puppet-lint-stdlib_deprecations 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8a262b62431245584e7002db4fda277fc2da95f538cb7ec5a15388eb7a9b4899
+  data.tar.gz: 5865cc5c09fdc7b435f3c58ed9e666a5f5d36495fe055a9f7a4e6beffb30475a
+SHA512:
+  metadata.gz: 582cbea7a8ad8e649396e986eb77769ab26dabcfb89c5922d38adf41871c46ef6e6a27e7e860e6fdea207ee494fc70c199cda883a4f5350cd4b80c190957f273
+  data.tar.gz: 0d2d3e2058bc22c4c59116cbe520c54b2823bfbf3dc8f887f6ce319d86d9e88c55238fe038b6c238151297e767f628625047c0d3dcfbfe6ce62ecf40f62443ea

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

data/README.md

@@ -0,0 +1,2 @@
+# puppet-lint-stdlib_deprecations
+A puppet-lint plugin to detect puppetlabs-stdlib deprecations including removed and non-namespaced functions and datatypes.

data/lib/puppet-lint/plugins/stdlib_deprecated_datatypes.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# Public: A puppet-lint custom check to detect removed deprecated compatibility data types.
+
+DEPRECATED_DATATYPES_VAR_TYPES = [:CLASSREF].freeze
+
+PuppetLint.new_check(:stdlib_deprecated_datatypes) do
+  def check
+    tokens.select { |x| DEPRECATED_DATATYPES_VAR_TYPES.include?(x.type) }.each do |token|
+      next unless token.value.include?('Stdlib::Compat::')
+
+      message = "Removed data type found: '#{token.value}'"
+
+      notify :error, {
+        message: message,
+        line: token.line,
+        column: token.column,
+        token: token,
+        fact_name: token.value
+      }
+    end
+  end
+end

data/lib/puppet-lint/plugins/stdlib_deprecated_functions.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+# Public: A puppet-lint custom check to detect deprecated functions.
+DEPRECATED_FUNCTIONS_VAR_TYPES = Set[:FUNCTION_NAME]
+
+# These functions have been removed in stdlib 9.x.
+REMOVED_FUNCTIONS = %w[
+  is_absolute_path type3x private is_bool validate_bool
+  is_string validate_string is_integer validate_integer is_hash
+  is_float validate_hash absolute_path validate_re validate_slength
+  is_ipv6_address validate_ipv6_address is_ipv4_address validate_ipv4_address
+  is_ip_address validate_ip_address size sprintf_hash is_email_address
+  is_mac_address is_domain_name is_function_available hash has_key is_array
+].freeze
+
+# Subset of REMOVED_FUNCTIONS that have been replaced with an alternative.
+REPLACED_FUNCTIONS = {
+  'private' => 'assert_private()',
+  'size' => 'length()',
+  'sprintf_hash' => 'sprintf()',
+  'hash' => 'Puppets built-in Hash.new()',
+  'has_key' => 'appropriate Puppet match expressions'
+}.freeze
+
+# These functions have been namespaced in stdlib 9.x.
+NAMESPACED_FUNCTIONS = %w[
+  batch_escape ensure_packages fqdn_rand_string has_interface_with merge
+  os_version_gte parsehocon parsepson powershell_escape seeded_rand
+  seeded_rand_string shell_escape to_json to_json_pretty to_python to_ruby
+  to_toml to_yaml type_of validate_domain_name validate_email_address
+].freeze
+
+PuppetLint.new_check(:stdlib_deprecated_functions) do
+  def check
+    tokens.select { |x| DEPRECATED_FUNCTIONS_VAR_TYPES.include?(x.type) }.each do |token|
+      if REMOVED_FUNCTIONS.include?(token.value)
+        removed_function_detected = true
+      elsif NAMESPACED_FUNCTIONS.include?(token.value)
+        namespaced_function_detected = true
+      else
+        next
+      end
+
+      message = "Deprecated function found: '#{token.value}'"
+      message += ". Use stdlib::#{token.value} instead." if namespaced_function_detected
+      message += ". Use #{REPLACED_FUNCTIONS[token.value]} instead." if REPLACED_FUNCTIONS.include?(token.value)
+
+      notify_log_level = removed_function_detected ? :error : :warning
+      notify notify_log_level, {
+        message: message,
+        line: token.line,
+        column: token.column,
+        token: token,
+        fact_name: token.value
+      }
+    end
+  end
+
+  # only applicable for namespaced functions
+  def fix(problem)
+    raise PuppetLint::NoFix unless NAMESPACED_FUNCTIONS.include?(problem[:token].value)
+
+    problem[:token].value = "stdlib::#{problem[:token].value}"
+  end
+end

data/lib/puppet-lint/plugins/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class StdlibDeprecations
+  VERSION ||= '0.0.1'
+end

data/spec/puppet-lint/plugins/stdlib_deprecated_datatypes_spec.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'stdlib_deprecated_datatypes' do
+  context 'when scanning puppet code for deprecated compat datatypes' do
+    let(:code) { 'Stdlib::Compat::String' }
+    let(:report) { /Removed data type found: 'Stdlib::Compat::String'/ }
+
+    it 'does detect a problem' do
+      expect(problems.size).to eq(1)
+    end
+
+    it 'throws an error' do
+      expect(problems).to include(a_hash_including(kind: /error/))
+    end
+
+    it 'contains the specific warning message' do
+      expect(problems).to include(a_hash_including(message: report))
+    end
+  end
+
+  context 'when scanning puppet code for multiple deprecated compat datatypes' do
+    let(:code) { 'Stdlib::Compat::String, Stdlib::Compat::Array' }
+    let(:string_report) { /Removed data type found: 'Stdlib::Compat::String'/ }
+    let(:array_report) { /Removed data type found: 'Stdlib::Compat::Array'/ }
+
+    it 'does detect a problem' do
+      expect(problems.size).to eq(2)
+    end
+
+    it 'throws an error' do
+      expect(problems).to include(a_hash_including(kind: /error/))
+    end
+
+    it 'contains the specific String warning message' do
+      expect(problems).to include(a_hash_including(message: string_report))
+    end
+
+    it 'contains the specific Array warning message' do
+      expect(problems).to include(a_hash_including(message: array_report))
+    end
+  end
+
+  context 'when scanning puppet code for non-deprecated datatypes' do
+    let(:code) { 'String' }
+
+    it 'does not detect a problem' do
+      expect(problems).to be_empty
+    end
+  end
+
+  context 'when scanning puppet code for a mixture of deprecated and non-depreacted data types' do
+    let(:code) { 'String, Stdlib::Compat::String' }
+    let(:report) { /Removed data type found: 'Stdlib::Compat::String'/ }
+
+    it 'does detect a problem' do
+      expect(problems.size).to eq(1)
+    end
+
+    it 'throws an error' do
+      expect(problems).to include(a_hash_including(kind: /error/))
+    end
+
+    it 'contains the specific warning message' do
+      expect(problems).to include(a_hash_including(message: report))
+    end
+  end
+
+  context 'when scanning puppet code for deprecated compat datatypes with a code block' do
+    let(:code) do
+      <<~PUPPETCODE
+        class foo (
+          Stdlib::Compat::String $bar = 'foobar',
+        ){}
+      PUPPETCODE
+    end
+    let(:report) { /Removed data type found: 'Stdlib::Compat::String'/ }
+
+    it 'does detect a problem' do
+      expect(problems.size).to eq(1)
+    end
+
+    it 'throws an error' do
+      expect(problems).to include(a_hash_including(kind: /error/))
+    end
+
+    it 'contains the specific warning message' do
+      expect(problems).to include(a_hash_including(message: report))
+    end
+  end
+end

data/spec/puppet-lint/plugins/stdlib_deprecated_functions_spec.rb

@@ -0,0 +1,327 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'stdlib_deprecated_functions' do
+  let(:generic_report) { /Deprecated function found:/ }
+
+  # Testing the stdlib_deprecated_functions check without autofix
+  context 'when testing puppet code with fix disabled and' do
+    context 'with one removed stdlib function present' do
+      let(:code) { "is_absolute_path('foo')" }
+
+      it 'does detect a problem' do
+        expect(problems.size).to eq(1)
+      end
+
+      it 'throws an error' do
+        expect(problems).to include(a_hash_including(kind: /error/))
+      end
+
+      it 'contains the specific warning message' do
+        expect(problems).to include(a_hash_including(message: generic_report))
+      end
+    end
+
+    context 'with one namespaced stdlib function present' do
+      let(:code) { "to_json('foo')" }
+
+      it 'does detect a problem' do
+        expect(problems.size).to eq(1)
+      end
+
+      it 'throws a warning' do
+        expect(problems).to include(a_hash_including(kind: /warning/))
+      end
+
+      it 'contains the specific warning message' do
+        expect(problems).to include(a_hash_including(message: generic_report))
+      end
+    end
+
+    context 'with a non-deprecated stdlib function present' do
+      let(:code) { "basename('/path/to/file')" }
+
+      it 'does not flag a problem' do
+        expect(problems.size).to eq(0)
+      end
+
+      it 'does not warn the user about deprecations' do
+        expect(problems).not_to include(a_hash_including(message: generic_report))
+      end
+    end
+
+    context 'with a wrongly written deprecated stdlib function present' do
+      let(:code) { "to_jron('foo')" }
+
+      it 'does not flag a problem' do
+        expect(problems.size).to eq(0)
+      end
+    end
+
+    context 'with multiple removed functions present' do
+      let(:code) { "is_absolute_path('foo')\nis_integer('foo')" }
+
+      it 'does detect multiple problems' do
+        expect(problems.size).to eq(2)
+      end
+
+      it 'throws an error' do
+        expect(problems).to include(a_hash_including(kind: /error/))
+      end
+
+      it 'does not throw a warning' do
+        expect(problems).not_to include(a_hash_including(kind: /warning/))
+      end
+
+      it 'contains the specific warning message' do
+        expect(problems).to include(a_hash_including(message: generic_report))
+      end
+    end
+
+    context 'with multiple namespaced functions present' do
+      let(:code) { "to_json('foo')\nto_yaml('foo')" }
+
+      it 'does detect multiple problems' do
+        expect(problems.size).to eq(2)
+      end
+
+      it 'throws a warning' do
+        expect(problems).to include(a_hash_including(kind: /warning/))
+      end
+
+      it 'does not throw an error' do
+        expect(problems).not_to include(a_hash_including(kind: /error/))
+      end
+
+      it 'contains the specific warning message' do
+        expect(problems).to include(a_hash_including(message: generic_report))
+      end
+    end
+
+    context 'with multiple mixed functions present' do
+      let(:code) { "is_absolute_path('foo')\nto_yaml('foo')" }
+
+      it 'does detect multiple problems' do
+        expect(problems.size).to eq(2)
+      end
+
+      it 'throws an error' do
+        expect(problems).to include(a_hash_including(kind: /error/))
+      end
+
+      it 'throws a warning' do
+        expect(problems).to include(a_hash_including(kind: /warning/))
+      end
+
+      it 'contains the specific warning message' do
+        expect(problems).to include(a_hash_including(message: generic_report))
+      end
+    end
+
+    context 'with a mix of deprecated and non-deprecated functions present' do
+      let(:code) { "is_absolute_path('foo')\nbasename('foo')" }
+
+      it 'does detect a problem' do
+        expect(problems.size).to eq(1)
+      end
+
+      it 'throws an error' do
+        expect(problems).to include(a_hash_including(kind: /error/))
+      end
+
+      it 'contains the specific warning message' do
+        expect(problems).to include(a_hash_including(message: generic_report))
+      end
+    end
+  end
+
+  # Testing the stdlib_deprecated_functions check with autofix
+  context 'when testing puppet code with fix enabled and' do
+    before do
+      PuppetLint.configuration.fix = true
+    end
+
+    after do
+      PuppetLint.configuration.fix = false
+    end
+
+    context 'with one non-replaceable removed stdlib function present' do
+      let(:code) { "is_absolute_path('foo')" }
+
+      it 'does detect a problem' do
+        expect(problems.size).to eq(1)
+      end
+
+      it 'throws an error' do
+        expect(problems).to include(a_hash_including(kind: /error/))
+      end
+
+      it 'does not fix the problem' do
+        expect(problems).not_to include(a_hash_including(kind: /fixed/))
+      end
+
+      it 'contains the specific warning message' do
+        expect(problems).to include(a_hash_including(message: generic_report))
+      end
+    end
+
+    context 'with one namespaced stdlib function present' do
+      let(:code) { "to_json('foo')" }
+      let(:fixedcode) { "stdlib::to_json('foo')" }
+
+      it 'does detect a problem' do
+        expect(problems.size).to eq(1)
+      end
+
+      it 'fixes the problem' do
+        expect(problems).to include(a_hash_including(kind: /fixed/))
+      end
+
+      it 'fixes the code' do
+        expect(manifest).to eq(fixedcode)
+      end
+
+      it 'contains the specific warning message' do
+        expect(problems).to include(a_hash_including(message: generic_report))
+      end
+    end
+
+    context 'with a non-deprecated stdlib function present' do
+      let(:code) { "basename('/path/to/file')" }
+
+      it 'does not flag a problem' do
+        expect(problems.size).to eq(0)
+      end
+
+      it 'does not warn the user about deprecations' do
+        expect(problems).not_to include(a_hash_including(message: generic_report))
+      end
+
+      it 'does not fix anything' do
+        expect(problems).not_to include(a_hash_including(kind: /fixed/))
+      end
+    end
+
+    context 'with a wrongly written deprecated stdlib function present' do
+      let(:code) { "to_jron('foo')" }
+
+      it 'does not flag a problem' do
+        expect(problems.size).to eq(0)
+      end
+
+      it 'does not fix anything' do
+        expect(problems).not_to include(a_hash_including(kind: /fixed/))
+      end
+    end
+
+    context 'with multiple namespaced functions present' do
+      let(:code) { "to_json('foo')\nto_yaml('foo')" }
+      let(:fixedcode) { "stdlib::to_json('foo')\nstdlib::to_yaml('foo')" }
+
+      it 'does detect multiple problems' do
+        expect(problems.size).to eq(2)
+      end
+
+      it 'fixes the problems' do
+        expect(problems).to include(a_hash_including(kind: /fixed/))
+      end
+
+      it 'does not avoid fixing the problems' do
+        expect(problems).not_to include(a_hash_including(kind: /warning/))
+      end
+
+      it 'fixes the code' do
+        expect(manifest).to eq(fixedcode)
+      end
+    end
+
+    context 'with multiple mixed functions present' do
+      let(:code) { "is_absolute_path('foo')\nto_yaml('foo')" }
+      let(:fixedcode) { "is_absolute_path('foo')\nstdlib::to_yaml('foo')" }
+
+      it 'does detect multiple problems' do
+        expect(problems.size).to eq(2)
+      end
+
+      it 'fixes the problems' do
+        expect(problems).to include(a_hash_including(kind: /fixed/))
+      end
+
+      it 'does not fix the unfixable problem' do
+        expect(problems).to include(a_hash_including(kind: /error/))
+      end
+
+      it 'fixes the code' do
+        expect(manifest).to eq(fixedcode)
+      end
+    end
+
+    context 'with the replaceable function size() present' do
+      # rubocop: disable Layout/LineLength
+      let(:code) { "size('foo')" }
+
+      it 'does detect a problem' do
+        expect(problems.size).to eq(1)
+      end
+
+      it 'offers an alternative' do
+        expect(problems).to include(a_hash_including(message: "Deprecated function found: 'size'. Use length() instead.", kind: :error))
+      end
+    end
+
+    context 'with the replaceable function hash() present' do
+      let(:code) { "hash('foo')" }
+
+      it 'does detect a problem' do
+        expect(problems.size).to eq(1)
+      end
+
+      it 'offers an alternative' do
+        expect(problems).to include(a_hash_including(message: "Deprecated function found: 'hash'. Use Puppets built-in Hash.new() instead.", kind: :error))
+      end
+    end
+
+    context 'with the replaceable function sprintf_hash() present' do
+      let(:code) { "sprintf_hash('foo')" }
+
+      it 'does detect a problem' do
+        expect(problems.size).to eq(1)
+      end
+
+      it 'offers an alternative' do
+        expect(problems).to include(a_hash_including(message: "Deprecated function found: 'sprintf_hash'. Use sprintf() instead.", kind: :error))
+      end
+    end
+
+    context 'with the replaceable function private() present' do
+      let(:code) { "private('foo')" }
+
+      it 'does detect a problem' do
+        expect(problems.size).to eq(1)
+      end
+
+      it 'offers an alternative' do
+        expect(problems).to include(a_hash_including(message: "Deprecated function found: 'private'. Use assert_private() instead.", kind: :error))
+      end
+    end
+
+    context 'with multiple replaceable functions present' do
+      let(:code) { "size('foo')\nsprintf_hash('foo')\nprivate('foo')" }
+      let(:fixedcode) { "length('foo')\nsprintf('foo')\nassert_private('foo')" }
+
+      it 'does detect multiple problems' do
+        expect(problems.size).to eq(3)
+      end
+
+      it 'offers an alternative for size' do
+        expect(problems).to include(a_hash_including(message: "Deprecated function found: 'size'. Use length() instead.", kind: :error))
+      end
+
+      it 'offers an alternative for private' do
+        expect(problems).to include(a_hash_including(message: "Deprecated function found: 'private'. Use assert_private() instead.", kind: :error))
+      end
+      # rubocop: enable Layout/LineLength
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'rspec'
+require 'simplecov'
+require 'puppet-lint'
+require 'rspec/its'
+
+if ENV['COVERAGE'] == 'yes'
+  require 'simplecov'
+  require 'simplecov-console'
+
+  SimpleCov.formatters = [
+    SimpleCov::Formatter::HTMLFormatter,
+    SimpleCov::Formatter::Console
+  ]
+
+  SimpleCov.start do
+    track_files 'lib/puppet-lint/**/*.rb'
+    add_filter 'lib/puppet-lint/plugins/version.rb'
+    add_filter '/spec'
+  end
+end
+
+PuppetLint::Plugins.load_spec_helper
+
+# Additional RSpec configuration
+RSpec.configure do |c|
+  # Example configuration
+  c.mock_with :rspec
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: puppet-lint-stdlib_deprecations
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Puppet, Inc.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-08-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: puppet-lint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: |2
+      Helps to detect deprecated, removed and non-namespaced puppetlabs-stdlib functions and datatypes during your upgrade to puppetlabs-stdlib 9.x,
+      and puppet 8.
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/puppet-lint/plugins/stdlib_deprecated_datatypes.rb
+- lib/puppet-lint/plugins/stdlib_deprecated_functions.rb
+- lib/puppet-lint/plugins/version.rb
+- spec/puppet-lint/plugins/stdlib_deprecated_datatypes_spec.rb
+- spec/puppet-lint/plugins/stdlib_deprecated_functions_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/puppetlabs/puppet-lint-stdlib_deprecations
+licenses:
+- Apache-2.0
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: A puppet-lint plugin to aid your puppetlabs-stdlib 9.x upgrade.
+test_files: []