File: digest_test.go

package info (click to toggle)
go-containerregistry 0.20.1%2Bds1-1
  • links: PTS, VCS
  • area: main
  • in suites: experimental, forky, sid, trixie
  • size: 5,700 kB
  • sloc: sh: 183; makefile: 5
file content (209 lines) | stat: -rw-r--r-- 6,834 bytes parent folder | download
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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
// Copyright 2018 Google LLC All Rights Reserved.
//
// 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 name

import (
	"encoding/json"
	"path"
	"reflect"
	"strings"
	"testing"
)

const validDigest = "sha256:deadb33fdeadb33fdeadb33fdeadb33fdeadb33fdeadb33fdeadb33fdeadb33f"

var goodStrictValidationDigestNames = []string{
	"gcr.io/g-convoy/hello-world@" + validDigest,
	"gcr.io/google.com/project-id/hello-world@" + validDigest,
	"us.gcr.io/project-id/sub-repo@" + validDigest,
	"example.text/foo/bar@" + validDigest,
}

var goodStrictValidationTagDigestNames = []string{
	"example.text/foo/bar:latest@" + validDigest,
	"example.text:8443/foo/bar:latest@" + validDigest,
	"example.text/foo/bar:v1.0.0-alpine@" + validDigest,
}

var goodWeakValidationDigestNames = []string{
	"namespace/pathcomponent/image@" + validDigest,
	"library/ubuntu@" + validDigest,
}

var goodWeakValidationTagDigestNames = []string{
	"nginx:latest@" + validDigest,
	"library/nginx:latest@" + validDigest,
}

var badDigestNames = []string{
	"gcr.io/project-id/unknown-alg@unknown:abc123",
	"gcr.io/project-id/wrong-length@sha256:d34db33fd34db33f",
	"gcr.io/project-id/missing-digest@",
	// https://github.com/google/go-containerregistry/issues/1394
	"repo@sha256:" + strings.Repeat(":", 64),
	"repo@sha256:" + strings.Repeat("sh", 32),
	"repo@sha256:" + validDigest + "@" + validDigest,
}

func TestNewDigestStrictValidation(t *testing.T) {
	t.Parallel()

	for _, name := range goodStrictValidationDigestNames {
		if digest, err := NewDigest(name, StrictValidation); err != nil {
			t.Errorf("`%s` should be a valid Digest name, got error: %v", name, err)
		} else if digest.Name() != name {
			t.Errorf("`%v` .Name() should reproduce the original name. Wanted: %s Got: %s", digest, name, digest.Name())
		}
	}

	for _, name := range goodStrictValidationTagDigestNames {
		if _, err := NewDigest(name, StrictValidation); err != nil {
			t.Errorf("`%s` should be a valid Digest name, got error: %v", name, err)
		}
	}

	for _, name := range append(goodWeakValidationDigestNames, badDigestNames...) {
		if repo, err := NewDigest(name, StrictValidation); err == nil {
			t.Errorf("`%s` should be an invalid Digest name, got Digest: %#v", name, repo)
		}
	}
}

func TestNewDigest(t *testing.T) {
	t.Parallel()

	for _, name := range append(goodStrictValidationDigestNames, append(goodWeakValidationDigestNames, goodWeakValidationTagDigestNames...)...) {
		if _, err := NewDigest(name, WeakValidation); err != nil {
			t.Errorf("`%s` should be a valid Digest name, got error: %v", name, err)
		}
	}

	for _, name := range badDigestNames {
		if repo, err := NewDigest(name, WeakValidation); err == nil {
			t.Errorf("`%s` should be an invalid Digest name, got Digest: %#v", name, repo)
		}
	}
}

func TestDigestComponents(t *testing.T) {
	t.Parallel()
	testRegistry := "gcr.io"
	testRepository := "project-id/image"
	fullRepo := path.Join(testRegistry, testRepository)

	digestNameStr := testRegistry + "/" + testRepository + "@" + validDigest
	digest, err := NewDigest(digestNameStr, StrictValidation)
	if err != nil {
		t.Fatalf("`%s` should be a valid Digest name, got error: %v", digestNameStr, err)
	}

	if got := digest.String(); got != digestNameStr {
		t.Errorf("String() was incorrect for %v. Wanted: `%s` Got: `%s`", digest, digestNameStr, got)
	}
	if got := digest.Identifier(); got != validDigest {
		t.Errorf("Identifier() was incorrect for %v. Wanted: `%s` Got: `%s`", digest, validDigest, got)
	}
	actualRegistry := digest.RegistryStr()
	if actualRegistry != testRegistry {
		t.Errorf("RegistryStr() was incorrect for %v. Wanted: `%s` Got: `%s`", digest, testRegistry, actualRegistry)
	}
	actualRepository := digest.RepositoryStr()
	if actualRepository != testRepository {
		t.Errorf("RepositoryStr() was incorrect for %v. Wanted: `%s` Got: `%s`", digest, testRepository, actualRepository)
	}
	contextRepo := digest.Context().String()
	if contextRepo != fullRepo {
		t.Errorf("Context().String() was incorrect for %v. Wanted: `%s` Got: `%s`", digest, fullRepo, contextRepo)
	}
	actualDigest := digest.DigestStr()
	if actualDigest != validDigest {
		t.Errorf("DigestStr() was incorrect for %v. Wanted: `%s` Got: `%s`", digest, validDigest, actualDigest)
	}
}

func TestDigestScopes(t *testing.T) {
	t.Parallel()
	testRegistry := "gcr.io"
	testRepo := "project-id/image"
	testAction := "pull"

	expectedScope := strings.Join([]string{"repository", testRepo, testAction}, ":")

	digestNameStr := testRegistry + "/" + testRepo + "@" + validDigest
	digest, err := NewDigest(digestNameStr, StrictValidation)
	if err != nil {
		t.Fatalf("`%s` should be a valid Digest name, got error: %v", digestNameStr, err)
	}

	actualScope := digest.Scope(testAction)
	if actualScope != expectedScope {
		t.Errorf("scope was incorrect for %v. Wanted: `%s` Got: `%s`", digest, expectedScope, actualScope)
	}
}

func TestJSON(t *testing.T) {
	t.Parallel()
	digestNameStr := "gcr.io/project-id/image@" + validDigest
	digest, err := NewDigest(digestNameStr, StrictValidation)
	if err != nil {
		t.Fatalf("`%s` should be a valid Digest name, got error: %v", digestNameStr, err)
	}

	t.Run("string", func(t *testing.T) {
		t.Parallel()
		b, err := json.Marshal(digest)
		if err != nil {
			t.Fatalf("Marshal() failed: %v", err)
		}

		if want := `"` + digestNameStr + `"`; want != string(b) {
			t.Errorf("Marshal() was incorrect. Wanted: `%s` Got: `%s`", want, string(b))
		}

		var out Digest
		if err := json.Unmarshal(b, &out); err != nil {
			t.Fatalf("Unmarshal() failed: %v", err)
		}

		if out.String() != digest.String() {
			t.Errorf("Unmarshaled Digest should be the same as the original. Wanted: `%s` Got: `%s`", digest, out)
		}
	})

	t.Run("map", func(t *testing.T) {
		t.Parallel()
		in := map[string]Digest{
			"a": digest,
		}
		b, err := json.Marshal(in)
		if err != nil {
			t.Fatalf("MarshalJSON() failed: %v", err)
		}

		want := `{"a":"` + digestNameStr + `"}`
		if want != string(b) {
			t.Errorf("Marshal() was incorrect. Wanted: `%s` Got: `%s`", want, string(b))
		}

		var out map[string]Digest
		if err := json.Unmarshal(b, &out); err != nil {
			t.Fatalf("Unmarshal() failed: %v", err)
		}

		if !reflect.DeepEqual(in, out) {
			t.Errorf("Unmarshaled map should be the same as the original. Wanted: `%v` Got: `%v`", in, out)
		}
	})
}