File: payload_test.go

package info (click to toggle)
golang-github-sigstore-sigstore 1.9.5-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,052 kB
  • sloc: makefile: 87; sh: 45
file content (165 lines) | stat: -rw-r--r-- 6,002 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
//
// Copyright 2021 The Sigstore Authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package payload

import (
	"encoding/json"
	"testing"

	"github.com/go-test/deep"
	"github.com/google/go-containerregistry/pkg/name"
)

const validDigest = "sha256:d34db33fd34db33fd34db33fd34db33fd34db33fd34db33fd34db33fd34db33f"

func mustParseDigest(t *testing.T, digestStr string) name.Digest {
	t.Helper()
	digest, err := name.NewDigest(digestStr)
	if err != nil {
		t.Fatalf("could not parse digest %q: %v", digestStr, err)
	}
	return digest
}

func TestMarshalCosign(t *testing.T) {
	t.Parallel()
	testCases := []struct {
		desc       string
		imgPayload Cosign
		expected   string
	}{
		{
			desc: "no claims",
			imgPayload: Cosign{
				Image: mustParseDigest(t, "example.com/test/image@"+validDigest),
			},
			expected: `{"critical":{"identity":{"docker-reference":"example.com/test/image"},"image":{"docker-manifest-digest":"sha256:d34db33fd34db33fd34db33fd34db33fd34db33fd34db33fd34db33fd34db33f"},"type":"cosign container image signature"},"optional":null}`,
		},
		{
			desc: "standard atomic signature",
			imgPayload: Cosign{
				Image: mustParseDigest(t, "example.com/atomic/test/image@"+validDigest),
				Annotations: map[string]interface{}{
					"creator":   "atomic",
					"timestamp": 1458239713,
				},
			},
			expected: `{"critical":{"identity":{"docker-reference":"example.com/atomic/test/image"},"image":{"docker-manifest-digest":"sha256:d34db33fd34db33fd34db33fd34db33fd34db33fd34db33fd34db33fd34db33f"},"type":"cosign container image signature"},"optional":{"creator":"atomic","timestamp":1458239713}}`,
		},
		{
			desc: "arbitrary claims",
			imgPayload: Cosign{
				Image: mustParseDigest(t, "example.com/cosign/test/image@"+validDigest),
				Annotations: map[string]interface{}{
					"creator": "anyone",
					"some_struct": map[string]interface{}{
						"foo":     "bar",
						"false":   true,
						"nothing": nil,
					},
					"CamelCase WithSpace": 8.314,
				},
			},
			expected: `{"critical":{"identity":{"docker-reference":"example.com/cosign/test/image"},"image":{"docker-manifest-digest":"sha256:d34db33fd34db33fd34db33fd34db33fd34db33fd34db33fd34db33fd34db33f"},"type":"cosign container image signature"},"optional":{"CamelCase WithSpace":8.314,"creator":"anyone","some_struct":{"false":true,"foo":"bar","nothing":null}}}`,
		},
		{
			desc: "custom identity",
			imgPayload: Cosign{
				Image:           mustParseDigest(t, "example.com/test/image@"+validDigest),
				ClaimedIdentity: "docker.io/library/test:1.2.3",
			},
			expected: `{"critical":{"identity":{"docker-reference":"docker.io/library/test:1.2.3"},"image":{"docker-manifest-digest":"sha256:d34db33fd34db33fd34db33fd34db33fd34db33fd34db33fd34db33fd34db33f"},"type":"cosign container image signature"},"optional":null}`,
		},
	}

	for _, tc := range testCases {
		t.Run(tc.desc, func(t *testing.T) {
			tc := tc
			t.Parallel()
			payload, err := json.Marshal(tc.imgPayload)
			if err != nil {
				t.Fatalf("json.Marshal returned error: %v", err)
			}

			if tc.expected != string(payload) {
				t.Errorf("marshaled payload was %q, wanted %q", string(payload), tc.expected)
			}
		})
	}
}

func TestUnmarshalCosign(t *testing.T) {
	t.Parallel()
	testCases := []struct {
		desc    string
		payload string

		expected  Cosign
		expectErr bool
	}{
		{
			desc:    "no claims",
			payload: `{"critical":{"identity":{"docker-reference":"example.com/test/image"},"image":{"docker-manifest-digest":"sha256:d34db33fd34db33fd34db33fd34db33fd34db33fd34db33fd34db33fd34db33f"},"type":"cosign container image signature"},"optional":null}`,
			expected: Cosign{
				Image:           mustParseDigest(t, "example.com/test/image@"+validDigest),
				ClaimedIdentity: "example.com/test/image",
			},
		},
		{
			desc:    "arbitrary claims",
			payload: `{"critical":{"identity":{"docker-reference":"example.com/cosign/test/image"},"image":{"docker-manifest-digest":"sha256:d34db33fd34db33fd34db33fd34db33fd34db33fd34db33fd34db33fd34db33f"},"type":"cosign container image signature"},"optional":{"CamelCase WithSpace":8.314,"creator":"anyone","some_struct":{"false":true,"foo":"bar","nothing":null}}}`,
			expected: Cosign{
				Image:           mustParseDigest(t, "example.com/cosign/test/image@"+validDigest),
				ClaimedIdentity: "example.com/cosign/test/image",
				Annotations: map[string]interface{}{
					"creator": "anyone",
					"some_struct": map[string]interface{}{
						"foo":     "bar",
						"false":   true,
						"nothing": nil,
					},
					"CamelCase WithSpace": 8.314,
				},
			},
		},
		{
			desc:      "unknown type",
			payload:   `{"critical":{"identity":{"docker-reference":"example.com/atomic/test/image"},"image":{"docker-manifest-digest":"sha256:d34db33fd34db33fd34db33fd34db33fd34db33fd34db33fd34db33fd34db33f"},"type":"atomic container signature"},"optional":{}}`,
			expectErr: true,
		},
	}

	for _, tc := range testCases {
		t.Run(tc.desc, func(t *testing.T) {
			tc := tc
			t.Parallel()
			var imgPayload Cosign
			err := json.Unmarshal([]byte(tc.payload), &imgPayload)
			if err != nil {
				if !tc.expectErr {
					t.Fatalf("json.Unmarshal unexpectedly returned an error: %v", err)
				}
				return // operation failed successfully
			}
			if tc.expectErr {
				t.Fatalf("json.Unmarshal returned %v, expected an error", imgPayload)
			}
			if diff := deep.Equal(tc.expected, imgPayload); diff != nil {
				t.Errorf("Cosign unmarshalled incorrectly: %v", diff)
			}
		})
	}
}