seijaku 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63fdce33cce3f7b4496f7ba0968a069554f351f5b1ea37d84c0dc20b7cfb3d49
-  data.tar.gz: 01fc22c0d064e13bbf514633545ec4f947176a531bf57fe479294d816f60154b
+  metadata.gz: 0b351498f055e85f7e20edc44374616118d0162b479104d18f20b271138a9271
+  data.tar.gz: '08c117438ac1e83a15fef55c6973e27fd15ef1d2fbc03a7027774deee4904720'
 SHA512:
-  metadata.gz: ffc15482a72317f1617f65374e2de9dd86008d7d4faa64dc3a34fe9dc9e5f940f77982f2a009a82c54613b1226135e3b8a58a2a37d126e6b0a6b105d4de7b0f6
-  data.tar.gz: 3bdfd31aac02d9bdd5be33b5f77f05327ac4eaa05af82654b00d9fb4c30382be07c0879ae1ac91deaaf36468e934a6f0696b7e6223659332de25a2ed22f31fca
+  metadata.gz: 23d86d8bad1a17e32a8b52faebe48873369c7eabf8988fbeec15e854d2e4b834aa8d29dab583dbfb121f18de545289bb1f4ab7484cd7bea787c0aba04cfcd33d
+  data.tar.gz: '0532610288a45a4e8391f71da9caa73d2ac22f2a02af7a99af4629fdaa9b3efe60a2fdcf7696337030822e2a24d8d1f832855b447f88292e9d92e4774f843134'

data/CHANGELOG.md

@@ -1,4 +1,16 @@
-## [Unreleased]
+## Seijaku
+
+Please mind Seijaku is still under heavy development.
+
+## [0.3.0] - 2023-12-14
+
+- scheduler has been added to run reccurent payloads
+- fixed a bug related to SSHExecutor set as default executor
+
+## [0.2.0] - 2023-12-12
+
+- SSH executor added with `ssh` YAML dictionnary and `host` Task support.
+- Documentation added in `./docs` directory
 
 ## [0.1.0] - 2023-12-11
 

data/README.md

@@ -1,6 +1,9 @@
 # Seijaku
 
+[![Seijaku version](https://badge.fury.io/rb/seijaku.svg)](https://badge.fury.io/rb/seijaku)
+
 Seijaku is a program that allows you to execute shell commands listed in YAML payload files, ensuring that they are executed correctly.
+It includes a lightweight scheduler that will take care of executing payloads with specific delay between two executions.
 
 ## Concepts
 
@@ -12,6 +15,8 @@ Each task can have "pre" and "post" tasks, for example to create and delete fold
 
 A step sometimes needs variables in order to be performed correctly: Seijaku supports the direct definition of variables or from an environment variable of the shell running Seijaku.
 
+A scheduler is a file listing payloads that must be executed with unique specifications: a name, a delay between two runs and the path to the concerned payload.
+
 ## Example
 
 ```yaml
@@ -49,6 +54,21 @@ tasks:
       - ssh: echo "executed on host"
 ```
 
+### Scheduler
+
+```yaml
+name: my-scheduler
+
+payloads:
+  - payload: ./test/my-payload.yaml
+    name: My test Payload
+    every: 3600				# executed every hour
+
+  - payload: ./test/another-payload.yaml
+    name: Another payload
+    every: 60				# executed every minute
+```
+
 ## Installation
 
 ### Dependencies
@@ -66,5 +86,6 @@ gem install seijaku
 
 ```bash
 seijaku -h
-seijaku -f ./my-payload.yaml
+seijaku -f ./my-payload.yaml # one-time payload execution
+seijaku -s ./my-scheduler.yaml # recurrent payloads execution with delay
 ```

data/bin/seijaku

@@ -19,6 +19,7 @@ module App
   opts = OptionParser.new
   opts.banner = "Seijaku: simply runs YAML tasks with shell"
   opts.on("-f", "--file FILE", "Payload file path") { |o| options[:payload] = o }
+  opts.on("-s", "--scheduler FILE", "Scheduler file") { |o| options[:scheduler] = o }
   opts.on("-h", "--help", "Shows help and exit") do
     puts opts
     exit(0)
@@ -26,17 +27,42 @@ module App
 
   opts.parse!
 
-  if options[:payload].nil?
+  if options[:payload].nil? and options[:scheduler].nil?
     puts opts
-    exit 0
+    puts "Either -f or -s must be set"
+    exit 1
   end
 
-  payload_file = YAML.safe_load(
-    File.read(options[:payload])
-  )
+  if options[:payload] and options[:scheduler]
+    puts opts
+    puts "Either -f or -s must be set"
+    exit 1
+  end
 
-  logger.info "Starting Seijaku. Payload: #{payload_file["name"]}"
+  if options[:payload]
+    payload_file = YAML.safe_load(
+      File.read(options[:payload]),
+      symbolize_names: true
+    )
 
-  payload = Payload.new(payload_file, logger)
-  payload.execute!
+    logger.info "Starting Seijaku. Payload: #{payload_file["name"]}"
+
+    payload = Payload.new(payload_file, logger)
+    payload.execute!
+  end
+
+  if options[:scheduler]
+    scheduler_file = YAML.safe_load(
+      File.read(options[:scheduler])
+    )
+
+    logger.info "Starting Seijaku. Scheduler: #{scheduler_file["name"]}"
+    begin
+      scheduler = Scheduler.new(scheduler_file, logger)
+      scheduler.monitor!
+    rescue Interrupt
+      scheduler.soft_exit!
+      puts "All payloads did stop their execution gracefully."
+    end
+  end
 end

data/docs/4 - scheduler.md

@@ -0,0 +1,54 @@
+# Schedulers
+
+Since version `0.3.0`, Seijaku implements a task scheduler that permits us to execute payloads with interval between two runs.
+
+Instead of using the `-f` parameter to run a payload, you can use the `-s (--scheduler)` parameter to pass a `schedulerfile` to Seijaku.
+
+## How it works ?
+
+Ruby isn't great at parallelism, but it does integrate `Threads`. The Scheduler will assign a Thread to all the payloads to execute.
+
+## Example
+
+Here is a really basic payload for example purpose:
+
+```yaml
+name: my-payload
+tasks:
+  - name: say hello world
+    steps:
+      - sh: echo "hello world"
+```
+
+If you want to run this payload every 10 seconds, you can create a scheduler file (call it whatever you want), describing the awaited behavior.
+
+```yaml
+name: "my-scheduler"
+
+payloads:
+  - payload: ./my-payload.yaml
+    every: 10
+    name: say-hello-world-10-s
+```
+
+## Graceful stop
+
+CTRL+C (Interrupt signal) sends an information to all the SchedulerExecutors running, asking them to do not re-schedule the payload execution they are in charge of once the current execution is finished.
+
+```
+...
+> CTRL+C
+[2023-12-14T18:48:12.509483 #8841]  INFO -- : Soft exit asked by user, waiting for payloads to stop naturally...
+I, [2023-12-14T18:48:12.509789 #8841]  INFO -- : test payload: still waiting...
+I, [2023-12-14T18:48:12.509856 #8841]  INFO -- : another-payload: still waiting...
+I, [2023-12-14T18:48:13.515211 #8841]  INFO -- : test payload: still waiting...
+I, [2023-12-14T18:48:13.515496 #8841]  INFO -- : another-payload: still waiting...
+I, [2023-12-14T18:48:14.520005 #8841]  INFO -- : test payload: still waiting...
+I, [2023-12-14T18:48:14.520262 #8841]  INFO -- : another-payload: stopped gracefully.
+I, [2023-12-14T18:48:15.524617 #8841]  INFO -- : test payload: stopped gracefully.
+All payloads did stop their execution gracefully.
+```
+
+## Work in progress
+
+* at the moment, only `every` is accepted. Cron formulas could one day be an option but its implementation is more complex.

data/lib/seijaku/executors/ssh.rb

@@ -6,12 +6,19 @@ require "net/ssh/proxy/jump"
 module Seijaku
   # SSHExecutor connects to SSH host and runs command
   class SSHExecutor
-    def initialize(raw, variables, task, ssh_hosts)
-      @command = ["sh", "-c", "'#{raw}'"]
+    def initialize(raw, variables, task, ssh_hosts, ssh_settings)
       @hosts = ssh_hosts
-      @variables = variables
+      @variables = variables.map do |key, value|
+        "#{key}='#{value}'"
+      end.join(" ")
+
+      @command = ["#{@variables};", "#{raw}"]
       @task = task
       @ssh_hosts = ssh_hosts
+      @ssh_settings = ssh_settings.transform_keys(&:to_sym)
+      if @ssh_settings[:verify_host_key].eql?("never")
+        @ssh_settings[:verify_host_key] = :never
+      end
 
       raise SSHExecutorError, "no ssh host defined in payload", [] if ssh_hosts.nil?
     end
@@ -20,12 +27,15 @@ module Seijaku
       machine = @ssh_hosts.hosts[@task.host]
       result = { command: @command.join(" "), stdout: nil, stderr: nil }
       status = {}
-      options = machine.bastion ? { proxy: bastion_setup } : {}
-      ssh = Net::SSH.start(machine.host, machine.user, port: machine.port, **options)
+      options = machine.bastion ? { proxy: bastion_setup, **@ssh_settings } : @ssh_settings
+
+      ssh = Net::SSH.start(machine.host, machine.user, {port: machine.port, **@ssh_settings})
+
       ssh.exec!(@command.join(" "), status: status) do |_ch, stream, data|
         result[:stdout] = data.chomp if stream == :stdout
         result[:stderr] = data.chomp unless stream == :stdout
       end
+
       ssh.close
 
       result[:exit_status] = status[:exit_code]

data/lib/seijaku/payload.rb

@@ -4,12 +4,15 @@ module Seijaku
   # Payload refers to the payload YAML file submitted by the user.
   # it includes tasks, steps, variables and name.
   class Payload
+    attr_reader :name
+
     def initialize(payload, logger)
-      @name = payload.fetch("name")
-      @variables = get_variables(payload.fetch("variables"))
-      @ssh_hosts = SSHGroup.new(payload.fetch("ssh", []))
-      @tasks = payload.fetch("tasks").map do |task|
-        Task.new(task, @variables, logger, @ssh_hosts)
+      @name = payload.fetch(:name)
+      @variables = get_variables(payload.fetch(:variables))
+      @ssh_hosts = SSHGroup.new(payload.fetch(:ssh, []))
+      @ssh_settings = payload.fetch(:ssh_settings, {})
+      @tasks = payload.fetch(:tasks).map do |task|
+        Task.new(task, @variables, logger, @ssh_hosts, @ssh_settings)
       end
     end
 

data/lib/seijaku/scheduler.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Seijaku
+  class Scheduler
+    def initialize(scheduler, logger)
+      @name = scheduler.fetch("name", nil)
+      @logger = logger
+      @scheduler_executors = scheduler.fetch("payloads", []).map do |payload_spec|
+        payload = File.read(payload_spec["payload"]).then do |data|
+          YAML.safe_load(data).then do |data|
+            Payload.new(data, logger)
+          end
+        end
+
+        SchedulerExecutor.new(payload, payload_spec, logger)
+      end
+    end
+
+    def monitor!
+      thd = []
+      @scheduler_executors.each do |scheduler_executor|
+        @logger.info "scheduling... #{scheduler_executor.name}"
+        thd << Thread.new do
+          scheduler_executor.execute!
+        end
+      end
+
+      thd.each &:join
+    end
+
+    def soft_exit!
+      @logger.info "Soft exit asked by user, waiting for payloads to stop naturally..."
+      thd = []
+      @scheduler_executors.each do |scheduler_executor|
+        thd << Thread.new do
+          scheduler_executor.status = :exiting
+          while scheduler_executor.status != :exited
+            @logger.info "#{scheduler_executor.name}: still waiting..."
+            sleep 1
+          end
+
+          @logger.info "#{scheduler_executor.name}: stopped gracefully"
+        end
+      end
+      thd.each &:join
+    end
+  end
+end

data/lib/seijaku/scheduler_executor.rb

@@ -0,0 +1,31 @@
+module Seijaku
+  class SchedulerExecutor
+    attr_reader :name
+    attr_accessor :status
+
+    def initialize(payload_obj, scheduler_spec, logger)
+      @name = scheduler_spec.fetch("name", nil)
+      @every = scheduler_spec.fetch("every", nil)
+      @payload_file = scheduler_spec.fetch("payload")
+
+      @logger = logger
+      @payload = payload_obj
+      @status = :awaiting
+    end
+
+    def execute!
+      while @status != :exiting do
+        @logger.info "[SCHEDULER] <<- starting execution: #{@name}"
+
+        @status = :started
+        @payload.execute!
+        @status = :awaiting
+
+        @logger.info "[SCHEDULER] <<- finished execution: #{@name} (#{@every}s)"
+        sleep @every
+      end
+
+      @status = :exited
+    end
+  end
+end

data/lib/seijaku/ssh/group.rb

@@ -8,7 +8,7 @@ module Seijaku
     def initialize(ssh_group)
       @hosts = {}
       ssh_group.each do |host|
-        @hosts[host["host"]] = Host.new(host)
+        @hosts[host[:host]] = Host.new(host)
       end
     end
   end

data/lib/seijaku/ssh/host.rb

@@ -6,10 +6,10 @@ module Seijaku
     attr_reader :host, :port, :user, :bastion
 
     def initialize(host)
-      @host = host.fetch("host", "localhost")
-      @port = host.fetch("port", 22)
-      @bastion = host.fetch("bastion", nil)
-      @user = host.fetch("user", "root")
+      @host = host.fetch(:host, "localhost")
+      @port = host.fetch(:port, 22)
+      @bastion = host.fetch(:bastion, nil)
+      @user = host.fetch(:user, "root")
     end
   end
 end

data/lib/seijaku/step.rb

@@ -6,17 +6,18 @@ module Seijaku
   class Step
     attr_reader :command, :pipeline
 
-    def initialize(step, variables, pipeline, logger, task, ssh_hosts = nil)
-      @sh = step.fetch("sh", nil)
-      @bash = step.fetch("bash", nil)
-      @ssh = step.fetch("ssh", nil)
-      @soft_fail = step.fetch("soft_fail", false)
-      @output = step.fetch("output", false)
+    def initialize(step, variables, pipeline, logger, task, ssh_hosts = nil, ssh_settings = {})
+      @sh = step.fetch(:sh, nil)
+      @bash = step.fetch(:bash, nil)
+      @ssh = step.fetch(:ssh, nil)
+      @soft_fail = step.fetch(:soft_fail, false)
+      @output = step.fetch(:output, false)
       @variables = variables
       @pipeline = pipeline
       @logger = logger
       @task = task
       @ssh_hosts = ssh_hosts
+      @ssh_settings = ssh_settings
 
       @command = (@sh || @bash) || @ssh
     end
@@ -24,7 +25,7 @@ module Seijaku
     def execute!
       result = SHExecutor.new(@sh, @variables).run! if @sh
       result = BashExecutor.new(@bash, @variables).run! if @bash
-      result = SSHExecutor.new(@ssh, @variables, @task, @ssh_hosts).run!
+      result = SSHExecutor.new(@ssh, @variables, @task, @ssh_hosts, @ssh_settings).run!
 
       if result[:exit_status] != 0
         logger_output(result)

data/lib/seijaku/task.rb

@@ -5,12 +5,12 @@ module Seijaku
   class Task
     attr_reader :host
 
-    def initialize(task, variables, logger, ssh_hosts = nil)
-      @name = task.fetch("name", nil)
-      @host = task.fetch("host", nil)
-      @steps = task.fetch("steps", []).map { |step| Step.new(step, variables, :steps, logger, self, ssh_hosts) }
-      @pre_steps = task.fetch("pre", []).map { |step| Step.new(step, variables, :pre, logger, self, ssh_hosts) }
-      @post_steps = task.fetch("post", []).map { |step| Step.new(step, variables, :post, logger, self, ssh_hosts) }
+    def initialize(task, variables, logger, ssh_hosts = nil, ssh_settings = {})
+      @name = task.fetch(:name, nil)
+      @host = task.fetch(:host, nil)
+      @steps = task.fetch(:steps, []).map { |step| Step.new(step, variables, :steps, logger, self, ssh_hosts, ssh_settings) }
+      @pre_steps = task.fetch(:pre, []).map { |step| Step.new(step, variables, :pre, logger, self, ssh_hosts, ssh_settings) }
+      @post_steps = task.fetch(:post, []).map { |step| Step.new(step, variables, :post, logger, self, ssh_hosts, ssh_settings) }
       @logger = logger
 
       raise TaskError, "no name set in task", [] if @name.nil?

data/lib/seijaku/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Seijaku
-  VERSION = "0.2.0"
+  VERSION = "0.4.0"
 end

data/lib/seijaku.rb

@@ -12,6 +12,9 @@ require_relative "seijaku/executors/sh"
 require_relative "seijaku/executors/bash"
 require_relative "seijaku/executors/ssh"
 
+require_relative "seijaku/scheduler"
+require_relative "seijaku/scheduler_executor"
+
 module Seijaku
   class Error < StandardError; end
   class VariableError < Error; end

data/sig/seijaku.rbs

@@ -1,4 +1,15 @@
 module Seijaku
   VERSION: String
   # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  class Error < StandardError
+  end
+
+  class TaskError < Error
+  end
+
+  class VariableError < Error
+  end
+
+  class SSHExecutorError < Error
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: seijaku
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Kohlrabbit
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-12 00:00:00.000000000 Z
+date: 2024-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bcrypt_pbkdf
@@ -71,11 +71,14 @@ files:
 - docs/1 - basic.md
 - docs/2 - variables.md
 - docs/3 - ssh.md
+- docs/4 - scheduler.md
 - lib/seijaku.rb
 - lib/seijaku/executors/bash.rb
 - lib/seijaku/executors/sh.rb
 - lib/seijaku/executors/ssh.rb
 - lib/seijaku/payload.rb
+- lib/seijaku/scheduler.rb
+- lib/seijaku/scheduler_executor.rb
 - lib/seijaku/ssh/group.rb
 - lib/seijaku/ssh/host.rb
 - lib/seijaku/step.rb