Merge pull request #54 from appknox/custom-timeout

timeout support added

Author: cosmosgenius

appknox/sarif_generator.go

@@ -90,7 +90,7 @@ type Help struct {
 	Markdown string `json:"markdown,omitempty"`
 }
 
-func GenerateSARIFGivenFileID(client *Client, fileID int, riskThreshold int) (SARIF, error) {
+func GenerateSARIFGivenFileID(client *Client, fileID int, riskThreshold int,staticScanTimeout time.Duration) (SARIF, error) {
 	ctx := context.Background()
 	var sarifReportProgess int
 	start := time.Now()
@@ -109,7 +109,7 @@ func GenerateSARIFGivenFileID(client *Client, fileID int, riskThreshold int) (SA
 			decor.Name("] "),
 		),
 	)
-
+	
 	for sarifReportProgess < 100 {
 		file, _, err := client.Files.GetByID(ctx, fileID)
 		if err != nil {
@@ -118,7 +118,8 @@ func GenerateSARIFGivenFileID(client *Client, fileID int, riskThreshold int) (SA
 		}
 		sarifReportProgess = file.StaticScanProgress
 		bar.SetCurrent(int64(sarifReportProgess), time.Since(start))
-		if time.Since(start) > 15*time.Minute {
+		
+		if time.Since(start) > staticScanTimeout {
 			err := errors.New("Request timed out")
 			PrintError(err)
 			os.Exit(1)
@@ -263,7 +264,7 @@ func GenerateSARIFGivenFileID(client *Client, fileID int, riskThreshold int) (SA
 }
 
 func PrintError(err error) {
-	panic("unimplemented")
+	panic(err)
 }
 
 func GenerateSARIFFileContent(sarif SARIF) (string, error) {

cmd/cicheck.go

@@ -5,6 +5,7 @@ import (
 	"os"
 	"strconv"
 	"strings"
+	"time"
 
 	"github.com/appknox/appknox-go/helper"
 	"github.com/spf13/cobra"
@@ -45,12 +46,18 @@ var cicheckCmd = &cobra.Command{
 			helper.PrintError(err)
 			os.Exit(1)
 		}
-		helper.ProcessCiCheck(fileID, riskThresholdInt)
+		timeoutMinutes, _ := cmd.Flags().GetInt("timeout")
+		timeout := time.Duration(timeoutMinutes) * time.Minute
+		
+		helper.ProcessCiCheck(fileID, riskThresholdInt, timeout)
 	},
 }
 
 func init() {
 	RootCmd.AddCommand(cicheckCmd)
 	cicheckCmd.Flags().StringP(
 		"risk-threshold", "r", "low", "Risk threshold to fail the command. Available options: low, medium, high")
+	cicheckCmd.Flags().IntP(
+			"timeout", "t", 30, "Static scan timeout in minutes for the CI check (default: 30)")
+	
 }

cmd/root.go

@@ -4,7 +4,7 @@ import (
 	"fmt"
 	"os"
 	"path/filepath"
-
+	
 	// "github.com/appknox/appknox-go/appknox"
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
@@ -39,7 +39,7 @@ func init() {
     viper.BindPFlag("host", RootCmd.PersistentFlags().Lookup("host"))
     viper.BindEnv("host", "APPKNOX_API_HOST")
 
-
+	// Define flags globally here for all subcommands
 	RootCmd.PersistentFlags().String("region", "", "Region names, e.g., global, saudi, uae. By default, global is used")
     viper.BindPFlag("region", RootCmd.PersistentFlags().Lookup("region"))
     viper.BindEnv("region", "APPKNOX_API_REGION")

cmd/sarif.go

@@ -5,7 +5,8 @@ import (
 	"os"
 	"strconv"
 	"strings"
-
+	"time"
+	
 	"github.com/appknox/appknox-go/helper"
 	"github.com/spf13/cobra"
 )
@@ -45,7 +46,9 @@ var sarifCmd = &cobra.Command{
 			os.Exit(1)
 		}
 		outputFilePath, _ := cmd.Flags().GetString("output")
-		helper.ConvertToSARIFReport(fileID,riskThresholdInt,outputFilePath)
+		timeoutMinutes, _ := cmd.Flags().GetInt("timeout")
+		timeout := time.Duration(timeoutMinutes) * time.Minute
+		helper.ConvertToSARIFReport(fileID,riskThresholdInt,outputFilePath,timeout)
 	},
 }
 
@@ -54,4 +57,6 @@ func init() {
 	sarifCmd.Flags().StringP(
 		"risk-threshold", "r", "low", "Risk threshold to fail the command. Available options: low, medium, high")
 	sarifCmd.PersistentFlags().StringP("output", "o", "report.sarif", "Output file path to save reports")
+	sarifCmd.Flags().IntP(
+		"timeout", "t", 30, "Static scan timeout in minutes for the CI check (default: 30)")
 }

helper/cicheck.go

@@ -6,7 +6,7 @@ import (
 	"fmt"
 	"os"
 	"time"
-
+	
 	"github.com/appknox/appknox-go/appknox"
 	"github.com/appknox/appknox-go/appknox/enums"
 	"github.com/cheynewallace/tabby"
@@ -15,11 +15,21 @@ import (
 )
 
 // ProcessCiCheck takes the list of analyses and print it to CLI.
-func ProcessCiCheck(fileID, riskThreshold int) {
+func ProcessCiCheck(fileID, riskThreshold int, staticScanTimeout time.Duration) {
+	// Add timeout validation
+	const minTimeout=1;//1 minute
+	const maxTimeout=240;//4 hours
+
+	if staticScanTimeout < minTimeout*time.Minute || staticScanTimeout > maxTimeout*time.Minute {
+		errMsg := fmt.Sprintf("Error: timeout must be between %v minute and %v minutes", minTimeout, maxTimeout)
+		fmt.Println(errMsg) // Print error message to standard output
+		os.Exit(1)
+	}
 	ctx := context.Background()
 	client := getClient()
 	var staticScanProgess int
 	start := time.Now()
+	fmt.Printf("Starting scan at: %v with timeout of %v\n", start.Format(time.RFC3339), staticScanTimeout)
 	p := mpb.New(
 		mpb.WithWidth(60),
 		mpb.WithRefreshRate(180*time.Millisecond),
@@ -44,7 +54,8 @@ func ProcessCiCheck(fileID, riskThreshold int) {
 		}
 		staticScanProgess = file.StaticScanProgress
 		bar.SetCurrent(int64(staticScanProgess), time.Since(start))
-		if time.Since(start) > 30*time.Minute {
+		
+		if time.Since(start) > staticScanTimeout {
 			err := errors.New("Request timed out")
 			PrintError(err)
 			os.Exit(1)

helper/sarif.go

@@ -3,13 +3,14 @@ package helper
 import (
 	"fmt"
 	"os"
-
+	"time"
+	
 	"github.com/appknox/appknox-go/appknox"
 )
 
-func ConvertToSARIFReport(fileID int, riskThreshold int, filePath string) error {
+func ConvertToSARIFReport(fileID int, riskThreshold int, filePath string,staticScanTimeout time.Duration) error {
 	client := getClient()
-	sarif, err := appknox.GenerateSARIFGivenFileID(client, fileID, riskThreshold)
+	sarif, err := appknox.GenerateSARIFGivenFileID(client, fileID, riskThreshold,staticScanTimeout)
 	if err != nil {
 		return err
 	}