capistrano-foreman_export 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ef81705c7a150367ed8dc5ec5cdc348c189bb8e3
+  data.tar.gz: 4c17528f1861a2987a22e5c39d223cef11f7c95b
+SHA512:
+  metadata.gz: 9ab0eed418a5fb34d6a78e3d02006db6642e437d9c64cae41638eb1779e7302adec2f13c2fc3d48d0fa39c58110b4b396bd182238eedd481ec20df79b544507f
+  data.tar.gz: ef50c02950ee766bdd60212ebdc8377257be3d0f795975df78c7933ee1851b70e8f66a000cbe576f10a9ec3306f59cb0d92abab7ef16184b6fa639b6b000f357

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Katsuma Ito
+
+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,81 @@
+# Capistrano::ForemanExport
+
+Capistrano task for foreman. Supervisord is supported.
+Export supervisord configuration from Procfile using `foreman export`. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'capistrano-foreman_export'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capistrano-foreman_export
+
+
+## Usage
+
+Add this line to your `Capfile`:
+
+    require 'capistrano/foreman_export'
+
+If you want to restart the application after deploy, add this line to your `config/deploy.rb`:
+
+    after 'deploy', 'foreman:export'
+    after 'deploy', 'foreman:restart'
+
+Configurable options:
+
+    set :foreman_backend, Capistrano::ForemanExport::Backend::Supervisord
+    set :foreman_roles, :app
+    set :foreman_port, 5000
+    set :foreman_output, '/etc/supervisor.d'
+    set :foreman_root, -> { release_path }
+    set :foreman_app, -> { fetch(:application) }
+    set :foreman_procfile, -> { release_path.join('Procfile') }
+    set :foreman_log, -> { release_path.join('log') }
+    set :foreman_user, 'nginx'
+    set :foreman_env_variables, { RAILS_ENV: 'development', FOO: 'Bar' }
+
+This would be:
+
+    $ cat /my_app/shared/RUNTIME_ENV
+    RAILS_ENV=development
+    FOO=Bar
+
+    $ bundle exec foreman export supervisord /etc/supervisor.d \
+    --port 5000 \
+    --root /my_app/releases/201409081122 \
+    --app my_app \
+    --procfile /my_app/releases/201409081122/Procfile \
+    --log /my_app/releases/201409081122/log \
+    --env /my_app/shared/RUNTIME_ENV,/my_app/releases/201409081122/.env \
+    --user nginx
+
+### Environment Variables
+
+    # This translates to SOME_ENV_VARIABLES=1 and save to RUNTIME_ENV file.
+    set :foreman_env_variables, { some_env_variables: 1 }
+
+## Capistrano Tasks
+
+Export supervisord configuration from Procfile:
+
+    cap foreman:export
+
+(Restart|Start|Stop) the applications:
+
+    cap foreman:(restart|start|stop)
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/capistrano-foreman_export.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capistrano/foreman_export/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "capistrano-foreman_export"
+  spec.version       = Capistrano::ForemanExport::VERSION
+  spec.authors       = ["Katsuma Ito"]
+  spec.email         = ["katsumai@gmail.com"]
+  spec.description   = %q{Capistrano task for foreman}
+  spec.summary       = %q{Capistrano task for foreman}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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 'capistrano', '~> 3.2'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/capistrano/foreman_export.rb

@@ -0,0 +1 @@
+load File.expand_path('../tasks/foreman.cap', __FILE__)

data/lib/capistrano/foreman_export/backend.rb

@@ -0,0 +1 @@
+require 'capistrano/foreman_export/backend/supervisord'

data/lib/capistrano/foreman_export/backend/supervisord.rb

@@ -0,0 +1,46 @@
+
+module Capistrano
+  module ForemanExport
+    module Backend
+      class Supervisord
+
+        def name
+          "supervisord"
+        end
+
+        def start_cmd(app_name)
+          wrap_bash <<-CMD
+          #{shell_add_if_new(app_name)}
+          supervisorctl start #{app_name}:*
+          CMD
+        end
+
+        def stop_cmd(app_name)
+          wrap_bash <<-CMD
+          supervisorctl stop #{app_name}:*
+          CMD
+        end
+
+        def restart_cmd(app_name)
+          wrap_bash <<-CMD
+          #{shell_add_if_new(app_name)}
+          supervisorctl restart #{app_name}:*
+          CMD
+        end
+
+        def shell_add_if_new(app_name)
+          "supervisorctl reread;  sleep 3; supervisorctl status | grep -w -- '#{app_name}' | grep -qv grep || supervisorctl add #{app_name}"
+        end
+
+        def wrap_bash(cmd)
+          "/bin/bash -c \"#{undent(cmd)}\""
+        end
+
+        def undent(str)
+          # from https://github.com/msmorgan/homebrew/blob/master/Library/Homebrew/extend/string.rb
+          str.gsub(/^.{#{str.slice(/^ +/).length}}/, '')
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/foreman_export/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module ForemanExport
+    VERSION = "0.0.2"
+  end
+end

data/lib/capistrano/tasks/foreman.cap

@@ -0,0 +1,77 @@
+require 'capistrano/foreman_export/backend'
+
+namespace :load do
+  task :defaults do
+    set :foreman_backend, Capistrano::ForemanExport::Backend::Supervisord
+    set :foreman_roles, :app
+    set :foreman_port, 5000
+    set :foreman_root, -> { release_path }
+    set :foreman_app, -> { fetch(:application) }
+    set :foreman_procfile, -> { release_path.join('Procfile') }
+    set :foreman_log, -> { release_path.join('log') }
+    set :foreman_user, 'nginx'
+    set :foreman_env_variables, {}
+    set :foreman_output, '/etc/supervisor.d'
+  end
+end
+
+namespace :foreman do
+
+    desc "export"
+    task :export do
+      on roles(fetch(:foreman_roles)) do
+        within release_path do
+          invoke 'foreman:export_env_variables'
+          execute :sudo, "touch #{release_path}/.env"
+          options = []
+          options << "--port #{fetch(:foreman_port)}" if fetch(:foreman_port)
+          options << "--root #{fetch(:foreman_root)}" if fetch(:foreman_root)
+          options << "--app #{fetch(:foreman_app)}" if fetch(:foreman_app)
+          options << "--procfile #{fetch(:foreman_procfile)}" if fetch(:foreman_procfile)
+          options << "--log #{fetch(:foreman_log)}" if fetch(:foreman_log)
+          options << "--user #{fetch(:foreman_user)}" if fetch(:foreman_user)
+          options << "--env #{release_path.join('.env')},#{env_variable_path}"
+          execute :sudo, [ "env PATH=$PATH", "bundle exec", 
+            "foreman export", backend.name, fetch(:foreman_output), options
+          ]
+        end
+      end
+    end
+
+    task :export_env_variables do
+      on roles(fetch(:foreman_roles)) do
+        envs = fetch(:foreman_env_variables).map {|k,v| %(#{k.upcase}=#{v}) }.join("\n")
+        envfile = StringIO.new(envs)
+        upload! envfile, env_variable_path
+      end
+    end
+
+    desc "start"
+    task :start do
+      on roles(fetch(:foreman_roles)) do
+        execute :sudo, backend.start_cmd(fetch(:foreman_app))
+      end
+    end
+
+    desc "stop"
+    task :stop do
+      on roles(fetch(:foreman_roles)) do
+        execute :sudo, backend.stop_cmd(fetch(:foreman_app))
+      end
+    end
+
+    desc "restart"
+    task :restart do
+      on roles(fetch(:foreman_roles)) do
+        execute :sudo, backend.restart_cmd(fetch(:foreman_app))
+      end
+    end
+end
+
+def backend
+  @backend ||= fetch(:foreman_backend).new
+end
+
+def env_variable_path
+  shared_path.join('RUNTIME_ENV')
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-foreman_export
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Katsuma Ito
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+description: Capistrano task for foreman
+email:
+- katsumai@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- capistrano-foreman_export.gemspec
+- lib/capistrano-foreman_export.rb
+- lib/capistrano/foreman_export.rb
+- lib/capistrano/foreman_export/backend.rb
+- lib/capistrano/foreman_export/backend/supervisord.rb
+- lib/capistrano/foreman_export/version.rb
+- lib/capistrano/tasks/foreman.cap
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Capistrano task for foreman
+test_files: []