puppet-lint-stdlib_deprecations 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a262b62431245584e7002db4fda277fc2da95f538cb7ec5a15388eb7a9b4899
-  data.tar.gz: 5865cc5c09fdc7b435f3c58ed9e666a5f5d36495fe055a9f7a4e6beffb30475a
+  metadata.gz: 5a09ec5fb006b9366fa223352f54f94bb678eb624956ad7c4958afe31b6b91cf
+  data.tar.gz: 9e0948a038b35fc8bc23ec15dba874f6a88465c1fab452cfde315027a475ddeb
 SHA512:
-  metadata.gz: 582cbea7a8ad8e649396e986eb77769ab26dabcfb89c5922d38adf41871c46ef6e6a27e7e860e6fdea207ee494fc70c199cda883a4f5350cd4b80c190957f273
-  data.tar.gz: 0d2d3e2058bc22c4c59116cbe520c54b2823bfbf3dc8f887f6ce319d86d9e88c55238fe038b6c238151297e767f628625047c0d3dcfbfe6ce62ecf40f62443ea
+  metadata.gz: 2964fb07f8f6a70f87c9b1207118e53d6f9e8495d0dca3628deca13eac6ca629c2aa61b241c457219d5277f63071a4a9400bb90bb2c10beb08f2f2a9f6f3b41c
+  data.tar.gz: 16171c1f001742c9b266ab7501c6cbafc76717e84d84562486bf7089ee745539df4695cf9d7b9449652ca995974005f2d8db0585fadc520f69049a0e446ab39f

data/README.md

@@ -1,2 +1,164 @@
 # puppet-lint-stdlib_deprecations
-A puppet-lint plugin to detect puppetlabs-stdlib deprecations including removed and non-namespaced functions and datatypes.
+
+[![ci](https://github.com/puppetlabs/puppet-lint-stdlib_deprecations/actions/workflows/nightly.yml/badge.svg)](https://github.com/puppetlabs/puppet-strings/actions/workflows/nightly.yml)
+[![Gem Version](https://badge.fury.io/rb/puppet-lint-stdlib_deprecations.svg)](https://badge.fury.io/rb/puppet-lint-stdlib_deprecations)
+[![Code Owners](https://img.shields.io/badge/owners-DevX--team-blue)](https://github.com/puppetlabs/puppet-lint-stdlib_deprecations/blob/main/CODEOWNERS)
+
+A puppet-lint plugin to detect [puppetlabs/stdlib](https://forge.puppet.com/modules/puppetlabs/stdlib) deprecations including removed and non-namespaced functions and datatypes.
+
+## Installation
+
+Add this line to your modules's Gemfile:
+
+```ruby
+gem 'puppet-lint-stdlib_deprecations'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it with:
+
+```bash
+gem install puppet-lint-stdlib_deprecations
+```
+
+## Checks
+
+This plugin includes two checks.
+
+### stdlib_deprecated_functions
+
+Scans your puppet code for instances of removed and non-namespaced functions in `puppetlabs/stdlib` v9.0.0+. The plugin will only flag functions removed, that do not have an exact replcacement in core Puppet (for example, `upcase` or `chomp`).
+
+```puppet
+class example_module::agent (
+  String $ipaddress = '127.0.0.1'
+) {
+  $chomped = chomp('hello\n')
+
+  if is_ip_address($ipaddress) {
+    notice("${ipaddress} is an ipaddress!")
+  }
+
+  $size = size('hello')
+
+  $escaped = batch_escape('echo "hello world"')
+}
+```
+
+The above manifest will result in this console output:
+
+```bash
+puppet-lint path/to/file.pp
+
+ERROR: Deprecated function found: 'is_ip_address' on line 6 (check: stdlib_deprecated_functions)
+ERROR: Deprecated function found: 'size'. Use length() instead. on line 10 (check: stdlib_deprecated_functions)
+WARNING: Deprecated function found: 'batch_escape'. Use stdlib::batch_escape instead. on line 12 (check: stdlib_deprecated_functions)
+```
+
+Notice, there is no output for the `chomp(..)` function call as there is a direct replacement in core Puppet, meaning the function will continue to work as expected.
+
+* `is_ip_address` is flagged as an error, as this will require manual intervention from the user to update this instance to a suitable replacement.
+* `size` is also flagged as an error was replaced by `length()` which is shipped with Puppet.
+* `batch_escape` omits a warning, this is because the function call will continue to work (until later removed from [puppetlabs/stdlib](https://forge.puppet.com/modules/puppetlabs/stdlib)), as 'under the hood' puppet will call the namespaced function.
+
+For functions which have a namespaced counterpart (like `batch_escape`) we can make use of puppet-lint's autocorrect functionality to automate the process of updating these function calls.
+
+```puppet
+class example_module::agent (
+  String $ipaddress = ''
+) {
+...
+  $escaped = batch_escape('echo "hello world"')
+}
+```
+
+```bash
+puppet-lint --fix path/to/file.pp
+...
+FIXED: Deprecated function found: 'batch_escape'. Use stdlib::batch_escape instead. on line 12 (check: stdlib_deprecated_functions)
+...
+```
+
+And the updated code will look like:
+
+```puppet
+class example_module::agent (
+  String $ipaddress = ''
+) {
+...
+  $escaped = stdlib::batch_escape('echo "hello world"')
+}
+```
+
+To disable this check, you can add `--no-stdlib_deprecated_functions-check` to your puppet-lint command line.
+
+```bash
+puppet-lint --no-stdlib_deprecated_functions-check path/to/file.pp
+```
+
+Or if you're calling puppet-lint via a Raketask, add this to your Rakefile:
+
+```ruby
+PuppetLint.configuration.send('disable_stdlib_deprecated_functions')
+```
+
+### stdlib_deprecated_datatypes
+
+Checks for instances of the removed `Stdlib::Compat` datatypes in your manifests.
+
+```puppet
+class example_module::agent (
+  String $ip = '127.0.0.1',
+) {
+  if ($ip =~ Stdlib::Compat::Ipv4) {
+    notice("${ip} is an ip address!")
+  }
+}
+```
+
+When running this check, puppet-lint will flag this instance of `Stdlib::Compat::Ip_address` as an error.
+
+```bash
+puppet-lint /path/to/file.pp
+
+ERROR: Removed data type found: 'Stdlib::Compat::Ipv4' on line 4 (check: stdlib_deprecated_datatypes)
+```
+
+What you should now use:
+
+```puppet
+class example_module::agent (
+  String $ip = '127.0.0.1',
+) {
+  if ($ip =~ Stdlib::IP::Address) {
+    notice("${ip} is an ip address!")
+  }
+}
+```
+
+Again, to disable this check you can add `--no-stdlib_deprecated_datatypes-check` to your puppet-lint command line.
+
+```bash
+puppet-lint  --no-stdlib_deprecated_datatypes-check /path/to/file.pp
+```
+
+Or by adding this line to your Rakefile (if calling the puppet-lint rake task).
+
+```ruby
+PuppetLint.configuration.send('disable_stdlib_deprecated_datatypes')
+```
+
+## License
+
+This codebase is licensed under Apache 2.0. However, the open source dependencies included in this codebase might be subject to other software licenses such as AGPL, GPL2.0, and MIT.
+
+## Development
+
+If you run into an issue with this plugin or would like to request a feature you can raise a PR with your suggested changes. Keep in mind that this gem runs automated testing using GitHub Actions and we generally expect new contributions to pass these tests, as well as add additional testing in case of new features.
+
+Alternatively, you can raise a Github issue with a feature request or bug reports. Every other Tuesday the DevX team holds office hours in the Puppet Community Slack, where you can ask questions about this and any other supported tools. This session runs at 15:00 (GMT) for about an hour.

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

@@ -3,9 +3,9 @@
 # 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.
+# These functions have been removed/scheduled for removal in stdlib 9.x.
 REMOVED_FUNCTIONS = %w[
-  is_absolute_path type3x private is_bool validate_bool
+  is_absolute_path type3x private is_bool validate_legacy 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
@@ -19,7 +19,8 @@ REPLACED_FUNCTIONS = {
   'size' => 'length()',
   'sprintf_hash' => 'sprintf()',
   'hash' => 'Puppets built-in Hash.new()',
-  'has_key' => 'appropriate Puppet match expressions'
+  'has_key' => '"if \'key\' in $my_hash"',
+  'validate_legacy' => 'Puppet data types to validate parameters'
 }.freeze
 
 # These functions have been namespaced in stdlib 9.x.

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-lint-stdlib_deprecations
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Puppet, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-27 00:00:00.000000000 Z
+date: 2024-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet-lint