producer-core 0.2.5 → 0.2.6

data/features/support/env_aruba_timeout.rb

@@ -0,0 +1,3 @@
+Before do
+  @aruba_timeout_seconds = 8
+end

data/features/{tasks/condition.feature → task_condition.feature}

@@ -3,7 +3,7 @@ Feature: `condition' task keyword
   Scenario: prevents task actions application when condition is not met
     Given a recipe with:
       """
-      task :hello do
+      task :some_task do
         condition { false }
 
         echo 'evaluated'

data/features/{tests/dir.feature → test_dir.feature}

@@ -6,7 +6,7 @@ Feature: `dir?' condition keyword
       """
       target 'some_host.test'
 
-      task :testing_directory_existence do
+      task :dir_test do
         condition { dir? 'some_directory' }
 
         echo 'evaluated'

data/features/{tests/env.feature → test_env.feature}

@@ -1,58 +1,48 @@
 @sshd
 Feature: `env?' condition keyword
 
-  Scenario: succeeds when remote environment variable is defined
+  Background:
     Given a recipe with:
       """
       target 'some_host.test'
 
-      task :testing_env_var_definition do
+      task :env_test_definition_ok do
         condition { env? :shell }
 
-        echo 'evaluated'
+        echo 'definition_ok'
       end
-      """
-    When I successfully execute the recipe
-    Then the output must contain "evaluated"
 
-  Scenario: fails when remote environment variable is not defined
-    Given a recipe with:
-      """
-      target 'some_host.test'
-
-      task :testing_env_var_definition do
+      task :env_test_definition_ko do
         condition { env? :non_existent_var }
 
-        echo 'evaluated'
+        echo 'definition_ko'
       end
-      """
-    When I successfully execute the recipe
-    Then the output must not contain "evaluated"
-
-  Scenario: succeeds when remote environment variable value match
-    Given a recipe with:
-      """
-      target 'some_host.test'
 
-      task :testing_env_var_value do
+      task :env_test_value do
         condition { env? :shell, '/bin/sh' }
 
-        echo 'evaluated'
+        echo 'value_ok'
       end
-      """
-    When I successfully execute the recipe
-    Then the output must contain "evaluated"
 
-  Scenario: fails when remote environment variable value does not match
-    Given a recipe with:
-      """
-      target 'some_host.test'
-
-      task :testing_env_var_value do
+      task :env_test_value do
         condition { env? :shell, 'non_existent_shell' }
 
-        echo 'evaluated'
+        echo 'value_ko'
       end
       """
+
+  Scenario: succeeds when remote environment variable is defined
+    When I successfully execute the recipe
+    Then the output must contain "definition_ok"
+
+  Scenario: fails when remote environment variable is not defined
+    When I successfully execute the recipe
+    Then the output must not contain "definition_ko"
+
+  Scenario: succeeds when remote environment variable value match
+    When I successfully execute the recipe
+    Then the output must contain "value_ok"
+
+  Scenario: fails when remote environment variable value does not match
     When I successfully execute the recipe
-    Then the output must not contain "evaluated"
+    Then the output must not contain "value_ko"

data/features/{tests/executable.feature → test_executable.feature}

@@ -1,30 +1,28 @@
 @sshd
 Feature: `executable?' condition keyword
 
-  Scenario: succeeds when remote executable is available
+  Background:
     Given a recipe with:
       """
       target 'some_host.test'
 
-      task :testing_executable_availability do
+      task :executable_test_ok do
         condition { executable? 'true' }
 
-        echo 'evaluated'
+        echo 'test_ok'
       end
-      """
-    When I successfully execute the recipe
-    Then the output must contain "evaluated"
-
-  Scenario: succeeds when remote executable is available
-    Given a recipe with:
-      """
-      target 'some_host.test'
 
-      task :testing_executable_availability do
+      task :executable_test_ok do
         condition { executable? 'some_non_existent_executable' }
 
-        echo 'evaluated'
+        echo 'test_ko'
       end
       """
+
+  Scenario: succeeds when remote executable is available
+    When I successfully execute the recipe
+    Then the output must contain "test_ok"
+
+  Scenario: fails when remote executable is not available
     When I successfully execute the recipe
-    Then the output must not contain "evaluated"
+    Then the output must not contain "test_ko"

data/features/{tests/file.feature → test_file.feature}

@@ -6,7 +6,7 @@ Feature: `file?' condition keyword
       """
       target 'some_host.test'
 
-      task :testing_file_existence do
+      task :file_test do
         condition { file? 'some_file' }
 
         echo 'evaluated'

data/features/{tests/file_contains.feature → test_file_contains.feature}

@@ -6,7 +6,7 @@ Feature: `file_contains' condition keyword
       """
       target 'some_host.test'
 
-      task :testing_content_in_file_presense do
+      task :file_contains_test do
         condition { file_contains 'some_file', 'some_content' }
 
         echo 'evaluated'

data/features/test_shell_command_status.feature

@@ -0,0 +1,48 @@
+@sshd
+Feature: `sh' and `` condition keyword
+
+  Background:
+    Given a recipe with:
+      """
+      target 'some_host.test'
+
+      task :sh_test_ok do
+        condition { sh 'true' }
+
+        echo 'test_ok'
+      end
+
+      task :sh_test_ko do
+        condition { sh 'false' }
+
+        echo 'test_ko'
+      end
+
+      task :sh_test_backtick_ok do
+        condition { `true` }
+
+        echo 'test_backtick_ok'
+      end
+
+      task :sh_test_backtick_ko do
+        condition { `false` }
+
+        echo 'test_backtick_ko'
+      end
+      """
+
+  Scenario: succeeds when remote command execution is a success
+    When I successfully execute the recipe
+    Then the output must contain "test_ok"
+
+  Scenario: fails when remote executable is not available
+    When I successfully execute the recipe
+    Then the output must not contain "test_ko"
+
+  Scenario: `` alias, succeeds when remote executable is available
+    When I successfully execute the recipe
+    Then the output must contain "test_backtick_ok"
+
+  Scenario: `` alias, fails when remote executable is not available
+    When I successfully execute the recipe
+    Then the output must not contain "test_backtick_ko"

data/lib/producer/core/cli.rb

@@ -3,36 +3,41 @@ module Producer
     class CLI
       ArgumentError = Class.new(::ArgumentError)
 
-      USAGE = "Usage: #{File.basename $0} [-v] [-n] recipe_file"
+      USAGE = "Usage: #{File.basename $0} [-v] [-n] recipe_file".freeze
 
-      EX_USAGE = 64
+      EX_USAGE    = 64
+      EX_SOFTWARE = 70
 
       class << self
-        def run!(arguments, output: $stderr)
+        def run!(arguments, stdin: $stdin, stdout: $stdout, stderr: $stderr)
+          cli = new(arguments, stdin: stdin, stdout: stdout, stderr: stderr)
           begin
-            cli = new(arguments)
             cli.parse_arguments!
+            cli.run
           rescue ArgumentError
-            output.puts USAGE
+            stderr.puts USAGE
             exit EX_USAGE
+          rescue RuntimeError => e
+            stderr.puts "#{e.class.name.split('::').last}: #{e.message}"
+            exit EX_SOFTWARE
           end
-          cli.run
         end
       end
 
-      attr_reader :arguments, :stdout, :env, :recipe
+      attr_reader :arguments, :stdin, :stdout, :stderr, :env
 
-      def initialize(args, stdout: $stdout)
+      def initialize(args, stdin: $stdin, stdout: $stdout, stderr: $stderr)
         @arguments  = args
+        @stdin      = stdin
         @stdout     = stdout
-        @env        = Env.new(output: stdout)
+        @env        = Env.new(input: stdin, output: stdout)
       end
 
       def parse_arguments!
         @arguments = arguments.inject([]) do |m, e|
           case e
           when '-v'
-            env.log_level = Logger::INFO
+            env.verbose = true
           when '-n'
             env.dry_run = true
           else
@@ -44,16 +49,15 @@ module Producer
         raise ArgumentError unless arguments.any?
       end
 
-      def run(worker: build_worker)
-        load_recipe
-        worker.process recipe.tasks
+      def run
+        worker.process load_recipe.tasks
       end
 
       def load_recipe
-        @recipe = Recipe.evaluate_from_file(@arguments.first, env)
+        Recipe.evaluate_from_file(@arguments.first, env)
       end
 
-      def build_worker
+      def worker
         Worker.new(env)
       end
     end

data/lib/producer/core/condition/dsl.rb

@@ -3,12 +3,21 @@ module Producer
     class Condition
       class DSL
         class << self
-          def define_test(keyword, klass)
-            define_method(keyword) do |*args|
-              @tests << klass.new(@env, *args)
-            end
-            define_method("no_#{keyword}") do |*args|
-              @tests << klass.new(@env, *args, negated: true)
+          def define_test(keyword, test)
+            {
+              keyword         => false,
+              "no_#{keyword}" => true
+            }.each do |kw, negated|
+              define_method(kw) do |*args|
+                if test.respond_to? :call
+                  args  = [test, *args]
+                  klass = Tests::ConditionTest
+                else
+                  klass = test
+                end
+                t = klass.new(@env, *args, negated: negated)
+                @tests << t
+              end
             end
           end
         end
@@ -29,8 +38,8 @@ module Producer
           @tests  = []
         end
 
-        def evaluate
-          instance_eval &@block
+        def evaluate(*args)
+          instance_exec *args, &@block
         end
       end
     end

data/lib/producer/core/condition.rb

@@ -2,9 +2,9 @@ module Producer
   module Core
     class Condition
       class << self
-        def evaluate(env, &block)
+        def evaluate(env, *args, &block)
           dsl = DSL.new(env, &block)
-          return_value = dsl.evaluate
+          return_value = dsl.evaluate *args
           Condition.new(dsl.tests, return_value)
         end
       end

data/lib/producer/core/env.rb

@@ -2,14 +2,14 @@ module Producer
   module Core
     class Env
       attr_reader   :input, :output, :registry, :logger
-      attr_accessor :target, :dry_run
+      attr_accessor :target, :verbose, :dry_run
 
       def initialize(input: $stdin, output: $stdout, remote: nil, registry: {})
+        @verbose  = @dry_run = false
         @input    = input
         @output   = output
-        @registry = registry
         @remote   = remote
-        @dry_run  = false
+        @registry = registry
       end
 
       def remote
@@ -27,7 +27,7 @@ module Producer
       def logger
         @logger ||= begin
           logger = Logger.new(output)
-          logger.level = Logger::ERROR
+          logger.level = verbose? ? Logger::INFO : Logger::ERROR
           logger.formatter = LoggerFormatter.new
           logger
         end
@@ -37,12 +37,8 @@ module Producer
         logger.info message
       end
 
-      def log_level
-        logger.level
-      end
-
-      def log_level=(level)
-        logger.level = level
+      def verbose?
+        @verbose
       end
 
       def dry_run?

data/lib/producer/core/errors.rb

@@ -1,7 +1,8 @@
 module Producer
   module Core
     Error                       = Class.new(StandardError)
+    RuntimeError                = Class.new(RuntimeError)
     ConditionNotMetError        = Class.new(Error)
-    RemoteCommandExecutionError = Class.new(Error)
+    RemoteCommandExecutionError = Class.new(RuntimeError)
   end
 end

data/lib/producer/core/recipe/dsl.rb

@@ -38,6 +38,10 @@ module Producer
           end
         end
 
+        def test_macro(name, dsl: Condition::DSL, &block)
+          dsl.define_test(name, block)
+        end
+
         def set(key, value)
           env[key] = value
         end

data/lib/producer/core/remote.rb

@@ -32,7 +32,7 @@ module Producer
 
             ch.on_request 'exit-status' do |c, data|
               exit_status = data.read_long
-              raise RemoteCommandExecutionError if exit_status != 0
+              raise RemoteCommandExecutionError, command if exit_status != 0
             end
           end
         end

data/lib/producer/core/tests/condition_test.rb

@@ -0,0 +1,23 @@
+module Producer
+  module Core
+    module Tests
+      class ConditionTest < Test
+        def verify
+          condition.met?
+        end
+
+        def condition
+          Condition.evaluate(env, *condition_args, &condition_block)
+        end
+
+        def condition_args
+          arguments.drop 1
+        end
+
+        def condition_block
+          arguments.first
+        end
+      end
+    end
+  end
+end