Skip to content

Commit

Permalink
add missing unit test case for warn mode verification policy
Browse files Browse the repository at this point in the history
This commit adds missing unit test case for warn mode verification
policy.

Signed-off-by: Yongxuan Zhang [email protected]
  • Loading branch information
Yongxuanzhang authored and tekton-robot committed May 25, 2023
1 parent 1535587 commit d4ff430
Show file tree
Hide file tree
Showing 3 changed files with 55 additions and 38 deletions.
28 changes: 13 additions & 15 deletions pkg/reconciler/pipelinerun/resources/pipelineref_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -459,7 +459,7 @@ func TestGetPipelineFunc_RemoteResolutionInvalidData(t *testing.T) {
}
}

func TestGetPipelineFunc_VerifySuccess(t *testing.T) {
func TestGetPipelineFunc_VerifyNoError(t *testing.T) {
// This test case tests the success cases of trusted-resources-verification-no-match-policy when it is set to
// fail: passed matching policy verification
// warn and ignore: no matching policies.
Expand Down Expand Up @@ -535,6 +535,12 @@ func TestGetPipelineFunc_VerifySuccess(t *testing.T) {
},
}

warnPolicyRefSource := &v1beta1.RefSource{
URI: " warnVP",
}
resolvedUnsignedMatched := test.NewResolvedResource(unsignedPipelineBytes, nil, warnPolicyRefSource, nil)
requesterUnsignedMatched := test.NewRequester(resolvedUnsignedMatched, nil)

testcases := []struct {
name string
requester *test.Requester
Expand Down Expand Up @@ -576,27 +582,19 @@ func TestGetPipelineFunc_VerifySuccess(t *testing.T) {
expected: unsignedPipeline,
expectedRefSource: noMatchPolicyRefSource,
}, {
name: "ignore unsigned pipeline without matching policies",
requester: requesterUnmatched,
verificationNoMatchPolicy: config.IgnoreNoMatchPolicy,
name: "unsigned pipeline fails warn mode policies doesn't return error",
requester: requesterUnsignedMatched,
verificationNoMatchPolicy: config.FailNoMatchPolicy,
pipelinerun: pr,
policies: vps,
expected: unsignedPipeline,
expectedRefSource: noMatchPolicyRefSource,
expectedRefSource: warnPolicyRefSource,
}, {
name: "warn no policies",
requester: requesterUnmatched,
verificationNoMatchPolicy: config.WarnNoMatchPolicy,
pipelinerun: pr,
policies: []*v1alpha1.VerificationPolicy{},
expected: unsignedPipeline,
expectedRefSource: noMatchPolicyRefSource,
}, {
name: "ignore no policies",
name: "ignore unsigned pipeline without matching policies",
requester: requesterUnmatched,
verificationNoMatchPolicy: config.IgnoreNoMatchPolicy,
pipelinerun: pr,
policies: []*v1alpha1.VerificationPolicy{},
policies: vps,
expected: unsignedPipeline,
expectedRefSource: noMatchPolicyRefSource,
}, {
Expand Down
27 changes: 13 additions & 14 deletions pkg/reconciler/taskrun/resources/taskref_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -723,7 +723,7 @@ func TestGetPipelineFunc_RemoteResolutionInvalidData(t *testing.T) {
}
}

func TestGetTaskFunc_VerifySuccess(t *testing.T) {
func TestGetTaskFunc_VerifyNoError(t *testing.T) {
// This test case tests the success cases of trusted-resources-verification-no-match-policy when it is set to
// fail: passed matching policy verification
// warn and ignore: no matching policies.
Expand Down Expand Up @@ -764,6 +764,12 @@ func TestGetTaskFunc_VerifySuccess(t *testing.T) {
resolvedMatched := test.NewResolvedResource(signedTaskBytes, nil, matchPolicyRefSource, nil)
requesterMatched := test.NewRequester(resolvedMatched, nil)

warnPolicyRefSource := &v1beta1.RefSource{
URI: " warnVP",
}
resolvedUnsignedMatched := test.NewResolvedResource(unsignedTaskBytes, nil, warnPolicyRefSource, nil)
requesterUnsignedMatched := test.NewRequester(resolvedUnsignedMatched, nil)

taskRef := &v1beta1.TaskRef{ResolverRef: v1beta1.ResolverRef{Resolver: "git"}}

testcases := []struct {
Expand Down Expand Up @@ -802,24 +808,17 @@ func TestGetTaskFunc_VerifySuccess(t *testing.T) {
expected: unsignedTask,
expectedRefSource: noMatchPolicyRefSource,
}, {
name: "allow unsigned task without matching policies",
requester: requesterUnmatched,
verificationNoMatchPolicy: config.IgnoreNoMatchPolicy,
name: "task fails warn mode policy doesn't return error",
requester: requesterUnsignedMatched,
verificationNoMatchPolicy: config.FailNoMatchPolicy,
policies: vps,
expected: unsignedTask,
expectedRefSource: noMatchPolicyRefSource,
}, {
name: "warn no policies",
requester: requesterUnmatched,
verificationNoMatchPolicy: config.WarnNoMatchPolicy,
policies: []*v1alpha1.VerificationPolicy{},
expected: unsignedTask,
expectedRefSource: noMatchPolicyRefSource,
expectedRefSource: warnPolicyRefSource,
}, {
name: "allow no policies",
name: "ignore unsigned task without matching policies",
requester: requesterUnmatched,
verificationNoMatchPolicy: config.IgnoreNoMatchPolicy,
policies: []*v1alpha1.VerificationPolicy{},
policies: vps,
expected: unsignedTask,
expectedRefSource: noMatchPolicyRefSource,
},
Expand Down
38 changes: 29 additions & 9 deletions test/trustedresources.go
Original file line number Diff line number Diff line change
Expand Up @@ -113,10 +113,11 @@ func SetupTrustedResourceConfig(ctx context.Context, verificationNoMatchPolicy s
}

// SetupVerificationPolicies set verification policies and secrets to store public keys.
// This function helps to setup 3 kinds of VerificationPolicies:
// This function helps to setup 4 kinds of VerificationPolicies:
// 1. One public key in inline data
// 2. One public key in secret
// 3. 2 authorities referring to the same secret. This is to test and make sure we don't have duplicate counts
// 3. the policy pattern doesn't match any resources
// 4. warn mode policy without keys
// SignerVerifier is returned to sign resources
// The k8s clientset is returned to fetch secret from it.
// VerificationPolicies are returned to fetch public keys
Expand Down Expand Up @@ -151,7 +152,7 @@ func SetupVerificationPolicies(t *testing.T) (signature.SignerVerifier, *ecdsa.P
HashAlgorithm: "sha256",
},
},
})
}, v1alpha1.ModeEnforce)

keyInSecretVp := getVerificationPolicy(
"keyInSecretVp",
Expand All @@ -170,7 +171,7 @@ func SetupVerificationPolicies(t *testing.T) (signature.SignerVerifier, *ecdsa.P
HashAlgorithm: "sha256",
},
},
})
}, v1alpha1.ModeEnforce)

wrongKeyandPatternVp := getVerificationPolicy(
"wrongKeyInDataVp",
Expand All @@ -186,11 +187,30 @@ func SetupVerificationPolicies(t *testing.T) (signature.SignerVerifier, *ecdsa.P
HashAlgorithm: "sha256",
},
},
})
}, v1alpha1.ModeEnforce)

warnModeVP := getVerificationPolicy(
"warnModeVP",
namespace,
[]v1alpha1.ResourcePattern{{
Pattern: "warnVP"},
},
[]v1alpha1.Authority{
{
Name: "pubkey",
Key: &v1alpha1.KeyRef{
SecretRef: &v1.SecretReference{
Name: secret.Name,
Namespace: secret.Namespace,
},
HashAlgorithm: "sha256",
},
},
}, v1alpha1.ModeWarn)

k8sclient := fakek8s.NewSimpleClientset(secret)

return sv, keys, k8sclient, []*v1alpha1.VerificationPolicy{&keyInDataVp, &keyInSecretVp, &wrongKeyandPatternVp}
return sv, keys, k8sclient, []*v1alpha1.VerificationPolicy{&keyInDataVp, &keyInSecretVp, &wrongKeyandPatternVp, &warnModeVP}
}

// SetupMatchAllVerificationPolicies set verification policies with a Pattern to match all resources
Expand Down Expand Up @@ -224,7 +244,7 @@ func SetupMatchAllVerificationPolicies(t *testing.T, namespace string) (signatur
HashAlgorithm: "sha256",
},
},
})
}, v1alpha1.ModeEnforce)

k8sclient := fakek8s.NewSimpleClientset(secret)

Expand Down Expand Up @@ -350,7 +370,7 @@ func readPasswordFn(confirm bool) func() ([]byte, error) {
}
}

func getVerificationPolicy(name, namespace string, patterns []v1alpha1.ResourcePattern, authorities []v1alpha1.Authority) v1alpha1.VerificationPolicy {
func getVerificationPolicy(name, namespace string, patterns []v1alpha1.ResourcePattern, authorities []v1alpha1.Authority, mode v1alpha1.ModeType) v1alpha1.VerificationPolicy {
return v1alpha1.VerificationPolicy{
TypeMeta: metav1.TypeMeta{
Kind: "VerificationPolicy",
Expand All @@ -363,7 +383,7 @@ func getVerificationPolicy(name, namespace string, patterns []v1alpha1.ResourceP
Spec: v1alpha1.VerificationPolicySpec{
Resources: patterns,
Authorities: authorities,
Mode: v1alpha1.ModeEnforce,
Mode: mode,
},
}
}

0 comments on commit d4ff430

Please sign in to comment.