Standardize code from dot to array notation (#306)

Author: alessfg

CHANGELOG.md

@@ -1,9 +1,10 @@
 # Changelog
 
-## 0.5.3 (Unreleased)
+## 0.6.0 (Unreleased)
 
 ENHANCEMENTS:
 
+* Standardize code from dot to array notation to keep in with the standards set by the other roles in the Ansible NGINX core collection.
 * Bump the minimum version of Ansible core required to run the role to `2.12` (`2.11` is no longer supported by Ansible).
 * Support the `include` directive in the main NGINX context.
 * Bump the Ansible `community.general` collection to `6.2.0` and `community.docker` collection to `3.4.0`.
@@ -16,7 +17,7 @@ BUG FIXES:
 TESTS:
 
 * Update GitHub actions to run on Ubuntu 22.04 (and thus support `cgroups` v2).
-* Explicitly specify `amd64` as the platform used in Molecule tests. This will ensure that tests work as expected when run on different host architectures (e.g. newer Macbooks with `arm` processors).
+* Explicitly specify `amd64` as the platform used in NGINX Plus Molecule tests. This will ensure that tests involving NGINX App Protect will work as expected when run on different host architectures (e.g. newer Macbooks with `arm` processors).
 
 ## 0.5.2 (October 17, 2022)
 

handlers/main.yml

@@ -11,12 +11,12 @@
 
 - name: (Handler - NGINX Config) Print NGINX error if syntax check fails
   ansible.builtin.debug:
-    var: config_check.stderr_lines
-  failed_when: config_check.rc != 0
+    var: config_check['stderr_lines']
+  failed_when: config_check['rc'] != 0
   when:
-    - config_check.stderr_lines is defined
-    - config_check.stderr_lines != []
-    - config_check.rc != 0
+    - config_check['stderr_lines'] is defined
+    - config_check['stderr_lines'] != []
+    - config_check['rc'] != 0
   listen: (Handler - NGINX Config) Run NGINX
 
 - name: (Handler - NGINX Config) Start/reload NGINX

molecule/cleanup_module/molecule.yml

@@ -11,34 +11,30 @@ lint: |
 platforms:
   - name: alpine-3.17
     image: alpine:3.17
-    platform: amd64
     dockerfile: ../common/Dockerfile.j2
     privileged: true
     cgroupns_mode: host
     volumes:
       - /sys/fs/cgroup:/sys/fs/cgroup:rw
     command: /sbin/init
-  - name: rhel-9
-    image: redhat/ubi9:9.1.0
-    platform: amd64
+  - name: debian-bullseye
+    image: debian:bullseye-slim
     dockerfile: ../common/Dockerfile.j2
     privileged: true
     cgroupns_mode: host
     volumes:
       - /sys/fs/cgroup:/sys/fs/cgroup:rw
-    command: /usr/sbin/init
-  - name: debian-bullseye
-    image: debian:bullseye-slim
-    platform: amd64
+    command: /sbin/init
+  - name: rhel-9
+    image: redhat/ubi9:9.1.0
     dockerfile: ../common/Dockerfile.j2
     privileged: true
     cgroupns_mode: host
     volumes:
       - /sys/fs/cgroup:/sys/fs/cgroup:rw
-    command: /sbin/init
+    command: /usr/sbin/init
   - name: ubuntu-jammy
     image: ubuntu:jammy
-    platform: amd64
     dockerfile: ../common/Dockerfile.j2
     privileged: true
     cgroupns_mode: host

molecule/cleanup_module/verify.yml

@@ -24,11 +24,11 @@
         path: /etc/nginx/conf.d/default.conf
       check_mode: true
       register: stat_result
-      failed_when: stat_result.stat.exists
+      failed_when: stat_result['stat']['exists'] | bool
 
     - name: Check mock.conf does not exist
       ansible.builtin.stat:
         path: /etc/nginx/conf.d/mock.conf
       check_mode: true
       register: stat_result
-      failed_when: stat_result.stat.exists
+      failed_when: stat_result['stat']['exists'] | bool

molecule/default/molecule.yml

@@ -11,34 +11,30 @@ lint: |
 platforms:
   - name: alpine-3.17
     image: alpine:3.17
-    platform: amd64
     dockerfile: ../common/Dockerfile.j2
     privileged: true
     cgroupns_mode: host
     volumes:
       - /sys/fs/cgroup:/sys/fs/cgroup:rw
     command: /sbin/init
-  - name: rhel-9
-    image: redhat/ubi9:9.1.0
-    platform: amd64
+  - name: debian-bullseye
+    image: debian:bullseye-slim
     dockerfile: ../common/Dockerfile.j2
     privileged: true
     cgroupns_mode: host
     volumes:
       - /sys/fs/cgroup:/sys/fs/cgroup:rw
-    command: /usr/sbin/init
-  - name: debian-bullseye
-    image: debian:bullseye-slim
-    platform: amd64
+    command: /sbin/init
+  - name: rhel-9
+    image: redhat/ubi9:9.1.0
     dockerfile: ../common/Dockerfile.j2
     privileged: true
     cgroupns_mode: host
     volumes:
       - /sys/fs/cgroup:/sys/fs/cgroup:rw
-    command: /sbin/init
+    command: /usr/sbin/init
   - name: ubuntu-jammy
     image: ubuntu:jammy
-    platform: amd64
     dockerfile: ../common/Dockerfile.j2
     privileged: true
     cgroupns_mode: host

molecule/default/verify.yml

@@ -24,42 +24,42 @@
         url: http://localhost
         return_content: true
       register: this
-      failed_when: "'Hello World' not in this.content"
+      failed_when: "'Hello World' not in this['content']"
 
     - name: Check client body cache directory exists
       ansible.builtin.stat:
         path: /var/cache/nginx/client
       check_mode: true
       register: stat_result
-      failed_when: not stat_result.stat.exists
+      failed_when: not stat_result['stat']['exists'] | bool
 
     - name: Check proxy cache directory exists
       ansible.builtin.stat:
         path: /var/cache/nginx/proxy
       check_mode: true
       register: stat_result
-      failed_when: not stat_result.stat.exists
+      failed_when: not stat_result['stat']['exists'] | bool
 
     - name: Check default.conf exists
       ansible.builtin.stat:
         path: /etc/nginx/conf.d/default.conf
       check_mode: true
       register: stat_result
-      failed_when: not stat_result.stat.exists
+      failed_when: not stat_result['stat']['exists'] | bool
 
     - name: Check frontend_default.conf exists
       ansible.builtin.stat:
         path: /etc/nginx/conf.d/frontend_default.conf
       check_mode: true
       register: stat_result
-      failed_when: not stat_result.stat.exists
+      failed_when: not stat_result['stat']['exists'] | bool
 
     - name: Check backend_default.conf exists
       ansible.builtin.stat:
         path: /etc/nginx/conf.d/backend/backend_default.conf
       check_mode: true
       register: stat_result
-      failed_when: not stat_result.stat.exists
+      failed_when: not stat_result['stat']['exists'] | bool
 
     - name: Ensure default.conf contains 'location /'
       ansible.builtin.lineinfile:

molecule/plus/verify.yml

@@ -20,48 +20,48 @@
       failed_when: (service is changed) or (service is failed)
 
     - name: Functional tests
-      when: ansible_os_family != "Alpine"
+      when: ansible_facts['os_family'] != 'Alpine'
       block:
         - name: Check that a page returns a status 200 and fail if the words Hello World are not in the page contents
           ansible.builtin.uri:
             url: http://localhost
             return_content: true
           register: this
-          failed_when: "'Hello World' not in this.content"
+          failed_when: "'Hello World' not in this['content']"
 
         - name: Check that a page returns a status 200 and fail if the words Request Rejected are not in the page contents
           ansible.builtin.uri:
             url: http://localhost/?v=<script>
             return_content: true
           register: this
-          failed_when: "'Request Rejected' not in this.content"
+          failed_when: "'Request Rejected' not in this['content']"
 
         - name: Ensure /var/log/messages contains block event from above test
           ansible.builtin.shell: grep -c "Non-browser Client,Abuse of Functionality,Cross Site Scripting (XSS)" /var/log/messages || true
           register: event
           changed_when: false
-          failed_when: event.stdout == "0"
+          failed_when: event['stdout'] == '0'
 
     - name: Check default.conf exists
       ansible.builtin.stat:
         path: /etc/nginx/conf.d/default.conf
       check_mode: true
       register: stat_result
-      failed_when: not stat_result.stat.exists
+      failed_when: not stat_result['stat']['exists'] | bool
 
     - name: Check frontend_default.conf exists
       ansible.builtin.stat:
         path: /etc/nginx/conf.d/frontend_default.conf
       check_mode: true
       register: stat_result
-      failed_when: not stat_result.stat.exists
+      failed_when: not stat_result['stat']['exists'] | bool
 
     - name: Check backend_default.conf exists
       ansible.builtin.stat:
         path: /etc/nginx/conf.d/backend_default.conf
       check_mode: true
       register: stat_result
-      failed_when: not stat_result.stat.exists
+      failed_when: not stat_result['stat']['exists'] | bool
 
     - name: Ensure default.conf contains 'location /'
       ansible.builtin.lineinfile:

molecule/stable_push/molecule.yml

@@ -11,34 +11,30 @@ lint: |
 platforms:
   - name: alpine-3.17
     image: alpine:3.17
-    platform: amd64
     dockerfile: ../common/Dockerfile.j2
     privileged: true
     cgroupns_mode: host
     volumes:
       - /sys/fs/cgroup:/sys/fs/cgroup:rw
     command: /sbin/init
-  - name: rhel-9
-    image: redhat/ubi9:9.1.0
-    platform: amd64
+  - name: debian-bullseye
+    image: debian:bullseye-slim
     dockerfile: ../common/Dockerfile.j2
     privileged: true
     cgroupns_mode: host
     volumes:
       - /sys/fs/cgroup:/sys/fs/cgroup:rw
-    command: /usr/sbin/init
-  - name: debian-bullseye
-    image: debian:bullseye-slim
-    platform: amd64
+    command: /sbin/init
+  - name: rhel-9
+    image: redhat/ubi9:9.1.0
     dockerfile: ../common/Dockerfile.j2
     privileged: true
     cgroupns_mode: host
     volumes:
       - /sys/fs/cgroup:/sys/fs/cgroup:rw
-    command: /sbin/init
+    command: /usr/sbin/init
   - name: ubuntu-jammy
     image: ubuntu:jammy
-    platform: amd64
     dockerfile: ../common/Dockerfile.j2
     privileged: true
     cgroupns_mode: host

molecule/stable_push/verify.yml

@@ -29,7 +29,7 @@
         path: /etc/nginx/conf.d/default.conf
       check_mode: true
       register: stat_result
-      failed_when: not stat_result.stat.exists
+      failed_when: not stat_result['stat']['exists'] | bool
 
     - name: Ensure default.conf contains 'location /'
       ansible.builtin.lineinfile:
@@ -45,4 +45,4 @@
         path: /etc/nginx/snippets/location_snippet.conf
       check_mode: true
       register: stat_result
-      failed_when: not stat_result.stat.exists
+      failed_when: not stat_result['stat']['exists'] | bool

tasks/config/cleanup-config.yml

@@ -1,9 +1,9 @@
 ---
 - name: Find NGINX config files
   ansible.builtin.find:
-    paths: "{{ item.directory }}"
+    paths: "{{ item['directory'] }}"
     patterns: "*.conf"
-    recurse: "{{ item.recurse | default(false) }}"
+    recurse: "{{ item['recurse'] | default(false) }}"
   loop: "{{ nginx_config_cleanup_paths }}"
   when: nginx_config_cleanup_paths is defined
   register: nginx_config_files
@@ -12,5 +12,5 @@
   ansible.builtin.file:
     path: "{{ item }}"
     state: absent
-  loop: "{{ nginx_config_files.results | map(attribute='files') | sum(start=[]) | map(attribute='path') | list + nginx_config_cleanup_files | default('') | list }}"
+  loop: "{{ nginx_config_files['results'] | map(attribute='files') | sum(start=[]) | map(attribute='path') | list + nginx_config_cleanup_files | default('') | list }}"
   notify: (Handler - NGINX Config) Run NGINX