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

Jump to bottom

Set Default Schema to Remote Schema #777

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
+24 −19
Open

Set Default Schema to Remote Schema #777

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
a8eed0e
feat: set default Atmos manifest URL if not specified in configuration
haitham911 Nov 13, 2024
2bed139
feat: log trace message when using default Atmos JSON Schema file
haitham911 Nov 13, 2024
8eb6212
Merge branch 'main' into DEV-2727
osterman Nov 13, 2024
759d75c
fix: improve error message for missing Atmos JSON Schema file
haitham911 Nov 15, 2024
411963c
Update internal/exec/validate_stacks.go
osterman Nov 15, 2024
4dddaa4
fix: change log level from trace to info for default Atmos JSON Schem…
haitham911 Nov 17, 2024
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
43 changes: 24 additions & 19 deletions internal/exec/validate_stacks.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ import (
u "github.com/cloudposse/atmos/pkg/utils"
)

const atmosManifestDefault = "https://atmos.tools/schemas/atmos/atmos-manifest/1.0/atmos-manifest.json"

// ExecuteValidateStacksCmd executes `validate stacks` command
func ExecuteValidateStacksCmd(cmd *cobra.Command, args []string) error {
info, err := processCommandLineArgs("", cmd, args, nil)
Expand Down Expand Up @@ -84,27 +86,30 @@ func ValidateStacks(cliConfig schema.CliConfiguration) error {
// The path to the Atmos manifest JSON Schema can be absolute path or a path relative to the `base_path` setting in `atmos.yaml`
var atmosManifestJsonSchemaFilePath string

if cliConfig.Schemas.Atmos.Manifest != "" {
atmosManifestJsonSchemaFileAbsPath := path.Join(cliConfig.BasePath, cliConfig.Schemas.Atmos.Manifest)

if u.FileExists(cliConfig.Schemas.Atmos.Manifest) {
atmosManifestJsonSchemaFilePath = cliConfig.Schemas.Atmos.Manifest
} else if u.FileExists(atmosManifestJsonSchemaFileAbsPath) {
atmosManifestJsonSchemaFilePath = atmosManifestJsonSchemaFileAbsPath
} else if u.IsURL(cliConfig.Schemas.Atmos.Manifest) {
atmosManifestJsonSchemaFilePath, err = downloadSchemaFromURL(cliConfig.Schemas.Atmos.Manifest)
if err != nil {
return err
}
} else {
return fmt.Errorf("the Atmos JSON Schema file '%s' does not exist.\n"+
"It can be configured in the 'schemas.atmos.manifest' section in 'atmos.yaml', or provided using the 'ATMOS_SCHEMAS_ATMOS_MANIFEST' "+
"ENV variable or '--schemas-atmos-manifest' command line argument.\n"+
"The path to the schema file should be an absolute path or a path relative to the 'base_path' setting in 'atmos.yaml'. \n"+
"Alternatively, you can specify a schema file using a URL that will be downloaded automatically.",
cliConfig.Schemas.Atmos.Manifest)
if cliConfig.Schemas.Atmos.Manifest == "" {
cliConfig.Schemas.Atmos.Manifest = atmosManifestDefault
u.LogInfo(cliConfig, fmt.Sprintf("The Atmos JSON Schema file is not configured. Using the default schema '%s'", atmosManifestDefault))
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's change to debug level, since it's not important enough to output every time.

}
atmosManifestJsonSchemaFileAbsPath := path.Join(cliConfig.BasePath, cliConfig.Schemas.Atmos.Manifest)

if u.FileExists(cliConfig.Schemas.Atmos.Manifest) {
atmosManifestJsonSchemaFilePath = cliConfig.Schemas.Atmos.Manifest
} else if u.FileExists(atmosManifestJsonSchemaFileAbsPath) {
atmosManifestJsonSchemaFilePath = atmosManifestJsonSchemaFileAbsPath
} else if u.IsURL(cliConfig.Schemas.Atmos.Manifest) {
atmosManifestJsonSchemaFilePath, err = downloadSchemaFromURL(cliConfig.Schemas.Atmos.Manifest)
if err != nil {
return err
}
} else {
return fmt.Errorf("Schema file '%s' not found. Configure via:\n"+
"1. 'schemas.atmos.manifest' in atmos.yaml\n"+
"2. ATMOS_SCHEMAS_ATMOS_MANIFEST env var\n"+
"3. --schemas-atmos-manifest flag\n\n"+
"Accepts: absolute path, paths relative to base_path, or URL",
cliConfig.Schemas.Atmos.Manifest)
}

// Include (process and validate) all YAML files in the `stacks` folder in all subfolders
includedPaths := []string{"**/*"}
// Don't exclude any YAML files for validation
Expand Down