fix: standardize casing of initialisms (#112)

* fix: standardize casing of initialisms
* fix: rename intoto -> inToto and Intoto to InToto
* fix: fix all linting errors

pkg/mirror/example_mirror_test.go

@@ -14,12 +14,12 @@ import (
 
 type TufMirrorOutput struct {
 	metadata          v1.Image
-	delegatedMetadata []*mirror.MirrorImage
-	targets           []*mirror.MirrorImage
-	delegatedTargets  []*mirror.MirrorIndex
+	delegatedMetadata []*mirror.Image
+	targets           []*mirror.Image
+	delegatedTargets  []*mirror.Index
 }
 
-func ExampleNewTufMirror() {
+func ExampleNewTUFMirror() {
 	home, err := os.UserHomeDir()
 	if err != nil {
 		panic(err)
@@ -29,7 +29,7 @@ func ExampleNewTufMirror() {
 	// configure TUF mirror
 	metadataURI := "https://docker.github.io/tuf-staging/metadata"
 	targetsURI := "https://docker.github.io/tuf-staging/targets"
-	m, err := mirror.NewTufMirror(embed.RootStaging.Data, tufOutputPath, metadataURI, targetsURI, tuf.NewMockVersionChecker())
+	m, err := mirror.NewTUFMirror(embed.RootStaging.Data, tufOutputPath, metadataURI, targetsURI, tuf.NewMockVersionChecker())
 	if err != nil {
 		panic(err)
 	}
@@ -46,7 +46,7 @@ func ExampleNewTufMirror() {
 	}
 
 	// create targets manifest
-	targets, err := m.GetTufTargetMirrors()
+	targets, err := m.GetTUFTargetMirrors()
 	if err != nil {
 		panic(err)
 	}

pkg/mirror/metadata.go

@@ -16,9 +16,9 @@ import (
 // TUF root metadata
 // -----------------
 
-// GetMetadataManifest returns an image with TUF root metadata as layers
-func (m *TufMirror) GetMetadataManifest(metadataURL string) (v1.Image, error) {
-	metadata, err := m.getTufMetadataMirror(metadataURL)
+// GetMetadataManifest returns an image with TUF root metadata as layers.
+func (m *TUFMirror) GetMetadataManifest(metadataURL string) (v1.Image, error) {
+	metadata, err := m.getMetadataMirror(metadataURL)
 	if err != nil {
 		return nil, fmt.Errorf("failed to get metadata: %w", err)
 	}
@@ -29,16 +29,16 @@ func (m *TufMirror) GetMetadataManifest(metadataURL string) (v1.Image, error) {
 	return manifest, nil
 }
 
-// getTufMetadataMirror returns a TufMetadata struct with TUF metadata as map of file names to bytes
-func (m *TufMirror) getTufMetadataMirror(metadataURL string) (*TufMetadata, error) {
-	trustedMetadata := m.TufClient.GetMetadata()
+// getMetadataMirror returns a TufMetadata struct with TUF metadata as map of file names to bytes.
+func (m *TUFMirror) getMetadataMirror(metadataURL string) (*TUFMetadata, error) {
+	trustedMetadata := m.TUFClient.GetMetadata()
 
 	rootMetadata := map[string][]byte{}
 	rootVersion := trustedMetadata.Root.Signed.Version
 	// get the previous versions of root metadata if any
 	if rootVersion != 1 {
 		var err error
-		rootMetadata, err = m.TufClient.GetPriorRoots(metadataURL)
+		rootMetadata, err = m.TUFClient.GetPriorRoots(metadataURL)
 		if err != nil {
 			return nil, fmt.Errorf("failed to get prior root metadata: %w", err)
 		}
@@ -69,7 +69,7 @@ func (m *TufMirror) getTufMetadataMirror(metadataURL string) (*TufMetadata, erro
 		snapshotVersion = strconv.FormatInt(trustedMetadata.Snapshot.Signed.Version, 10)
 		targetsVersion = strconv.FormatInt(trustedMetadata.Targets[metadata.TARGETS].Signed.Version, 10)
 	}
-	return &TufMetadata{
+	return &TUFMetadata{
 		Root:      rootMetadata,
 		Snapshot:  map[string][]byte{nameFromRole(metadata.SNAPSHOT, snapshotVersion): snapshotBytes},
 		Targets:   map[string][]byte{nameFromRole(metadata.TARGETS, targetsVersion): targetsBytes},
@@ -77,12 +77,12 @@ func (m *TufMirror) getTufMetadataMirror(metadataURL string) (*TufMetadata, erro
 	}, nil
 }
 
-// buildMetadataManifest returns an OCI image with TUF metadata as layers with annotations
-func (m *TufMirror) buildMetadataManifest(metadata *TufMetadata) (v1.Image, error) {
+// buildMetadataManifest returns an OCI image with TUF metadata as layers with annotations.
+func (m *TUFMirror) buildMetadataManifest(metadata *TUFMetadata) (v1.Image, error) {
 	img := empty.Image
 	img = mutate.MediaType(img, types.OCIManifestSchema1)
 	img = mutate.ConfigMediaType(img, types.OCIConfigJSON)
-	for _, role := range TufRoles {
+	for _, role := range TUFRoles {
 		layers, err := m.makeRoleLayers(role, metadata)
 		if err != nil {
 			return nil, fmt.Errorf("failed to make role layer: %w", err)
@@ -95,8 +95,8 @@ func (m *TufMirror) buildMetadataManifest(metadata *TufMetadata) (v1.Image, erro
 	return img, nil
 }
 
-// makeRoleLayers returns a list of layers for a given TUF role
-func (m *TufMirror) makeRoleLayers(role TufRole, tufMetadata *TufMetadata) ([]mutate.Addendum, error) {
+// makeRoleLayers returns a list of layers for a given TUF role.
+func (m *TUFMirror) makeRoleLayers(role TUFRole, tufMetadata *TUFMetadata) ([]mutate.Addendum, error) {
 	var layers []mutate.Addendum
 	ann := map[string]string{tufFileAnnotation: ""}
 	switch role {
@@ -115,8 +115,8 @@ func (m *TufMirror) makeRoleLayers(role TufRole, tufMetadata *TufMetadata) ([]mu
 	return layers, nil
 }
 
-// annotatedMetaLayers returns a list of layers with annotations for each TUF metadata file
-func (m *TufMirror) annotatedMetaLayers(meta map[string][]byte) []mutate.Addendum {
+// annotatedMetaLayers returns a list of layers with annotations for each TUF metadata file.
+func (m *TUFMirror) annotatedMetaLayers(meta map[string][]byte) []mutate.Addendum {
 	var layers []mutate.Addendum
 	for name, data := range meta {
 		ann := map[string]string{tufFileAnnotation: name}
@@ -129,8 +129,8 @@ func (m *TufMirror) annotatedMetaLayers(meta map[string][]byte) []mutate.Addendu
 // TUF delegated targets metadata
 // ------------------------------
 
-// GetDelegatedMetadataMirrors returns a list of mirrors (image/tag pairs) for each delegated targets role metadata
-func (m *TufMirror) GetDelegatedMetadataMirrors() ([]*MirrorImage, error) {
+// GetDelegatedMetadataMirrors returns a list of mirrors (image/tag pairs) for each delegated targets role metadata.
+func (m *TUFMirror) GetDelegatedMetadataMirrors() ([]*Image, error) {
 	// get current delegated targets metadata
 	delegatedTargets, err := m.getDelegatedTargetsMetadata()
 	if err != nil {
@@ -143,12 +143,12 @@ func (m *TufMirror) GetDelegatedMetadataMirrors() ([]*MirrorImage, error) {
 	return mirror, nil
 }
 
-// getDelegatedTargetsMetadata returns delegated targets metadata as a list of DelegatedTargetMetadata (role name and data)
-func (m *TufMirror) getDelegatedTargetsMetadata() ([]DelegatedTargetMetadata, error) {
+// getDelegatedTargetsMetadata returns delegated targets metadata as a list of DelegatedTargetMetadata (role name and data).
+func (m *TUFMirror) getDelegatedTargetsMetadata() ([]DelegatedTargetMetadata, error) {
 	var delegatedTargets []DelegatedTargetMetadata
-	md := m.TufClient.GetMetadata()
+	md := m.TUFClient.GetMetadata()
 	for _, role := range md.Targets[metadata.TARGETS].Signed.Delegations.Roles {
-		roleMetadata, err := m.TufClient.LoadDelegatedTargets(role.Name, metadata.TARGETS)
+		roleMetadata, err := m.TUFClient.LoadDelegatedTargets(role.Name, metadata.TARGETS)
 		if err != nil {
 			return nil, fmt.Errorf("failed to get delegated role metadata: %w", err)
 		}
@@ -170,9 +170,9 @@ func (m *TufMirror) getDelegatedTargetsMetadata() ([]DelegatedTargetMetadata, er
 	return delegatedTargets, nil
 }
 
-// buildDelegatedMetadataManifests returns a list of mirrors (image/tag pairs) for each delegated target role metadata
-func (m *TufMirror) buildDelegatedMetadataManifests(delegated []DelegatedTargetMetadata) ([]*MirrorImage, error) {
-	manifests := []*MirrorImage{}
+// buildDelegatedMetadataManifests returns a list of mirrors (image/tag pairs) for each delegated target role metadata.
+func (m *TUFMirror) buildDelegatedMetadataManifests(delegated []DelegatedTargetMetadata) ([]*Image, error) {
+	manifests := []*Image{}
 	for _, role := range delegated {
 		img := empty.Image
 		img = mutate.MediaType(img, types.OCIManifestSchema1)
@@ -183,7 +183,7 @@ func (m *TufMirror) buildDelegatedMetadataManifests(delegated []DelegatedTargetM
 		if err != nil {
 			return nil, fmt.Errorf("failed to append delegated targets layer to image: %w", err)
 		}
-		manifests = append(manifests, &MirrorImage{Image: img, Tag: role.Name})
+		manifests = append(manifests, &Image{Image: img, Tag: role.Name})
 	}
 	return manifests, nil
 }

pkg/mirror/metadata_test.go

@@ -21,10 +21,10 @@ func TestGetTufMetadataMirror(t *testing.T) {
 	defer server.Close()
 
 	path := test.CreateTempDir(t, "", "tuf_temp")
-	m, err := NewTufMirror(embed.RootDev.Data, path, server.URL+"/metadata", server.URL+"/targets", tuf.NewMockVersionChecker())
+	m, err := NewTUFMirror(embed.RootDev.Data, path, server.URL+"/metadata", server.URL+"/targets", tuf.NewMockVersionChecker())
 	assert.NoError(t, err)
 
-	tufMetadata, err := m.getTufMetadataMirror(server.URL + "/metadata")
+	tufMetadata, err := m.getMetadataMirror(server.URL + "/metadata")
 	assert.NoError(t, err)
 
 	// check that all roles are not empty
@@ -39,7 +39,7 @@ func TestGetMetadataManifest(t *testing.T) {
 	defer server.Close()
 
 	path := test.CreateTempDir(t, "", "tuf_temp")
-	m, err := NewTufMirror(embed.RootDev.Data, path, server.URL+"/metadata", server.URL+"/targets", tuf.NewMockVersionChecker())
+	m, err := NewTUFMirror(embed.RootDev.Data, path, server.URL+"/metadata", server.URL+"/targets", tuf.NewMockVersionChecker())
 	assert.NoError(t, err)
 
 	img, err := m.GetMetadataManifest(server.URL + "/metadata")
@@ -78,7 +78,7 @@ func TestGetDelegatedMetadataMirrors(t *testing.T) {
 	defer server.Close()
 
 	path := test.CreateTempDir(t, "", "tuf_temp")
-	m, err := NewTufMirror(embed.RootDev.Data, path, server.URL+"/metadata", server.URL+"/targets", tuf.NewMockVersionChecker())
+	m, err := NewTUFMirror(embed.RootDev.Data, path, server.URL+"/metadata", server.URL+"/targets", tuf.NewMockVersionChecker())
 	assert.NoError(t, err)
 
 	delegations, err := m.GetDelegatedMetadataMirrors()

pkg/mirror/mirror.go

@@ -16,15 +16,15 @@ import (
 	"github.com/google/go-containerregistry/pkg/v1/remote"
 )
 
-func NewTufMirror(root []byte, tufPath, metadataURL, targetsURL string, versionChecker tuf.VersionChecker) (*TufMirror, error) {
+func NewTUFMirror(root []byte, tufPath, metadataURL, targetsURL string, versionChecker tuf.VersionChecker) (*TUFMirror, error) {
 	if root == nil {
 		root = embed.RootDefault.Data
 	}
-	tufClient, err := tuf.NewTufClient(root, tufPath, metadataURL, targetsURL, versionChecker)
+	tufClient, err := tuf.NewClient(root, tufPath, metadataURL, targetsURL, versionChecker)
 	if err != nil {
 		return nil, fmt.Errorf("failed to create TUF client: %w", err)
 	}
-	return &TufMirror{TufClient: tufClient, tufPath: tufPath, metadataURL: metadataURL, targetsURL: targetsURL}, nil
+	return &TUFMirror{TUFClient: tufClient, tufPath: tufPath, metadataURL: metadataURL, targetsURL: targetsURL}, nil
 }
 
 func PushImageToRegistry(image v1.Image, imageName string) error {
@@ -85,7 +85,7 @@ func SaveIndex(outputs []*oci.ImageSpec, index v1.ImageIndex, indexName string)
 				Add: index,
 				Descriptor: v1.Descriptor{
 					Annotations: map[string]string{
-						oci.OciReferenceTarget: indexName,
+						oci.OCIReferenceTarget: indexName,
 					},
 				},
 			})
@@ -110,7 +110,7 @@ func SaveImage(output *oci.ImageSpec, image v1.Image, imageName string) error {
 			Add: image,
 			Descriptor: v1.Descriptor{
 				Annotations: map[string]string{
-					oci.OciReferenceTarget: imageName,
+					oci.OCIReferenceTarget: imageName,
 				},
 			},
 		})
@@ -127,7 +127,7 @@ func SaveImage(output *oci.ImageSpec, image v1.Image, imageName string) error {
 	return nil
 }
 
-func SaveReferrers(manifest *attestation.AttestationManifest, outputs []*oci.ImageSpec) error {
+func SaveReferrers(manifest *attestation.Manifest, outputs []*oci.ImageSpec) error {
 	for _, output := range outputs {
 		if output.Type == oci.OCI {
 			continue

pkg/mirror/targets.go

@@ -13,16 +13,16 @@ import (
 	"github.com/theupdateframework/go-tuf/v2/metadata"
 )
 
-// GetTufTargetMirrors returns a list of top-level target files as MirrorImages (image with tag)
-func (m *TufMirror) GetTufTargetMirrors() ([]*MirrorImage, error) {
-	targetMirrors := []*MirrorImage{}
-	md := m.TufClient.GetMetadata()
+// GetTUFTargetMirrors returns a list of top-level target files as MirrorImages (image with tag).
+func (m *TUFMirror) GetTUFTargetMirrors() ([]*Image, error) {
+	targetMirrors := []*Image{}
+	md := m.TUFClient.GetMetadata()
 
 	// for each top-level target file, create an image with the target file as a layer
 	targets := md.Targets[metadata.TARGETS].Signed.Targets
 	for _, t := range targets {
 		// download target file
-		_, data, err := m.TufClient.DownloadTarget(t.Path, filepath.Join(m.tufPath, "download"))
+		_, data, err := m.TUFClient.DownloadTarget(t.Path, filepath.Join(m.tufPath, "download"))
 		if err != nil {
 			return nil, fmt.Errorf("failed to download target %s: %w", t.Path, err)
 		}
@@ -42,16 +42,16 @@ func (m *TufMirror) GetTufTargetMirrors() ([]*MirrorImage, error) {
 		if err != nil {
 			return nil, fmt.Errorf("failed to append role layer to image: %w", err)
 		}
-		targetMirrors = append(targetMirrors, &MirrorImage{Image: img, Tag: name})
+		targetMirrors = append(targetMirrors, &Image{Image: img, Tag: name})
 	}
 	return targetMirrors, nil
 }
 
 // GetDelegatedTargetMirrors returns a list of delegated target files as MirrorIndexes (image index with tag)
-// each image in the index contains a delegated target file
-func (m *TufMirror) GetDelegatedTargetMirrors() ([]*MirrorIndex, error) {
-	mirror := []*MirrorIndex{}
-	md := m.TufClient.GetMetadata()
+// each image in the index contains a delegated target file.
+func (m *TUFMirror) GetDelegatedTargetMirrors() ([]*Index, error) {
+	mirror := []*Index{}
+	md := m.TUFClient.GetMetadata()
 
 	// for each delegated role, create an image index with target files as images
 	roles := md.Targets[metadata.TARGETS].Signed.Delegations.Roles
@@ -60,7 +60,7 @@ func (m *TufMirror) GetDelegatedTargetMirrors() ([]*MirrorIndex, error) {
 		index := v1.ImageIndex(empty.Index)
 
 		// get delegated targets metadata for role
-		roleMeta, err := m.TufClient.LoadDelegatedTargets(role.Name, metadata.TARGETS)
+		roleMeta, err := m.TUFClient.LoadDelegatedTargets(role.Name, metadata.TARGETS)
 		if err != nil {
 			return nil, fmt.Errorf("failed to load delegated targets metadata: %w", err)
 		}
@@ -68,7 +68,7 @@ func (m *TufMirror) GetDelegatedTargetMirrors() ([]*MirrorIndex, error) {
 		// for each target file, create an image with the target file as a layer
 		for _, target := range roleMeta.Signed.Targets {
 			// download target file
-			_, data, err := m.TufClient.DownloadTarget(target.Path, filepath.Join(m.tufPath, "download"))
+			_, data, err := m.TUFClient.DownloadTarget(target.Path, filepath.Join(m.tufPath, "download"))
 			if err != nil {
 				return nil, fmt.Errorf("failed to download target %s: %w", target.Path, err)
 			}
@@ -103,7 +103,7 @@ func (m *TufMirror) GetDelegatedTargetMirrors() ([]*MirrorIndex, error) {
 				},
 			})
 		}
-		mirror = append(mirror, &MirrorIndex{Index: index, Tag: role.Name})
+		mirror = append(mirror, &Index{Index: index, Tag: role.Name})
 	}
 	return mirror, nil
 }

pkg/mirror/targets_test.go

@@ -27,10 +27,10 @@ func TestGetTufTargetsMirror(t *testing.T) {
 	defer server.Close()
 
 	path := test.CreateTempDir(t, "", "tuf_temp")
-	m, err := NewTufMirror(embed.RootDev.Data, path, server.URL+"/metadata", server.URL+"/targets", tuf.NewMockVersionChecker())
+	m, err := NewTUFMirror(embed.RootDev.Data, path, server.URL+"/metadata", server.URL+"/targets", tuf.NewMockVersionChecker())
 	assert.NoError(t, err)
 
-	targets, err := m.GetTufTargetMirrors()
+	targets, err := m.GetTUFTargetMirrors()
 	assert.NoError(t, err)
 	assert.Greater(t, len(targets), 0)
 
@@ -61,10 +61,10 @@ func TestTargetDelegationMetadata(t *testing.T) {
 	defer server.Close()
 
 	path := test.CreateTempDir(t, "", "tuf_temp")
-	tm, err := NewTufMirror(embed.RootDev.Data, path, server.URL+"/metadata", server.URL+"/targets", tuf.NewMockVersionChecker())
+	tm, err := NewTUFMirror(embed.RootDev.Data, path, server.URL+"/metadata", server.URL+"/targets", tuf.NewMockVersionChecker())
 	assert.NoError(t, err)
 
-	targets, err := tm.TufClient.LoadDelegatedTargets("test-role", "targets")
+	targets, err := tm.TUFClient.LoadDelegatedTargets("test-role", "targets")
 	assert.NoError(t, err)
 	assert.Greater(t, len(targets.Signed.Targets), 0)
 }
@@ -74,7 +74,7 @@ func TestGetDelegatedTargetMirrors(t *testing.T) {
 	defer server.Close()
 
 	path := test.CreateTempDir(t, "", "tuf_temp")
-	m, err := NewTufMirror(embed.RootDev.Data, path, server.URL+"/metadata", server.URL+"/targets", tuf.NewMockVersionChecker())
+	m, err := NewTUFMirror(embed.RootDev.Data, path, server.URL+"/metadata", server.URL+"/targets", tuf.NewMockVersionChecker())
 	assert.NoError(t, err)
 
 	mirrors, err := m.GetDelegatedTargetMirrors()

pkg/mirror/types.go

@@ -14,11 +14,11 @@ const (
 	tufFileAnnotation    = "tuf.io/filename"
 )
 
-type TufRole string
+type TUFRole string
 
-var TufRoles = []TufRole{metadata.ROOT, metadata.SNAPSHOT, metadata.TARGETS, metadata.TIMESTAMP}
+var TUFRoles = []TUFRole{metadata.ROOT, metadata.SNAPSHOT, metadata.TARGETS, metadata.TIMESTAMP}
 
-type TufMetadata struct {
+type TUFMetadata struct {
 	Root      map[string][]byte
 	Snapshot  map[string][]byte
 	Targets   map[string][]byte
@@ -31,18 +31,18 @@ type DelegatedTargetMetadata struct {
 	Data    []byte
 }
 
-type MirrorImage struct {
+type Image struct {
 	Image v1.Image
 	Tag   string
 }
 
-type MirrorIndex struct {
+type Index struct {
 	Index v1.ImageIndex
 	Tag   string
 }
 
-type TufMirror struct {
-	TufClient   *tuf.TufClient
+type TUFMirror struct {
+	TUFClient   *tuf.Client
 	tufPath     string
 	metadataURL string
 	targetsURL  string