producer-core 0.5.11 → 0.5.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 36585c1613648e9e3c47084767dbc1d4acb341a4
-  data.tar.gz: cb961db67e6034e2224cc999ef2c3f27f5502170
+  metadata.gz: a59bbda268d60668c1b0bff8dc1f37eefc3a834d
+  data.tar.gz: 830f6e8ba0a452024d905679e3536f359476767b
 SHA512:
-  metadata.gz: 3e6ed9ca8c684ae00da66d69471f5524e4aad33c4d0016be19cb46374eefb82bb5e15c089663869ec4c15a0b744e63ae146f0ec7b4e695050547f7635c16eb0e
-  data.tar.gz: 2bb9d2a0c8599b2c869c6fedc291d931411ca9d63670e1dbe6ba0c4110baa96904da302bc323dcbdb25469b60a6f9fe7fa55f9c3cb0d1902e1c369931f3b23e4
+  metadata.gz: 37113fab68f768445a648eb0c299aec71b07ec3f1be756195ce96dc711a62cb70759f29cbd9ae86f4fc7e1f4deccd4df5594e7ca585310656c7e279d1bd159fc
+  data.tar.gz: 30ffac8b310c4a41ed49c97611f8eacab87401a59e02d7a54d72dc51beb5eaaaedb1abbede07c79f4a6822674e29579e09e79924b52cd709261754302368b3df

data/README.md

@@ -227,109 +227,6 @@ design and usage of Domain Specific Languages in Ruby, and refactor
 all my scripts as "recipes" in a common language.
 
 
-Sample recipe
--------------
-
-  Based on the previous template example (FreeBSD jails.conf
-template):
-
-```ruby
-require 'producer/stdlib'
-
-JAILS_ROOT  = '/var/jails'.freeze
-ZROOT       = 'tank/jails'.freeze
-INTERFACE   = 're0'.freeze
-SETS        = {
-  base: '2b028a894d25711ad496762622a52d74b1e32ee04693ad1cf056e3ddcdc23975',
-  src:  'f919287a5ef51d4f133f27c99c54f2e8054f408d3dd53bc60f4e233cc75ec03d'
-}.freeze
-JAILS       = [
-  {
-    name:   'freebsd-10r1',
-    src:    true,
-    addr4:  '10.0.0.1'
-  },
-  {
-    name:   'freebsd-10r1-gcc',
-    src:    true,
-    addr4:  '10.0.0.2'
-  }
-].freeze
-
-task :freebsd_archives_fetch do
-  SETS.keys.each { |set| condition { no_file? "/tmp/#{set}.txz"} }
-
-  SETS.each do |set, sum|
-    sh <<-eoh
-      cd /tmp && \
-      fetch ftp://ftp.freebsd.org:/pub/FreeBSD/releases/amd64/10.1-RELEASE/#{set}.txz && \
-      sha256 -c #{sum} #{set}.txz
-    eoh
-  end
-end
-
-task :jails_fs_create do
-  condition { no_sh "zfs list #{ZROOT}" }
-  sh "zfs create -o mountpoint=#{JAILS_ROOT} -o compress=lz4 #{ZROOT}"
-end
-
-JAILS.each do |jail|
-  root  = "#{JAILS_ROOT}/#{jail[:name]}"
-  fs    = "#{ZROOT}/#{jail[:name]}"
-
-  task :jail_initialize do
-    condition { no_sh "zfs list #{fs}@install" }
-
-    task :jail_fs_create do
-      condition { no_sh "zfs list #{fs}" }
-
-      sh "zfs create #{fs}"
-
-      SETS.keys.each do |set|
-        next if set == 'src' && !jail[:src]
-        sh "tar -JxC #{root}/ -f /tmp/#{set}.txz"
-      end
-    end
-
-    task :rc_conf do
-      file_write_once "#{root}/etc/rc.conf", <<-eoh
-hostname=#{jail[:name]}
-# ...
-      eoh
-    end
-
-    task :root_passwd do
-      sh "chroot #{root} pw user mod root -w random"
-    end
-
-    task :mail_aliases do
-      condition { no_file? "#{root}/etc/mail/aliases.db" }
-
-      sh "chroot #{root} make -C /etc/mail aliases"
-    end
-
-    freebsd_update_patch_interactive "#{root}/usr/sbin/freebsd-update"
-
-    task :jail_snapshot_install do
-       sh "zfs snapshot #{fs}@install"
-    end
-  end
-
-  task :jail_update do
-    condition { no_sh "zfs list #{fs}@update" }
-
-    sh "chroot #{root} freebsd-update fetch install"
-    sh "zfs snapshot #{fs}@update"
-  end
-end
-
-task :jails_conf do
-  conf = template 'freebsd/jail.conf', if: INTERFACE, jails: JAILS
-  file_write_once '/etc/jail.conf', conf
-end
-```
-
-
 Similar or related code and tools
 ---------------------------------
 

data/lib/producer/core/action.rb

@@ -1,7 +1,7 @@
 module Producer
   module Core
     class Action
-      INSPECT_ARGUMENTS_SUM_LEN = 68.freeze
+      INSPECT_ARGUMENTS_SUM_LEN = 68
 
       extend Forwardable
       def_delegators :@env, :input, :output, :error_output, :remote
@@ -34,6 +34,12 @@ module Producer
         return if arguments.compact.size == size
         fail ArgumentError, '`%s\' action requires %d arguments' % [name, size]
       end
+
+      def convert_options conversions
+        conversions.each do |original, convertion|
+          options[convertion] = options.delete original if options.key? original
+        end
+      end
     end
   end
 end

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

@@ -4,9 +4,8 @@ module Producer
       class FileWriter < Action
         def setup
           check_arguments_size! arguments_size
-          @path, @content         = arguments
-          @options[:permissions]  = @options.delete :mode if options.key? :mode
-          @options[:owner]        = @options.delete :user if options.key? :user
+          @path, @content = arguments
+          convert_options mode: :permissions, user: :owner
         end
 
         def name
@@ -15,7 +14,7 @@ module Producer
 
         def apply
           fs.file_write @path, @content
-          fs.setstat @path, @options unless @options.empty?
+          fs.setstat @path, options unless options.empty?
         end
 
       private

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

@@ -5,8 +5,7 @@ module Producer
         def setup
           check_arguments_size! 1
           @path = Pathname.new(arguments.first)
-          @options[:permissions]  = @options.delete :mode if @options.key? :mode
-          @options[:owner]        = @options.delete :user if @options.key? :user
+          convert_options mode: :permissions, user: :owner
         end
 
         def name
@@ -17,7 +16,7 @@ module Producer
           @path.descend do |path|
             next if fs.dir? path
             fs.mkdir path.to_s
-            fs.setstat path.to_s, @options unless @options.empty?
+            fs.setstat path.to_s, options unless options.empty?
           end
         end
       end

data/lib/producer/core/cli.rb

@@ -25,11 +25,7 @@ module Producer
           stderr.puts e.message
           exit EX_USAGE
         rescue StandardError => e
-          ef = ErrorFormatter.new(
-            debug:        cli.env.debug?,
-            force_cause:  [RecipeEvaluationError]
-          )
-          stderr.puts ef.format e
+          stderr.puts ErrorFormatter.new(debug: cli.env.debug?).format e
           exit EX_SOFTWARE
         end
       end

data/lib/producer/core/condition.rb

@@ -3,20 +3,8 @@ module Producer
     class Condition
       class << self
         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
-              @tests << klass.new(@env, *args, negated: negated)
-            end
-          end
+          declare_test_method keyword, test
+          declare_test_method "no_#{keyword}", test, negated: true
         end
 
         def evaluate env, *args, &block
@@ -26,6 +14,20 @@ module Producer
             o.instance_eval { @return_value = return_value }
           end
         end
+
+      private
+
+        def declare_test_method keyword, test, negated: false
+          define_method keyword do |*args|
+            if test.respond_to? :call
+              args.unshift test
+              klass = Tests::ConditionTest
+            else
+              klass = test
+            end
+            @tests << klass.new(@env, *args, negated: negated)
+          end
+        end
       end
 
       extend Forwardable

data/lib/producer/core/error_formatter.rb

@@ -8,9 +8,8 @@ module Producer
         /\/net-sftp/
       ].freeze
 
-      def initialize debug: false, force_cause: []
-        @debug        = debug
-        @force_cause  = force_cause
+      def initialize debug: false
+        @debug = debug
       end
 
       def debug?

data/lib/producer/core/errors.rb

@@ -9,5 +9,6 @@ module Producer
     RemoteCommandExecutionError = Class.new(RuntimeError)
     RegistryKeyError            = Class.new(RuntimeError)
     RemoteInvalidError          = Class.new(ArgumentError)
+    TemplateMissingError        = Class.new(RuntimeError)
   end
 end

data/lib/producer/core/remote/fs.rb

@@ -33,7 +33,7 @@ module Producer
         end
 
         def file_read path
-          sftp.file.open(path) { |f| f.read }
+          sftp.file.open path, &:read
         rescue Net::SFTP::StatusException
           nil
         end

data/lib/producer/core/remote.rb

@@ -10,10 +10,7 @@ module Producer
 
       def session
         @session ||= begin
-          if !@hostname
-            fail RemoteInvalidError,
-              "remote target is invalid: `#{@hostname.inspect}'"
-          end
+          check_hostname!
           Net::SSH.start(@hostname, user_name)
         end
       end
@@ -57,6 +54,14 @@ module Producer
       def cleanup
         session.close if @session
       end
+
+    private
+
+      def check_hostname!
+        return if @hostname
+        fail RemoteInvalidError,
+          "remote target is invalid: `#{@hostname.inspect}'"
+      end
     end
   end
 end

data/lib/producer/core/template/erb_renderer.rb

@@ -0,0 +1,26 @@
+module Producer
+  module Core
+    class Template
+      class ERBRenderer
+        class << self
+          def render file_path, variables = {}
+            tpl = ERB.new(File.read(file_path), nil, '-')
+            tpl.filename = file_path.to_s
+            tpl.result build_erb_binding variables
+          end
+
+        protected
+
+          def build_erb_binding variables
+            Object.new.instance_eval do |o|
+              variables.each do |k, v|
+                o.instance_variable_set "@#{k}", v
+              end
+              binding
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/producer/core/template/yaml_renderer.rb

@@ -0,0 +1,13 @@
+module Producer
+  module Core
+    class Template
+      class YAMLRenderer
+        class << self
+          def render file_path, *_
+            YAML.load(File.read(file_path))
+          end
+        end
+      end
+    end
+  end
+end

data/lib/producer/core/template.rb

@@ -2,50 +2,38 @@ module Producer
   module Core
     class Template
       SEARCH_PATH = 'templates'.freeze
+      RENDERERS   = {
+        ERBRenderer   => %i[erb],
+        YAMLRenderer  => %i[yaml]
+      }.freeze
 
-      def initialize path, search_path: SEARCH_PATH
+      def initialize path, search_path: SEARCH_PATH, renderers: RENDERERS
         @path         = Pathname.new(path)
         @search_path  = Pathname.new(search_path)
+        @renderers    = renderers
       end
 
       def render variables = {}
-        case (file_path = resolve_path).extname
-          when '.yaml'  then render_yaml file_path
-          when '.erb'   then render_erb file_path, variables
+        candidates.each do |c|
+          r, * = @renderers.find { |_, v| v.include? c.extname[1..-1].to_sym }
+          return r.render c, variables if r
         end
-      end
-
-    private
 
-      def render_erb file_path, variables = {}
-        tpl = ERB.new(File.read(file_path), nil, '-')
-        tpl.filename = file_path.to_s
-        tpl.result build_erb_binding variables
+        fail TemplateMissingError, "template `#{@path}' not found"
       end
 
-      def render_yaml file_path
-        YAML.load(File.read(file_path))
-      end
+    protected
 
-      def resolve_path
+      def candidates
         if @path.to_s =~ /\A\.\//
-          resolve_suffix @path
+          glob_candidates_by_prefix @path
         else
-          resolve_suffix @search_path + @path
+          glob_candidates_by_prefix @search_path + @path
         end
       end
 
-      def resolve_suffix path
-        Pathname.glob("#{path}.{erb,yaml}").first
-      end
-
-      def build_erb_binding variables
-        Object.new.instance_eval do |o|
-          variables.each do |k, v|
-            o.instance_variable_set "@#{k}", v
-          end
-          binding
-        end
+      def glob_candidates_by_prefix path_prefix
+        Pathname.glob(path_prefix.to_s + ?*)
       end
     end
   end

data/lib/producer/core/test.rb

@@ -20,6 +20,10 @@ module Producer
       def pass?
         verify ^ negated?
       end
+
+      def verify
+        fail NotImplementedError
+      end
     end
   end
 end

data/lib/producer/core/testing/cucumber.rb

@@ -29,6 +29,7 @@ end
 # Enable cucumber-sshd "fast" mode (persists sshd across scenarios), and
 # register hooks for @sshd tagged scenarios.
 Before do
-  @_sshd_fast = true
+  @_sshd_fast       = true
+  @_sshd_wait_ready = true if ENV.key? 'TRAVIS'
 end
 require 'cucumber/sshd/cucumber'

data/lib/producer/core/version.rb

@@ -1,5 +1,5 @@
 module Producer
   module Core
-    VERSION = '0.5.11'.freeze
+    VERSION = '0.5.12'.freeze
   end
 end

data/lib/producer/core.rb

@@ -45,6 +45,8 @@ require 'producer/core/remote'
 require 'producer/core/remote/environment'
 require 'producer/core/remote/fs'
 require 'producer/core/task'
+require 'producer/core/template/erb_renderer'
+require 'producer/core/template/yaml_renderer'
 require 'producer/core/template'
 require 'producer/core/version'
 require 'producer/core/worker'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: producer-core
 version: !ruby/object:Gem::Version
-  version: 0.5.11
+  version: 0.5.12
 platform: ruby
 authors:
 - Thibault Jouan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-14 00:00:00.000000000 Z
+date: 2015-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh
@@ -45,6 +45,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -52,6 +55,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
@@ -149,6 +155,8 @@ files:
 - lib/producer/core/remote/fs.rb
 - lib/producer/core/task.rb
 - lib/producer/core/template.rb
+- lib/producer/core/template/erb_renderer.rb
+- lib/producer/core/template/yaml_renderer.rb
 - lib/producer/core/test.rb
 - lib/producer/core/testing.rb
 - lib/producer/core/testing/aruba_program_wrapper.rb
@@ -192,8 +200,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Provisioning tool
 test_files: []
+has_rdoc: