feat: add timeout to jobs

Author: dareste

cmd/kic-supportpkg.go

@@ -28,7 +28,7 @@ func Execute() {
 				fmt.Printf("Running job %s...", job.Name)
 				err = job.Collect(collector)
 				if err != nil {
-					fmt.Printf("Error: %s\n", err)
+					fmt.Printf(" Error: %s\n", err)
 				} else {
 					fmt.Print(" OK\n")
 				}

pkg/jobs/job.go

@@ -2,6 +2,8 @@ package jobs
 
 import (
 	"context"
+	"errors"
+	"fmt"
 	"github.com/nginxinc/kubectl-kic-supportpkg/pkg/data_collector"
 	"os"
 	"path"
@@ -11,27 +13,44 @@ import (
 type Job struct {
 	Name    string
 	Global  bool
-	Execute func(dc *data_collector.DataCollector, ctx context.Context) map[string][]byte
-	//TODO: execute function must return an error
+	Timeout time.Duration
+	Execute func(dc *data_collector.DataCollector, ctx context.Context, ch chan JobResult)
+}
+
+type JobResult struct {
+	Files map[string][]byte
+	Error error
 }
 
 func (j Job) Collect(dc *data_collector.DataCollector) error {
-	ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
+	ch := make(chan JobResult, 1)
+
+	ctx, cancel := context.WithTimeout(context.Background(), j.Timeout)
 	defer cancel()
 
-	jobResults := j.Execute(dc, ctx)
+	go j.Execute(dc, ctx, ch)
 
-	for fileName, fileValue := range jobResults {
-		err := os.MkdirAll(path.Dir(fileName), os.ModePerm)
-		if err != nil {
-			return err
+	select {
+	case <-ctx.Done():
+		return errors.New(fmt.Sprintf("Context cancelled: %v", ctx.Err()))
+
+	case jobResults := <-ch:
+		if jobResults.Error != nil {
+			return jobResults.Error
 		}
-		file, _ := os.Create(fileName)
-		_, err = file.Write(fileValue)
-		if err != nil {
-			return err
+
+		for fileName, fileValue := range jobResults.Files {
+			err := os.MkdirAll(path.Dir(fileName), os.ModePerm)
+			if err != nil {
+				return err
+			}
+			file, _ := os.Create(fileName)
+			_, err = file.Write(fileValue)
+			if err != nil {
+				return err
+			}
+			_ = file.Close()
 		}
-		_ = file.Close()
+		return nil
 	}
-	return nil
 }