capistrano-opscomplete 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a434f5baae62ed091c04472a4dc20f427a79aadc
+  data.tar.gz: d4a151042cfaf864fcfe0a9b9b33b6924b3cffa9
+SHA512:
+  metadata.gz: '09ee42b231e8269735885573d3acda6b1a12d46d0813f17b2167e6ac37a1e9ec7edfcbc7c2e554918cbbdeb6a79983afce3f9a50d7f3361657f6220da90b33cf'
+  data.tar.gz: dfc4c295ea1c29a0366c0a6cbcd8fc4c7fdbdae69d3515d53bace18d02dd386f0a328d4dc2d3fa75117dcea3bba76873024a9e25c3885b74e2da2fa947c6dad7

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+#git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in capistrano-opscomplete.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2018 makandra GmbH
+
+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,108 @@
+# Capistrano::Opscomplete
+
+This gem provides capistrano tasks for convenient deployment to a makandra [OpsComplete for Ruby](https://opscomplete.com/ruby) environment. If you find any bugs or run
+into a problem, please drop us a mail or open an issue.
+
+## Installation
+
+Include the gem in your applications Gemfile:
+
+```ruby
+gem 'capistrano-opscomplete'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it manually with:
+
+    $ gem install capistrano-opscomplete
+
+Now, include the DSL extensions and tasks by adding the following line to your `Capfile` _after_ `capistrano/deploy`:
+
+```ruby
+require 'capistrano/opscomplete'
+```
+
+Verify the gem was installed and tasks are available:
+
+    $ bundle exec cap -T | grep opscomplete
+
+Optional: If you want to manage ruby versions for certain roles, set `rbenv_roles` in your `deploy.rb`:
+
+```ruby
+set :rbenv_roles, :app
+```
+
+You might also want to configure some hooks, see [using capistrano hooks](#using-capistrano-hooks).
+
+## Usage
+
+If you encounter any errors, please make sure you have the newest version of the capistrano-opscomplete gem installed. Don't hesitate to
+contact the OpsComplete for Ruby team for further support.
+
+### List available tasks
+
+To see available capistrano tasks, execute:
+
+    $ bundle exec cap -T
+
+### opscomplete:ruby:check
+
+The `opscomplete:ruby:check` task checks for a properly configured ruby. It will not try to correct any misconfigurations, but just abort
+the capistrano run.
+
+    $ bundle exec cap <ENVIRONMENT> opscomplete:ruby:check
+
+Where `<ENVIRONMENT>` could be `production`, `staging`, ...
+
+### opscomplete:ruby:ensure
+
+The `opscomplete:ruby:ensure` task checks for a ruby as requested in application's `.ruby-version` file and will try to correct some
+misconfigurations.
+
+    $ bundle exec cap <ENVIRONMENT> opscomplete:ruby:ensure
+
+Where `<ENVIRONMENT>` could be `production`, `staging`, ...
+
+More specifically this task will:
+  - Check whether you are running a 'managed ruby' (installed with OpsComplete for Ruby) or if you have to install ruby using this gem or rbenv.
+  - If you are using 'unmanaged ruby':
+    - Checks if ruby version requested by `.ruby-version` is installed.
+    - If it is not installed, checks if it can be installed using `ruby-build` and installs it.
+    - Check if `rbenv global` version is set according to application's `.ruby-version` file. Change it if required.
+    - Install the `bundler` and `geordi` gem if required.
+    - Run `rbenv rehash` if required.
+
+*Note:* If, for any reason, no `.ruby-version` file can be found in your release directory, you may set the following option in
+deploy.rb:
+
+```ruby
+set :opscomplete_ruby_version, '<VERSION>'
+```
+
+Where `<VERSION>` is the desired ruby version.
+
+### opscomplete:appserver:restart
+
+To restart your application server execute:
+
+    $ bundle exec cap <ENVIRONMENT> opscomplete:appserver:restart
+
+Where `<ENVIRONMENT>` could be `production`, `staging`, ...
+
+Note: The current version of this gem only support the passenger app server. The current version of this gem does not support restarting your application, if multiple instances of passenger are running on the same host. This would be the case if you have Apache _and_ Nginx servers running on the same host.
+
+### Using capistrano hooks
+
+There are many hooks in the [default deploy flow](https://capistranorb.com/documentation/getting-started/flow/) to integrate tasks into your own deployment configuration. To ensure a ruby version according to your application is installed during deployment, add the following to your `Capfile`.
+
+```ruby
+before 'deploy:starting', 'opscomplete:ruby:ensure'
+after 'deploy:published', 'opscomplete:appserver:restart'
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

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

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/capistrano-opscomplete.gemspec

@@ -0,0 +1,36 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "capistrano/opscomplete/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "capistrano-opscomplete"
+  spec.version       = Capistrano::Opscomplete::VERSION
+  spec.authors       = ["Makandra Operations"]
+  spec.email         = ["ops@makandra.de"]
+
+  spec.summary       = %q{Capistrano tasks for easy deployment to a makandra opscomplete environment.}
+  spec.homepage      = "https://opscomplete.com/ruby"
+
+  spec.license       = 'MIT'
+
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^((test|spec|features)/|.gitignore|.rubocop.yml)}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_dependency 'capistrano', '>=3.0', '<4.0.0'
+end

data/lib/capistrano/dsl/opscomplete.rb

@@ -0,0 +1,50 @@
+module Capistrano
+  module DSL
+    # A whole capistrano/rake namespace, for grouping our helpers and tasks
+    module Opscomplete
+      def managed_ruby
+        test("[ -f #{rbenv_root_path}/.ruby_managed_by_makandra ]")
+      end
+
+      def rbenv_ruby_build_path
+        "#{rbenv_root_path}/plugins/ruby-build"
+      end
+
+      def rbenv_repo_url
+        'https://github.com/rbenv/rbenv.git'
+      end
+
+      def ruby_build_repo_url
+        'https://github.com/rbenv/ruby-build.git'
+      end
+
+      def app_ruby_version
+        app_ruby_version_file_path = release_path.join('.ruby-version').to_s
+        if fetch(:opscomplete_ruby_version)
+          warn("Using version from :opscomplete_ruby_version setting: #{fetch(:opscomplete_ruby_version)}.")
+          return fetch(:opscomplete_ruby_version)
+        elsif test("[ -f #{app_ruby_version_file_path} ]")
+          return capture(:cat, app_ruby_version_file_path)
+        else
+          raise Capistrano::ValidationError, 'Could not find application\'s .ruby-version. Consider setting opscomplete_ruby_version.'
+        end
+      end
+
+      def rbenv_installable_rubies
+        rbenv_installable_rubies = capture(:rbenv, :install, '--list').split("\n")
+        rbenv_installable_rubies.map!(&:strip)
+        rbenv_installable_rubies.delete("Available version:")
+        rbenv_installable_rubies
+      end
+
+      def rbenv_root_path
+        capture(:rbenv, :root)
+      end
+
+      def rbenv_installed_rubies
+        rbenv_installed_rubies = capture(:ls, '-1', "#{rbenv_root_path}/versions").split("\n")
+        rbenv_installed_rubies.map!(&:strip)
+      end
+    end
+  end
+end

data/lib/capistrano/opscomplete.rb

@@ -0,0 +1,4 @@
+require "capistrano/opscomplete/version"
+
+load File.expand_path('../opscomplete/tasks.rake', __FILE__)
+load File.expand_path('../opscomplete/deploy.rake', __FILE__)

data/lib/capistrano/opscomplete/deploy.rake

@@ -0,0 +1,10 @@
+namespace :deploy do
+  desc 'Show deployed revision'
+  task :revision do
+    on roles :app do
+      within current_path do
+        info "Revision: #{capture(:cat, 'REVISION')}"
+      end
+    end
+  end
+end

data/lib/capistrano/opscomplete/tasks.rake

@@ -0,0 +1,105 @@
+# vim: filetype=ruby
+require 'capistrano/dsl/opscomplete'
+
+namespace :opscomplete do
+  include Capistrano::DSL::Opscomplete
+  # desc 'Validate opscomplete specific configuration'
+  task :validate do
+    invoke('opscomplete:ruby:check')
+  end
+
+  namespace :ruby do
+    # desc 'Rehash rbenv shims (run this after installing executables).'
+    task :rehash do
+      on roles fetch(:rbenv_roles) do
+        execute(:rbenv, :rehash)
+      end
+    end
+
+    desc 'Check if rbenv global ruby is set according to application\'s .ruby-version.'
+    task :check do
+      on roles fetch(:rbenv_roles) do |host|
+        warn("#{host}: Managed ruby environment! Won't do any changes to ruby version.") if managed_ruby
+        unless capture(:rbenv, :global) == app_ruby_version
+          raise Capistrano::ValidationError,
+                "Ruby version is not set according to application's .ruby-version file. Use cap opscomplete:ruby:ensure."
+        end
+        info("#{host}: Required ruby version '#{app_ruby_version}' is installed.")
+      end
+    end
+
+    # desc 'Install rbenv plugin ruby-build'
+    task :install_ruby_build do
+      on roles fetch(:rbenv_roles) do
+        next if test "[ -d #{rbenv_ruby_build_path} ]"
+        execute :git, :clone, ruby_build_repo_url, rbenv_ruby_build_path
+      end
+    end
+
+    # desc 'Update rbenv plugin ruby-build'
+    task :update_ruby_build do
+      on roles fetch(:rbenv_roles) do
+        if test "[ -d #{rbenv_ruby_build_path} ]"
+          within rbenv_ruby_build_path do
+            execute :git, :pull
+          end
+        else
+          warn('Could not find ruby-build.')
+        end
+      end
+    end
+
+    # desc 'Install bundler gem'
+    task :install_bundler do
+      on roles fetch(:rbenv_roles) do
+        next if test(:rbenv, :exec, :gem, :query, '--quiet --installed --name-matches ^bundler$')
+        execute(:rbenv, :exec, :gem, :install, :bundler, '--quiet --no-rdoc --no-ri')
+        invoke!('opscomplete:ruby:rehash')
+      end
+    end
+
+    # desc 'Install geordi gem'
+    task :install_geordi do
+      on roles fetch(:rbenv_roles) do
+        next if test(:rbenv, :exec, :gem, :query, '--quiet --installed --name-matches ^geordi$')
+        execute(:rbenv, :exec, :gem, :install, :geordi, '--quiet --no-rdoc --no-ri')
+        invoke!('opscomplete:ruby:rehash')
+      end
+    end
+
+    desc 'Install and configure ruby according to applications .ruby-version.'
+    task :ensure do
+      on roles fetch(:rbenv_roles) do |host|
+        if managed_ruby
+          raise Capistrano::ValidationError, "Managed ruby environment! Won't do any changes to ruby version."
+        end
+        if rbenv_installed_rubies.include?(app_ruby_version)
+          info("#{host}: Required ruby version '#{app_ruby_version}' is installed.")
+        else
+          invoke('opscomplete:ruby:update_ruby_build')
+          if rbenv_installable_rubies.include?(app_ruby_version)
+            warn('Required ruby version is not installed, but available for installation.')
+            info("Installing ruby #{app_ruby_version}.")
+            execute(:rbenv, :install, app_ruby_version)
+            invoke!('opscomplete:ruby:rehash')
+          else
+            raise Capistrano::ValidationError,
+                  'Ruby version required by application is neither installed nor installable using ruby-install.'
+          end
+        end
+        execute(:rbenv, :global, app_ruby_version) unless capture(:rbenv, :global) == app_ruby_version
+      end
+      invoke('opscomplete:ruby:install_bundler')
+      invoke('opscomplete:ruby:install_geordi')
+    end
+  end
+
+  namespace :appserver do
+    desc 'Restart Application'
+    task :restart do
+      on roles :app do
+        execute "sudo passenger-config restart-app --ignore-app-not-running #{fetch(:deploy_to)}"
+      end
+    end
+  end
+end

data/lib/capistrano/opscomplete/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module Opscomplete
+    VERSION = '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-opscomplete
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Makandra Operations
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-07-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+description: 
+email:
+- ops@makandra.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- capistrano-opscomplete.gemspec
+- lib/capistrano-opscomplete.rb
+- lib/capistrano/dsl/opscomplete.rb
+- lib/capistrano/opscomplete.rb
+- lib/capistrano/opscomplete/deploy.rake
+- lib/capistrano/opscomplete/tasks.rake
+- lib/capistrano/opscomplete/version.rb
+homepage: https://opscomplete.com/ruby
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.6.13
+signing_key: 
+specification_version: 4
+summary: Capistrano tasks for easy deployment to a makandra opscomplete environment.
+test_files: []