more ansible-lint 6.x fixes (#168)

* more ansible-lint 6.x fixes

* ensure ethtool is installed where needed

Author: richm

.ansible-lint

@@ -1,3 +1,23 @@
 ---
+profile: production
 skip_list:
   - fqcn-builtins
+exclude_paths:
+  - tests/roles/
+  - .github/
+  - examples/roles/
+kinds:
+  - yaml: "**/meta/collection-requirements.yml"
+  - yaml: "**/tests/collection-requirements.yml"
+  - playbook: "**/tests/tests_*.yml"
+  - playbook: "**/tests/setup-snapshot.yml"
+  - tasks: "**/tests/*.yml"
+  - playbook: "**/tests/playbooks/*.yml"
+  - tasks: "**/tests/tasks/*.yml"
+  - tasks: "**/tests/tasks/*/*.yml"
+  - vars: "**/tests/vars/*.yml"
+  - playbook: "**/examples/*.yml"
+mock_roles:
+  - linux-system-roles.timesync
+extra_vars:
+  targets: target_hosts

README.md

@@ -29,40 +29,40 @@ timesync_ntp_servers:
   - hostname: foo.example.com   # Hostname or address of the server
     minpoll: 4                  # Minimum polling interval (default 6)
     maxpoll: 8                  # Maximum polling interval (default 10)
-    iburst: yes                 # Flag enabling fast initial synchronization
-                                # (default no)
-    pool: no                    # Flag indicating that each resolved address
+    iburst: true                # Flag enabling fast initial synchronization
+                                # (default false)
+    pool: false                 # Flag indicating that each resolved address
                                 # of the hostname is a separate NTP server
-                                # (default no)
-    nts: no                     # Flag enabling Network Time Security (NTS)
-                                # authentication mechanism (default no,
+                                # (default false)
+    nts: false                  # Flag enabling Network Time Security (NTS)
+                                # authentication mechanism (default false,
                                 # supported only with chrony >= 4.0)
-    prefer: no                  # Flag marking the source to be preferred for
+    prefer: false               # Flag marking the source to be preferred for
                                 # synchronization over other sources
-                                # (default no)
-    trust: no                   # Flag marking the source to be trusted over
+                                # (default false)
+    trust: false                # Flag marking the source to be trusted over
                                 # sources that don't have this flag
-                                # (default no)
-    xleave: no                  # Flag enabling interleaved mode (default no)
+                                # (default false)
+    xleave: false               # Flag enabling interleaved mode (default false)
     filter: 1                   # Number of NTP measurements per clock update
                                 # (default 1)
 
 # List of PTP domains
 timesync_ptp_domains:
   - number: 0                   # PTP domain number
-    interfaces: [ eth0 ]        # List of interfaces in the domain
+    interfaces: [eth0]          # List of interfaces in the domain
     delay: 0.000010             # Assumed maximum network delay to the
                                 # grandmaster in seconds
                                 # (default 100 microsecond)
     transport: UDPv4            # Network transport: UDPv4, UDPv6, L2
                                 # (default UDPv4)
     udp_ttl: 1                  # TTL for UDPv4 and UDPv6 transports
                                 # (default 1)
-    hybrid_e2e: no              # Flag enabling unicast end-to-end delay
-                                # requests (default no)
+    hybrid_e2e: false           # Flag enabling unicast end-to-end delay
+                                # requests (default false)
 
-# Flag enabling use of NTP servers provided by DHCP (default no)
-timesync_dhcp_ntp_servers: no
+# Flag enabling use of NTP servers provided by DHCP (default false)
+timesync_dhcp_ntp_servers: false
 
 # Minimum offset of the clock which can be corrected by stepping (default is
 # specific to NTP/PTP implementation: chrony 1.0, ntp 0.128, linuxptp 0.00002).
@@ -80,21 +80,21 @@ timesync_min_sources: 1
 # List of interfaces which should have hardware timestamping enabled for NTP
 # (default empty list). As a special value, '*' enables the timestamping on all
 # interfaces that support it.
-timesync_ntp_hwts_interfaces: [ '*' ]
+timesync_ntp_hwts_interfaces: ["*"]
 
 # Name of the package which should be installed and configured for NTP.
 # Possible values are "chrony" and "ntp". If not defined, the currently active
 # or enabled service will be configured. If no service is active or enabled, a
 # package specific to the system and its version will be selected.
 timesync_ntp_provider: chrony
 
-# Sometimes administrators might need extended configurations for chrony which 
-# are not covered by the predefined settings provided by this role. 
-# 'timesync_chrony_custom_settings' allows to define a list of custom settings 
-# for the chrony.conf file, by providing a list of settings. As an example, 
+# Sometimes administrators might need extended configurations for chrony which
+# are not covered by the predefined settings provided by this role.
+# 'timesync_chrony_custom_settings' allows to define a list of custom settings
+# for the chrony.conf file, by providing a list of settings. As an example,
 # for debugging, one might need to log mesurements, statistics and tracking.
-# This information is usually stored in the /var/log/chrony directory. For 
-# that, one needs to define two different settings (logdir and log), as 
+# This information is usually stored in the /var/log/chrony directory. For
+# that, one needs to define two different settings (logdir and log), as
 # follows:
 timesync_chrony_custom_settings:
   - "logdir /var/log/chrony"
@@ -111,11 +111,11 @@ Install and configure ntp to synchronize the system clock with three NTP servers
   vars:
     timesync_ntp_servers:
       - hostname: foo.example.com
-        iburst: yes
+        iburst: true
       - hostname: bar.example.com
-        iburst: yes
+        iburst: true
       - hostname: baz.example.com
-        iburst: yes
+        iburst: true
   roles:
     - linux-system-roles.timesync
 ```
@@ -128,7 +128,7 @@ grandmaster in PTP domain number 0, which is accessible on interface eth0:
   vars:
     timesync_ptp_domains:
       - number: 0
-        interfaces: [ eth0 ]
+        interfaces: [eth0]
   roles:
     - linux-system-roles.timesync
 ```
@@ -149,19 +149,19 @@ synchronization:
         maxpoll: 6
     timesync_ptp_domains:
       - number: 0
-        interfaces: [ eth0, eth1 ]
+        interfaces: [eth0, eth1]
         transport: L2
         delay: 0.000010
       - number: 1
-        interfaces: [ eth2 ]
+        interfaces: [eth2]
         transport: UDPv4
         delay: 0.000010
   roles:
     - linux-system-roles.timesync
 ```
 
-Install and configure chrony with multiple NTP servers and custom advanced 
-settings: log `measurements`,`statistics` and `tracking`
+Install and configure chrony with multiple NTP servers and custom advanced
+settings: log `measurements`, `statistics` and `tracking`
 into `/var/log/chrony`:
 
 

defaults/main.yml

@@ -5,5 +5,5 @@ timesync_dhcp_ntp_servers: false
 timesync_step_threshold: -1.0
 timesync_min_sources: 1
 timesync_ntp_hwts_interfaces: []
-timesync_ntp_provider: ''
+timesync_ntp_provider: ""
 timesync_max_distance: 0

examples/multiple-ntp-servers.yml

@@ -1,5 +1,6 @@
 ---
-- hosts: "{{ target }}"
+- name: Example with multiple servers
+  hosts: "{{ targets }}"
   vars:
     timesync_ntp_servers:
       - hostname: 0.pool.ntp.org

examples/single-pool.yml

@@ -1,5 +1,6 @@
 ---
-- hosts: "{{ targets }}"
+- name: Example with single pool
+  hosts: "{{ targets }}"
   vars:
     timesync_ntp_servers:
       - hostname: 2.pool.ntp.org

tests/setup-snapshot.yml

@@ -1,5 +1,6 @@
 ---
-- hosts: all
+- name: Setup snapshot
+  hosts: all
   tasks:
     - name: Set platform/version specific variables
       include_role:
@@ -15,7 +16,7 @@
           - linuxptp
         state: present
       no_log: true
-      ignore_errors: true
+      ignore_errors: true  # noqa ignore-errors
 
     - name: Uninstall test packages
       package:

tests/tests_chrony.yml

@@ -26,7 +26,8 @@
     - name: Run chrony tests
       tags: tests::verify
       block:
-        - meta: flush_handlers
+        - name: Flush handlers
+          meta: flush_handlers
 
         - name: Wait for services to start
           wait_for:
@@ -35,6 +36,7 @@
         - name: Get list of currently used time sources
           shell: chronyc -n sources || ntpq -pn
           register: sources
+          changed_when: false
 
         - name: Check time sources
           assert:
@@ -44,8 +46,9 @@
               - "'172.16.123.3' in sources.stdout"
 
         - name: Get list of log files
-          shell: ls /var/log/chrony/
+          command: ls /var/log/chrony/
           register: logfiles
+          changed_when: false
 
         - name: Check log generated files
           assert:

tests/tests_default.yml

@@ -1,7 +1,6 @@
 ---
 - name: Ensure that the role runs with default parameters
   hosts: all
-
+  gather_facts: false
   roles:
     - linux-system-roles.timesync
-  gather_facts: false

tests/tests_default_vars.yml

@@ -1,14 +1,13 @@
 ---
 - name: Ensure that the role declares all parameters in defaults
   hosts: all
-
   tasks:
-    - name: include the timesync role
+    - name: Include the timesync role
       include_role:
         name: linux-system-roles.timesync
         public: true
 
-    - name: check that public vars are defined
+    - name: Check that public vars are defined
       assert:
         that: vars[item] is defined
       loop:

tests/tests_default_wrapper.yml

@@ -4,7 +4,7 @@
     - 'tests::slow'
   hosts: all
   tasks:
-    - name: create temporary file
+    - name: Create temporary file
       tempfile:
         state: file
         suffix: .inventory.yaml
@@ -37,7 +37,7 @@
       vars:
         __ap_cmd: "{{ ansible_playbook_filepath | d('ansible-playbook') }}"
 
-    - name: remove the temporary file
+    - name: Remove the temporary file
       file:
         path: "{{ tempinventory.path }}"
         state: absent

tests/tests_ntp.yml

@@ -21,13 +21,16 @@
     timesync_step_threshold: 0.01
     timesync_dhcp_ntp_servers: true
     timesync_min_sources: 2
-    timesync_ntp_hwts_interfaces: ['*']
+    timesync_ntp_hwts_interfaces: ["*"]
   roles:
     - linux-system-roles.timesync
 
   tasks:
-    - block:
-        - meta: flush_handlers
+    - name: Run test
+      tags: tests::verify
+      block:
+        - name: Flush handlers
+          meta: flush_handlers
 
         - name: Wait for services to start
           wait_for:
@@ -36,6 +39,7 @@
         - name: Get list of currently used time sources
           shell: chronyc -n sources || ntpq -pn
           register: sources
+          changed_when: false
 
         - name: Check time sources
           assert:
@@ -105,4 +109,3 @@
               - ntp_conf is not search('172\.16\.123\.2.*true')
               - ntp_conf is search('172\.16\.123\.3.*true')
           when: ntp_conf is defined
-      tags: tests::verify

tests/tests_ntp_provider1.yml

@@ -8,27 +8,32 @@
     - linux-system-roles.timesync
 
   pre_tasks:
-    - block:
+    - name: Remove provider packages
+      check_mode: false
+      tags: tests::setup
+      block:
         - name: Remove NTP providers
-          package: name={{ item }} state=absent
+          package:
+            name: "{{ item }}"
+            state: absent
           with_items:
             - chrony
             - ntp
-      check_mode: false
-      tags: tests::setup
 
   post_tasks:
-    - block:
+    - name: Verify provider is working
+      tags: tests::verify
+      block:
         - name: Wait for services to start
           wait_for:
             timeout: 2
 
         - name: Get list of currently used time sources
           shell: chronyc -n sources || ntpq -pn
           register: sources
+          changed_when: false
 
         - name: Check time sources
           assert:
             that:
               - "'172.16.123.1' in sources.stdout"
-      tags: tests::verify

tests/tests_ntp_provider2.yml

@@ -8,29 +8,40 @@
     - linux-system-roles.timesync
 
   pre_tasks:
-    - block:
+    - name: Remove the install ntp
+      check_mode: false
+      tags: tests::setup
+      block:
         - name: Remove ntp
-          package: name=ntp state=absent
+          package:
+            name: ntp
+            state: absent
 
         - name: Install chrony
-          package: name=chrony state=present
+          package:
+            name: chrony
+            state: present
           register: package_install
-          ignore_errors: true
+          ignore_errors: true  # noqa ignore-errors
 
-        - meta: end_play
+        - name: Skip test if no package
+          meta: end_play
           when: package_install.failed
 
         - name: Enable chronyd
-          service: name=chronyd state=started enabled=yes
-      check_mode: false
-      tags: tests::setup
+          service:
+            name: chronyd
+            state: started
+            enabled: true
 
   post_tasks:
-    - block:
+    - name: Verify chronyd running
+      tags: tests::verify
+      block:
         - name: Wait for services to start
           wait_for:
             timeout: 2
 
         - name: Check chronyd service
-          shell: chronyc -n tracking
-      tags: tests::verify
+          command: chronyc -n tracking
+          changed_when: false