Add boolean variable to change behavior of multi-line actions in conf…

[bschonec]

Added a boolean variable to control the multi-line behavior of the action module. If rsyslog::dont_linebreak_actions == TRUE then all the options in the action will be on a single line.

This behavior might be necessary if you have CIS or STIG scans on your /etc/rsyslog.d configuration files that are looking for settings on a single line such as:

^\s*([^#]+\s+)?action\(([^#]+\s+)?\btarget="?[^#"]+"?\b
and

^\s*\*\.\*\s+@
These regexs will fail even if the configuration is correct but spans multiple lines.

[smortex]

Not a user of the module so only reporting style issues.

[smortex]

Don't add default value to Hiera if they are not changed from one OS to another. This prevent puppet-string from displaying default-values when generating the module REFERENCE file.

[bschonec]

I did not know this. Thanks for the explanation. Wouldn't it be prudent, then to apply this policy to all of the pre-existing variables in common.yaml?

[smortex]

IMHO it is a good idea, submitting this is a follow-up PR is fine.

[smortex]

REFERENCE.md is outdated

Please update REFERENCE.md with

$ bundle exec rake strings:generate:reference

Add it to the PR and CI should continue.

[bschonec]

@smortex, I updated REFERENCE.md as you suggested but still there are errors.

[smortex]

It still show "REFERENCE.md is outdated". Maybe your bundle is outdated? I run the following and it passed:

bundle update
bundle exec rake strings:generate:reference
git add REFERENCE.md
git commit -m 'Regenerate REFERENCE.md'
git push

[bschonec]

It still show "REFERENCE.md is outdated". Maybe your bundle is outdated? I run the following and it passed:

bundle update
bundle exec rake strings:generate:reference
git add REFERENCE.md
git commit -m 'Regenerate REFERENCE.md'
git push

Perhaps I'm misunderstanding but the tests are not passing.

[smortex]

Considering a catalog with:

rsyslog::component::action { 'foo':
  # ...
}

this will fail because the rsyslog was not included (it is included on line 10, but the parameter default value need it before that code is run).

The following would work:

include rsyslog

rsyslog::component::action { 'foo':
  # ...
}

The test suite probably need to be adjusted to ensure the main class of the module is included before testing the rsyslog::component::action class:

https://rspec-puppet.com/documentation/defined_types/#specifying-code-to-include-before