feature: Add version command and enhance CLI logging

- Add version command to display CLI version information
- Add command execution logging with sensitive data masking
- Add version logging to file

Author: andrzej-janczak

.github/workflows/go.yml

@@ -9,17 +9,12 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # Needed for git history
       - name: Set up Go
         uses: actions/setup-go@v4
-      - name: Build CLI for Linux
-        run: |
-          GOOS=linux GOARCH=amd64 go build -o cli-v2-linux ./cli-v2.go
-      - name: Build CLI for Windows
-        run: |
-          GOOS=windows GOARCH=amd64 go build -o cli-v2.exe ./cli-v2.go
-      - name: Build CLI for macOS
-        run: |
-          GOOS=darwin GOARCH=amd64 go build -o cli-v2-macos ./cli-v2.go
+      - name: Build CLI for all platforms
+        run: make build-all
       - name: Upload CLI binaries
         uses: actions/upload-artifact@v4
         with:
@@ -38,7 +33,7 @@ jobs:
         uses: actions/setup-go@v4
       - name: Install dependencies from .codacy/codacy.yaml
         run: |
-          go build ./cli-v2.go
+          make build
           ./cli-v2 install
       - name: "Run tests"
         run: |

.github/workflows/it-test.yml

@@ -16,6 +16,8 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # Needed for git history
 
       - name: Set up Go
         uses: actions/setup-go@v5
@@ -46,7 +48,6 @@ jobs:
         if: matrix.os != 'windows-latest'
         run: chmod +x cli-v2
 
-
       - name: Run tool tests
         if: matrix.os != 'windows-latest'
         id: run_tests

Makefile

@@ -0,0 +1,34 @@
+.PHONY: build clean build-all build-linux build-darwin build-windows
+
+# Get the version from git describe or fallback to a default version
+VERSION := $(shell git describe --tags --always --dirty 2>/dev/null || echo "development")
+COMMIT := $(shell git rev-parse --short HEAD 2>/dev/null || echo "unknown")
+BUILD_TIME := $(shell date -u '+%Y-%m-%d_%H:%M:%S')
+
+# Build flags
+LDFLAGS := -X 'codacy/cli-v2/version.Version=$(VERSION)' \
+           -X 'codacy/cli-v2/version.GitCommit=$(COMMIT)' \
+           -X 'codacy/cli-v2/version.BuildTime=$(BUILD_TIME)'
+
+# Build the CLI for current platform
+build:
+	go build -ldflags "$(LDFLAGS)" -o cli-v2
+
+# Build for Linux
+build-linux:
+	GOOS=linux GOARCH=amd64 go build -ldflags "$(LDFLAGS)" -o cli-v2-linux
+
+# Build for macOS
+build-darwin:
+	GOOS=darwin GOARCH=amd64 go build -ldflags "$(LDFLAGS)" -o cli-v2-macos
+
+# Build for Windows
+build-windows:
+	GOOS=windows GOARCH=amd64 go build -ldflags "$(LDFLAGS)" -o cli-v2.exe
+
+# Build for all platforms
+build-all: build-linux build-darwin build-windows
+
+# Clean build artifacts
+clean:
+	rm -f cli-v2 cli-v2-linux cli-v2-macos cli-v2.exe 

cli-v2.go

@@ -5,6 +5,7 @@ import (
 	"codacy/cli-v2/config"
 	config_file "codacy/cli-v2/config-file"
 	"codacy/cli-v2/utils/logger"
+	"codacy/cli-v2/version"
 	"fmt"
 	"os"
 	"path/filepath"
@@ -22,8 +23,10 @@ func main() {
 		fmt.Printf("Failed to initialize logger: %v\n", err)
 	}
 
-	// Log startup message
-	logger.Debug("Starting Codacy CLI.", logrus.Fields{})
+	// Log startup message and version
+	logger.Info("Starting Codacy CLI", logrus.Fields{
+		"version": version.GetVersion(),
+	})
 
 	// This also setup the config global !
 	configErr := config_file.ReadConfigFile(config.Config.ProjectConfigFile())

cmd/root.go

@@ -4,17 +4,20 @@ import (
 	"fmt"
 	"os"
 	"path/filepath"
+	"strings"
 
 	"codacy/cli-v2/config"
 	"codacy/cli-v2/utils/logger"
+	"codacy/cli-v2/version"
 
 	"github.com/fatih/color"
+	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 )
 
 var rootCmd = &cobra.Command{
 	Use:     "codacy-cli",
-	Short:   "Codacy CLI - A command line interface for Codacy",
+	Short:   fmt.Sprintf("Codacy CLI v%s - A command line interface for Codacy", version.GetVersion()),
 	Long:    "",
 	Example: getExampleText(),
 	PersistentPreRun: func(cmd *cobra.Command, args []string) {
@@ -23,6 +26,16 @@ var rootCmd = &cobra.Command{
 		if err := logger.Initialize(logsDir); err != nil {
 			fmt.Printf("Warning: Failed to initialize file logger: %v\n", err)
 		}
+
+		// Create a masked version of the full command for logging
+		maskedArgs := maskSensitiveArgs(os.Args)
+
+		// Log the command being executed with its arguments and flags
+		logger.Info("Executing CLI command", logrus.Fields{
+			"command":      cmd.Name(),
+			"full_command": maskedArgs,
+			"args":         args,
+		})
 	},
 	Run: func(cmd *cobra.Command, args []string) {
 		// Check if .codacy directory exists
@@ -122,3 +135,37 @@ Use "{{.CommandPath}} [command] --help" for more information about a command.{{e
 https://github.com/codacy/codacy-cli-v2
 `)
 }
+
+// maskSensitiveArgs creates a copy of the arguments with sensitive values masked
+func maskSensitiveArgs(args []string) []string {
+	maskedArgs := make([]string, len(args))
+	copy(maskedArgs, args)
+
+	sensitiveFlags := map[string]bool{
+		"--api-token":        true,
+		"--repository-token": true,
+		"--project-token":    true,
+		"--codacy-api-token": true,
+	}
+
+	for i, arg := range maskedArgs {
+		// Skip the first argument (program name)
+		if i == 0 {
+			continue
+		}
+
+		// Handle --flag=value format
+		for flag := range sensitiveFlags {
+			if strings.HasPrefix(arg, flag+"=") {
+				maskedArgs[i] = flag + "=***"
+				break
+			}
+		}
+
+		// Handle --flag value format
+		if sensitiveFlags[arg] && i < len(maskedArgs)-1 {
+			maskedArgs[i+1] = "***"
+		}
+	}
+	return maskedArgs
+}

cmd/root_test.go

@@ -0,0 +1,73 @@
+package cmd
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestMaskSensitiveArgs(t *testing.T) {
+	tests := []struct {
+		name     string
+		args     []string
+		expected []string
+	}{
+		{
+			name:     "no sensitive flags",
+			args:     []string{"codacy-cli", "analyze", "--tool", "eslint"},
+			expected: []string{"codacy-cli", "analyze", "--tool", "eslint"},
+		},
+		{
+			name:     "api token with space",
+			args:     []string{"codacy-cli", "init", "--api-token", "secret123", "--tool", "eslint"},
+			expected: []string{"codacy-cli", "init", "--api-token", "***", "--tool", "eslint"},
+		},
+		{
+			name:     "api token with equals",
+			args:     []string{"codacy-cli", "init", "--api-token=secret123", "--tool", "eslint"},
+			expected: []string{"codacy-cli", "init", "--api-token=***", "--tool", "eslint"},
+		},
+		{
+			name:     "repository token at end with space",
+			args:     []string{"codacy-cli", "init", "--repository-token", "secret123"},
+			expected: []string{"codacy-cli", "init", "--repository-token", "***"},
+		},
+		{
+			name:     "repository token at end with equals",
+			args:     []string{"codacy-cli", "init", "--repository-token=secret123"},
+			expected: []string{"codacy-cli", "init", "--repository-token=***"},
+		},
+		{
+			name:     "project token at start with space",
+			args:     []string{"codacy-cli", "--project-token", "secret123", "analyze"},
+			expected: []string{"codacy-cli", "--project-token", "***", "analyze"},
+		},
+		{
+			name:     "project token at start with equals",
+			args:     []string{"codacy-cli", "--project-token=secret123", "analyze"},
+			expected: []string{"codacy-cli", "--project-token=***", "analyze"},
+		},
+		{
+			name:     "multiple tokens mixed format",
+			args:     []string{"codacy-cli", "--api-token=secret1", "--project-token", "secret2"},
+			expected: []string{"codacy-cli", "--api-token=***", "--project-token", "***"},
+		},
+		{
+			name:     "token flag at end without value",
+			args:     []string{"codacy-cli", "analyze", "--api-token"},
+			expected: []string{"codacy-cli", "analyze", "--api-token"},
+		},
+		{
+			name:     "empty value after equals",
+			args:     []string{"codacy-cli", "--api-token="},
+			expected: []string{"codacy-cli", "--api-token=***"},
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			masked := maskSensitiveArgs(tt.args)
+			assert.Equal(t, tt.expected, masked, "masked arguments should match expected")
+		})
+	}
+}

cmd/version.go

@@ -0,0 +1,38 @@
+package cmd
+
+import (
+	"codacy/cli-v2/version"
+	"fmt"
+	"runtime"
+
+	"github.com/fatih/color"
+	"github.com/spf13/cobra"
+)
+
+var versionCmd = &cobra.Command{
+	Use:   "version",
+	Short: "Display version information",
+	Run: func(cmd *cobra.Command, args []string) {
+		bold := color.New(color.Bold)
+		cyan := color.New(color.FgCyan)
+
+		fmt.Println()
+		bold.Println("Codacy CLI Version Information")
+		fmt.Println("-----------------------------")
+		cyan.Printf("Version:    ")
+		fmt.Println(version.Version)
+		cyan.Printf("Commit:     ")
+		fmt.Println(version.GitCommit)
+		cyan.Printf("Built:      ")
+		fmt.Println(version.BuildTime)
+		cyan.Printf("Go version: ")
+		fmt.Println(runtime.Version())
+		cyan.Printf("OS/Arch:    ")
+		fmt.Printf("%s/%s\n", runtime.GOOS, runtime.GOARCH)
+		fmt.Println()
+	},
+}
+
+func init() {
+	rootCmd.AddCommand(versionCmd)
+}

version/version.go

@@ -0,0 +1,21 @@
+package version
+
+// Version information set at build time
+var (
+	// Version is the current version of codacy-cli
+	Version = "development"
+
+	// GitCommit is the git commit hash of the build
+	GitCommit = "unknown"
+
+	// BuildTime is the time the binary was built
+	BuildTime = "unknown"
+)
+
+// GetVersion returns the current version of codacy-cli
+func GetVersion() string {
+	if GitCommit != "unknown" {
+		return Version + " (" + GitCommit + ") built at " + BuildTime
+	}
+	return Version
+}