refactor to comply with current ansible-lint and sanity guidelines

Signed-off-by: Adam Miller <admiller@redhat.com>

tests/integration/targets/authorized_key/tasks/check_mode.yml

@@ -1,34 +1,37 @@
+---
 # -------------------------------------------------------------
 # check mode
 
 - name: CHECK MODE | copy an existing file in place with comments
-  copy:
+  ansible.builtin.copy:
     src: existing_authorized_keys
     dest: "{{ output_dir | expanduser }}/authorized_keys"
+    mode: "0600"
 
 - name: CHECK MODE | add key in check mode to validate return codes
-  authorized_key:
+  ansible.posix.authorized_key:
     user: root
     key: "{{ multiple_key_different_order_2 }}"
     state: present
     path: "{{ output_dir | expanduser }}/authorized_keys"
-  check_mode: True
+  check_mode: true
   register: result
 
 - name: CHECK MODE | assert that authorized_keys return values are consistent
-  assert:
+  ansible.builtin.assert:
     that:
-      - 'result.changed == True'
+      - result.changed == True
       - '"user" in result'
       - '"key" in result'
 
 - name: CHECK MODE | recopy authorized_keys to ensure it was not changed
-  copy:
+  ansible.builtin.copy:
     src: existing_authorized_keys
     dest: "{{ output_dir | expanduser }}/authorized_keys"
+    mode: "0600"
   register: result
 
 - name: CHECK MODE | assert that the authorized_keys file was not changed
-  assert:
+  ansible.builtin.assert:
     that:
-      - 'result.changed == False'
+      - result.changed == False

tests/integration/targets/authorized_key/tasks/comments.yml

@@ -1,8 +1,9 @@
+---
 # -------------------------------------------------------------
 # comments
 
 - name: Add rsa key with existing comment
-  authorized_key:
+  ansible.posix.authorized_key:
     user: root
     key: "{{ rsa_key_basic }}"
     state: present
@@ -10,7 +11,7 @@
   register: result
 
 - name: Change the comment on an existing key
-  authorized_key:
+  ansible.posix.authorized_key:
     user: root
     key: "{{ rsa_key_basic }}"
     comment: user@acme.com
@@ -18,18 +19,18 @@
     path: "{{ output_dir | expanduser }}/authorized_keys"
   register: result
 
-- name: get the file content
-  shell: cat "{{ output_dir | expanduser }}/authorized_keys" | fgrep DATA_BASIC
-  changed_when: no
+- name: Get the file content
+  ansible.builtin.command: fgrep DATA_BASIC "{{ output_dir | expanduser }}/authorized_keys"
+  changed_when: false
   register: content
 
 - name: Assert that comment on an existing key was changed
-  assert:
+  ansible.builtin.assert:
     that:
       - "'user@acme.com' in content.stdout"
 
 - name: Set the same key with comment to ensure no changes are reported
-  authorized_key:
+  ansible.posix.authorized_key:
     user: root
     key: "{{ rsa_key_basic }}"
     comment: user@acme.com
@@ -38,11 +39,12 @@
   register: result
 
 - name: Assert that no changes were made when running again
-  assert:
+  ansible.builtin.assert:
     that:
       - not result.changed
 
-- debug:
+- name: Debug the result and content
+  ansible.builtin.debug:
     var: "{{ item }}"
     verbosity: 1
   with_items:

tests/integration/targets/authorized_key/tasks/main.yml

@@ -1,3 +1,4 @@
+---
 # test code for the authorized_key module
 # - (c) 2014, James Cammarata <jcammarata@ansible.com>
 # - (c) 2021, Hideki Saito <saito@fgrep.org>
@@ -17,16 +18,16 @@
 # along with Ansible.  If not, see <http://www.gnu.org/licenses/>.
 
 - name: Setup testing environment
-  import_tasks: setup_steps.yml
+  ansible.builtin.import_tasks: setup_steps.yml
 
 - name: Test for multiple keys handling
-  import_tasks: multiple_keys.yml
+  ansible.builtin.import_tasks: multiple_keys.yml
 
 - name: Test for ssh-dss key handling
-  import_tasks: ssh_dss.yml
+  ansible.builtin.import_tasks: ssh_dss.yml
 
 - name: Test for check mode
-  import_tasks: check_mode.yml
+  ansible.builtin.import_tasks: check_mode.yml
 
 - name: Test for the management of comments with key
-  import_tasks: comments.yml
+  ansible.builtin.import_tasks: comments.yml

tests/integration/targets/authorized_key/tasks/multiple_keys.yml

@@ -1,38 +1,39 @@
+---
 # -------------------------------------------------------------
 # multiple keys
 
-- name: add multiple keys
-  authorized_key:
+- name: Add multiple keys
+  ansible.posix.authorized_key:
     user: root
     key: "{{ multiple_key_base }}"
     state: present
     path: "{{ output_dir | expanduser }}/authorized_keys"
   register: result
 
-- name: assert that the key was added
-  assert:
+- name: Assert that the key was added
+  ansible.builtin.assert:
     that:
-    - 'result.changed == True'
-    - 'result.key == multiple_key_base'
-    - 'result.key_options == None'
+      - result.changed == True
+      - result.key == multiple_key_base
+      - result.key_options == None
 
-- name: add multiple keys different order
-  authorized_key:
+- name: Add multiple keys different order
+  ansible.posix.authorized_key:
     user: root
     key: "{{ multiple_key_different_order }}"
     state: present
     path: "{{ output_dir | expanduser }}/authorized_keys"
   register: result
 
-- name: assert that the key was added
-  assert:
+- name: Assert that the key was added
+  ansible.builtin.assert:
     that:
-    - 'result.changed == True'
-    - 'result.key == multiple_key_different_order'
-    - 'result.key_options == None'
+      - result.changed == True
+      - result.key == multiple_key_different_order
+      - result.key_options == None
 
-- name: add multiple keys exclusive
-  authorized_key:
+- name: Add multiple keys exclusive
+  ansible.posix.authorized_key:
     user: root
     key: "{{ multiple_key_exclusive }}"
     state: present
@@ -40,42 +41,42 @@
     exclusive: true
   register: result
 
-- name: assert that the key was added
-  assert:
+- name: Assert that the key was added
+  ansible.builtin.assert:
     that:
-      - 'result.changed == True'
-      - 'result.key == multiple_key_exclusive'
-      - 'result.key_options == None'
+      - result.changed == True
+      - result.key == multiple_key_exclusive
+      - result.key_options == None
 
-- name: add multiple keys in different calls
-  authorized_key:
+- name: Add multiple keys in different calls
+  ansible.posix.authorized_key:
     user: root
-    key: "ecdsa-sha2-nistp521 ECDSA_DATA 4@testing"
+    key: ecdsa-sha2-nistp521 ECDSA_DATA 4@testing
     state: present
     path: "{{ output_dir | expanduser }}/authorized_keys"
   register: result
 
-- name: add multiple keys in different calls
-  authorized_key:
+- name: Add multiple keys in different calls
+  ansible.posix.authorized_key:
     user: root
-    key: "ssh-rsa DATA_BASIC 1@testing"
+    key: ssh-rsa DATA_BASIC 1@testing
     state: present
     path: "{{ output_dir | expanduser }}/authorized_keys"
   register: result
 
-- name: get the file content
-  shell: cat "{{ output_dir | expanduser }}/authorized_keys"
-  changed_when: no
+- name: Get the file content
+  ansible.builtin.command: /bin/cat "{{ output_dir | expanduser }}/authorized_keys"
+  changed_when: false
   register: multiple_keys_at_a_time
 
-- name: assert that the key was added
-  assert:
+- name: Assert that the key was added
+  ansible.builtin.assert:
     that:
-      - 'result.changed == false'
-      - 'multiple_keys_at_a_time.stdout  == multiple_key_exclusive.strip()'
+      - result.changed == false
+      - multiple_keys_at_a_time.stdout  == multiple_key_exclusive.strip()
 
-- name: add multiple keys comment
-  authorized_key:
+- name: Add multiple keys comment
+  ansible.posix.authorized_key:
     user: root
     key: "{{ multiple_keys_comments }}"
     state: present
@@ -83,14 +84,14 @@
     exclusive: true
   register: result
 
-- name: get the file content
-  shell: cat "{{ output_dir | expanduser }}/authorized_keys"
-  changed_when: no
+- name: Get the file content
+  ansible.builtin.command: /bin/cat "{{ output_dir | expanduser }}/authorized_keys"
+  changed_when: false
   register: multiple_keys_comments
 
-- name: assert that the keys exist and comment only lines were not added
-  assert:
+- name: Assert that the keys exist and comment only lines were not added
+  ansible.builtin.assert:
     that:
-      - 'result.changed == False'
-      - 'multiple_keys_comments.stdout == multiple_key_exclusive.strip()'
-      - 'result.key_options == None'
+      - result.changed == False
+      - multiple_keys_comments.stdout == multiple_key_exclusive.strip()
+      - result.key_options == None

tests/integration/targets/authorized_key/tasks/setup_steps.yml

@@ -1,37 +1,40 @@
+---
 # -------------------------------------------------------------
 # Setup steps
 - name: Clean up the working directory and files
-  file:
-    path: '{{ output_dir }}'
+  ansible.builtin.file:
+    path: "{{ output_dir }}"
     state: absent
 
 - name: Create the working directory
-  file:
-    path: '{{ output_dir }}'
+  ansible.builtin.file:
+    path: "{{ output_dir }}"
     state: directory
+    mode: "0744"
 
-- name: copy an existing file in place with comments
-  copy:
+- name: Copy an existing file in place with comments
+  ansible.builtin.copy:
     src: existing_authorized_keys
     dest: "{{ output_dir | expanduser }}/authorized_keys"
+    mode: "0600"
 
-- name: add multiple keys different order
-  authorized_key:
+- name: Add multiple keys different order
+  ansible.posix.authorized_key:
     user: root
     key: "{{ multiple_key_different_order_2 }}"
     state: present
     path: "{{ output_dir | expanduser }}/authorized_keys"
   register: result
 
-- name: get the file content
-  shell: cat "{{ output_dir | expanduser }}/authorized_keys"
-  changed_when: no
+- name: Get the file content
+  ansible.builtin.command: /bin/cat "{{ output_dir | expanduser }}/authorized_keys"
+  changed_when: false
   register: multiple_keys_existing
 
-- name: assert that the key was added and comments and ordering preserved
-  assert:
+- name: Assert that the key was added and comments and ordering preserved
+  ansible.builtin.assert:
     that:
-      - 'result.changed == True'
+      - result.changed == True
       - '"# I like candy" in multiple_keys_existing.stdout'
       - '"# I like candy" in multiple_keys_existing.stdout_lines[0]'
       - '"ssh-rsa DATA_BASIC 1@testing" in multiple_keys_existing.stdout'
@@ -41,19 +44,20 @@
 
 # start afresh
 
-- name: remove file foo.txt
-  file:
+- name: Remove file foo.txt
+  ansible.builtin.file:
     path: "{{ output_dir | expanduser }}/authorized_keys"
     state: absent
 
-- name: touch the authorized_keys file
-  file:
+- name: Touch the authorized_keys file
+  ansible.builtin.file:
     dest: "{{ output_dir }}/authorized_keys"
     state: touch
+    mode: "0600"
   register: result
 
-- name: assert that the authorized_keys file was created
-  assert:
+- name: Assert that the authorized_keys file was created
+  ansible.builtin.assert:
     that:
-      - 'result.changed == True'
-      - 'result.state == "file"'
+      - result.changed == True
+      - result.state == "file"

tests/integration/targets/authorized_key/tasks/ssh_dss.yml

@@ -1,241 +1,250 @@
+---
 # -------------------------------------------------------------
 # basic ssh-dss key
 
-- name: add basic ssh-dss key
-  authorized_key: user=root key="{{ dss_key_basic }}" state=present path="{{ output_dir | expanduser }}/authorized_keys"
+- name: Add basic ssh-dss key
+  ansible.posix.authorized_key:
+    user: root
+    key: "{{ dss_key_basic }}"
+    state: present
+    path: "{{ output_dir | expanduser }}/authorized_keys"
   register: result
 
-- name: assert that the key was added
-  assert:
+- name: Assert that the key was added
+  ansible.builtin.assert:
     that:
-      - 'result.changed == True'
-      - 'result.key == dss_key_basic'
-      - 'result.key_options == None'
+      - result.changed == True
+      - result.key == dss_key_basic
+      - result.key_options == None
 
-- name: re-add basic ssh-dss key
-  authorized_key: user=root key="{{ dss_key_basic }}" state=present path="{{ output_dir | expanduser }}/authorized_keys"
+- name: Re-add basic ssh-dss key
+  ansible.posix.authorized_key:
+    user: root
+    key: "{{ dss_key_basic }}"
+    state: present
+    path: "{{ output_dir | expanduser }}/authorized_keys"
   register: result
 
-- name: assert that nothing changed
-  assert:
+- name: Assert that nothing changed
+  ansible.builtin.assert:
     that:
-      - 'result.changed == False'
+      - result.changed == False
 
 # -------------------------------------------------------------
 # ssh-dss key with an unquoted option
 
-- name: add ssh-dss key with an unquoted option
-  authorized_key:
+- name: Add ssh-dss key with an unquoted option
+  ansible.posix.authorized_key:
     user: root
     key: "{{ dss_key_unquoted_option }}"
     state: present
     path: "{{ output_dir | expanduser }}/authorized_keys"
   register: result
 
-- name: assert that the key was added
-  assert:
+- name: Assert that the key was added
+  ansible.builtin.assert:
     that:
-      - 'result.changed == True'
-      - 'result.key == dss_key_unquoted_option'
-      - 'result.key_options == None'
+      - result.changed == True
+      - result.key == dss_key_unquoted_option
+      - result.key_options == None
 
-- name: re-add ssh-dss key with an unquoted option
-  authorized_key:
+- name: Re-add ssh-dss key with an unquoted option
+  ansible.posix.authorized_key:
     user: root
     key: "{{ dss_key_unquoted_option }}"
     state: present
     path: "{{ output_dir | expanduser }}/authorized_keys"
   register: result
 
-- name: assert that nothing changed
-  assert:
+- name: Assert that nothing changed
+  ansible.builtin.assert:
     that:
-      - 'result.changed == False'
+      - result.changed == False
 
 # -------------------------------------------------------------
 # ssh-dss key with a leading command="/bin/foo"
 
-- name: add ssh-dss key with a leading command
-  authorized_key:
+- name: Add ssh-dss key with a leading command
+  ansible.posix.authorized_key:
     user: root
     key: "{{ dss_key_command }}"
     state: present
     path: "{{ output_dir | expanduser }}/authorized_keys"
   register: result
 
-- name: assert that the key was added
-  assert:
+- name: Assert that the key was added
+  ansible.builtin.assert:
     that:
-      - 'result.changed == True'
-      - 'result.key == dss_key_command'
-      - 'result.key_options == None'
+      - result.changed == True
+      - result.key == dss_key_command
+      - result.key_options == None
 
-- name: re-add ssh-dss key with a leading command
-  authorized_key:
+- name: Re-add ssh-dss key with a leading command
+  ansible.posix.authorized_key:
     user: root
     key: "{{ dss_key_command }}"
     state: present
     path: "{{ output_dir | expanduser }}/authorized_keys"
   register: result
 
-- name: assert that nothing changed
-  assert:
+- name: Assert that nothing changed
+  ansible.builtin.assert:
     that:
-      - 'result.changed == False'
+      - result.changed == False
 
 # -------------------------------------------------------------
 # ssh-dss key with a complex quoted leading command
 # ie. command="/bin/echo foo 'bar baz'"
 
-- name: add ssh-dss key with a complex quoted leading command
-  authorized_key:
+- name: Add ssh-dss key with a complex quoted leading command
+  ansible.posix.authorized_key:
     user: root
     key: "{{ dss_key_complex_command }}"
     state: present
     path: "{{ output_dir | expanduser }}/authorized_keys"
   register: result
 
-- name: assert that the key was added
-  assert:
+- name: Assert that the key was added
+  ansible.builtin.assert:
     that:
-      - 'result.changed == True'
-      - 'result.key == dss_key_complex_command'
-      - 'result.key_options == None'
+      - result.changed == True
+      - result.key == dss_key_complex_command
+      - result.key_options == None
 
-- name: re-add ssh-dss key with a complex quoted leading command
-  authorized_key:
+- name: Re-add ssh-dss key with a complex quoted leading command
+  ansible.posix.authorized_key:
     user: root
     key: "{{ dss_key_complex_command }}"
     state: present
     path: "{{ output_dir | expanduser }}/authorized_keys"
   register: result
 
-- name: assert that nothing changed
-  assert:
+- name: Assert that nothing changed
+  ansible.builtin.assert:
     that:
-      - 'result.changed == False'
+      - result.changed == False
 
 # -------------------------------------------------------------
 # ssh-dss key with a command and a single option, which are
 # in a comma-separated list
 
-- name: add ssh-dss key with a command and a single option
-  authorized_key:
+- name: Add ssh-dss key with a command and a single option
+  ansible.posix.authorized_key:
     user: root
     key: "{{ dss_key_command_single_option }}"
     state: present
     path: "{{ output_dir | expanduser }}/authorized_keys"
   register: result
 
-- name: assert that the key was added
-  assert:
+- name: Assert that the key was added
+  ansible.builtin.assert:
     that:
-      - 'result.changed == True'
-      - 'result.key == dss_key_command_single_option'
-      - 'result.key_options == None'
+      - result.changed == True
+      - result.key == dss_key_command_single_option
+      - result.key_options == None
 
-- name: re-add ssh-dss key with a command and a single option
-  authorized_key:
+- name: Re-add ssh-dss key with a command and a single option
+  ansible.posix.authorized_key:
     user: root
     key: "{{ dss_key_command_single_option }}"
     state: present
     path: "{{ output_dir | expanduser }}/authorized_keys"
   register: result
 
-- name: assert that nothing changed
-  assert:
+- name: Assert that nothing changed
+  ansible.builtin.assert:
     that:
-      - 'result.changed == False'
+      - result.changed == False
 
 # -------------------------------------------------------------
 # ssh-dss key with a command and multiple other options
 
-- name: add ssh-dss key with a command and multiple options
-  authorized_key:
+- name: Add ssh-dss key with a command and multiple options
+  ansible.posix.authorized_key:
     user: root
     key: "{{ dss_key_command_multiple_options }}"
     state: present
     path: "{{ output_dir | expanduser }}/authorized_keys"
   register: result
 
-- name: assert that the key was added
-  assert:
+- name: Assert that the key was added
+  ansible.builtin.assert:
     that:
-      - 'result.changed == True'
-      - 'result.key == dss_key_command_multiple_options'
-      - 'result.key_options == None'
+      - result.changed == True
+      - result.key == dss_key_command_multiple_options
+      - result.key_options == None
 
-- name: re-add ssh-dss key with a command and multiple options
-  authorized_key:
+- name: Re-add ssh-dss key with a command and multiple options
+  ansible.posix.authorized_key:
     user: root
     key: "{{ dss_key_command_multiple_options }}"
     state: present
     path: "{{ output_dir | expanduser }}/authorized_keys"
   register: result
 
-- name: assert that nothing changed
-  assert:
+- name: Assert that nothing changed
+  ansible.builtin.assert:
     that:
-      - 'result.changed == False'
+      - result.changed == False
 
 # -------------------------------------------------------------
 # ssh-dss key with multiple trailing parts, which are space-
 # separated and not quoted in any way
 
-- name: add ssh-dss key with trailing parts
-  authorized_key:
+- name: Add ssh-dss key with trailing parts
+  ansible.posix.authorized_key:
     user: root
     key: "{{ dss_key_trailing }}"
     state: present
     path: "{{ output_dir | expanduser }}/authorized_keys"
   register: result
 
-- name: assert that the key was added
-  assert:
+- name: Assert that the key was added
+  ansible.builtin.assert:
     that:
-      - 'result.changed == True'
-      - 'result.key == dss_key_trailing'
-      - 'result.key_options == None'
+      - result.changed == True
+      - result.key == dss_key_trailing
+      - result.key_options == None
 
-- name: re-add ssh-dss key with trailing parts
-  authorized_key:
+- name: Re-add ssh-dss key with trailing parts
+  ansible.posix.authorized_key:
     user: root
     key: "{{ dss_key_trailing }}"
     state: present
     path: "{{ output_dir | expanduser }}/authorized_keys"
   register: result
 
-- name: assert that nothing changed
-  assert:
+- name: Assert that nothing changed
+  ansible.builtin.assert:
     that:
-      - 'result.changed == False'
+      - result.changed == False
 
 # -------------------------------------------------------------
 # basic ssh-dss key with mutliple permit-open options
 # https://github.com/ansible/ansible-modules-core/issues/1715
 
-- name: add basic ssh-dss key with multi-opts
-  authorized_key:
+- name: Add basic ssh-dss key with multi-opts
+  ansible.posix.authorized_key:
     user: root
     key: "{{ dss_key_basic }}"
-    key_options: 'no-agent-forwarding,no-X11-forwarding,permitopen="10.9.8.1:8080",permitopen="10.9.8.1:9001"'
+    key_options: no-agent-forwarding,no-X11-forwarding,permitopen="10.9.8.1:8080",permitopen="10.9.8.1:9001"
     state: present
     path: "{{ output_dir | expanduser }}/authorized_keys"
   register: result
 
-- name: assert that the key with multi-opts was added
-  assert:
+- name: Assert that the key with multi-opts was added
+  ansible.builtin.assert:
     that:
-      - 'result.changed == True'
-      - 'result.key == dss_key_basic'
-      - 'result.key_options == "no-agent-forwarding,no-X11-forwarding,permitopen=\"10.9.8.1:8080\",permitopen=\"10.9.8.1:9001\""'
+      - result.changed == True
+      - result.key == dss_key_basic
+      - result.key_options == "no-agent-forwarding,no-X11-forwarding,permitopen=\"10.9.8.1:8080\",permitopen=\"10.9.8.1:9001\""
 
-- name: get the file content
-  shell: cat "{{ output_dir | expanduser }}/authorized_keys" | fgrep DATA_BASIC
-  changed_when: no
+- name: Get the file content
+  ansible.builtin.command: fgrep DATA_BASIC "{{ output_dir | expanduser }}/authorized_keys"
+  changed_when: false
   register: content
 
-- name: validate content
-  assert:
+- name: Validate content
+  ansible.builtin.assert:
     that:
-      - 'content.stdout == "no-agent-forwarding,no-X11-forwarding,permitopen=\"10.9.8.1:8080\",permitopen=\"10.9.8.1:9001\" ssh-dss DATA_BASIC root@testing"'
+      - content.stdout == "no-agent-forwarding,no-X11-forwarding,permitopen=\"10.9.8.1:8080\",permitopen=\"10.9.8.1:9001\" ssh-dss DATA_BASIC root@testing"