resque-kubernetes 1.3.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c90637618ea819269c20b91f9cc752e28b435da0
-  data.tar.gz: 94391752da8c4a799442d22e31f5cfdf3ac8cc21
+SHA256:
+  metadata.gz: c5705807fc4c023c6d41f4ea9de1ead2e365e1a7a4153b9c0bbf507a775c17ef
+  data.tar.gz: 80b8d23e4914a5d59308e46e3486b8ee8935f8da0661ecf692e4a33ad5d3075f
 SHA512:
-  metadata.gz: 9c3dcccddc78c704a909c2abba2b0acd7236ba8df30026dbaf4a0ce11958e4823064c25dfb8bdfaf3b923510fe3468088ad70d26ec799c6ca0fe037711db2f89
-  data.tar.gz: f9257d78372f47e6a94be98d022095d05d3af32f960b402c126a760cf247060e28fd7dca34c402898e8db6d591fb79e63f6162042da130b77f4767da3c16ca02
+  metadata.gz: a406b7260bbb127425fa7522bb7ab579594236190f88a5a992071161da966b4a96d3a12dd442fea0a5fb4134d515a2e044b0728303858dea3c9bdab593c22b77
+  data.tar.gz: 71e8a8a42de666cd4a43ab5ba311349d07311bc956733c9a464203118bd098b7ab4b36928e7e800087b7efd7258b4b444f26958ccd84f509433c365619b47460

data/.rubocop.yml

@@ -1,13 +1,17 @@
-Documentation:
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+
+Style/Documentation:
   Exclude:
     - "**/railtie.rb"
     - "spec/**/*"
 
 Style/StringLiterals:
   EnforcedStyle: double_quotes
-Metrics/LineLength:
+Layout/LineLength:
   Max: 120
-Layout/AlignHash:
+Layout/HashAlignment:
   EnforcedHashRocketStyle: table
   EnforcedColonStyle: table
 Layout/SpaceInsideHashLiteralBraces:
@@ -16,9 +20,9 @@ Style/RaiseArgs:
   EnforcedStyle: compact
 Style/EmptyMethod:
   EnforcedStyle: expanded
-Layout/IndentArray:
+Layout/FirstArrayElementIndentation:
   IndentationWidth: 4
-Layout/IndentHash:
+Layout/FirstHashElementIndentation:
   IndentationWidth: 4
 Style/ConditionalAssignment:
   EnforcedStyle: assign_inside_condition

data/.ruby-version

@@ -1 +1 @@
-2.3.1
+3.0.5

data/Appraisals

@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-appraise "kubeclient-3" do
-  gem "kubeclient", "3.1.2"
-end
-
 appraise "kubeclient-4" do
-  gem "kubeclient", "4.0.0"
+  gem "kubeclient", "4.11.0"
 end

data/CHANGELOG.md

@@ -1,3 +1,43 @@
+# V3.0.0
+**Breaking Change:**
+- Drop support for Ruby 2.7.
+- Drop support for `kubeclient` 3.x.
+
+**Changes:**
+- Add support for Ruby 3.0.
+- Requires `kubeclient` >= 4.9.3.
+
+# V2.0.0
+**Breaking Change:**
+- The `environments` configuration as been replaced by a more flexible `enabled` property.
+
+  Here's how to migrate from the `environments` property to the `enabled` property:
+
+  Before:
+  ```ruby
+  # config/initializers/resque-kubernetes.rb
+
+  Resque::Kubernetes.configuration do |config|
+   config.environments << "staging"
+   config.max_workers = 10
+  end
+  ```
+
+  After:
+  ```ruby
+  # config/initializers/resque-kubernetes.rb
+
+  Resque::Kubernetes.configuration do |config|
+   config.enabled     = Rails.env.production? || Rails.env.staging?
+   config.max_workers = 10
+  end
+  ```
+    
+  ⚠️ By default, this gem is not enabled.
+
+**Changes:**
+- Allow resque 2.0 but retain support for 1.26 or later.
+
 # v1.3.0
 - Retry when a timeout occurs connecting to the Kubernetes API server
 

data/Gemfile

@@ -4,3 +4,11 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in resque-kubernetes.gemspec
 gemspec
+
+gem "appraisal"
+gem "bundler", "~> 2.0"
+gem "bundler-audit", "~> 0"
+gem "googleauth", "~> 0.6"
+gem "rake", "~> 12.3"
+gem "rspec", "~> 3.7"
+gem "rubocop", "~> 1.50"

data/README.md

@@ -152,19 +152,16 @@ your project:
 # config/initializers/resque-kubernetes.rb
 
 Resque::Kubernetes.configuration do |config|
- config.environments << "staging"
+ config.enabled     = Rails.env.production? || Rails.env.staging?
  config.max_workers = 10
 end
 ```
 
-### `environments`
+### `enabled`
 
-> This only works under Rails, when `Rails.env` is set.
+⚠️ By default, the `enabled` property is set to `false` which means that, by default, this plugin will not be launched.
 
-By default `Resque::Kubernetes` will only manage Kubernetes Jobs in
-`:production`. If you want to add other environments you can update this list
-(`config.environments << "staging"`) or replace it (`config.environments =
-["production", "development"]`).
+You should not enable this Resque plugin in environments that are not run inside a Kubernetes cluster (for example, your CI env).
 
 ### `max_workers`
 
@@ -215,7 +212,7 @@ The gem will automatically connect to the Kubernetes server in the following cas
     installed
 
 There are many other ways to connect and you can do so by providing your own
-[configured `kubeclient`](https://github.com/abonas/kubeclient#usage):
+[configured `kubeclient`](https://github.com/ManageIQ/kubeclient#usage):
 
 ```ruby
 # config/initializers/resque-kubernetes.rb

data/gemfiles/kubeclient_4.gemfile

@@ -2,6 +2,14 @@
 
 source "https://rubygems.org"
 
-gem "kubeclient", "4.0.0"
+gem "kubeclient", "4.11.0"
 
 gemspec path: "../"
+
+gem "appraisal"
+gem "bundler", "~> 2.0"
+gem "bundler-audit", "~> 0"
+gem "googleauth", "~> 0.6"
+gem "rake", "~> 12.3"
+gem "rspec", "~> 3.7"
+gem "rubocop", "~> 1.50"

data/lib/resque/kubernetes/configurable.rb

@@ -12,6 +12,7 @@ module Resque
       #
       # name:    The name of the setting.
       # default: A default value for the setting. (Optional)
+      # rubocop: disable Style/ClassVars
       def define_setting(name, default = nil)
         class_variable_set("@@#{name}", default)
 
@@ -23,6 +24,7 @@ module Resque
           class_variable_get("@@#{name}")
         end
       end
+      # rubocop: enable Style/ClassVars
 
       private
 

data/lib/resque/kubernetes/context/kubectl.rb

@@ -9,32 +9,40 @@ module Resque
           File.exist?(kubeconfig)
         end
 
+        # rubocop: disable Metrics/MethodLength
         def context
           config = Kubeclient::Config.read(kubeconfig)
 
-          Resque::Kubernetes::ContextFactory::Context.new(
-              config.context.api_endpoint,
-              config.context.api_version,
-              config.context.namespace,
+          options = {
               auth_options: auth_options(config),
               ssl_options:  config.context.ssl_options
+          }
+
+          Resque::Kubernetes::ContextFactory::Context.new(
+            config.context.api_endpoint,
+            config.context.api_version,
+            config.context.namespace,
+            options
           )
         end
+        # rubocop: enable Metrics/MethodLength
 
         private
 
         def kubeconfig
-          File.join(ENV["HOME"], ".kube", "config")
+          File.join(Dir.home, ".kube", "config")
         end
 
         def auth_options(config)
           options = config.context.auth_options
           return options unless options.empty?
+
           google_application_default_credentials
         end
 
         def google_application_default_credentials
           return unless defined?(Google) && defined?(Google::Auth)
+
           {bearer_token: Kubeclient::GoogleApplicationDefaultCredentials.token}
         end
       end

data/lib/resque/kubernetes/context/well_known.rb

@@ -14,12 +14,16 @@ module Resque
         end
 
         def context
-          Resque::Kubernetes::ContextFactory::Context.new(
-              "https://kubernetes.default.svc",
-              "v1",
-              namespace,
+          options = {
               auth_options: {bearer_token_file: TOKEN_FILE},
               ssl_options:  ssl_options
+          }
+
+          Resque::Kubernetes::ContextFactory::Context.new(
+            "https://kubernetes.default.svc",
+            "v1",
+            namespace,
+            options
           )
         end
 
@@ -27,11 +31,13 @@ module Resque
 
         def namespace
           return nil unless File.exist?(NAMESPACE_FILE)
+
           File.read(NAMESPACE_FILE)
         end
 
         def ssl_options
           return {} unless File.exist?(CA_FILE)
+
           {ca_file: CA_FILE}
         end
       end

data/lib/resque/kubernetes/context_factory.rb

@@ -10,7 +10,6 @@ module Resque
 
       class << self
         def context
-          # TODO: Add ability to load this from config
           [
               Resque::Kubernetes::Context::WellKnown,
               Resque::Kubernetes::Context::Kubectl
@@ -18,6 +17,8 @@ module Resque
             context = context_type.new
             return context.context if context.applicable?
           end
+
+          nil
         end
       end
     end

data/lib/resque/kubernetes/job.rb

@@ -78,14 +78,13 @@ module Resque
     module Job
       def self.included(base)
         return unless base.respond_to?(:before_enqueue)
+
         base.before_enqueue :before_enqueue_kubernetes_job
       end
 
       # A before_enqueue hook that adds worker jobs to the cluster.
       def before_enqueue_kubernetes_job(*_args)
-        if defined? Rails
-          return unless Resque::Kubernetes.environments.include?(Rails.env)
-        end
+        return unless Resque::Kubernetes.enabled
 
         manager = JobsManager.new(self)
         manager.reap_finished_jobs

data/lib/resque/kubernetes/jobs_manager.rb

@@ -20,21 +20,17 @@ module Resque
 
       def reap_finished_jobs
         finished_jobs.each do |job|
-          begin
-            jobs_client.delete_job(job.metadata.name, job.metadata.namespace)
-          rescue KubeException => e
-            raise unless e.error_code == 404
-          end
+          jobs_client.delete_job(job.metadata.name, job.metadata.namespace)
+        rescue KubeException => e
+          raise unless e.error_code == 404
         end
       end
 
       def reap_finished_pods
         finished_pods.each do |pod|
-          begin
-            pods_client.delete_pod(pod.metadata.name, pod.metadata.namespace)
-          rescue KubeException => e
-            raise unless e.error_code == 404
-          end
+          pods_client.delete_pod(pod.metadata.name, pod.metadata.namespace)
+        rescue KubeException => e
+          raise unless e.error_code == 404
         end
       end
 
@@ -63,6 +59,7 @@ module Resque
 
       def client(scope)
         return RetriableClient.new(Resque::Kubernetes.kubeclient) if Resque::Kubernetes.kubeclient
+
         client = build_client(scope)
         RetriableClient.new(client) if client
       end
@@ -70,18 +67,19 @@ module Resque
       def build_client(scope)
         context = ContextFactory.context
         return unless context
+
         @default_namespace = context.namespace if context.namespace
 
-        Kubeclient::Client.new(context.endpoint + scope, context.version, context.options)
+        Kubeclient::Client.new(context.endpoint + scope, context.version, **context.options)
       end
 
       def finished_jobs
-        resque_jobs = jobs_client.get_jobs(label_selector: "resque-kubernetes=job")
+        resque_jobs = jobs_client.get_jobs({label_selector: "resque-kubernetes=job"})
         resque_jobs.select { |job| job.spec.completions == job.status.succeeded }
       end
 
       def finished_pods
-        resque_jobs = pods_client.get_pods(label_selector: "resque-kubernetes=pod")
+        resque_jobs = pods_client.get_pods({label_selector: "resque-kubernetes=pod"})
         resque_jobs.select do |pod|
           pod.status.phase == "Succeeded" && pod.status.containerStatuses.all? do |status|
             status.state.terminated.reason == "Completed"
@@ -90,10 +88,10 @@ module Resque
       end
 
       def jobs_maxed?(name, namespace)
-        resque_jobs = jobs_client.get_jobs(
-            label_selector: "resque-kubernetes=job,resque-kubernetes-group=#{name}",
-            namespace:      namespace
-        )
+        resque_jobs = jobs_client.get_jobs({
+                                               label_selector: "resque-kubernetes=job,resque-kubernetes-group=#{name}",
+                                               namespace:      namespace
+                                           })
         running = resque_jobs.reject { |job| job.spec.completions == job.status.succeeded }
         running.size >= owner.max_workers
       end

data/lib/resque/kubernetes/version.rb

@@ -2,6 +2,6 @@
 
 module Resque
   module Kubernetes
-    VERSION = "1.3.0"
+    VERSION = "3.0.0"
   end
 end

data/lib/resque/kubernetes.rb

@@ -19,8 +19,8 @@ module Resque
   module Kubernetes
     extend Configurable
 
-    # By default only manage kubernetes jobs in :production
-    define_setting :environments, ["production"]
+    # By default, this plugin is not active.
+    define_setting :enabled, false
 
     # Limit the number of workers that should be spun up, default 10
     define_setting :max_workers, 10

data/resque-kubernetes.gemspec

@@ -23,16 +23,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "appraisal"
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "bundler-audit", "~> 0"
-  spec.add_development_dependency "googleauth", "~> 0.6"
-  spec.add_development_dependency "rake", "~> 12.3"
-  spec.add_development_dependency "rspec", "~> 3.7"
-  # Pinned less than 0.56.0 until this is resolved: https://github.com/rubocop-hq/rubocop/issues/5975
-  spec.add_development_dependency "rubocop", "~> 0.52", ">= 0.52.1", "< 0.56.0"
+  spec.required_ruby_version = ">= 3.0"
 
-  spec.add_dependency "kubeclient", ">= 3.1.2", "< 5.0"
-  spec.add_dependency "resque", "~> 1.26"
+  spec.add_dependency "kubeclient", ">= 4.9.3", "< 5.0"
+  spec.add_dependency "resque", ">= 1.26"
   spec.add_dependency "retriable", "~> 3.0"
+  spec.metadata["rubygems_mfa_required"] = "true"
 end

metadata

@@ -1,132 +1,22 @@
 --- !ruby/object:Gem::Specification
 name: resque-kubernetes
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Jeremy Wadsack
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-12-11 00:00:00.000000000 Z
+date: 2023-05-06 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: appraisal
-  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: 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: bundler-audit
-  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: googleauth
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.3'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.7'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.52'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.52.1
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 0.56.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.52'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.52.1
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 0.56.0
 - !ruby/object:Gem::Dependency
   name: kubeclient
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.1.2
+        version: 4.9.3
     - - "<"
       - !ruby/object:Gem::Version
         version: '5.0'
@@ -136,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.1.2
+        version: 4.9.3
     - - "<"
       - !ruby/object:Gem::Version
         version: '5.0'
@@ -144,14 +34,14 @@ dependencies:
   name: resque
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.26'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.26'
 - !ruby/object:Gem::Dependency
@@ -189,7 +79,6 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- gemfiles/kubeclient_3.gemfile
 - gemfiles/kubeclient_4.gemfile
 - lib/resque/kubernetes.rb
 - lib/resque/kubernetes/configurable.rb
@@ -207,8 +96,9 @@ files:
 homepage: https://github.com/keylimetoolbox/resque-kubernetes
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -216,16 +106,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.2.33
+signing_key:
 specification_version: 4
 summary: Run Resque Jobs as Kubernetes Jobs
 test_files: []

data/gemfiles/kubeclient_3.gemfile

@@ -1,7 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "kubeclient", "3.1.2"
-
-gemspec path: "../"