Skip to content

Commit

Permalink
empty string compare rule docs
Browse files Browse the repository at this point in the history
  • Loading branch information
oraNod committed Sep 13, 2022
1 parent e79e65c commit a885914
Showing 1 changed file with 44 additions and 0 deletions.
44 changes: 44 additions & 0 deletions src/ansiblelint/rules/empty_string_compare.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# empty-string-compare

This rule checks for empty string comparison in playbooks.
To ensure code clarity you should avoid using empty strings in conditional statements with the `when` clause.

- Use `when: var|length > 0` instead of `when: var != ""`.
- Use `when: var|length == 0` instead of `when: var == ""`.

This is an opt-in rule.
You must enable it in your Ansible-lint configuration as follows:

```yaml
enable_list:
- empty-string-compare
```

## Problematic Code

```yaml
---
- name: Example playbook
hosts: all
tasks:
- name: Shut down
ansible.builtin.command: /sbin/shutdown -t now
when: ansible_os_family == "" # <- Compares with an empty string.
- name: Shut down
ansible.builtin.command: /sbin/shutdown -t now
when: ansible_os_family !="" # <- Compares with an empty string.
```

## Correct Code

```yaml
---
- name: Example playbook
hosts: all
tasks:
- name: Shut down
ansible.builtin.shell: |
/sbin/shutdown -t now
echo $var ==
when: ansible_os_family
```

0 comments on commit a885914

Please sign in to comment.