producer-core 0.1.0

data/.gitignore

@@ -0,0 +1,3 @@
+/Gemfile-custom.rb
+/Gemfile.lock
+/tmp/

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+
+eval File.read('Gemfile-custom.rb') if File.exist?('Gemfile-custom.rb')

data/Guardfile

@@ -0,0 +1,11 @@
+guard :cucumber, cli: '--format pretty --quiet' do
+  watch(%r{\Afeatures/.+\.feature\z})
+  watch(%r{\Afeatures/support/.+\.rb\z})                { 'features' }
+  watch(%r{\Afeatures/step_definitions/.+_steps\.rb\z}) { 'features' }
+end
+
+guard :rspec do
+  watch(%r{\Aspec/.+_spec\.rb\z})
+  watch(%r{\Alib/(.+)\.rb\z})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')    { 'spec' }
+end

data/LICENSE

@@ -0,0 +1,30 @@
+Copyright 2013 Thibault Jouan. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+  * Redistributions of source code must retain the above copyright
+    notice, this list of conditions and the following disclaimer.
+
+  * Redistributions in binary form must reproduce the above copyright
+    notice, this list of conditions and the following disclaimer in
+    the documentation and/or other materials provided with the
+    distribution.
+
+  * Neither the name of the software nor the names of its contributors
+    may be used to endorse or promote products derived from this
+    software without specific prior written permission.
+
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS
+BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
+BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
+IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/Rakefile

@@ -0,0 +1,13 @@
+require 'cucumber/rake/task'
+require 'rspec/core/rake_task'
+
+desc 'Run all scenarios'
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = '--tags ~@sshd'
+end
+
+desc 'Run all specs'
+RSpec::Core::RakeTask.new(:spec)
+
+
+task default: [:features, :spec]

data/bin/producer

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'producer/core'
+
+Producer::Core::CLI.new(ARGV).run!

data/features/actions/echo.feature

@@ -0,0 +1,12 @@
+Feature: `echo' task action
+
+  Scenario: ouputs text
+    Given a recipe with:
+      """
+      task :some_task do
+        echo 'hello'
+      end
+      """
+    When I execute the recipe
+    Then the exit status must be 0
+    And the output must contain exactly "hello\n"

data/features/actions/sh.feature

@@ -0,0 +1,39 @@
+@sshd
+Feature: sh task action
+
+  Scenario: executes command
+    Given a recipe with:
+      """
+      target 'some_host.test'
+
+      task :some_task do
+        sh '\true'
+      end
+      """
+    When I execute the recipe
+    Then the exit status must be 0
+
+  Scenario: forwards standard ouput
+    Given a recipe with:
+      """
+      target 'some_host.test'
+
+      task :some_task do
+        sh '\echo from remote'
+      end
+      """
+    When I execute the recipe
+    Then the output must contain "from remote"
+
+  Scenario: aborts on failed command execution
+    Given a recipe with:
+      """
+      target 'some_host.test'
+
+      task :some_task do
+        sh '\false'
+        sh '\echo after_fail'
+      end
+      """
+    When I execute the recipe
+    Then the output must not contain "after_fail"

data/features/cli/usage.feature

@@ -0,0 +1,9 @@
+Feature: CLI usage
+
+  Scenario: prints the usage when an argument is missing
+    When I run `producer`
+    Then the exit status must be 64
+    And the output must contain exactly:
+      """
+      Usage: producer recipe_file
+      """

data/features/recipes/env.feature

@@ -0,0 +1,9 @@
+Feature: `env' recipe keyword
+
+  Scenario: exposes the internal env object
+    Given a recipe with:
+      """
+      env
+      """
+    When I execute the recipe
+    Then the exit status must be 0

data/features/recipes/evaluation.feature

@@ -0,0 +1,10 @@
+Feature: recipe evaluation
+
+  Scenario: evaluates ruby code in a recipe
+    Given a recipe with:
+      """
+      puts 'hello from recipe'
+      """
+    When I execute the recipe
+    Then the exit status must be 0
+    And the output must contain exactly "hello from recipe\n"

data/features/recipes/source.feature

@@ -0,0 +1,16 @@
+Feature: `source' recipe keyword
+
+  Background:
+    Given a recipe with:
+      """
+      source 'sourced_recipe'
+      """
+
+  Scenario: requires a recipe file
+    Given a file named "sourced_recipe.rb" with:
+      """
+      puts 'sourced recipe'
+      """
+    When I execute the recipe
+    Then the exit status must be 0
+    And the output must contain "sourced recipe"

data/features/recipes/target.feature

@@ -0,0 +1,12 @@
+Feature: `target' recipe keyword
+
+  Scenario: registers the target host on which tasks should be applied
+    Given a recipe with:
+      """
+      target 'some_host.example'
+
+      puts env.target
+      """
+    When I execute the recipe
+    Then the exit status must be 0
+    And the output must contain exactly "some_host.example\n"

data/features/steps/recipe_steps.rb

@@ -0,0 +1,7 @@
+Given(/^a recipe with:$/) do |recipe_body|
+  write_file 'recipe.rb', recipe_body
+end
+
+When(/^I execute the recipe$/) do
+  run_simple('producer recipe.rb', false)
+end

data/features/support/env_aruba.rb

@@ -0,0 +1,16 @@
+module Cucumber
+  class Runtime
+    alias :old_step_match :step_match
+
+    def step_match(step_name, name_to_report = nil)
+      if step_name.include? ' must '
+        name_to_report = step_name.dup
+        step_name.gsub! ' must ', ' should '
+      end
+
+      old_step_match(step_name, name_to_report)
+    end
+  end
+end
+
+require 'aruba/cucumber'

data/features/support/env_cucumber-doc_string.rb

@@ -0,0 +1,23 @@
+require 'cucumber/formatter/pretty'
+
+module Cucumber
+  module Ast
+    class DocString
+      alias :old_initialize :initialize
+
+      def initialize(string, content_type)
+        old_initialize(string + "\n", content_type)
+      end
+    end
+  end
+
+  module Formatter
+    class Pretty
+      alias :old_doc_string :doc_string
+
+      def doc_string(string)
+        old_doc_string(string.chomp)
+      end
+    end
+  end
+end

data/features/support/ssh.rb

@@ -0,0 +1,106 @@
+# FIXME: should be extracted as a separate gem `cucumber-sshd?'.
+class SSHServer
+  include Aruba::Api
+
+  DEFAULT_LISTEN_PORT = 2222
+  KEY_PATH            = 'etc/ssh_host_rsa_key'
+  KEY_PUB_PATH        = KEY_PATH.dup << '.pub'
+  SSHD_CONFIG_PATH    = 'etc/sshd_config'
+  SSH_CONFIG_PATH     = '.ssh/config'
+
+  attr_accessor :listen_port
+
+  def initialize(base_path)
+    @base_path    = base_path
+    @listen_port  = ENV['PRODUCER_TEST_SSHD_PORT'] ?
+      ENV['PRODUCER_TEST_SSHD_PORT'] :
+      DEFAULT_LISTEN_PORT
+  end
+
+  def start
+    in_current_dir do
+      @pid = fork do
+        $stderr.reopen '/dev/null'
+        exec "/usr/sbin/sshd -f etc/sshd_config -Deq"
+      end
+    end
+  end
+
+  def stop
+    Process.kill('TERM', @pid)
+    Process.wait(@pid)
+  end
+
+  def make_env
+    %w[etc .ssh].map { |e| create_dir e }
+
+    write_file KEY_PATH, <<-eoh
+-----BEGIN RSA PRIVATE KEY-----
+MIIEpAIBAAKCAQEA7EVDKeM7NYCGGVJw0wWLGCoptMFSR7DobhbEx2bAQbWDLFBF
+7S9bXpW/ddebFA4GBkHVriNPwu/IGjIgO3tivVcy6iguNKdYRABlSfpeAs+OdCzK
+hyEWhmKnFMZs2MhPiJg/KUep2gFZLoEcs9vkk37+cLcuUVkXVOSPXlYCuHjgkwaN
+9ij/KvCcLP4tw83H3Pyh1Wn/Y4k1+3nWN2S3RgRHF9RjEx7nm2FmXcZq1wygPe5G
+2bQNvZKykL+wlKIHwKiM4AWpVClczOiljNv9KROhGWanIZNNBIDTnikxFvY0FyoP
+1qvRrE8BlqxNeyG/vYNmXsv8xpO0MOF65z3d2QIDAQABAoIBAHL8dmZxX0R3i0vR
+knUwsnQNOQTuPPQFBelmDViaCiEwjGlJm+6F6KrMqERarO+Cr63l5m98YfoWJkWR
+dZxdPT22rWHGMk6PzuYxZxoszgoCJ2skzWAcW1EFvBjhROHwAr0Qk1Ssut4NX/DB
+B04FS2X5HS2QCOuwNymqnpejtmk+A2hv9bGVzj0X614gX3h5+0dImGrYE0Lu+Abf
+5fvWhN5nxgK5CVlU7WM09WxyHj9lBXI+W2dgTl6w3QJfBBQTkarLmDpwIeErq9xc
+al2qHj60nYC+RdFopuLfJWKiObdKRFpuPFYKbTA9nJz9T61zAF+LaDZ1mvdTuQmz
+jJEJ0nECgYEA+o2uJcDOCD2LBp2LqeQcGk1PrFLpSQ5921B10SxDWhygs2+UlBCW
+7t/qurqjEUZ91l3TAlUM7ViB/EkXk/xWJRJCzlmWRXfht9LPQTWlnDox/w8uSV2g
+3VwPx1xpju2PHO7Vsk6dsQsyoro14qNhYa9m1lBHA1TtJ/RLWauvnmUCgYEA8WgZ
+MthPXi/clDg2DlROGOEWd7WgaErEz578HWnegcMrHb8RV/XW21CO2UegHykzUlxz
+vJxAqhQeKJbP7T8uzuCZnkZqBqPh5PJT1XqxZibTeQvqYLzbIiKqmDrZWuRJvbLL
+kPxwYEG8R8nl9Dk1tLHuTQWWa5Q49he1cDss4GUCgYEA7WMBRZnIW3xb1Xe9VMjg
+a3cmbqHbj7FgQ0OXbQigA6euBnRIdITHTCnxDtw4Fe0Q2uLoQoRsjA/YkDx8T2S8
+BcGodDPjMYxk2rKsVR9L+poUtpEejLpd6H0KIhwHkzi26HXNGHRt6ckvP4hn94RO
+hqwWJiXHMnvrenh2T85fxRUCgYEA7m06NhWejhAHc/zwpsZtO/VUE3e3rknqiIUl
+zIc71D3G3+JOZunQA1xVOhSb+SrgHYBibu6Ej3a/MqeBRXkZ6gm6r7AsF9LU0SLl
+2fsMKzA9vVgfbNwaMmS6yQ+WjUbb7hghJlmtQ+So6N5n2AaJHKaADmJuZmJGwAg6
+k1ZexGECgYAFc+GjjFOPxC+Qg6z8261PnDffBK0o+0/EIq3cGA7Cp5pEo/hhMjDl
+W7CLjAGkok9W+rr9XwwXWCBuJmPh2jYeNaQljrHt9hIAOAxoYdbweb9oSo5SkcHv
+iDjcFK8S1e5vnlZAh9xH1WMCEsaz1WNqWm7CZOayN2LFn6Ed9seYYg==
+-----END RSA PRIVATE KEY-----
+    eoh
+
+    write_file KEY_PUB_PATH, <<-eoh
+ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDsRUMp4zs1gIYZUnDTBYsYKim0wVJHsOhuFsTHZsBBtYMsUEXtL1telb9115sUDgYGQdWuI0/C78gaMiA7e2K9VzLqKC40p1hEAGVJ+l4Cz450LMqHIRaGYqcUxmzYyE+ImD8pR6naAVkugRyz2+STfv5wty5RWRdU5I9eVgK4eOCTBo32KP8q8Jws/i3Dzcfc/KHVaf9jiTX7edY3ZLdGBEcX1GMTHuebYWZdxmrXDKA97kbZtA29krKQv7CUogfAqIzgBalUKVzM6KWM2/0pE6EZZqchk00EgNOeKTEW9jQXKg/Wq9GsTwGWrE17Ib+9g2Zey/zGk7Qw4XrnPd3Z
+    eoh
+
+    write_file SSHD_CONFIG_PATH, <<-eoh
+Port #{listen_port}
+ListenAddress ::1
+
+Protocol 2
+HostKey #{File.expand_path @base_path}/#{KEY_PATH}
+PidFile /dev/null
+UsePrivilegeSeparation no
+ForceCommand HOME=#{File.expand_path @base_path} sh -c "cd ~; $SSH_ORIGINAL_COMMAND"
+    eoh
+
+    write_file SSH_CONFIG_PATH, <<-eoh
+Host          some_host.test
+  HostName    localhost
+  Port        #{listen_port}
+    eoh
+  end
+end
+
+
+Before('@sshd') do
+  @_sshd = SSHServer.new(current_dir)
+  @_sshd.make_env
+  @_sshd.start
+
+  ENV['HOME'] = File.expand_path current_dir
+
+  # FIXME: we might need to wait until sshd accepts connections, polling isn't
+  # really acceptable, another workaround might be to execute sshd with
+  # LD_PRELOAD and a hook, so we could block here until the hook release the
+  # blocking call.
+end
+
+After('@sshd') do
+  @_sshd.stop
+end

data/features/tasks/condition.feature

@@ -0,0 +1,14 @@
+Feature: `condition' task keyword
+
+  Scenario: prevents task actions application when condition is not met
+    Given a recipe with:
+      """
+      task :hello do
+        condition { false }
+
+        echo 'evaluated'
+      end
+      """
+    When I execute the recipe
+    Then the exit status must be 0
+    And the output must not contain "evaluated"

data/features/tasks/evaluation.feature

@@ -0,0 +1,12 @@
+Feature: task evaluation
+
+  Scenario: evaluates ruby code in task blocks
+    Given a recipe with:
+      """
+      task :hello do
+        puts 'hello from recipe'
+      end
+      """
+    When I execute the recipe
+    Then the exit status must be 0
+    And the output must contain exactly "hello from recipe\n"

data/features/tests/has_env.feature

@@ -0,0 +1,32 @@
+@sshd
+Feature: `has_env' condition keyword
+
+  Scenario: succeeds when remote environment variable is defined
+    Given a recipe with:
+      """
+      target 'some_host.test'
+
+      task :testing_env_var_definition do
+        condition { has_env :shell }
+
+        echo 'evaluated'
+      end
+      """
+    When I execute the recipe
+    Then the exit status must be 0
+    And 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
+        condition { has_env :inexistent_var }
+
+        echo 'evaluated'
+      end
+      """
+    When I execute the recipe
+    Then the exit status must be 0
+    And the output must not contain "evaluated"

data/lib/producer/core/action.rb

@@ -0,0 +1,12 @@
+module Producer
+  module Core
+    class Action
+      attr_accessor :env, :arguments
+
+      def initialize(env, *args)
+        @env        = env
+        @arguments  = args
+      end
+    end
+  end
+end

data/lib/producer/core/actions/echo.rb

@@ -0,0 +1,11 @@
+module Producer
+  module Core
+    module Actions
+      class Echo < Action
+        def apply
+          env.output arguments.first
+        end
+      end
+    end
+  end
+end

data/lib/producer/core/actions/shell_command.rb

@@ -0,0 +1,11 @@
+module Producer
+  module Core
+    module Actions
+      class ShellCommand < Action
+        def apply
+          env.output env.remote.execute(arguments.first)
+        end
+      end
+    end
+  end
+end

data/lib/producer/core/cli.rb

@@ -0,0 +1,43 @@
+module Producer
+  module Core
+    class CLI
+      attr_reader :arguments
+
+      USAGE = "Usage: #{File.basename $0} recipe_file"
+
+      def initialize(arguments, stdout = $stdout)
+        @stdout     = stdout
+        @arguments  = arguments
+      end
+
+      def run!
+        check_arguments!
+        interpreter.process recipe.tasks
+      end
+
+      def check_arguments!
+        print_usage_and_exit(64) unless @arguments.length == 1
+      end
+
+      def env
+        @env ||= Env.new
+      end
+
+      def recipe
+        @recipe ||= Recipe.evaluate_from_file(@arguments.first, env)
+      end
+
+      def interpreter
+        @interpreter ||= Interpreter.new
+      end
+
+      private
+
+      def print_usage_and_exit(status)
+        @stdout.puts USAGE
+
+        exit status
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+module Producer
+  module Core
+    class Condition
+      class DSL
+        class << self
+          def evaluate(env, &block)
+            dsl = new(env, &block)
+            return_value = dsl.evaluate
+            Condition.new(dsl.tests, return_value)
+          end
+
+          def define_test(keyword, klass)
+            define_method(keyword) do |*args|
+              @tests << klass.new(@env, *args)
+            end
+          end
+        end
+
+        define_test :has_env, Tests::HasEnv
+
+        attr_accessor :tests
+
+        def initialize(env, &block)
+          @env    = env
+          @block  = block
+          @tests  = []
+        end
+
+        def evaluate
+          instance_eval &@block
+        end
+      end
+    end
+  end
+end

data/lib/producer/core/condition.rb

@@ -0,0 +1,26 @@
+module Producer
+  module Core
+    class Condition
+      class << self
+        def evaluate(env, &block)
+          DSL.evaluate(env, &block)
+        end
+      end
+
+      def initialize(tests, return_value = nil)
+        @tests        = tests
+        @return_value = return_value
+      end
+
+      def met?
+        return !!@return_value if @tests.empty?
+        @tests.each { |t| return false unless t.success? }
+        true
+      end
+
+      def !
+        !met?
+      end
+    end
+  end
+end

data/lib/producer/core/env.rb

@@ -0,0 +1,21 @@
+module Producer
+  module Core
+    class Env
+      attr_writer   :output
+      attr_accessor :target
+
+      def initialize
+        @output = $stdout
+        @target = nil
+      end
+
+      def output(str)
+        @output.puts str
+      end
+
+      def remote
+        @remote ||= Remote.new(target)
+      end
+    end
+  end
+end

data/lib/producer/core/errors.rb

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

data/lib/producer/core/interpreter.rb

@@ -0,0 +1,13 @@
+module Producer
+  module Core
+    class Interpreter
+      def process(tasks)
+        tasks.each { |t| process_task t }
+      end
+
+      def process_task(task)
+        task.actions.each(&:apply) if task.condition_met?
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+module Producer
+  module Core
+    class Recipe
+      class DSL
+        attr_reader :tasks
+
+        def self.evaluate(code, env)
+          dsl = new(code).evaluate(env)
+          Recipe.new(dsl.tasks)
+        end
+
+        def initialize(code = nil, &block)
+          @code   = code
+          @block  = block
+          @tasks  = []
+        end
+
+        def evaluate(env)
+          @env = env
+          if @code
+            instance_eval @code
+          else
+            instance_eval &@block
+          end
+          self
+        end
+
+        private
+
+        def env
+          @env
+        end
+
+        def source(filepath)
+          instance_eval File.read("./#{filepath}.rb"), "#{filepath}.rb"
+        end
+
+        def target(hostname)
+          env.target = hostname
+        end
+
+        def task(name, &block)
+          @tasks << Task.evaluate(name, env, &block)
+        end
+      end
+    end
+  end
+end

data/lib/producer/core/recipe.rb

@@ -0,0 +1,15 @@
+module Producer
+  module Core
+    class Recipe
+      attr_accessor :tasks
+
+      def self.evaluate_from_file(filepath, env)
+        DSL.evaluate(File.read(filepath), env)
+      end
+
+      def initialize(tasks = [])
+        @tasks = tasks
+      end
+    end
+  end
+end