itamae 1.10.0 → 1.12.5

data/lib/itamae/mash.rb

@@ -0,0 +1,7 @@
+require 'hashie'
+
+module Itamae
+  class Mash < Hashie::Mash
+    disable_warnings
+  end
+end

data/lib/itamae/node.rb

@@ -1,7 +1,7 @@
-require 'itamae'
 require 'hashie'
 require 'json'
 require 'schash'
+require 'itamae/mash'
 
 module Itamae
   class Node
@@ -10,7 +10,7 @@ module Itamae
     attr_reader :mash
 
     def initialize(hash, backend)
-      @mash = Hashie::Mash.new(hash)
+      @mash = Itamae::Mash.new(hash)
       @backend = backend
     end
 
@@ -43,7 +43,7 @@ module Itamae
     private
 
     def _reverse_merge(other_hash)
-      Hashie::Mash.new(other_hash).merge(@mash)
+      Itamae::Mash.new(other_hash).merge(@mash)
     end
 
     def method_missing(method, *args)
@@ -63,7 +63,7 @@ module Itamae
     def fetch_inventory_value(key)
       value = @backend.host_inventory[key]
       if value.is_a?(Hash)
-        value = Hashie::Mash.new(value)
+        value = Itamae::Mash.new(value)
       end
 
       value

data/lib/itamae/notification.rb

@@ -1,5 +1,3 @@
-require 'itamae'
-
 module Itamae
   class Notification < Struct.new(:defined_in_resource, :action, :target_resource_desc, :timing)
     def self.create(*args)

data/lib/itamae/recipe.rb

@@ -1,5 +1,3 @@
-require 'itamae'
-
 module Itamae
   class Recipe
     NotFoundError = Class.new(StandardError)
@@ -55,7 +53,7 @@ module Itamae
 
     def load(vars = {})
       context = EvalContext.new(self, vars)
-      context.instance_eval(File.read(path), path, 1)
+      InstanceEval.new(File.read(path), path, 1, context: context).call
     end
 
     def run
@@ -153,6 +151,25 @@ module Itamae
       end
     end
 
+    class InstanceEval
+      def initialize(src, path, lineno, context:)
+        # Using instance_eval + eval to allow top-level class/module definition without `::`.
+        # To pass args without introducing any local/instance variables, this code is also eval-ed.
+        @code = <<-RUBY
+          @context.instance_eval do
+            eval(#{src.dump}, nil, #{path.dump}, #{lineno})
+          end
+        RUBY
+        @context = context
+      end
+
+      # This method has no local variables to avoid spilling them to recipes.
+      def call
+        eval(@code)
+      end
+    end
+    private_constant :InstanceEval
+
     class RecipeFromDefinition < Recipe
       attr_accessor :definition
 

data/lib/itamae/resource/base.rb

@@ -1,4 +1,3 @@
-require 'itamae'
 require 'shellwords'
 require 'hashie'
 
@@ -16,7 +15,7 @@ module Itamae
         def initialize(resource)
           @resource = resource
 
-          @attributes = Hashie::Mash.new
+          @attributes = Itamae::Mash.new
           @notifications = []
           @subscriptions = []
           @verify_commands = []
@@ -196,6 +195,7 @@ module Itamae
             show_differences
 
             method_name = "action_#{action}"
+            Itamae.logger.debug "(in #{method_name})"
             if runner.dry_run?
               unless respond_to?(method_name)
                 Itamae.logger.error "action #{action.inspect} is unavailable"
@@ -222,7 +222,7 @@ module Itamae
       end
 
       def clear_current_attributes
-        @current_attributes = Hashie::Mash.new
+        @current_attributes = Itamae::Mash.new
       end
 
       def pre_action

data/lib/itamae/resource/directory.rb

@@ -1,5 +1,3 @@
-require 'itamae'
-
 module Itamae
   module Resource
     class Directory < Base

data/lib/itamae/resource/execute.rb

@@ -1,5 +1,3 @@
-require 'itamae'
-
 module Itamae
   module Resource
     class Execute < Base

data/lib/itamae/resource/file.rb

@@ -1,16 +1,19 @@
-require 'itamae'
-
 module Itamae
   module Resource
     class File < Base
       define_attribute :action, default: :create
       define_attribute :path, type: String, default_name: true
       define_attribute :content, type: String, default: nil
+      define_attribute :sensitive, default: false
       define_attribute :mode, type: String
       define_attribute :owner, type: String
       define_attribute :group, type: String
       define_attribute :block, type: Proc, default: proc {}
 
+      class << self
+        attr_accessor :sha256sum_available
+      end
+
       def pre_action
         current.exist = run_specinfra(:check_file_is_file, attributes.path)
 
@@ -29,6 +32,11 @@ module Itamae
           end
         end
 
+        if exists_and_not_modified?
+          attributes.modified = false
+          return
+        end
+
         send_tempfile
         compare_file
       end
@@ -135,10 +143,28 @@ module Itamae
         end
       end
 
+      def exists_and_not_modified?
+        return false unless current.exist && sha256sum_available?
+
+        current_digest = run_command(["sha256sum", attributes.path]).stdout.split(/\s/, 2).first
+        digest = if content_file
+          Digest::SHA256.file(content_file).hexdigest
+        else
+          Digest::SHA256.hexdigest(attributes.content.to_s)
+        end
+
+        current_digest == digest
+      end
+
       def show_content_diff
+        if attributes.sensitive
+          Itamae.logger.info("diff exists, but not displaying sensitive content")
+          return
+        end
+
         if attributes.modified
           Itamae.logger.info "diff:"
-          diff = run_command(["diff", "-u", compare_to, @temppath], error: false)
+          diff = run_command(["diff", "-u", "--label=#{attributes.path} (BEFORE)", compare_to, "--label=#{attributes.path} (AFTER)", @temppath], error: false)
           diff.stdout.each_line do |line|
             color = if line.start_with?('+')
                       :green
@@ -173,7 +199,12 @@ module Itamae
           src = if content_file
                   content_file
                 else
-                  f = Tempfile.open('itamae')
+                  f = 
+                    if Gem.win_platform?
+                      Tempfile.open('itamae', :mode=>IO::BINARY)
+                    else
+                      Tempfile.open('itamae')
+                    end
                   f.write(attributes.content)
                   f.close
                   f.path
@@ -183,12 +214,12 @@ module Itamae
 
           if backend.is_a?(Itamae::Backend::Docker)
             run_command(["mkdir", @temppath])
-            backend.send_file(src, @temppath)
+            backend.send_file(src, @temppath, user: attributes.user)
             @temppath = ::File.join(@temppath, ::File.basename(src))
           else
             run_command(["touch", @temppath])
             run_specinfra(:change_file_mode, @temppath, '0600')
-            backend.send_file(src, @temppath)
+            backend.send_file(src, @temppath, user: attributes.user)
           end
 
           run_specinfra(:change_file_mode, @temppath, '0600')
@@ -196,6 +227,12 @@ module Itamae
           f.unlink if f
         end
       end
+
+      def sha256sum_available?
+        return self.class.sha256sum_available unless self.class.sha256sum_available.nil?
+
+        self.class.sha256sum_available = run_command(["sha256sum", "--version"], error: false).exit_status == 0
+      end
     end
   end
 end

data/lib/itamae/resource/gem_package.rb

@@ -1,5 +1,3 @@
-require 'itamae'
-
 module Itamae
   module Resource
     class GemPackage < Base

data/lib/itamae/resource/git.rb

@@ -1,5 +1,3 @@
-require 'itamae'
-
 module Itamae
   module Resource
     class Git < Base
@@ -86,11 +84,11 @@ module Itamae
       end
 
       def get_revision(branch)
-        result = run_command_in_repo("git rev-list #{shell_escape(branch)}", error: false)
-        unless result.exit_status == 0
-          fetch_origin!
-        end
-        run_command_in_repo("git rev-list #{shell_escape(branch)}").stdout.lines.first.strip
+        result = run_command_in_repo("git rev-parse #{shell_escape(branch)}", error: false)
+        return result.stdout.strip if result.exit_status == 0
+
+        fetch_origin!
+        run_command_in_repo("git rev-parse #{shell_escape(branch)}").stdout.strip
       end
 
       def fetch_origin!

data/lib/itamae/resource/group.rb

@@ -1,5 +1,3 @@
-require 'itamae'
-
 module Itamae
   module Resource
     class Group < Base

data/lib/itamae/resource/http_request.rb

@@ -1,4 +1,3 @@
-require 'itamae'
 require 'uri'
 require 'net/https'
 
@@ -6,6 +5,9 @@ module Itamae
   module Resource
     class HttpRequest < File
       RedirectLimitExceeded = Class.new(StandardError)
+      HTTPClientError = Class.new(StandardError)
+      HTTPServerError = Class.new(StandardError)
+      HTTPUnknownError = Class.new(StandardError)
 
       alias_method :_action_create, :action_create
       undef_method :action_create, :action_delete, :action_edit
@@ -49,7 +51,10 @@ module Itamae
             response = http.method(attributes.action).call(uri.request_uri, attributes.message, attributes.headers)
           end
 
-          if response.kind_of?(Net::HTTPRedirection)
+          case response
+          when Net::HTTPSuccess
+            break
+          when Net::HTTPRedirection
             if redirects_followed < attributes.redirect_limit
               uri = URI.parse(response["location"])
               redirects_followed += 1
@@ -57,8 +62,12 @@ module Itamae
             else
               raise RedirectLimitExceeded
             end
+          when Net::HTTPClientError
+            raise HTTPClientError
+          when Net::HTTPServerError
+            raise HTTPServerError
           else
-            break
+            raise HTTPUnknownError
           end
         end
 

data/lib/itamae/resource/link.rb

@@ -1,5 +1,3 @@
-require 'itamae'
-
 module Itamae
   module Resource
     class Link < Base

data/lib/itamae/resource/local_ruby_block.rb

@@ -1,5 +1,3 @@
-require 'itamae'
-
 module Itamae
   module Resource
     class LocalRubyBlock < Base

data/lib/itamae/resource/package.rb

@@ -1,5 +1,3 @@
-require 'itamae'
-
 module Itamae
   module Resource
     class Package < Base
@@ -26,6 +24,8 @@ module Itamae
       end
 
       def action_install(action_options)
+        return if !attributes.version && current.installed
+
         unless run_specinfra(:check_package_is_installed, attributes.name, attributes.version)
           run_specinfra(:install_package, attributes.name, attributes.version, attributes.options)
           updated!
@@ -33,7 +33,7 @@ module Itamae
       end
 
       def action_remove(action_options)
-        if run_specinfra(:check_package_is_installed, attributes.name, nil)
+        if current.installed
           run_specinfra(:remove_package, attributes.name, attributes.options)
           updated!
         end

data/lib/itamae/resource/remote_directory.rb

@@ -1,5 +1,3 @@
-require 'itamae'
-
 module Itamae
   module Resource
     class RemoteDirectory < Base
@@ -41,7 +39,7 @@ module Itamae
         super
 
         if current.exist
-          diff = run_command(["diff", "-u", attributes.path, @temppath], error: false)
+          diff = run_command(["diff", "-u", "-r", attributes.path, @temppath], error: false)
           if diff.exit_status == 0
             # no change
             Itamae.logger.debug "directory content will not change"

data/lib/itamae/resource/remote_file.rb

@@ -1,5 +1,3 @@
-require 'itamae'
-
 module Itamae
   module Resource
     class RemoteFile < File

data/lib/itamae/resource/service.rb

@@ -1,5 +1,3 @@
-require 'itamae'
-
 module Itamae
   module Resource
     class Service < Base

data/lib/itamae/resource/template.rb

@@ -1,4 +1,3 @@
-require 'itamae'
 require 'erb'
 require 'tempfile'
 
@@ -38,9 +37,14 @@ module Itamae
 
         def render_file(src)
           template = ::File.read(src)
-          ERB.new(template, nil, '-').tap do |erb|
-            erb.filename = src
-          end.result(binding)
+          erb =
+            if ERB.instance_method(:initialize).parameters.assoc(:key) # Ruby 2.6+
+              ERB.new(template, trim_mode: '-')
+            else
+              ERB.new(template, nil, '-')
+            end
+          erb.filename = src
+          erb.result(binding)
         end
 
         def node

data/lib/itamae/resource/user.rb

@@ -1,5 +1,3 @@
-require 'itamae'
-
 module Itamae
   module Resource
     class User < Base

data/lib/itamae/resource.rb

@@ -1,4 +1,3 @@
-require 'itamae'
 require 'itamae/resource/base'
 require 'itamae/resource/file'
 require 'itamae/resource/package'

data/lib/itamae/runner.rb

@@ -1,4 +1,3 @@
-require 'itamae'
 require 'json'
 require 'yaml'
 
@@ -31,7 +30,7 @@ module Itamae
       prepare_handler
 
       @node = create_node
-      @tmpdir = "/tmp/itamae_tmp"
+      @tmpdir = options[:tmp_dir] || '/tmp/itamae_tmp'
       @children = RecipeChildren.new
       @diff = false
 
@@ -99,11 +98,11 @@ module Itamae
         unless @backend.run_command("which ohai", error: false).exit_status == 0
           # install Ohai
           Itamae.logger.info "Installing Chef package... (to use Ohai)"
-          @backend.run_command("curl -L https://www.opscode.com/chef/install.sh | bash")
+          @backend.run_command("curl -L https://omnitruck.chef.io/install.sh | bash")
         end
 
         Itamae.logger.info "Loading node data via ohai..."
-        hash.merge!(JSON.parse(@backend.run_command("ohai").stdout))
+        hash.merge!(JSON.parse(@backend.run_command("ohai 2>/dev/null").stdout))
       end
 
       if @options[:node_json]

data/lib/itamae/version.rb

@@ -1,3 +1,3 @@
 module Itamae
-  VERSION = "1.10.0"
+  VERSION = "1.12.5"
 end

data/lib/itamae.rb

@@ -1,6 +1,5 @@
 require "itamae/version"
 require "itamae/runner"
-require "itamae/cli"
 require "itamae/recipe"
 require "itamae/resource"
 require "itamae/handler"
@@ -13,6 +12,7 @@ require "itamae/notification"
 require "itamae/definition"
 require "itamae/ext"
 require "itamae/generators"
+require "itamae/mash"
 
 module Itamae
   # Your code goes here...

data/spec/integration/default_spec.rb

@@ -104,7 +104,7 @@ describe file('/tmp/http_request_headers.html') do
   its(:content) { should match(/"User-Agent":\s*"Itamae"/) }
 end
 
-describe file('/tmp/http_request_redirect.html') do
+xdescribe file('/tmp/http_request_redirect.html') do
   it { should be_file }
   its(:content) { should match(/"from":\s*"itamae"/) }
 end
@@ -119,34 +119,6 @@ describe file('/tmp/subscribes') do
   its(:content) { should eq("2431") }
 end
 
-describe file('/tmp/cron_stopped') do
-  it { should be_file }
-  its(:content) do
-    expect(subject.content.lines.size).to eq 1
-  end
-end
-
-# FIXME: cron service is not running in docker...
-#
-# root@3450c6da6ea5:/# ps -C cron
-#   PID TTY          TIME CMD
-# root@3450c6da6ea5:/# service cron start
-# Rather than invoking init scripts through /etc/init.d, use the service(8)
-# utility, e.g. service cron start
-#
-# Since the script you are attempting to invoke has been converted to an
-# Upstart job, you may also use the start(8) utility, e.g. start cron
-# root@3450c6da6ea5:/# ps -C cron
-#   PID TTY          TIME CMD
-# root@3450c6da6ea5:/#
-
-# describe file('/tmp/cron_running') do
-#   it { should be_file }
-#   its(:content) do
-#     expect(subject.content.lines.size).to eq 2
-#   end
-# end
-
 describe file('/tmp-link') do
   it { should be_linked_to '/tmp' }
   its(:content) do
@@ -206,15 +178,19 @@ describe command('gem list') do
 end
 
 describe command('gem list') do
-  its(:stdout) { should include('rake (11.1.0)') }
+  its(:stdout) { should match(/^rake \(.*11.1.0.*\)/) }
 end
 
 describe command('gem list') do
   its(:stdout) { should_not include('test-unit') }
 end
 
-describe command('ri Bundler') do
-  its(:stderr) { should eq("Nothing known about Bundler\n") }
+describe command('gem list') do
+  its(:stdout) { should include('ast (2.0.0)') }
+end
+
+describe command('ri AST') do
+  its(:stderr) { should eq("Nothing known about AST\n") }
 end
 
 describe file('/tmp/created_by_definition') do
@@ -357,3 +333,21 @@ describe file('/tmp/empty_file3') do
   it { should be_file }
   its(:content) { should eq "" }
 end
+
+describe file('/tmp/toplevel_module') do
+  it { should exist }
+  it { should be_file }
+  its(:content) { should eq "helper" }
+end
+
+describe file('/tmp/local_variables') do
+  it { should exist }
+  it { should be_file }
+  its(:content) { should eq "[]" }
+end
+
+describe file('/tmp/instance_variables') do
+  it { should exist }
+  it { should be_file }
+  its(:content) { should eq "[:@recipe]" } # backward compatibility
+end

data/spec/integration/docker_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe file('/tmp/cron_stopped') do
+  it { should be_file }
+  its(:content) do
+    expect(subject.content.lines.size).to eq 1
+  end
+end
+
+# FIXME: cron service is not running in docker...
+#
+# root@3450c6da6ea5:/# ps -C cron
+#   PID TTY          TIME CMD
+# root@3450c6da6ea5:/# service cron start
+# Rather than invoking init scripts through /etc/init.d, use the service(8)
+# utility, e.g. service cron start
+#
+# Since the script you are attempting to invoke has been converted to an
+# Upstart job, you may also use the start(8) utility, e.g. start cron
+# root@3450c6da6ea5:/# ps -C cron
+#   PID TTY          TIME CMD
+# root@3450c6da6ea5:/#
+
+# describe file('/tmp/cron_running') do
+#   it { should be_file }
+#   its(:content) do
+#     expect(subject.content.lines.size).to eq 2
+#   end
+# end

data/spec/integration/local_spec.rb

@@ -0,0 +1,6 @@
+describe file('/tmp/file_as_ordinary_user') do
+  it { should be_file }
+  it { should be_owned_by "itamae" }
+  it { should be_grouped_into "itamae" }
+end
+