patches 2.0.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 69347a281680b6b89baafd7d31c2ab4f5256f74a
-  data.tar.gz: f8896fc3443f64d83ea4c74fbe78aa962a9e58b1
+SHA256:
+  metadata.gz: 44dfdb47ded3bbc59e4f3e6e60608368cd63018a2424bcc209800f882444e0d9
+  data.tar.gz: 4f197d97c612321564aba0b1e15fbfefa7eb288affdd20fdeb556d6bea8a1de3
 SHA512:
-  metadata.gz: 7bd2bf0ce3a97d21fcd20acd5c082d4c03234ae75612fdd495b7199f42c081ea977acf0d91ff4b05468b52ed902b4724fa81e417b71ece81cf8f973749cd9335
-  data.tar.gz: bd6b3b260c5bb60c9274152d0b7e0a49485f0da5cce5a825846b3bdf54ded029af520bb7457b7f6465e112d207976811ea90b5f28d0876a20575a626b26631ec
+  metadata.gz: 5ff6266eee49006debf847b631eebe295b33c9bf3d5f50c528fb19db5e2d137d1158ee89a21fc7f108b623e236a0dacbdaefae444ce3944f3bc951b9420fdc2a
+  data.tar.gz: dd761de25dd47a74c9c7123352fda506a38117278ed59c254e4511573a2748172702be682a3fc7e1fe9b54f854052827b428f4c01e563771f222d3322db33cf1

data/.gitignore

@@ -10,3 +10,4 @@
 /coverage/
 /test.db
 /*.gem
+.byebug_history

data/docs/usage.md

@@ -5,7 +5,7 @@
 Add patches to the project Gemfile
 
 ```ruby
-gem 'patches', '~> 2.0.0'
+gem 'patches', '~> 2.4.0'
 ```
 
 Install the database migration
@@ -22,7 +22,9 @@ bundle exec rake db:migrate
 
 ## Configuration
 
-If you would like to run the patches asynchronously, or would like them to notify your hipchat room when they fail or succeed, you need to set up an initializer to set those options.
+If you would like to run the patches asynchronously, or would like them to notify
+your hipchat room or Slack channel when they fail or succeed, you need to set up
+an initializer to set those options.
 
 ```Ruby
 Patches::Config.configure do |config|
@@ -32,11 +34,34 @@ Patches::Config.configure do |config|
   config.hipchat_options = {
     api_token: ENV['HIPCHAT_TOKEN'],
     room: ENV['HIPCHAT_ROOM'],
-    user: ENV['HIPCHAT_USERNAME'] #maximum of 15 characters
+    user: ENV['HIPCHAT_USERNAME'], # maximum of 15 characters
+    api_version: 'v1', # optional
   }
+
+  config.use_slack = true
+  config.slack_options = {
+    webhook_url: ENV['SLACK_WEBHOOK_URL'],
+    channel: ENV['SLACK_CHANNEL'],
+    username: ENV['SLACK_USER']
+  }
+end
+```
+
+### Running patches in parallel for tenants
+
+If you are using the Apartment gem, you can run the patches for each tenant in parallel.
+Just set the config ```sidekiq_parallel``` to ```true``` and you're good to go.
+
+```
+Patches::Config.configure do |config|
+  config.use_sidekiq = true
+  config.sidekiq_parallel = true
 end
 ```
 
+*Note:* Make sure your sidekiq queue is able to process concurrent jobs.
+You can use ```config.sidekiq_options``` to customise it.
+
 ## Creating Patches
 
 Generate a patch
@@ -57,6 +82,12 @@ end
 
 update the run method and then execute
 
+Generate patch with specs
+
+```
+bundle exec rails g patches:patch PreferenceUpdate --specs=true
+```
+
 
 ```bash
 bundle exec rake patches:run
@@ -76,8 +107,21 @@ And then in your deploy.rb
 after 'last_task_you_want_to_run' 'patches:run'
 ```
 
-If you are using sidekiq and restarting the sidekiq process on the box as a part of the deploy process, please make sure that the patches run task runs after sidekiq restarts, otherwise there is no guarentee the tasks will run.
+If you are using sidekiq and restarting the sidekiq process on the box
+as a part of the deploy process, please make sure that the patches run task runs
+after sidekiq restarts, otherwise there is no guarentee the tasks will run.
+
+## File Download
+
+If a patch requires data assets, you could use S3 to store the file.
+If credentials are defined in env vars, as per https://docs.aws.amazon.com/cli/latest/topic/config-vars.html#id1
+
+```
+require 'aws-sdk-s3'
+Aws::S3::Client.new.get_object(bucket: @bucket_name, key: filename, response_target: destination)
+```
 
 ## Multitenant
 
-Patches will detect if `Apartment` gem is installed and if there are any tenants and run the patches for each tenant
+Patches will detect if `Apartment` gem is installed and if there are any tenants
+and run the patches for each tenant

data/lib/generators/patches/patch_generator.rb

@@ -4,8 +4,11 @@ module Patches
       desc 'Adds an empty patch'
       source_root File.expand_path('../templates', __FILE__)
 
+      class_option :specs, type: :boolean, default: false, description: 'Generates a rspec file for the patch'
+
       def generate_patch
         template "patch.rb.erb", "db/patches/#{file_name}.rb"
+        template "patch_spec.rb.erb", "spec/patches/#{file_name}_spec.rb" if options['specs']
       end
 
       private

data/lib/generators/patches/templates/patch_spec.rb.erb

@@ -0,0 +1,8 @@
+require 'rails_helper'
+require_relative '../../db/patches/<%= file_name %>'
+
+describe <%= class_name %> do
+  describe '#run' do
+    # Specs go here
+  end
+end

data/lib/patches.rb

@@ -20,11 +20,13 @@ module Patches
 end
 
 require "patches/base"
+require "patches/config"
+require "patches/tenant_run_concern"
+require "patches/tenant_worker" if defined?(Sidekiq)
 require "patches/engine" if defined?(Rails)
 require "patches/patch"
 require "patches/pending"
 require "patches/runner"
 require "patches/tenant_runner"
-require "patches/config"
 require "patches/notifier"
 require "patches/worker" if defined?(Sidekiq)

data/lib/patches/config.rb

@@ -1,19 +1,58 @@
 module Patches
   class Config
     class << self
-      class_attribute :use_sidekiq, :sidekiq_queue, :sidekiq_options, :use_hipchat, :hipchat_options
-
-      def sidekiq_queue
-        @sidekiq_queue ||= 'default'
+      def configuration
+        @configuration ||= Configuration.new
       end
 
-      def sidekiq_options
-        @sidekiq_options ||= { retry: false, queue: Patches::Config.sidekiq_queue }
+      def configuration=(config)
+        @configuration = config
       end
 
       def configure
-        yield self
+        yield configuration
+      end
+
+      class Configuration
+        attr_accessor :use_sidekiq, :sidekiq_queue, :sidekiq_options, :use_hipchat,
+          :hipchat_options, :sidekiq_parallel, :use_slack, :slack_options
+
+        def initialize
+          @sidekiq_queue = 'default'
+        end
+
+        def sidekiq_options
+          @sidekiq_options ||= { retry: false, queue: sidekiq_queue }
+        end
+
+        def hipchat_api_token
+          hipchat_options[:api_token]
+        end
+
+        def hipchat_init_options
+          hipchat_options.except(:api_token, :room, :user)
+        end
+
+        def hipchat_room
+          hipchat_options[:room]
+        end
+
+        def hipchat_user
+          hipchat_options[:user]
+        end
+
+        def slack_channel
+          slack_options[:channel]
+        end
+
+        def slack_username
+          slack_options[:username]
+        end
+
+        def slack_webhook_url
+          slack_options[:webhook_url]
+        end
       end
     end
   end
-end
+end

data/lib/patches/notifier.rb

@@ -1,34 +1,62 @@
+require 'slack-notifier'
+
 class Patches::Notifier
   class << self
     def notify_success(patches)
       send_hipchat_message(success_message(patches), color: 'green')
+      send_slack_message(success_message(patches), 'good')
     end
 
     def notify_failure(patch_path, error)
       send_hipchat_message(failure_message(patch_path, error), color: 'red')
+      send_slack_message(failure_message(patch_path, error), 'danger')
     end
 
     def success_message(patches)
-      message = "#{patches.count} patches succeeded"
+      message = "#{environment_prefix}#{patches.count} patches succeeded"
       append_tenant_message(message)
     end
 
     def failure_message(patch_path, error)
-      message = "Error applying patch: #{Pathname.new(patch_path).basename} failed with error: #{error}"
+      details = "#{Pathname.new(patch_path).basename} failed with error: #{error}"
+      message = "#{environment_prefix}Error applying patch: #{details}"
       append_tenant_message(message)
     end
 
+    def environment_prefix
+      "[#{Rails.env.upcase}] " if defined?(Rails)
+    end
+
     def append_tenant_message(message)
       message = message + " for tenant: #{Apartment::Tenant.current}" if defined?(Apartment)
       message
     end
 
+    def send_hipchat_message(message, options)
+      return unless defined?(HipChat) && config.use_hipchat
+
+      client = HipChat::Client.new(config.hipchat_api_token, config.hipchat_init_options)
+      room = client[config.hipchat_room]
+      room.send(config.hipchat_user, message, options)
+    end
+
+    def send_slack_message(message, color)
+      return unless defined?(Slack) && config.use_slack
+
+      notifier = Slack::Notifier.new(
+        config.slack_webhook_url,
+        channel: config.slack_channel,
+        username: config.slack_username)
+
+      payload = { attachments: [{ color: color, text: message }] }
+
+      notifier.post payload
+    end
+
     private
 
-    def send_hipchat_message(message, options)
-      if defined?(HipChat) && Patches::Config.use_hipchat
-        HipChat::Client.new(Patches::Config.hipchat_options[:api_token])[Patches::Config.hipchat_options[:room]].send(Patches::Config.hipchat_options[:user], message, options)
-      end
+    def config
+      Patches::Config.configuration
     end
   end
 end

data/lib/patches/tenant_run_concern.rb

@@ -0,0 +1,8 @@
+module Patches
+  module TenantRunConcern
+    def run(tenant_name, path = nil)
+      Apartment::Tenant.switch(tenant_name)
+      Patches::Runner.new(path).perform
+    end
+  end
+end

data/lib/patches/tenant_runner.rb

@@ -1,4 +1,5 @@
 class Patches::TenantRunner
+  include Patches::TenantRunConcern
   attr_accessor :path
 
   def initialize(path: nil, tenants: nil)
@@ -8,19 +9,22 @@ class Patches::TenantRunner
 
   def perform
     Patches.logger.info("Patches tenant runner for: #{tenants.join(',')}")
-
     tenants.each do |tenant|
-      Apartment::Tenant.switch(tenant)
-      runner = build
-      runner.perform
+      if parallel?
+        Patches::TenantWorker.perform_async(tenant, path)
+      else
+        run(tenant, path)
+      end
     end
   end
 
-  def build
-    Patches::Runner.new(path)
-  end
-
   def tenants
     @tenants ||= (Apartment.tenant_names || [])
   end
+
+  private
+
+  def parallel?
+    Patches::Config.configuration.sidekiq_parallel
+  end
 end

data/lib/patches/tenant_worker.rb

@@ -0,0 +1,12 @@
+require 'sidekiq'
+
+class Patches::TenantWorker
+  include Sidekiq::Worker
+  include Patches::TenantRunConcern
+
+  sidekiq_options Patches::Config.configuration.sidekiq_options
+
+  def perform(tenant_name, path)
+    run(tenant_name, path)
+  end
+end

data/lib/patches/version.rb

@@ -1,3 +1,3 @@
 module Patches
-  VERSION = "2.0.0"
+  VERSION = "2.4.0"
 end

data/lib/patches/worker.rb

@@ -3,7 +3,7 @@ require 'sidekiq'
 class Patches::Worker
   include Sidekiq::Worker
 
-  sidekiq_options Patches::Config.sidekiq_options
+  sidekiq_options Patches::Config.configuration.sidekiq_options
 
   def perform(runner)
     runner.constantize.new.perform

data/lib/tasks/patches.rake

@@ -7,7 +7,7 @@ namespace :patches do
       runner = Patches::Runner
     end
 
-    if defined?(Sidekiq) && Patches::Config.use_sidekiq
+    if defined?(Sidekiq) && Patches::Config.configuration.use_sidekiq
       Patches::Worker.perform_async(runner)
     else
       runner.new.perform

data/patches.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "railties", ">= 3.2"
+  spec.add_dependency "slack-notifier"
 
   spec.add_development_dependency "bundler", "~> 1.8"
   spec.add_development_dependency "rake", "~> 10.0"
@@ -34,4 +35,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "codeclimate-test-reporter", "~> 0.4"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "sidekiq", "~> 3.4.1"
+  spec.add_development_dependency "hipchat"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "byebug"
 end

data/script/buildkite.sh

@@ -2,7 +2,9 @@
 set -e
 
 echo '--- setting ruby version'
-rbenv local 2.1.5
+cd /var/lib/buildkite-agent/.rbenv/plugins/ruby-build && git pull && cd -
+rbenv install 2.3.7 -s
+rbenv local 2.3.7
 
 echo '--- setting up env'
 REVISION=https://github.com/$BUILDBOX_PROJECT_SLUG/commit/$BUILDBOX_COMMIT

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: patches
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.4.0
 platform: ruby
 authors:
 - John D'Agostino
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-06 00:00:00.000000000 Z
+date: 2018-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: slack-notifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -206,6 +220,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.4.1
+- !ruby/object:Gem::Dependency
+  name: hipchat
+  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: webmock
+  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: byebug
+  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: A simple gem for one off tasks for example database patches
 email:
 - johnd@jobready.com.au
@@ -228,6 +284,7 @@ files:
 - lib/generators/patches.rb
 - lib/generators/patches/patch_generator.rb
 - lib/generators/patches/templates/patch.rb.erb
+- lib/generators/patches/templates/patch_spec.rb.erb
 - lib/patches.rb
 - lib/patches/base.rb
 - lib/patches/capistrano.rb
@@ -238,7 +295,9 @@ files:
 - lib/patches/patch.rb
 - lib/patches/pending.rb
 - lib/patches/runner.rb
+- lib/patches/tenant_run_concern.rb
 - lib/patches/tenant_runner.rb
+- lib/patches/tenant_worker.rb
 - lib/patches/version.rb
 - lib/patches/worker.rb
 - lib/tasks/patches.rake
@@ -264,7 +323,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: A simple gem for one off tasks