tests(integration): test improvement (#348)

* tests(integration): test improvement

* More test improvements

Author: taraspos

integration/run_exec_test.go

@@ -1,9 +1,12 @@
 package integration
 
 import (
+	"bufio"
 	"fmt"
+	"maps"
 	"os"
 	"path/filepath"
+	"slices"
 	"strconv"
 	"strings"
 	"testing"
@@ -14,43 +17,124 @@ import (
 func TestIntegration(t *testing.T) {
 	projectName := strings.ToLower(t.Name())
 	outputDir := t.TempDir()
-	local_exec_filename := "local_exec.txt"
-	exec_filename := "exec.txt"
-	run_filename := "run.txt"
-	sleep_for_seconds := 15
-	schedule_seconds := 3
+	composeFile := "./test-run-exec/docker-compose.yml"
 
-	t.Setenv("COMPOSE_FILE", "./test-run-exec/docker-compose.yml")
+	localExecFilename := "my-local-job.txt"
+	execFilename := "my-exec-job.txt"
+	runFilename := "my-run-job.txt"
+
+	sleepForSec := 10
+	scheduleEverySec := 3
+	expectedExecutions := (sleepForSec / scheduleEverySec)
+
+	if _, err := os.Stat(composeFile); os.IsNotExist(err) {
+		t.Fatalf("Compose file %s not found", composeFile)
+	}
+
+	t.Setenv("COMPOSE_FILE", composeFile)
 	t.Setenv("COMPOSE_PROJECT_NAME", projectName)
 	t.Setenv("OUTPUT_DIR", outputDir)
-	t.Setenv("SCHEDULE", fmt.Sprintf("@every %ds", schedule_seconds))
-	t.Setenv("SLEEP_SEC", strconv.Itoa(sleep_for_seconds))
-	t.Setenv("LOCAL_EXEC_OUTPUT_FILE", local_exec_filename)
-	t.Setenv("EXEC_OUTPUT_FILE", exec_filename)
-	t.Setenv("RUN_OUTPUT_FILE", run_filename)
-
-	t.Log("Printing docker compose config")
-	if err := sh.RunV("docker", "compose", "config"); err != nil {
-		t.Fatal(err)
-	}
+	t.Setenv("SCHEDULE", fmt.Sprintf("@every %ds", scheduleEverySec))
+	t.Setenv("SLEEP_FOR", strconv.Itoa(sleepForSec))
+	t.Setenv("LOCAL_EXEC_OUTPUT_FILE", localExecFilename)
+	t.Setenv("EXEC_OUTPUT_FILE", execFilename)
+	t.Setenv("RUN_OUTPUT_FILE", runFilename)
 
-	t.Log("Running docker compose up")
-	if err := sh.RunV("docker", "compose", "up", "--exit-code-from", "sleep1"); err != nil {
-		t.Error(err)
+	for _, command := range []string{"config", "build", "pull"} {
+		t.Run("docker compose "+command, func(t *testing.T) {
+			t.Logf("Running docker compose %s", command)
+			if err := sh.RunV("docker", "compose", command); err != nil {
+				t.Fatal(err)
+			}
+		})
 	}
 
-	for _, file := range []string{local_exec_filename, exec_filename, run_filename} {
-		t.Run(file, func(t *testing.T) {
+	t.Run("docker compose up", func(t *testing.T) {
+		if err := sh.RunV("docker", "compose", "up", "--exit-code-from", "sleep1"); err != nil {
+			t.Fatal(err)
+		}
+
+		for _, file := range []string{localExecFilename, execFilename, runFilename} {
 			t.Log("Checking for outputs in", file)
-			data, err := os.ReadFile(filepath.Join(outputDir, file))
+			count, content, err := checkFile(filepath.Join(outputDir, file))
 			if err != nil {
 				t.Error(err)
+				continue
 			}
 
-			split := strings.Split(string(data), "\n")
-			if expectedLines := sleep_for_seconds / schedule_seconds; len(split) != expectedLines {
-				t.Errorf("expected %d lines in %s, but got %d", expectedLines, file, len(split))
+			if count != expectedExecutions {
+				t.Errorf("expected %d lines in %s, but got %d. File content:\n%s", expectedExecutions, file, count, content)
 			}
-		})
+
+			// check files generated by the `save-folder` setting
+			resultFiles, err := checkSavedResults(file, outputDir)
+			if err != nil {
+				t.Error(err)
+			}
+
+			if len(resultFiles) != 3 {
+				keys := slices.Sorted(maps.Keys(resultFiles))
+				t.Errorf("expected 3 result files for %s, but got %d. Result files: %v", file, len(resultFiles), keys)
+			}
+
+			for file, count := range resultFiles {
+				if count != expectedExecutions {
+					t.Errorf("expected %d job execution files for %s, but got %d", expectedExecutions, file, count)
+				}
+			}
+		}
+	})
+}
+
+func checkSavedResults(fileName string, dir string) (map[string]int, error) {
+	jobName := strings.TrimSuffix(fileName, filepath.Ext(fileName))
+	files, err := os.ReadDir(dir)
+	if err != nil {
+		return nil, err
+	}
+
+	// Look in the outpot directory and count the number of files (without the filename prefix)
+	// Ofelia produces job executon results with the following naming convention:
+	// - 20250419_182443_my-local-job.json
+	// - 20250419_182443_my-local-job.stderr.log
+	// - 20250419_182443_my-local-job.stdout.log
+	//
+	// Before counting, we will trim timestamp prefix.
+
+	counts := make(map[string]int)
+	for _, file := range files {
+		if strings.Contains(file.Name(), jobName) {
+			nameSplit := strings.Split(file.Name(), jobName)
+			fileType := strings.TrimPrefix(file.Name(), nameSplit[0])
+			counts[fileType]++
+		}
+	}
+
+	// remove original file from counts
+	delete(counts, fileName)
+
+	return counts, nil
+}
+
+func checkFile(path string) (int, string, error) {
+	f, err := os.Open(path)
+	if err != nil {
+		return 0, "", err
+	}
+	defer f.Close()
+
+	scanner := bufio.NewScanner(f)
+	content := strings.Builder{}
+	count := 0
+	for scanner.Scan() {
+		content.Write(scanner.Bytes())
+		content.WriteByte('\n')
+		count++
+	}
+
+	if err := scanner.Err(); err != nil {
+		return 0, "", err
 	}
+
+	return count, content.String(), nil
 }

integration/test-run-exec/docker-compose.yml

@@ -25,6 +25,7 @@ services:
       - /var/run/docker.sock:/var/run/docker.sock:ro
       - *output_mount
     labels:
+      ofelia.save-folder: "/tmp/"
       ofelia.job-local.my-local-job.schedule: *schedule
       ofelia.job-local.my-local-job.command: *cmd_date_tee
       ofelia.job-run.my-run-job.schedule: *schedule