patches 2.4.0 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44dfdb47ded3bbc59e4f3e6e60608368cd63018a2424bcc209800f882444e0d9
-  data.tar.gz: 4f197d97c612321564aba0b1e15fbfefa7eb288affdd20fdeb556d6bea8a1de3
+  metadata.gz: 2efd0dc04504ab68ece9ffb46f6e1c2a6adcae93b39dac5824d4cfed34093a99
+  data.tar.gz: 167f4f394fea327cbdf85f9c3e1ac067639abdfd606b2077ec70e5b1bb0a4bbb
 SHA512:
-  metadata.gz: 5ff6266eee49006debf847b631eebe295b33c9bf3d5f50c528fb19db5e2d137d1158ee89a21fc7f108b623e236a0dacbdaefae444ce3944f3bc951b9420fdc2a
-  data.tar.gz: dd761de25dd47a74c9c7123352fda506a38117278ed59c254e4511573a2748172702be682a3fc7e1fe9b54f854052827b428f4c01e563771f222d3322db33cf1
+  metadata.gz: 90edf98dc27bdeb176f8075711a2703cad55853ef010ce99b908a63001739d58dfab1ccc002e5ce61e4bbfe0724b4ca08321037b673c20fe529e76bc5a58f535
+  data.tar.gz: 666b762d233f27259f8c33afe2cf2ddb4cff060d313de6795840fac767e14e46401e1c5e8ff321379b4d9f9dbeea4bd00704656e03942ac312bdb3fea13f64a4

data/.buildkite/pipeline.yml

@@ -0,0 +1,24 @@
+steps:
+  - label: ':hammer: Tests'
+    plugins:
+      docker-compose:
+        run: app
+    command: 'bundle exec rspec'
+    agents:
+      queue: docker-heavy
+    artifact_paths: 'coverage/.resultset.json'
+
+  - wait
+
+  - command: "Report CodeClimate Coverage"
+    label: ":codeclimate: Report coverage"
+    plugins:
+      jobready/codeclimate-test-reporter#v2.0:
+        prefix: /app
+        artifact: "coverage/.resultset*.json"
+        input_type: simplecov
+        parts: 1
+    env:
+      CC_TEST_REPORTER_ID:
+    agents:
+      queue: docker-heavy

data/.rspec

@@ -1,2 +1,2 @@
---format documentation
 --color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,42 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [3.4.0] - 2020-07-21
+### Added
+- `Patches::TenantWorker` application version constraint forward compatibility
+
+## [3.3.0] - 2020-07-20
+### Added
+- Application version constraints
+
+## [3.2.0] - 2020-07-16
+### Added
+- Added `Patches::Worker` extra parameters to support forward compatibility with the upcoming releases
+
+## [3.1.0] - 2019-11-25
+### Fixed
+- Gem compatibility with Apartment 2
+
+## [3.0.1] - 2018-11-19
+### Added
+- Set icon_emoji of posted slack message to :dog:
+
+## [3.0.0] - 2018-11-19
+### Removed
+- Hipchat is no longer supported
+
+## [2.4.1] - 2018-09-19
+### Changed
+- Corrected gem ownership and authors.
+### Added
+- Changelog
+- Dockerfile and BuildKite pipeline config
+
+## [2.4.0] - 2018-09-17
+### Added
+- Added slack notification configurability

data/Dockerfile

@@ -0,0 +1,9 @@
+FROM ruby:2.3
+
+RUN touch ~/.gemrc && echo "gem: --no-ri --no-rdoc" >> ~/.gemrc
+
+WORKDIR /app/
+ADD . /app/
+RUN bundle install
+
+CMD bundle exec rake -T

data/LICENSE.md

@@ -16,4 +16,6 @@ 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.
+THE SOFTWARE.
+
+https://opensource.org/licenses/MIT

data/README.md

@@ -1,7 +1,8 @@
 # Patches
 [![Build status](https://badge.buildkite.com/4f3df3f3458bcc933dc44cab6c136af5c3bbdd9f761f1a99ff.svg)](https://buildkite.com/jobready/patches)
-[![Code Climate](https://codeclimate.com/repos/557f93b76956807f81000001/badges/39d142050017ffeb2564/gpa.svg)](https://codeclimate.com/repos/557f93b76956807f81000001/feed)
-[![Test Coverage](https://codeclimate.com/repos/557f93b76956807f81000001/badges/39d142050017ffeb2564/coverage.svg)](https://codeclimate.com/repos/557f93b76956807f81000001/coverage)
+[![Maintainability](https://api.codeclimate.com/v1/badges/39d142050017ffeb2564/maintainability)](https://codeclimate.com/repos/557f93b76956807f81000001/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/39d142050017ffeb2564/test_coverage)](https://codeclimate.com/repos/557f93b76956807f81000001/test_coverage)
+[![Gem Version](https://badge.fury.io/rb/patches.svg)](https://badge.fury.io/rb/patches)
 
 ![patches](docs/patches.jpg)
 
@@ -35,9 +36,12 @@ see `docs/usage.md`
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+```
+docker-compose build
+docker-compose run app bundle exec rspec
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org/gems/patches).
 
 ## Contributing
 

data/docker-compose.yml

@@ -0,0 +1,11 @@
+version: '3.2'
+services:
+  app:
+    build: .
+    volumes:
+      - .:/app
+      - app-gems:/usr/local/bundle
+
+volumes:
+  app-gems:
+    driver: local

data/docs/usage.md

@@ -23,21 +23,13 @@ bundle exec rake db:migrate
 ## Configuration
 
 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
+your Slack channel when they fail or succeed, you need to set up
 an initializer to set those options.
 
-```Ruby
+```ruby
 Patches::Config.configure do |config|
   config.use_sidekiq = true
 
-  config.use_hipchat = true
-  config.hipchat_options = {
-    api_token: ENV['HIPCHAT_TOKEN'],
-    room: ENV['HIPCHAT_ROOM'],
-    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'],
@@ -52,7 +44,7 @@ end
 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.
 
-```
+```ruby
 Patches::Config.configure do |config|
   config.use_sidekiq = true
   config.sidekiq_parallel = true
@@ -62,6 +54,23 @@ end
 *Note:* Make sure your sidekiq queue is able to process concurrent jobs.
 You can use ```config.sidekiq_options``` to customise it.
 
+### Application version verification
+
+In environments where a rolling update of sidekiq workers is performed during the deployment, multiple versions of the application run at the same time. If a Patches job is scheduled by the new application version during the rolling update, there is a possibility that it can be executed by the old application version, which will not have all the required patch files.
+
+To prevent this case, set the application version in the config:
+
+```ruby
+Patches::Config.configure do |config|
+  revision_file_path = Rails.root.join('REVISION')
+
+  if File.exist?(revision_file_path)
+    config.application_version = File.read(revision_file_path)
+    config.retry_after_version_mismatch_in = 1.minute
+  end
+end
+```
+
 ## Creating Patches
 
 Generate a patch
@@ -84,7 +93,7 @@ update the run method and then execute
 
 Generate patch with specs
 
-```
+```bash
 bundle exec rails g patches:patch PreferenceUpdate --specs=true
 ```
 
@@ -116,7 +125,7 @@ after sidekiq restarts, otherwise there is no guarentee the tasks will run.
 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
 
-```
+```ruby
 require 'aws-sdk-s3'
 Aws::S3::Client.new.get_object(bucket: @bucket_name, key: filename, response_target: destination)
 ```

data/lib/patches.rb

@@ -22,6 +22,7 @@ end
 require "patches/base"
 require "patches/config"
 require "patches/tenant_run_concern"
+require "patches/application_version_validation"
 require "patches/tenant_worker" if defined?(Sidekiq)
 require "patches/engine" if defined?(Rails)
 require "patches/patch"

data/lib/patches/application_version_validation.rb

@@ -0,0 +1,9 @@
+module Patches
+  module ApplicationVersionValidation
+    def valid_application_version?(application_version)
+      return true unless application_version
+      return true unless Patches::Config.configuration.application_version
+      Patches::Config.configuration.application_version == application_version
+    end
+  end
+end

data/lib/patches/config.rb

@@ -14,8 +14,15 @@ module Patches
       end
 
       class Configuration
-        attr_accessor :use_sidekiq, :sidekiq_queue, :sidekiq_options, :use_hipchat,
-          :hipchat_options, :sidekiq_parallel, :use_slack, :slack_options
+        attr_accessor \
+          :application_version,
+          :retry_after_version_mismatch_in,
+          :sidekiq_options,
+          :sidekiq_parallel,
+          :sidekiq_queue,
+          :slack_options,
+          :use_sidekiq,
+          :use_slack
 
         def initialize
           @sidekiq_queue = 'default'
@@ -25,20 +32,8 @@ module Patches
           @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]
+        def retry_after_version_mismatch_in
+          @retry_after_version_mismatch_in ||= 1.minute
         end
 
         def slack_channel

data/lib/patches/notifier.rb

@@ -3,12 +3,10 @@ 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
 
@@ -32,14 +30,6 @@ class Patches::Notifier
       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
 
@@ -48,7 +38,7 @@ class Patches::Notifier
         channel: config.slack_channel,
         username: config.slack_username)
 
-      payload = { attachments: [{ color: color, text: message }] }
+      payload = { icon_emoji: ":dog:", attachments: [{ color: color, text: message }] }
 
       notifier.post payload
     end

data/lib/patches/tenant_run_concern.rb

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

data/lib/patches/tenant_worker.rb

@@ -3,10 +3,15 @@ require 'sidekiq'
 class Patches::TenantWorker
   include Sidekiq::Worker
   include Patches::TenantRunConcern
+  include Patches::ApplicationVersionValidation
 
   sidekiq_options Patches::Config.configuration.sidekiq_options
 
-  def perform(tenant_name, path)
-    run(tenant_name, path)
+  def perform(tenant_name, path, params = {})
+    if valid_application_version?(params['application_version'])
+      run(tenant_name, path)
+    else
+      self.class.perform_in(Patches::Config.configuration.retry_after_version_mismatch_in, tenant_name, path, params)
+    end
   end
 end

data/lib/patches/version.rb

@@ -1,3 +1,6 @@
 module Patches
-  VERSION = "2.4.0"
+  MAJOR = 3
+  MINOR = 4
+  PATCH = 0
+  VERSION = [MAJOR, MINOR, PATCH].compact.join(".").freeze
 end

data/lib/patches/worker.rb

@@ -2,10 +2,15 @@ require 'sidekiq'
 
 class Patches::Worker
   include Sidekiq::Worker
+  include Patches::ApplicationVersionValidation
 
   sidekiq_options Patches::Config.configuration.sidekiq_options
 
-  def perform(runner)
-    runner.constantize.new.perform
+  def perform(runner, params = {})
+    if valid_application_version?(params['application_version'])
+      runner.constantize.new.perform
+    else
+      self.class.perform_in(Patches::Config.configuration.retry_after_version_mismatch_in, runner, params)
+    end
   end
 end

data/lib/tasks/patches.rake

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

data/patches.gemspec

@@ -6,8 +6,8 @@ require 'patches/version'
 Gem::Specification.new do |spec|
   spec.name          = "patches"
   spec.version       = Patches::VERSION
-  spec.authors       = ["John D'Agostino"]
-  spec.email         = ["johnd@jobready.com.au"]
+  spec.authors       = ["JobReady"]
+  spec.email         = ["ruby_gems@jobready.com.au"]
 
   spec.licenses    = ['MIT']
   spec.summary       = %q{A simple gem for one off tasks}
@@ -25,17 +25,15 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.8"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "sqlite3", "~> 1.3.5"
-  spec.add_development_dependency "rspec-rails", "~> 3.2.0"
+  spec.add_development_dependency "rspec-rails", "~> 4.0.0"
   spec.add_development_dependency "capybara", "~> 2.3.0"
   spec.add_development_dependency "generator_spec", "~> 0.9.0"
   spec.add_development_dependency "simplecov", "~> 0.10"
   spec.add_development_dependency "factory_girl", "~> 4.5.0"
   spec.add_development_dependency "timecop", "~> 0.7.0"
   spec.add_development_dependency "database_cleaner", "~> 1.3.0"
-  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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: patches
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 3.4.0
 platform: ruby
 authors:
-- John D'Agostino
+- JobReady
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-17 00:00:00.000000000 Z
+date: 2020-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 4.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
@@ -178,20 +178,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.3.0
-- !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -220,20 +206,6 @@ 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
@@ -264,14 +236,16 @@ dependencies:
         version: '0'
 description: A simple gem for one off tasks for example database patches
 email:
-- johnd@jobready.com.au
+- ruby_gems@jobready.com.au
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".buildkite/pipeline.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
+- CHANGELOG.md
+- Dockerfile
 - Gemfile
 - LICENSE.md
 - README.md
@@ -279,6 +253,7 @@ files:
 - bin/console
 - bin/setup
 - db/migrate/201506011700_create_patch.rb
+- docker-compose.yml
 - docs/patches.jpg
 - docs/usage.md
 - lib/generators/patches.rb
@@ -286,6 +261,7 @@ files:
 - lib/generators/patches/templates/patch.rb.erb
 - lib/generators/patches/templates/patch_spec.rb.erb
 - lib/patches.rb
+- lib/patches/application_version_validation.rb
 - lib/patches/base.rb
 - lib/patches/capistrano.rb
 - lib/patches/capistrano/tasks.rake
@@ -302,7 +278,6 @@ files:
 - lib/patches/worker.rb
 - lib/tasks/patches.rake
 - patches.gemspec
-- script/buildkite.sh
 homepage: http://github.com/jobready/patches
 licenses:
 - MIT
@@ -322,8 +297,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A simple gem for one off tasks

data/.travis.yml

@@ -1,3 +0,0 @@
-language: ruby
-rvm:
-  - 2.1.3

data/script/buildkite.sh

@@ -1,21 +0,0 @@
-#!/bin/bash
-set -e
-
-echo '--- setting ruby version'
-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
-
-echo '--- bundling'
-bundle install -j $(nproc) --without production --quiet
-
-echo '--- running specs'
-if bundle exec rspec; then
-  echo "[Successful] $BUILDBOX_PROJECT_SLUG - Build - $BUILDBOX_BUILD_URL - Commit - $REVISION" | hipchat_room_message -t $HIPCHAT_TOKEN -r $HIPCHAT_ROOM -f "Buildbox" -c "green"
-else
-  echo "[Failed] Build $BUILDBOX_PROJECT_SLUG - Build - $BUILDBOX_BUILD_URL - Commit - $REVISION" | hipchat_room_message -t $HIPCHAT_TOKEN -r $HIPCHAT_ROOM -f "Buildbox" -c "red"
-  exit 1;
-fi