voxpupuli / puppet-lint-resource_reference_syntax

puppet-lint plugin resource reference check

Note, this plugin will check for Puppet resource reference syntax which will no longer work with Puppet 4.x.

Installation

To use this plugin, add the following like to the Gemfile in your Puppet code base and run bundle install.

gem 'puppet-lint-resource_reference_syntax'

Usage

This plugin provides two new checks to puppet-lint.

resource_reference_without_whitespace

--fix support: No

This check will raise an error for any resource reference that has a whitespace between the Type reference and the opening bracket.

e.g. the following code is NOT good for Puppet 4:

  require => File ['/etc/motd']

and will result in the following error:

ERROR: whitespce between reference type and title on line 4

resource_reference_without_title_capital

--fix support: No

This check will raise an error for any resource reference that uses the title with capital letter without enclosed quotes.

e.g. the following code will not work on Puppet 4:

  require => Service[Apache],
  require => Service[Apache, Mysql],
  require => Service[apache]

and will result in the following error:

ERROR: resource reference with title with capital letter on line 4

The following references are good code for Puppet 4:

  require => Service['apache'],
  require => Service['apache', 'mysql'],
  require => [ Service['apache'], Service['mysql'] ],

Transfer Notice

This plugin was originally authored by example42. The maintainer preferred that Puppet Community take ownership of the module for future improvement and maintenance. Existing pull requests and issues were transferred over, please fork and continue to contribute here instead of Camptocamp.

License

This gem is licensed under the Apache-2 license.

Release information

To make a new release, please do:

• update the version in the gemspec file
• Install gems with bundle install --with release --path .vendor
• generate the changelog with bundle exec rake changelog
• Check if the new version matches the closed issues/PRs in the changelog
• Create a PR with it
• After it got merged, push a tag. GitHub actions will do the actual release to rubygems and GitHub Packages

puppet-lint-resource_reference_syntax's Issues

resource_reference_without_whitespace error on resource collection

For some reason I am getting an error from your module where I don't think there should be one.

Error message:
resource_reference_without_whitespace:ERROR:whitespace between reference type and title

Resource.
Sshkeys::Set_authorized_key <<| tag == $::facts[fqdn] |>>

I am rather sure that is a valid resource collector.
If I use a non structured fact it fails.
If I take out all the spaces on that line it passes.

Whereas this resource collector does not produce the error.
Sshkey <<| tag == $primary_server |>>

Is something going wrong because it is a sub resource?

false resource_reference_without_whitespace on resource collection

Since updating the gem to latest (1.0.11) I'm seeing some issues with whitespace errors on resource collectors.
Picked the example from #9 to illustrate:

package { 'htop':
  ensure => latest,
}
Sshkeys::Set_authorized_key <<| tag == $::facts[fqdn] |>>

yields

ERROR: whitespce between reference type and title on line 4

while

Sshkeys::Set_authorized_key <<| tag == $::facts[fqdn] |>>

on its own yields no errors.

The more definitions are prior to the collector the more alleged errors are printed.

service { 'puppet':
  ensure => running,
}
package { 'less':
  ensure => latest,
}
package { 'htop':
  ensure => latest,
}
Sshkeys::Set_authorized_key <<| tag == $::facts[fqdn] |>>

ERROR: whitespce between reference type and title on line 10
ERROR: whitespce between reference type and title on line 10
ERROR: whitespce between reference type and title on line 10

The same files checked against version 1.0.10 do not throw any errors.

Doesn't detect spaces when using chaining arrows syntax ("Class ['A'] -> Class ['B']")

I understand that this is more of a missing feature than a bug but it would be cool if you could add this.

Example of code that should trigger an error:

Class ['redis::install']
    -> Class ['redis::firewall']
    -> Class ['redis::config']
    ~> Class ['redis::service']

False warning: whitespce between reference type and title

Following code should be valid with Puppet 4, still it yield warning:

require => [ File['foo'], Package['some-package'] ],

ERROR: whitespce between reference type and title on line 40

False warning: resource reference with title with capital letter

Incorrect warning yield in case that type contains just variable:

File[$conf_file],

False positive for require

Example:
require => File[tomcat8_dir]
will mark as an Error:
ERROR: resource reference with title with capital letter on line
when gem puppet-lint-resource_reference_syntax is installed.
Other used gem's:
gem list

*** LOCAL GEMS ***

abrt (0.0.6)
bigdecimal (1.2.0)
io-console (0.4.2)
json (1.7.7)
psych (2.0.0)
puppet-lint (2.0.0, 1.1.0)
puppet-lint-top_scope_facts-check (0.0.1)
puppet-lint-trailing_newline-check (1.0.0)
puppet-lint-unquoted_string-check (0.3.0)
puppet-lint-variable_contains_upcase (1.0.1)
rdoc (4.0.0)

Wrong match when a variable is in the title

Afaik

file {'foo':
  ensure => file,
  notify => Title["with ${param}"],
}

is valid code but it returns a problem