itamae 1.11.1 → 1.12.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2213250f28fa9b34d4c8d149add25c33f9955b6dd30dfab4fc7ddd9f4e438e61
-  data.tar.gz: 12b67ddfa15210dfb1ea8d35b5aa02db9e4985f4e141c66d7102628b09b5f914
+  metadata.gz: 8ae63d9a50f327992d3efd26c9e0de210038cbacdad66a46f25506ff4120c14e
+  data.tar.gz: 2c8d8acb12e94cb4b3bdc8708d1928165a8b2b05f84a1036d01713a248542519
 SHA512:
-  metadata.gz: 4a83817032655a372418a0c2aeef5561e2b669c075b16a0b56f3522d94883396cc535b44cad5d3e2b7c2b8c8c4fdbf400eb95a9efe986b97effaa587cf8d5564
-  data.tar.gz: 96380efa8166f7629035be66884c3526c4c521eaababb5303bf0c520bbb914ebcb8de2e2492bd0ffbc1681d8285d62e011853476565b409486f040422101007a
+  metadata.gz: 743001b3776f624308d7c4b85842f4fb186f0260eed592112e9aa6f9bd786032894090a2221ce6a4f969569159c78261fefc87270ba0e45ca6e71ade21e23333
+  data.tar.gz: 051e86dc11a37a1acc66a481ac96c768e6d0f20c3894dae2c94698f590b308b4374d84b2c3ae91f7aa2cd7c12f6aeb2ba4f16c5b748a809a4fd9058663de75cb

data/.github/workflows/test.yml

@@ -0,0 +1,202 @@
+name: test
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    types:
+      - opened
+      - synchronize
+      - reopened
+  schedule:
+    - cron: "0 0 * * 5" # JST 9:00 (Fri)
+
+jobs:
+  unit:
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+
+      matrix:
+        ruby:
+          - "2.3"
+          - "2.4"
+          - "2.5"
+          - "2.6"
+          - "2.7"
+          - "3.0"
+        rubyopt:
+          - ""
+          - "--jit"
+        exclude:
+          # --jit is available since MRI 2.6
+          - ruby:    "2.3"
+            rubyopt: "--jit"
+          - ruby:    "2.4"
+            rubyopt: "--jit"
+          - ruby:    "2.5"
+            rubyopt: "--jit"
+
+    env:
+      RUBYOPT: ${{ matrix.rubyopt }}
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - run: bundle update
+
+      - run: bundle exec rake spec:unit
+
+      - name: Slack Notification (not success)
+        uses: lazy-actions/slatify@master
+        if: "! success()"
+        continue-on-error: true
+        with:
+          job_name: ${{ format('*unit* ({0},{1})', matrix.ruby, matrix.rubyopt) }}
+          type: ${{ job.status }}
+          icon_emoji: ":octocat:"
+          url: ${{ secrets.SLACK_WEBHOOK }}
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+  integration-docker:
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+
+      matrix:
+        ruby:
+          - "2.3"
+          - "2.4"
+          - "2.5"
+          - "2.6"
+          - "2.7"
+          - "3.0"
+        rubyopt:
+          - ""
+          - "--jit"
+        image:
+          - ubuntu:trusty
+        exclude:
+          # --jit is available since MRI 2.6
+          - ruby:    "2.3"
+            rubyopt: "--jit"
+          - ruby:    "2.4"
+            rubyopt: "--jit"
+          - ruby:    "2.5"
+            rubyopt: "--jit"
+
+    env:
+      RUBYOPT: ${{ matrix.rubyopt }}
+      TEST_IMAGE: ${{ matrix.image }}
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - run: bundle update
+
+      - run: bundle exec rake spec:integration:docker:boot
+
+      - run: bundle exec rake spec:integration:docker:provision
+        env:
+          # FIXME: avoid error for "Command `chmod 777 /tmp/itamae_tmp` failed. (exit status: 1)"
+          ITAMAE_TMP_DIR: /var/tmp/itamae_tmp
+
+      - run: bundle exec rake spec:integration:docker:serverspec
+      - run: bundle exec rake spec:integration:docker:clean_docker_container
+
+      - name: Slack Notification (not success)
+        uses: lazy-actions/slatify@master
+        if: "! success()"
+        continue-on-error: true
+        with:
+          job_name: ${{ format('*integration-docker* ({0},{1},{2})', matrix.ruby, matrix.rubyopt, matrix.image) }}
+          type: ${{ job.status }}
+          icon_emoji: ":octocat:"
+          url: ${{ secrets.SLACK_WEBHOOK }}
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+  integration-local:
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+
+      matrix:
+        ruby:
+          - "2.3"
+          - "2.4"
+          - "2.5"
+          - "2.6"
+          - "2.7"
+          - "3.0"
+        rubyopt:
+          - ""
+          - "--jit"
+        exclude:
+          # --jit is available since MRI 2.6
+          - ruby:    "2.3"
+            rubyopt: "--jit"
+          - ruby:    "2.4"
+            rubyopt: "--jit"
+          - ruby:    "2.5"
+            rubyopt: "--jit"
+
+    env:
+      RUBYOPT: ${{ matrix.rubyopt }}
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - run: bundle update
+
+      - run: bundle exec rake spec:integration:local:main
+      - run: bundle exec rake spec:integration:local:ordinary_user
+
+      - name: Slack Notification (not success)
+        uses: lazy-actions/slatify@master
+        if: "! success()"
+        continue-on-error: true
+        with:
+          job_name: ${{ format('*integration-local* ({0},{1})', matrix.ruby, matrix.rubyopt) }}
+          type: ${{ job.status }}
+          icon_emoji: ":octocat:"
+          url: ${{ secrets.SLACK_WEBHOOK }}
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+  notify:
+    needs:
+      - unit
+      - integration-docker
+      - integration-local
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Slack Notification (success)
+        uses: lazy-actions/slatify@master
+        if: always()
+        continue-on-error: true
+        with:
+          job_name: '*notify*'
+          type: ${{ job.status }}
+          icon_emoji: ":octocat:"
+          url: ${{ secrets.SLACK_WEBHOOK }}
+          token: ${{ secrets.GITHUB_TOKEN }}

data/CHANGELOG.md

@@ -1,5 +1,33 @@
 ## Unreleased
-[full changelog](https://github.com/itamae-kitchen/itamae/compare/v1.11.1...master)
+[full changelog](https://github.com/itamae-kitchen/itamae/compare/v1.12.2...master)
+
+## v1.12.2
+[full changelog](https://github.com/itamae-kitchen/itamae/compare/v1.12.1...v1.12.2)
+
+Improvements
+
+- [remote_directory: add diff -r option](https://github.com/itamae-kitchen/itamae/pull/338)
+
+## v1.12.1
+[full changelog](https://github.com/itamae-kitchen/itamae/compare/v1.12.0...v1.12.1)
+
+Improvements
+
+- [Allow defining top-level modules without `::`](https://github.com/itamae-kitchen/itamae/pull/332)
+
+## v1.12.0
+[full changelog](https://github.com/itamae-kitchen/itamae/compare/v1.11.2...v1.12.0)
+
+Improvements
+
+- [Add `--tmp-dir` to cli options](https://github.com/itamae-kitchen/itamae/pull/331)
+
+## v1.11.2
+[full changelog](https://github.com/itamae-kitchen/itamae/compare/v1.11.1...v1.11.2)
+
+Bugfixes
+
+- [Support thor-1.1.0 (by @chaaaaarlotte)](https://github.com/itamae-kitchen/itamae/pull/329)
 
 ## v1.11.1
 [full changelog](https://github.com/itamae-kitchen/itamae/compare/v1.11.0...v1.11.1)

data/README.md

@@ -1,6 +1,6 @@
 # [![](https://raw.githubusercontent.com/itamae-kitchen/itamae-logos/master/small/FA-Itamae-horizontal-01-180x72.png)](https://github.com/itamae-kitchen/itamae)
 
-[![Gem Version](https://badge.fury.io/rb/itamae.svg)](http://badge.fury.io/rb/itamae) [![Code Climate](https://codeclimate.com/github/ryotarai/itamae/badges/gpa.svg)](https://codeclimate.com/github/ryotarai/itamae) [![Build Status](https://travis-ci.com/itamae-kitchen/itamae.svg?branch=master)](https://travis-ci.com/itamae-kitchen/itamae) [![Slack](https://img.shields.io/badge/slack-join-blue.svg)](https://join.slack.com/t/itamae/shared_invite/enQtNTExNTI3ODM1NTY5LTM5MWJlZTgwODE0YTUwMThiNzZjN2I1MGNlZjE2NjlmNzg5NTNlOTliMDhkNDNmNTQ2ZTgwMzZjNjI5NDJiZGI)
+[![Gem Version](https://badge.fury.io/rb/itamae.svg)](http://badge.fury.io/rb/itamae) [![Code Climate](https://codeclimate.com/github/ryotarai/itamae/badges/gpa.svg)](https://codeclimate.com/github/ryotarai/itamae) [![Build Status](https://github.com/itamae-kitchen/itamae/workflows/test/badge.svg?branch=master)](https://github.com/itamae-kitchen/itamae/actions?query=workflow%3Atest) [![Slack](https://img.shields.io/badge/slack-join-blue.svg)](https://join.slack.com/t/itamae/shared_invite/enQtNTExNTI3ODM1NTY5LTM5MWJlZTgwODE0YTUwMThiNzZjN2I1MGNlZjE2NjlmNzg5NTNlOTliMDhkNDNmNTQ2ZTgwMzZjNjI5NDJiZGI)
 
 Simple and lightweight configuration management tool inspired by Chef.
 

data/Rakefile

@@ -10,6 +10,8 @@ end
 desc 'Run unit and integration specs.'
 task :spec => ['spec:unit', 'spec:integration:all']
 
+TEST_IMAGE = ENV["TEST_IMAGE"] || "ubuntu:trusty"
+
 namespace :spec do
   RSpec::Core::RakeTask.new("unit") do |task|
     task.ruby_opts = '-I ./spec/unit'
@@ -17,60 +19,54 @@ namespace :spec do
   end
 
   namespace :integration do
-    targets = ["ubuntu:trusty"]
     container_name = 'itamae'
 
-    task :all     => targets + ['spec:integration:local']
+    task :all => ['spec:integration:docker' 'spec:integration:local']
 
-    targets.each do |target|
-      desc "Run provision and specs to #{target}"
-      task target => ["docker:#{target}", "provision:#{target}", "serverspec:#{target}", 'clean_docker_container']
+    desc "Run provision and specs"
+    task :docker => ["docker:boot", "docker:provision", "docker:serverspec", 'docker:clean_docker_container']
 
-      namespace :docker do
-        desc "Run docker for #{target}"
-        task target do
-          sh "docker run --privileged -d --name #{container_name} #{target} /sbin/init"
-        end
+    namespace :docker do
+      desc "Run docker"
+      task :boot do
+        sh "docker run --privileged -d --name #{container_name} #{TEST_IMAGE} /sbin/init"
       end
 
-      namespace :provision do
-        desc "Run itamae to #{target}"
-        task target do
-          suites = [
-            [
-              "spec/integration/recipes/default.rb",
-              "spec/integration/recipes/default2.rb",
-              "spec/integration/recipes/redefine.rb",
-              "spec/integration/recipes/docker.rb",
-            ],
-            [
-              "--dry-run",
-              "spec/integration/recipes/dry_run.rb",
-            ],
-          ]
-          suites.each do |suite|
-            cmd = %w!bundle exec ruby -w bin/itamae docker!
-            cmd << "-l" << (ENV['LOG_LEVEL'] || 'debug')
-            cmd << "-j" << "spec/integration/recipes/node.json"
-            cmd << "--container" << container_name
-            cmd << "--tag" << "itamae:latest"
-            cmd += suite
+      desc "Run itamae"
+      task :provision do
+        suites = [
+          [
+            "spec/integration/recipes/default.rb",
+            "spec/integration/recipes/default2.rb",
+            "spec/integration/recipes/redefine.rb",
+            "spec/integration/recipes/docker.rb",
+          ],
+          [
+            "--dry-run",
+            "spec/integration/recipes/dry_run.rb",
+          ],
+        ]
+        suites.each do |suite|
+          cmd = %w!bundle exec ruby -w bin/itamae docker!
+          cmd << "-l" << (ENV['LOG_LEVEL'] || 'debug')
+          cmd << "-j" << "spec/integration/recipes/node.json"
+          cmd << "--container" << container_name
+          cmd << "--tag" << "itamae:latest"
+          cmd << "--tmp-dir" << (ENV['ITAMAE_TMP_DIR'] || '/tmp/itamae_tmp')
+          cmd += suite
 
-            p cmd
-            unless system(*cmd)
-              raise "#{cmd} failed"
-            end
+          p cmd
+          unless system(*cmd)
+            raise "#{cmd} failed"
           end
         end
       end
 
-      namespace :serverspec do
-        desc "Run serverspec tests to #{target}"
-        RSpec::Core::RakeTask.new(target.to_sym) do |t|
-          ENV['DOCKER_CONTAINER'] = container_name
-          t.ruby_opts = '-I ./spec/integration'
-          t.pattern = "spec/integration/{default,docker}_spec.rb"
-        end
+      desc "Run serverspec tests"
+      RSpec::Core::RakeTask.new(:serverspec) do |t|
+        ENV['DOCKER_CONTAINER'] = container_name
+        t.ruby_opts = '-I ./spec/integration'
+        t.pattern = "spec/integration/{default,docker}_spec.rb"
       end
 
       desc 'Clean a docker container for test'

data/lib/itamae/cli.rb

@@ -25,6 +25,15 @@ module Itamae
       option :log_level, type: :string, aliases: ['-l'], default: 'info'
       option :color, type: :boolean, default: true
       option :config, type: :string, aliases: ['-c']
+      option :tmp_dir, type: :string, aliases: ['-t'], default: "/tmp/itamae_tmp"
+    end
+
+    def self.options
+      @itamae_options ||= super.dup.tap do |options|
+        if config = options[:config]
+          options.merge!(YAML.load_file(config))
+        end
+      end
     end
 
     desc "local RECIPE [RECIPE...]", "Run Itamae locally"
@@ -117,14 +126,6 @@ module Itamae
     end
 
     private
-    def options
-      @itamae_options ||= super.dup.tap do |options|
-        if config = options[:config]
-          options.merge!(YAML.load_file(config))
-        end
-      end
-    end
-
     def validate_generate_target!(command, target)
       unless GENERATE_TARGETS.include?(target)
         msg = %Q!ERROR: "itamae #{command}" was called with "#{target}" !

data/lib/itamae/recipe.rb

@@ -53,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
@@ -151,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/remote_directory.rb

@@ -39,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/runner.rb

@@ -30,7 +30,7 @@ module Itamae
       prepare_handler
 
       @node = create_node
-      @tmpdir = "/tmp/itamae_tmp"
+      @tmpdir = options[:tmp_dir]
       @children = RecipeChildren.new
       @diff = false
 

data/lib/itamae/version.rb

@@ -1,3 +1,3 @@
 module Itamae
-  VERSION = "1.11.1"
+  VERSION = "1.12.2"
 end

data/spec/integration/default_spec.rb

@@ -333,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/recipes/default.rb

@@ -556,3 +556,9 @@ unless v1 == v2 && v2 == v3 && v1 =~ /\A\d+kB\z/
   raise "failed to fetch host inventory value (#{v1}, #{v2}, #{v3})"
 end
 
+include_recipe "toplevel_module"
+file "/tmp/toplevel_module" do
+  content ToplevelModule.helper
+end
+
+include_recipe "variables"

data/spec/integration/recipes/toplevel_module.rb

@@ -0,0 +1,6 @@
+# Testing you don't need to write `module ::ToplevelModule`
+module ToplevelModule
+  def self.helper
+    "helper"
+  end
+end

data/spec/integration/recipes/variables.rb

@@ -0,0 +1,14 @@
+node.reverse_merge!(
+  variables: {
+    lvars: binding.local_variables,
+    ivars: instance_variables,
+  }
+)
+
+file "/tmp/local_variables" do
+  content node[:variables][:lvars].to_s
+end
+
+file "/tmp/instance_variables" do
+  content node[:variables][:ivars].to_s
+end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: itamae
 version: !ruby/object:Gem::Version
-  version: 1.11.1
+  version: 1.12.2
 platform: ruby
 authors:
 - Ryota Arai
 - Yusuke Nakamura
 - sue445
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-29 00:00:00.000000000 Z
+date: 2021-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -200,7 +200,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - ryota.arai@gmail.com
 - yusuke1994525@gmail.com
@@ -210,9 +210,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -293,6 +293,8 @@ files:
 - spec/integration/recipes/redefine.rb
 - spec/integration/recipes/templates/empty_file.erb
 - spec/integration/recipes/templates/template_auto.erb
+- spec/integration/recipes/toplevel_module.rb
+- spec/integration/recipes/variables.rb
 - spec/integration/spec_helper.rb
 - spec/unit/lib/itamae/backend_spec.rb
 - spec/unit/lib/itamae/handler/base_spec.rb
@@ -314,7 +316,7 @@ metadata:
   homepage_uri: https://itamae.kitchen/
   source_code_uri: https://github.com/itamae-kitchen/itamae
   changelog_uri: https://github.com/itamae-kitchen/itamae/blob/master/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -329,8 +331,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Simple Configuration Management Tool
 test_files:
@@ -357,6 +359,8 @@ test_files:
 - spec/integration/recipes/redefine.rb
 - spec/integration/recipes/templates/empty_file.erb
 - spec/integration/recipes/templates/template_auto.erb
+- spec/integration/recipes/toplevel_module.rb
+- spec/integration/recipes/variables.rb
 - spec/integration/spec_helper.rb
 - spec/unit/lib/itamae/backend_spec.rb
 - spec/unit/lib/itamae/handler/base_spec.rb

data/.travis.yml

@@ -1,41 +0,0 @@
-language: ruby
-sudo: required
-dist: xenial
-services:
-  - docker
-rvm:
-  - 2.3
-  - 2.4
-  - 2.5
-  - 2.6
-  - 2.7
-  - 3.0
-  - ruby-head
-bundler_args: "--jobs=4 --retry=3"
-cache:
-  bundler: true
-
-before_install:
-  - travis_retry gem install bundler --no-document || travis_retry gem install bundler --no-document -v 1.17.3
-
-script:
-  - RUBYOPT=$SPEC_RUBYOPT bundle exec rake spec
-notifications:
-  email: false
-  slack:
-    secure: PcecHsVS6lw89K5PllW8xFlzu0d04p6lYfxlUZL0/yp9flAczElJME4RshSMSkbnu5e2Iw8KUA2xB1jkAzDo9qYoXveaKyjkFUOb1ZxYIVxzzfoDDwUNTMmSoyjZjvbeBUcpxxmxy6nXa3zS+gA2ohqWhS9WTTlTqyM5RriDjZ8=
-matrix:
-  allow_failures:
-  - rvm: ruby-head
-  include:
-  - rvm: 2.6
-    env: SPEC_RUBYOPT="--jit"
-  - rvm: 2.7
-    env: SPEC_RUBYOPT="--jit"
-  - rvm: 3.0
-    env: SPEC_RUBYOPT="--jit"
-  - rvm: ruby-head
-    env: SPEC_RUBYOPT="--jit"
-branches:
-  only:
-  - master