refactor: Add extra linting for better line length (#42)

.go-tools

@@ -1,2 +1,3 @@
 github.com/oligot/[email protected]
 gotest.tools/[email protected]
+github.com/segmentio/[email protected]

.golangci.yml

@@ -17,7 +17,7 @@ linters:
     - gocritic
     - gocyclo
     - godot
-    - gofmt
+    - gofumpt
     - gosec
     - gosimple
     - govet
@@ -54,6 +54,16 @@ linters-settings:
     check-error-free-encoding: true
   gci:
     local-prefixes: github.com/mesosphere/mindthegap
+  gocritic:
+    enabled-tags:
+      - diagnostic
+      - experimental
+      - opinionated
+      - performance
+      - style
+  gofumpt:
+    lang-version: "1.17"
+    extra-rules: true
   lll:
     line-length: 120
 

archive/archive_test.go

@@ -59,8 +59,11 @@ func TestArchiveDirectorySuccess(t *testing.T) {
 		}
 		var buf bytes.Buffer
 		_, err = io.CopyN(&buf, tr, 1024)
-		require.Condition(t,
-			func() (success bool) { return err == nil || err == io.EOF }, "error reading content from tarball")
+		require.Condition(
+			t,
+			func() (success bool) { return err == nil || err == io.EOF },
+			"error reading content from tarball",
+		)
 		archivedContents[hdr.Name] = buf.String()
 	}
 
@@ -70,24 +73,36 @@ func TestArchiveDirectorySuccess(t *testing.T) {
 func TestArchiveDirectoryDestDirNotWritable(t *testing.T) {
 	tmpDir := t.TempDir()
 	notWriteable := filepath.Join(tmpDir, "notwritable")
-	require.NoError(t, os.Mkdir(notWriteable, 0500), "error creating not writable directory")
+	require.NoError(t, os.Mkdir(notWriteable, 0o500), "error creating not writable directory")
 	outputFile := filepath.Join(notWriteable, "out.tar.gz")
-	require.Error(t, archive.ArchiveDirectory("testdata", outputFile), "expected error archiving directory")
+	require.Error(
+		t,
+		archive.ArchiveDirectory("testdata", outputFile),
+		"expected error archiving directory",
+	)
 }
 
 func TestArchiveDirectoryDestFileExists(t *testing.T) {
 	tmpDir := t.TempDir()
 	outputFile := filepath.Join(tmpDir, "out.tar.gz")
-	f, err := os.OpenFile(outputFile, os.O_CREATE, 0400)
+	f, err := os.OpenFile(outputFile, os.O_CREATE, 0o400)
 	require.NoError(t, err, "error creating dummy file")
 	require.NoError(t, f.Close(), "error closing dummy file")
-	require.NoError(t, archive.ArchiveDirectory("testdata", outputFile), "unexpected error archiving directory")
+	require.NoError(
+		t,
+		archive.ArchiveDirectory("testdata", outputFile),
+		"unexpected error archiving directory",
+	)
 }
 
 func TestArchiveDirectoryUnreadableSource(t *testing.T) {
 	tmpDir := t.TempDir()
 	unreadable := filepath.Join(tmpDir, "unreadable")
-	require.NoError(t, os.Mkdir(unreadable, 0100), "error creating unreadable directory")
+	require.NoError(t, os.Mkdir(unreadable, 0o100), "error creating unreadable directory")
 	outputFile := filepath.Join(tmpDir, "out.tar.gz")
-	require.Error(t, archive.ArchiveDirectory(unreadable, outputFile), "expected error archiving directory")
+	require.Error(
+		t,
+		archive.ArchiveDirectory(unreadable, outputFile),
+		"expected error archiving directory",
+	)
 }

cmd/create/imagebundle/image_bundle.go

@@ -38,10 +38,17 @@ func NewCommand(out output.Output) *cobra.Command {
 				switch {
 				case err == nil:
 					out.EndOperation(false)
-					return fmt.Errorf("%s already exists: specify --overwrite to overwrite existing file", outputFile)
+					return fmt.Errorf(
+						"%s already exists: specify --overwrite to overwrite existing file",
+						outputFile,
+					)
 				case !errors.Is(err, os.ErrNotExist):
 					out.EndOperation(false)
-					return fmt.Errorf("failed to check if output file %s already exists: %w", outputFile, err)
+					return fmt.Errorf(
+						"failed to check if output file %s already exists: %w",
+						outputFile,
+						err,
+					)
 				default:
 					out.EndOperation(true)
 				}
@@ -60,7 +67,10 @@ func NewCommand(out output.Output) *cobra.Command {
 			outputFileAbs, err := filepath.Abs(outputFile)
 			if err != nil {
 				out.EndOperation(false)
-				return fmt.Errorf("failed to determine where to create temporary directory: %w", err)
+				return fmt.Errorf(
+					"failed to determine where to create temporary directory: %w",
+					err,
+				)
 			}
 
 			cleaner := cleanup.NewCleaner()
@@ -100,7 +110,10 @@ func NewCommand(out output.Output) *cobra.Command {
 				if registryConfig.Credentials != nil && registryConfig.Credentials.Username != "" {
 					skopeoOpts = append(
 						skopeoOpts,
-						skopeo.SrcCredentials(registryConfig.Credentials.Username, registryConfig.Credentials.Password),
+						skopeo.SrcCredentials(
+							registryConfig.Credentials.Username,
+							registryConfig.Credentials.Password,
+						),
 					)
 				} else {
 					skopeoStdout, skopeoStderr, err := skopeoRunner.AttemptToLoginToRegistry(context.TODO(), registryName)
@@ -121,7 +134,8 @@ func NewCommand(out output.Output) *cobra.Command {
 						)
 
 						srcImageManifestList, skopeoStdout, skopeoStderr, err := skopeoRunner.InspectManifest(
-							context.TODO(), fmt.Sprintf("docker://%s", srcImageName),
+							context.TODO(),
+							fmt.Sprintf("docker://%s", srcImageName),
 						)
 						if err != nil {
 							out.EndOperation(false)
@@ -131,9 +145,15 @@ func NewCommand(out output.Output) *cobra.Command {
 						}
 						out.V(4).Infof("---skopeo stdout---:\n%s", skopeoStdout)
 						out.V(4).Infof("---skopeo stderr---:\n%s", skopeoStderr)
-						destImageManifestList := manifestlist.ManifestList{Versioned: srcImageManifestList.Versioned}
-						platformManifests := make(map[string]manifestlist.ManifestDescriptor, len(srcImageManifestList.Manifests))
-						for _, m := range srcImageManifestList.Manifests {
+						destImageManifestList := manifestlist.ManifestList{
+							Versioned: srcImageManifestList.Versioned,
+						}
+						platformManifests := make(
+							map[string]manifestlist.ManifestDescriptor,
+							len(srcImageManifestList.Manifests),
+						)
+						for i := range srcImageManifestList.Manifests {
+							m := srcImageManifestList.Manifests[i]
 							srcManifestPlatform := m.Platform.OS + "/" + m.Platform.Architecture
 							if m.Platform.Variant != "" {
 								srcManifestPlatform += "/" + m.Platform.Variant
@@ -150,16 +170,34 @@ func NewCommand(out output.Output) *cobra.Command {
 								platformManifest, ok = platformManifests[p.String()]
 								if !ok {
 									out.EndOperation(false)
-									return fmt.Errorf("could not find platform %s for image %s", p, srcImageName)
+									return fmt.Errorf(
+										"could not find platform %s for image %s",
+										p,
+										srcImageName,
+									)
 								}
 							}
 
-							skopeoStdout, skopeoStderr, err := skopeoRunner.Copy(context.TODO(),
-								fmt.Sprintf("docker://%s/%s@%s", registryName, imageName, platformManifest.Digest),
-								fmt.Sprintf("docker://%s/%s@%s", reg.Address(), imageName, platformManifest.Digest),
+							skopeoStdout, skopeoStderr, err := skopeoRunner.Copy(
+								context.TODO(),
+								fmt.Sprintf(
+									"docker://%s/%s@%s",
+									registryName,
+									imageName,
+									platformManifest.Digest,
+								),
+								fmt.Sprintf(
+									"docker://%s/%s@%s",
+									reg.Address(),
+									imageName,
+									platformManifest.Digest,
+								),
 								append(
 									skopeoOpts,
-									skopeo.DisableDestTLSVerify(), skopeo.OS(p.os), skopeo.Arch(p.arch), skopeo.Variant(p.variant),
+									skopeo.DisableDestTLSVerify(),
+									skopeo.OS(p.os),
+									skopeo.Arch(p.arch),
+									skopeo.Variant(p.variant),
 								)...,
 							)
 							if err != nil {
@@ -171,7 +209,10 @@ func NewCommand(out output.Output) *cobra.Command {
 							out.V(4).Infof("---skopeo stdout---:\n%s", skopeoStdout)
 							out.V(4).Infof("---skopeo stderr---:\n%s", skopeoStderr)
 
-							destImageManifestList.Manifests = append(destImageManifestList.Manifests, platformManifest)
+							destImageManifestList.Manifests = append(
+								destImageManifestList.Manifests,
+								platformManifest,
+							)
 						}
 						skopeoStdout, skopeoStderr, err = skopeoRunner.CopyManifest(context.TODO(),
 							destImageManifestList,
@@ -212,10 +253,13 @@ func NewCommand(out output.Output) *cobra.Command {
 	cmd.Flags().StringVar(&configFile, "images-file", "",
 		"File containing list of images to create bundle from, either as YAML configuration or a simple list of images")
 	_ = cmd.MarkFlagRequired("images-file")
-	cmd.Flags().Var(newPlatformSlicesValue([]platform{{os: "linux", arch: "amd64"}}, &platforms), "platform",
-		"platforms to download images (required format: <os>/<arch>[/<variant>])")
-	cmd.Flags().StringVar(&outputFile, "output-file", "images.tar.gz", "Output file to write image bundle to")
-	cmd.Flags().BoolVar(&overwrite, "overwrite", false, "Overwrite image bundle file if it already exists")
+	cmd.Flags().
+		Var(newPlatformSlicesValue([]platform{{os: "linux", arch: "amd64"}}, &platforms), "platform",
+			"platforms to download images (required format: <os>/<arch>[/<variant>])")
+	cmd.Flags().
+		StringVar(&outputFile, "output-file", "images.tar.gz", "Output file to write image bundle to")
+	cmd.Flags().
+		BoolVar(&overwrite, "overwrite", false, "Overwrite image bundle file if it already exists")
 
 	return cmd
 }

cmd/create/imagebundle/platforms_flag.go

@@ -90,7 +90,10 @@ func writePlatformsAsCSV(vals []platform) (string, error) {
 func parsePlatformString(s string) (platform, error) {
 	splitVal := strings.Split(s, "/")
 	if len(splitVal) < 2 || len(splitVal) > 3 {
-		return platform{}, fmt.Errorf("invalid platform specification: %s (required format: <os>/<arch>[/<variant>]", s)
+		return platform{}, fmt.Errorf(
+			"invalid platform specification: %s (required format: <os>/<arch>[/<variant>]",
+			s,
+		)
 	}
 	p := platform{os: splitVal[0], arch: splitVal[1]}
 	if len(splitVal) == 3 {

cmd/create/imagebundle/platforms_flag_test.go

@@ -231,7 +231,11 @@ func TestSSWithComma(t *testing.T) {
 	values := f.Lookup("ps").Value.(*platformSliceValue)
 
 	if len(expected) != len(*values.value) {
-		t.Fatalf("expected number of values to be %d but got: %d", len(expected), len(*values.value))
+		t.Fatalf(
+			"expected number of values to be %d but got: %d",
+			len(expected),
+			len(*values.value),
+		)
 	}
 	for i, v := range *values.value {
 		if expected[i] != v {
@@ -256,7 +260,12 @@ func TestPSAsSliceValue(t *testing.T) {
 		}
 	})
 	expectedPlatform := platform{os: "windows", arch: "arm", variant: "v7"}
-	require.ElementsMatch(t, []platform{expectedPlatform}, ps, "Expected ps to be overwritten with 'windows/arm/v7'")
+	require.ElementsMatch(
+		t,
+		[]platform{expectedPlatform},
+		ps,
+		"Expected ps to be overwritten with 'windows/arm/v7'",
+	)
 }
 
 func TestPSGetSlice(t *testing.T) {
@@ -286,7 +295,11 @@ func TestPSAppend(t *testing.T) {
 	arg2 := fmt.Sprintf(argfmt, in[1])
 	require.NoError(t, f.Parse([]string{arg1, arg2}), "error parsing flags")
 
-	require.NoError(t, f.Lookup("ps").Value.(pflag.SliceValue).Append("windows/i386"), "error appending to platforms")
+	require.NoError(
+		t,
+		f.Lookup("ps").Value.(pflag.SliceValue).Append("windows/i386"),
+		"error appending to platforms",
+	)
 	require.ElementsMatch(t,
 		append(in, "windows/i386"),
 		f.Lookup("ps").Value.(pflag.SliceValue).GetSlice(),

cmd/importcmd/imagebundle/image_bundle.go

@@ -58,7 +58,9 @@ func NewCommand(out output.Output) *cobra.Command {
 			out.EndOperation(true)
 
 			out.StartOperation("Starting temporary Docker registry")
-			reg, err := registry.NewRegistry(registry.Config{StorageDirectory: tempDir, ReadOnly: true})
+			reg, err := registry.NewRegistry(
+				registry.Config{StorageDirectory: tempDir, ReadOnly: true},
+			)
 			if err != nil {
 				out.EndOperation(false)
 				return fmt.Errorf("failed to create local Docker registry: %w", err)
@@ -95,7 +97,8 @@ func NewCommand(out output.Output) *cobra.Command {
 		},
 	}
 
-	cmd.Flags().StringVar(&imageBundleFile, "image-bundle", "", "Tarball containing list of images to push")
+	cmd.Flags().
+		StringVar(&imageBundleFile, "image-bundle", "", "Tarball containing list of images to push")
 	_ = cmd.MarkFlagRequired("image-bundle")
 	cmd.Flags().StringVar(&containerdNamespace, "containerd-namespace", "k8s.io",
 		"Containerd namespace to import images into")

cmd/push/imagebundle/image_bundle.go

@@ -59,7 +59,9 @@ func NewCommand(out output.Output) *cobra.Command {
 			out.EndOperation(true)
 
 			out.StartOperation("Starting temporary Docker registry")
-			reg, err := registry.NewRegistry(registry.Config{StorageDirectory: tempDir, ReadOnly: true})
+			reg, err := registry.NewRegistry(
+				registry.Config{StorageDirectory: tempDir, ReadOnly: true},
+			)
 			if err != nil {
 				out.EndOperation(false)
 				return fmt.Errorf("failed to create local Docker registry: %w", err)
@@ -75,7 +77,10 @@ func NewCommand(out output.Output) *cobra.Command {
 			skopeoRunner, skopeoCleanup := skopeo.NewRunner()
 			cleaner.AddCleanupFn(func() { _ = skopeoCleanup() })
 
-			skopeoStdout, skopeoStderr, err := skopeoRunner.AttemptToLoginToRegistry(context.TODO(), destRegistry)
+			skopeoStdout, skopeoStderr, err := skopeoRunner.AttemptToLoginToRegistry(
+				context.TODO(),
+				destRegistry,
+			)
 			if err != nil {
 				out.Infof("---skopeo stdout---:\n%s", skopeoStdout)
 				out.Infof("---skopeo stderr---:\n%s", skopeoStderr)
@@ -119,7 +124,8 @@ func NewCommand(out output.Output) *cobra.Command {
 		},
 	}
 
-	cmd.Flags().StringVar(&imageBundleFile, "image-bundle", "", "Tarball containing list of images to push")
+	cmd.Flags().
+		StringVar(&imageBundleFile, "image-bundle", "", "Tarball containing list of images to push")
 	_ = cmd.MarkFlagRequired("image-bundle")
 	cmd.Flags().StringVar(&destRegistry, "to-registry", "", "Registry to push images to")
 	_ = cmd.MarkFlagRequired("to-registry")

cmd/serve/imagebundle/image_bundle.go

@@ -73,10 +73,12 @@ func NewCommand(out output.Output) *cobra.Command {
 		},
 	}
 
-	cmd.Flags().StringVar(&imageBundleFile, "image-bundle", "", "Tarball containing list of images to push")
+	cmd.Flags().
+		StringVar(&imageBundleFile, "image-bundle", "", "Tarball containing list of images to push")
 	_ = cmd.MarkFlagRequired("image-bundle")
 	cmd.Flags().StringVar(&listenAddress, "listen-address", "localhost", "Address to list on")
-	cmd.Flags().Uint16Var(&listenPort, "listen-port", 0, "Port to listen on (0 means use any free port)")
+	cmd.Flags().
+		Uint16Var(&listenPort, "listen-port", 0, "Port to listen on (0 means use any free port)")
 	cmd.Flags().StringVar(&tlsCertificate, "tls-cert-file", "", "TLS certificate file")
 	cmd.Flags().StringVar(&tlsKey, "tls-private-key-file", "", "TLS private key file")
 

config/config_test.go

@@ -124,7 +124,9 @@ func TestParseFile(t *testing.T) {
 			if strings.HasSuffix(tt.name, "in plain text file") {
 				ext = "txt"
 			}
-			got, err := ParseFile(filepath.Join("testdata", strings.ReplaceAll(tt.name, " ", "_")+"."+ext))
+			got, err := ParseFile(
+				filepath.Join("testdata", strings.ReplaceAll(tt.name, " ", "_")+"."+ext),
+			)
 			if (err != nil) != tt.wantErr {
 				t.Errorf("ParseFile() error = %v, wantErr %v", err, tt.wantErr)
 				return

containerd/ctr.go

@@ -14,15 +14,21 @@ type CtrOption func() string
 func ImportImage(ctx context.Context, src, tag, containerdNamespace string) ([]byte, error) {
 	baseArgs := []string{"-n", containerdNamespace}
 	//nolint:gosec // Args are fine.
-	cmd := exec.CommandContext(ctx, "ctr", append(baseArgs, []string{"images", "pull", "--plain-http", src}...)...)
+	cmd := exec.CommandContext(
+		ctx,
+		"ctr",
+		append(baseArgs, []string{"images", "pull", "--plain-http", src}...)...)
 	cmdOutput, err := cmd.CombinedOutput()
 	if err != nil {
 		return cmdOutput, fmt.Errorf("failed to pull image from temporary docker registry: %w", err)
 	}
 
 	if tag != "" {
 		//nolint:gosec // Args are fine.
-		cmd = exec.CommandContext(ctx, "ctr", append(baseArgs, []string{"images", "tag", "--force", src, tag}...)...)
+		cmd = exec.CommandContext(
+			ctx,
+			"ctr",
+			append(baseArgs, []string{"images", "tag", "--force", src, tag}...)...)
 		tagOutput, err := cmd.CombinedOutput()
 		cmdOutput = append(cmdOutput, tagOutput...)
 		if err != nil {

make/go.mk

@@ -86,9 +86,9 @@ endif
 
 .PHONY: lint.%
 lint.%: ## Runs golangci-lint for a specific module
-lint.%: install-tool.go.golangci-lint; $(info $(M) running golangci-lint for $* module)
+lint.%: install-tool.go.golangci-lint install-tool.go.golines; $(info $(M) linting $* module)
+	$(if $(filter-out root,$*),cd $* && )golines -w .
 	$(if $(filter-out root,$*),cd $* && )golangci-lint run --fix --config=$(GOLANGCI_CONFIG_FILE)
-	$(if $(filter-out root,$*),cd $* && )go fmt ./...
 	$(if $(filter-out root,$*),cd $* && )go fix ./...
 
 .PHONY: mod-tidy