test-kitchen 3.3.1 → 3.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cbe0ba6a501464b8f253beca9d017b7d09a90fa5f4407e775d5fe31b81f610da
-  data.tar.gz: c7e0c062a903e1be1fd5425f692fecdd28d29841a5bee156b89a0d7149a25b10
+  metadata.gz: 0b2b5ae9a13717d2eb6e02314305d2ee451bdf5739a396ffd649eeb03bd2cbd1
+  data.tar.gz: 2552cb2ca280b5f696fc17ed7f1346c7b9c9320d6d0f8b5bd729bb7ee23bd480
 SHA512:
-  metadata.gz: abb1d27365dcdbfe5eaccffe717d7391f63a8784a75ee79bb44b8a5ba23d72d17bd7bd01a3d375454111ddcd0425874f0fa7b14dcdd2cf461ccdf978426f99c3
-  data.tar.gz: 6bd22f60e9f13a0b74f1c4c4598be74071640f5593f7039f030aa5c95de1a595e5a6401eb092eee2f165715d28202bb0b43324e16b5393a96dc256b993d05109
+  metadata.gz: cd7e48cec7ae4a0a959dc58bdcb196549a432177b8338340d774c9b20165efa95306dcc3f5b1c4aebd8da225462165b5a3d0e5dadbdc1a8d07fd7f282046d0c8
+  data.tar.gz: cef3fceeb5cc11c249b814fc3681187207eaeadc92dd499f422555ce69992bc57ce8d9177e4e637e57433a6515cc5275b1dbeae60c78b8b10605fa4370980e41

data/lib/kitchen/lifecycle_hook/base.rb

@@ -1,3 +1,5 @@
+require_relative "../platform_filter"
+
 module Kitchen
   class LifecycleHook
     class Base
@@ -59,14 +61,14 @@ module Kitchen
         lifecycle_hooks.state_file
       end
 
-      # @return [Array<String>] names of excluded platforms
+      # @return [Array<PlatformFilter>] names of excluded platforms
       def excludes
-        @excludes ||= hook.fetch(:excludes, [])
+        @excludes ||= PlatformFilter.convert(hook.fetch(:excludes, []))
       end
 
-      # @return [Array<String>] names of only included platforms
+      # @return [Array<PlatformFilter>] names of only included platforms
       def includes
-        @includes ||= hook.fetch(:includes, [])
+        @includes ||= PlatformFilter.convert(hook.fetch(:includes, []))
       end
 
       # @return [String]

data/lib/kitchen/platform_filter.rb

@@ -0,0 +1,72 @@
+#
+# Author:: Baptiste Courtois (<b.courtois@criteo.com>)
+#
+# Copyright (C) 2021, Baptiste Courtois
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Kitchen
+  # A wrapper on Regexp and strings to mix them in platform filters.
+  #
+  # This should handle backward compatibility in most cases were
+  # platform are matched against a filters array using Array.include?
+  #
+  # This wrapper does not work if filters arrays are converted to Set.
+  #
+  # @author Baptiste Courtois <b.courtois@criteo.com>
+  class PlatformFilter
+    # Pattern used to determine whether a filter should be handled as a Regexp
+    REGEXP_LIKE_PATTERN = %r{^/(?<pattern>.*)/(?<options>[ix]*)$}.freeze
+
+    # Converts platform filters into an array of PlatformFilter handling both strings and Regexp.
+    # A string "looks-like" a regexp if it starts by / and end by / + Regexp options i or x
+    #
+    # @return [Array] filters with regexp-like string converted to PlatformRegexpFilter
+    def self.convert(filters)
+      ::Kernel.Array(filters).map do |filter|
+        if (match = filter.match(REGEXP_LIKE_PATTERN))
+          options = match["options"].include?("i") ? ::Regexp::IGNORECASE : 0
+          options |= ::Regexp::EXTENDED if match["options"].include?("x")
+          filter = ::Regexp.new(match["pattern"], options)
+        end
+        new(filter)
+      end
+    end
+
+    # @return [Regexp] value of this filter
+    attr_reader :value
+
+    # Constructs a new filter.
+    #
+    # @param [Regexp,String] value of the filter
+    def initialize(value)
+      raise ::ArgumentError, "PlatformFilter#new requires value to be a String or a Regexp" unless value.is_a?(::Regexp) || value.is_a?(::String)
+
+      @value = value
+    end
+
+    # Override of the equality operator to check whether the wrapped Regexp match the given object.
+    #
+    # @param [Object] other object to compare to
+    # @return [Boolean] whether the objects are equal or the wrapped Regexp matches the given string or symbol
+    def ==(other)
+      if @value.is_a?(::Regexp) && (other.is_a?(::String) || other.is_a?(::Symbol))
+        @value =~ other
+      else
+        other == @value
+      end
+    end
+
+    alias eq? ==
+  end
+end

data/lib/kitchen/suite.rb

@@ -15,6 +15,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require_relative "platform_filter"
+
 module Kitchen
   # A logical configuration representing a test case or fixture that will be
   # executed on a platform.
@@ -41,8 +43,8 @@ module Kitchen
       @name = options.fetch(:name) do
         raise ClientError, "Suite#new requires option :name"
       end
-      @excludes = options.fetch(:excludes, [])
-      @includes = options.fetch(:includes, [])
+      @excludes = PlatformFilter.convert(options.fetch(:excludes, []))
+      @includes = PlatformFilter.convert(options.fetch(:includes, []))
     end
   end
 end

data/lib/kitchen/version.rb

@@ -16,5 +16,5 @@
 # limitations under the License.
 
 module Kitchen
-  VERSION = "3.3.1".freeze
+  VERSION = "3.3.2".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test-kitchen
 version: !ruby/object:Gem::Version
-  version: 3.3.1
+  version: 3.3.2
 platform: ruby
 authors:
 - Fletcher Nichol
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-04 00:00:00.000000000 Z
+date: 2022-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mixlib-shellout
@@ -440,6 +440,7 @@ files:
 - lib/kitchen/login_command.rb
 - lib/kitchen/metadata_chopper.rb
 - lib/kitchen/platform.rb
+- lib/kitchen/platform_filter.rb
 - lib/kitchen/plugin.rb
 - lib/kitchen/plugin_base.rb
 - lib/kitchen/provisioner.rb
@@ -520,7 +521,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.11
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: Test Kitchen is an integration tool for developing and testing infrastructure