puppet-lint and rubocop checks

[sanfrancrisko]

Originally raised: https://tickets.puppetlabs.com/browse/PDK-1700

We should add/create several puppet-lint plugins to the default install. We should also maintain a set of Puppet specific rubocop rules like https://github.com/chef/cookstyle/tree/master/lib/rubocop/cop/chef

Lint checks:

• puppet-lint-param-docs
• top_scope_facts
• legacy_facts
• world_writable_files
• puppet-lint-security-plugins (author is open to us taking over maintenance)
• https://github.com/TQRG/puppet-security-linter (evaluate first)

Rubocops

• 3.x functions
• facts with code outside of {{setcode}} scope
• facts with dots in their names
• use require_relative for helper code
• don't require parts of puppet that conflict with the autoloader, eg "require 'puppet/type/package'"

[sanfrancrisko]

Comment from @genebean :

FWIW, puppet-lint plugin wise, I have traditionally used these:

puppet-lint-absolute_template_path
puppet-lint-classes_and_types_beginning_with_digits-check
puppet-lint-empty_string-check
puppet-lint-leading_zero-check
puppet-lint-legacy_facts-check
puppet-lint-resource_reference_syntax
puppet-lint-spaceship_operator_without_tag-check
puppet-lint-top_scope_facts-check
puppet-lint-trailing_comma-check
puppet-lint-trailing_newline-check
puppet-lint-undef_in_function-check
puppet-lint-unquoted_string-check
puppet-lint-variable_contains_upcase
puppet-lint-version_comparison-check

[sanfrancrisko]

Comment from Tim Muesel:

On Vox Pupuli we use:

$ bundle list | grep puppet-lint-

• puppet-lint-absolute_classname-check (3.0.0)
• puppet-lint-anchor-check (1.0.0)
• puppet-lint-classes_and_types_beginning_with_digits-check (0.1.2)
• puppet-lint-file_ensure-check (0.3.1)
• puppet-lint-leading_zero-check (0.1.1)
• puppet-lint-legacy_facts-check (1.0.4)
• puppet-lint-manifest_whitespace-check (0.1.17)
• puppet-lint-param-docs (1.6.0)
• puppet-lint-resource_reference_syntax (1.1.0)
• puppet-lint-strict_indent-check (2.0.7)
• puppet-lint-topscope-variable-check (1.0.1)
• puppet-lint-trailing_comma-check (0.4.2)
• puppet-lint-unquoted_string-check (2.0.0)
• puppet-lint-variable_contains_upcase (1.2.0)
• puppet-lint-version_comparison-check (0.2.1)

[sanfrancrisko]

Comment from @yachub :

Even though options in .puppet-lint.rc are configurable in .sync.yml through Rakefile.linter_fail_on_warnings, I think enabling --fail-on-warnings as a default via changing fail_on_warnings would be a good idea, otherwise any findings caught by the puppet-lint gems results in a successful test. Specifically thinking about CI with pull requests in regards to this.

[bastelfreak]

Vox Pupuli now also uses puppet-lint-optional_default-check on all modules. Modules with full puppet-strings coverage also have puppet-lint-param-docs.

[bastelfreak]

@sanfrancrisko how can we move this forward? Vox Pupuli publishes a gem that pulls in all related linter plugins: https://rubygems.org/gems/voxpupuli-puppet-lint-plugins and I think it would be really good for the puppet ecosystem if pdk uses this plugin as well (in addition to setting fail_on_warnings).

[claviola]

@sanfrancrisko how can we move this forward? Vox Pupuli publishes a gem that pulls in all related linter plugins: https://rubygems.org/gems/voxpupuli-puppet-lint-plugins and I think it would be really good for the puppet ecosystem if pdk uses this plugin as well (in addition to setting fail_on_warnings).

It looks like this is the case now: puppetlabs/pdk-templates@6bf31242