cronicle 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ce9c4a8eff04541e0649bf02eb6e096774d2d42b
+  data.tar.gz: 0833f3ca301c909805d70910e08491de147f4507
+SHA512:
+  metadata.gz: 2237ab42e1da6822a540b0a806a67da32155288aeb9a6fdb345ec85baf6b66e137b9b95745898166e9446405e07dbb4dcad3604929ad00e4042978e68282f180
+  data.tar.gz: c48de4d137fcb1030b8fede56e6189b439d58cd788c12a4ad70be84e31594dd7bb2c8dce361e1985245fcc778701894ae4562fbe18e0e3641a72dbfeb146062a

data/.gitignore

@@ -0,0 +1,19 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+test.rb
+Jobfile
+/.vagrant
+*.pem
+*.bak

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,22 @@
+language: ruby
+rvm:
+- 2.0.0
+before_install:
+- openssl aes-256-cbc -K $encrypted_3e901e83a832_key -iv $encrypted_3e901e83a832_iv
+  -in cronicle.us-east-1.pem.enc -out cronicle.us-east-1.pem -d
+install:
+- wget https://dl.bintray.com/mitchellh/vagrant/vagrant_1.7.2_x86_64.deb
+- sudo dpkg -i vagrant_1.7.2_x86_64.deb
+before_script:
+- vagrant plugin install vagrant-aws
+- vagrant up --provider=aws
+script:
+- bundle install
+- bundle exec rake
+after_script:
+- vagrant destroy -f
+env:
+  global:
+  - secure: CdUw5RJ8GXVCD5Orr+hP7tscfE1rNFyz2bnIqWj8jLCnxcLY7TqcV9v1z130uuU+keAyzAFIOPu1GHrr83Sgyo2MIwQkYfA52K1gB5ThzZXZQDSvGKJk3mtfvRkxJVmUxeCEZVC9QXKqR5WW15Cj7wBG4Y6dClty3zwyH7MtPI8=
+  - secure: gR/fjFSW81OtcnI8lQREfwj/EeW0YOsXOTUpZCPRdWaaIKGYmjB+6H+KgPcw1nGy+kknb5HXyOTLTSKOngC6WW1EaeKYzKqKGn8xlFGpFMmLCVXyDJG85ABr8jC768AltbYPYuUYb0JgX2PEMH1NNbCVaQqh8oUlBOjMrMqCbzk=
+  - EC2_KEYPAIR_NAME=cronicle.us-east-1

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Genki Sugawara
+
+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,127 @@
+# Cronicle
+
+It is a tool for execute script, and define cron on remote hosts.
+
+[![Gem Version](https://badge.fury.io/rb/cronicle.svg)](http://badge.fury.io/rb/cronicle)
+[![Build Status](https://travis-ci.org/winebarrel/cronicle.svg?branch=master)](https://travis-ci.org/winebarrel/cronicle)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cronicle'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cronicle
+
+## Usage
+
+```
+Commands:
+  cronicle apply           # Apply cron jobs to remote hosts
+  cronicle exec JOB_NAME   # Execute a job on remote hosts
+  cronicle help [COMMAND]  # Describe available commands or one specific command
+
+Options:
+  -f, [--file=FILE]                    # Job definition file
+                                       # Default: Jobfile
+  -h, [--hosts=HOSTS]                  # Hosts definition file
+  -r, [--target-roles=one two three]   # Target host role list
+  -p, [--sudo-password=SUDO-PASSWORD]  # Sudo password
+      [--dry-run], [--no-dry-run]      # Do not actually change
+  -c, [--ssh-config=SSH-CONFIG]        # OpenSSH configuration file
+      [--connection-timeout=N]         # SSH connection timeout
+      [--concurrency=N]                # SSH concurrency
+                                       # Default: 10
+      [--libexec=LIBEXEC]              # Cronicle libexec path
+                                       # Default: /var/lib/cronicle/libexec
+  -v, [--verbose], [--no-verbose]      # Verbose mode
+      [--debug], [--no-debug]          # Debug mode
+      [--color], [--no-color]          # Colorize log
+                                       # Default: true
+```
+
+## Quick Start
+
+```sh
+$ cat Jobfile
+on servers: :your_hostname do
+  job :my_job, user: "ec2-user", schedule: "* * * * *" do
+    puts "hello"
+  end
+end
+
+$ cronicle exec my_job
+my_job on your_hostname/ec2-user> Execute job
+my_job on your_hostname/ec2-user> hello
+
+$ cronicle apply --dry-run
+my_job on your_hostname/ec2-user> Create job: schedule="* * * * *" (dry-run)
+
+$ cronicle apply
+my_job on your_hostname/ec2-user> Create job: schedule="* * * * *"
+
+$ ssh your_hostname 'crontab -l'
+* * * * * /var/lib/cronicle/libexec/ec2-user/my_job 2>&1 | logger -t cronicle/ec2-user/my_job
+
+$ ssh your_hostname 'cat /var/lib/cronicle/libexec/ec2-user/my_job'
+#!/usr/bin/env ruby
+puts "hello"
+```
+
+## Hosts definition file
+
+Any of the following formats:
+
+```
+server1,server2,...
+```
+```
+server1
+server2
+...
+```
+```javascript
+{
+  "servers": {
+    "server1": ["web", "app"]
+    "server2": ["db"]
+  }
+}
+```
+```javascript
+{
+  "roles": {
+    "web": ["server1"],
+    "app": ["server1"],
+    "db": ["server2"]
+  }
+}
+```
+
+Hosts definition file is not required.
+
+If you pass `--hosts` options, can be defined as follows in Jobfile:
+
+```ruby
+on servers: /any_host/ do # use regexp
+  job :foo, user: "ec2-user", schedule: "* * * * *" do
+    3.times do
+      puts "hello"
+    end
+  end
+end
+
+on roles: "web" do # use role
+  job :my_job, user: "ec2-user", schedule: "* * * * *" do
+    puts "hello"
+  end
+end
+```

data/Rakefile

@@ -0,0 +1,5 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+task :default => :spec

data/Vagrantfile

@@ -0,0 +1,56 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+VAGRANTFILE_API_VERSION = "2"
+
+Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
+  config.vm.box = "dummy"
+  config.vm.box_url = "https://github.com/mitchellh/vagrant-aws/raw/master/dummy.box"
+
+  config.vm.synced_folder ".", "/vagrant", disabled: true
+
+  config.vm.define :amazon_linux do |machine|
+    machine.vm.provider :aws do |aws, override|
+      aws.access_key_id = ENV["AWS_ACCESS_KEY_ID"]
+      aws.secret_access_key = ENV["AWS_SECRET_ACCESS_KEY"]
+      aws.keypair_name = ENV["EC2_KEYPAIR_NAME"]
+      aws.instance_type = "m1.large"
+      aws.region = ENV["AWS_REGION"] || 'us-east-1'
+      aws.terminate_on_shutdown = true
+      aws.ami = ENV["AMAZON_LINUX_AMI"] || "ami-8e682ce6"
+
+      override.ssh.username = "ec2-user"
+      override.ssh.private_key_path = ENV["EC2_PRIVATE_KEY_PATH"] || ENV["EC2_KEYPAIR_NAME"] + ".pem"
+      override.ssh.pty = true
+
+      override.vm.provision "shell", inline: <<-SH
+echo cronicle | passwd --stdin ec2-user
+echo 'ec2-user ALL=(ALL) ALL' > /etc/sudoers.d/cloud-init
+      SH
+
+      override.vm.boot_timeout = 180
+    end
+  end
+
+  config.vm.define :ubuntu do |machine|
+    machine.vm.provider :aws do |aws, override|
+      aws.access_key_id = ENV["AWS_ACCESS_KEY_ID"]
+      aws.secret_access_key = ENV["AWS_SECRET_ACCESS_KEY"]
+      aws.keypair_name = ENV["EC2_KEYPAIR_NAME"]
+      aws.instance_type = "m1.large"
+      aws.region = ENV["AWS_REGION"] || 'us-east-1'
+      aws.terminate_on_shutdown = true
+      aws.ami = ENV['UBUNTU_AMI'] || "ami-84562dec"
+
+      override.ssh.username = "ubuntu"
+      override.ssh.private_key_path = ENV["EC2_PRIVATE_KEY_PATH"] || ENV["EC2_KEYPAIR_NAME"] + ".pem"
+      override.ssh.pty = true
+
+      override.vm.provision "shell", inline: <<-SH
+echo ubuntu:cronicle | chpasswd
+echo 'ubuntu ALL=(ALL) ALL' > /etc/sudoers.d/90-cloud-init-users
+      SH
+
+      override.vm.boot_timeout = 180
+    end
+  end
+end

data/bin/cronicle

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+$: << File.expand_path("#{File.dirname __FILE__}/../lib")
+require 'rubygems'
+require 'cronicle'
+
+Cronicle::CLI.start(ARGV)

data/cronicle.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cronicle/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'cronicle'
+  spec.version       = Cronicle::VERSION
+  spec.authors       = ['Genki Sugawara']
+  spec.email         = ['sgwr_dts@yahoo.co.jp']
+  spec.summary       = %q{It is a tool for execute script, and define cron on remote hosts.}
+  spec.description   = %q{It is a tool for execute script, and define cron on remote hosts.}
+  spec.homepage      = 'https://github.com/winebarrel/cronicle'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_dependency 'sourcify', '~> 0.6.0.rc4'
+  spec.add_dependency 'sshkit', '~> 1.6.1'
+  spec.add_dependency 'thor'
+  spec.add_dependency 'colorize'
+  spec.add_dependency 'parallel'
+  spec.add_dependency 'diffy'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '>= 3.0.0'
+  spec.add_development_dependency 'serverspec'
+end

data/lib/cronicle.rb

@@ -0,0 +1,28 @@
+require 'colorize'
+require 'diffy'
+require 'json'
+require 'parallel'
+require 'set'
+require 'shellwords'
+require 'singleton'
+require 'sourcify'
+require 'sshkit'
+require 'sshkit/dsl'
+require 'tempfile'
+require 'thor'
+
+module Cronicle; end
+require 'cronicle/ext/hash_ext'
+require 'cronicle/ext/string_ext'
+require 'cronicle/ext/sshkit_ext'
+require 'cronicle/logger'
+require 'cronicle/utils'
+require 'cronicle/client'
+require 'cronicle/cli'
+require 'cronicle/driver'
+require 'cronicle/dsl'
+require 'cronicle/dsl/context'
+require 'cronicle/dsl/context/job'
+require 'cronicle/exporter'
+require 'cronicle/host_list'
+require 'cronicle/version'

data/lib/cronicle/cli.rb

@@ -0,0 +1,105 @@
+class Cronicle::CLI < Thor
+  include Cronicle::Logger::Helper
+
+  class_option 'file',               :aliases => '-f', :desc => 'Job definition file',        :default => 'Jobfile'
+  class_option 'hosts',              :aliases => '-h', :desc => 'Hosts definition file'
+  class_option 'target-roles',       :aliases => '-r', :desc => 'Target host role list',      :type => :array
+  class_option 'sudo-password',      :aliases => '-p', :desc => 'Sudo password'
+  class_option 'dry-run',                              :desc => 'Do not actually change',     :type => :boolean, :default => false
+  class_option 'ssh-config',         :aliases => '-c', :desc => 'OpenSSH configuration file', :default => nil
+  class_option 'connection-timeout',                   :desc => 'SSH connection timeout',     :type => :numeric, :default => nil
+  class_option 'concurrency',                          :desc => 'SSH concurrency',            :type => :numeric, :default => Cronicle::Client::DEFAULTS[:concurrency]
+  class_option 'libexec',                              :desc => 'Cronicle libexec path',      :default => Cronicle::Client::DEFAULTS[:libexec]
+  class_option 'verbose',            :aliases => '-v', :desc => 'Verbose mode',               :type => :boolean, :default => false
+  class_option 'debug',                                :desc => 'Debug mode',                 :type => :boolean, :default => false
+  class_option 'color',                                :desc => 'Colorize log',               :type => :boolean, :default => true
+
+  def initialize(*args)
+    super
+
+    if options['debug']
+      Cronicle::Logger.instance.set_debug(true)
+    end
+
+    if not $stdin.tty? or not options['color']
+      String.disable_colorization = true
+    end
+  end
+
+  desc 'exec JOB_NAME', 'Execute a job on remote hosts'
+  def exec(job_name)
+    with_logging do
+      set_ssh_options
+      client.exec(jobfile, job_name)
+    end
+  end
+
+  desc 'apply', 'Apply cron jobs to remote hosts'
+  def apply
+    with_logging do
+      set_ssh_options
+      client.apply(jobfile)
+    end
+  end
+
+  private
+
+  def with_logging
+    begin
+      yield
+    rescue => e
+      if options['debug']
+        raise e
+      else
+        log(:error, e.message, :color => :red)
+      end
+    end
+  end
+
+  def client
+    Cronicle::Client.new(host_list, client_options)
+  end
+
+  def jobfile
+    file = options['file']
+
+    unless File.exist?(file)
+      raise Thor::Error, "No Jobfile found (looking for: #{file})"
+    end
+
+    file
+  end
+
+  def host_list
+    Cronicle::HostList.new(
+      options.fetch('hosts', ''),
+      host_list_options
+    )
+  end
+
+  def client_options
+    {
+      :sudo_password => options['sudo-password'],
+      :concurrency => options['concurrency'],
+      :libexec => options['libexec'],
+      :dry_run => options['dry-run'],
+      :verbose => options['verbose']
+    }
+  end
+
+  def host_list_options
+    {
+      :roles => options['target-roles']
+    }
+  end
+
+  def set_ssh_options
+    conn_timeout = options['connection-timeout']
+    ssh_config = options['ssh-config']
+
+    SSHKit::Backend::Netssh.configure do |ssh|
+      ssh.connection_timeout = conn_timeout if conn_timeout
+      ssh.ssh_options = {:config => ssh_config} if ssh_config
+    end
+  end
+end