Merge pull request #105 from fmotalleb/vars

Author: fmotalleb

.vscode/launch.json

@@ -14,7 +14,8 @@
             "envFile": "${workspaceFolder}/.env",
             "args": [
                 "-c",
-                "config.local.yaml"
+                "config.local.yaml",
+                "-v"
             ]
         },
         {

CHANGELOG.md

@@ -1,29 +1,81 @@
+
 # Changelog
 
-## 0.2
-
-* Docker integration
-  * Execute the command inside a running container (using attach)
-  * Create new container (using given image name) and then run the command inside it
-
-* Command execution credentials (unix only)
-
-## v0.1
-
-* Initial release
-* Added support for multiple scheduler methods:
-  * Cron string (with seconds)
-  * Interval (duration)
-  * At (time)
-* Tasks:
-  * Built-in http request methods (get,post)
-  * Can invoke external commands (same as cron)
-    * Supports setting environments variable
-  * Can be configured to use any terminal/shell you want such as sh,bash,nu,cmd,powershell,...
-  * Can have retries per task (on commands exit-code !=0 or http request errors)
-* Support for hooks, for both when tasks fail or they finish successfully (structure is the same as a task)
-* Multiple scheduler for each job
-* Multiple task for each job
-* Logging:
-  * File logging
-  * ansi/plain/json log formatter
+This file summarizes notable changes for each released tag. Trivial noise (merge commits, many dependabot lines and minor chore commits) has been removed to keep the history focused.
+
+## v0.1 (2024-06-06)
+
+- MVP and core features: command implementation, get/post/executable tasks, file log writer, compiler for Task.
+- Schedulers: initial support for interval, cron and at schedulers.
+- Config and validation: initial config structure and config validation added.
+
+## v0.1.1 (2024-06-07)
+
+- Improvements to concurrency and task-runner: concurrency lock, concurrency config field and sync.Locker implementation.
+- Cron improvements: optional seconds field, macros support and docs updates.
+- Added config schema and miscellaneous optimizations.
+
+## v0.2 (2024-06-12)
+
+- Docker connection: create containers from images and a fully functional docker connection implementation.
+- Per-task hooks and dynamic task connections.
+- Credential manager + validator and other robustness fixes.
+
+## v0.4 (2024-06-30)
+
+- Integrated cron parser and sanitizer.
+- Webserver and HTTP event listener added.
+- Notable breaking change: scheduler renamed to event.
+- Various fixes and race-condition fixes in concurrent pool and test coverage improvements.
+
+## v0.4.1 — v0.4.5 (2024-07-01 → 2024-07-02)
+
+- Releases focused on Docker-related fixes, CI tweaks, and stability fixes (docker image/ghcr, docker API migration, CI updates).
+
+## v0.5.0 (2024-07-06)
+
+- Metrics/exporters: added basic exporters including command status and event counter exporter.
+- Fixes for global context and concurrency behavior.
+
+## v0.6.0-alpha → v0.6.0 (2024-07-13 → 2024-07-29)
+
+- Docker event listener and utilities added.
+- Exported/overhauled some functionalities and various dependency bumps for docker-related modules.
+
+## v0.7.x (2024-08-17 → 2024-09-10)
+
+- Improvements: environ key handling, logfile watcher, command event arg mode.
+- Multiple dependency updates and bug fixes; numerous small improvements and tests.
+
+## v0.7.4 → v0.7.6 (2025-02-17 → 2025-05-12)
+
+- Tooling updates: Go version bumped to 1.24, multiple dependabot dependency bumps and CI/tooling maintenance.
+- Fixes: deadlock and race-condition fixes.
+
+## v0.8.x (2025-05-20 → 2025-07-26)
+
+- Major refactor and system design improvements: generator-based approach, redesigned template engine, command context immutability.
+- CI/CD and goreleaser/workflow fixes and simplifications. Docker and template-related fixes.
+
+## v0.9.0 (2025-09-27)
+
+- Template engine: switched to go-tools version and added query params support.
+- Various dependency bumps and tooling updates.
+
+## v0.9.1 (2025-11-04)
+
+- Versioning and release tweaks; added version data to CLI command.
+- Dependency/tooling bumps (CodeQL, actions, docker, etc.).
+
+## v0.9.2 (2025-11-08)
+
+- Bump: docker to latest version.
+- Hotfix: added buffer size to zip channel (10 items per input).
+- Feature: added signal handling.
+- Fix: concurrent write exception fix.
+
+## v0.10.0 (2025-11-08)
+
+- Feature: per-task variables that can be used in hooks.
+- Chore: switch logger to zap logger.
+- Fix: remove redundant println in cron registration.

cmd/parser/cron_string.go

@@ -68,10 +68,10 @@ func (s *CronString) parseAsSpec(
 	specs := make([]cronSpec, 0)
 	lines := s.sanitize().lines()
 	matcher, parser, err := buildMapper(hasUser, pattern)
-	log.Debug("parsing lines using line matcher", zap.String("matcher", matcher.String()))
 	if err != nil {
 		return []cronSpec{}, err
 	}
+	log.Debug("parsing lines using line matcher", zap.String("matcher", matcher.String()))
 	for num, line := range lines {
 		l := cronLine{line}
 		if env, err := l.exportEnv(); len(env) > 0 {

cmd/parser/parser.go

@@ -54,7 +54,7 @@ func run(cmd *cobra.Command, _ []string) {
 }
 
 func writeOutput(log *zap.Logger, cfg *parserConfig, result string) {
-	outputFile, err := os.OpenFile(cfg.output, os.O_WRONLY|os.O_CREATE, 0o644)
+	outputFile, err := os.OpenFile(cfg.output, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, 0o644)
 	if err != nil {
 		log.Panic("failed to open output file", zap.Error(err))
 	}

config.local.yaml

@@ -3,11 +3,13 @@
 jobs:
   - name: echo
     tasks:
-      - command: echo {{ now | date "2006-01-02_15-04-05" }}
+      - command: echo {{ .Vars.name }}; sleep 5sec
+        vars:
+          name: '{{ now | date "2006-01-02_15-04-05" }}'
         env:
           COLE: test
         on-done:
-          - command: echo test $env.COLE
+          - command: echo {{ .Vars.name }}
         # connections:
         #   - image: "library/alpine"
 

config/config.go

@@ -88,6 +88,9 @@ type Task struct {
 	// Hooks
 	OnDone []Task `mapstructure:"on-done" json:"on-done,omitempty"`
 	OnFail []Task `mapstructure:"on-fail" json:"on-fail,omitempty"`
+
+	// Misc
+	Vars map[string]string `mapstructure:"vars" json:"vars,omitempty"`
 }
 
 // TaskConnection represents the connection configuration for a task.

core/cmd_connection/command/command.go

@@ -4,6 +4,7 @@ package command
 import (
 	"context"
 	"fmt"
+	"maps"
 	"os"
 	"strings"
 
@@ -59,6 +60,14 @@ func (ctx Ctx) getEnv() map[string]string {
 	return env
 }
 
+func (ctx Ctx) getVars() map[string]string {
+	env, ok := ctx.Value(ctxutils.Vars).(map[string]string)
+	if !ok {
+		return map[string]string{}
+	}
+	return env
+}
+
 func (ctx Ctx) envReshape() []string {
 	env := ctx.getEnv()
 	result := make([]string, 0, len(env))
@@ -108,7 +117,10 @@ func (ctx Ctx) applyEventTemplate(src string) (string, error) {
 		ctx.logger.Warn("Event not found in context")
 		return src, nil
 	}
-	return applyTemplate(ctx.logger, src, event.GetData())
+	data := maps.Clone(event.GetData())
+	vars := ctx.getVars()
+	data["Vars"] = vars
+	return applyTemplate(ctx.logger, src, data)
 }
 
 func (ctx Ctx) tryTemplate(src string) string {

core/cmd_connection/docker_attach.go

@@ -133,7 +133,7 @@ func (d *DockerAttachConnection) Execute() ([]byte, error) {
 	d.log.Debug("output of stdout is fetched", zap.Int64("bytes", wrote))
 	if err != nil {
 		d.log.Debug("copy of std is failed", zap.Int64("until-err", wrote), zap.Error(err))
-		return nil, err
+		return writer.Bytes(), err
 	}
 	return writer.Bytes(), nil
 }

core/common/retry.go

@@ -52,5 +52,5 @@ func IncreaseRetry(ctx context.Context) context.Context {
 }
 
 func ResetRetries(ctx context.Context) context.Context {
-	return context.WithValue(ctx, ctxutils.RetryCountKey, 0)
+	return context.WithValue(ctx, ctxutils.RetryCountKey, RetryCount(0))
 }

core/event/logfile.go

@@ -100,7 +100,6 @@ func (lf *LogFile) BuildTickChannel() abstraction.EventChannel {
 		}
 		for {
 			data, err := reader.ReadString(byte(0))
-			lf.logger.Debug("failed to read line", zap.String("data", data), zap.Error(err))
 			if err != nil && err != io.EOF {
 				lf.logger.Error("error reading log file", zap.Error(err))
 				return