Skip to content

Fix erroneous attest error #280

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

Merged
ToreMerkely merged 1 commit into from
Aug 9, 2024
Merged

Fix erroneous attest error #280

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
21 changes: 16 additions & 5 deletions cmd/kosli/attestGeneric_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,12 @@ func (suite *AttestGenericCommandTestSuite) TestAttestGenericCmd() {
cmd: fmt.Sprintf("attest generic foo bar %s", suite.defaultKosliArguments),
golden: "Error: accepts at most 1 arg(s), received 2 [foo bar]\n",
},
{
wantError: true,
name: "fails when artifact-name is provided and there is an --artifact-type flag and --compliant is not set with =",
cmd: fmt.Sprintf("attest generic testdata/file1 %s --artifact-type file --compliant false", suite.defaultKosliArguments),
golden: "Error: accepts at most 1 arg(s), received 2 [testdata/file1 false]\nSee https://docs.kosli.com//faq/#boolean-flags\n",
},
{
wantError: true,
name: "fails when missing a required flag",
Expand All @@ -49,15 +55,15 @@ func (suite *AttestGenericCommandTestSuite) TestAttestGenericCmd() {
},
{
wantError: true,
name: "fails when artifact-name is provided (as _unused_ boolean 'space' arg) and there is no --artifact-type",
name: "fails when artifact-name is provided (as _unused_ boolean 'space' arg) and there is no --artifact-type and no --fingerprint",
cmd: fmt.Sprintf("attest generic %s --compliant false", suite.defaultKosliArguments),
golden: "Error: --artifact-type is required when artifact name ('false') argument is supplied.\nSee https://docs.kosli.com//faq/#boolean-flags\nUsage: kosli attest generic [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags]\n",
golden: "Error: --artifact-type or --fingerprint must be specified when artifact name ('false') argument is supplied.\nSee https://docs.kosli.com//faq/#boolean-flags\nUsage: kosli attest generic [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags]\n",
},
{
wantError: true,
name: "fails when artifact-name is provided and there is no --artifact-type",
cmd: fmt.Sprintf("attest generic wibble %s", suite.defaultKosliArguments),
golden: "Error: --artifact-type is required when artifact name ('wibble') argument is supplied.\nUsage: kosli attest generic [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags]\n",
golden: "Error: --artifact-type or --fingerprint must be specified when artifact name ('wibble') argument is supplied.\nUsage: kosli attest generic [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags]\n",
},
{
wantError: true,
Expand All @@ -69,7 +75,7 @@ func (suite *AttestGenericCommandTestSuite) TestAttestGenericCmd() {
wantError: true,
name: "fails when there are extra args and gives custom help message when an argument is true|false",
cmd: fmt.Sprintf("attest generic %s --compliant false", suite.defaultKosliArguments),
golden: "Error: --artifact-type is required when artifact name ('false') argument is supplied.\nSee https://docs.kosli.com//faq/#boolean-flags\nUsage: kosli attest generic [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags]\n",
golden: "Error: --artifact-type or --fingerprint must be specified when artifact name ('false') argument is supplied.\nSee https://docs.kosli.com//faq/#boolean-flags\nUsage: kosli attest generic [IMAGE-NAME | FILE-PATH | DIR-PATH] [flags]\n",
},
{
wantError: true,
Expand All @@ -95,6 +101,11 @@ func (suite *AttestGenericCommandTestSuite) TestAttestGenericCmd() {
cmd: fmt.Sprintf("attest generic --name \"\" --commit HEAD --origin-url example.com %s", suite.defaultKosliArguments),
golden: "Error: flag '--name' is required, but empty string was provided\n",
},
{
name: "can attest generic against an artifact using artifact-name and --fingerprint",
cmd: fmt.Sprintf("attest generic testdata/file1 %s --name foo --fingerprint 7509e5bda0c762d2bac7f90d758b5b2263fa01ccbc542ab5e3df163be08e6ca9", suite.defaultKosliArguments),
golden: "generic attestation 'foo' is reported to trail: test-123\n",
},
{
name: "can attest generic against an artifact using artifact name and --artifact-type",
cmd: fmt.Sprintf("attest generic testdata/file1 --artifact-type file --name foo --commit HEAD --origin-url example.com %s", suite.defaultKosliArguments),
Expand All @@ -106,7 +117,7 @@ func (suite *AttestGenericCommandTestSuite) TestAttestGenericCmd() {
golden: "generic attestation 'bar' is reported to trail: test-123\n",
},
{
name: "can attest generic against an artifact using --fingerprint",
name: "can attest generic against an artifact using --fingerprint and no artifact-name",
cmd: fmt.Sprintf("attest generic --fingerprint 7509e5bda0c762d2bac7f90d758b5b2263fa01ccbc542ab5e3df163be08e6ca9 --name foo --commit HEAD --origin-url example.com %s", suite.defaultKosliArguments),
golden: "generic attestation 'foo' is reported to trail: test-123\n",
},
Expand Down
5 changes: 3 additions & 2 deletions cmd/kosli/cli_utils.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -521,9 +521,10 @@ func ValidateAttestationArtifactArg(args []string, artifactType, inputSha256 str
if artifactType != "" && (len(args) == 0 || args[0] == "") {
return fmt.Errorf("artifact name argument is required when --artifact-type is set")
}
if artifactType == "" && len(args) > 0 {
return fmt.Errorf("--artifact-type is required when artifact name ('%s') argument is supplied.%s", args[0], BooleanArgsMessageLink(args))
if artifactType == "" && inputSha256 == "" && len(args) > 0 {
return fmt.Errorf("--artifact-type or --fingerprint must be specified when artifact name ('%s') argument is supplied.%s", args[0], BooleanArgsMessageLink(args))
}

if inputSha256 != "" {
if err := digest.ValidateDigest(inputSha256); err != nil {
return err
Expand Down