feat: Add JSON Schema to Okta source plugin #16493
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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,26 @@ | ||
| package main | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "log" | ||
| "path" | ||
| "runtime" | ||
|
|
||
| "github.com/cloudquery/cloudquery/plugins/source/okta/client" | ||
| cqjsonschema "github.com/cloudquery/codegen/jsonschema" | ||
| ) | ||
|
|
||
| func main() { | ||
| fmt.Println("Generating JSON schema for plugin spec") | ||
| cqjsonschema.GenerateIntoFile(new(client.Spec), path.Join(currDir(), "../..", "schema.json"), | ||
|
candiduslynx marked this conversation as resolved.
|
||
| cqjsonschema.WithAddGoComments("github.com/cloudquery/cloudquery/plugins/source/okta/client", path.Join(currDir(), "../..")), | ||
| ) | ||
| } | ||
|
|
||
| func currDir() string { | ||
| _, filename, _, ok := runtime.Caller(0) | ||
| if !ok { | ||
| log.Fatal("Failed to get caller information") | ||
| } | ||
| return path.Dir(filename) | ||
| } | ||
This file contains hidden or 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,82 @@ | ||
| package client | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "github.com/cloudquery/codegen/jsonschema" | ||
| ) | ||
|
|
||
| func TestJSONSchema(t *testing.T) { | ||
| jsonschema.TestJSONSchema(t, JSONSchema, []jsonschema.TestCase{ | ||
| { | ||
| Name: "empty spec", | ||
| Spec: `{}`, | ||
| Err: true, | ||
| }, | ||
| { | ||
| Name: "spec with token", | ||
| Spec: `{"token": "tok"}`, | ||
| Err: true, | ||
| }, | ||
| { | ||
| Name: "spec with token and domain", | ||
| Spec: `{"token": "tok", "domain": "https://domain.okta.com"}`, | ||
| }, | ||
| { | ||
| Name: "spec with token and invalid domain", | ||
| Spec: `{"token": "tok", "domain": "https://<CHANGE_THIS_TO_YOUR_OKTA_DOMAIN>.okta.com"}`, | ||
| Err: true, | ||
| }, | ||
| { | ||
| Name: "spec with token and domain and empty rate limit", | ||
| Spec: `{"token": "tok", "domain": "https://domain.okta.com", "rate_limit": {}}`, | ||
| }, | ||
| { | ||
| Name: "spec with token and domain and null rate limit", | ||
| Spec: `{"token": "tok", "domain": "https://domain.okta.com", "rate_limit": null}`, | ||
| }, | ||
| { | ||
| Name: "spec with token and domain and rate limit", | ||
| Spec: `{"token": "tok", "domain": "https://domain.okta.com", "rate_limit": {"max_backoff": 60}}`, | ||
| }, | ||
| { | ||
| Name: "spec with token and domain and invalid rate limit", | ||
| Spec: `{"token": "tok", "domain": "https://domain.okta.com", "rate_limit": {"max_backoff": true}}`, | ||
|
Contributor
There was a problem hiding this comment. remove token from tests (only leave for the tests that are actually testing token)
Contributor
There was a problem hiding this comment. Or merge #16498 & reintroduce requirement for |
||
| Err: true, | ||
| }, | ||
| { | ||
| Name: "spec with token and domain and zero rate limit", | ||
| Spec: `{"token": "tok", "domain": "https://domain.okta.com", "rate_limit": {"max_backoff": 0}}`, | ||
|
Contributor
There was a problem hiding this comment. rl tests could be extracted into a separate func, see https://github.com/cloudquery/cloudquery/blob/main/plugins/source/aws/client/spec/organization_test.go |
||
| Err: true, | ||
| }, | ||
| { | ||
| Name: "spec with bool concurrency", | ||
| Spec: `{"token": "tok", "domain": "https://domain.okta.com", "concurrency":false}`, | ||
| Err: true, | ||
| }, | ||
| { | ||
| Name: "spec with null concurrency", | ||
| Spec: `{"token": "tok", "domain": "https://domain.okta.com", "concurrency":null}`, | ||
| Err: true, | ||
| }, | ||
| { | ||
| Name: "spec with string concurrency", | ||
| Spec: `{"token": "tok", "domain": "https://domain.okta.com", "concurrency":"str"}`, | ||
| Err: true, | ||
| }, | ||
| { | ||
| Name: "spec with proper concurrency", | ||
| Spec: `{"token": "tok", "domain": "https://domain.okta.com", "concurrency": 7}`, | ||
| }, | ||
| { | ||
| Name: "spec with array concurrency", | ||
| Spec: `{"token": "tok", "domain": "https://domain.okta.com", "concurrency":["abc"]}`, | ||
| Err: true, | ||
| }, | ||
| { | ||
| Name: "spec with unknown field", | ||
| Spec: `{"token": "tok", "domain": "https://domain.okta.com", "unknown": "test"}`, | ||
| Err: true, | ||
| }, | ||
| }) | ||
| } | ||
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.