saltstack-formulas / template-formula

SaltStack formula template filled with dummy content

Home Page:http://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

[BUG] Incorrect usage of file.managed mode

iils-jschmidt opened this issue · comments

According so salt lint, file.managed mode should be in quotation marks and have a leading zero.
So all occurrences of this:

  • mode: 644
    should be replaced with this:
  • mode: '0644'

Thanks for the report, @jensgw.

This was a conscious decision when first introducing salt-lint across this org, in our CI. Referring to the values set to be skipped in the configuration file:

# Skipping `207` and `208` because `210` is sufficient, at least for the time-being
# I.e. Allows 3-digit unquoted codes to still be used, such as `644` and `755`
- 207 # File modes should always be encapsulated in quotation marks
- 208 # File modes should always contain a leading zero

Essentially, the important rule to be upheld, from a YAML perspective, is 210:

  • Numbers that start with 0 should always be encapsulated in quotation marks

At the current time, there's no plan to enable 207 and 208 across the org -- the effort involved would be substantial, with no effective payback.

An argument could be made that this template itself could be adjusted; this is something that could be discussed in the next Formulas' working group meeting -- CC: @saltstack-formulas/wg.

I think it makes sense to have just this template formula tweaked to use '0644' notation. All forks made from it in the future would be correct by default and anything already existing just have a simple lint warning.