chutzen 0.8.4 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa53613b2fb5208ae0f7824b9617cde550535abaa2306e05d862cad1ae147b2b
-  data.tar.gz: 5c4b6dd163b1097a14a49d2b39bb94322c1378089784d8b3d8e589d0523d5404
+  metadata.gz: d5150871b332694272fd6cd676916cc8b710c13e7f4f47cdfd717b0b5517a398
+  data.tar.gz: b47c1877522ef2082e3d507a03c735a817906cd751da307aaa94bf81ae678972
 SHA512:
-  metadata.gz: 3195bbf164332b41112fde4ba6a0d88cfcde0cab7adf278daf64d1197bd30f70529af1630fa3fa7e9cc889f99b10bee3253f8ce98bc6ac42cfc2c9ecbeab5e26
-  data.tar.gz: f871912fa5c9df6eb51124c4a457f9e7e20dd6609e0558ed52505ff8f81f09236c7f8bbb194e1d4319ef3375c221b31025417747b92f375c72a37938911f715d
+  metadata.gz: 56cbd867e92a2f6bd9e0cc3ce366e84099f7f5f82b1a46f3126c578692c1af764ccecb96156e93fa893975e6e3aad46d34f3c729166da53939faa9fe9525c5ec
+  data.tar.gz: a597dfd4348eddf963d3e815fdb6734a6f545a9c01180524cfff41593fd0e18cdea5f1de0bf5170fc9d3e854c793e81181bff526611e3d523c19066450b0e239

data/README.md

@@ -242,3 +242,39 @@ That is why a `Chutzen::Signal` worker will, by default, only process within 30
     Chutzen::Signal.
       set(queue: 'chutzen-5-test').
       perform_async('stop', (Time.now + 10).to_i)
+
+## Mocking
+
+Chutzen descriptions can get relatively complex and you may want to use a mock to test logic. You can do this by mocking commands:
+
+    Chutzen.mocked(
+      'ls' => lamda do
+        # Generally you only access stdout and stderr from mocks and return
+        # the exit status code.
+        stdout.puts("app test")
+        0
+      end,
+      'unknown' => lambda do
+        # The mock uses the basepath of the executed path to look up the
+        # Proc. So /path/to/unknown becomes unknown. Use the 127 exit status
+        # to simulate a missing binary.
+        127
+      end,
+      # The value returned from the Proc is cast to an integer, so this is
+      # zero.
+      'zero' => -> {},
+      # You have full access to the Chutzen::Command internals, but these
+      # mocks may break when internals change.
+      'hack' => lambda do 
+        @dictionary['width'] = '201'
+      	0
+      end,
+    ) do
+      # Any command executed in the same process/thread will now use the mocked
+      # commands instead of using Open3 to execute it.
+      Command.new(
+      	{ "execute" => "ls" },
+        dictionary:,
+        work_path:
+      ).perform
+    end

data/lib/chutzen/command.rb

@@ -58,11 +58,19 @@ module Chutzen
     def perform
       return if skip?
 
-      result = @execute ? perform_command : self
+      result = @execute ? perform_command_or_mock : self
       merge_remember_into_dictionary
       result
     end
 
+    def perform_command_or_mock
+      if Chutzen.mock
+        perform_mock
+      else
+        perform_command
+      end
+    end
+
     def perform_command
       trace_execution do
         # We use the STOP signal to instruct Sidekiq to stop reading from the queue and the TERM
@@ -87,6 +95,13 @@ module Chutzen
       end
     end
 
+    def perform_mock
+      @exit_status = ExitStatus.new(Chutzen.mock.perform(self).to_i)
+      verify_exit_status
+      merge_output_into_dictionary
+      self
+    end
+
     # Returns the result expressed by the result section but with its variables
     # instantiated.
     def result

data/lib/chutzen/dictionary.rb

@@ -82,7 +82,7 @@ module Chutzen
       else
         data.each do |name, value|
           path = search(value, key)
-          return (path << name) if path
+          return path << name if path
         end
         nil
       end
@@ -91,7 +91,7 @@ module Chutzen
     def self.search_array(data, key)
       data.each.with_index do |item, index|
         path = search(item, key)
-        return (path << index) if path
+        return path << index if path
       end
       nil
     end

data/lib/chutzen/exit_status.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'parslet'
+
+module Chutzen
+  # Used to mock an exit status normally provided by executing something through Open3.
+  ExitStatus = Data.define(:status) do
+    def to_i
+      status.to_i
+    end
+
+    def success?
+      status.zero?
+    end
+  end
+end

data/lib/chutzen/mock.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Chutzen
+  # Keeps mocked commands and executes Command instances against them.
+  class Mock
+    attr_reader :mocks
+
+    def initialize(mocks)
+      @mocks = mocks
+    end
+
+    def perform(command)
+      name = File.basename(command.to_s.split(' ', 2).first.to_s)
+      command.instance_exec(&mocks.fetch(name))
+    end
+  end
+end

data/lib/chutzen/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Chutzen
-  VERSION = '0.8.4'
+  VERSION = '0.9.0'
 end

data/lib/chutzen.rb

@@ -9,10 +9,12 @@ module Chutzen
   autoload :Command, 'chutzen/command'
   autoload :Demux, 'chutzen/demux'
   autoload :Dictionary, 'chutzen/dictionary'
+  autoload :ExitStatus, 'chutzen/exit_status'
   autoload :Expression, 'chutzen/expression'
   autoload :ExpressionParser, 'chutzen/expression_parser'
   autoload :FailWhen, 'chutzen/fail_when'
   autoload :Job, 'chutzen/job'
+  autoload :Mock, 'chutzen/mock'
   autoload :Notification, 'chutzen/notification'
   autoload :RuntimeError, 'chutzen/runtime_error'
   autoload :Shell, 'chutzen/shell'
@@ -24,9 +26,10 @@ module Chutzen
   autoload :Worker, 'chutzen/worker'
 
   class << self
-    attr_accessor :sidekiq_queue
+    attr_accessor :sidekiq_queue, :mock
   end
   self.sidekiq_queue = 'chutzen'
+  self.mock = nil
 
   # Enqueue a Sidekiq job that will eventually perform the job in the
   # description.
@@ -90,4 +93,12 @@ module Chutzen
     expires_in ||= 30
     (Time.now + expires_in).to_i
   end
+
+  # Sets the global mock instance for the duration of the block.
+  def self.mocked(**)
+    self.mock = Chutzen::Mock.new(**)
+    yield
+  ensure
+    self.mock = nil
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chutzen
 version: !ruby/object:Gem::Version
-  version: 0.8.4
+  version: 0.9.0
 platform: ruby
 authors:
 - Manfred Stienstra
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-06 00:00:00.000000000 Z
+date: 2026-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parslet
@@ -81,12 +81,14 @@ files:
 - lib/chutzen/command/execution_failed.rb
 - lib/chutzen/demux.rb
 - lib/chutzen/dictionary.rb
+- lib/chutzen/exit_status.rb
 - lib/chutzen/expression.rb
 - lib/chutzen/expression/lookup_error.rb
 - lib/chutzen/expression/syntax_error.rb
 - lib/chutzen/expression_parser.rb
 - lib/chutzen/fail_when.rb
 - lib/chutzen/job.rb
+- lib/chutzen/mock.rb
 - lib/chutzen/notification.rb
 - lib/chutzen/runtime_error.rb
 - lib/chutzen/shell.rb
@@ -108,7 +110,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.1'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="