Lint fixes

Signed-off-by: Derek McGowan <derek@mcg.dev>
containerd · Nov 30, 2022 · 478f1c9 · 478f1c9
1 parent 28ea754
commit 478f1c9
Show file tree

Hide file tree

Showing 10 changed files with 28 additions and 23 deletions.
diff --git a/.golangci.yml b/.golangci.yml
@@ -41,6 +41,10 @@ linters-settings:
       - G306
       - G402
       - G404
+  misspell:
+    ignore-words:
+      - transferer
+      - transferers
 
 run:
   timeout: 8m

diff --git a/pkg/transfer/archive/exporter.go b/pkg/transfer/archive/exporter.go
@@ -29,7 +29,7 @@ import (
 )
 
 func init() {
-	// TODO: Move this to seperate package?
+	// TODO: Move this to separate package?
 	plugins.Register(&transfertypes.ImageExportStream{}, &ImageExportStream{})
 	plugins.Register(&transfertypes.ImageImportStream{}, &ImageImportStream{})
 }

diff --git a/pkg/transfer/image/imagestore.go b/pkg/transfer/image/imagestore.go
@@ -34,11 +34,11 @@ import (
 )
 
 func init() {
-	// TODO: Move this to seperate package?
-	plugins.Register(&transfertypes.ImageStore{}, &ImageStore{}) // TODO: Rename ImageStoreDestination
+	// TODO: Move this to separate package?
+	plugins.Register(&transfertypes.ImageStore{}, &Store{}) // TODO: Rename ImageStoreDestination
 }
 
-type ImageStore struct {
+type Store struct {
 	// TODO: Put these configurations in object which can convert to/from any
 	// Embed generated type
 	imageName     string
@@ -52,17 +52,17 @@ type ImageStore struct {
 	unpacks []unpack.Platform
 }
 
-func NewImageStore(image string) *ImageStore {
-	return &ImageStore{
+func NewStore(image string) *Store {
+	return &Store{
 		imageName: image,
 	}
 }
 
-func (is *ImageStore) String() string {
+func (is *Store) String() string {
 	return fmt.Sprintf("Local Image Store (%s)", is.imageName)
 }
 
-func (is *ImageStore) FilterHandler(h images.HandlerFunc, cs content.Store) images.HandlerFunc {
+func (is *Store) FilterHandler(h images.HandlerFunc, cs content.Store) images.HandlerFunc {
 	h = images.SetChildrenMappedLabels(cs, h, is.labelMap)
 	if is.allMetadata {
 		// Filter manifests by platforms but allow to handle manifest
@@ -80,7 +80,7 @@ func (is *ImageStore) FilterHandler(h images.HandlerFunc, cs content.Store) imag
 	return h
 }
 
-func (is *ImageStore) Store(ctx context.Context, desc ocispec.Descriptor, store images.Store) (images.Image, error) {
+func (is *Store) Store(ctx context.Context, desc ocispec.Descriptor, store images.Store) (images.Image, error) {
 	img := images.Image{
 		Name:   is.imageName,
 		Target: desc,
@@ -111,23 +111,23 @@ func (is *ImageStore) Store(ctx context.Context, desc ocispec.Descriptor, store
 	}
 }
 
-func (is *ImageStore) Get(ctx context.Context, store images.Store) (images.Image, error) {
+func (is *Store) Get(ctx context.Context, store images.Store) (images.Image, error) {
 	return store.Get(ctx, is.imageName)
 }
 
-func (is *ImageStore) UnpackPlatforms() []unpack.Platform {
+func (is *Store) UnpackPlatforms() []unpack.Platform {
 	return is.unpacks
 }
 
-func (is *ImageStore) MarshalAny(ctx context.Context, sm streaming.StreamCreator) (typeurl.Any, error) {
+func (is *Store) MarshalAny(ctx context.Context, sm streaming.StreamCreator) (typeurl.Any, error) {
 	s := &transfertypes.ImageStore{
 		Name: is.imageName,
 		// TODO: Support other fields
 	}
 	return typeurl.MarshalAny(s)
 }
 
-func (is *ImageStore) UnmarshalAny(ctx context.Context, sm streaming.StreamGetter, a typeurl.Any) error {
+func (is *Store) UnmarshalAny(ctx context.Context, sm streaming.StreamGetter, a typeurl.Any) error {
 	var s transfertypes.ImageStore
 	if err := typeurl.UnmarshalTo(a, &s); err != nil {
 		return err

diff --git a/pkg/transfer/image/registry.go b/pkg/transfer/image/registry.go
@@ -38,7 +38,7 @@ import (
 )
 
 func init() {
-	// TODO: Move this to seperate package?
+	// TODO: Move this to separate package?
 	plugins.Register(&transfertypes.OCIRegistry{}, &OCIRegistry{})
 }
 

diff --git a/pkg/transfer/local/pull.go b/pkg/transfer/local/pull.go
@@ -32,7 +32,7 @@ import (
 	"github.com/sirupsen/logrus"
 )
 
-func (ts *localTransferService) pull(ctx context.Context, ir transfer.ImageFetcher, is transfer.ImageStorer, tops *transfer.TransferOpts) error {
+func (ts *localTransferService) pull(ctx context.Context, ir transfer.ImageFetcher, is transfer.ImageStorer, tops *transfer.Config) error {
 	ctx, done, err := ts.withLease(ctx)
 	if err != nil {
 		return err
@@ -146,7 +146,7 @@ func (ts *localTransferService) pull(ctx context.Context, ir transfer.ImageFetch
 	handler = images.Handlers(append(baseHandlers,
 		fetchHandler(store, fetcher, progressTracker),
 		checkNeedsFix,
-		childrenHandler, // List children to track hierachy
+		childrenHandler, // List children to track hierarchy
 		appendDistSrcLabelHandler,
 	)...)
 

diff --git a/pkg/transfer/local/push.go b/pkg/transfer/local/push.go
@@ -25,7 +25,7 @@ import (
 	"github.com/containerd/containerd/remotes"
 )
 
-func (ts *localTransferService) push(ctx context.Context, ig transfer.ImageGetter, p transfer.ImagePusher, tops *transfer.TransferOpts) error {
+func (ts *localTransferService) push(ctx context.Context, ig transfer.ImageGetter, p transfer.ImagePusher, tops *transfer.Config) error {
 	/*
 		// TODO: Platform matching
 		if pushCtx.PlatformMatcher == nil {

diff --git a/pkg/transfer/local/transfer.go b/pkg/transfer/local/transfer.go
@@ -58,7 +58,7 @@ func NewTransferService(lm leases.Manager, cs content.Store, is images.Store) tr
 }
 
 func (ts *localTransferService) Transfer(ctx context.Context, src interface{}, dest interface{}, opts ...transfer.Opt) error {
-	topts := &transfer.TransferOpts{}
+	topts := &transfer.Config{}
 	for _, opt := range opts {
 		opt(topts)
 	}
@@ -100,7 +100,7 @@ func name(t interface{}) string {
 
 // echo is mostly used for testing, it implements an import->export which is
 // a no-op which only roundtrips the bytes.
-func (ts *localTransferService) echo(ctx context.Context, i transfer.ImageImportStreamer, e transfer.ImageExportStreamer, tops *transfer.TransferOpts) error {
+func (ts *localTransferService) echo(ctx context.Context, i transfer.ImageImportStreamer, e transfer.ImageExportStreamer, tops *transfer.Config) error {
 	r, err := i.ImportStream(ctx)
 	if err != nil {
 		return err

diff --git a/pkg/transfer/proxy/transfer.go b/pkg/transfer/proxy/transfer.go
@@ -45,7 +45,7 @@ func NewTransferer(client transferapi.TransferClient, sc streaming.StreamCreator
 }
 
 func (p *proxyTransferer) Transfer(ctx context.Context, src interface{}, dst interface{}, opts ...transfer.Opt) error {
-	o := &transfer.TransferOpts{}
+	o := &transfer.Config{}
 	for _, opt := range opts {
 		opt(o)
 	}

diff --git a/pkg/transfer/transfer.go b/pkg/transfer/transfer.go
@@ -86,14 +86,14 @@ type ImageUnpacker interface {
 
 type ProgressFunc func(Progress)
 
-type TransferOpts struct {
+type Config struct {
 	Progress ProgressFunc
 }
 
-type Opt func(*TransferOpts)
+type Opt func(*Config)
 
 func WithProgress(f ProgressFunc) Opt {
-	return func(opts *TransferOpts) {
+	return func(opts *Config) {
 		opts.Progress = f
 	}
 }

diff --git a/plugins/transfer/plugin.go b/plugins/transfer/plugin.go
@@ -22,6 +22,7 @@ import (
 	"github.com/containerd/containerd/pkg/transfer/local"
 	"github.com/containerd/containerd/plugin"
 
+	// Load packages with type registrations
 	_ "github.com/containerd/containerd/pkg/transfer/archive"
 	_ "github.com/containerd/containerd/pkg/transfer/image"
 )