capistrano-rails-artifact 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 22521537c54403392131a5708d7e1dcb107bb562
+  data.tar.gz: 95a16e59e2c3b934ec89ba678ddf7cf0400c5f96
+SHA512:
+  metadata.gz: 8c6b20785363b01cd92843bacc926a255d3aef35d8243ef8af591658912140f42cc6d2adc12abc8abc062fcf9da02328c1952eed1920919bc91e830c28038f96
+  data.tar.gz: bb23e28cee2c0e9b78e9e9d63a9c9a5435ab8dd145edac0e2211383fb297547aacbacc8045a875bd362b3e9e8a18b5511d7897a3c42d1baf513c28b40b2f4e8b

data/.capistrano/metrics

@@ -0,0 +1 @@
+none

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.vagrant

data/Capfile

@@ -0,0 +1,26 @@
+# Allows cap to have its config in 'test' to reduce confusion
+set :deploy_config_path, 'test/config/deploy.rb'
+set :stage_config_path, 'test/config/deploy'
+
+# Load DSL and Setup Up Stages
+require 'capistrano/setup'
+
+# Includes default deployment tasks
+require 'capistrano/deploy'
+
+# Includes tasks from other gems included in your Gemfile
+#
+# For documentation on these, see for example:
+#
+#   https://github.com/capistrano/rvm
+#   https://github.com/capistrano/rbenv
+#   https://github.com/capistrano/chruby
+#   https://github.com/capistrano/bundler
+#   https://github.com/capistrano/rails
+#
+# require 'capistrano/rvm'
+# require 'capistrano/rbenv'
+# require 'capistrano/chruby'
+# require 'capistrano/bundler'
+# require 'capistrano/rails/assets'
+# require 'capistrano/rails/migrations'

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Case Taintor
+
+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,63 @@
+# CapistranoRailsArtifact
+
+A gem to allow you to package your Rails app into a .tar.gz and deploy it easily. This works by creating a
+new type of 'scm' for Capistrano 3.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capistrano-rails-artifact'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capistrano-rails-artifact
+
+## Usage
+
+This gem assumes that you have a tar.gz file in an accessible place. This .tar.gz should contain all the gems
+vendored into vendor/bundle as well as the compiled assets. An example command to build this archive is:
+
+```sh
+export RAILS_ENV=production
+rm -rf vendor/bundle
+bundle install --without development test --deployment
+bundle exec rake assets:precompile
+echo `git rev-parse HEAD` > REVISION
+mkdir -p dist
+tar -cvzf dist/release.tar.gz --exclude .git --exclude log --exclude "./vendor/bundle/ruby/2.1.0/cache" --exclude "./vendor/bundle/ruby/2.1.0/doc" --exclude .envrc --exclude dist --exclude tmp --exclude coverage --exclude features --exclude spec --exclude vagrants --exclude Vagrantfile --exclude README.md .
+
+# TODO: put dist/release.tar.gz somewhere that is accessible from your application machines
+```
+
+In your `config/deploy.rb`, you just need to set two variables
+
+```ruby
+set :rails_artifact_archive_location, '<URL TO TAR GZ>'
+
+set :scm, :rails_artifact
+```
+
+## Testing
+
+Testing is done by spinning up a vagrant box, deploying to it, and then checking the result. You must
+have Virtualbox and Vagrant installed, then run:
+
+```sh
+bundle exec rake
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/ctaintor/capistrano-rails-artifact/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = "test/**/*_test.rb"
+end
+
+task :default => :test

data/Vagrantfile

@@ -0,0 +1,27 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+# Vagrantfile API/syntax version. Don't touch unless you know what you're doing!
+VAGRANTFILE_API_VERSION = "2"
+
+Vagrant.configure(VAGRANTFILE_API_VERSION) do |config|
+
+  config.vm.define "deploy_target" do |deploy_target|
+    deploy_target.vm.box = "CentOS-6.5-x86_64-v20140504.box"
+    deploy_target.vm.box_url = "https://developer.nrel.gov/downloads/vagrant-boxes/CentOS-6.5-x86_64-v20140504.box"
+    deploy_target.vbguest.auto_update = false
+    deploy_target.vm.provider "virtualbox" do |v|
+      v.memory = 512
+      v.cpus = 1
+    end
+    script = <<BLOCK
+#Creates a simple http server to server the files in '/vagrant/test'
+cd /vagrant/test;
+nohup python -m SimpleHTTPServer 8080 >/dev/null 2>&1 &
+sleep 5
+BLOCK
+    deploy_target.vm.provision "shell", inline: script
+    deploy_target.ssh.forward_agent = true
+  end
+
+end

data/capistrano-rails-artifact.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capistrano-rails-artifact/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "capistrano-rails-artifact"
+  spec.version       = CapistranoRailsArtifact::VERSION
+  spec.authors       = ["Case Taintor"]
+  spec.email         = ["case.taintor@klarna.com"]
+  spec.summary       = %q{A gem to allow you to deploy using a .tar.gz}
+  spec.description   = %q{A gem to allow you to deploy using a .tar.gz}
+  spec.homepage      = ""
+  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_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency "capistrano", "~> 3.0"
+end

data/lib/capistrano/rails_artifact.rb

@@ -0,0 +1,13 @@
+# This file will be included by default when someone sets the scm to be :rails_artifact
+
+load File.expand_path('../tasks/rails_artifact.rake', __FILE__)
+
+# These two tasks are unnecessary for this strategy
+Rake::Task['deploy:log_revision'].clear
+Rake::Task['deploy:set_current_revision'].clear
+namespace :deploy do
+  task :set_current_revision do
+  end
+  task :log_revision do
+  end
+end

data/lib/capistrano/tasks/rails_artifact.rake

@@ -0,0 +1,26 @@
+namespace :rails_artifact do
+  desc 'Check that the repo is reachable'
+  task :check do
+  end
+
+  desc 'Copy repo to releases'
+  task :create_release do
+    on release_roles :all do
+      archive_url = fetch(:rails_artifact_archive_location)
+      file_location = '/tmp/build-artifact-files/build-artifact.tar.gz'
+      execute :mkdir, '-p', File.dirname(file_location)
+      execute :rm, "-f #{file_location}"
+
+      execute :mkdir, '-p', release_path
+      execute :wget, "--no-check-certificate  -q -O '#{file_location}' '#{archive_url}'"
+      within release_path do
+        execute :tar, "-xzf '#{file_location}'"
+      end
+      execute :rm, file_location
+    end
+  end
+
+  desc 'Determine the revision that will be deployed'
+  task :set_current_revision do
+  end
+end

data/lib/capistrano-rails-artifact/version.rb

@@ -0,0 +1,3 @@
+module CapistranoRailsArtifact
+  VERSION = '1.0.0'
+end

data/lib/capistrano-rails-artifact.rb

@@ -0,0 +1 @@
+require_relative 'capistrano-rails-artifact/version'

data/test/capistrano-rails-artifact_test.rb

@@ -0,0 +1,83 @@
+require 'minitest/autorun'
+require 'sshkit'
+require 'sshkit/dsl'
+
+class CapistranoRailsArtifactSpec < MiniTest::Unit::TestCase
+  def setup
+    system("vagrant up")
+    configure_sshkit_for_vagrant
+  end
+
+  def teardown
+    #system("vagrant destroy -f")
+  end
+
+  # This is the sole test that is run. Of course it'd be nicer to have more tests, but each one adds
+  # time, so... meh
+  def test_deploy_works
+    puts "Deploying once"
+    result = `bundle exec cap testing deploy`
+    assert_equal true, $?.success?, "Deployment failed. Output was:\n#{result}"
+
+    check_file_and_permissions
+
+    puts "Deploying twice"
+    result = `bundle exec cap testing deploy`
+    assert_equal true, $?.success?, "2nd Deployment failed. Output was:\n#{result}"
+
+    puts "Deploying the last time"
+    result = `bundle exec cap testing deploy`
+    assert_equal true, $?.success?, "3rd Deployment failed - likely a permissions error. Output was:\n#{result}"
+
+    puts "Testing rollback"
+    result = `bundle exec cap testing deploy:rollback`
+    assert_equal true, $?.success?, "Rollback failed. Output was:\n#{result}"
+    check_only_one_release
+  end
+
+  def check_file_and_permissions
+    release_dir_writable = false
+    release_dir_readable = false
+    release_artifact_writable = false
+    release_artifact_readable = false
+    on('deploy_target') do
+      releases_dir = '/tmp/capistrano-rails-artifact/releases'
+      timestamp = capture("ls #{releases_dir}").lines[0].chomp
+      release_dir = File.join(releases_dir,timestamp)
+
+      release_dir_writable = test("[ -w #{release_dir} ]")
+      release_dir_readable= test("[ -r #{release_dir} ]")
+      release_artifact_writable = test("[ -w #{release_dir}/ARTIFACT ]")
+      release_artifact_readable = test("[ -r #{release_dir}/ARTIFACT ]")
+    end
+    assert_equal true, release_dir_writable, "release dir is not writable"
+    assert_equal true, release_dir_readable, "release dir is not readable"
+    assert_equal true, release_artifact_writable, "release artifact is not writable"
+    assert_equal true, release_artifact_readable, "release artifact is not readable"
+  end
+
+  def check_only_one_release
+    dirs_in_releases = []
+    on('deploy_target') do
+      dirs_in_releases = capture("ls /tmp/capistrano-rails-artifact/releases").lines.map(&:chomp)
+    end
+    assert_equal 1, dirs_in_releases.size
+  end
+
+  def configure_sshkit_for_vagrant
+    require 'tempfile'
+    tempfile = Tempfile.open('vagrant-ssh-config')
+
+    system("vagrant ssh-config > #{tempfile.path}")
+
+    unless $?.success?
+      puts "You need to `vagrant up` first!"
+      exit(1)
+    end
+
+    SSHKit.config.backend.configure do |config|
+      config.ssh_options = {config: tempfile.path}
+    end
+  end
+end
+

data/test/config/deploy/testing.rb

@@ -0,0 +1,17 @@
+role :app, %w{deploy_target}
+role :web, %w{deploy_target}
+
+# Sets up Capistrano to be able to deploy into your vagrant box
+require 'tempfile'
+tempfile = Tempfile.open('vagrant-ssh-config')
+
+system("vagrant ssh-config > #{tempfile.path}")
+
+unless $?.success?
+  puts "You need to `vagrant up` first!"
+  exit(1)
+end
+
+set :ssh_options, {
+    config: [tempfile.path]
+}

data/test/config/deploy.rb

@@ -0,0 +1,12 @@
+set :application, 'capistrano-rails-artifact'
+
+#The Vagrantfile used python to start a simple server serving contents of /vagrant/test (which is actually this project's test directory)
+set :rails_artifact_archive_location, 'http://127.0.0.1:8080/test-build-artifact.tar.gz'
+
+set :rails_artifact_group, 'rails_runners'
+
+set :deploy_to, '/tmp/capistrano-rails-artifact'
+
+set :scm, :rails_artifact
+
+set :keep_releases, 2 #we make this low so we can test that the cleanup of release dirs works

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-rails-artifact
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Case Taintor
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A gem to allow you to deploy using a .tar.gz
+email:
+- case.taintor@klarna.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".capistrano/metrics"
+- ".gitignore"
+- Capfile
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- Vagrantfile
+- capistrano-rails-artifact.gemspec
+- lib/capistrano-rails-artifact.rb
+- lib/capistrano-rails-artifact/version.rb
+- lib/capistrano/rails_artifact.rb
+- lib/capistrano/tasks/rails_artifact.rake
+- test/capistrano-rails-artifact_test.rb
+- test/config/deploy.rb
+- test/config/deploy/testing.rb
+- test/test-build-artifact.tar.gz
+homepage: ''
+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.4.8
+signing_key: 
+specification_version: 4
+summary: A gem to allow you to deploy using a .tar.gz
+test_files:
+- test/capistrano-rails-artifact_test.rb
+- test/config/deploy.rb
+- test/config/deploy/testing.rb
+- test/test-build-artifact.tar.gz