train-kubernetes 0.1.12 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fcca2f4cc7de5b099cb5a3ee64e8ec7e935fdb986234d4ca9a3659d73efa874e
-  data.tar.gz: 15006a25d2cc0a823e21025d0b9f02cdd75bcefcac6965a28b17735147c1a4df
+  metadata.gz: 5d870645522d279417d494da837ce3cd98d606ceab682d975c287c91a5ea1f95
+  data.tar.gz: c704898863a9bc0599efef8e19b7dba031a4c12a92d2f6346c68e33f5982eca3
 SHA512:
-  metadata.gz: 17df60f7afdf0948ea15ce899b97b3aa33ba2173e87715c2b736783644a48aae037112188c570aab65f2cc3f40978e16c43c716c489623a7f556757b9204bfa6
-  data.tar.gz: 47f38cc6b1b41873f411da7a6fc3be723d2ead3cf5a0b225367a5bd6bfe518a57eb06f1805e1557d708d8e3c161881a4b4dbc6747aaaf0e760573795c5a43f38
+  metadata.gz: f1ca28a6b208f9998018f69516fcc71d6551295cc28ad99e94193556123833758b3d3ea2c0f276f79520586f2cbf140eedd1dbd387049ecbb69230a8e63e73b6
+  data.tar.gz: ee7fc4808bcb55449fa73c5213624c5ac322774f0728abef2bbd2c0160a04c02c25880ac7b54b1d1c15cef7731bc88118a1dab7c01d6343846b8baf57595dd1d

data/Gemfile

@@ -1,13 +1,19 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 gemspec
 
 # Remaining group is only used for development.
 group :development do
-  gem 'bundler'
-  gem 'byebug'
-  gem 'inspec', '>= 3.7.11' # We need InSpec for the test harness while developing.
-  gem 'minitest'
-  gem 'rake'
-  gem 'rubocop', '~> 0.59'
+  gem "bundler"
+  gem "byebug"
+  gem "inspec", ">= 5.22.72" # We need InSpec for the test harness while developing.
+  gem "minitest"
+  gem "mocha"
+  gem "rake"
+  gem "m"
+  gem "rubocop"
+  gem "chefstyle"
+  gem "simplecov"
+  gem "simplecov_json_formatter"
+  gem "github_changelog_generator"
 end

data/README.md

@@ -4,7 +4,7 @@ This plugin allows applications that rely on Train to communicate with the Kuber
 
 ## Usage
 
-When used in combination with the [InSpec Kubernetes Resource Pack](https://github.com/bgeesaman/inspec-k8s) you can validate the spec of any Kubernetes resource you have access to:
+When used in combination with the [InSpec Kubernetes Resource Pack](https://github.com/inspec/inspec-k8s) you can validate the spec of any Kubernetes resource you have access to:
 
 ```ruby
 describe k8sobjects(api: 'v1', type: 'pods', namespace: 'default', labelSelector: 'run=nginx') do
@@ -41,9 +41,10 @@ Currently it supports only Linux based containers
 - Ruby 2.4+
 - You have set the env var KUBECONFIG or have a valid ~/.kube/config
 
-
 ## Installation
 
+**_NOTE:_** **_The train-kubernetes plugin now comes included with InSpec 5.22.0 and later, and does not require installation separately._**
+
 Train plugins are distributed as gems.  You may choose to manage the gem yourself, but if you are an InSpec user, InSPec can handle it for you.
 
 First, run:
@@ -82,18 +83,18 @@ Families:  cloud, api
 Release:   0.1.3
 ```
 
-## Troubleshooting
+## Troubleshooting (Only applicable for InSpec version 5.21.* and earlier)
 
 If you run into issues installing via `inspec plugin install train-kubernetes`, try:
 
 * Try running `gem install train-kubernetes` before `inspec plugin install train-kubernetes`.
-* Ensure the `~/.inspec/plugins.json` has `"0.1.3"` and not `"= 0.1.3"` for the `version` value.  Modify it by hand if needed. 
+* Ensure the `~/.inspec/plugins.json` has `"0.1.3"` and not `"= 0.1.3"` for the `version` value.  Modify it by hand if needed.
 * Ensure you can cleanly install the `k8s-ruby` gem version `0.10.4` or greater.  e.g. `gem install k8s-ruby -v 0.10.4`
 * Ensure that only one version of the `excon` gem is installed.  e.g. `gem list | grep excon`.  If you see two versions, `gem uninstall excon` and remove the older version.
 
 ## Reporting Issues
 
-Bugs, typos, limitations, and frustrations are welcome to be reported through the [GitHub issues page for the train-kubernetes project](https://github.com/bgeesaman/train-kubernetes/issues).
+Bugs, typos, limitations, and frustrations are welcome to be reported through the [GitHub issues page for the train-kubernetes project](https://github.com/inspec/train-kubernetes/issues).
 
 You may also ask questions in the #inspec channel of the Chef Community Slack team.  However, for an issue to get traction, please report it as a github issue.
 

data/lib/train-kubernetes/connection.rb

@@ -1,7 +1,7 @@
-require 'train'
-require 'k8s-ruby'
-require 'train-kubernetes/platform'
-require 'train-kubernetes/kubectl_client'
+require "train"
+require "k8s-ruby"
+require "train-kubernetes/platform"
+require "train-kubernetes/kubectl_client"
 
 module TrainPlugins
   module TrainKubernetes
@@ -10,7 +10,7 @@ module TrainPlugins
 
       def initialize(options)
         super(options)
-        @pod = options[:pod] || options[:path]&.gsub('/', '')
+        @pod = options[:pod] || options[:path]&.gsub("/", "")
         @container = options[:container]
         @namespace = options[:namespace] || options[:host]
         parse_kubeconfig
@@ -31,7 +31,7 @@ module TrainPlugins
       end
 
       def unique_identifier
-        @client.transport.server.gsub(%r{(http|https)\:\/\/}, '') || 'default'
+        @client.transport.server.gsub(%r{(http|https)\:\/\/}, "") || "default"
       end
 
       def parse_kubeconfig
@@ -47,7 +47,7 @@ module TrainPlugins
         KubectlClient.new(pod: opts[:pod] || pod,
                           container: opts[:container] || container,
                           namespace: opts[:namespace] || namespace)
-                     .execute(cmd)
+          .execute(cmd)
       end
 
       def file_via_connection(path, **args)

data/lib/train-kubernetes/file/linux.rb

@@ -1,13 +1,13 @@
-require 'train/file/remote/linux'
-require 'train/extras/stat'
+require "train/file/remote/linux"
+require "train/extras/stat"
 
 module TrainPlugins
   module TrainKubernetes
     module File
       class Linux < ::Train::File::Remote::Linux
-        def initialize(backend, path, follow_symlink = true, pod:, **args)
+        def initialize(backend, path, pod:, follow_symlink: true, **args)
           @backend = backend
-          @path = path || ''
+          @path = path || ""
           @follow_symlink = follow_symlink
           @pod = pod
           @container = args[:container]
@@ -22,7 +22,7 @@ module TrainPlugins
 
           @content = @backend.run_command("cat #{@spath} || echo -n",
                                           { pod: pod, namespace: namespace, container: container })
-                             .stdout
+            .stdout
           return @content unless @content.empty?
 
           @content = nil if directory? || size.nil? || (size > 0)
@@ -30,7 +30,7 @@ module TrainPlugins
         end
 
         def content=(new_content)
-          execute_result = @backend.run_command('base64 --help', { pod: pod, namespace: namespace, container: container })
+          execute_result = @backend.run_command("base64 --help", { pod: pod, namespace: namespace, container: container })
           if execute_result.exit_status != 0
             raise TransportError, "#{self.class} found no base64 binary for file writes"
           end
@@ -46,10 +46,10 @@ module TrainPlugins
 
         def exist?
           @exist ||= begin
-            f = @follow_symlink ? '' : " || test -L #{@spath}"
+            f = @follow_symlink ? "" : " || test -L #{@spath}"
             @backend.run_command("test -e #{@spath}" + f,
                                  { pod: pod, namespace: namespace, container: container })
-                    .exit_status == 0
+              .exit_status == 0
           end
         end
 
@@ -70,8 +70,8 @@ module TrainPlugins
 
           @shallow_link_path ||=
             @backend.run_command("readlink #{@spath}", { pod: pod, namespace: namespace, container: container })
-                    .stdout
-                    .chomp
+              .stdout
+              .chomp
         end
 
         def stat
@@ -79,8 +79,8 @@ module TrainPlugins
             shell_escaped_path = @spath
             backend = @backend
             follow_symlink = @follow_symlink
-            lstat = follow_symlink ? ' -L' : ''
-            format = '--printf'
+            lstat = follow_symlink ? " -L" : ""
+            format = "--printf"
             res = backend.run_command("stat#{lstat} #{shell_escaped_path} 2>/dev/null #{format} '%s\n%f\n%U\n%u\n%G\n%g\n%X\n%Y\n%C'",
                                       { pod: pod, namespace: namespace, container: container })
             # ignore the exit_code: it is != 0 if selinux labels are not supported
@@ -92,7 +92,7 @@ module TrainPlugins
             tmask = fields[1].to_i(16)
             selinux = fields[8]
             ## selinux security context string not available on esxi
-            selinux = nil if (selinux == '?') || (selinux == '(null)') || (selinux == 'C')
+            selinux = nil if (selinux == "?") || (selinux == "(null)") || (selinux == "C")
             {
               type: Train::Extras::Stat.find_type(tmask),
               mode: tmask & 07777,
@@ -102,7 +102,7 @@ module TrainPlugins
               gid: fields[5].to_i,
               mtime: fields[7].to_i,
               size: fields[0].to_i,
-              selinux_label: selinux
+              selinux_label: selinux,
             }
           end
         end
@@ -118,13 +118,13 @@ module TrainPlugins
         def user_permissions
           return {} unless exist?
 
-          skip_reource '`user_permissions` is not supported on your Linux Containers yet.'
+          skip_reource "`user_permissions` is not supported on your Linux Containers yet."
         end
 
         def inherited?
           return false unless exist?
 
-          skip_resource '`inherited?` is not supported on your Linux Containers yet.'
+          skip_resource "`inherited?` is not supported on your Linux Containers yet."
         end
 
         private
@@ -133,10 +133,10 @@ module TrainPlugins
         def read_target_path
           full_path = @backend.run_command("readlink -n #{@spath} -f",
                                            { pod: pod, namespace: namespace, container: container })
-                              .stdout
+            .stdout
           # Needed for some OSes like OSX that returns relative path
           # when the link and target are in the same directory
-          if !full_path.start_with?('/') && full_path != ''
+          if !full_path.start_with?("/") && full_path != ""
             full_path = ::File.expand_path("../#{full_path}", @spath)
           end
           full_path

data/lib/train-kubernetes/file/linux_immutable_file_check.rb

@@ -1,5 +1,5 @@
-require 'inspec/resources/file'
-require 'inspec/exceptions'
+require "inspec/resources/file"
+require "inspec/exceptions"
 
 module TrainPlugins
   module TrainKubernetes
@@ -15,8 +15,8 @@ module TrainPlugins
         def find_utility_or_error(utility_name)
           %W(/usr/sbin/#{utility_name} /sbin/#{utility_name} /usr/bin/#{utility_name} /bin/#{utility_name} #{utility_name}).each do |cmd|
             if inspec.backend
-                     .run_command("sh -c 'type \"#{cmd}\"'", { pod: pod, container: container, namespace: namespace })
-                     .exit_status.to_i == 0
+                .run_command("sh -c 'type \"#{cmd}\"'", { pod: pod, container: container, namespace: namespace })
+                .exit_status.to_i == 0
               return cmd
             end
           end
@@ -27,7 +27,7 @@ module TrainPlugins
         def is_immutable?
           # Check if lsattr is available. In general, all linux system has lsattr & chattr
           # This logic check is valid for immutable flag set with chattr
-          utility = find_utility_or_error('lsattr')
+          utility = find_utility_or_error("lsattr")
 
           utility_cmd = inspec.backend.run_command("#{utility} #{file_path}",
                                                    { pod: pod, container: container, namespace: namespace })
@@ -37,7 +37,7 @@ module TrainPlugins
           # General output for lsattr file_name is:
           # ----i---------e----- file_name
           # The fifth char resembles the immutable flag. Total 20 flags are allowed.
-          lsattr_info = utility_cmd.stdout.strip.squeeze(' ')
+          lsattr_info = utility_cmd.stdout.strip.squeeze(" ")
           lsattr_info =~ /^.{4}i.{15} .*/
         end
 

data/lib/train-kubernetes/kubectl_client.rb

@@ -1,12 +1,12 @@
-require 'mixlib/shellout'
-require 'train/extras'
+require "mixlib/shellout" unless defined?(Mixlib::ShellOut)
+require "train/extras"
 
 module TrainPlugins
   module TrainKubernetes
     class KubectlClient
       attr_reader :pod, :container, :namespace
 
-      DEFAULT_NAMESPACE = 'default'.freeze
+      DEFAULT_NAMESPACE = "default".freeze
 
       def initialize(pod:, namespace: nil, container: nil)
         @pod = pod
@@ -20,7 +20,7 @@ module TrainPlugins
         res = shell.run_command
         Train::Extras::CommandResult.new(res.stdout, res.stderr, res.exitstatus)
       rescue Errno::ENOENT => _e
-        Train::Extras::CommandResult.new('', '', 1)
+        Train::Extras::CommandResult.new("", "", 1)
       end
 
       private
@@ -30,12 +30,12 @@ module TrainPlugins
       end
 
       def build_instruction(command, stdin, _tty)
-        ['kubectl exec'].tap do |arr|
-          arr << '--stdin' if stdin
+        ["kubectl exec"].tap do |arr|
+          arr << "--stdin" if stdin
           arr << pod if pod
-          arr << '-n'
+          arr << "-n"
           arr << namespace
-          arr << '--'
+          arr << "--"
           arr << command
         end.join("\s")
       end

data/lib/train-kubernetes/platform.rb

@@ -2,8 +2,8 @@ module TrainPlugins
   module TrainKubernetes
     module Platform
       def platform
-        Train::Platforms.name('k8s').in_family('cloud')
-        force_platform!('k8s', release: TrainPlugins::TrainKubernetes::VERSION)
+        Train::Platforms.name("k8s").in_family("cloud")
+        force_platform!("k8s", release: TrainPlugins::TrainKubernetes::VERSION)
       end
     end
   end

data/lib/train-kubernetes/transport.rb

@@ -1,10 +1,10 @@
-require 'train-kubernetes/connection'
+require "train-kubernetes/connection"
 
 module TrainPlugins
   module TrainKubernetes
     class Transport < Train.plugin(1)
-      name 'k8s'
-      option :kubeconfig, default: ENV['KUBECONFIG'] || '~/.kube/config'
+      name "k8s"
+      option :kubeconfig, default: ENV["KUBECONFIG"] || "~/.kube/config"
       option :pod, default: nil
       option :container, default: nil
       option :namespace, default: nil

data/lib/train-kubernetes/version.rb

@@ -5,6 +5,6 @@
 
 module TrainPlugins
   module TrainKubernetes
-    VERSION = '0.1.12'.freeze
+    VERSION = "0.3.1".freeze
   end
 end

data/lib/train-kubernetes.rb

@@ -12,10 +12,10 @@ libdir = File.dirname(__FILE__)
 $LOAD_PATH.unshift(libdir) unless $LOAD_PATH.include?(libdir)
 
 # It's traditional to keep your gem version in a separate file, so CI can find it easier.
-require 'train-kubernetes/version'
+require "train-kubernetes/version"
 
 # A train plugin has three components: Transport, Connection, and Platform.
 # Transport acts as the glue.
-require 'train-kubernetes/transport'
-require 'train-kubernetes/platform'
-require 'train-kubernetes/file/linux'
+require "train-kubernetes/transport"
+require "train-kubernetes/platform"
+require "train-kubernetes/file/linux"

data/train-kubernetes.gemspec

@@ -5,24 +5,24 @@
 # It is traditional in a gemspec to dynamically load the current version
 # from a file in the source tree.  The next three lines make that happen.
 # lib = File.expand_path('../lib', __FILE__)
-lib = File.expand_path('lib', __dir__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'train-kubernetes/version'
+require "train-kubernetes/version"
 
 Gem::Specification.new do |spec|
   # Importantly, all Train plugins must be prefixed with `train-`
-  spec.name          = 'train-kubernetes'
+  spec.name          = "train-kubernetes"
 
   # It is polite to namespace your plugin under TrainPlugins::YourPluginInCamelCase
   spec.version       = TrainPlugins::TrainKubernetes::VERSION
-  spec.authors       = ['Brad Geesaman']
-  spec.email         = ['bradgeesaman@gmail.com']
-  spec.summary       = 'Train Kubernetes'
+  spec.authors       = ["Brad Geesaman"]
+  spec.email         = ["bradgeesaman@gmail.com"]
+  spec.summary       = "Train Kubernetes"
   spec.description   = 'A Train "transport" plugin for Chef Inspec that allows testing of all Kubernetes API resources'
-  spec.homepage      = 'https://github.com/bgeesaman/train-kubernetes'
-  spec.license       = 'Apache-2.0'
+  spec.homepage      = "https://github.com/inspec/train-kubernetes"
+  spec.license       = "Apache-2.0"
 
-  spec.required_ruby_version = '>= 2.4'
+  spec.required_ruby_version = ">= 3.1"
 
   # Though complicated-looking, this is pretty standard for a gemspec.
   # It just filters what will actually be packaged in the gem (leaving
@@ -30,9 +30,9 @@ Gem::Specification.new do |spec|
   spec.files = %w{
     README.md train-kubernetes.gemspec Gemfile
   } + Dir.glob(
-    'lib/**/*', File::FNM_DOTMATCH
+    "lib/**/*", File::FNM_DOTMATCH
   ).reject { |f| File.directory?(f) }
-  spec.require_paths = ['lib']
+  spec.require_paths = ["lib"]
 
   # If you rely on any other gems, list them here with any constraints.
   # This is how `inspec plugin install` is able to manage your dependencies.
@@ -44,7 +44,9 @@ Gem::Specification.new do |spec|
   # Do not list inspec as a dependency of the train plugin.
 
   # All plugins should mention train, > 1.4
-  # pinning k8s-ruby to 0.10.5 to avoid broken dry-type gem upgrades from k8s-ruby
-  spec.add_dependency 'k8s-ruby', '~> 0.14.0'
-  spec.add_dependency 'train', '~> 3.0'
+  # pinning k8s-ruby to greater than 0.17.0 since it has support for Ruby version 3.4
+  # pinning k8s-ruby to be greater than 0.17.2 since it removes the breaking change for
+  # windows builds introduced in 0.17.1
+  spec.add_dependency "k8s-ruby", ">= 0.17.2"
+  spec.add_dependency "train", "~> 3.0"
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: train-kubernetes
 version: !ruby/object:Gem::Version
-  version: 0.1.12
+  version: 0.3.1
 platform: ruby
 authors:
 - Brad Geesaman
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-14 00:00:00.000000000 Z
+date: 2025-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: k8s-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: 0.17.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: 0.17.2
 - !ruby/object:Gem::Dependency
   name: train
   requirement: !ruby/object:Gem::Requirement
@@ -58,11 +58,11 @@ files:
 - lib/train-kubernetes/transport.rb
 - lib/train-kubernetes/version.rb
 - train-kubernetes.gemspec
-homepage: https://github.com/bgeesaman/train-kubernetes
+homepage: https://github.com/inspec/train-kubernetes
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -70,15 +70,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.3.27
+signing_key: 
 specification_version: 4
 summary: Train Kubernetes
 test_files: []