Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add app spec validate-offline (Resolves #1449) #1450

Merged
merged 5 commits into from
Oct 24, 2023
+26 −2
Merged

Add app spec validate-offline (Resolves #1449) #1450

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ae6c1b6
integration/apps_spec_test: Add tests for apps spec validate-offline
trinitronx Oct 22, 2023
385ae5f
commands/apps: Add apps spec validate-offline command (Fixes #1449)
trinitronx Oct 22, 2023
6204426
commands/apps: Refactor spec validation into a common function
trinitronx Oct 22, 2023
8319fec
commands/apps: refactor validate-offline -> --schema-only (Fixes #144…
trinitronx Oct 23, 2023
c54c617
Add integration test without auth.
andrewsomething Oct 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions commands/apps.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -704,9 +704,9 @@ Optionally, pass a deployment ID to get the spec of that specific deployment.`,
AddStringFlag(getCmd, doctl.ArgAppDeployment, "", "", "optional: a deployment ID")
AddStringFlag(getCmd, doctl.ArgFormat, "", "yaml", `the format to output the spec in; either "yaml" or "json"`)

validateCmd := CmdBuilder(cmd, RunAppsSpecValidate, "validate <spec file>", "Validate an application spec", `Use this command to check whether a given app spec (YAML or JSON) is valid.
validateCmd := cmdBuilderWithInit(cmd, RunAppsSpecValidate, "validate <spec file>", "Validate an application spec", `Use this command to check whether a given app spec (YAML or JSON) is valid.

You may pass - as the filename to read from stdin.`, Writer)
You may pass - as the filename to read from stdin.`, Writer, false)
AddBoolFlag(validateCmd, doctl.ArgSchemaOnly, "", false, "Only validate the spec schema and not the correctness of the spec.")

return cmd
Expand Down Expand Up @@ -762,6 +762,7 @@ func RunAppsSpecGet(c *CmdConfig) error {
}

// RunAppsSpecValidate validates an app spec file
// doesn't require auth & connection to the API with doctl.ArgSchemaOnly flag
func RunAppsSpecValidate(c *CmdConfig) error {
if len(c.Args) < 1 {
return doctl.NewMissingArgsErr(c.NS)
Expand All @@ -778,6 +779,7 @@ func RunAppsSpecValidate(c *CmdConfig) error {
return err
}

// validate schema only (offline)
if schemaOnly {
ymlSpec, err := yaml.Marshal(appSpec)
if err != nil {
Expand All @@ -787,6 +789,10 @@ func RunAppsSpecValidate(c *CmdConfig) error {
return err
}

// validate the spec against the API
if err := c.initServices(c); err != nil {
return err
}
res, err := c.Apps().Propose(&godo.AppProposeRequest{
Spec: appSpec,
})
Expand Down
18 changes: 18 additions & 0 deletions integration/apps_spec_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,6 +197,24 @@ var _ = suite("apps/spec/validate", func(t *testing.T, when spec.G, it spec.S) {
expect.Equal(expectedOutput, strings.TrimSpace(string(output)))
})

it("schema-only works without auth", func() {
cmd := exec.Command(builtBinaryPath,
"-u", server.URL,
"apps", "spec", "validate",
"--schema-only", "-",
)
byt, err := json.Marshal(testAppSpec)
expect.NoError(err)

cmd.Stdin = bytes.NewReader(byt)

output, err := cmd.CombinedOutput()
expect.NoError(err)

expectedOutput := "name: test\nservices:\n- github:\n branch: main\n repo: digitalocean/doctl\n name: service"
expect.Equal(expectedOutput, strings.TrimSpace(string(output)))
})

it("calls proposeapp", func() {
cmd := exec.Command(builtBinaryPath,
"-t", "some-magic-token",
Expand Down