feat: Validate plugin spec before init#16546
Merged
Merged
Conversation
disq
reviewed
Feb 8, 2024
erezrokah
approved these changes
Feb 8, 2024
disq
reviewed
Feb 8, 2024
disq
approved these changes
Feb 8, 2024
Co-authored-by: Kemal <223029+disq@users.noreply.github.com>
hermanschaaf
approved these changes
Feb 8, 2024
kodiakhq Bot
pushed a commit
that referenced
this pull request
Feb 8, 2024
🤖 I have created a release *beep* *boop* --- ## [5.4.0](cli-v5.3.1...cli-v5.4.0) (2024-02-08) ### Features * Validate plugin spec before init ([#16546](#16546)) ([081e1b7](081e1b7)) ### Bug Fixes * **deps:** Update module github.com/cloudquery/plugin-pb-go to v1.17.0 ([#16528](#16528)) ([c6b0142](c6b0142)) * **deps:** Update module github.com/cloudquery/plugin-pb-go to v1.17.1 ([#16539](#16539)) ([844434b](844434b)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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.
This PR adds spec validation before passing it to the plugin.
It also extracts the init logic into a handy
initPluginfunc.The decision structure is the following (we allow a bit of leeway here if the schema provided isn't a correct JSON schema: the CLI will skip validation instead of failing the sync/init)
flowchart TD A{No Connection?} ----> |true| S A{No Connection?} --> |false| G[Get spec schema] subgraph validate G --> |non-empty schema| P[parse schema] G --> |failed call| E[error-out] P --> |OK| V[validate spec] V --> |failed| E end P --> |failed| S G --> |unimplemented| S G --> |empty schema| S V --> |OK| I[init] S[Skip validation] --> I