forked from go-gitea/gitea
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Validate migration files (go-gitea#18203)
JSON Schema validation for data used by Gitea during migrations Discussion at https://forum.forgefriends.org/t/common-json-schema-for-repository-information/563 Co-authored-by: Loïc Dachary <[email protected]>
- Loading branch information
1 parent
49dd906
commit 3bb028c
Showing
26 changed files
with
577 additions
and
74 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,112 @@ | ||
| // Copyright 2022 The Gitea Authors. All rights reserved. | ||
| // Use of this source code is governed by a MIT-style | ||
| // license that can be found in the LICENSE file. | ||
|
|
||
| package migration | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "os" | ||
| "strings" | ||
|
|
||
| "code.gitea.io/gitea/modules/json" | ||
| "code.gitea.io/gitea/modules/log" | ||
|
|
||
| "github.com/santhosh-tekuri/jsonschema/v5" | ||
| "gopkg.in/yaml.v2" | ||
| ) | ||
|
|
||
| // Load project data from file, with optional validation | ||
| func Load(filename string, data interface{}, validation bool) error { | ||
| isJSON := strings.HasSuffix(filename, ".json") | ||
|
|
||
| bs, err := os.ReadFile(filename) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| if validation { | ||
| err := validate(bs, data, isJSON) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| } | ||
| return unmarshal(bs, data, isJSON) | ||
| } | ||
|
|
||
| func unmarshal(bs []byte, data interface{}, isJSON bool) error { | ||
| if isJSON { | ||
| return json.Unmarshal(bs, data) | ||
| } | ||
| return yaml.Unmarshal(bs, data) | ||
| } | ||
|
|
||
| func getSchema(filename string) (*jsonschema.Schema, error) { | ||
| c := jsonschema.NewCompiler() | ||
| c.LoadURL = openSchema | ||
| return c.Compile(filename) | ||
| } | ||
|
|
||
| func validate(bs []byte, datatype interface{}, isJSON bool) error { | ||
| var v interface{} | ||
| err := unmarshal(bs, &v, isJSON) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| if !isJSON { | ||
| v, err = toStringKeys(v) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| } | ||
|
|
||
| var schemaFilename string | ||
| switch datatype := datatype.(type) { | ||
| case *[]*Issue: | ||
| schemaFilename = "issue.json" | ||
| case *[]*Milestone: | ||
| schemaFilename = "milestone.json" | ||
| default: | ||
| return fmt.Errorf("file_format:validate: %T has not a validation implemented", datatype) | ||
| } | ||
|
|
||
| sch, err := getSchema(schemaFilename) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| err = sch.Validate(v) | ||
| if err != nil { | ||
| log.Error("migration validation with %s failed for\n%s", schemaFilename, string(bs)) | ||
| } | ||
| return err | ||
| } | ||
|
|
||
| func toStringKeys(val interface{}) (interface{}, error) { | ||
| var err error | ||
| switch val := val.(type) { | ||
| case map[interface{}]interface{}: | ||
| m := make(map[string]interface{}) | ||
| for k, v := range val { | ||
| k, ok := k.(string) | ||
| if !ok { | ||
| return nil, fmt.Errorf("found non-string key %T %s", k, k) | ||
| } | ||
| m[k], err = toStringKeys(v) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| } | ||
| return m, nil | ||
| case []interface{}: | ||
| l := make([]interface{}, len(val)) | ||
| for i, v := range val { | ||
| l[i], err = toStringKeys(v) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| } | ||
| return l, nil | ||
| default: | ||
| return val, nil | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| // Copyright 2022 The Gitea Authors. All rights reserved. | ||
| // Use of this source code is governed by a MIT-style | ||
| // license that can be found in the LICENSE file. | ||
|
|
||
| package migration | ||
|
|
||
| import ( | ||
| "strings" | ||
| "testing" | ||
|
|
||
| "github.com/santhosh-tekuri/jsonschema/v5" | ||
| "github.com/stretchr/testify/assert" | ||
| ) | ||
|
|
||
| func TestMigrationJSON_IssueOK(t *testing.T) { | ||
| issues := make([]*Issue, 0, 10) | ||
| err := Load("file_format_testdata/issue_a.json", &issues, true) | ||
| assert.NoError(t, err) | ||
| err = Load("file_format_testdata/issue_a.yml", &issues, true) | ||
| assert.NoError(t, err) | ||
| } | ||
|
|
||
| func TestMigrationJSON_IssueFail(t *testing.T) { | ||
| issues := make([]*Issue, 0, 10) | ||
| err := Load("file_format_testdata/issue_b.json", &issues, true) | ||
| if _, ok := err.(*jsonschema.ValidationError); ok { | ||
| errors := strings.Split(err.(*jsonschema.ValidationError).GoString(), "\n") | ||
| assert.Contains(t, errors[1], "missing properties") | ||
| assert.Contains(t, errors[1], "poster_id") | ||
| } else { | ||
| t.Fatalf("got: type %T with value %s, want: *jsonschema.ValidationError", err, err) | ||
| } | ||
| } | ||
|
|
||
| func TestMigrationJSON_MilestoneOK(t *testing.T) { | ||
| milestones := make([]*Milestone, 0, 10) | ||
| err := Load("file_format_testdata/milestones.json", &milestones, true) | ||
| assert.NoError(t, err) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| [ | ||
| { | ||
| "number": 1, | ||
| "poster_id": 1, | ||
| "poster_name": "name_a", | ||
| "title": "title_a", | ||
| "content": "content_a", | ||
| "state": "closed", | ||
| "is_locked": false, | ||
| "created": "1985-04-12T23:20:50.52Z", | ||
| "updated": "1986-04-12T23:20:50.52Z", | ||
| "closed": "1987-04-12T23:20:50.52Z" | ||
| } | ||
| ] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| - number: 1 | ||
| poster_id: 1 | ||
| poster_name: name_a | ||
| title: title_a | ||
| content: content_a | ||
| state: closed | ||
| is_locked: false | ||
| created: 2021-05-27T15:24:13+02:00 | ||
| updated: 2021-11-11T10:52:45+01:00 | ||
| closed: 2021-11-11T10:52:45+01:00 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| [ | ||
| { | ||
| "number": 1 | ||
| } | ||
| ] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| [ | ||
| { | ||
| "title": "title_a", | ||
| "description": "description_a", | ||
| "deadline": "1988-04-12T23:20:50.52Z", | ||
| "created": "1985-04-12T23:20:50.52Z", | ||
| "updated": "1986-04-12T23:20:50.52Z", | ||
| "closed": "1987-04-12T23:20:50.52Z", | ||
| "state": "closed" | ||
| }, | ||
| { | ||
| "title": "title_b", | ||
| "description": "description_b", | ||
| "deadline": "1998-04-12T23:20:50.52Z", | ||
| "created": "1995-04-12T23:20:50.52Z", | ||
| "updated": "1996-04-12T23:20:50.52Z", | ||
| "closed": null, | ||
| "state": "open" | ||
| } | ||
| ] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.