fix lint findings

Author: joonas-fi

cmd/bob/baseimageconf.go

@@ -11,7 +11,7 @@ import (
 )
 
 const (
-	baseImageJsonLocation = "/turbobob-baseimage.json"
+	baseImageJSONLocation = "/turbobob-baseimage.json"
 )
 
 // base image conf JSON - able to provide hints for useful commands, setting up cache paths etc.
@@ -33,7 +33,7 @@ type LangserverSpec struct {
 // base image conf is optional. if it doesn't exist, an empty (but valid) conf will be
 // returned without error
 func loadBaseImageConfWhenInsideContainer() (*BaseImageConfig, error) {
-	exists, err := osutil.Exists(baseImageJsonLocation)
+	exists, err := osutil.Exists(baseImageJSONLocation)
 	if err != nil {
 		return nil, fmt.Errorf("loadBaseImageConfWhenInsideContainer: %w", err)
 	}
@@ -43,7 +43,7 @@ func loadBaseImageConfWhenInsideContainer() (*BaseImageConfig, error) {
 	}
 
 	conf := &BaseImageConfig{}
-	if err := jsonfile.ReadDisallowUnknownFields(baseImageJsonLocation, conf); err != nil {
+	if err := jsonfile.ReadDisallowUnknownFields(baseImageJSONLocation, conf); err != nil {
 		return nil, fmt.Errorf("loadBaseImageConfWhenInsideContainer: %w", err)
 	}
 
@@ -59,7 +59,7 @@ func loadNonOptionalBaseImageConf(projectName string, builder bobfile.BuilderSpe
 
 	// unfortunately there isn't a good high-level way to grab a file from a Docker image, so that's
 	// why we have to create a container to get it
-	content, err := exec.Command("docker", "run", "--rm", dockerImage, "cat", baseImageJsonLocation).Output()
+	content, err := exec.Command("docker", "run", "--rm", dockerImage, "cat", baseImageJSONLocation).Output()
 	if err != nil {
 		return nil, err
 	}

cmd/bob/build.go

@@ -27,7 +27,7 @@ type BuildContext struct {
 	BuilderNameFilter string
 	ENVsAreRequired   bool
 	VersionControl    versioncontrol.Interface
-	RevisionId        *versioncontrol.RevisionId
+	RevisionID        *versioncontrol.RevisionID
 	Debug             bool   // enables additional debugging or verbose logging
 	FastBuild         bool   // skip all non-essential steps (linting, testing etc.) to build faster
 	RepositoryURL     string // human-visitable URL, like "https://github.com/function61/turbobob"
@@ -97,7 +97,7 @@ func runBuilder(builder bobfile.BuilderSpec, buildCtx *BuildContext, opDesc stri
 	// inserts ["--env", "FOO"] pairs for each PassEnvs
 	buildArgs, errEnv := dockerRelayEnvVars(
 		buildArgs,
-		buildCtx.RevisionId,
+		buildCtx.RevisionID,
 		builder,
 		buildCtx.ENVsAreRequired,
 		archesToBuildFor,
@@ -149,7 +149,7 @@ func buildAndPushOneDockerImage(dockerImage bobfile.DockerImageSpec, buildCtx *B
 	}
 
 	tagWithoutVersion := dockerImage.Image
-	tag := tagWithoutVersion + ":" + buildCtx.RevisionId.FriendlyRevisionId
+	tag := tagWithoutVersion + ":" + buildCtx.RevisionID.FriendlyRevisionID
 	tagLatest := tagWithoutVersion + ":latest"
 	dockerfilePath := dockerImage.DockerfilePath
 
@@ -179,8 +179,8 @@ func buildAndPushOneDockerImage(dockerImage bobfile.DockerImageSpec, buildCtx *B
 
 	annotate(ociv1.AnnotationTitle, buildCtx.Bobfile.ProjectName)
 	annotate(ociv1.AnnotationCreated, time.Now().UTC().Format(time.RFC3339))
-	annotate(ociv1.AnnotationRevision, buildCtx.RevisionId.RevisionId)
-	annotate(ociv1.AnnotationVersion, buildCtx.RevisionId.FriendlyRevisionId)
+	annotate(ociv1.AnnotationRevision, buildCtx.RevisionID.RevisionID)
+	annotate(ociv1.AnnotationVersion, buildCtx.RevisionID.FriendlyRevisionID)
 	annotate(ociv1.AnnotationDescription, buildCtx.Bobfile.Meta.Description)
 
 	// "URL to get source code for building the image"
@@ -241,6 +241,7 @@ func buildAndPushOneDockerImage(dockerImage bobfile.DockerImageSpec, buildCtx *B
 		args = append(args, "--push")
 	}
 
+	//nolint:gosec // ok
 	if err := passthroughStdoutAndStderr(exec.Command(args[0], args[1:]...)).Run(); err != nil {
 		return withErr(err)
 	}
@@ -296,9 +297,9 @@ func cloneToWorkdir(buildCtx *BuildContext) error {
 		return err
 	}
 
-	printHeading(fmt.Sprintf("Updating to %s", buildCtx.RevisionId.RevisionId))
+	printHeading(fmt.Sprintf("Updating to %s", buildCtx.RevisionID.RevisionID))
 
-	if err := workspaceRepo.Update(buildCtx.RevisionId.RevisionId); err != nil {
+	if err := workspaceRepo.Update(buildCtx.RevisionID.RevisionID); err != nil {
 		return err
 	}
 
@@ -330,8 +331,6 @@ func build(buildCtx *BuildContext) (*buildOutput, error) {
 	// to include modification check for the Dockerfile and all of its build context, so we're just
 	// best off calling Docker build because it is the best at detecting cache invalidation.
 	for _, builder := range buildCtx.Bobfile.Builders {
-		builder := builder // pin
-
 		if buildCtx.BuilderNameFilter != "" && builder.Name != buildCtx.BuilderNameFilter {
 			continue
 		}
@@ -440,7 +439,7 @@ func constructBuildContext(
 		return nil, errVcDetermine
 	}
 
-	metadata, err := versioncontrol.CurrentRevisionId(versionControl, onlyCommitted)
+	metadata, err := versioncontrol.CurrentRevisionID(versionControl, onlyCommitted)
 	if err != nil {
 		return nil, err
 	}
@@ -456,7 +455,7 @@ func constructBuildContext(
 	buildCtx := &BuildContext{
 		Bobfile:           bobfile,
 		PublishArtefacts:  publishArtefacts,
-		RevisionId:        metadata,
+		RevisionID:        metadata,
 		OriginDir:         repoOriginDir,
 		WorkspaceDir:      workspaceDir,
 		CloningStepNeeded: cloningStepNeeded,

cmd/bob/dev.go

@@ -2,7 +2,6 @@ package main
 
 import (
 	"fmt"
-	"io/ioutil"
 	"os"
 	"os/exec"
 	"path/filepath"
@@ -143,12 +142,12 @@ func devCommand(builderName string, envsAreRequired bool, ignoreNag bool) ([]str
 			dockerCmd = append(dockerCmd, "--publish", port)
 		}
 
-		devHttpIngress, ingressHostname := setupDevIngress(
+		devHTTPIngress, ingressHostname := setupDevIngress(
 			builder,
 			userConfig.DevIngressSettings,
 			bobfile)
-		if len(devHttpIngress) > 0 {
-			dockerCmd = append(dockerCmd, devHttpIngress...)
+		if len(devHTTPIngress) > 0 {
+			dockerCmd = append(dockerCmd, devHTTPIngress...)
 
 			shimCfg.DynamicProTipsFromHost = append(shimCfg.DynamicProTipsFromHost, fmt.Sprintf("dev ingress: https://%s/", ingressHostname))
 		}
@@ -159,7 +158,7 @@ func devCommand(builderName string, envsAreRequired bool, ignoreNag bool) ([]str
 		var errEnv error
 		dockerCmd, errEnv = dockerRelayEnvVars(
 			dockerCmd,
-			revisionIdForDev(),
+			revisionIDForDev(),
 			*builder,
 			envsAreRequired,
 			archesToBuildFor,
@@ -177,7 +176,7 @@ func devCommand(builderName string, envsAreRequired bool, ignoreNag bool) ([]str
 
 			// this needs to be dynamic, because on the host side there must be a unique dir
 			// per dev container
-			shimDataDirHost, err := ioutil.TempDir("", "bob-shim-")
+			shimDataDirHost, err := os.MkdirTemp("", "bob-shim-")
 			if err != nil {
 				return nil, err
 			}
@@ -265,12 +264,12 @@ func currentRunningGoOsArchToOsArchCode() OsArchCode {
 }
 
 // TODO: maybe merge with resolveMetadataFromVersionControl(.., false)
-func revisionIdForDev() *versioncontrol.RevisionId {
-	return &versioncontrol.RevisionId{
+func revisionIDForDev() *versioncontrol.RevisionID {
+	return &versioncontrol.RevisionID{
 		VcKind:             "managedByCi", // FIXME
-		RevisionId:         "dev",
-		RevisionIdShort:    "dev",
-		FriendlyRevisionId: "dev",
+		RevisionID:         "dev",
+		RevisionIDShort:    "dev",
+		FriendlyRevisionID: "dev",
 	}
 }
 

cmd/bob/devingress.go

@@ -14,11 +14,11 @@ func setupDevIngress(
 	ingressSettings devIngressSettings,
 	bobfile *bobfile.Bobfile,
 ) ([]string, string) {
-	if builder.DevHttpIngress == "" {
+	if builder.DevHTTPIngress == "" {
 		return nil, ""
 	}
 
-	containerPort := builder.DevHttpIngress
+	containerPort := builder.DevHTTPIngress
 
 	if err := ingressSettings.Validate(); err != nil {
 		fmt.Fprintf(os.Stderr, "WARN: cannot setup DevHttpIngress because user's config: %v\n", err)
@@ -28,12 +28,12 @@ func setupDevIngress(
 	// "joonas.fi-blog" => "joonas-fi-blog"
 	// don't accept multi-level subdomains because wildcard TLS certs only apply
 	// one level.
-	ingressAppId := strings.ReplaceAll(bobfile.ProjectName, ".", "-")
+	ingressAppID := strings.ReplaceAll(bobfile.ProjectName, ".", "-")
 	if builder.Name != "default" {
-		ingressAppId += "-" + builder.Name
+		ingressAppID += "-" + builder.Name
 	}
 
-	ingressHostname := ingressAppId + "." + ingressSettings.Domain
+	ingressHostname := ingressAppID + "." + ingressSettings.Domain
 
 	labels := []string{
 		// Edgerouter needs explicit opt-in for "no auth" to not accidentally expose private services

cmd/bob/devshim.go

@@ -3,7 +3,6 @@ package main
 import (
 	"fmt"
 	"io"
-	"io/ioutil"
 	"os"
 	"os/exec"
 	"path/filepath"
@@ -191,7 +190,7 @@ func customizePrompt() error {
 	// Bob makes a pretty Powerline-inspired prompt (https://github.com/powerline/powerline)
 
 	//nolint:gosec // ok
-	return ioutil.WriteFile("/root/.bashrc", []byte(`
+	return os.WriteFile("/root/.bashrc", []byte(`
 # customization written by Turbo Bob
 export PS1="\$(bob powerline \$?)"
 `), 0755)

cmd/bob/docker.go

@@ -4,7 +4,6 @@ import (
 	"bytes"
 	"errors"
 	"fmt"
-	"io/ioutil"
 	"os"
 	"os/exec"
 	"strings"
@@ -26,17 +25,7 @@ func isDevContainerRunning(containerName string) bool {
 }
 
 func devContainerName(bobfile *bobfile.Bobfile, builder bobfile.BuilderSpec) string {
-	return containerNameInternal("dev", bobfile, builder)
-}
-
-func langServerContainerName(bobfile *bobfile.Bobfile, builder bobfile.BuilderSpec) string {
-	return containerNameInternal("langserver", bobfile, builder)
-}
-
-// do not use directly
-func containerNameInternal(kind string, bobfile *bobfile.Bobfile, builder bobfile.BuilderSpec) string {
-	return fmt.Sprintf("tb%s-%s-%s", kind, bobfile.ProjectName, builder.Name)
-
+	return fmt.Sprintf("tbdev-%s-%s", bobfile.ProjectName, builder.Name)
 }
 
 func builderImageName(projectName string, builder bobfile.BuilderSpec) string {
@@ -72,7 +61,7 @@ func buildBuilder(bobfile *bobfile.Bobfile, builder *bobfile.BuilderSpec) error
 	imageBuildCmd, err := func() (*exec.Cmd, error) {
 		// provide Dockerfile from stdin for contextless build
 		if builder.ContextlessBuild {
-			dockerfileContent, err := ioutil.ReadFile(dockerfilePath)
+			dockerfileContent, err := os.ReadFile(dockerfilePath)
 			if err != nil {
 				return nil, err
 			}
@@ -114,7 +103,7 @@ func buildBuilder(bobfile *bobfile.Bobfile, builder *bobfile.BuilderSpec) error
 
 func dockerRelayEnvVars(
 	dockerArgs []string,
-	revisionId *versioncontrol.RevisionId,
+	revisionID *versioncontrol.RevisionID,
 	builder bobfile.BuilderSpec,
 	envsAreRequired bool,
 	osArches bobfile.OsArchesSpec,
@@ -125,9 +114,9 @@ func dockerRelayEnvVars(
 		dockerArgs = append(dockerArgs, "--env", key+"="+value)
 	}
 
-	env("FRIENDLY_REV_ID", revisionId.FriendlyRevisionId)
-	env("REV_ID", revisionId.RevisionId)
-	env("REV_ID_SHORT", revisionId.RevisionIdShort)
+	env("FRIENDLY_REV_ID", revisionID.FriendlyRevisionID)
+	env("REV_ID", revisionID.RevisionID)
+	env("REV_ID_SHORT", revisionID.RevisionIDShort)
 
 	for _, envKey := range builder.PassEnvs {
 		envValue := os.Getenv(envKey)

cmd/bob/info.go

@@ -16,13 +16,13 @@ func info() error {
 		return err
 	}
 
-	revisionId := buildCtx.RevisionId // shorthand
+	revisionID := buildCtx.RevisionID // shorthand
 
 	basicDetails := termtables.CreateTable()
 	basicDetails.AddRow("Project name", buildCtx.Bobfile.ProjectName)
-	basicDetails.AddRow("VcKind", revisionId.VcKind)
-	basicDetails.AddRow("Revision ID (full)", fmt.Sprintf("%s (%s)", revisionId.RevisionIdShort, revisionId.RevisionId))
-	basicDetails.AddRow("Friendly revision", revisionId.FriendlyRevisionId)
+	basicDetails.AddRow("VcKind", revisionID.VcKind)
+	basicDetails.AddRow("Revision ID (full)", fmt.Sprintf("%s (%s)", revisionID.RevisionIDShort, revisionID.RevisionID))
+	basicDetails.AddRow("Friendly revision", revisionID.FriendlyRevisionID)
 
 	fmt.Printf("BASIC DETAILS\n%s\n", basicDetails.Render())
 

cmd/bob/init.go

@@ -3,7 +3,6 @@ package main
 import (
 	"encoding/json"
 	"fmt"
-	"io/ioutil"
 	"os"
 	"path/filepath"
 
@@ -69,7 +68,7 @@ func writeBoilerplate(filePath string, content string) error {
 		return fmt.Errorf("CI boilerplate '%s' already exists", filePath)
 	}
 
-	return ioutil.WriteFile(
+	return os.WriteFile(
 		filePath,
 		[]byte(content),
 		osutil.FileMode(osutil.OwnerRW, osutil.GroupRW, osutil.OtherNone))
@@ -127,18 +126,18 @@ func writeBobfileIfNotExists(content bobfile.Bobfile) error {
 		return bobfile.ErrInitBobfileExists
 	}
 
-	asJson, errJson := json.MarshalIndent(&content, "", "\t")
-	if errJson != nil {
-		return errJson
+	asJSON, errJSON := json.MarshalIndent(&content, "", "\t")
+	if errJSON != nil {
+		return errJSON
 	}
 
 	if err := os.MkdirAll(filepath.Dir(bobfile.Name), 0755); err != nil {
 		return err
 	}
 
-	return ioutil.WriteFile(
+	return os.WriteFile(
 		bobfile.Name,
-		[]byte(fmt.Sprintf("%s\n", asJson)),
+		[]byte(fmt.Sprintf("%s\n", asJSON)),
 		osutil.FileMode(osutil.OwnerRW, osutil.GroupRW, osutil.OtherNone))
 }
 

cmd/bob/initguess.go

@@ -57,7 +57,7 @@ func initGuessFromDockerfile() error {
 
 			return []string{"bash", "-c", script}, nil
 		} else { // exec form
-			return []string(runCommand.CmdLine), nil
+			return runCommand.CmdLine, nil
 		}
 	}()
 	if err != nil {

cmd/bob/langserver.go

@@ -74,6 +74,8 @@ func langserverRunShim(ctx context.Context, langCodeRequested string) error {
 		return err
 	}
 
+	// LSP process needs to run in the dev container (not a separate langserver container) because it might need access
+	// to compiler cache, built object files etc.
 	containerName := devContainerName(projectFile, *builder)
 
 	if !isDevContainerRunning(containerName) {
@@ -125,6 +127,7 @@ func langserverRunGeneric(ctx context.Context, language string) error {
 	args = append(args, server.ref)
 	args = append(args, server.args...)
 
+	//nolint:gosec // ok
 	lspServer := exec.CommandContext(ctx, args[0], args[1:]...)
 	/*
 		if strace := false; strace {