mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-24 05:40:23 -07:00
win_mapped_drive: new module (#27020)
* win_mapped_drive: new module * Rebased from upstream and updated copyright text
This commit is contained in:
parent
e46adece48
commit
44ed891290
6 changed files with 555 additions and 0 deletions
1
test/integration/targets/win_mapped_drive/aliases
Normal file
1
test/integration/targets/win_mapped_drive/aliases
Normal file
|
@ -0,0 +1 @@
|
|||
windows/ci/group1
|
|
@ -0,0 +1,9 @@
|
|||
test_win_mapped_drive_letter: M
|
||||
test_win_mapped_drive_path: share1
|
||||
test_win_mapped_drive_path2: share2
|
||||
|
||||
test_win_mapped_drive_local_path: C:\ansible\win_mapped_drive\share1
|
||||
test_win_mapped_drive_local_path2: C:\ansible\win_mapped_drive\share2
|
||||
|
||||
test_win_mapped_drive_temp_user: TestMappedUser
|
||||
test_win_mapped_drive_temp_password: aZ293jgkdslgj4
|
62
test/integration/targets/win_mapped_drive/tasks/main.yml
Normal file
62
test/integration/targets/win_mapped_drive/tasks/main.yml
Normal file
|
@ -0,0 +1,62 @@
|
|||
---
|
||||
# test setup
|
||||
- name: gather facts required by the tests
|
||||
setup:
|
||||
|
||||
- name: ensure mapped drive is deleted before test
|
||||
win_mapped_drive:
|
||||
letter: '{{test_win_mapped_drive_letter}}'
|
||||
state: absent
|
||||
|
||||
- name: ensure temp mapped drive user exist
|
||||
win_user:
|
||||
name: '{{test_win_mapped_drive_temp_user}}'
|
||||
password: '{{test_win_mapped_drive_temp_password}}'
|
||||
state: present
|
||||
groups:
|
||||
- Administrators
|
||||
|
||||
- name: ensure temp folders exist
|
||||
win_file:
|
||||
path: '{{item}}'
|
||||
state: directory
|
||||
with_items:
|
||||
- '{{test_win_mapped_drive_local_path}}'
|
||||
- '{{test_win_mapped_drive_local_path2}}'
|
||||
|
||||
# can't use win_share as it doesnt't support Server 2008 and 2008 R2
|
||||
- name: ensure shares exist
|
||||
win_shell: $share = Get-WmiObject -Class Win32_Share | Where-Object { $_.Name -eq '{{item.name}}' }; if (-not $share) { $share = [wmiClass]'Win32_Share'; $share.Create('{{item.path}}', '{{item.name}}', 0) }
|
||||
with_items:
|
||||
- { name: '{{test_win_mapped_drive_path}}', path: '{{test_win_mapped_drive_local_path}}' }
|
||||
- { name: '{{test_win_mapped_drive_path2}}', path: '{{test_win_mapped_drive_local_path2}}' }
|
||||
|
||||
- block:
|
||||
# tests
|
||||
- include_tasks: tests.yml
|
||||
|
||||
# test cleanup
|
||||
always:
|
||||
- name: ensure mapped drive is deleted at the end of the test
|
||||
win_mapped_drive:
|
||||
letter: '{{test_win_mapped_drive_letter}}'
|
||||
state: absent
|
||||
|
||||
- name: ensure shares are removed
|
||||
win_shell: $share = Get-WmiObject -Class Win32_Share | Where-Object { $_.Name -eq '{{item}}' }; if ($share) { $share.Delete() }
|
||||
with_items:
|
||||
- '{{test_win_mapped_drive_path}}'
|
||||
- '{{test_win_mapped_drive_path2}}'
|
||||
|
||||
- name: ensure temp folders are deleted
|
||||
win_file:
|
||||
path: '{{item}}'
|
||||
state: absent
|
||||
with_items:
|
||||
- '{{test_win_mapped_drive_local_path}}'
|
||||
- '{{test_win_mapped_drive_local_path2}}'
|
||||
|
||||
- name: ensure temp mapped driver user is deleted
|
||||
win_user:
|
||||
name: '{{test_win_mapped_drive_temp_user}}'
|
||||
state: absent
|
272
test/integration/targets/win_mapped_drive/tasks/tests.yml
Normal file
272
test/integration/targets/win_mapped_drive/tasks/tests.yml
Normal file
|
@ -0,0 +1,272 @@
|
|||
---
|
||||
- name: fail with invalid path
|
||||
win_mapped_drive:
|
||||
letter: invalid
|
||||
register: fail_invalid_letter
|
||||
failed_when: "fail_invalid_letter.msg != 'letter must be a single letter from A-Z, was: invalid'"
|
||||
|
||||
- name: fail without specify path when creating drive
|
||||
win_mapped_drive:
|
||||
letter: '{{test_win_mapped_drive_letter}}'
|
||||
state: present
|
||||
register: fail_path_missing
|
||||
failed_when: fail_path_missing.msg != 'path must be set when creating a mapped drive'
|
||||
|
||||
- name: fail when specifying letter with existing physical path
|
||||
win_mapped_drive:
|
||||
letter: c
|
||||
path: \\{{ansible_hostname}}\{{test_win_mapped_drive_path}}
|
||||
state: present
|
||||
register: fail_local_letter
|
||||
failed_when: fail_local_letter.msg != 'failed to create mapped drive c, this letter is in use and is pointing to a non UNC path'
|
||||
|
||||
- name: create mapped drive check
|
||||
win_mapped_drive:
|
||||
letter: '{{test_win_mapped_drive_letter}}'
|
||||
path: \\{{ansible_hostname}}\{{test_win_mapped_drive_path}}
|
||||
state: present
|
||||
register: create_drive_check
|
||||
check_mode: yes
|
||||
|
||||
- name: get actual of create mapped drive check
|
||||
win_command: 'net use {{test_win_mapped_drive_letter}}:' # Get-PSDrive/Get-WmiObject/Get-CimInstance doesn't work over WinRM
|
||||
register: create_drive_actual_check
|
||||
failed_when: False
|
||||
|
||||
- name: assert create mapped drive check
|
||||
assert:
|
||||
that:
|
||||
- create_drive_check|changed
|
||||
- create_drive_actual_check.rc == 2 # should fail with this error code when it isn't found
|
||||
|
||||
- name: create mapped drive
|
||||
win_mapped_drive:
|
||||
letter: '{{test_win_mapped_drive_letter}}'
|
||||
path: \\{{ansible_hostname}}\{{test_win_mapped_drive_path}}
|
||||
state: present
|
||||
register: create_drive
|
||||
|
||||
- name: get actual of create mapped drive
|
||||
win_command: 'net use {{test_win_mapped_drive_letter}}:'
|
||||
register: create_drive_actual
|
||||
|
||||
- name: assert create mapped drive
|
||||
assert:
|
||||
that:
|
||||
- create_drive|changed
|
||||
- create_drive_actual.rc == 0
|
||||
- create_drive_actual.stdout_lines[1] == "Remote name \\\\{{ansible_hostname}}\\{{test_win_mapped_drive_path}}"
|
||||
|
||||
- name: create mapped drive again
|
||||
win_mapped_drive:
|
||||
letter: '{{test_win_mapped_drive_letter}}'
|
||||
path: \\{{ansible_hostname}}\{{test_win_mapped_drive_path}}
|
||||
state: present
|
||||
register: create_drive_again
|
||||
|
||||
- name: assert create mapped drive again
|
||||
assert:
|
||||
that:
|
||||
- not create_drive_again|changed
|
||||
|
||||
- name: change mapped drive target check
|
||||
win_mapped_drive:
|
||||
letter: '{{test_win_mapped_drive_letter}}'
|
||||
path: \\{{ansible_hostname}}\{{test_win_mapped_drive_path2}}
|
||||
state: present
|
||||
register: change_drive_target_check
|
||||
check_mode: yes
|
||||
|
||||
- name: get actual of change mapped drive target check
|
||||
win_command: 'net use {{test_win_mapped_drive_letter}}:'
|
||||
register: change_drive_target_actual_check
|
||||
|
||||
- name: assert change mapped drive target check
|
||||
assert:
|
||||
that:
|
||||
- change_drive_target_check|changed
|
||||
- change_drive_target_actual_check.rc == 0
|
||||
- change_drive_target_actual_check.stdout_lines[1] == "Remote name \\\\{{ansible_hostname}}\\{{test_win_mapped_drive_path}}"
|
||||
|
||||
- name: change mapped drive target
|
||||
win_mapped_drive:
|
||||
letter: '{{test_win_mapped_drive_letter}}'
|
||||
path: \\{{ansible_hostname}}\{{test_win_mapped_drive_path2}}
|
||||
state: present
|
||||
register: change_drive_target
|
||||
|
||||
- name: get actual of change mapped drive target
|
||||
win_command: 'net use {{test_win_mapped_drive_letter}}:'
|
||||
register: change_drive_target_actual
|
||||
|
||||
- name: assert change mapped drive target
|
||||
assert:
|
||||
that:
|
||||
- change_drive_target|changed
|
||||
- change_drive_target_actual.rc == 0
|
||||
- change_drive_target_actual.stdout_lines[1] == "Remote name \\\\{{ansible_hostname}}\\{{test_win_mapped_drive_path2}}"
|
||||
|
||||
- name: fail to delete mapped drive if target doesn't match
|
||||
win_mapped_drive:
|
||||
letter: '{{test_win_mapped_drive_letter}}'
|
||||
path: \\{{ansible_hostname}}\{{test_win_mapped_drive_path}}
|
||||
state: absent
|
||||
register: fail_delete_incorrect_target
|
||||
failed_when: fail_delete_incorrect_target.msg != 'did not delete mapped drive ' + test_win_mapped_drive_letter + ', the target path is pointing to a different location at \\\\' + ansible_hostname + '\\' + test_win_mapped_drive_path2
|
||||
|
||||
- name: delete mapped drive check
|
||||
win_mapped_drive:
|
||||
letter: '{{test_win_mapped_drive_letter}}'
|
||||
path: \\{{ansible_hostname}}\{{test_win_mapped_drive_path2}}
|
||||
state: absent
|
||||
register: delete_drive_check
|
||||
check_mode: yes
|
||||
|
||||
- name: get actual of delete mapped drive check
|
||||
win_command: 'net use {{test_win_mapped_drive_letter}}:'
|
||||
register: delete_drive_actual_check
|
||||
|
||||
- name: assert delete mapped drive check
|
||||
assert:
|
||||
that:
|
||||
- delete_drive_check|changed
|
||||
- delete_drive_actual_check.rc == 0
|
||||
- delete_drive_actual_check.stdout_lines[1] == "Remote name \\\\{{ansible_hostname}}\\{{test_win_mapped_drive_path2}}"
|
||||
|
||||
- name: delete mapped drive
|
||||
win_mapped_drive:
|
||||
letter: '{{test_win_mapped_drive_letter}}'
|
||||
path: \\{{ansible_hostname}}\{{test_win_mapped_drive_path2}}
|
||||
state: absent
|
||||
register: delete_drive
|
||||
|
||||
- name: get actual of delete mapped drive
|
||||
win_command: 'net use {{test_win_mapped_drive_letter}}:'
|
||||
register: delete_drive_actual
|
||||
failed_when: False
|
||||
|
||||
- name: assert delete mapped drive
|
||||
assert:
|
||||
that:
|
||||
- delete_drive|changed
|
||||
- delete_drive_actual.rc == 2
|
||||
|
||||
- name: delete mapped drive again
|
||||
win_mapped_drive:
|
||||
letter: '{{test_win_mapped_drive_letter}}'
|
||||
path: \\{{ansible_hostname}}\{{test_win_mapped_drive_path2}}
|
||||
state: absent
|
||||
register: delete_drive_again
|
||||
|
||||
- name: assert delete mapped drive again
|
||||
assert:
|
||||
that:
|
||||
- not delete_drive_again|changed
|
||||
|
||||
# not much we can do to test out the credentials except that it sets it, winrm
|
||||
# makes it hard to actually test out we can still access the mapped drive
|
||||
- name: map drive with current credentials check
|
||||
win_mapped_drive:
|
||||
letter: '{{test_win_mapped_drive_letter}}'
|
||||
path: \\{{ansible_hostname}}\{{test_win_mapped_drive_path}}
|
||||
state: present
|
||||
username: '{{ansible_hostname}}\{{test_win_mapped_drive_temp_user}}'
|
||||
password: '{{test_win_mapped_drive_temp_password}}'
|
||||
register: map_with_credentials_check
|
||||
check_mode: yes
|
||||
|
||||
- name: get actual of map drive with current credentials check
|
||||
win_command: 'net use {{test_win_mapped_drive_letter}}:'
|
||||
register: map_with_credentials_actual_check
|
||||
failed_when: False
|
||||
|
||||
- name: assert map drive with current credentials check
|
||||
assert:
|
||||
that:
|
||||
- map_with_credentials_check|changed
|
||||
- map_with_credentials_actual_check.rc == 2
|
||||
|
||||
- name: map drive with current credentials
|
||||
win_mapped_drive:
|
||||
letter: '{{test_win_mapped_drive_letter}}'
|
||||
path: \\{{ansible_hostname}}\{{test_win_mapped_drive_path}}
|
||||
state: present
|
||||
username: '{{ansible_hostname}}\{{test_win_mapped_drive_temp_user}}'
|
||||
password: '{{test_win_mapped_drive_temp_password}}'
|
||||
register: map_with_credentials
|
||||
|
||||
- name: get actual of map drive with current credentials
|
||||
win_command: 'net use {{test_win_mapped_drive_letter}}:'
|
||||
register: map_with_credentials_actual
|
||||
|
||||
- name: get username of mapped network drive with credentials
|
||||
win_reg_stat:
|
||||
path: HKCU:\Network\{{test_win_mapped_drive_letter}}
|
||||
name: UserName
|
||||
register: map_with_credential_actual_username
|
||||
|
||||
- name: assert map drive with current credentials
|
||||
assert:
|
||||
that:
|
||||
- map_with_credentials|changed
|
||||
- map_with_credentials_actual.rc == 0
|
||||
- map_with_credential_actual_username.value == '{{ansible_hostname}}\\{{test_win_mapped_drive_temp_user}}'
|
||||
|
||||
- name: map drive with current credentials again
|
||||
win_mapped_drive:
|
||||
letter: '{{test_win_mapped_drive_letter}}'
|
||||
path: \\{{ansible_hostname}}\{{test_win_mapped_drive_path}}
|
||||
state: present
|
||||
username: '{{ansible_hostname}}\{{test_win_mapped_drive_temp_user}}'
|
||||
password: '{{test_win_mapped_drive_temp_password}}'
|
||||
register: map_with_credentials_again
|
||||
|
||||
- name: assert map drive with current credentials again
|
||||
assert:
|
||||
that:
|
||||
- map_with_credentials_again|changed # we expect a change as it will just delete and recreate if credentials are passed
|
||||
|
||||
- name: delete mapped drive without path check
|
||||
win_mapped_drive:
|
||||
letter: '{{test_win_mapped_drive_letter}}'
|
||||
state: absent
|
||||
register: delete_without_path_check
|
||||
check_mode: yes
|
||||
|
||||
- name: get actual delete mapped drive without path check
|
||||
win_command: 'net use {{test_win_mapped_drive_letter}}:'
|
||||
register: delete_without_path_actual_check
|
||||
|
||||
- name: assert delete mapped drive without path check
|
||||
assert:
|
||||
that:
|
||||
- delete_without_path_check|changed
|
||||
- delete_without_path_actual_check.rc == 0
|
||||
|
||||
- name: delete mapped drive without path
|
||||
win_mapped_drive:
|
||||
letter: '{{test_win_mapped_drive_letter}}'
|
||||
state: absent
|
||||
register: delete_without_path
|
||||
|
||||
- name: get actual delete mapped drive without path
|
||||
win_command: 'net use {{test_win_mapped_drive_letter}}:'
|
||||
register: delete_without_path_actual
|
||||
failed_when: False
|
||||
|
||||
- name: assert delete mapped drive without path check
|
||||
assert:
|
||||
that:
|
||||
- delete_without_path|changed
|
||||
- delete_without_path_actual.rc == 2
|
||||
|
||||
- name: delete mapped drive without path again
|
||||
win_mapped_drive:
|
||||
letter: '{{test_win_mapped_drive_letter}}'
|
||||
state: absent
|
||||
register: delete_without_path_again
|
||||
|
||||
- name: assert delete mapped drive without path check again
|
||||
assert:
|
||||
that:
|
||||
- not delete_without_path_again|changed
|
Loading…
Add table
Add a link
Reference in a new issue