This repository has been archived by the owner on Nov 18, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 170
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
internal/filetypes: add auto interpretation
- automatically detect OpenAPI and JSONSchema based on strict criteria. - json+schema no longer magically maps to jsonschema For inputs, auto mode is now automatically enabled for .json and .yaml/yml files. Any explicit tag, like json: or data: disables auto mode. Change-Id: I391179c4542b823c428e4989e31381e00caa4a45 Reviewed-on: https://cue-review.googlesource.com/c/cue/+/5410 Reviewed-by: Marcel van Lohuizen <mpvl@google.com>
- Loading branch information
Showing
11 changed files
with
377 additions
and
73 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| // Copyright 2020 CUE Authors | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package encoding | ||
|
|
||
| import ( | ||
| "net/url" | ||
| "path" | ||
| "strings" | ||
|
|
||
| "cuelang.org/go/cue" | ||
| "cuelang.org/go/cue/build" | ||
| ) | ||
|
|
||
| // Detect detects the interpretation. | ||
| func Detect(v cue.Value) (i build.Interpretation) { | ||
| switch { | ||
| case isOpenAPI(v): | ||
| return build.OpenAPI | ||
| case isJSONSchema(v): | ||
| return build.JSONSchema | ||
| } | ||
| return i | ||
| } | ||
|
|
||
| func isOpenAPI(v cue.Value) bool { | ||
| s, _ := v.Lookup("openapi").String() | ||
| if !strings.HasPrefix(s, "3.") { | ||
| return false | ||
| } | ||
| if _, err := v.Lookup("info", "title").String(); err != nil { | ||
| return false | ||
| } | ||
| if _, err := v.Lookup("info", "version").String(); err != nil { | ||
| return false | ||
| } | ||
| return true | ||
| } | ||
|
|
||
| func isJSONSchema(v cue.Value) bool { | ||
| s, err := v.Lookup("$schema").String() | ||
| if err != nil { | ||
| return false | ||
| } | ||
| u, err := url.Parse(s) | ||
| if err != nil { | ||
| return false | ||
| } | ||
| if u.Hostname() != "json-schema.org" { | ||
| return false | ||
| } | ||
| if _, base := path.Split(u.EscapedPath()); base != "schema" { | ||
| return false | ||
| } | ||
| return true | ||
| } |
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,101 @@ | ||
| // Copyright 2020 CUE Authors | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| package encoding | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "cuelang.org/go/cue" | ||
| "cuelang.org/go/cue/build" | ||
| ) | ||
|
|
||
| func TestDetect(t *testing.T) { | ||
| testCases := []struct { | ||
| name string | ||
| in string | ||
| out build.Interpretation | ||
| }{{ | ||
| name: "validOpenAPI", | ||
| in: ` | ||
| openapi: "3.0.0" | ||
| info: title: "Foo" | ||
| info: version: "v1alpha1" | ||
| `, | ||
| out: build.OpenAPI, | ||
| }, { | ||
| name: "noOpenAPI", | ||
| in: ` | ||
| info: title: "Foo" | ||
| info: version: "v1alpha1" | ||
| `, | ||
| }, { | ||
| name: "noTitle", | ||
| in: ` | ||
| openapi: "3.0.0" | ||
| info: version: "v1alpha1" | ||
| `, | ||
| }, { | ||
| name: "noVersion", | ||
| in: ` | ||
| openapi: "3.0.0" | ||
| info: title: "Foo" | ||
| `, | ||
| }, { | ||
| name: "validJSONSchema", | ||
| in: ` | ||
| $schema: "https://json-schema.org/schema#" | ||
| `, | ||
| out: build.JSONSchema, | ||
| }, { | ||
| name: "validJSONSchema", | ||
| in: ` | ||
| $schema: "https://json-schema.org/draft-07/schema#" | ||
| `, | ||
| out: build.JSONSchema, | ||
| }, { | ||
| name: "noSchema", | ||
| in: ` | ||
| $id: "https://acme.com/schema#" | ||
| `, | ||
| }, { | ||
| name: "wrongHost", | ||
| in: ` | ||
| $schema: "https://acme.com/schema#" | ||
| `, | ||
| }, { | ||
| name: "invalidURL", | ||
| in: ` | ||
| $schema: "://json-schema.org/draft-07" | ||
| `, | ||
| }, { | ||
| name: "invalidPath", | ||
| in: ` | ||
| $schema: "https://json-schema.org/draft-07" | ||
| `, | ||
| }} | ||
| for _, tc := range testCases { | ||
| t.Run(tc.name, func(t *testing.T) { | ||
| var r cue.Runtime | ||
| inst, err := r.Compile(tc.name, tc.in) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| got := Detect(inst.Value()) | ||
| if got != tc.out { | ||
| t.Errorf("got %v; want %v", got, tc.out) | ||
| } | ||
| }) | ||
| } | ||
| } |
Oops, something went wrong.