Merge pull request #5 from gammadia/better-jobfile

.github/workflows/ci.yaml

@@ -0,0 +1,15 @@
+name: CI
+on: [push]
+
+jobs:
+  tests:
+    name: Tests
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup Go
+        uses: actions/setup-go@v4
+        with:
+          go-version: '1.21.x'
+      - name: Tests
+        run: make test

Makefile

@@ -18,3 +18,7 @@ proto:
 .PHONY: run-server
 run-server: proto
 	reflex -s -t 120s -r '\.go' -- bash -c "make bin/alfred-server && bin/alfred-server"
+
+.PHONY: test
+test:
+	go test -v ./...

client/job/jobfile.go

@@ -2,11 +2,18 @@ package job
 
 import (
 	"fmt"
+	"os"
+	"path"
+	"regexp"
+	"strconv"
+	"time"
 )
 
 const JobfileVersion = "1"
 
 type Jobfile struct {
+	path string
+
 	Version  string
 	Name     string
 	Image    JobfileImage
@@ -27,7 +34,10 @@ type JobfileService struct {
 }
 
 type JobfileServiceHealth struct {
-	Cmd []string
+	Cmd      []string
+	Timeout  string
+	Interval string
+	Retries  string
 }
 
 func (jobfile Jobfile) Validate() error {
@@ -36,16 +46,68 @@ func (jobfile Jobfile) Validate() error {
 	}
 
 	if jobfile.Name == "" {
-		return fmt.Errorf("job name is required")
+		return fmt.Errorf("name is required")
 	}
 
 	if jobfile.Image.Dockerfile == "" {
 		return fmt.Errorf("image.dockerfile is required")
 	}
+	if _, err := os.Stat(path.Join(jobfile.path, jobfile.Image.Dockerfile)); os.IsNotExist(err) {
+		return fmt.Errorf("image.dockerfile must be an existing file on disk")
+	}
 
 	if jobfile.Image.Context == "" {
 		return fmt.Errorf("image.context is required")
 	}
+	if _, err := os.Stat(path.Join(jobfile.path, jobfile.Image.Context)); os.IsNotExist(err) {
+		return fmt.Errorf("image.context must be an existing folder on disk")
+	}
+
+	serviceNameRegex := regexp.MustCompile(`^[a-zA-Z][a-zA-Z0-9._-]+$`)
+	serviceEnvKeyRegex := regexp.MustCompile(`^[A-Z][A-Z0-9_]+$`)
+
+	for name, service := range jobfile.Services {
+		if !serviceNameRegex.MatchString(name) {
+			return fmt.Errorf("services names must be valid identifiers")
+		}
+
+		if service.Image == "" {
+			return fmt.Errorf("services[%s].image is required", name)
+		}
+
+		for key, _ := range service.Env {
+			if !serviceEnvKeyRegex.MatchString(key) {
+				return fmt.Errorf("services[%s].env[%s] must be a valid environment variable identifier", name, key)
+			}
+		}
+
+		// If none of the health fields are specified, skip validation
+		if service.Health.Cmd == nil && service.Health.Timeout == "" && service.Health.Interval == "" && service.Health.Retries == "" {
+			continue
+		}
+
+		if len(service.Health.Cmd) < 1 {
+			return fmt.Errorf("services[%s].health.cmd is required", name)
+		}
+
+		if service.Health.Interval != "" {
+			if _, err := time.ParseDuration(service.Health.Interval); err != nil {
+				return fmt.Errorf("services[%s].health.interval is not a valid duration: %w", name, err)
+			}
+		}
+
+		if service.Health.Timeout != "" {
+			if _, err := time.ParseDuration(service.Health.Timeout); err != nil {
+				return fmt.Errorf("services[%s].health.timeout is not a valid duration: %w", name, err)
+			}
+		}
+
+		if service.Health.Retries != "" {
+			if _, err := strconv.ParseInt(service.Health.Retries, 10, 64); err != nil {
+				return fmt.Errorf("services[%s].health.retries is not a valid numeric: %w", name, err)
+			}
+		}
+	}
 
 	return nil
 }

client/job/jobfile_test.go

@@ -0,0 +1,55 @@
+package job
+
+import (
+	"github.com/samber/lo"
+	"github.com/stretchr/testify/assert"
+	"gopkg.in/yaml.v3"
+	"os"
+	"path"
+	"testing"
+)
+
+var flagtests = []struct {
+	file     string
+	expected string
+}{
+	{"tests/jobfile/valid_minimalist.yaml", ""},
+	{"tests/jobfile/valid_full_featured.yaml", ""},
+
+	{"tests/jobfile/invalid_missing_name.yaml", "name is required"},
+	{"tests/jobfile/invalid_missing_image_dockerfile.yaml", "image.dockerfile is required"},
+	{"tests/jobfile/invalid_missing_image_context.yaml", "image.context is required"},
+	{"tests/jobfile/invalid_missing_services_image.yaml", "services[mysql].image is required"},
+	{"tests/jobfile/invalid_missing_services_health_cmd.yaml", "services[mysql].health.cmd is required"},
+
+	{"tests/jobfile/invalid_version.yaml", "unsupported version '42'"},
+	{"tests/jobfile/invalid_image_dockerfile.yaml", "image.dockerfile must be an existing file on disk"},
+	{"tests/jobfile/invalid_image_context.yaml", "image.context must be an existing folder on disk"},
+	{"tests/jobfile/invalid_services_map.yaml", "yaml: unmarshal errors:\n  line 7: cannot unmarshal !!seq into map[string]job.JobfileService"},
+	{"tests/jobfile/invalid_services_keys.yaml", "services names must be valid identifiers"},
+	{"tests/jobfile/invalid_services_env_keys.yaml", "services[mysql].env[0/2] must be a valid environment variable identifier"},
+}
+
+func TestJobValidate(t *testing.T) {
+	var buf []byte
+	var err error
+
+	for _, tt := range flagtests {
+		t.Run(tt.file, func(t *testing.T) {
+			buf = lo.Must(os.ReadFile(tt.file))
+
+			var jobfile Jobfile
+			if err = yaml.Unmarshal(buf, &jobfile); err != nil {
+				assert.Equal(t, tt.expected, err.Error())
+				return
+			}
+			jobfile.path = path.Dir(tt.file)
+			if err = jobfile.Validate(); err != nil {
+				assert.Equal(t, tt.expected, err.Error())
+				return
+			}
+
+			assert.Equal(t, "", tt.expected)
+		})
+	}
+}

client/job/reader.go

@@ -2,14 +2,16 @@ package job
 
 import (
 	"fmt"
+	"github.com/gammadia/alfred/proto"
+	"github.com/samber/lo"
+	"google.golang.org/protobuf/types/known/durationpb"
+	"gopkg.in/yaml.v3"
 	"os"
 	"os/exec"
 	"path"
+	"strconv"
 	"strings"
-
-	"github.com/gammadia/alfred/proto"
-	"github.com/samber/lo"
-	"gopkg.in/yaml.v3"
+	"time"
 )
 
 func Read(p string, overrides Overrides) (job *proto.Job, err error) {
@@ -28,6 +30,7 @@ func Read(p string, overrides Overrides) (job *proto.Job, err error) {
 		err = fmt.Errorf("unmarshal: %w", err)
 		return
 	}
+	jobfile.path = workDir
 	if err = jobfile.Validate(); err != nil {
 		err = fmt.Errorf("validate: %w", err)
 		return
@@ -62,7 +65,7 @@ func Read(p string, overrides Overrides) (job *proto.Job, err error) {
 
 	// Services
 	for name, service := range jobfile.Services {
-		job.Services = append(job.Services, &proto.Job_Service{
+		jobService := &proto.Job_Service{
 			Name:  name,
 			Image: service.Image,
 			Env: lo.MapToSlice(service.Env, func(key string, value string) *proto.Job_Env {
@@ -75,7 +78,20 @@ func Read(p string, overrides Overrides) (job *proto.Job, err error) {
 				Cmd:  service.Health.Cmd[0],
 				Args: service.Health.Cmd[1:],
 			}),
-		})
+		}
+
+		if service.Health.Timeout != "" {
+			jobService.Health.Timeout = durationpb.New(lo.Must(time.ParseDuration(service.Health.Timeout)))
+		}
+		if service.Health.Interval != "" {
+			jobService.Health.Interval = durationpb.New(lo.Must(time.ParseDuration(service.Health.Interval)))
+		}
+		if service.Health.Retries != "" {
+			retries := lo.Must(strconv.ParseUint(service.Health.Retries, 10, 64))
+			jobService.Health.Retries = &retries
+		}
+
+		job.Services = append(job.Services, jobService)
 	}
 
 	return

client/job/tests/jobfile/a.dockerfile

@@ -0,0 +1 @@
+FROM alpine:latest

client/job/tests/jobfile/invalid_image_context.yaml

@@ -0,0 +1,5 @@
+version: "1"
+name: "test"
+image:
+  dockerfile: "a.dockerfile"
+  context: "./toto"

client/job/tests/jobfile/invalid_image_dockerfile.yaml

@@ -0,0 +1,5 @@
+version: "1"
+name: "test"
+image:
+  dockerfile: "toto.dockerfile"
+  context: "."

client/job/tests/jobfile/invalid_missing_image_context.yaml

@@ -0,0 +1,4 @@
+version: "1"
+name: "test"
+image:
+  dockerfile: "a.dockerfile"

client/job/tests/jobfile/invalid_missing_image_dockerfile.yaml

@@ -0,0 +1,4 @@
+version: "1"
+name: "test"
+image:
+  context: "."

client/job/tests/jobfile/invalid_missing_name.yaml

@@ -0,0 +1,4 @@
+version: "1"
+image:
+  dockerfile: "a.dockerfile"
+  context: "."

client/job/tests/jobfile/invalid_missing_services_health_cmd.yaml

@@ -0,0 +1,10 @@
+version: "1"
+name: "test"
+image:
+  dockerfile: "a.dockerfile"
+  context: "."
+services:
+  mysql:
+    image: mysql
+    health:
+      retries: 1

client/job/tests/jobfile/invalid_missing_services_image.yaml

@@ -0,0 +1,9 @@
+version: "1"
+name: "test"
+image:
+  dockerfile: "a.dockerfile"
+  context: "."
+services:
+  mysql:
+    env:
+      TOTO: toto

client/job/tests/jobfile/invalid_services_env_keys.yaml

@@ -0,0 +1,10 @@
+version: "1"
+name: "test"
+image:
+  dockerfile: "a.dockerfile"
+  context: "."
+services:
+  mysql:
+    image: mysql
+    env:
+      0/2: foo

client/job/tests/jobfile/invalid_services_health_timeout.yaml

@@ -0,0 +1,10 @@
+version: "1"
+name: "test"
+image:
+  dockerfile: "a.dockerfile"
+  context: "."
+services:
+  mysql:
+    image: mysql
+    health:
+      timeout:

client/job/tests/jobfile/invalid_services_keys.yaml

@@ -0,0 +1,8 @@
+version: "1"
+name: "test"
+image:
+  dockerfile: "a.dockerfile"
+  context: "."
+services:
+  0/2:
+    image: mysql

client/job/tests/jobfile/invalid_services_map.yaml

@@ -0,0 +1,8 @@
+version: "1"
+name: "test"
+image:
+  dockerfile: "a.dockerfile"
+  context: "."
+services:
+  - mysql
+  - redis

client/job/tests/jobfile/invalid_version.yaml

@@ -0,0 +1,5 @@
+version: "42"
+name: "test"
+image:
+  dockerfile: "a.dockerfile"
+  context: "."

client/job/tests/jobfile/valid_full_featured.yaml

@@ -0,0 +1,24 @@
+version: "1"
+name: "test"
+image:
+  dockerfile: "a.dockerfile"
+  context: "."
+services:
+  redis:
+    image: "redis:7.0.5-alpine"
+    health:
+      cmd: ["redis-cli", "ping"]
+      timeout: "5s"
+      wait: "1s"
+      retries: 10
+  mysql:
+    image: "mysql:8.0.31"
+    env:
+      MYSQL_ROOT_PASSWORD: "root"
+    health:
+      cmd: ["mysqladmin", "-u", "root", "-proot", "-h", "127.0.0.1", "ping"]
+      timeout: "10s"
+      interval: "2s"
+      retries: 20
+tasks: |
+  sloth instance --app tipee list -o json | jq -r '.[] | select(.features.tests) | .id' | tail -n 1

client/job/tests/jobfile/valid_minimalist.yaml

@@ -0,0 +1,5 @@
+version: "1"
+name: "test"
+image:
+  dockerfile: "a.dockerfile"
+  context: "."

go.mod

@@ -13,6 +13,7 @@ require (
 	github.com/spf13/cobra v1.7.0
 	github.com/spf13/pflag v1.0.5
 	github.com/spf13/viper v1.17.0
+	github.com/stretchr/testify v1.8.4
 	golang.org/x/crypto v0.14.0
 	google.golang.org/grpc v1.59.0
 	google.golang.org/protobuf v1.31.0
@@ -21,6 +22,7 @@ require (
 
 require (
 	github.com/Microsoft/go-winio v0.6.1 // indirect
+	github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc // indirect
 	github.com/distribution/reference v0.5.0 // indirect
 	github.com/docker/distribution v2.8.3+incompatible // indirect
 	github.com/docker/go-connections v0.4.0 // indirect
@@ -44,6 +46,7 @@ require (
 	github.com/opencontainers/image-spec v1.0.2 // indirect
 	github.com/pelletier/go-toml/v2 v2.1.0 // indirect
 	github.com/pkg/errors v0.9.1 // indirect
+	github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 // indirect
 	github.com/rivo/uniseg v0.4.4 // indirect
 	github.com/sagikazarmark/locafero v0.3.0 // indirect
 	github.com/sagikazarmark/slog-shim v0.1.0 // indirect