itamae-template 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 571d1c929a677f2384ac2e7195a07904d17d52eb
+  data.tar.gz: a45d20547bb367b16294efb0f98b8fc5e07c82ce
+SHA512:
+  metadata.gz: 97501a028fc505e71f6b5a13a567f07046cf046fc548f896482532692bff4400ecc2ac3a3572979159b34bacd2440a77d0db47bef320b43cae41a43a3f2a0033
+  data.tar.gz: d260ef531325cc406a54f2fe4874758c8e5311a9f61acdc1b5f4d09feb6581a449f83999bb45d4e9937c5670f95a8033807c58ff08d16a659d689169fd174ef0

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in itamae-template.gemspec
+gemspec

data/README.md

@@ -0,0 +1,110 @@
+# Itamae::Template
+
+Itamae template generator for roles and cookbooks, based on the
+[Best Practice](https://github.com/itamae-kitchen/itamae/wiki/Best-Practice)
+of [Itamae](https://github.com/itamae-kitchen/itamae/).
+
+## Features
+
+| command | description |
+|:-----|:--------|
+| `itamae-template init`  | Initialize repository to use cookbooks and roles |
+| `itamae-template g role [name]` | Generate roles/[name]/default.rb |
+| `itamae-template g cookbook [name]` | Generate cookbooks/[name]/default.rb |
+| `itamae-template d role [name]` | Destroy roles/[name]/default.rb |
+| `itamae-template d cookbook [name]` | Destroy cookbooks/[name]/default.rb |
+
+And you can include those recipes by `include_cookbook` or `include_role`.
+
+### Capistrano tasks
+
+The initialized repository includes following capistrano tasks.
+
+NOTE: Because `itamae ssh` is slow, itamae-template installs itamae remotely and
+execute recipes via `itamae local`.
+
+| command | description |
+|:-----|:--------|
+| `cap itamae prepare` | Install ruby to execute itamae remotely |
+| `cap itamae dry-run` | Check what will be executed |
+| `cap itamae apply` | Apply recipes |
+
+## Installation
+
+```bash
+$ gem install itamae-template
+```
+
+## Get started
+
+This is a tutorial of `itamae-template`.
+
+```bash
+# Create repository to add itamae recipes.
+$ mkdir infra
+$ cd infra
+$ git init
+
+# Initialize itamae helpers.
+$ gem install itamae-template
+$ itamae-template init
+
+# Specify hosts to provision. If you can ssh to the host by `ssh foo`,
+# edit: `role :production, %w[foo]`
+$ vim config/deploy.rb
+
+# Install ruby and bundler to the production role, i.e. "foo" host.
+# It will be installed to /opt/itamae/bin/ruby, not system-widely.
+$ bundle install
+$ bundle exec cap itamae prepare
+
+# Test execution of the recipes.
+$ bundle exec cap itamae dry-run
+
+# Apply recipes. It just prints hello.
+$ bundle exec cap itamae apply
+```
+
+### Cookbook
+
+```bash
+# Drop hello cookbook.
+$ itamae-template d cookbook hello
+
+# Create new cookbook. "default.rb" will be loaded by
+# `include_cookbook "nginx"`
+$ itamae-template g cookbook nginx
+$ vim cookbooks/nginx/default.rb
+$ vim roles/production/default.rb
+```
+
+### Role
+
+```bash
+# Create new role.
+$ itamae-template g role staging
+$ vim roles/staging/default.rb
+
+# Specify hosts to apply staging recipes.
+# Edit: `role :staging, %w[bar]`
+$ vim config/deploy.rb
+
+# Apply recipes only for staging by the capistrano way.
+$ ROLES=staging bundle exec cap itamae apply
+```
+
+## Shorthand
+
+You can use :sushi: instead of `itamae-template`.
+
+```bash
+$ sushi init
+$ sushi g role [name]
+$ sushi g cookbook [name]
+$ sushi d role [name]
+$ sushi d cookbook [name]
+```
+
+## License
+
+MIT License

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "itamae/template"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/itamae-template

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.expand_path('../lib', __dir__)
+require 'itamae/template/cli'
+
+Itamae::Template::CLI.start(ARGV)

data/exe/sushi

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+# Just a shorthand for itamae-template.
+
+$:.unshift File.expand_path('../lib', __dir__)
+require 'itamae/template/cli'
+
+Itamae::Template::CLI.start(ARGV)

data/itamae-template.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'itamae/template/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "itamae-template"
+  spec.version       = Itamae::Template::VERSION
+  spec.authors       = ["Takashi Kokubun"]
+  spec.email         = ["takashi-kokubun@cookpad.com"]
+
+  spec.summary       = %q{The best practice for itamae}
+  spec.description   = %q{Itamae template generater for roles and cookbooks.}
+  spec.homepage      = "https://github.com/k0kubun/itamae-template"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "thor"
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/itamae/template/cli.rb

@@ -0,0 +1,95 @@
+require 'fileutils'
+require 'pathname'
+require 'thor'
+
+module Itamae
+  module Template
+    class CLI < Thor
+      AVAILABLE_TARGETS = %w[role cookbook].freeze
+      TEMPLATE_PATH = Pathname.new(File.expand_path('../../../template', __dir__))
+      COLOR_MAP = {
+        red:   31, # remove
+        green: 32, # create
+        blue:  34, # identical
+        white: 37, # invoke
+      }
+
+      desc 'init', 'Initialize itamae repository'
+      def init
+        Dir.glob(TEMPLATE_PATH.join('**/*')).sort.each do |path|
+          copy_template(path)
+        end
+      end
+
+      desc 'generate [role|cookbook] [NAME]', 'Generate role or cookbook'
+      def generate(target, name)
+        validate_target!(target)
+
+        create_directory(File.join("#{target}s", name))
+        create_file(File.join("#{target}s", name, 'default.rb'), "# noop\n")
+        create_file(File.join("#{target}s", name, 'node.yml'), "# No variables\n")
+      end
+      method_option :generate, aliases: :g
+
+      desc 'destroy [role|cookbook] [NAME]', 'Destroy role or cookbook'
+      def destroy(target, name)
+        validate_target!(target)
+
+        recursive_remove(File.join("#{target}s", name))
+        recursive_remove(File.join("#{target}s", name, 'default.rb'))
+        recursive_remove(File.join("#{target}s", name, 'node.yml'))
+      end
+      method_option :destroy, aliases: :d
+
+      private
+
+      def validate_target!(target)
+        unless AVAILABLE_TARGETS.include?(target)
+          abort "Unexpected target '#{target}' is given.\n  Allowed: #{AVAILABLE_TARGETS.join(', ')}"
+        end
+      end
+
+      def copy_template(path)
+        relative_path = Pathname.new(path).relative_path_from(TEMPLATE_PATH)
+
+        if File.file?(path)
+          create_file(relative_path, File.read(path))
+        else
+          create_directory(relative_path)
+        end
+      end
+
+      def create_file(relative_path, content)
+        target_path = Pathname.new(Dir.pwd).join(relative_path)
+
+        if File.exist?(target_path)
+          puts "#{colorize('identical', code: :blue)}  #{relative_path}"
+        else
+          File.write(target_path, content)
+          puts "#{colorize('create', code: :green)}  #{relative_path}"
+        end
+      end
+
+      def create_directory(relative_path)
+        target_path = Pathname.new(Dir.pwd).join(relative_path)
+
+        if File.exist?(target_path)
+          puts "#{colorize('identical', code: :blue)}  #{relative_path}"
+        else
+          FileUtils.mkdir(target_path)
+          puts "#{colorize('create', code: :green)}  #{relative_path}"
+        end
+      end
+
+      def recursive_remove(relative_path)
+        target_path = Pathname.new(Dir.pwd).join(relative_path)
+        FileUtils.rm_rf(target_path)
+        puts "#{colorize('remove', code: :red)}  #{relative_path}"
+      end
+
+      def colorize(text, code: :red)
+        "\e[1m\e[#{COLOR_MAP[code]}m#{'%12s' % text}\e[0m"
+      end
+    end
+  end
+end

data/lib/itamae/template/version.rb

@@ -0,0 +1,5 @@
+module Itamae
+  module Template
+    VERSION = "0.1.0"
+  end
+end

data/lib/itamae/template.rb

@@ -0,0 +1,2 @@
+require 'itamae/template/cli'
+require 'itamae/template/version'

data/template/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+tmp

data/template/Capfile

@@ -0,0 +1,14 @@
+# Load DSL and set up stages
+require 'capistrano/setup'
+
+# Enable sudo
+require 'sshkit/sudo'
+
+# You can send password with $SUDO_PASSWORD
+if ENV['SUDO_PASSWORD']
+  module SSHKit
+    def Sudo.password_cache
+      Hash.new { "#{ENV['SUDO_PASSWORD']}\n" }
+    end
+  end
+end

data/template/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+# Install itamae and its plugins.
+gem 'itamae', '>= 1.5'
+
+# This group is only used by client and not installed on remote host.
+group :cap do
+  gem 'capistrano', '~> 3.4'
+  gem 'sshkit-sudo', '0.0.4'
+end

data/template/config/deploy/itamae.rb

@@ -0,0 +1,108 @@
+task 'apply'   => %w[rsync itamae:bundle_install itamae:apply]
+task 'dry-run' => %w[rsync itamae:bundle_install itamae:dry_run]
+task 'prepare' => %w[prepare:ruby prepare:bundler]
+
+# Ruby to execute itamae is installed to /opt/itamae.
+EMBEDDED_RUBY_DIR = '/opt/itamae'
+def bin_path(*paths)
+  File.join(EMBEDDED_RUBY_DIR, 'bin', *paths)
+end
+
+# This repository is rsynced to /tmp/itamae-cache.
+def cache_path(*paths)
+  File.join('/tmp/itamae-cache', *paths)
+end
+
+task :rsync do
+  on roles(:all) do |srv|
+    run_locally do
+      execute(*%W[
+        rsync -az --copy-links --copy-unsafe-links --delete
+        --exclude=.git* --exclude=.bundle*
+        . #{srv}:#{cache_path}
+      ])
+    end
+  end
+end
+
+namespace :itamae do
+  def run_itamae(role, dry_run: false)
+    local_yaml = File.join(File.expand_path('../../roles', __dir__), role.to_s, 'node.yml')
+    sudo(*%W[
+      PATH=#{bin_path}:${PATH} BUNDLE_GEMFILE=#{cache_path('Gemfile')}
+      #{bin_path('bundle')} exec itamae local
+      #{cache_path('recipe_helper.rb')} #{cache_path('roles', role.to_s, 'default.rb')}
+      --no-color #{'--dry-run' if dry_run}
+      #{"--node-yaml=#{cache_path('roles', role.to_s, 'node.yml')}" if File.exist?(local_yaml)}
+    ])
+  end
+
+  task :bundle_install do
+    on roles(:all) do
+      sudo(*%W[
+        BUNDLE_GEMFILE=#{cache_path('Gemfile')}
+        #{bin_path('bundle')} install --jobs `nproc` --without cap --quiet
+      ])
+    end
+  end
+
+  task :dry_run do
+    on roles(:all) do |srv|
+      srv.roles.each do |role|
+        run_itamae(role, dry_run: true)
+      end
+    end
+  end
+
+  task :apply do
+    on roles(:all) do |srv|
+      srv.roles.each do |role|
+        run_itamae(role)
+      end
+    end
+  end
+end
+
+namespace :prepare do
+  task :ruby do
+    on roles(:all) do
+      def install_ruby(platform, version)
+        return if capture("test -e #{bin_path('ruby')}; echo $?") == '0'
+
+        sudo :mkdir, '-p', EMBEDDED_RUBY_DIR
+        begin
+          cache_url = "https://s3.amazonaws.com/pkgr-buildpack-ruby/current/#{platform}/ruby-#{version}.tgz"
+          sudo(*%W[curl -s #{cache_url} -o /tmp/ruby.tgz])
+        rescue SSHKit::Command::Failed
+          # TODO: build ruby with ruby-build.
+          abort "'#{platform}' is not supported now. Please update config/deploy/itamae.rb"
+        end
+        sudo(*%W[tar xzf /tmp/ruby.tgz -C #{EMBEDDED_RUBY_DIR}])
+      end
+
+      # FIXME: support more OSs or versions. Basically this is using:
+      # http://blog.packager.io/post/101342252191/one-liner-to-get-a-precompiled-ruby-on-your-own
+      os = capture('head -n1 /etc/issue')
+      case os
+      when /^Ubuntu/
+        install_ruby('ubuntu-14.04', '2.1.4')
+      when /^CentOS release (\d)/
+        install_ruby("centos-#{$1}", '2.1.4')
+      when /Red Hat Enterprise Linux/
+        install_ruby('centos-6', '2.1.4')
+      when /Debian/
+        install_ruby('debian-7', '2.1.4')
+      when /Fedora/
+        install_ruby('fedora-20', '2.1.4')
+      else
+        abort "'#{os}' is not supported now. Please update config/deploy/itamae.rb"
+      end
+    end
+  end
+
+  task :bundler do
+    on roles(:all) do
+      execute!(*%W[test -e #{bin_path('bundle')} || sudo #{bin_path('gem')} install bundler --no-ri --no-rdoc])
+    end
+  end
+end

data/template/config/deploy.rb

@@ -0,0 +1,8 @@
+# You can filter roles by ROLES env variable.
+#   $ ROLES=role1,role2 bundle exec cap itamae apply
+#
+# With following example, you can apply recipes to production role by:
+#   $ ROLES=production bundle exec cap itamae apply
+#
+# TODO: Configure hosts to apply recipes.
+role :production, %w[example-host.com]

data/template/cookbooks/hello/default.rb

@@ -0,0 +1 @@
+execute "echo #{node[:hello].join(' ')}"

data/template/recipe_helper.rb

@@ -0,0 +1,19 @@
+require 'pathname'
+
+module RecipeHelper
+  ROOT_DIR = Pathname.new(File.expand_path(__dir__))
+
+  def include_role(name)
+    path = ROOT_DIR.join('roles', *name.split('::'))
+    path = path.relative_path_from(Pathname.new(@recipe.path).parent)
+    include_recipe(path.to_s)
+  end
+
+  def include_cookbook(name)
+    path = ROOT_DIR.join('cookbooks', *name.split('::'))
+    path = path.relative_path_from(Pathname.new(@recipe.path).parent)
+    include_recipe(path.to_s)
+  end
+end
+
+Itamae::Recipe::EvalContext.send(:include, RecipeHelper)

data/template/roles/production/default.rb

@@ -0,0 +1 @@
+include_cookbook 'hello'

data/template/roles/production/node.yml

@@ -0,0 +1,4 @@
+# These variables are available as `node`
+hello:
+  - hello
+  - world

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: itamae-template
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Takashi Kokubun
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Itamae template generater for roles and cookbooks.
+email:
+- takashi-kokubun@cookpad.com
+executables:
+- itamae-template
+- sushi
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/itamae-template
+- exe/sushi
+- itamae-template.gemspec
+- lib/itamae/template.rb
+- lib/itamae/template/cli.rb
+- lib/itamae/template/version.rb
+- template/.gitignore
+- template/Capfile
+- template/Gemfile
+- template/config/deploy.rb
+- template/config/deploy/itamae.rb
+- template/cookbooks/hello/default.rb
+- template/recipe_helper.rb
+- template/roles/production/default.rb
+- template/roles/production/node.yml
+homepage: https://github.com/k0kubun/itamae-template
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.0
+signing_key: 
+specification_version: 4
+summary: The best practice for itamae
+test_files: []