976547 - Puppet materials should adhere to a standard style guide

Status: RESOLVED FIXED

(Socorro :: Infra, task)

Description

[Daniel Maher [:phrawzty]]

For the same reasons that the code[1] and the documentation are expected to adhere to a style guide, so should our Puppet materials - in particular, the manifests.  This is an easy thing to implement now because we don't publish much Puppet stuff (yet); however, the longer we wait, the more painful this will become down the road.

I suggest using the community style guide[2] since it's generally considered to be highly readable and since the standard puppet-lint[3] tool uses this guide by default.

[1] http://socorro.readthedocs.org/en/latest/codingconventions.html
[2] http://docs.puppetlabs.com/guides/style_guide.html
[3] http://puppet-lint.com/

Comment 1

[Selena Deckelmann :selenamarie :selena]

+1 !!!!!!

Comment 2

[[github robot]]

Commits pushed to master at https://github.com/mozilla/socorro

https://github.com/mozilla/socorro/commit/6426951e957023fb8a36c2559bbec3ead27354c5
clean up syntax to match style guide; bug 976547

https://github.com/mozilla/socorro/commit/6e6f18d3e893e4a5d083c642b43552d3eb902729
Merge pull request #1913 from phrawzty/bug976547

fixes bug 976547

Comment 3

[Lonnen :lonnen]

W could integrate lint into the build process like we do with pep8. In Boxen modules we use:

   puppet-lint \
     --fail-on-warnings \
     --no-80chars-check \
     --no-class_inherits_from_params_class-check \
     --with-filename manifests \

The downside is incorporating ruby into the release stack.

Comment 4

[Lonnen :lonnen]

I see you're already on it with that dependent bug. Good show!