lukaszraczylo/salt-lint

Linter for Salt configuration management.

salt-lint

Linter for Salt configuration management.

Master: Development:

Documentation:

Please see documentation to interpret any results returned.

Running within git repo with its git files only

git ls-files | grep sls | xargs -I {} salt-lint -f {}

Do not use it until version >= 0.5

salt-lint's Issues

Single line declaration has problems

If I have a stanza like this:

awesome-service:
  service.running:
    - blah: True

The check fails (with the [!] Found single line declaration in... error), because it matches on the service in the top line, not just the service in the 2nd line. Anyway around this?

Return code is always 1, even when no issues are found

Hello, thank you for this gem!

I would like to use it in our CI/CD pipeline, but am running into an issue: the return code is always 1, even where no issues are found. I've read the code to try to understand why, but could not find the issue.

I would very much appreciate if you have the time to look into it! Let me know if you need additional information.

Test ticket from Code Climate

Issue opened automagically.

if(errors) will be true if variable exists.

salt-lint/lib/salt-lint/options.rb

Line 27 in 46a182f

if(errors)

errors=0
if(errors)
    puts 1
end
1

if(errors>0)
    puts 1
end
=> nil

Recommend using map.jinja over calling `pillar.get`

For example in firewall/templates/iptables-rules:

Bad

:INPUT {{ salt['pillar.get']('firewall:default_policy', 'ACCEPT') }} [0:0]

Good

{% from 'firewall/map.jinja' import firewall with context %}
:INPUT {{ salt['pillar.get']('firewall:default_policy', 'ACCEPT') }} [0:0]

I.e. we probably want to look for any instance of {{ salt['pillar.get']( (though be a bit more relaxed about whitespace)

Check templates all live under a templates/ folder

For instance

/etc/iptables-rules:
  file.managed:
    - source: salt://firewall/iptables-rules
    - template: jinja
    - user: root
    - group: root

If there is a template: jinja attribute the source attribute should have /templates/ in it somewhere.

Exit codes

The salt-lint executable always returns 0, even if something has failed. Are there plans to actually return correct codes? Also have to think of the case when using -s also.