feat(cli): Add scan defaults and compilation model caching (#89)

Author: misonijnik

.github/workflows/ci-cli.yaml

@@ -141,13 +141,94 @@ jobs:
         working-directory: cli
         run: |
           ./opentaint compile --quiet ${{ steps.github-token.outputs.arg }} --output portable-project ../project-root --verbosity debug
-          ./opentaint scan --quiet ${{ steps.github-token.outputs.arg }} --output report.sarif portable-project --verbosity debug
+          ./opentaint scan --quiet ${{ steps.github-token.outputs.arg }} --output report.sarif --project-model portable-project --verbosity debug
 
-      - name: Run opentaint scan
+      - name: Run opentaint scan with explicit path and output
         working-directory: cli
         run: |
           ./opentaint scan --quiet ${{ steps.github-token.outputs.arg }} --output report.sarif ../project-root
 
+      - name: Clean up cached models before default-output tests
+        working-directory: cli
+        run: ./opentaint prune --yes ${{ steps.github-token.outputs.arg }}
+
+      - name: Run opentaint scan with default output (CompileAndScan)
+        working-directory: cli
+        run: |
+          ./opentaint scan --quiet ${{ steps.github-token.outputs.arg }} ../project-root
+
+      - name: Verify cached model and default SARIF location
+        run: |
+          # Exactly one project cache directory should exist
+          MODEL_COUNT=$(ls -d ~/.opentaint/cache/*/ 2>/dev/null | wc -l)
+          if [ "$MODEL_COUNT" -ne 1 ]; then
+            echo "Expected 1 cached model directory, found $MODEL_COUNT"
+            ls -la ~/.opentaint/cache/ || true
+            exit 1
+          fi
+
+          CACHE_DIR=$(ls -d ~/.opentaint/cache/*/)
+
+          # project-model directory should exist
+          if [ ! -d "${CACHE_DIR}project-model" ]; then
+            echo "Expected project-model directory in $CACHE_DIR"
+            ls -la "$CACHE_DIR"
+            exit 1
+          fi
+
+          # Default SARIF should be inside project-model/sources/
+          SARIF_PATH="${CACHE_DIR}project-model/sources/opentaint.sarif"
+          if [ ! -f "$SARIF_PATH" ]; then
+            echo "Expected default SARIF at $SARIF_PATH"
+            find "$CACHE_DIR" -name "*.sarif" || true
+            exit 1
+          fi
+
+          echo "Cached model verified at: $CACHE_DIR"
+          echo "Default SARIF verified at: $SARIF_PATH"
+
+      - name: Run opentaint scan with no arguments (defaults to current directory)
+        working-directory: project-root
+        run: |
+          ../cli/opentaint scan --quiet ${{ steps.github-token.outputs.arg }}
+
+      - name: Run opentaint scan on pre-compiled model without --output
+        working-directory: cli
+        run: |
+          ./opentaint scan --quiet ${{ steps.github-token.outputs.arg }} --project-model portable-project
+
+      - name: Verify SARIF placed inside provided project-model
+        working-directory: cli
+        run: |
+          if [ ! -f "portable-project/sources/opentaint.sarif" ]; then
+            echo "Expected SARIF at portable-project/sources/opentaint.sarif"
+            find portable-project -name "*.sarif" || true
+            exit 1
+          fi
+          echo "SARIF in explicit project-model verified"
+
+      - name: Run opentaint prune --dry-run and verify cached models listed
+        working-directory: cli
+        run: |
+          OUTPUT=$(./opentaint prune --dry-run 2>&1)
+          if ! echo "$OUTPUT" | grep -q "model"; then
+            echo "Expected prune --dry-run to list cached model artifacts"
+            echo "$OUTPUT"
+            exit 1
+          fi
+          echo "Prune dry-run correctly lists cached models"
+
+      - name: Run opentaint prune --yes and verify cached models removed
+        working-directory: cli
+        run: |
+          ./opentaint prune --yes
+          if [ -d ~/.opentaint/cache ] && [ "$(ls -A ~/.opentaint/cache 2>/dev/null)" ]; then
+            echo "Expected cache directory to be empty after prune"
+            ls -la ~/.opentaint/cache/
+            exit 1
+          fi
+          echo "Prune correctly removed cached models"
+
   run-on-petclinic-windows:
     runs-on: windows-latest
 
@@ -185,7 +266,7 @@ jobs:
         working-directory: cli
         run: |
           ./opentaint compile --quiet ${{ steps.github-token.outputs.arg }} --output portable-project ../project-root --verbosity debug
-          ./opentaint scan --quiet ${{ steps.github-token.outputs.arg }} --output report.sarif portable-project --verbosity debug
+          ./opentaint scan --quiet ${{ steps.github-token.outputs.arg }} --output report.sarif --project-model portable-project --verbosity debug
 
       - name: Run opentaint scan
         working-directory: cli
@@ -232,7 +313,7 @@ jobs:
       - name: Run opentaint scan
         working-directory: cli
         run: |
-          ./opentaint scan ${{ steps.github-token.outputs.arg }} --output stirling-pdf-report.sarif stirling-pdf-model
+          ./opentaint scan ${{ steps.github-token.outputs.arg }} --output stirling-pdf-report.sarif --project-model stirling-pdf-model
 
   test-install-sh-linux:
     runs-on: ubuntu-latest

README.md

@@ -127,7 +127,7 @@ irm https://raw.githubusercontent.com/seqra/opentaint/main/scripts/install/insta
 
 **Scan your project:**
 ```bash
-opentaint scan --output results.sarif /path/to/your/spring/project
+opentaint scan
 ```
 
 **Or use Docker:**

cli/cmd/compile.go

@@ -26,6 +26,15 @@ const (
 var OutputProjectModelPath string
 var ProjectPath string
 var DryRunCompile bool
+var CompileLogFile string
+
+// currentCompileBuilder returns a builder pre-populated with the user's current compile flags.
+// All compile command suggestions should use this as the base to ensure that adding a new
+// flag in one place automatically propagates to every suggestion.
+func currentCompileBuilder(projectPath string) *utils.OpentaintCommandBuilder {
+	return utils.NewCompileCommand(projectPath).
+		WithOutput(OutputProjectModelPath)
+}
 
 // compileCmd represents the compile command
 var compileCmd = &cobra.Command{
@@ -44,6 +53,15 @@ Arguments:
 		projectRoot := filepath.Clean(ProjectPath)
 		absProjectRoot := log.AbsPathOrExit(projectRoot, "project path")
 
+		if err := validation.ValidateSourceProjectForCompile(absProjectRoot); err != nil {
+			out.FatalErr(err)
+		}
+
+		// Activate logging
+		if !DryRunCompile {
+			activateLoggingForProject(CompileLogFile, absProjectRoot)
+		}
+
 		outputProjectModelPath := filepath.Clean(OutputProjectModelPath)
 		absOutputProjectModelPath := log.AbsPathOrExit(outputProjectModelPath, "output")
 
@@ -97,6 +115,7 @@ func init() {
 	compileCmd.Flags().StringVarP(&OutputProjectModelPath, "output", "o", "", `Path to the result project model`)
 	_ = compileCmd.MarkFlagRequired("output")
 	compileCmd.Flags().BoolVar(&DryRunCompile, "dry-run", false, "Validate inputs and show what would run without compiling")
+	compileCmd.Flags().StringVar(&CompileLogFile, "log-file", "", "Path to the log file (default: <cache-dir>/logs/<timestamp>.log)")
 }
 
 func ensureAutobuilderAvailable() (string, error) {
@@ -131,7 +150,7 @@ func compile(absProjectRoot, absOutputProjectModelPath, autobuilderJarPath strin
 		validationErr := fmt.Errorf("output validation failed after compile: %w", err)
 		output.LogInfo(validationErr)
 		if caller == External {
-			suggest("If native compilation fails due to missing required Java, set JAVA_HOME according to the project's requirements or try Docker-based compilation:", utils.BuildCompileCommandWithDocker(ProjectPath, OutputProjectModelPath))
+			suggest("If native compilation fails due to missing required Java, set JAVA_HOME according to the project's requirements or try Docker-based compilation:", utils.BuildCompileCommandWithDocker(currentCompileBuilder(""), ProjectPath, OutputProjectModelPath))
 		}
 		return fmt.Errorf("there was a problem during the compile step, check the full logs: %s", globals.LogPath)
 	}

cli/cmd/logging.go

@@ -0,0 +1,44 @@
+package cmd
+
+import (
+	"github.com/seqra/opentaint/internal/globals"
+	"github.com/seqra/opentaint/internal/output"
+	"github.com/seqra/opentaint/internal/utils"
+	"github.com/seqra/opentaint/internal/utils/log"
+)
+
+// activateLogging opens the log file and configures the output printer's log writer.
+// If logFilePath is set, it uses that directly. Otherwise, it derives the log path
+// from the project cache directory. If both are empty, no log file is opened.
+func activateLogging(logFilePath string, projectCachePath string) {
+	var logPath string
+	var err error
+
+	if logFilePath != "" {
+		logPath = log.AbsPathOrExit(logFilePath, "log file")
+		if _, err = log.OpenLogFileAt(logPath); err != nil {
+			out.Fatalf("Failed to open log file: %s", err)
+		}
+	} else if projectCachePath != "" {
+		logPath, err = log.OpenProjectLog(projectCachePath)
+		if err != nil {
+			out.Fatalf("Failed to open project log file: %s", err)
+		}
+	}
+
+	if logPath != "" {
+		globals.LogPath = logPath
+		out.SetLogWriter(log.LogWriter())
+	}
+}
+
+// activateLoggingForProject resolves the project cache path from projectPath,
+// then activates logging. Used by compile and project commands that share the
+// same "resolve cache path → activate logging" pattern.
+func activateLoggingForProject(logFilePath string, projectPath string) {
+	cachePath, err := utils.GetProjectCachePath(projectPath)
+	if err != nil {
+		output.LogInfof("Failed to resolve project cache path for logging: %v", err)
+	}
+	activateLogging(logFilePath, cachePath)
+}

cli/cmd/project.go

@@ -206,12 +206,13 @@ func (c *JavaAutobuilderConfig) logProjectSummary(projectYamlPath string, config
 }
 
 var (
-	OutputDir     string
-	SourceRoot    string
-	Dependencies  []string
-	Packages      []string
-	Classpaths    []string
-	DryRunProject bool
+	OutputDir      string
+	SourceRoot     string
+	Dependencies   []string
+	Packages       []string
+	Classpaths     []string
+	DryRunProject  bool
+	ProjectLogFile string
 )
 
 var projectCmd = &cobra.Command{
@@ -235,6 +236,12 @@ Examples:
 			WithClasspath(Classpaths).
 			Build()
 
+		// Activate logging — derive cache slug from --output path
+		if !DryRunProject {
+			outputAbs := log.AbsPathOrExit(filepath.Clean(OutputDir), "output")
+			activateLoggingForProject(ProjectLogFile, outputAbs)
+		}
+
 		classpathItems := make([]any, len(config.classpaths))
 		for i, cp := range config.classpaths {
 			classpathItems[i] = cp
@@ -284,4 +291,5 @@ func init() {
 	projectCmd.Flags().StringArrayVar(&Classpaths, "classpath", []string{}, "Classpath entries (classes or JAR files)")
 	_ = projectCmd.MarkFlagRequired("classpath")
 	projectCmd.Flags().BoolVar(&DryRunProject, "dry-run", false, "Validate inputs and show what would run without generating project model")
+	projectCmd.Flags().StringVar(&ProjectLogFile, "log-file", "", "Path to the log file (default: <cache-dir>/logs/<timestamp>.log)")
 }

cli/cmd/prune.go

@@ -25,7 +25,7 @@ Identifies artifacts that are no longer needed:
 - Redundant downloads when bundled artifacts are available
 - Stale install-tier artifacts (~/.opentaint/install/) after a opentaint upgrade
 
-By default, log files are kept. Use --include-logs to also prune them.`,
+By default, log files are kept. Use --include-logs to also prune them from project cache directories.`,
 	Run: func(cmd *cobra.Command, args []string) {
 		result, err := utils.ScanForStaleArtifacts(pruneIncLogs)
 		if err != nil {

cli/cmd/root.go

@@ -40,19 +40,13 @@ var rootCmd = &cobra.Command{
 		}
 		globals.Config.Log.Verbosity = verbosity
 
-		// Set up logging to both console and file
-		logFile, logPath, err := log.OpenLogFile()
-		globals.LogPath = logPath
-		cobra.CheckErr(err)
-
-		if err := log.SetUpLogs(logFile, globals.Config.Log.Verbosity, globals.Config.Log.Color); err != nil {
+		if err := log.SetUpLogs(globals.Config.Log.Verbosity); err != nil {
 			return fmt.Errorf("failed to set up logging: %w", err)
 		}
 
 		// Configure the output printer (color mode, quiet mode)
 		out.Configure(globals.Config.Log.Color, globals.Config.Quiet)
 		out.SetVerbosity(globals.Config.Log.Verbosity)
-		out.SetLogWriter(logFile)
 
 		// Start async update check (non-blocking, at most once per day)
 		if !globals.Config.Quiet {
@@ -84,7 +78,7 @@ var rootCmd = &cobra.Command{
 func Execute() {
 	err := rootCmd.Execute()
 	if err != nil {
-		fmt.Fprintf(os.Stderr, "Error: %s\n", err)
+		fmt.Fprintf(os.Stderr, "Error: %s\n", output.Humanize(err))
 		fmt.Fprintln(os.Stderr, "Run 'opentaint --help' for usage.")
 		os.Exit(1)
 	}
@@ -176,7 +170,9 @@ func addConfigFields(cmd *cobra.Command, sb *output.SectionBuilder) {
 			if viper.ConfigFileUsed() != "" {
 				sb.Field("Config file", viper.ConfigFileUsed())
 			}
-			sb.Field("Log file", globals.LogPath)
+			if globals.LogPath != "" {
+				sb.Field("Log file", globals.LogPath)
+			}
 		}
 	}
 }