itamae 1.0.0.beta1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e8b0f4978f8d00ca41234de5b288befcdc1f0f68
+  data.tar.gz: 20ad47b014f03d7af8ac547152281c5c0fbd9f99
+SHA512:
+  metadata.gz: dd694c3e13fa40bbee8862338c59ff8079dd30763ba2710c9868e9a4dda8bda080baef7a46a8a21c4b67fdecab051447eb2064015625e1e5f843f741de767c85
+  data.tar.gz: 3d95d7a8a67337c18b56d569e3b6e45dfe65331e9a522a5d7f5a8586c330698c81199699584f94080b52befdaf561ffd5d4c9b683958244f1175515e8abf735f

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.vagrant
+Gemfile.local

data/.rspec

@@ -0,0 +1,2 @@
+--color
+-fd

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - "2.0.0"
+  - "1.9.3"
+script:
+  - bundle exec rake spec:unit

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in itamae.gemspec
+gemspec
+
+path = Pathname.new("Gemfile.local")
+eval(path.read) if path.exist?
+
+group :test do
+  if RUBY_PLATFORM.include?('darwin')
+    gem 'growl'
+  end
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013-2014 Ryota Arai
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,60 @@
+# Itamae
+
+Configuration management tool like Chef which is simpler and lighter than Chef
+
+## Concept
+
+* Good DSL like Chef
+* Simpler and lighter than Chef
+* It's just like Chef. No compatibility.
+* Idempotent.
+
+## Installation
+
+```
+$ gem install itamae
+```
+
+## Usage
+
+### Run locally
+
+```
+$ sudo itamae execute -j example/node.json example/recipe.rb
+D, [2013-12-24T14:05:50.859587 #7156] DEBUG -- : Loading node data from /vagrant/example/node.json ...
+I, [2013-12-24T14:05:50.862072 #7156]  INFO -- : >>> Executing Itamae::Resources::Package ({:action=>:install, :name=>"git"})...
+D, [2013-12-24T14:05:51.335070 #7156] DEBUG -- : Command `apt-get -y install git` succeeded
+D, [2013-12-24T14:05:51.335251 #7156] DEBUG -- : STDOUT> Reading package lists...
+Building dependency tree...
+Reading state information...
+git is already the newest version.
+0 upgraded, 0 newly installed, 0 to remove and 156 not upgraded.
+D, [2013-12-24T14:05:51.335464 #7156] DEBUG -- : STDERR>
+I, [2013-12-24T14:05:51.335531 #7156]  INFO -- : <<< Succeeded.
+I, [2013-12-24T14:05:51.335728 #7156]  INFO -- : >>> Executing Itamae::Resources::File ({:action=>:create, :source=>"foo", :path=>"/home/vagrant/foo"})...
+D, [2013-12-24T14:05:51.335842 #7156] DEBUG -- : Copying a file from '/vagrant/example/foo' to '/home/vagrant/foo'...
+I, [2013-12-24T14:05:51.339119 #7156]  INFO -- : <<< Succeeded.
+```
+
+### Run via SSH
+
+```
+$ itamae ssh -j example/node.json -h 192.168.10.10 -p 22 -u user -i /path/to/private_key example/recipe.rb
+```
+
+## Run tests
+
+Requirements: Vagrant
+
+```
+$ bundle exec rake spec
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+

data/Rakefile

@@ -0,0 +1,62 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+require 'tempfile'
+require 'net/ssh'
+
+desc 'Run unit and integration specs.'
+task :spec => ['spec:unit', 'spec:integration:all']
+
+namespace :spec do
+  RSpec::Core::RakeTask.new("unit") do |task|
+    task.ruby_opts = '-I ./spec/unit'
+    task.pattern = "./spec/unit{,/*/**}/*_spec.rb"
+  end
+
+  namespace :integration do
+    targets = []
+    Bundler.with_clean_env do
+      `cd spec/integration && /usr/bin/vagrant status`.split("\n\n")[1].each_line do |line|
+        targets << line.match(/^[^ ]+/)[0]
+      end
+    end
+
+    task :all     => targets
+
+    targets.each do |target|
+      desc "Run provision and specs to #{target}"
+      task target => ["provision:#{target}", "serverspec:#{target}"]
+
+      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, "/usr/bin/vagrant up #{target}"
+            system env, "/usr/bin/vagrant 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 << " -j spec/integration/recipes/node.json"
+            cmd << " spec/integration/recipes/default.rb"
+
+            system cmd
+            abort unless $?.exitstatus == 0
+          end
+        end
+      end
+
+      namespace :serverspec do
+        desc "Run serverspec tests to #{target}"
+        RSpec::Core::RakeTask.new(target.to_sym) do |t|
+          ENV['TARGET_HOST'] = target
+          t.ruby_opts = '-I ./spec/integration'
+          t.pattern = "spec/integration/*_spec.rb"
+        end
+      end
+    end
+  end
+end

data/bin/itamae

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'itamae/cli'
+Itamae::CLI.start
+

data/example/foo

@@ -0,0 +1 @@
+Hello

data/example/node.json

@@ -0,0 +1 @@
+{"file_source": "foo"}

data/example/recipe.rb

@@ -0,0 +1,15 @@
+package "git" do
+  action :install
+end
+
+remote_file '/home/vagrant/foo' do
+  source node['file_source']
+end
+
+directory '/tmp/itamae' do
+  action :create
+  mode '0777'
+  owner 'vagrant'
+  group 'vagrant'
+end
+

data/itamae.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'itamae/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "itamae"
+  spec.version       = Itamae::VERSION
+  spec.authors       = ["Ryota Arai"]
+  spec.email         = ["ryota.arai@gmail.com"]
+  spec.summary       = %q{Simple Configuration Management Tool}
+  spec.homepage      = "https://github.com/ryotarai/itamae"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "thor"
+  spec.add_runtime_dependency "specinfra", "2.0.0.beta20"
+  spec.add_runtime_dependency "hashie"
+
+  # TODO: move to specinfra
+  spec.add_runtime_dependency "net-scp"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "serverspec", "2.0.0.beta16"
+  spec.add_development_dependency "pry-byebug"
+end

data/lib/itamae.rb

@@ -0,0 +1,13 @@
+require "itamae/version"
+require "itamae/runner"
+require "itamae/cli"
+require "itamae/recipe"
+require "itamae/resources"
+require "itamae/logger"
+require "itamae/node"
+require "itamae/specinfra"
+
+module Itamae
+  # Your code goes here...
+end
+

data/lib/itamae/cli.rb

@@ -0,0 +1,23 @@
+require 'itamae'
+require 'thor'
+
+module Itamae
+  class CLI < Thor
+    desc "local RECIPE [RECIPE...]", "Run Itamae locally"
+    option :node_json, type: :string, aliases: ['-j']
+    def local(*recipe_files)
+      Runner.run(recipe_files, :local, options)
+    end
+
+    desc "ssh RECIPE [RECIPE...]", "Run Itamae via ssh"
+    option :node_json, type: :string, aliases: ['-j']
+    option :host, required: true, type: :string, aliases: ['-h']
+    option :user, type: :string, aliases: ['-u']
+    option :key, type: :string, aliases: ['-i']
+    option :port, type: :numeric, aliases: ['-p']
+    def ssh(*recipe_files)
+      Runner.run(recipe_files, :ssh, options)
+    end
+  end
+end
+

data/lib/itamae/logger.rb

@@ -0,0 +1,44 @@
+require 'itamae'
+require 'logger'
+
+module Itamae
+  module Logger
+    class Formatter
+      def call(severity, datetime, progname, msg)
+        "[%s] %5s : %s\n" % [format_datetime(datetime), severity, msg2str(msg)]
+      end
+
+      private
+      def format_datetime(time)
+        time.strftime("%Y-%m-%dT%H:%M:%S.") << "%06d" % time.usec
+      end
+
+      def msg2str(msg)
+        case msg
+        when ::String
+          msg
+        when ::Exception
+          "#{ msg.message } (#{ msg.class })\n" <<
+          (msg.backtrace || []).join("\n")
+        else
+          msg.inspect
+        end
+      end
+    end
+
+    def self.logger
+      @logger ||= ::Logger.new($stdout).tap do |logger|
+        logger.formatter = Formatter.new
+      end
+    end
+
+    def self.logger=(l)
+      @logger = l
+    end
+
+    def self.method_missing(method, *args, &block)
+      logger.public_send(method, *args, &block)
+    end
+  end
+end
+

data/lib/itamae/node.rb

@@ -0,0 +1,9 @@
+require 'itamae'
+require 'hashie'
+require 'json'
+
+module Itamae
+  class Node < Hashie::Mash
+  end
+end
+

data/lib/itamae/recipe.rb

@@ -0,0 +1,46 @@
+require 'itamae'
+
+module Itamae
+  class Recipe
+    attr_reader :path
+    attr_reader :runner
+
+    def initialize(runner, path)
+      @runner = runner
+      @path = path
+      @resources = []
+      load_resources
+    end
+
+    def node
+      @runner.node
+    end
+
+    def run
+      @resources.each do |resource|
+        Logger.info ">>> Executing #{resource.class.name} (#{resource.options})..."
+        begin
+          resource.run
+        rescue Resources::CommandExecutionError
+          Logger.error "<<< Failed."
+          exit 2
+        else
+          Logger.info "<<< Succeeded."
+        end
+      end
+    end
+
+    private
+
+    def load_resources
+      instance_eval(File.read(@path), @path, 1)
+    end
+
+    def method_missing(method, name, &block)
+      klass = Resources.get_resource_class(method)
+      resource = klass.new(self, name, &block)
+      @resources << resource
+    end
+  end
+end
+

data/lib/itamae/resources.rb

@@ -0,0 +1,25 @@
+require 'itamae'
+require 'itamae/resources/base'
+require 'itamae/resources/file'
+require 'itamae/resources/package'
+require 'itamae/resources/remote_file'
+require 'itamae/resources/directory'
+require 'itamae/resources/template'
+
+module Itamae
+  module Resources
+    Error = Class.new(StandardError)
+    CommandExecutionError = Class.new(StandardError)
+    OptionMissingError = Class.new(StandardError)
+    InvalidTypeError = Class.new(StandardError)
+    NotSupportedOsError = Class.new(StandardError)
+
+    def self.get_resource_class_name(method)
+      method.to_s.split('_').map {|part| part.capitalize}.join
+    end
+
+    def self.get_resource_class(method)
+      const_get(get_resource_class_name(method))
+    end
+  end
+end

data/lib/itamae/resources/base.rb

@@ -0,0 +1,151 @@
+require 'itamae'
+require 'shellwords'
+
+module Itamae
+  module Resources
+    class Base
+      @defined_options ||= {}
+      @supported_oses ||= []
+
+      class << self
+        attr_reader :defined_options
+        attr_reader :supported_oses
+
+        def inherited(subclass)
+          subclass.instance_variable_set(
+            :@defined_options,
+            self.defined_options.dup
+          )
+        end
+
+        def define_option(name, options)
+          current = @defined_options[name.to_sym] || {}
+          @defined_options[name.to_sym] = current.merge(options)
+        end
+
+        def support_os(hash)
+          @supported_oses << hash
+        end
+      end
+
+      define_option :action, type: Symbol, required: true
+
+      attr_reader :resource_name
+      attr_reader :options
+
+      def initialize(recipe, resource_name, &block)
+        @options = {}
+        @recipe = recipe
+        @resource_name = resource_name
+
+        instance_eval(&block) if block_given?
+
+        process_options
+        ensure_os
+      end
+
+      def run
+        public_send("#{action}_action".to_sym)
+      end
+
+      def nothing_action
+        # do nothing
+      end
+
+      private
+
+      def method_missing(method, *args)
+        if args.size == 1 && self.class.defined_options[method]
+          return @options[method] = args.first
+        elsif args.size == 0 && @options.has_key?(method)
+          return @options[method]
+        end
+        super
+      end
+
+      def process_options
+        self.class.defined_options.each_pair do |key, details|
+          @options[key] ||= @resource_name if details[:default_name]
+          @options[key] ||= details[:default]
+
+          if details[:required] && !@options[key]
+            raise Resources::OptionMissingError, "'#{key}' option is required but it is not set."
+          end
+
+          if @options[key] && details[:type] && !@options[key].is_a?(details[:type])
+            raise Resources::InvalidTypeError, "#{key} option should be #{details[:type]}."
+          end
+        end
+      end
+
+      def run_specinfra(type, *args)
+        command = Specinfra.command.public_send(type, *args)
+        run_command(command)
+      end
+
+      def run_command(command)
+        result = backend.run_command(command)
+        exit_status = result.exit_status
+
+        if exit_status == 0
+          method = :debug
+          Logger.public_send(method, "Command `#{command}` succeeded")
+        else
+          method = :error
+          Logger.public_send(method, "Command `#{command}` failed. (exit status: #{exit_status})")
+        end
+
+        if result.stdout && result.stdout != ''
+          Logger.public_send(method, "STDOUT> #{result.stdout.chomp}")
+        end
+        if result.stderr && result.stderr != ''
+          Logger.public_send(method, "STDERR> #{result.stderr.chomp}")
+        end
+
+        unless exit_status == 0
+          raise CommandExecutionError
+        end
+      end
+
+      def copy_file(src, dst)
+        Logger.debug "Copying a file from '#{src}' to '#{dst}'..."
+        unless ::File.exist?(src)
+          raise Error, "The file '#{src}' doesn't exist."
+        end
+        unless backend.copy_file(src, dst)
+          raise Error, "Copying a file failed."
+        end
+      end
+
+      def node
+        runner.node
+      end
+
+      def backend
+        Itamae.backend
+      end
+
+      def runner
+        @recipe.runner
+      end
+
+      def shell_escape(str)
+        Shellwords.escape(str)
+      end
+
+      def ensure_os
+        return unless self.class.supported_oses
+        ok = self.class.supported_oses.any? do |supported|
+          supported.each_pair.all? do |k, v|
+            backend.os[k] == v
+          end
+        end
+
+        unless ok
+          raise NotSupportedOsError, "#{self.class.name} resource doesn't support this OS now."
+        end
+      end
+    end
+  end
+end
+