pin/api_stability_test.go at main · git-pkgs/pin · GitHub

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
package pin_test

import (
	"testing"

	pin "github.com/git-pkgs/pin"
	"github.com/git-pkgs/pin/lock"
	"github.com/git-pkgs/pin/manifest"
	"github.com/git-pkgs/pin/pinfs"
)

// TestPublicAPIStability is a compile-time guard rail: it references
// every public symbol pin commits to keeping stable across minor
// releases. Removing, renaming, or changing the type of any of these
// is a breaking change and must ship under a new major version.
//
// The test never fails at runtime; the value is in the build error
// that surfaces when an exported symbol is missing.
func TestPublicAPIStability(t *testing.T) {
	t.Parallel()

	// Top-level functions.
	_ = pin.New
	_ = pin.Sync
	_ = pin.Add
	_ = pin.Outdated
	_ = pin.OutdatedExitCode
	_ = pin.Verify
	_ = pin.Remove
	_ = pin.List
	_ = pin.Path
	_ = pin.Init
	_ = pin.SBOM
	_ = pin.EncodeLock

	// Configuration and result types.
	var _ pin.ClientOptions
	var _ pin.Client
	var _ pin.SyncOptions
	var _ pin.SyncResult
	var _ pin.AddOptions
	var _ pin.AddResult
	var _ pin.OutdatedOptions
	var _ pin.OutdatedReport
	var _ pin.VerifyOptions
	var _ pin.VerifyResult
	var _ pin.Drift
	var _ pin.ListEntry
	var _ pin.SBOMOptions
	var _ pin.SBOMFormat

	// Sentinel errors. Callers branch with errors.Is.
	_ = pin.ErrNoLockfile
	_ = pin.ErrFrozenDrift
	_ = pin.ErrVerifyFailed
	_ = pin.ErrProvenanceMissing
	_ = pin.ErrPublisherMismatch
	_ = pin.ErrPathEscape
	_ = pin.ErrPathCollision

	// Constants.
	_ = pin.DefaultManifest
	_ = pin.DefaultLock
	_ = pin.ToolName
	_ = pin.ToolVersion
	_ = pin.SeverityOK
	_ = pin.SeverityBehind
	_ = pin.SeverityDeprecated
	_ = pin.SeverityYanked
	_ = pin.SeverityProvenanceDowngrade
	_ = pin.ExitOutdated
	_ = pin.ExitYanked
	_ = pin.SBOMCycloneDXJSON
	_ = pin.SBOMCycloneDXXML
	_ = pin.SBOMSPDXJSON

	// pinfs sub-package: the writable-filesystem abstraction.
	_ = pinfs.OS
	_ = pinfs.NewMemory
	var _ pinfs.Writer
	var _ pinfs.Memory

	// lock sub-package.
	var _ lock.Lock
	var _ lock.Asset
	var _ lock.Attestation
	var _ lock.Changes
	_ = lock.Read
	_ = lock.Write
	_ = lock.Diff

	// manifest sub-package.
	var _ manifest.Manifest
	var _ manifest.Entry
	var _ manifest.Trust
	var _ manifest.Source
	_ = manifest.Read
	_ = manifest.AddEntry
	_ = manifest.RemoveEntry
	_ = manifest.ParseSource
}