|
| 1 | +// Copyright 2021 OCI Contributors |
| 2 | +// |
| 3 | +// Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | +// you may not use this file except in compliance with the License. |
| 5 | +// You may obtain a copy of the License at |
| 6 | +// |
| 7 | +// https://www.apache.org/licenses/LICENSE-2.0 |
| 8 | +// |
| 9 | +// Unless required by applicable law or agreed to in writing, software |
| 10 | +// distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 | +// See the License for the specific language governing permissions and |
| 13 | +// limitations under the License. |
| 14 | + |
| 15 | +// Package testdigest is a separate package, because it has some testing |
| 16 | +// utilities that may be useful to other internal Algorithm implementors. |
| 17 | +// |
| 18 | +// It is not a stable interface and not meant for consumption outside of |
| 19 | +// digest developers. |
| 20 | +package testdigest |
| 21 | + |
| 22 | +import ( |
| 23 | + "errors" |
| 24 | + "testing" |
| 25 | + |
| 26 | + "github.com/opencontainers/go-digest" |
| 27 | +) |
| 28 | + |
| 29 | +type TestCase struct { |
| 30 | + // Input the formal format of the hash, for example sha256:e58fcf7418d4390dec8e8fb69d88c06ec07039d651fedd3aa72af9972e7d046b |
| 31 | + Input string |
| 32 | + // If err is non-nil, then the parsing of Input is expected to return this error |
| 33 | + Err error |
| 34 | + // Algorithm should be an available or registered algorithm |
| 35 | + Algorithm digest.Algorithm |
| 36 | + // Encoded is the the encoded portion of the digest to expect, for example e58fcf7418d4390dec8e8fb69d88c06ec07039d651fedd3aa72af9972e7d046b |
| 37 | + Encoded string |
| 38 | +} |
| 39 | + |
| 40 | +func RunTestCase(t *testing.T, testcase TestCase) { |
| 41 | + dgst, err := digest.Parse(testcase.Input) |
| 42 | + if !errors.Is(err, testcase.Err) { |
| 43 | + t.Fatalf("error differed from expected while parsing %q: %v != %v", testcase.Input, err, testcase.Err) |
| 44 | + } |
| 45 | + |
| 46 | + if testcase.Err != nil { |
| 47 | + return |
| 48 | + } |
| 49 | + |
| 50 | + if dgst.Algorithm() != testcase.Algorithm { |
| 51 | + t.Fatalf("incorrect Algorithm for parsed digest: %q != %q", dgst.Algorithm(), testcase.Algorithm) |
| 52 | + } |
| 53 | + |
| 54 | + if dgst.Encoded() != testcase.Encoded { |
| 55 | + t.Fatalf("incorrect hex for parsed digest: %q != %q", dgst.Encoded(), testcase.Encoded) |
| 56 | + } |
| 57 | + |
| 58 | + // Parse string return value and check equality |
| 59 | + newParsed, err := digest.Parse(dgst.String()) |
| 60 | + if err != nil { |
| 61 | + t.Fatalf("unexpected error parsing Input %q: %v", testcase.Input, err) |
| 62 | + } |
| 63 | + |
| 64 | + if newParsed != dgst { |
| 65 | + t.Fatalf("expected equal: %q != %q", newParsed, dgst) |
| 66 | + } |
| 67 | + |
| 68 | + newFromHex := digest.NewDigestFromEncoded(newParsed.Algorithm(), newParsed.Encoded()) |
| 69 | + if newFromHex != dgst { |
| 70 | + t.Fatalf("%v != %v", newFromHex, dgst) |
| 71 | + } |
| 72 | +} |
0 commit comments