Fix linters in role and make them fit oooq rules

Add linter rule with pipefail when using shell module
and pipe.
Fix linter issues in role - pipefail for shell.
See also: https://review.openstack.org/#/c/564472/

Change-Id: Ie615b05dffc374972a8f3629485a4413e85d331d

ci-scripts/ansible-lint.sh

@@ -12,10 +12,4 @@
 #   this requires refactoring roles, skipping for now
 SKIPLIST="ANSIBLE0006,ANSIBLE0007,ANSIBLE0010,ANSIBLE0012,ANSIBLE0013,ANSIBLE0016"
 
-# Lin the role.
-ansible-lint -vvv -x $SKIPLIST ./ || lint_error=1
-
-# exit with 1 if we had a least an error or warning.
-if [[ -n "$lint_error" ]]; then
-    exit 1;
-fi
+ansible-lint -vvv -x $SKIPLIST ./ -R -r ./ci-scripts/ansible_rules

ci-scripts/ansible_rules/ShellPipefail.py

@@ -0,0 +1,53 @@
+#   Copyright Red Hat, Inc. All Rights Reserved.
+#
+#   Licensed under the Apache License, Version 2.0 (the "License"); you may
+#   not use this file except in compliance with the License. You may obtain
+#   a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#   WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#   License for the specific language governing permissions and limitations
+#   under the License.
+
+from ansiblelint import AnsibleLintRule
+
+
+def incorrect_task(task, cmd):
+    if 'shell' not in task:
+        return False
+    if 'register' in task:
+        return False
+    if task.get('ignore_errors'):
+        return False
+
+    if isinstance(task['shell'], dict):
+        args = task['shell']['cmd'].split()
+    else:
+        args = task['shell'].split()
+    if not set(args).isdisjoint(cmd) and 'pipefail' not in args:
+        return True
+
+    return False
+
+
+class ShellPipefail(AnsibleLintRule):
+    id = 'OOOQ0001'
+    shortdesc = 'Shell should have a pipefail'
+    description = 'Shell commands should have "set -o pipefail" if using PIPE'
+    tags = ['shell']
+    cmd = ["|", "timestamper_cmd"]
+
+    def matchplay(self, file, play):
+        ret = []
+        if play.get('block') and not play.get('ignore_errors'):
+            block = play['block']
+            for task in block:
+                if incorrect_task(task, self.cmd):
+                    ret.append((file, self.shortdesc))
+        else:
+            if incorrect_task(play, self.cmd):
+                ret.append((file, self.shortdesc))
+        return ret

tasks/common/nova_actions_check.yml

@@ -1,6 +1,7 @@
 ---
 - name: run post nova actions test
   shell: |
+    set -o pipefail
     source {{ overcloud_rc }}
     {{ working_dir }}/nova_actions_check.sh | tee {{ working_dir }}/nova_actions_check.log
   when: nova_actions_check|bool

tasks/fast-forward-upgrade/ffu_update_stack_outputs.yaml

@@ -8,12 +8,14 @@
 
 - name: print stack failures
   shell: |
+    set -o pipefail
     source {{ undercloud_rc }}
     openstack stack failures list --long {{ overcloud_stack_name }} | tee {{ working_dir}}/ffu_update_stack_outputs_failed.log
   when: ffu_stack_output|failed
 
 - name: print resource list
   shell: |
+    set -o pipefail
     source {{ undercloud_rc }}
     openstack stack resource list --filter status=FAILED --nested-depth 5 {{ overcloud_stack_name }} | tee {{ working_dir}}/ffu_update_stack_outputs_failed_resources.log
   when: ffu_stack_output|failed

tasks/fast-forward-upgrade/ffu_upgrade_ceph.yaml

@@ -8,11 +8,13 @@
 - block:
     - name: print stack failures
       shell: |
+        set -o pipefail
         source {{ undercloud_rc }}
         openstack stack failures list --long {{ overcloud_stack_name }} | tee {{ working_dir}}/ffu_upgrade_ceph_failed.log
 
     - name: print resource list
       shell: |
+        set -o pipefail
         source {{ undercloud_rc }}
         openstack stack resource list --filter status=FAILED --nested-depth 5 {{ overcloud_stack_name }} | tee {{ working_dir}}/ffu_upgrade_ceph_failed_resources.log
 

tasks/fast-forward-upgrade/ffu_upgrade_converge.yaml

@@ -8,12 +8,14 @@
 
 - name: print stack failures
   shell: |
+    set -o pipefail
     source {{ undercloud_rc }}
     openstack stack failures list --long {{ overcloud_stack_name }} | tee {{ working_dir}}/ffu_upgrade_converge_failed.log
   when: ffu_converge|failed
 
 - name: print resource list
   shell: |
+    set -o pipefail
     source {{ undercloud_rc }}
     openstack stack resource list --filter status=FAILED --nested-depth 5 {{ overcloud_stack_name }} | tee {{ working_dir}}/ffu_upgrade_converge_failed_resources.log
   when: ffu_converge|failed

tasks/update/overcloud_update_converge.yml

@@ -9,6 +9,7 @@
 - block:
     - name: print stack failures
       shell: |
+        set -o pipefail
         source {{ undercloud_rc }}
         openstack stack failures list --long {{ overcloud_stack_name }} | tee {{ working_dir}}/overcloud_composable_failed_update_converge.log
 

tasks/update/overcloud_update_prepare.yml

@@ -9,11 +9,13 @@
 - block:
     - name: print stack failures
       shell: |
+        set -o pipefail
         source {{ undercloud_rc }}
         openstack stack failures list --long {{ overcloud_stack_name }} | tee {{ working_dir}}/overcloud_failed_update_prepare.log
 
     - name: print resource list
       shell: |
+        set -o pipefail
         source {{ undercloud_rc }}
         openstack stack resource list --filter status=FAILED --nested-depth 5 {{ overcloud_stack_name }} | tee {{ working_dir}}/overcloud_failed_prepare_resources.log
 

tasks/upgrade/controller_node_upgrade.yml

@@ -1,6 +1,6 @@
 ---
 - name: Running post upgrade scripts for {{ node_name | splitext | first }}
-  shell: "{{working_dir}}/{{ node_name | splitext | first }}_post/{{ item }}.sh"
+  shell: "set -o pipefail && {{working_dir}}/{{ node_name | splitext | first }}_post/{{ item }}.sh"
   with_items:
     - 'reboot'
     - 'haproxy'

tasks/upgrade/overcloud_upgrade_converge.yml

@@ -9,6 +9,7 @@
 - block:
     - name: print stack failures
       shell: |
+        set -o pipefail
         source {{ undercloud_rc }}
         openstack stack failures list --long {{ overcloud_stack_name }} | tee {{ working_dir}}/overcloud_composable_failed_upgrade_converge.log
 

tasks/upgrade/overcloud_upgrade_prepare.yml

@@ -20,11 +20,13 @@
 - block:
     - name: print stack failures
       shell: |
+        set -o pipefail
         source {{ undercloud_rc }}
         openstack stack failures list --long {{ overcloud_stack_name }} | tee {{ working_dir}}/overcloud_failed_upgrade_prepare.log
 
     - name: print resource list
       shell: |
+        set -o pipefail
         source {{ undercloud_rc }}
         openstack stack resource list --filter status=FAILED --nested-depth 5 {{ overcloud_stack_name }} | tee {{ working_dir}}/overcloud_failed_prepare_resources.log