do_run 0.1.0

data/lib/do/validator.rb

@@ -0,0 +1,124 @@
+require_relative 'config'
+require_relative 'scheduler'
+require_relative 'task'
+require_relative 'error'
+
+module Do
+  # Stateless validation over a parsed {Config}. Returns human-readable error
+  # strings and never touches the system.
+  module Validator
+    module_function
+
+    # @param config [Config] parsed configuration
+    # @return [Array<String>] validation errors (empty when valid)
+    def validate(config)
+      errors = []
+      errors.concat(validate_commands(config))
+      errors.concat(validate_task_fields(config))
+      errors.concat(validate_duplicates(config))
+      errors.concat(validate_schedules(config))
+      errors.concat(validate_unit_names(config))
+      errors.concat(validate_directories(config))
+      errors.concat(validate_environment(config))
+      errors
+    end
+
+    def valid?(config)
+      validate(config).empty?
+    end
+
+    # @raise [ValidationError] when config is invalid
+    def validate!(config)
+      errors = validate(config)
+      raise ValidationError, errors unless errors.empty?
+
+      true
+    end
+
+    def validate_commands(config)
+      config.tasks.flat_map do |task|
+        if task.command.nil? || task.command.to_s.strip.empty?
+          ["task '#{task.name}' is missing required field 'command'"]
+        else
+          []
+        end
+      end
+    end
+
+    def validate_task_fields(config)
+      config.tasks.flat_map do |task|
+        unknown = task.raw.keys - Config::KNOWN_TASK_FIELDS
+        unknown.map { |field| "unsupported field '#{field}' for task '#{task.name}'" }
+      end
+    end
+
+    def validate_duplicates(config)
+      lowered = config.tasks.map { |t| t.name.downcase }
+      lowered
+        .select { |n| lowered.count(n) > 1 }.uniq
+        .map { |n| "duplicate task name '#{n}'" }
+    end
+
+    def validate_schedules(config)
+      config.tasks.flat_map { |task| schedule_errors(task) }
+    end
+
+    def validate_unit_names(config)
+      config.tasks.flat_map do |task|
+        name = task.name.to_s
+        if name.empty?
+          ['task has an empty name']
+        elsif name.start_with?('.') || name =~ %r{[\s/]|\.}
+          ["task name '#{name}' is not a valid systemd unit name " \
+           "(must not contain spaces, '/', dots, or start with a dot)"]
+        else
+          []
+        end
+      end
+    end
+
+    def validate_directories(config)
+      config.tasks.flat_map do |task|
+        wd = task.working_directory
+        next [] if wd.nil? || wd.empty?
+
+        if File.directory?(File.expand_path(wd))
+          []
+        else
+          ["working directory '#{wd}' for task '#{task.name}' does not exist"]
+        end
+      end
+    end
+
+    def validate_environment(config)
+      config.tasks.flat_map do |task|
+        (task.environment || {}).flat_map do |key, value|
+          if key.is_a?(String) && value.is_a?(String)
+            []
+          else
+            ["environment for task '#{task.name}' must map strings to strings"]
+          end
+        end
+      end
+    end
+
+    def schedule_errors(task)
+      sched = task.schedule
+      return [] if sched.nil? || sched.empty?
+
+      unless Task::SCHEDULES.include?(sched)
+        return ["invalid schedule for task '#{task.name}'. " \
+                'Expected: once, hourly, daily, weekly, or monthly.']
+      end
+
+      # Driving the calendar generator lets us reuse the exact same parsing
+      # rules that will later be used to emit the systemd unit.
+      begin
+        Scheduler.on_calendar(task)
+        []
+      rescue Do::Error => e
+        ["invalid schedule for task '#{task.name}': #{e.message}"]
+      end
+    end
+  end
+end

data/lib/do/version.rb

@@ -0,0 +1,3 @@
+module Do
+  VERSION = '0.1.0'.freeze
+end

data/lib/do.rb

@@ -0,0 +1,13 @@
+require_relative 'do/version'
+require_relative 'do/error'
+require_relative 'do/config'
+require_relative 'do/task'
+require_relative 'do/scheduler'
+require_relative 'do/systemd'
+require_relative 'do/validator'
+require_relative 'do/executor'
+require_relative 'do/manager'
+require_relative 'do/cli'
+
+module Do
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: do_run
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- do contributors
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: toml-rb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+description: do is a declarative execution layer for Linux. It translates a small
+  TOML configuration into systemd user services and timers, giving you a friendly
+  control plane without reinventing scheduling.
+executables:
+- do
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- bin/do
+- lib/do.rb
+- lib/do/cli.rb
+- lib/do/config.rb
+- lib/do/error.rb
+- lib/do/executor.rb
+- lib/do/manager.rb
+- lib/do/scheduler.rb
+- lib/do/systemd.rb
+- lib/do/task.rb
+- lib/do/validator.rb
+- lib/do/version.rb
+homepage: https://sahil.im./tools/do
+licenses:
+- GPL-3.0-or-later
+metadata:
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.16
+specification_version: 4
+summary: Declarative Linux execution layer backed by systemd user services and timers.
+test_files: []