Skip to content

Commit

Permalink
fix: return the correct yaml parsing error (#1691)
Browse files Browse the repository at this point in the history
## Description:
Fixes #1690

## Is this change user facing?
YES
  • Loading branch information
tedim52 committed Nov 4, 2023
1 parent 7dfccea commit c6170ec
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 9 deletions.
2 changes: 1 addition & 1 deletion README.md
Expand Up @@ -322,7 +322,7 @@ kurtosis enclave add
</details>

<!-------- ONLY LINKS BELOW THIS POINT -------->
[enclave]: https://docs.kurtosis.com/explanations/architecture#enclaves
[enclave]: https://docs.kurtosis.com/advanced-concepts/enclaves
[awesome-kurtosis]: https://github.com/kurtosis-tech/awesome-kurtosis#readme
[quickstart-reference]: https://docs.kurtosis.com/quickstart
[discord]: https://discord.gg/6Jjp9c89z9
Expand Down
2 changes: 1 addition & 1 deletion cli/cli/commands/run/run.go
Expand Up @@ -738,7 +738,7 @@ func getArgsFromFilepathOrURL(packageArgsFile string) (string, error) {

packageArgsFileStr := string(packageArgsFileBytes)
if packageArgParsingErr := validateSerializedArgs(packageArgsFileStr); packageArgParsingErr != nil {
return "", stacktrace.Propagate(err, "attempted to validate '%v' but failed", packageArgsFileFlagKey)
return "", stacktrace.Propagate(packageArgParsingErr, "attempted to validate '%v' but failed", packageArgsFileFlagKey)
}

return packageArgsFileStr, nil
Expand Down
Expand Up @@ -19,12 +19,11 @@ const (
GitHubFeatureRequestIssueUrl = GithubNewIssuesUrl + "?labels=feature+request&template=feature-request.yml"
GitHubDocsIssueUrl = GithubNewIssuesUrl + "?labels=docs&template=docs-issue.yml"
CLICommandsReferenceURL = DocumentationUrl + "/cli"
StarlarkPackagesReferenceURL = DocumentationUrl + "/concepts-reference/packages"
StarlarkLocatorsReferenceURL = DocumentationUrl + "/concepts-reference/locators"
StarlarkPackagesReferenceURL = DocumentationUrl + "/advanced-concepts/packages"
StarlarkLocatorsReferenceURL = DocumentationUrl + "/advanced-concepts/locators"
UpgradeCLIInstructionsPage = DocumentationUrl + "/install#upgrading"
MetricsPhilosophyDocs = DocumentationUrl + "/explanations/metrics-philosophy"
HowImportWorksLink = DocumentationUrl + "/explanations/how-do-kurtosis-imports-work"
PackageDocLink = DocumentationUrl + "/concepts-reference/packages"
MetricsPhilosophyDocs = DocumentationUrl + "/advanced-concepts/metrics-philosophy"
HowImportWorksLink = DocumentationUrl + "/advanced-concepts/how-do-kurtosis-imports-work"
GoogleRe2SyntaxDocumentation = "https://github.com/google/re2/wiki/Syntax"
KurtosisDiscordUrl = "https://discord.gg/6Jjp9c89z9"
KurtosisOnBoardCalendlyUrl = "https://calendly.com/d/zgt-f2c-66p/kurtosis-onboarding"
Expand Down Expand Up @@ -58,5 +57,4 @@ var urlsToValidateInTest = []string{
HowImportWorksLink,
KurtosisTechTwitterProfileLink,
KurtosisCloudLink,
PackageDocLink,
}
Expand Up @@ -79,7 +79,7 @@ func (provider *GitPackageContentProvider) GetKurtosisYaml(packageAbsolutePathOn
pathToKurtosisYaml := path.Join(packageAbsolutePathOnDisk, startosis_constants.KurtosisYamlName)
if _, err := os.Stat(pathToKurtosisYaml); err != nil {
return nil, startosis_errors.WrapWithInterpretationError(err, "Couldn't find a '%v' in the root of the package: '%v'. Packages are expected to have a '%v' at root; for more information have a look at %v",
startosis_constants.KurtosisYamlName, packageAbsolutePathOnDisk, startosis_constants.KurtosisYamlName, user_support_constants.PackageDocLink)
startosis_constants.KurtosisYamlName, packageAbsolutePathOnDisk, startosis_constants.KurtosisYamlName, user_support_constants.StarlarkPackagesReferenceURL)
}

kurtosisYaml, interpretationError := validateAndGetKurtosisYaml(pathToKurtosisYaml, provider.packagesDir)
Expand Down

0 comments on commit c6170ec

Please sign in to comment.