chore: add more logging

Author: jaredLunde

cmd/new-dockerfile/main.go

@@ -87,6 +87,11 @@ func main() {
 		os.Exit(1)
 	}
 
+	contents = append(
+		[]byte(fmt.Sprintf(issueStr)),
+		contents...,
+	)
+
 	if !write {
 		fmt.Println(string(contents))
 		return
@@ -100,3 +105,7 @@ func main() {
 
 	log.Info(fmt.Sprintf("Auto-generated Dockerfile for project using %s: %s", string(r.Name()), output))
 }
+
+const issueStr = `# Auto-generated by the "new-dockerfile" CLI tool
+# Please report any issues to: https://github.com/flexstack/new-dockerfile/issues
+`

main.go

@@ -80,4 +80,5 @@ func (a *Dockerfile) MatchRuntime(path string) (runtime.Runtime, error) {
 	return nil, ErrRuntimeNotFound
 }
 
+// Error returned when we could not auto-detect the runtime of the project.
 var ErrRuntimeNotFound = fmt.Errorf("A Dockerfile was not detected in the project and we could not auto-generate one for you.")

runtime/elixir.go

@@ -52,7 +52,7 @@ func (d *Elixir) GenerateDockerfile(path string) ([]byte, error) {
 		return nil, err
 	}
 
-	BinName, err := findBinName(path)
+	binName, err := findBinName(path)
 	if err != nil {
 		return nil, err
 	}
@@ -64,14 +64,14 @@ func (d *Elixir) GenerateDockerfile(path string) ([]byte, error) {
   Binary name    : %s
 
   Docker build arguments can supersede these defaults if provided.
-  See https://flexstack.com/docs/languages-and-frameworks/autogenerate-dockerfile`, *elixirVersion, *otpVersion, BinName),
+  See https://flexstack.com/docs/languages-and-frameworks/autogenerate-dockerfile`, *elixirVersion, *otpVersion, binName),
 	)
 
 	var buf bytes.Buffer
 	if err := tmpl.Option("missingkey=zero").Execute(&buf, map[string]string{
 		"ElixirVersion": *elixirVersion,
 		"OTPVersion":    strings.Split(*otpVersion, ".")[0],
-		"BinName":       BinName,
+		"BinName":       binName,
 	}); err != nil {
 		return nil, fmt.Errorf("Failed to execute template")
 	}

runtime/golang.go

@@ -105,16 +105,15 @@ ARG CGO_ENABLED=0
 COPY . .
 RUN if [ -f go.mod ]; then go mod download; fi
 
-# -trimpath removes the absolute path to the source code in the binary
-# -ldflags="-s -w" removes the symbol table and debug information from the binary
-# CGO_ENABLED=0 disables the use of cgo
 FROM base AS build
 WORKDIR /go/src/app
 ARG TARGETOS=linux
 ARG TARGETARCH=arm64
 ARG CGO_ENABLED=0
 ARG PACKAGE={{.Package}}
-
+# -trimpath removes the absolute path to the source code in the binary
+# -ldflags="-s -w" removes the symbol table and debug information from the binary
+# CGO_ENABLED=0 disables the use of cgo
 RUN CGO_ENABLED=${CGO_ENABLED} GOOS=${TARGETOS} GOARCH=${TARGETARCH} go build -trimpath -ldflags="-s -w" -o /go/bin/app "${PACKAGE}"
 
 FROM debian:stable-slim

runtime/node.go

@@ -89,6 +89,7 @@ func (d *Node) GenerateDockerfile(path string) ([]byte, error) {
 		for _, cmd := range startCommands {
 			if _, ok := scripts[cmd].(string); ok {
 				startCMD = fmt.Sprintf("%s run %s", packageManager, cmd)
+				d.Log.Info("Detected start command in package.json: " + startCMD)
 				break
 			}
 		}
@@ -99,6 +100,7 @@ func (d *Node) GenerateDockerfile(path string) ([]byte, error) {
 
 				if ok && startScriptRe.MatchString(value) {
 					startCMD = fmt.Sprintf("%s run %s", packageManager, name)
+					d.Log.Info("Detected start command in package.json via regex pattern: " + startCMD)
 					break
 				}
 			}
@@ -108,6 +110,7 @@ func (d *Node) GenerateDockerfile(path string) ([]byte, error) {
 		for _, cmd := range buildCommands {
 			if _, ok := scripts[cmd].(string); ok {
 				buildCMD = fmt.Sprintf("%s run %s", packageManager, cmd)
+				d.Log.Info("Detected build command in package.json: " + buildCMD)
 				break
 			}
 		}

runtime/php.go

@@ -53,6 +53,7 @@ func (d *PHP) GenerateDockerfile(path string) ([]byte, error) {
 	startCMD := "apache2-foreground"
 	installCMD := ""
 	if _, err := os.Stat(filepath.Join(path, "composer.json")); err == nil {
+		d.Log.Info("Detected composer.json file")
 		installCMD = "composer update && composer install --prefer-dist --no-dev --optimize-autoloader --no-interaction"
 	}
 
@@ -73,6 +74,7 @@ func (d *PHP) GenerateDockerfile(path string) ([]byte, error) {
 	}
 
 	if npmInstallCMD != "" {
+		d.Log.Info("Detected package-lock.json, pnpm-lock.yaml, yarn.lock or bun.lockb file")
 		if installCMD == "" {
 			installCMD = npmInstallCMD
 		} else {
@@ -101,6 +103,7 @@ func (d *PHP) GenerateDockerfile(path string) ([]byte, error) {
 			for _, cmd := range buildCommands {
 				if _, ok := scripts[cmd].(string); ok {
 					buildCMD = fmt.Sprintf("%s run %s", packageManager, cmd)
+					d.Log.Info("Detected build command in package.json: " + buildCMD)
 					break
 				}
 			}

runtime/python.go

@@ -64,14 +64,19 @@ func (d *Python) GenerateDockerfile(path string) ([]byte, error) {
 
 	installCMD := ""
 	if _, err := os.Stat(filepath.Join(path, "requirements.txt")); err == nil {
+		d.Log.Info("Detected requirements.txt file")
 		installCMD = "pip install -r requirements.txt"
 	} else if _, err := os.Stat(filepath.Join(path, "poetry.lock")); err == nil {
+		d.Log.Info("Detected a poetry project")
 		installCMD = "poetry install --no-dev --no-interactive --no-ansi"
 	} else if _, err := os.Stat(filepath.Join(path, "Pipfile.lock")); err == nil {
+		d.Log.Info("Detected a pipenv project")
 		installCMD = "PIPENV_VENV_IN_PROJECT=1 pipenv install --deploy"
 	} else if _, err := os.Stat(filepath.Join(path, "pdm.lock")); err == nil {
+		d.Log.Info("Detected a pdm project")
 		installCMD = "pdm install --prod"
 	} else if _, err := os.Stat(filepath.Join(path, "pyproject.toml")); err == nil {
+		d.Log.Info("Detected a pyproject.toml file")
 		installCMD = "pip install --upgrade build setuptools && pip install ."
 	}
 
@@ -99,9 +104,14 @@ func (d *Python) GenerateDockerfile(path string) ([]byte, error) {
 				}
 			}
 
-			startCMD = fmt.Sprintf(`python -m %s`, projectName)
+			if projectName != "" {
+				startCMD = fmt.Sprintf(`python -m %s`, projectName)
+				d.Log.Info("Detected start command via pyproject.toml")
+			}
 		}
-	} else {
+	}
+
+	if startCMD == "" {
 		mainFiles := []string{
 			"main.py",
 			"app.py",
@@ -121,6 +131,7 @@ func (d *Python) GenerateDockerfile(path string) ([]byte, error) {
 			}
 
 			startCMD = fmt.Sprintf(`python %s`, fn)
+			d.Log.Info("Detected start command via main file: " + startCMD)
 			break
 		}
 	}

runtime/ruby.go

@@ -69,10 +69,15 @@ func (d *Ruby) GenerateDockerfile(path string) ([]byte, error) {
 		installCMD = installCMD + " && bun install"
 	}
 
+	if packageManager != "" {
+		d.Log.Info("Detected Node.js package manager: " + packageManager)
+	}
+
 	isRails := isRailsProject(path)
 	buildCMD := ""
 	startCMD := ""
 	if isRails {
+		d.Log.Info("Detected Rails project")
 		buildCMD = "bundle exec rake assets:precompile"
 		startCMD = "bundle exec rails server -b 0.0.0.0 -p ${PORT}"
 	} else {
@@ -86,10 +91,13 @@ func (d *Ruby) GenerateDockerfile(path string) ([]byte, error) {
 
 			switch fn {
 			case "config.ru":
+				d.Log.Info("Detected Rack project")
 				startCMD = "bundle exec rackup config.ru -p ${PORT}"
 			case "config/environment.rb":
+				d.Log.Info("Detected Rails project")
 				startCMD = "bundle exec ruby script/server"
 			case "Rakefile":
+				d.Log.Info("Detected Rake project")
 				startCMD = "bundle exec rake"
 			}
 

runtime/rust.go

@@ -68,11 +68,13 @@ func (d *Rust) GenerateDockerfile(path string) ([]byte, error) {
 			if bin == "bin" {
 				if pkgs, ok := cargoTOML[bin].([]map[string]interface{}); ok {
 					if len(pkgs) > 0 {
+						d.Log.Info("Detected binary in Cargo.toml via [[bin]]")
 						pkg = pkgs[0]
 						break
 					}
 				}
 			} else if pkg, ok = cargoTOML[bin].(map[string]interface{}); ok {
+				d.Log.Info("Detected binary in Cargo.toml via [" + bin + "]")
 				break
 			}
 		}