Embed SignOptions in RemoteSignOptions

Signed-off-by: Byron Chien <[email protected]>

example_remoteSign_test.go

@@ -46,10 +46,9 @@ func Example_remoteSign() {
 	exampleRepo := registry.NewRepository(remoteRepo)
 
 	// exampleSignOptions is an example of notation.SignOptions.
-	exampleSignOptions := notation.RemoteSignOptions{
-		ArtifactReference:  exampleArtifactReference,
-		SignatureMediaType: exampleSignatureMediaType,
-	}
+	exampleSignOptions := notation.RemoteSignOptions{}
+	exampleSignOptions.ArtifactReference =  exampleArtifactReference
+	exampleSignOptions.SignatureMediaType = exampleSignatureMediaType
 
 	// remote sign core process
 	// upon successful signing, descriptor of the sign content is returned and

notation.go

@@ -26,8 +26,8 @@ const annotationX509ChainThumbprint = "io.cncf.notary.x509chain.thumbprint#S256"
 var errDoneVerification = errors.New("done verification")
 var reservedAnnotationPrefixes = [...]string{"io.cncf.notary"}
 
-// RemoteSignOptions contains parameters for notation.Sign.
-type RemoteSignOptions struct {
+// SignOptions contains parameters for Signer.Sign.
+type SignOptions struct {
 	// ArtifactReference sets the reference of the artifact that needs to be signed.
 	ArtifactReference string
 
@@ -43,32 +43,16 @@ type RemoteSignOptions struct {
 	// PluginConfig sets or overrides the plugin configuration.
 	PluginConfig map[string]string
 
-	// UserMetadata contains key-value pairs that are added to the signature payload
-	UserMetadata map[string]string
-
 	// SigningAgent sets the signing agent name
 	SigningAgent string
 }
 
-// SignOptions contains parameters for Signer.Sign.
-type SignOptions struct {
-	// ArtifactReference sets the reference of the artifact that needs to be signed.
-	ArtifactReference string
-
-	// SignatureMediaType is the envelope type of the signature.
-	// Currently both `application/jose+json` and `application/cose` are
-	// supported.
-	SignatureMediaType string
-
-	// ExpiryDuration identifies the expiry duration of the resulted signature. Zero value
-	// represents no expiry duration.
-	ExpiryDuration time.Duration
-
-	// PluginConfig sets or overrides the plugin configuration.
-	PluginConfig map[string]string
+// RemoteSignOptions contains parameters for notation.Sign.
+type RemoteSignOptions struct {
+	SignOptions
 
-	// SigningAgent sets the signing agent name
-	SigningAgent string
+	// UserMetadata contains key-value pairs that are added to the signature payload
+	UserMetadata map[string]string
 }
 
 // Signer is a generic interface for signing an artifact.
@@ -317,8 +301,7 @@ func Verify(ctx context.Context, verifier Verifier, repo registry.Repository, re
 	errExceededMaxVerificationLimit := ErrorVerificationFailed{Msg: fmt.Sprintf("total number of signatures associated with an artifact should be less than: %d", remoteOpts.MaxSignatureAttempts)}
 	numOfSignatureProcessed := 0
 
-	var verificationFailedErr error
-	verificationFailedErr = ErrorVerificationFailed{}
+	var verificationFailedErr error = ErrorVerificationFailed{}
 
 	// get signature manifests
 	logger.Debug("Fetching signature manifests using referrers API")

notation_test.go

@@ -28,10 +28,10 @@ func TestSignSuccess(t *testing.T) {
 	}
 	for _, tc := range testCases {
 		t.Run(tc.name, func(b *testing.T) {
-			opts := RemoteSignOptions{
-				ExpiryDuration:    tc.dur,
-				ArtifactReference: mock.SampleArtifactUri,
-			}
+			opts := RemoteSignOptions{}
+			opts.ExpiryDuration = tc.dur
+			opts.ArtifactReference = mock.SampleArtifactUri
+
 			_, err := Sign(context.Background(), &dummySigner{}, repo, opts)
 			if err != nil {
 				b.Fatalf("Sign failed with error: %v", err)
@@ -42,10 +42,10 @@ func TestSignSuccess(t *testing.T) {
 
 func TestSignSuccessWithUserMetadata(t *testing.T) {
 	repo := mock.NewRepository()
-	opts := RemoteSignOptions{
-		ArtifactReference: mock.SampleArtifactUri,
-		UserMetadata:      expectedMetadata,
-	}
+	opts := RemoteSignOptions{}
+	opts.ArtifactReference = mock.SampleArtifactUri
+	opts.UserMetadata = expectedMetadata
+
 	_, err := Sign(context.Background(), &verifyMetadataSigner{}, repo, opts)
 	if err != nil {
 		t.Fatalf("error: %v", err)
@@ -63,7 +63,10 @@ func TestSignWithInvalidExpiry(t *testing.T) {
 	}
 	for _, tc := range testCases {
 		t.Run(tc.name, func(b *testing.T) {
-			_, err := Sign(context.Background(), &dummySigner{}, repo, RemoteSignOptions{ExpiryDuration: tc.dur})
+			opts := RemoteSignOptions{}
+			opts.ExpiryDuration = tc.dur
+
+			_, err := Sign(context.Background(), &dummySigner{}, repo, opts)
 			if err == nil {
 				b.Fatalf("Expected error but not found")
 			}