spinnaker-sidekiq 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c1227c6d8e7b04dde5034da339d80cea8eb11d74cfa21f314c9695a2caf3e57a
+  data.tar.gz: d77f9478512c78415a7299c234c4b5d16261cad6054c9df58e7a6c1756c94efb
+SHA512:
+  metadata.gz: e0cb4f4b4d22b3e650a90984f46278e378310499fb34dc59a1ebeae084dd4b080be09445a364c5cb12ce272a63ad5e5cd4c9636864bf6b4c16ba2dff3dbc364f
+  data.tar.gz: eaf670a53aad6be0b883b62e66e30f755aab18502fb85c5ae3048906b52c181c7da0c09adfadc2c430159420eda89a6df607b1d0a801b5d27a9cce4c9a8aeb49

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 Intellum Inc.
+
+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,52 @@
+# Spinnaker::Sidekiq
+
+API to implement a webhook stage for spinnaker to stop sidekiq workers gracefully.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'spinnaker-sidekiq'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install spinnaker-sidekiq
+```
+
+## Usage
+
+Mount the engine in your rails application.
+
+``` ruby
+mount Spinnaker::Sidekiq::Engine, at: "/spinnaker/sidekiq"
+```
+
+API token can be specified by environment variable `SPINNAKER_SIDEKIQ_API_TOKEN` or doing:
+
+``` ruby
+Spinnaker::Sidekiq.api_token = 'SECRET_VALUE'
+```
+
+In spinnaker, create a webhook stage with the following configuration:
+
+- Webhook URL: `https://example.com/spinnaker/sidekiq/quiet_all`
+- Method: `POST`
+- Payload `{}`
+- Custom Headers:
+    `Authorization` value `Token SPINNAKER_API_TOKEN`
+- Status JsonPath: `$.status`
+- Progress location: `$.progress`
+- SUCCESS status mapping: `quiet`
+
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+end
+
+require "rdoc/task"
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title = "Spinnaker::Sidekiq"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include("README.md")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = false
+end
+
+task default: :test

data/app/controllers/spinnaker/sidekiq/api_controller.rb

@@ -0,0 +1,47 @@
+require_dependency "spinnaker/sidekiq/application_controller"
+require "sidekiq/api"
+
+module Spinnaker
+  module Sidekiq
+    class ApiController < ApplicationController
+      before_action :authenticate
+
+      # This will be used by a webhook stage to quiet all workers during deployment
+      def quiet_all
+        ps = ::Sidekiq::ProcessSet.new
+        ps.each(&:quiet!)
+        render plain: "", location: url_for(action: "status", started_at: Time.now.to_i)
+      end
+
+      # This will be used to poll the status of the sidekiq workers.
+      def status
+        ps = ::Sidekiq::ProcessSet.new
+
+        processes = ps.reject { |process|
+          params[:started_at] && process["started_at"] > DateTime.strptime(params[:started_at], "%s").to_i
+        }
+
+        busy_jobs = processes.sum { |process| process["busy"] }
+
+        status = busy_jobs == 0 ? "quiet" : "busy"
+
+        render json: {status: status, progress: "Pending jobs: #{busy_jobs}"}
+      end
+
+      private
+
+      def authenticate
+        authenticate_or_request_with_http_token do |token, _options|
+          token_digest = ::Digest::SHA256.hexdigest(token)
+          api_auth_token_digest = ::Digest::SHA256.hexdigest(api_authentication_token)
+
+          ActiveSupport::SecurityUtils.secure_compare(token_digest, api_auth_token_digest)
+        end
+      end
+
+      def api_authentication_token
+        Spinnaker::Sidekiq.api_token
+      end
+    end
+  end
+end

data/app/controllers/spinnaker/sidekiq/application_controller.rb

@@ -0,0 +1,6 @@
+module Spinnaker
+  module Sidekiq
+    class ApplicationController < ActionController::Base
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,4 @@
+Spinnaker::Sidekiq::Engine.routes.draw do
+  post "/quiet_all", to: "api#quiet_all"
+  get "/status", to: "api#status"
+end

data/lib/spinnaker/sidekiq.rb

@@ -0,0 +1,19 @@
+require "spinnaker/sidekiq/engine"
+
+module Spinnaker
+  module Sidekiq
+    class MissingApiToken < StandardError
+      def initialize(msg = "Set SPINNAKER_SIDEKIQ_API_TOKEN environment variable or Spinnaker::Sidekiq.api_token")
+        super
+      end
+    end
+
+    class << self
+      attr_writer :api_token
+
+      def api_token
+        @api_token ||= ENV.fetch("SPINNAKER_SIDEKIQ_API_TOKEN") { raise MissingApiToken }
+      end
+    end
+  end
+end

data/lib/spinnaker/sidekiq/engine.rb

@@ -0,0 +1,7 @@
+module Spinnaker
+  module Sidekiq
+    class Engine < ::Rails::Engine
+      isolate_namespace Spinnaker::Sidekiq
+    end
+  end
+end

data/lib/spinnaker/sidekiq/version.rb

@@ -0,0 +1,5 @@
+module Spinnaker
+  module Sidekiq
+    VERSION = "0.1.0"
+  end
+end

data/lib/tasks/spinnaker/sidekiq_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :spinnaker_sidekiq do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: spinnaker-sidekiq
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jorge Dias
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-03-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.6
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.6.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.6
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.6.2
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: standard
+  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: gem-release
+  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: API to implement a webhook stage for spinnaker to stop sidekiq workers
+  gracefully
+email:
+- jdias@intellum.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/controllers/spinnaker/sidekiq/api_controller.rb
+- app/controllers/spinnaker/sidekiq/application_controller.rb
+- config/routes.rb
+- lib/spinnaker/sidekiq.rb
+- lib/spinnaker/sidekiq/engine.rb
+- lib/spinnaker/sidekiq/version.rb
+- lib/tasks/spinnaker/sidekiq_tasks.rake
+homepage: https://github.com/intellum/spinnaker-sidekiq
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Spinnaker Sidekiq integration
+test_files: []