krane 2.3.4 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e1fd1232d053c7f2bc648a315551c103ebd4792165f7b8c9b81f1c0b2f810bc
-  data.tar.gz: 214360319ed90c6bc752d99ee1b3e08244703ad56d3b5e964993fccee2b7562c
+  metadata.gz: 8100399551f3e460863aa36cd1be88385a4dc648701f53a0be2bf13005796b63
+  data.tar.gz: f5842c8d9d7f71ba9e7b0b5b2b16d956b4ba71931571d9badf3d7bc2a4eae846
 SHA512:
-  metadata.gz: a98198f5aed91b383295bf7ddcd9dad6bdcc68d5361582ef873fa53b7b191d92963c9bd359c841f0c95b7e3c007e0f32dbc331019d5c8a4bf2c4358ccf0aac5c
-  data.tar.gz: 6267bef54343cdf3c301cab0bd377a1d6110b1c2862bdf2dc5288fd0ffba8337a1cc88aa7e708e8a19dd042646699e3ad64c3d23171e0f23a9a5f5a85fcf470c
+  metadata.gz: 4ed454e7264750fd9b44ab0f3badbff014eb511b3ecd4696dce0b72cee7da2a0efdfac92a65214ead36fc336b941be6869e4282f47846e9dfbd2d9230a8a1607
+  data.tar.gz: 6be5ba46142a43dd1965dca486de1e42020b7aa7c9a806d21a150bb581598dfdf8bb203361be97072a6f7e18a6041335ce722073bc5cd6830f2444828c423484

data/.github/workflows/ci.yml

@@ -0,0 +1,66 @@
+name: Krane CI
+
+on: [push]
+
+jobs:
+  ruby-tests:
+    runs-on: ubuntu-latest
+
+    name: "Tests - Ruby ${{ matrix.ruby }} with k8s ${{ matrix.kubernetes_version }}"
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+        # Use unique Ruby versions, or GitHub gets confused when building the rest of the matrix
+        - '3.0.3' # With k8s 1.23
+        - '3.0.2' # With k8s 1.22
+        - '3.0.1' # With k8s 1.21
+        - '3.0' # With k8s 1.20
+        - '2.7' # With k8s 1.19
+        include:
+        # Match kind images with chosen version https://github.com/kubernetes-sigs/kind/releases
+        - ruby: '3.0.3'
+          kind_version: 'v0.11.1'
+          kubernetes_version: '1.23.0'
+          kind_image: 'kindest/node:v1.23.0@sha256:49824ab1727c04e56a21a5d8372a402fcd32ea51ac96a2706a12af38934f81ac'
+        - ruby: '3.0.2'
+          kind_version: 'v0.11.1'
+          kubernetes_version: '1.22.0'
+          kind_image: 'kindest/node:v1.22.0@sha256:b8bda84bb3a190e6e028b1760d277454a72267a5454b57db34437c34a588d047'
+        - ruby: '3.0.1'
+          kind_version: 'v0.11.1'
+          kubernetes_version: '1.21.1'
+          kind_image: 'kindest/node:v1.21.1@sha256:69860bda5563ac81e3c0057d654b5253219618a22ec3a346306239bba8cfa1a6'
+        - ruby: '3.0'
+          kind_version: 'v0.11.1'
+          kubernetes_version: '1.20.7'
+          kind_image: 'kindest/node:v1.20.7@sha256:cbeaf907fc78ac97ce7b625e4bf0de16e3ea725daf6b04f930bd14c67c671ff9'
+        - ruby: '2.7'
+          kind_version: 'v0.11.1'
+          kubernetes_version: '1.19.11'
+          kind_image: 'kindest/node:v1.19.11@sha256:07db187ae84b4b7de440a73886f008cf903fcf5764ba8106a9fd5243d6f32729'
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Ruby ${{ matrix.ruby }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Setup kubectl
+        run: |
+          mkdir -p "${GITHUB_WORKSPACE}/bin"
+          curl -o "${GITHUB_WORKSPACE}/bin/kubectl" -LO "https://dl.k8s.io/release/v${{ matrix.kubernetes_version }}/bin/linux/amd64/kubectl"
+          chmod +x "${GITHUB_WORKSPACE}/bin/kubectl"
+          echo "PATH=$GITHUB_WORKSPACE/bin:${PATH}" >> $GITHUB_ENV
+
+      - uses: engineerd/setup-kind@v0.5.0
+        with:
+          version: "${{ matrix.kind_version }}"
+          image: "${{ matrix.kind_image }}"
+
+      - name: Run tests
+        run: |
+          bin/test

data/.gitignore

@@ -15,3 +15,4 @@ dev/flamegraph.svg
 dev/profile
 dev/flamegraph.pl
 .local-context
+bin/kind

data/CHANGELOG.md

@@ -1,5 +1,27 @@
 ## next
 
+## 2.4.0
+
+*Enhancements*
+
+- Ensure deploy tasks fail without at least one non-empty resource [#865](https://github.com/Shopify/krane/issues/865)
+
+*Other*
+
+- Remove Ruby 2.6 and K8s < 1.19 from the CI testing matrix. All fixtures have been updated to be compatible with K8s 1.22+.
+
+## 2.3.7
+
+- isolated_execution_state active_support require for Rails 7+
+
+## 2.3.6
+
+- Update kubeclient for better Ruby 3.1 compatibility.
+
+## 2.3.5
+
+- Psych 4 compatibility
+
 ## 2.3.4
 
 - Fix for [CVE-2021-41817](https://www.ruby-lang.org/en/news/2021/11/15/date-parsing-method-regexp-dos-cve-2021-41817/). See [ServicesDB action item here](https://services.shopify.io/action_items/definitions/isolated/59).

data/README.md

@@ -74,23 +74,23 @@ If you need the ability to render dynamic values in templates before deploying,
 ## Prerequisites
 
 * Ruby 2.6+
-* Your cluster must be running Kubernetes v1.15.0 or higher<sup>1</sup>
+* Your cluster must be running Kubernetes v1.19.0 or higher<sup>1</sup>
 
 <sup>1</sup> We run integration tests against these Kubernetes versions. You can find our
 official compatibility chart below.
 
-| Kubernetes version | Last officially supported in gem version |
-| :----------------: | :-------------------: |
-|        1.5         |        0.11.2         |
-|        1.6         |        0.15.2         |
-|        1.7         |        0.20.6         |
-|        1.8         |        0.21.1         |
-|        1.9         |        0.24.0         |
-|        1.10        |        0.27.0         |
+| Kubernetes version | Currently Tested? | Last officially supported in gem version |
+|:------------------:|-------------------|:----------------------------------------:|
+|        1.18        | No                |                  2.3.7                   |
+|        1.19        | Yes               |                    --                    |
+|        1.20        | Yes               |                    --                    |
+|        1.21        | Yes               |                    --                    |
+|        1.22        | Yes               |                    --                    |
+|        1.23        | Yes               |                    --                    |
 
 ## Installation
 
-1. [Install kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/#install-kubectl-binary-via-curl) (requires v1.15.0 or higher) and make sure it is available in your $PATH
+1. [Install kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/#install-kubectl-binary-via-curl) (requires v1.19.0 or higher) and make sure it is available in your $PATH
 2. Set up your [kubeconfig file](https://kubernetes.io/docs/tasks/access-application-cluster/authenticate-across-clusters-kubeconfig/) for access to your cluster(s).
 3. `gem install krane`
 

data/Rakefile

@@ -7,6 +7,7 @@ Rake::TestTask.new(:integration_test) do |t|
   t.libs << "test"
   t.libs << "lib"
   t.test_files = FileList['test/integration/**/*_test.rb']
+  t.warning = !ENV.key?('CI')
 end
 
 desc("Run integration tests that CANNOT be run in parallel")
@@ -14,6 +15,7 @@ Rake::TestTask.new(:serial_integration_test) do |t|
   t.libs << "test"
   t.libs << "lib"
   t.test_files = FileList['test/integration-serial/**/*_test.rb']
+  t.warning = !ENV.key?('CI')
 end
 
 desc("Run unit tests")
@@ -21,6 +23,7 @@ Rake::TestTask.new(:unit_test) do |t|
   t.libs << "test"
   t.libs << "lib"
   t.test_files = FileList['test/unit/**/*_test.rb']
+  t.warning = !ENV.key?('CI')
 end
 
 desc("Run cli tests")
@@ -28,6 +31,7 @@ Rake::TestTask.new(:cli_test) do |t|
   t.libs << "test"
   t.libs << "lib"
   t.test_files = FileList['test/exe/**/*_test.rb']
+  t.warning = !ENV.key?('CI')
 end
 
 desc("Run all tests")

data/bin/test

@@ -27,9 +27,10 @@ if [[ ${PARALLELISM:=0} -lt 1 ]]; then
   fi
 fi
 
-if [[ ${CI:="0"} == "1" ]]; then
-  echo "--- :ruby: Bundle Install"
-  bundle install --jobs 4
+if [[ "${CI:-0}" != "0" ]]; then
+  SCRIPT_DIR="$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )"
+  echo "kind-kind" > "${SCRIPT_DIR}/../.local-context"
+  PARALLELISM=2
 fi
 
 print_header "Run CLI Tests"

data/dev.yml

@@ -1,22 +1,22 @@
 ---
 name: krane
 up:
-  - ruby: 2.6.6 # Matches gemspec
+  - ruby: '3.0.3' # Matches gemspec
   - bundler
-  - homebrew:
-    - minikube
-    - hyperkit
   - custom:
-      name: Install the minikube fork of driver-hyperkit
-      met?: command -v docker-machine-driver-hyperkit
-      meet: curl -LO https://storage.googleapis.com/minikube/releases/latest/docker-machine-driver-hyperkit && sudo install -o root -g wheel -m 4755 docker-machine-driver-hyperkit /usr/local/bin/ && rm ./docker-machine-driver-hyperkit
+      name: Install Kubernetes in Docker (KinD)
+      met?: bin/kind version 2>&1 | grep -q v0.11.1
+      meet: |
+        mkdir -p bin
+        curl -sLo bin/kind "https://github.com/kubernetes-sigs/kind/releases/download/v0.11.1/kind-darwin-amd64"
+        chmod +x bin/kind
   - custom:
-      name: Minikube Cluster
-      met?: test $(minikube status | grep Running | wc -l) -ge 2 && $(minikube status | grep -q 'Configured')
-      meet: minikube start --kubernetes-version=v1.18.18 --vm-driver=hyperkit
-      down: minikube stop
+      name: Create KinD Cluster
+      met?: bin/kind get clusters | grep -q krane
+      meet: bin/kind create cluster --name krane --image "kindest/node:v1.22.0@sha256:b8bda84bb3a190e6e028b1760d277454a72267a5454b57db34437c34a588d047"
+      down: |
+        ((bin/kind get clusters | grep -q krane) && bin/kind delete cluster --name krane) || true
 commands:
-  reset-minikube: minikube delete && rm -rf ~/.minikube
   test:
     run: bin/test
   tophat:

data/krane.gemspec

@@ -27,21 +27,19 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.6.0'
   spec.add_dependency("activesupport", ">= 5.0")
-  spec.add_dependency("cgi")
-  spec.add_dependency("date")
-  spec.add_dependency("kubeclient", "~> 4.3")
+  spec.add_dependency("kubeclient", "~> 4.9")
   spec.add_dependency("googleauth", "~> 0.8")
   spec.add_dependency("ejson", "~> 1.0")
   spec.add_dependency("colorize", "~> 0.8")
   spec.add_dependency("statsd-instrument", ['>= 2.8', "< 4"])
   spec.add_dependency("oj", "~> 3.0")
   spec.add_dependency("concurrent-ruby", "~> 1.1")
-  spec.add_dependency("jsonpath", "~> 0.9.6")
+  spec.add_dependency("jsonpath", "~> 1.0")
   spec.add_dependency("thor", ">= 1.0", "< 2.0")
 
   # Basics
   spec.add_development_dependency("bundler")
-  spec.add_development_dependency("rake", "~> 10.0")
+  spec.add_development_dependency("rake", "~> 13.0")
   spec.add_development_dependency("yard")
 
   # Test framework

data/lib/krane/common.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'active_support'
+require 'active_support/isolated_execution_state' if ActiveSupport::VERSION::MAJOR > 6
 require 'active_support/core_ext/object/blank'
 require 'active_support/core_ext/hash/reverse_merge'
 require 'active_support/core_ext/hash/slice'

data/lib/krane/deploy_task.rb

@@ -254,6 +254,10 @@ module Krane
 
       StatsD.client.gauge('discover_resources.count', resources.size, tags: statsd_tags)
 
+      if resources.empty?
+        raise FatalDeploymentError, "No deployable resources were found!"
+      end
+
       resources.sort
     rescue InvalidTemplateError => e
       record_invalid_template(logger: @logger, err: e.message, filename: e.filename,

data/lib/krane/kubernetes_resource/custom_resource_definition.rb

@@ -37,7 +37,10 @@ module Krane
 
     def group_version_kind
       group = @definition.dig("spec", "group")
-      version = @definition.dig("spec", "version")
+      # Since 1.22: spec.version is removed in v1; use spec.versions instead.
+      # New spec here: https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/#create-a-customresourcedefinition
+      # This is only used in testing, so we will simply take the first version we see:
+      version = @definition.dig("spec", "versions", 0, "name")
       "#{group}/#{version}/#{kind}"
     end
 

data/lib/krane/kubernetes_resource/mutating_webhook_configuration.rb

@@ -48,6 +48,7 @@ module Krane
       end
 
       def has_side_effects?
+        # Note: After K8s 1.22, this should ALWAYS be false.
         !%w(None NoneOnDryRun).include?(side_effects)
       end
 

data/lib/krane/kubernetes_resource.rb

@@ -584,7 +584,12 @@ module Krane
     # If the resource template uses generateName, validating with apply will fail
     def validate_with_local_dry_run(kubectl)
       verb = deploy_method == :apply ? "apply" : "create"
-      command = [verb, "-f", file_path, "--dry-run", "--output=name"]
+      command = if kubectl.client_version >= Gem::Version.new('1.18')
+        [verb, "-f", file_path, "--dry-run=client", "--output=name"]
+      else
+        [verb, "-f", file_path, "--dry-run", "--output=name"]
+      end
+
       kubectl.run(*command, log_failure: false, output_is_sensitive: sensitive_template_content?,
         retry_whitelist: [:client_timeout, :empty, :context_deadline], attempts: 3, use_namespace: !global?)
     end

data/lib/krane/render_task.rb

@@ -73,7 +73,7 @@ module Krane
       file_basename = File.basename(filename)
       @logger.info("Rendering #{file_basename}...")
       implicit = []
-      YAML.parse_stream(rendered_content, "<rendered> #{filename}") { |d| implicit << d.implicit }
+      YAML.parse_stream(rendered_content, filename: "<rendered> #{filename}") { |d| implicit << d.implicit }
       if rendered_content.present?
         stream.puts "---\n" if implicit.first
         stream.puts rendered_content

data/lib/krane/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Krane
-  VERSION = "2.3.4"
+  VERSION = "2.4.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: krane
 version: !ruby/object:Gem::Version
-  version: 2.3.4
+  version: 2.4.0
 platform: ruby
 authors:
 - Katrina Verey
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-24 00:00:00.000000000 Z
+date: 2022-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -26,48 +26,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
-- !ruby/object:Gem::Dependency
-  name: cgi
-  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: date
-  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: kubeclient
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.3'
+        version: '4.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.3'
+        version: '4.9'
 - !ruby/object:Gem::Dependency
   name: googleauth
   requirement: !ruby/object:Gem::Requirement
@@ -164,14 +136,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.6
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.6
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -212,14 +184,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -444,11 +416,10 @@ files:
 - ".github/ISSUE_TEMPLATE.md"
 - ".github/probots.yml"
 - ".github/pull_request_template.md"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rubocop-http---shopify-github-io-ruby-style-guide-rubocop-yml"
 - ".rubocop.yml"
-- ".shopify-build/VERSION"
-- ".shopify-build/krane.yml"
 - 1.0-Upgrade.md
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md

data/.shopify-build/VERSION

@@ -1 +0,0 @@
-v1

data/.shopify-build/krane.yml

@@ -1,48 +0,0 @@
-containers:
-  default:
-    docker: circleci/ruby:2.6.6
-
-steps:
-  - label: Lint
-    timeout: 5m
-    run:
-      - bundle: ~
-      - bundle exec rubocop
-  - label: 'Run Test Suite (:kubernetes: 1.21-latest :ruby: 3.0)'
-    command: bin/ci
-    agents:
-      queue: k8s-ci
-    env:
-      LOGGING_LEVEL: "4"
-      KUBERNETES_VERSION: v1.21-latest
-      RUBY_VERSION: "3.0"
-  - label: 'Run Test Suite (:kubernetes: 1.20-latest :ruby: 3.0)'
-    command: bin/ci
-    agents:
-      queue: k8s-ci
-    env:
-      LOGGING_LEVEL: "4"
-      KUBERNETES_VERSION: v1.20-latest
-      RUBY_VERSION: "3.0"
-  - label: 'Run Test Suite (:kubernetes: 1.19-latest :ruby: 2.7)'
-    command: bin/ci
-    agents:
-      queue: k8s-ci
-    env:
-      LOGGING_LEVEL: "4"
-      KUBERNETES_VERSION: v1.19-latest
-      RUBY_VERSION: "2.7"
-  - label: 'Run Test Suite (:kubernetes: 1.18-latest)'
-    command: bin/ci
-    agents:
-      queue: k8s-ci
-    env:
-      LOGGING_LEVEL: "4"
-      KUBERNETES_VERSION: v1.18-latest
-  - label: 'Run Test Suite (:kubernetes: 1.17-latest)'
-    command: bin/ci
-    agents:
-      queue: k8s-ci
-    env:
-      LOGGING_LEVEL: "4"
-      KUBERNETES_VERSION: v1.17-latest