kanaveral 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e3d1bf221748c5b0ab3b62e41458e9ecc428248c
+  data.tar.gz: e5d33590b267ee7f9e3ee0e0b2013dda9b091435
+SHA512:
+  metadata.gz: 13f4f2122e85887ff3893a8862c5b7539dc25996cccc96a463f0fa40a656c57a0e7c7ed228e45261495b2d10152053386ca3f4e7d77fd971d911dac27be47ac9
+  data.tar.gz: c640ae85fbc14043fa16f5bd8c89e4e1a7201634a750d48deb6f7e90874c82b56e84ca7de510c58823000dc9cb9495eee900788f0ee851bafe8eda6eedcb1aff

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Philippe Cantin
+
+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,167 @@
+# Kanaveral
+
+Kanaveral is a flexible deployment/automation tool.
+Its purpose is for app deployment and/or server installation.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'kanaveral'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kanaveral
+
+## Usage
+
+You can see an example under /sample, commands.rb contains the commands you use and kanaveral.rb is 
+the deployment script itself which use commands.rb.
+
+The main file must be named kanaveral.rb.
+The DSL define 3 main instructions :
+
+- **commands** : indicate the path to load your commands.rb
+
+- **server** : define your servers (user, host, app root ...). Set password to true if you don't use ssh keys.
+
+- **deploy** contain the main instructions block to deploy your application, with **local** blocks for commands to 
+run locally and **remote** blocks for commands to run on remote server. You can save outputs of commands to be
+used later via the keyword to:. The output result string will be available via context variable passed to
+your lambda in commands.rb
+
+
+### Commands
+
+Simply define a command like that :
+
+```ruby
+command(<symbol>) do
+  command ->(context) { "my shell command where i get access to context" }
+  notice -> { "What i do"}
+end
+```
+if *notice* lambda is not present a default message is displayed. If you don't need
+context just skip lambda parameter.
+
+**Example**
+
+```ruby
+command(:bundler) do
+  command ->(context) { "cd #{context.server.root} && bundle" }
+  notice -> { "Run bundle" }
+end
+```
+
+
+With *context.server* you get your server configuration, *context.server.user*, *context.server.host* etc...
+
+You can also get variables you define in your deployment script via keyword to: (see after 'Deploy script')
+
+**Example**
+
+```ruby
+command(:newrelic) do
+  command ->(context) { "echo '#{context.commits}' | newrelic deployments -c" }
+end
+```
+
+*context.commits* contains the output of the command *run :changelog, to: :commits* (see after 'Deploy script') 
+
+### Deploy script
+```ruby
+Kanaveral::Base.deployer do
+  
+  #set the file where commands to be loaded
+  commands(File.join(File.dirname(__FILE__), 'commands.rb')) 
+  
+  #define server 1
+  server 'server-1' do |s| 
+    s.user = 'user'
+    s.host = 'myhost or ip'
+    s.root = '/home/www/application'
+    s.password = true
+  end
+  
+  #define server 1
+  server 'server-2' do |s|
+    s.user = 'user'
+    s.host = 'myhost'
+    s.root = '/home/www/application'
+    s.password = true
+  end
+   
+  #deploy commands for production servers  
+  deploy(:production) do
+    
+    #run commands locally
+    local do
+      run :changelog, to: :commits 
+      #save output to commits which will be available in you commands via context.commits
+      run :git_push
+    end
+
+	#run commands on server-1 and then server-2
+    remotes('server-1', 'server-2') do
+      run :git_pull
+      run :bundler
+      run :assets_precompile
+      run :unicorn_upgrade
+    end
+	
+	#then run commands on server-2 only
+    remote('server-2') do
+      run :delayed_job_restart
+    end
+    
+    #at least run a command which use context.commits (this push a deployment
+    notification to newrelic with changelog made from commits)
+    local do
+      run :newrelic
+    end 
+  end
+
+end
+
+```
+
+Then in order to run just run at the same path where your kanaveral.rb is: 
+
+	$ kanaveral -e production
+or 
+
+	$ bundle exec kanaveral -e production
+
+
+**NOTES**
+
+- **kanaveral command look for a file named kanaveral.rb at the path it is launched**
+
+- *context* and *server* are ruby OpenStruct so, you are free to define what you need. But user, host, root and
+password are reserved.
+
+## Todo
+
+- Some generic and often used commands included in gem which can be used for ie rails application deployment(bundler, git commands ...)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/anoiaque/kanaveral. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "kanaveral"
+
+# 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/kanaveral

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+require 'optparse'
+
+options = {}
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: kanaveral [options]"
+
+  opts.on("-e environment", "Environment for deploy ie production") do |v|
+    options[:env] = v
+  end
+  
+  opts.on('-h', "Help") { puts opts; exit }
+  opts.parse!
+end
+
+ENV['KANAVERAL_ENV'] = options[:env]
+require "#{Dir.pwd}/kanaveral.rb"

data/kanaveral.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kanaveral/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "kanaveral"
+  spec.version       = Kanaveral::VERSION
+  spec.authors       = ["Philippe Cantin"]
+  spec.email         = ["anoiaque@me.com"]
+
+  spec.summary       = %q{Simple application deployer}
+  spec.description   = %q{Simple application deployer}
+  spec.homepage      = "http://www.artizencoder.com"
+  spec.license       = "MIT"
+
+  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 'net-ssh'
+  spec.add_dependency 'rainbow'
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+end

data/lib/kanaveral.rb

@@ -0,0 +1,144 @@
+require "kanaveral/version"
+require 'ostruct'
+require 'net/ssh'
+require 'rainbow'
+require 'io/console'
+require 'kanaveral/extensions'
+require 'kanaveral/output'
+
+module Kanaveral
+  using Kanaveral::Extensions
+  
+  class MissingCommand < Exception
+    def initialize(command)
+      @command = command
+    end
+    
+    def message
+      "Missing command : #{@command}"
+    end
+  end
+  
+  class Command < OpenStruct
+    @@commands = {}
+    
+    def self.load path
+      class_eval(File.read(path))
+      @@commands
+    end
+    
+    def self.command tag, &block
+      cmd = new
+      cmd.instance_eval(&block)
+      cmd.tag = tag
+      cmd.msg ||= -> { "Run #{cmd.tag}" }
+      
+      @@commands[tag] = cmd
+    end
+    
+    def command cmd
+      self.cmd = cmd
+    end
+    
+    def notice msg
+      self.msg = msg
+    end
+    
+  end
+  
+  class Server < OpenStruct;end
+  
+  class Deploy
+    attr_accessor :local_commands, :remote_commands
+    
+    def initialize context
+      @context = context
+      @commands = @context.commands
+    end
+    
+    def local &block
+      instance_eval(&block)
+    end
+    
+    def remotes *names, &block
+      names.each do |name|
+        remote(name, &block)
+      end
+    end
+    
+    def remote name, &block
+      Kanaveral::Output.deploy(name)
+      
+      @server = @context.servers[name]
+      password = Kanaveral::Output.password(@server.name) if @server.password
+      args = [@server.host, @server.user]
+      args << { password: password } if password
+      
+      Net::SSH.start(*args) do |ssh|
+        @ssh = ssh
+        instance_eval(&block)
+      end
+      
+      @ssh = nil
+      @server = nil
+    end
+    
+    def run command, args={}
+      cmd = @commands[command]
+      raise MissingCommand.new(command) unless cmd
+      
+      cmd.context = @context
+      cmd.context.server = @server
+      
+      
+      Kanaveral::Output.command(kall(cmd.msg))
+
+      output = @ssh ? @ssh.exec!(kall(cmd.cmd)) : `#{kall(cmd.cmd)}`
+
+      @context.send("#{args[:to]}=", output) if args[:to]
+
+      Kanaveral::Output.cmd_output(output) unless @context.nooutput
+      output
+    end
+    
+    private
+    
+    def kall callee
+      callee.arity == 0 ? callee.call : callee.call(@context)
+    end
+    
+  end
+  
+  class Context < OpenStruct;end
+  
+  class Base 
+    ENV_KEY = 'KANAVERAL_ENV'
+    
+    def server name
+      @servers ||= {}
+      server = Server.new
+      server.name = name
+      yield server
+      @servers[name] = server
+    end
+    
+    def deploy env=:development, &block
+      Kanaveral::Output.warn("Environment : #{ENV[ENV_KEY] || 'Not set via KANAVERAL_ENV'}")
+      
+      return unless ENV[ENV_KEY] == env.to_s 
+
+      @context = Context.new(servers: @servers, commands: @commands)
+      @deployer = Deploy.new(@context)
+      @deployer.instance_eval(&block)
+    end
+    
+    def commands path
+      @commands = Command.load(path)
+    end
+  
+    def self.deployer &block
+      self.new.instance_eval(&block)
+    end
+    
+  end
+end

data/lib/kanaveral/extensions.rb

@@ -0,0 +1,9 @@
+module Kanaveral
+  module Extensions
+    refine String do
+      def camelize
+        split('_'.freeze).map(&:capitalize).join
+      end
+    end
+  end
+end

data/lib/kanaveral/output.rb

@@ -0,0 +1,53 @@
+module Kanaveral
+  module Output
+    
+    def self.password remote
+      ask "Password for #{remote} : "
+      password = STDIN.noecho(&:gets).chop
+      cr
+      password
+    end
+    
+    def self.cmd_output text
+      text ||= ''
+      cr
+      print Rainbow(text).cyan
+      cr
+    end
+    
+    def self.ask text
+      cr
+      print Rainbow(text).green
+    end
+    
+    def self.command text
+      cr
+      text = '-> ' + text
+      notice(text)
+    end
+    
+    def self.deploy name
+      cr
+      title = " Deploy to #{name} "
+      banner '-'*(title.length + 1)
+      banner title
+      banner '-'*(title.length + 1)
+    end
+    
+    def self.banner text
+      puts Rainbow(text).cyan
+    end
+    
+    def self.notice text
+      puts Rainbow(text).white
+    end
+    
+    def self.warn text
+      puts Rainbow(text).yellow.bright.underline
+    end
+    
+    def self.cr
+      puts "\n"
+    end
+  end
+end

data/lib/kanaveral/version.rb

@@ -0,0 +1,3 @@
+module Kanaveral
+  VERSION = "0.1.0"
+end

data/sample/commands.rb

@@ -0,0 +1,35 @@
+command(:changelog) do
+  command -> { "git log origin/master..master --format=short" }
+  notice -> { "Create changelog from commits" }
+end
+
+command(:git_push) do
+  command -> { "git push origin master" }
+  notice -> { "Push to origin/master" }
+end
+
+command(:git_pull) do
+  command -> { "git pull origin master" }
+  notice -> { "Pull from origin/master" }
+end
+
+command(:assets_precompile) do
+  command -> { "echo precompile assets" }
+end
+
+command(:unicorn_upgrade) do
+  command -> { "echo unicorns upgrade" }
+end
+
+command(:delayed_job_restart) do
+  command -> { "echo restart delayed job worker" }
+end
+
+command(:newrelic) do
+  command ->(context) { "echo '#{context.commits}' | newrelic deployments -c" }
+end
+
+command(:bundler) do
+  command ->(context) { ". ~/.profile && cd #{context.server.root} && bundle --quiet --without development test" }
+  notice -> { "Run Bundler install" }
+end

data/sample/kanaveral.rb

@@ -0,0 +1,44 @@
+require 'kanaveral'
+
+Kanaveral::Base.deployer do
+  
+  commands(File.join(File.dirname(__FILE__), 'commands.rb'))
+  
+  server 'server-1' do |s|
+    s.user = 'philippe'
+    s.host = 'philae'
+    s.root = '/home/www/application'
+    s.password = true
+  end
+  
+  server 'server-2' do |s|
+    s.user = 'philippe'
+    s.host = 'philae'
+    s.root = '/home/www/application'
+    s.password = true
+  end
+    
+  deploy(:production) do
+    
+    local do
+      run :changelog, to: :commits
+      run :git_push
+    end
+
+    remotes('server-1', 'server-2') do
+      run :git_pull
+      run :bundler
+      run :assets_precompile
+      run :unicorn_upgrade
+    end
+
+    remote('server-2') do
+      run :delayed_job_restart
+    end
+    
+    local do
+      run :newrelic
+    end 
+  end
+
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: kanaveral
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Philippe Cantin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: net-ssh
+  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: rainbow
+  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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple application deployer
+email:
+- anoiaque@me.com
+executables:
+- kanaveral
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/kanaveral
+- kanaveral.gemspec
+- lib/kanaveral.rb
+- lib/kanaveral/extensions.rb
+- lib/kanaveral/output.rb
+- lib/kanaveral/version.rb
+- sample/commands.rb
+- sample/kanaveral.rb
+homepage: http://www.artizencoder.com
+licenses:
+- MIT
+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.2.3
+signing_key: 
+specification_version: 4
+summary: Simple application deployer
+test_files: []
+has_rdoc: