travis-cli 0.0.1

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT LICENSE
+
+Copyright (c)  Sven Fuchs <svenfuchs@artweb-design.de>
+
+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,43 @@
+# Travis CLI
+
+Deployment tool for Travis CI
+
+Currently supports the following commands:
+
+    $ travis deploy [remote] # deploy to remote
+    $ travis config [remote] # sync the local config file from travis-keychain and push the config to remote
+
+The tool relies on git remotes being defined in `.git/config`. So, in order to deploy to production there needs to be a `production` remote repository defined in the git config.
+
+## Deployment
+
+Deploying to `staging` will just push to staging and run the migrations if `-m` was given. One can also pass `-c` in order to configure the app.
+
+    Deploying to production.
+    $ git push staging HEAD:master
+    Running migrations.
+    $ heroku run rake db:migrate -r staging
+
+Deploying to production will also update the production branch and tag the current commit.
+
+    Updating production branch.
+    $ git checkout production
+    $ git reset --hard master
+    $ git push origin production -f
+    Tagging deploy 2011-12-11 16:04.
+    $ git tag -a 'deploy.2011-12-11.16-04' -m 'deploy 2011-12-11 16:04'
+    $ git push --tags
+    $ git checkout master
+    Deploying to production.
+    $ git push production HEAD:master -f
+    Running migrations.
+    $ heroku run rake db:migrate -r production
+
+WARNING:
+
+The production branch is updated using `git reset --hard [branch]` and pushed using `git push origin production -f`.
+
+That means that all commits in the `production` branch that are not present in the target branch (e.g. `master`) will be removed from the history of `production`.
+
+**So never commit to the production branch directly!**
+

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rake'
+require 'rspec/core/rake_task'
+require 'tasks/standalone_migrations'
+
+desc 'Run specs'
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = './spec/**/*_spec.rb'
+end
+
+task :default => :spec

data/bin/travis

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+$: << File.expand_path('../../lib', __FILE__)
+
+require 'rubygems'
+require 'travis/cli'
+require 'thor/runner'
+
+klass, task = Thor::Util.find_class_and_task_by_namespace("travis:#{ARGV.shift}")
+ARGV.unshift(task) if task
+klass.start(ARGV, :shell => Thor::Base.shell.new)

data/lib/travis/cli.rb

@@ -0,0 +1,29 @@
+require 'thor'
+
+module Travis
+  autoload :Keychain, 'travis/keychain'
+
+  class Cli < Thor
+    autoload :Config, 'travis/cli/config'
+    autoload :Deploy, 'travis/cli/deploy'
+    autoload :Helper, 'travis/cli/helper'
+
+    namespace 'travis'
+
+    desc 'config', 'Sync config between keychain, app and local working directory'
+    method_option :restart, :aliases => '-r', :type => :boolean, :default => true
+    method_option :backup,  :aliases => '-b', :type => :boolean, :default => false
+
+    def config(remote)
+      Config.new(shell, remote, options).invoke
+    end
+
+    desc 'deploy', 'Deploy to the given remote'
+    method_option :migrate, :aliases => '-m', :type => :boolean, :default => false
+    method_option :configure, :aliases => '-c', :type => :boolean, :default => false
+
+    def deploy(remote)
+      Deploy.new(shell, remote, options).invoke
+    end
+  end
+end

data/lib/travis/cli/config.rb

@@ -0,0 +1,75 @@
+require 'shellwords'
+require 'yaml'
+
+module Travis
+  class Cli
+    class Config
+      include Helper
+
+      attr_reader :shell, :remote, :options
+
+      def initialize(shell, remote, options)
+        @remote = remote
+        @options = options
+        @shell = shell
+      end
+
+      def invoke
+        store
+        push
+        restart if restart?
+      end
+
+      protected
+
+        def app
+          @app ||= begin
+            app = File.basename(Dir.pwd).gsub('travis-', '')
+            app = 'web' if app == 'ci'
+            app
+          end
+        end
+
+        def config
+          @config ||= keychain.fetch
+        end
+
+        def keychain
+          @keychain ||= Keychain.new(app, shell)
+        end
+
+        def store
+          backup if backup?
+          File.open(filename, 'w+') { |f| f.write(config) }
+        end
+
+        def push
+          say 'Configuring the app ...'
+          config = Shellwords.escape(YAML.dump(YAML.load(self.config)[remote]))
+          run "heroku config:add travis_config=#{config} -r #{remote}", :echo => "heroku config:add travis_config=... -r #{app}"
+        end
+
+        def restart
+          say 'Restarting the app ...'
+          run "heroku restart -r #{remote}"
+        end
+
+        def backup
+          say 'Backing up the old config file ...'
+          run "cp #{filename} #{filename}.backup"
+        end
+
+        def restart?
+          !!options['restart']
+        end
+
+        def backup?
+          !!options['backup']
+        end
+
+        def filename
+          "config/travis.yml"
+        end
+    end
+  end
+end

data/lib/travis/cli/deploy.rb

@@ -0,0 +1,83 @@
+module Travis
+  class Cli
+    class Deploy
+      include Helper
+
+      attr_reader :shell, :remote, :options
+
+      def initialize(shell, remote, options)
+        @remote = remote
+        @options = options
+        @shell = shell
+      end
+
+      def invoke
+        if clean?
+          tag if remote == 'production'
+          configure if configure?
+          push
+          migrate if migrate?
+        else
+          error 'There are unstaged changes.'
+        end
+      end
+
+      protected
+
+        attr_reader :remote
+
+        def clean?
+          `git status`.include?('working directory clean')
+        end
+
+        def push
+          say "Deploying to #{remote}."
+          run "git push #{remote} HEAD:master -f".strip
+        end
+
+        def tag
+          say "Updating production branch."
+          with_branch('production') do |branch|
+            run "git reset --hard #{branch}"
+            run 'git push origin production -f'
+
+            say "Tagging #{version}."
+            run "git tag -a '#{version.gsub(':', '-').gsub(' ', '.')}' -m '#{version}'"
+            run 'git push --tags'
+          end
+        end
+
+        def with_branch(target)
+          current = branch
+          run "git checkout #{target}"
+          yield current
+          run "git checkout #{current}"
+        end
+
+        def branch
+          `git branch --no-color 2> /dev/null` =~ /\* (.*)$/ && $1
+        end
+
+        def version
+          @version ||= "deploy #{Time.now.utc.strftime('%Y-%m-%d %H:%M')}"
+        end
+
+        def configure?
+          !!options['configure']
+        end
+
+        def configure
+          Config.new(shell, remote, :restart => false).invoke
+        end
+
+        def migrate?
+          !!options['migrate']
+        end
+
+        def migrate
+          say 'Running migrations'
+          run "heroku run rake db:migrate -r #{remote}"
+        end
+    end
+  end
+end

data/lib/travis/cli/helper.rb

@@ -0,0 +1,23 @@
+module Travis
+  class Cli
+    module Helper
+      protected
+
+        def run(cmd, options = {})
+          cmd = cmd.strip
+          puts "$ #{options[:echo] || cmd}" unless options[:echo].is_a?(FalseClass)
+          exit unless system(cmd)
+        end
+
+        def say(message)
+          shell.say(message, :green)
+        end
+
+        def error(message)
+          message = shell.set_color(message, :red)
+          shell.error(message)
+          exit 1
+        end
+    end
+  end
+end

data/lib/travis/keychain.rb

@@ -0,0 +1,39 @@
+module Travis
+  class Keychain
+    include Cli::Helper
+
+    attr_reader :app, :shell, :dir
+
+    def initialize(app, shell, dir = '../travis-keychain')
+      @app = app
+      @shell = shell
+      @dir = File.expand_path(dir)
+    end
+
+    def fetch
+      chdir { pull }
+      read
+    end
+
+    protected
+
+      def pull
+        error 'There are unstaged changes in your travis-keychain working directory.' unless clean?
+        say 'Fetching the keychain ...'
+        run 'git pull'
+      end
+
+      def read
+        File.read(File.join(dir, "config/travis.#{app}.yml")) || ''
+      end
+
+      def chdir(&block)
+        FileUtils.mkdir_p(dir)
+        Dir.chdir(dir, &block)
+      end
+
+      def clean?
+        `git status`.include?('working directory clean')
+      end
+  end
+end

data/lib/travis_cli.rb

@@ -0,0 +1 @@
+require 'travis/cli'

data/lib/travis_cli/version.rb

@@ -0,0 +1,3 @@
+module TravisCli
+  VERSION = "0.0.1"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,34 @@
+ENV['RAILS_ENV'] = ENV['ENV'] = 'test'
+
+RSpec.configure do |c|
+  c.mock_with :mocha
+  c.before(:each) { Time.now.utc.tap { | now| Time.stubs(:now).returns(now) } }
+end
+
+require 'travis/cli'
+require 'mocha'
+
+module Mock
+  class Shell
+    def messages
+      @messages ||= []
+    end
+
+    def say(*args)
+      messages << args
+    end
+    alias :error :say
+  end
+end
+
+module Kernel
+  def capture_stdout
+    out = StringIO.new
+    $stdout = out
+    yield
+    return out.string
+  ensure
+    $stdout = STDOUT
+  end
+end
+

data/spec/travis/cli/config_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe Travis::Cli::Config do
+  let(:shell)  { Mock::Shell.new }
+  let(:config) { "staging:\n  foo: bar" }
+
+  before :each do
+    Travis::Cli::Config.any_instance.stubs(:clean?).returns(true)
+    Travis::Cli::Config.any_instance.stubs(:run)
+    Travis::Keychain.any_instance.stubs(:fetch).returns(config)
+    File.stubs(:open)
+  end
+
+  describe 'sync' do
+    it 'fetches the config from the keychain' do
+      command = Travis::Cli::Config.new(shell, 'staging', {})
+      command.send(:keychain).expects(:fetch).returns(config)
+      command.invoke
+    end
+
+    it 'writes the config to the local config file' do
+      command = Travis::Cli::Config.new(shell, 'staging', {})
+      File.expects(:open).with { |path, mode| path =~ %r(config/travis.yml) }
+      command.invoke
+    end
+
+    it 'pushes the config to the given heroku remote' do
+      command = Travis::Cli::Config.new(shell, 'staging', {})
+      command.expects(:run).with { |cmd, options| cmd =~ /heroku config:add travis_config=.* -r staging/m }
+      command.invoke
+    end
+
+    it 'restarts the app when --restart is given' do
+      command = Travis::Cli::Config.new(shell, 'staging', 'restart' => true)
+      command.expects(:restart)
+      command.invoke
+    end
+
+    it 'does not restart the app when --restart is not given' do
+      command = Travis::Cli::Config.new(shell, 'staging', {})
+      command.expects(:restart).never
+      command.invoke
+    end
+  end
+end

data/spec/travis/cli/deploy_spec.rb

@@ -0,0 +1,110 @@
+require 'spec_helper'
+
+describe Travis::Cli::Deploy do
+  let(:shell)  { Mock::Shell.new }
+
+  before :each do
+    $stdout = StringIO.new
+    Travis::Cli::Deploy.any_instance.stubs(:clean?).returns(true)
+    Travis::Cli::Deploy.any_instance.stubs(:branch).returns('master')
+    File.stubs(:open)
+  end
+
+  after :each do
+    $stdout = STDOUT
+  end
+
+  describe 'with a clean working directory' do
+    describe 'given remote "production"' do
+      let(:command) { Travis::Cli::Deploy.new(shell, 'production', {}) }
+
+      before :each do
+        command.stubs(:system).returns(true)
+      end
+
+      it 'switches to the production branch' do
+        command.expects(:system).with('git checkout production').returns(true)
+        command.invoke
+      end
+
+      it 'resets the production branch to the current branch' do
+        command.expects(:system).with('git reset --hard master').returns(true)
+        command.invoke
+      end
+
+      it 'pushes the production branch to origin' do
+        command.expects(:system).with('git push origin production -f').returns(true)
+        command.invoke
+      end
+
+      it 'switches back to the previous branch' do
+        command.expects(:system).with('git checkout master').returns(true)
+        command.invoke
+      end
+
+      it 'tags the current commit ' do
+        command.expects(:system).with { |cmd| cmd =~ /git tag -a 'deploy.*' -m 'deploy.*'/ }.returns(true)
+        command.invoke
+      end
+
+      it 'pushes the tag to origin' do
+        command.expects(:system).with('git push --tags').returns(true)
+        command.invoke
+      end
+
+      it 'pushes to the given remote' do
+        command.expects(:system).with('git push production HEAD:master -f').returns(true)
+        command.invoke
+      end
+    end
+
+    describe 'given the remote "staging"' do
+      let(:command) { Travis::Cli::Deploy.new(shell, 'staging', {}) }
+
+      before :each do
+        command.stubs(:system).returns(true)
+      end
+
+      it 'does not switch to the production branch' do
+        command.expects(:system).with('git checkout production').never
+        command.invoke
+      end
+
+      it 'does not tag the current commit if the given remote is "staging"' do
+        command.expects(:system).with { |cmd| cmd =~ /git tag -a 'deploy .*' -m 'deploy .*'/ }.never
+        command.invoke
+      end
+
+      it 'pushes to the given remote' do
+        command.expects(:system).with('git push staging HEAD:master -f').returns(true)
+        command.invoke
+      end
+    end
+
+    it 'migrates the database if --migrate is given' do
+      command = Travis::Cli::Deploy.new(shell, 'production', 'migrate' => true)
+      command.stubs(:system).returns(true)
+      command.expects(:system).with('heroku run rake db:migrate -r production').returns(true)
+      command.invoke
+    end
+
+    it 'configures the application if --configure is given' do
+      command = Travis::Cli::Deploy.new(shell, 'production', 'configure' => true)
+      command.stubs(:system).returns(true)
+      command.expects(:configure)
+      command.invoke
+    end
+  end
+
+  describe 'with a dirty working directory' do
+    before :each do
+    end
+
+    it 'outputs an error message' do
+      command = Travis::Cli::Deploy.new(shell, 'production', {})
+      command.stubs(:clean?).returns(false)
+      command.expects(:error).with('There are unstaged changes.')
+      command.invoke
+    end
+  end
+end

data/spec/travis/keychain_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe Travis::Keychain do
+  let(:shell)    { stub('shell', :say => nil, :error => nil) }
+  let(:keychain) { Travis::Keychain.new('hub', shell) }
+
+  before :each do
+    keychain.stubs(:system).returns(true)
+    keychain.stubs(:`)
+    keychain.stubs(:clean?).returns(true)
+    File.stubs(:read)
+  end
+
+  def fetch
+    capture_stdout do
+      keychain.fetch
+    end
+  end
+
+  describe 'fetch' do
+    it 'changes to the keychain directory' do
+      Dir.expects(:chdir).with { |path| path =~ %r(/travis-keychain$) }
+      fetch
+    end
+
+    it 'errors if the working directory is dirty' do
+      keychain.stubs(:clean?).returns(false)
+      keychain.expects(:error).with('There are unstaged changes in your travis-keychain working directory.')
+      fetch
+    end
+
+    it 'pulls changes from origin' do
+      keychain.expects(:run).with('git pull')
+      fetch
+    end
+
+    it 'reads the configuration' do
+      File.expects(:read).with { |path| path =~ %r(config/travis.hub.yml$) }
+      fetch
+    end
+  end
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: travis-cli
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Travis CI
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-11 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: &70356498144940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70356498144940
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70356498144320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70356498144320
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &70356498143500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70356498143500
+description: ! '[description]'
+email: contact@travis-ci.org
+executables:
+- travis
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/travis/cli/config.rb
+- lib/travis/cli/deploy.rb
+- lib/travis/cli/helper.rb
+- lib/travis/cli.rb
+- lib/travis/keychain.rb
+- lib/travis_cli/version.rb
+- lib/travis_cli.rb
+- spec/spec_helper.rb
+- spec/travis/cli/config_spec.rb
+- spec/travis/cli/deploy_spec.rb
+- spec/travis/keychain_spec.rb
+- Gemfile
+- LICENSE
+- Rakefile
+- README.md
+- bin/travis
+homepage: https://github.com/travis-ci/travis-cli
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: ! '[none]'
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: ! '[summary]'
+test_files: []
+has_rdoc: