fix rubocop offenses, add .rubocop_todo.yml, reactivate rubocop in th…

…e CI

.github/workflows/ci.yml

@@ -14,5 +14,3 @@ jobs:
  puppet:
  name: Puppet
  uses: voxpupuli/gha-puppet/.github/workflows/basic.yml@v1
- with:
- rubocop: false

.rubocop.yml

@@ -1,4 +1,6 @@
 ---
+inherit_from: .rubocop_todo.yml
+
 # Managed by modulesync - DO NOT EDIT
 # https://voxpupuli.org/docs/updating-files-managed-with-modulesync/
 

.rubocop_todo.yml

@@ -0,0 +1,23 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2023-03-01 07:21:23 UTC using RuboCop version 1.22.3.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 34
+# Configuration parameters: .
+# SupportedStyles: have_received, receive
+RSpec/MessageSpies:
+ EnforcedStyle: receive
+
+# Offense count: 17
+# Configuration parameters: AllowSubject.
+RSpec/MultipleMemoizedHelpers:
+ Max: 8
+
+# Offense count: 9
+RSpec/StubbedMock:
+ Exclude:
+ - 'spec/unit/puppet/provider/kubectl_apply_resource/kubectl_spec.rb'

lib/puppet/functions/k8s/format_url.rb

@@ -30,13 +30,13 @@ def k8s_format_binary(url, components)
  kernel_ext = 'zip'
  kernel_ext = 'tar.gz' if kernel == 'linux'
 
- components = Hash[components.map { |k, v| [k.to_sym, v] }].merge(
+ components = components.transform_keys(&:to_sym).merge(
  arch: arch,
  underscore_arch_suffix: underscore_arch_suffix,
  dash_arch_suffix: dash_arch_suffix,
  k3s_arch: k3s_arch,
  kernel: kernel,
- kernel_ext: kernel_ext,
+ kernel_ext: kernel_ext
  )
 
  url % components

lib/puppet/provider/kubeconfig/ruby.rb

@@ -139,6 +139,7 @@ def credentials_valid?
 
  return false unless user['name'] == resource[:user]
  return false unless user['user']
+
  if resource[:client_cert]
  if resource[:embed_certs] == :true
  wanted = Base64.strict_encode64(File.read(resource[:client_cert]))

lib/puppet/provider/kubectl_apply/file.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require File.expand_path('../../../util/k8s', __FILE__)
+require File.expand_path('../../util/k8s', __dir__)
 
 # Applies resources as YAML files on disk
 Puppet::Type.type(:kubectl_apply).provide(:file) do
@@ -54,7 +54,7 @@ def file_get
  return nil unless File.exist? resource[:file]
 
  JSON.parse(File.read(resource[:file]))
- rescue
+ rescue StandardError
  {}
  end
 end

lib/puppet/provider/kubectl_apply/kubectl.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require File.expand_path('../../../util/k8s', __FILE__)
+require File.expand_path('../../util/k8s', __dir__)
 require 'tempfile'
 
 # Applies resources as data in a Kubernetes cluster

lib/puppet/type/kubeconfig.rb

@@ -49,9 +49,7 @@ def retrieve
  desc 'An arbitrary path used as the identity of the resource.'
 
  validate do |value|
- unless Puppet::Util.absolute_path?(value)
- raise Puppet::Error, "File paths must be fully qualified, not '#{value}'"
- end
+ raise Puppet::Error, "File paths must be fully qualified, not '#{value}'" unless Puppet::Util.absolute_path?(value)
  end
  end
 
@@ -105,27 +103,21 @@ def retrieve
  desc 'The path to a CA certificate to include in the kubeconfig'
 
  validate do |value|
- unless Puppet::Util.absolute_path?(value)
- raise Puppet::Error, "File paths must be fully qualified, not '#{value}'"
- end
+ raise Puppet::Error, "File paths must be fully qualified, not '#{value}'" unless Puppet::Util.absolute_path?(value)
  end
  end
  newparam(:client_cert) do
  desc 'The path to a client certificate to include in the kubeconfig'
 
  validate do |value|
- unless Puppet::Util.absolute_path?(value)
- raise Puppet::Error, "File paths must be fully qualified, not '#{value}'"
- end
+ raise Puppet::Error, "File paths must be fully qualified, not '#{value}'" unless Puppet::Util.absolute_path?(value)
  end
  end
  newparam(:client_key) do
  desc 'The path to a client key to include in the kubeconfig'
 
  validate do |value|
- unless Puppet::Util.absolute_path?(value)
- raise Puppet::Error, "File paths must be fully qualified, not '#{value}'"
- end
+ raise Puppet::Error, "File paths must be fully qualified, not '#{value}'" unless Puppet::Util.absolute_path?(value)
  end
  end
 
@@ -137,9 +129,7 @@ def retrieve
  desc 'The path to a file containing an authentication token'
 
  validate do |value|
- unless Puppet::Util.absolute_path?(value)
- raise Puppet::Error, "File paths must be fully qualified, not '#{value}'"
- end
+ raise Puppet::Error, "File paths must be fully qualified, not '#{value}'" unless Puppet::Util.absolute_path?(value)
  end
  end
 
@@ -151,12 +141,8 @@ def retrieve
  end
 
  validate do
- if self[:token] && self[:token_file]
- raise Puppet::Error, "Can't specify both token and token_file for the same kubeconfig entry"
- end
- unless self[:path]
- raise(Puppet::Error, 'path is a required attribute')
- end
+ raise Puppet::Error, "Can't specify both token and token_file for the same kubeconfig entry" if self[:token] && self[:token_file]
+ raise(Puppet::Error, 'path is a required attribute') unless self[:path]
  end
 
  # Ensure the file or directory exists
@@ -172,7 +158,7 @@ def retrieve
  self[:client_key],
  ].compact
  end
- req += [ self[:token_file] ].compact
+ req += [self[:token_file]].compact
 
  req
  end

lib/puppet/type/kubectl_apply.rb

@@ -72,9 +72,7 @@ def retrieve
  desc 'The name of the resource'
 
  validate do |value|
- unless value.match? %r{^([a-z0-9][a-z0-9.:-]{0,251}[a-z0-9]|[a-z0-9])$}
- raise Puppet::Error, 'Resource name must be valid'
- end
+ raise Puppet::Error, 'Resource name must be valid' unless value.match? %r{^([a-z0-9][a-z0-9.:-]{0,251}[a-z0-9]|[a-z0-9])$}
  end
  end
 
@@ -86,28 +84,22 @@ def retrieve
  desc 'The namespace the resource is contained in'
 
  validate do |value|
- unless value.match? %r{^[a-z0-9.-]{0,253}$}
- raise Puppet::Error, 'Namespace must be valid'
- end
+ raise Puppet::Error, 'Namespace must be valid' unless value.match? %r{^[a-z0-9.-]{0,253}$}
  end
  end
 
  newparam(:kubeconfig) do
  desc 'The kubeconfig file to use for handling the resource'
 
  validate do |value|
- unless Puppet::Util.absolute_path?(value)
- raise Puppet::Error, 'Kubeconfig path must be fully qualified'
- end
+ raise Puppet::Error, 'Kubeconfig path must be fully qualified' unless Puppet::Util.absolute_path?(value)
  end
  end
  newparam(:file) do
  desc 'The local file for the resource'
 
  validate do |value|
- unless Puppet::Util.absolute_path?(value)
- raise Puppet::Error, 'File path must be fully qualified'
- end
+ raise Puppet::Error, 'File path must be fully qualified' unless Puppet::Util.absolute_path?(value)
  end
  end
 
@@ -139,13 +131,9 @@ def retrieve
  defaultto({})
 
  validate do |value|
- unless value.is_a? Hash
- raise Puppet::Error, 'Content must be a valid content hash'
- end
+ raise Puppet::Error, 'Content must be a valid content hash' unless value.is_a? Hash
 
- if ['apiVersion', 'kind'].any? { |key| value.key? key }
- raise Puppet::Error, "Can't specify apiVersion or kind in content"
- end
+ raise Puppet::Error, "Can't specify apiVersion or kind in content" if %w[apiVersion kind].any? { |key| value.key? key }
  end
  end
 
@@ -157,10 +145,10 @@ def retrieve
  end
 
  autorequire(:kubeconfig) do
- [ self[:kubeconfig] ]
+ [self[:kubeconfig]]
  end
  autorequire(:service) do
- [ 'k8s-apiserver' ]
+ ['k8s-apiserver']
  end
  autorequire(:file) do
  [
@@ -169,7 +157,7 @@ def retrieve
  ]
  end
  autorequire(:k8s__binary) do
- [ 'kubectl' ]
+ ['kubectl']
  end
 
  def nice_name

lib/puppet/util/k8s.rb

@@ -23,8 +23,8 @@ def self.content_diff(local, content)
  next if value.include? v
 
  if v.is_a? Hash
- diff ||= value.select { |ov| ov.is_a? Hash }
-  .none? do |ov|
+ diff ||= value.select { |ov| ov.is_a? Hash }.
+ none? do |ov|
  v_copy = Marshal.load(Marshal.dump(v))
  delete_merge.call(v_copy, ov)
 
@@ -43,9 +43,7 @@ def self.content_diff(local, content)
  hash1.delete(key) if hash1.key?(key) && (hash1[key].nil? || (hash1[key].respond_to?(:empty?) && hash1[key].empty?))
  end
  hash1.dup.each_pair do |key, value|
- if value.nil? && !hash2.key?(key)
- hash1.delete key
- end
+ hash1.delete key if value.nil? && !hash2.key?(key)
  end
 
  hash1

spec/classes/k8s_spec.rb

@@ -9,7 +9,7 @@
 
  it { is_expected.to compile }
 
- [ 'node', 'server' ].each do |role|
+ %w[node server].each do |role|
  context "with role #{role}" do
  let(:params) do
  {
@@ -24,7 +24,7 @@
  context 'With dual-stack' do
  it { is_expected.to compile }
 
- [ 'node', 'server' ].each do |role|
+ %w[node server].each do |role|
  context "with role #{role}" do
  let(:params) do
  {

spec/classes/node/kube_proxy_spec.rb

@@ -5,13 +5,13 @@
 describe 'k8s::node::kube_proxy' do
  let(:pre_condition) do
  <<~PUPPET
- function assert_private() {}
+  function assert_private() {}
 
- include ::k8s
- class { '::k8s::node':
- manage_kubelet => false,
- manage_proxy => false,
- }
+  include ::k8s
+  class { '::k8s::node':
+  manage_kubelet => false,
+  manage_proxy => false,
+  }
  PUPPET
  end
 
@@ -20,13 +20,15 @@ class { '::k8s::node':
  let(:facts) { os_facts }
 
  it { is_expected.to compile }
+
  it do
  sysconf = '/etc/sysconfig'
  sysconf = '/etc/default' if os_facts['os']['family'] == 'Debian'
 
- is_expected.to contain_file(File.join(sysconf, 'kube-proxy'))
- .that_notifies('Service[kube-proxy]')
+ is_expected.to contain_file(File.join(sysconf, 'kube-proxy')).
+ that_notifies('Service[kube-proxy]')
  end
+
  it { is_expected.to contain_systemd__unit_file('kube-proxy.service').that_notifies('Service[kube-proxy]') }
  it { is_expected.to contain_service('kube-proxy') }
 
@@ -41,11 +43,11 @@ class { '::k8s::node':
  end
 
  it do
- is_expected.to contain_kubeconfig('/srv/kubernetes/kube-proxy.kubeconf')
- .with_ca_cert('/tmp/ca.pem')
- .with_client_cert('/tmp/cert.pem')
- .with_client_key('/tmp/key.pem')
- .that_notifies('Service[kube-proxy]')
+ is_expected.to contain_kubeconfig('/srv/kubernetes/kube-proxy.kubeconf').
+ with_ca_cert('/tmp/ca.pem').
+ with_client_cert('/tmp/cert.pem').
+ with_client_key('/tmp/key.pem').
+ that_notifies('Service[kube-proxy]')
  end
  end
 
@@ -59,10 +61,10 @@ class { '::k8s::node':
  end
 
  it do
- is_expected.to contain_kubeconfig('/srv/kubernetes/kube-proxy.kubeconf')
- .with_ca_cert('/tmp/ca.pem')
- .with_token('blah')
- .that_notifies('Service[kube-proxy]')
+ is_expected.to contain_kubeconfig('/srv/kubernetes/kube-proxy.kubeconf').
+ with_ca_cert('/tmp/ca.pem').
+ with_token('blah').
+ that_notifies('Service[kube-proxy]')
  end
  end
 
@@ -75,12 +77,14 @@ class { '::k8s::node':
 
  it { is_expected.not_to contain_kubeconfig('/srv/kubernetes/kube-proxy.kubeconf') }
  it { is_expected.to contain_k8s__binary('kube-proxy').with_ensure('absent') }
+
  it do
  sysconf = '/etc/sysconfig'
  sysconf = '/etc/default' if os_facts['os']['family'] == 'Debian'
 
  is_expected.to contain_file(File.join(sysconf, 'kube-proxy')).with_ensure('absent')
  end
+
  it { is_expected.to contain_systemd__unit_file('kube-proxy.service').with_ensure('absent') }
  it { is_expected.to contain_service('kube-proxy').with_ensure('stopped').with_enable(false) }
  end

spec/classes/node/kubectl_spec.rb

@@ -5,13 +5,13 @@
 describe 'k8s::node::kubectl' do
  let(:pre_condition) do
  <<~PUPPET
- function assert_private() {}
+  function assert_private() {}
 
- include ::k8s
- class { '::k8s::node':
- manage_kubelet => false,
- manage_proxy => false,
- }
+  include ::k8s
+  class { '::k8s::node':
+  manage_kubelet => false,
+  manage_proxy => false,
+  }
  PUPPET
  end