itamae 1.6.3 → 1.7.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c517c9de5fc2f44be1ad04227c37925ccb82423d
-  data.tar.gz: 4dbd70a0f470a4f5cdad0e3e67aef8cf137ee860
+  metadata.gz: c693dfeb747bd80dffef33f292b26a2a8e075f81
+  data.tar.gz: b11be7c402d731d2444cf79600b63e82987b2c1f
 SHA512:
-  metadata.gz: b17b31eb7091de71bfd2f8fbd13e460a54d0592e3ff47a599fae0a31116834ef93dcef811997d14279825bd03a5af125aee994e44e73f2c310de7e27ebb6ab6c
-  data.tar.gz: c1a18658f08ea4c9e49e9c9883d33de00117256b33df6262472dde2cb9888f2853664e6a9a55a8ce9a3667d239e36fdd6585e44fe417cd6cc2f8defd4ce7b764
+  metadata.gz: 85df294c1e5860f42b81ddcff13ef64245504d65a063a0061ac72a513af4af3d5d0fe1d416b095d9b8cf11c12e67aa9a1f5dc5cba711e08c9427cdd9cde4223c
+  data.tar.gz: 11d1f27227fa148d113222f3bc03a14058edcdc071e93dcc5a026928aae06c78ab3e3a4160c08b4671e3636da53168572f9fe1f31186ba9a4a59d2d2b9e5277f

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## v1.6.4.pre
+
+Features
+
+- `--profile` option (experimental)
+  - `--profile PATH` saves executed commands to `PATH` in JSON format
+
+Bugfixes
+
+- [Suppress errors of `edit` action of `file` resource when the target file doesn't exist in `dry-run` mode](https://github.com/itamae-kitchen/itamae/pull/144)
+
 ## v1.6.3
 
 Features

data/Gemfile

@@ -3,6 +3,9 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in itamae.gemspec
 gemspec
 
+gem 'vagrant', github: 'mitchellh/vagrant'
+gem 'vagrant-digitalocean'
+
 path = Pathname.new("Gemfile.local")
 eval(path.read) if path.exist?
 
@@ -11,4 +14,3 @@ group :test do
     gem 'growl'
   end
 end
-

data/Rakefile

@@ -3,7 +3,7 @@ require 'rspec/core/rake_task'
 require 'tempfile'
 require 'net/ssh'
 
-vagrant_bin = ENV['CI'] ? 'vagrant' : '/usr/bin/vagrant'
+vagrant_bin = 'vagrant'
 
 desc 'Run unit and integration specs.'
 task :spec => ['spec:unit', 'spec:integration:all']
@@ -16,10 +16,13 @@ namespace :spec do
 
   namespace :integration do
     targets = []
-    Bundler.with_clean_env do
-      `cd spec/integration && #{vagrant_bin} status`.split("\n\n")[1].each_line do |line|
-        targets << line.match(/^[^ ]+/)[0]
-      end
+    status = `cd spec/integration && #{vagrant_bin} status`
+    unless $?.exitstatus == 0
+      raise "vagrant status failed.\n#{status}"
+    end
+
+    status.split("\n\n")[1].each_line do |line|
+      targets << line.match(/^[^ ]+/)[0]
     end
 
     task :all     => targets
@@ -30,27 +33,37 @@ namespace :spec do
 
       namespace :provision do
         task target do
-          Bundler.with_clean_env do
-            config = Tempfile.new('', Dir.tmpdir)
-            env = {"VAGRANT_CWD" => File.expand_path('./spec/integration')}
-            system env, "#{vagrant_bin} up #{target}"
-            system env, "#{vagrant_bin} ssh-config #{target} > #{config.path}"
-            options = Net::SSH::Config.for(target, [config.path])
+          config = Tempfile.new('', Dir.tmpdir)
+          env = {"VAGRANT_CWD" => File.expand_path('./spec/integration')}
+          system env, "#{vagrant_bin} up #{target}"
+          system env, "#{vagrant_bin} ssh-config #{target} > #{config.path}"
+          options = Net::SSH::Config.for(target, [config.path])
 
-            cmd = "bundle exec bin/itamae ssh"
-            cmd << " -h #{options[:host_name]}"
-            cmd << " -u #{options[:user]}"
-            cmd << " -p #{options[:port]}"
-            cmd << " -i #{options[:keys].first}"
-            cmd << " -l #{ENV['LOG_LEVEL'] || 'debug'}"
-            cmd << " -j spec/integration/recipes/node.json"
-            cmd << " spec/integration/recipes/default.rb"
-            cmd << " spec/integration/recipes/default2.rb"
-            cmd << " spec/integration/recipes/redefine.rb"
+          suites = [
+            [
+              "spec/integration/recipes/default.rb",
+              "spec/integration/recipes/default2.rb",
+              "spec/integration/recipes/redefine.rb",
+            ],
+            [
+              "--dry-run",
+              "spec/integration/recipes/dry_run.rb",
+            ],
+          ]
+          suites.each do |suite|
+            cmd = %w!bundle exec bin/itamae ssh!
+            cmd << "-h" << options[:host_name]
+            cmd << "-u" << options[:user]
+            cmd << "-p" << options[:port].to_s
+            cmd << "-i" << options[:keys].first
+            cmd << "-l" << (ENV['LOG_LEVEL'] || 'debug')
+            cmd << "-j" << "spec/integration/recipes/node.json"
+            cmd += suite
 
-            puts cmd
-            system cmd
-            abort unless $?.exitstatus == 0
+            p cmd
+            unless system(*cmd)
+              raise "#{cmd} failed"
+            end
           end
         end
       end
@@ -86,4 +99,3 @@ namespace :release do
     system "git commit -m 'Bump up version'"
   end
 end
-

data/lib/itamae/backend.rb

@@ -35,9 +35,12 @@ module Itamae
     end
 
     class Base
+      attr_reader :executed_commands
+      
       def initialize(options)
         @options = options
         @backend = create_specinfra_backend
+        @executed_commands = []
       end
 
       def run_command(commands, options = {})
@@ -50,7 +53,9 @@ module Itamae
 
         Itamae.logger.with_indent do
           reset_output_handler
-          result = @backend.run_command(command)
+
+          result = run_command_with_profiling(command)
+
           flush_output_handler_buffer
 
           if result.exit_status == 0 || !options[:error]
@@ -186,6 +191,16 @@ module Itamae
       def shell
         @options[:shell]
       end
+
+      def run_command_with_profiling(command)
+        start_at = Time.now
+        result = @backend.run_command(command)
+        duration = Time.now.to_f - start_at.to_f
+
+        @executed_commands << {command: command, duration: duration}
+
+        result
+      end
     end
 
     class Local < Base

data/lib/itamae/cli.rb

@@ -15,12 +15,13 @@ module Itamae
     end
 
     def self.define_exec_options
-      option :dot, type: :string, default: nil, desc: "Only write dependency graph in DOT", banner: "PATH"
+      option :dot, type: :string, default: nil, desc: "[EXPERIMENTAL] Only write dependency graph in DOT", banner: "PATH"
       option :node_json, type: :string, aliases: ['-j']
       option :node_yaml, type: :string, aliases: ['-y']
       option :dry_run, type: :boolean, aliases: ['-n']
       option :shell, type: :string, default: "/bin/sh"
-      option :ohai, type: :boolean, default: false, desc: "This option is DEPRECATED and will be inavailable."
+      option :ohai, type: :boolean, default: false, desc: "This option is DEPRECATED and will be unavailable."
+      option :profile, type: :string, desc: "[EXPERIMENTAL] Save profiling data", banner: "PATH"
     end
 
     desc "local RECIPE [RECIPE...]", "Run Itamae locally"

data/lib/itamae/notification.rb

@@ -10,8 +10,8 @@ module Itamae
       runner.children.find_resource_by_description(target_resource_desc)
     end
 
-    def run(options)
-      action_resource.run(action, options)
+    def run
+      action_resource.run(action)
     end
 
     def action_resource

data/lib/itamae/recipe.rb

@@ -58,24 +58,24 @@ module Itamae
       context.instance_eval(File.read(path), path, 1)
     end
 
-    def run(options = {})
+    def run
       show_banner
 
       Itamae.logger.with_indent do
-        @children.run(options)
-        run_delayed_notifications(options)
+        @children.run
+        run_delayed_notifications
       end
     end
 
     private
 
-    def run_delayed_notifications(options)
+    def run_delayed_notifications
       @delayed_notifications.uniq! do |notification|
         [notification.action, notification.action_resource]
       end
 
       while notification = @delayed_notifications.shift
-        notification.run(options)
+        notification.run
       end
     end
 

data/lib/itamae/recipe_children.rb

@@ -53,14 +53,9 @@ module Itamae
       end.flatten
     end
 
-    def run(options)
+    def run
       self.each do |resource|
-        case resource
-        when Resource::Base
-          resource.run(nil, dry_run: options[:dry_run])
-        when Recipe
-          resource.run(options)
-        end
+        resource.run
       end
     end
 

data/lib/itamae/resource/base.rb

@@ -120,7 +120,7 @@ module Itamae
         process_attributes
       end
 
-      def run(specific_action = nil, options = {})
+      def run(specific_action = nil)
         Itamae.logger.debug "#{resource_type}[#{resource_name}]"
 
         Itamae.logger.with_indent_if(Itamae.logger.debug?) do
@@ -133,11 +133,11 @@ module Itamae
           end
 
           [specific_action || attributes.action].flatten.each do |action|
-            run_action(action, options)
+            run_action(action)
           end
 
-          verify unless options[:dry_run]
-          notify(options) if updated?
+          verify unless runner.dry_run?
+          notify if updated?
         end
 
         @updated = false
@@ -146,7 +146,7 @@ module Itamae
         exit 2
       end
 
-      def action_nothing(options)
+      def action_nothing
         # do nothing
       end
 
@@ -166,7 +166,7 @@ module Itamae
 
       alias_method :current, :current_attributes
 
-      def run_action(action, options)
+      def run_action(action)
         original_attributes = @attributes # preserve and restore later
         @current_action = action
 
@@ -187,12 +187,18 @@ module Itamae
           show_differences
 
           method_name = "action_#{action}"
-          if options[:dry_run]
+          if runner.dry_run?
             unless respond_to?(method_name)
               Itamae.logger.error "action #{action.inspect} is unavailable"
             end
           else
-            public_send(method_name, options)
+            args = [method_name]
+            if method(method_name).arity == 1
+              # for plugin compatibility
+              args << runner.options
+            end
+
+            public_send(*args)
           end
 
           updated! if different?
@@ -327,7 +333,7 @@ module Itamae
         @updated
       end
 
-      def notify(options)
+      def notify
         (notifications + recipe.children.subscribing(self)).each do |notification|
           message = "Notifying #{notification.action} to #{notification.action_resource.resource_type} resource '#{notification.action_resource.resource_name}'"
 
@@ -346,7 +352,7 @@ module Itamae
           if notification.delayed?
             @recipe.delayed_notifications << notification
           elsif notification.immediately?
-            notification.run(options)
+            notification.run
           end
         end
       end

data/lib/itamae/resource/execute.rb

@@ -24,4 +24,3 @@ module Itamae
     end
   end
 end
-

data/lib/itamae/resource/file.rb

@@ -20,9 +20,11 @@ module Itamae
         when :edit
           attributes.exist = true
 
-          content = backend.receive_file(attributes.path)
-          attributes.block.call(content)
-          attributes.content = content
+          unless runner.dry_run?
+            content = backend.receive_file(attributes.path)
+            attributes.block.call(content)
+            attributes.content = content
+          end
         end
 
         send_tempfile
@@ -163,4 +165,3 @@ module Itamae
     end
   end
 end
-

data/lib/itamae/runner.rb

@@ -13,18 +13,20 @@ module Itamae
         runner.load_recipes(recipe_files)
 
         if dot_file = options[:dot]
-          Itamae.logger.info "Writing dependency graph in DOT to #{dot_file}..."
-          open(dot_file, 'w') do |f|
-            f.write(runner.children.deps_in_dot)
-          end
+          runner.save_dependency_graph(dot_file)
           return
         end
 
-        runner.run(dry_run: options[:dry_run])
+        runner.run
+
+        if profile = options[:profile]
+          runner.save_profile(profile)
+        end
       end
     end
 
     attr_reader :backend
+    attr_reader :options
     attr_reader :node
     attr_reader :tmpdir
     attr_reader :children
@@ -55,11 +57,28 @@ module Itamae
       end
     end
 
-    def run(options)
-      children.run(options)
+    def run
+      children.run
       @backend.finalize
     end
 
+    def dry_run?
+      @options[:dry_run]
+    end
+
+    def save_dependency_graph(path)
+      Itamae.logger.info "Writing dependency graph in DOT to #{path}..."
+      open(path, 'w') do |f|
+        f.write(runner.children.deps_in_dot)
+      end
+    end
+
+    def save_profile(path)
+      open(path, 'w', 0600) do |f|
+        f.write(@backend.executed_commands.to_json)
+      end
+    end
+
     private
     def create_node
       hash = {}
@@ -91,4 +110,3 @@ module Itamae
     end
   end
 end
-

data/lib/itamae/version.txt

@@ -1 +1 @@
-1.6.3
+1.7.0.pre

data/spec/integration/Vagrantfile

@@ -1,5 +1,6 @@
 # -*- mode: ruby -*-
 # vi: set ft=ruby :
+require 'vagrant-digitalocean'
 
 # Vagrantfile API/syntax version. Don't touch unless you know what you're doing!
 VAGRANTFILE_API_VERSION = "2"

data/spec/integration/recipes/dry_run.rb

@@ -0,0 +1,6 @@
+file "/tmp/it_does_not_exist" do
+  action :edit
+  block do |content|
+    content.gsub!("foo", "bar")
+  end
+end

data/spec/integration/spec_helper.rb

@@ -5,10 +5,8 @@ require 'tempfile'
 set :backend, :ssh
 
 def vagrant(cmd)
-  Bundler.with_clean_env do
-    env = {"VAGRANT_CWD" => File.dirname(__FILE__)}
-    system env, "/usr/bin/vagrant #{cmd}"
-  end
+  env = {"VAGRANT_CWD" => File.dirname(__FILE__)}
+  system(env, "vagrant #{cmd}")
 end
 
 if ENV['ASK_SUDO_PASSWORD']
@@ -38,8 +36,7 @@ set :ssh_options, options
 # set :disable_sudo, true
 
 # Set environment variables
-# set :env, :LANG => 'C', :LC_MESSAGES => 'C' 
+# set :env, :LANG => 'C', :LC_MESSAGES => 'C'
 
 # Set PATH
 # set :path, '/sbin:/usr/local/sbin:$PATH'
-

data/spec/unit/lib/itamae/resource/base_spec.rb

@@ -102,7 +102,9 @@ describe TestResource do
 
   let(:commands) { double(:commands) }
   let(:runner) do
-    double(:runner)
+    instance_double(Itamae::Runner).tap do |r|
+      allow(r).to receive(:dry_run?).and_return(false)
+    end
   end
   let(:recipe) do
     double(:recipe).tap do |r|
@@ -120,14 +122,5 @@ describe TestResource do
       expect(subject).to receive(:action_name)
       subject.run
     end
-
-    context 'with dry_run' do
-      context 'when specified action is unavailable' do
-        it 'logs error' do
-          expect(Itamae.logger).to receive(:error).with(/action :name is unavailable/)
-          subject.run(nil, dry_run: true)
-        end
-      end
-    end
   end
 end

data/wercker.yml

@@ -47,25 +47,17 @@ build:
         name: chmod 600 id_rsa
         code: chmod 600 $HOME/.ssh/id_rsa.vagrant
 
-    - script:
-        name: download vagrant
-        code: wget https://dl.bintray.com/mitchellh/vagrant/vagrant_1.6.3_x86_64.deb
-
-    - script:
-        name: install vagrant
-        code: sudo dpkg -i vagrant_1.6.3_x86_64.deb
-
     - script:
         name: install libxml and libxslt
         code: sudo apt-get install libxml2-dev libxslt1-dev
 
     - script:
-        name: install vagrant-digitalocean
-        code: NOKOGIRI_USE_SYSTEM_LIBRARIES=1 vagrant plugin install vagrant-digitalocean
+        name: bundle install
+        code: bundle install --deployment -j4
 
     - script:
         name: start vm
-        code: vagrant up --provider=digital_ocean
+        code: bundle exec vagrant up --provider=digital_ocean
         cwd: spec/integration
 
     # Add more steps here:
@@ -76,10 +68,10 @@ build:
   after-steps:
     - script:
         name: shutdown vm
-        code: vagrant destroy -f
+        code: bundle exec vagrant destroy -f
         cwd: spec/integration
 
     - script:
         name: shutdown old vms
-        code: ruby ci/destroy_old_droplets.rb
+        code: bundle exec ruby ci/destroy_old_droplets.rb
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: itamae
 version: !ruby/object:Gem::Version
-  version: 1.6.3
+  version: 1.7.0.pre
 platform: ruby
 authors:
 - Ryota Arai
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-21 00:00:00.000000000 Z
+date: 2015-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -244,6 +244,7 @@ files:
 - spec/integration/recipes/default2.rb
 - spec/integration/recipes/define/default.rb
 - spec/integration/recipes/define/files/remote_file_in_definition
+- spec/integration/recipes/dry_run.rb
 - spec/integration/recipes/files/remote_file_auto
 - spec/integration/recipes/hello.erb
 - spec/integration/recipes/hello.txt
@@ -276,9 +277,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.5
@@ -292,6 +293,7 @@ test_files:
 - spec/integration/recipes/default2.rb
 - spec/integration/recipes/define/default.rb
 - spec/integration/recipes/define/files/remote_file_in_definition
+- spec/integration/recipes/dry_run.rb
 - spec/integration/recipes/files/remote_file_auto
 - spec/integration/recipes/hello.erb
 - spec/integration/recipes/hello.txt