rails_deployer 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7b502a8937a57384ae06cc336a20186aa8ff676a
+  data.tar.gz: 02fdbeb08baa1f0aef75c05ff97983c3278596b9
+SHA512:
+  metadata.gz: 7ad826f9f28f2d27ab2c4f5b66812137437652cc3bd0643ce9458aa15d992f80fcfe2942a65e4a0465303a0b722642d047d72eb32fdfd0f622fc2565f6103b58
+  data.tar.gz: ce4811d904694d437f20efcff0991b1656ff36c5969536976da9c5ce454fdf7e6ee0c4119f68540987f3b2e1c77bd32515284896664a27aa995e4de28df5e035

data/.gitignore

@@ -0,0 +1,22 @@
+.DS_Store
+.idea
+pkg/*
+
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/.rubocop.yml

@@ -0,0 +1,5 @@
+Metrics/AbcSize:
+  Max: 18
+
+Metrics/LineLength:
+  Max: 100

data/.ruby-version

@@ -0,0 +1 @@
+2.2.2

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'rspec', group: :test
+
+# Specify your gem's dependencies in kp-rails-deployer.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,51 @@
+PATH
+  remote: .
+  specs:
+    rails_deployer (0.1.1)
+      net-ssh (~> 2.6, >= 2.6.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.1.0)
+    astrolabe (1.3.1)
+      parser (~> 2.2)
+    diff-lcs (1.2.5)
+    net-ssh (2.9.2)
+    parser (2.2.2.6)
+      ast (>= 1.1, < 3.0)
+    powerpack (0.1.1)
+    rainbow (2.0.0)
+    rake (10.4.2)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    rubocop (0.32.1)
+      astrolabe (~> 1.3)
+      parser (>= 2.2.2.5, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.4)
+    ruby-progressbar (1.7.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rails_deployer!
+  rake (~> 10.3, >= 10.3.2)
+  rspec
+  rubocop
+
+BUNDLED WITH
+   1.10.6

data/README.md

@@ -0,0 +1,25 @@
+# Rails deployer
+
+Contains common rake tasks for being able to deploy to heroku or bring's own systems
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rails_deployer', git: 'git@github.com:bring/kp-rails-deployer.git'
+
+And then execute:
+
+    $ bundle
+
+## Clone this gem
+
+	git clone git@github.com:bring/kp-rails-deployer.git
+
+## Usage examples
+
+    rake qa:deploy
+    rake qa:deploy branch=topic_branch
+    
+    rake production:deploy
+    rake production:deploy branch=topic_branch

data/Rakefile

@@ -0,0 +1,23 @@
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new
+RuboCop::RakeTask.new
+
+task default: [:spec, :rubocop]
+
+module RuboCop
+  module Cop
+    module Style
+      # Enforce double indent on continued lines
+      class MultilineOperationIndentation
+        def correct_indentation(*)
+          configured_indentation_width * 2
+        end
+      end
+    end
+  end
+end

data/lib/rails_deployer.rb

@@ -0,0 +1,4 @@
+require 'rails_deployer/version'
+require 'rails_deployer/common'
+require 'rails_deployer/bring'
+require 'rails_deployer/heroku'

data/lib/rails_deployer/bring.rb

@@ -0,0 +1,44 @@
+require_relative 'common'
+
+module RailsDeployer
+  # Operations specific to the Bring operational environment
+  module Bring
+    include RailsDeployer::Common
+
+    def change_branch(env)
+      Net::SSH.start(env[:host], env[:user]) do |ssh|
+        say "Checking out the branch we are deploying: #{env[:branch]}"
+        ssh.exec("cd #{env[:remote_path]} && git checkout #{env[:branch]}")
+      end
+    end
+
+    def make_env(app_name, rails_env)
+      branch = ENV['branch'] || 'master'
+      suffix = ("_#{rails_env}" if rails_env != 'production')
+      user = 'posten'
+      host = rails_env == 'production' ? 'posap408.unix.cosng.net' : 'posap413.unix.cosng.net'
+      {
+          branch: branch,
+          host: host,
+          http_proxy: 'http://proxy.ergogroup.no:3128',
+          push_to_repo: "#{user}@#{host}:/var/apps/#{app_name}#{suffix}/.git",
+          rails_env: rails_env,
+          remote_path: "/var/apps/#{app_name}#{suffix}",
+          user: user,
+          wheneverize: true,
+      }
+    end
+
+    def deploy(app_name, rails_env)
+      env = make_env(app_name, rails_env)
+      pp env
+      upload(env)
+      change_branch(env)
+      install_bundle(env)
+      precompile_assets(env)
+      migrate(env)
+      seed(env, :seed => (ENV['seed'] == 'true'))
+      restart(env)
+    end
+  end
+end

data/lib/rails_deployer/bring/rake.rb

@@ -0,0 +1,27 @@
+module RailsDeployer::Bring::Rake
+  extend RailsDeployer::Bring
+  extend ::Rake::DSL
+
+  def self.define_tasks(app_name)
+    namespace :deploy do
+      [:qa, :production].each do |app_env|
+
+        desc "deploy to #{app_env} with optional arguments [branch=branchname] and [seed=true] to load data from seeds.rb"
+        task(app_env) { deploy(app_name, app_env.to_s) }
+
+        namespace app_env do
+          desc 'Initialize the server environment'
+          task :initialize do
+            env = make_env(app_name, app_env.to_s)
+            Net::SSH.start(env[:host], env[:user]) do |ssh|
+              puts 'Create app directory'
+              ssh.exec("mkdir -p #{env[:remote_path]}")
+              puts 'Initialize the GIT repo'
+              ssh.exec("cd #{env[:remote_path]} && git init && git config receive.denyCurrentBranch=ignore")
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rails_deployer/common.rb

@@ -0,0 +1,143 @@
+require 'net/ssh'
+
+module RailsDeployer
+  # Common deployment tasks
+  # All methods takes in a environment hash with possible arguments
+  #   :push_to_repo             => the remote repo
+  #   :host                     => the remote host
+  #   :user                     => the user to the remote host
+  #   :rails_env                => the rails environment being used
+  #   :remote_path              => the remote path
+  #   :branch                   => the branch to deploy
+  #   :queue_script_path        => the path to the queue init script
+  #   :local_path               => the path for local chechout of repo (used by kp-miniapp-deploy)
+  #   :name                     => the name of the application
+  #   :http_proxy               => the proxy to use when doing external requests
+  #   :rails_relative_url_root  => assets precompile with relative url
+  module Common
+    RBENV = '~/.rbenv/bin/rbenv exec'
+    BUNDLE = "#{RBENV} bundle"
+    RAKE = "#{BUNDLE} exec rake"
+
+    def checkout(env)
+      say "Fetching latest of #{get_name(env)} from Github"
+      system("#{set_proxy(env)} #{cd_to_local(env[:local_path])} git pull origin #{env[:branch]}")
+    end
+
+    def upload(env)
+      say 'Pushing git repo'
+      system("#{cd_to_local(env[:local_path])} git push --mirror #{env[:push_to_repo]}")
+    end
+
+    def seed(env, opts)
+      unless opts[:seed]
+        say "Not seeding since you did not specify 'seed=true'"
+        return
+      end
+
+      Net::SSH.start(env[:host], env[:user]) do |ssh|
+        say 'Seeding database'
+        ssh.exec("cd #{env[:remote_path]} && #{RAKE} db:seed #{set_env(env)}")
+      end
+    end
+
+    def migrate(env)
+      Net::SSH.start(env[:host], env[:user]) do |ssh|
+        say 'Migrating database'
+        ssh.exec("cd #{env[:remote_path]} && #{RAKE} db:migrate #{set_env(env)}")
+      end
+    end
+
+    def install_bundle(env)
+      Net::SSH.start(env[:host], env[:user]) do |ssh|
+        say 'installing bundle'
+        bundle_command = "#{BUNDLE} install --without=test development cucumber --deployment"
+        ssh.exec("#{set_proxy(env)} cd #{env[:remote_path]} && #{bundle_command}")
+      end
+    end
+
+    def precompile_assets(env)
+      Net::SSH.start(env[:host], env[:user]) do |ssh|
+        say 'precompiling assets bundle'
+        ssh.exec("cd #{env[:remote_path]} && #{RAKE} assets:precompile #{set_env(env)} #{set_precompile_relative_url(env)}")
+      end
+    end
+
+    def restart(env)
+      say 'Restarting...'
+      Net::SSH.start(env[:host], env[:user]) do |ssh|
+        say "removing #{env[:remote_path]}/tmp/restart.txt before running a touch"
+        ssh.exec("rm -v #{env[:remote_path]}/tmp/restart.txt")
+      end
+      # run in two different sessions to make sure they are run after
+      # each other so that restart.txt is not removed AFTER it was touched
+      Net::SSH.start(env[:host], env[:user]) do |ssh|
+        say "touching #{env[:remote_path]}/tmp/restart.txt"
+        ssh.exec("touch #{env[:remote_path]}/tmp/restart.txt")
+      end
+    end
+
+    def update_crontab(env)
+      return unless env[:wheneverize]
+      say 'Updating crontab..'
+      Net::SSH.start(env[:host], env[:user]) do |ssh|
+        say "running whenever command in #{env[:remote_path]}"
+        bundle_command = "#{BUNDLE} exec whenever --set environment=#{env[:rails_env]}"
+        ssh.exec("cd #{env[:remote_path]} && #{bundle_command} --update-crontab")
+      end
+    end
+
+    def restart_queue(env)
+      return if env[:queue_script_path].nil? || env[:queue_script_path].empty?
+      kp_forms_queue_script = "#{env[:queue_script_path]}-#{env[:rails_env]}"
+
+      say "Restarting #{get_name(env)} sidekiq queue.."
+      Net::SSH.start(env[:host], env[:user]) do |ssh|
+        ssh.exec("#{kp_forms_queue_script} quiet")
+        ssh.exec("#{kp_forms_queue_script} stop")
+      end
+      Net::SSH.start(env[:host], env[:user]) do |ssh|
+        ssh.exec("#{kp_forms_queue_script} start")
+      end
+    end
+
+    def restart_websocket(env)
+      return unless env[:restart_websocket]
+      say 'Restarting websocket'
+      Net::SSH.start(env[:host], env[:user]) do |ssh|
+        say "running whenever command in #{env[:remote_path]}"
+        command_context = "cd #{env[:remote_path]} && RAILS_ENV=#{env[:rails_env]}"
+        ssh.exec("#{command_context} #{RAKE} websocket_rails:stop_server")
+        ssh.exec("#{command_context} #{RAKE} websocket_rails:start_server")
+      end
+    end
+
+    def cd_to_local(local_path)
+      "cd #{local_path} &&" if local_path
+    end
+
+    def say(message)
+      puts message
+    end
+
+    def get_name(env)
+      env.fetch('name', 'application')
+    end
+
+    def set_env(env) # rubocop:disable Style/AccessorMethodName
+      "RAILS_ENV=#{env[:rails_env]} RACK_ENV=#{env[:rails_env]}"
+    end
+
+    def set_precompile_relative_url(env)
+      return unless env[:rails_relative_url_root]
+      "RAILS_RELATIVE_URL_ROOT=#{env[:rails_relative_url_root]}"
+    end
+
+    def set_proxy(env) # rubocop:disable Style/AccessorMethodName
+      return '' if env[:http_proxy].nil? || env[:http_proxy].empty?
+      exports = "export https_proxy=#{env[:https_proxy]}; export http_proxy=#{env[:http_proxy]}"
+      git_config = "git config --global http.proxy #{env[:http_proxy]}"
+      "#{exports} ; #{git_config} &&"
+    end
+  end
+end

data/lib/rails_deployer/heroku.rb

@@ -0,0 +1,8 @@
+require_relative 'common'
+
+module RailsDeployer
+  # Deployment setup for Heroku
+  module Heroku
+    include RailsDeployer::Common
+  end
+end

data/lib/rails_deployer/version.rb

@@ -0,0 +1,4 @@
+# Name space for Bring Rails Deployment
+module RailsDeployer
+  VERSION = '0.1.1'
+end

data/rails_deployer.gemspec

@@ -0,0 +1,25 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rails_deployer/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = 'rails_deployer'
+  spec.version     = RailsDeployer::VERSION
+  spec.date        = '2013-04-10'
+  spec.summary     = 'Common rails deployment tasks for konsernportalen'
+  spec.description = 'Common rails deployment tasks for konsernportalen'
+  spec.authors     = ['Hans-Christian Fjeldberg']
+  spec.email       = 'hcf@bekk.no'
+  spec.homepage    = 'http://posten.no'
+  spec.metadata.delete('allowed_push_host') # use this gem from GH source
+
+  spec.files       = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  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 'net-ssh', '~> 2.6', '>= 2.6.1'
+
+  spec.add_development_dependency 'rake', '~> 10.3', '>= 10.3.2'
+  spec.add_development_dependency 'rubocop'
+end

data/spec/rails_deployer/bring_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe RailsDeployer::Bring do
+  include_context 'shared'
+  it 'has the correct methods' do
+    expect(RailsDeployer::Bring.public_method_defined? :change_branch).to be true
+    common_methods.each do |method|
+      expect(RailsDeployer::Bring.public_method_defined? method).to be true
+    end
+  end
+end

data/spec/rails_deployer/common_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe RailsDeployer::Common do
+  include_context 'shared'
+  it 'has the correct methods' do
+    common_methods.each do |method|
+      expect(RailsDeployer::Common.public_method_defined? method).to be true
+    end
+  end
+end

data/spec/rails_deployer/heroku_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe RailsDeployer::Heroku do
+  include_context 'shared'
+  it 'has the correct methods' do
+    common_methods.each do |method|
+      expect(RailsDeployer::Heroku.public_method_defined? method).to be true
+    end
+  end
+end

data/spec/rails_deployer/version_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+describe RailsDeployer do
+  it 'VERSION constant should have major-, minor- and build- or git SHA1-version or jenkins' do
+    expect(RailsDeployer::VERSION)
+        .to match(/\d+\.\d+\.(\d+|\h{5,40}|jenkins-kp-rails-deployer-\d+)/)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'rails_deployer'
+
+Dir[('./spec/support/**/*.rb')].each { |file| require file }
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  config.fail_fast = true
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  # --seed 1234
+  config.order = 'random'
+end

data/spec/support/contexts/shared_context.rb

@@ -0,0 +1,9 @@
+RSpec.shared_context 'shared' do
+  let(:common_methods) do
+    %i(
+      checkout upload seed migrate install_bundle precompile_assets restart
+      update_crontab restart_queue restart_websocket cd_to_local say get_name
+      set_env set_proxy
+    )
+  end
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: rails_deployer
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Hans-Christian Fjeldberg
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: net-ssh
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.3.2
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: Common rails deployment tasks for konsernportalen
+email: hcf@bekk.no
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/rails_deployer.rb
+- lib/rails_deployer/bring.rb
+- lib/rails_deployer/bring/rake.rb
+- lib/rails_deployer/common.rb
+- lib/rails_deployer/heroku.rb
+- lib/rails_deployer/version.rb
+- rails_deployer.gemspec
+- spec/rails_deployer/bring_spec.rb
+- spec/rails_deployer/common_spec.rb
+- spec/rails_deployer/heroku_spec.rb
+- spec/rails_deployer/version_spec.rb
+- spec/spec_helper.rb
+- spec/support/contexts/shared_context.rb
+homepage: http://posten.no
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Common rails deployment tasks for konsernportalen
+test_files:
+- spec/rails_deployer/bring_spec.rb
+- spec/rails_deployer/common_spec.rb
+- spec/rails_deployer/heroku_spec.rb
+- spec/rails_deployer/version_spec.rb
+- spec/spec_helper.rb
+- spec/support/contexts/shared_context.rb
+has_rdoc: