win_tempfile - return absolute path on created temp file (#53827)

* win_tempfile - return absolute path on created temp file

* Fix tests for CI

changelogs/fragments/win_tempfile-path.yaml

@@ -0,0 +1,2 @@
+bugfixes:
+- win_tempfile - Always return the full NTFS absolute path and not a DOS 8.3 path.

lib/ansible/modules/windows/win_tempfile.ps1

@@ -16,7 +16,14 @@ Function New-TempFile {
         $randomname = [System.IO.Path]::GetRandomFileName()
         $temppath = (Join-Path -Path $path -ChildPath "$prefix$randomname$suffix")
         Try {
-            New-Item -Path $temppath -ItemType $type -WhatIf:$checkmode | Out-Null
+            $file = New-Item -Path $temppath -ItemType $type -WhatIf:$checkmode
+            # Makes sure we get the full absolute path of the created temp file and not a relative or DOS 8.3 dir
+            if (-not $checkmode) {
+                $temppath = $file.FullName
+            } else {
+                # Just rely on GetFulLpath for check mode
+                $temppath = [System.IO.Path]::GetFullPath($temppath)
+            }
         } Catch {
             $temppath = $null
             $error = $_

lib/ansible/modules/windows/win_tempfile.py

@@ -60,7 +60,7 @@ EXAMPLES = r"""
 
 RETURN = r'''
 path:
-  description: Path to created file or directory.
+  description: The absolute path to the created file or directory.
   returned: success
   type: str
   sample: C:\Users\Administrator\AppData\Local\Temp\ansible.bMlvdk

test/integration/targets/win_tempfile/defaults/main.yml

@@ -1 +1 @@
-test_tempfile_path: C:\ansible\win_tempfile
+test_tempfile_path: 'C:\ansible\win_tempfile .ÅÑŚÌβŁÈ [$!@^&test(;)]'

test/integration/targets/win_tempfile/tasks/main.yml

@@ -1,12 +1,16 @@
 ---
-- name: get expanded %TEMP% value
+- name: get the current %TEMP% value
-  win_command: powershell.exe "$env:TEMP"
+  win_shell: '[System.IO.Path]::GetFullPath($env:TEMP)'
-  register: raw_temp_value
+  register: temp_value
 
-# match filter doesn't work with \, replace it with /
+- name: register temp path value
-- name: replace backslash with frontslash for easier testing
   set_fact:
-    temp_value: "{{raw_temp_value.stdout_lines[0] | regex_replace('\\\\', '/')}}"
+    temp_value: '{{ temp_value.stdout | trim }}'
+
+
+- name: get raw %TEMP% value
+  win_shell: '$env:TEMP'
+  register: raw_temp_value
 
 - name: create temp file defaults check
   win_tempfile:
@@ -23,7 +27,7 @@
     that:
     - create_tmp_file_defaults_check is changed
     - create_tmp_file_defaults_check.state == 'file'
-    - create_tmp_file_defaults_check.path | regex_replace('\\\\', '/')  is match(temp_value + '/ansible.*')
+    - create_tmp_file_defaults_check.path.startswith(temp_value + '\\ansible.')
     - actual_create_tmp_file_defaults_check.stat.exists == False
 
 - name: create temp file defaults
@@ -40,7 +44,7 @@
     that:
     - create_tmp_file_defaults is changed
     - create_tmp_file_defaults.state == 'file'
-    - create_tmp_file_defaults.path | regex_replace('\\\\', '/')  is match(temp_value + '/ansible.*')
+    - create_tmp_file_defaults.path.startswith(temp_value + '\\ansible.')
     - actual_create_tmp_file_defaults.stat.exists == True
     - actual_create_tmp_file_defaults.stat.isdir == False
 
@@ -58,7 +62,7 @@
     that:
     - create_tmp_file_defaults_again is changed
     - create_tmp_file_defaults_again.state == 'file'
-    - create_tmp_file_defaults_again.path | regex_replace('\\\\', '/')  is match(temp_value + '/ansible.*')
+    - create_tmp_file_defaults_again.path.startswith(temp_value + '\\ansible.')
     - create_tmp_file_defaults_again.path != create_tmp_file_defaults.path
     - actual_create_tmp_file_defaults_again.stat.exists == True
     - actual_create_tmp_file_defaults_again.stat.isdir == False
@@ -79,7 +83,7 @@
     that:
     - create_tmp_folder_check is changed
     - create_tmp_folder_check.state == 'directory'
-    - create_tmp_folder_check.path | regex_replace('\\\\', '/')  is match(temp_value + '/ansible.*')
+    - create_tmp_folder_check.path.startswith(temp_value  + '\\ansible.')
     - actual_create_tmp_folder_check.stat.exists == False
 
 - name: create temp folder
@@ -97,7 +101,7 @@
     that:
     - create_tmp_folder is changed
     - create_tmp_folder.state == 'directory'
-    - create_tmp_folder.path | regex_replace('\\\\', '/')  is match(temp_value + '/ansible.*')
+    - create_tmp_folder.path.startswith(temp_value + '\\ansible.')
     - actual_create_tmp_folder.stat.exists == True
     - actual_create_tmp_folder.stat.isdir == True
 
@@ -116,7 +120,8 @@
     that:
     - create_tmp_file_suffix is changed
     - create_tmp_file_suffix.state == 'file'
-    - create_tmp_file_suffix.path | regex_replace('\\\\', '/')  is match(temp_value + '/ansible.*.test-suffix')
+    - create_tmp_file_suffix.path.startswith(temp_value + '\\ansible.')
+    - create_tmp_file_suffix.path.endswith('test-suffix')
     - actual_creat_tmp_file_suffix.stat.exists == True
     - actual_creat_tmp_file_suffix.stat.isdir == False
 
@@ -135,39 +140,92 @@
     that:
     - create_tmp_file_prefix is changed
     - create_tmp_file_prefix.state == 'file'
-    - create_tmp_file_prefix.path | regex_replace('\\\\', '/')  is match(temp_value + '/test-prefix.*')
+    - create_tmp_file_prefix.path.startswith(temp_value + '\\test-prefix')
     - actual_creat_tmp_file_prefix.stat.exists == True
     - actual_creat_tmp_file_prefix.stat.isdir == False
 
 - name: create new temp file folder
   win_file:
-    path: "{{test_tempfile_path}}"
+    path: '{{test_tempfile_path}}\testing folder'
     state: directory
 
-- name: create temp file with different path
+- block:
-  win_tempfile:
+  - name: create temp file with different path
-    path: "{{test_tempfile_path}}"
+    win_tempfile:
-  register: create_tmp_file_difference_path
+      path: '{{test_tempfile_path}}\testing folder'
+    register: create_tmp_file_difference_path
 
-- name: get stat of temp file with different path
+  - name: get stat of temp file with different path
-  win_stat:
+    win_stat:
-    path: "{{create_tmp_file_difference_path.path}}"
+      path: "{{create_tmp_file_difference_path.path}}"
-  register: actual_creat_tmp_file_different_path
+    register: actual_creat_tmp_file_different_path
 
-- name: convert new temp path to regex format
+  - name: assert create temp file with different path
-  set_fact:
+    assert:
-    test_tempfile_path_regex: "{{test_tempfile_path | regex_replace('\\\\', '/')}}"
+      that:
+      - create_tmp_file_difference_path is changed
+      - create_tmp_file_difference_path.state == 'file'
+      - create_tmp_file_difference_path.path.startswith(test_tempfile_path + '\\testing folder\\ansible.')
+      - actual_creat_tmp_file_different_path.stat.exists == True
+      - actual_creat_tmp_file_different_path.stat.isdir == False
 
-- name: assert create temp file with different path
+  - name: create temp file with DOS 8.3 short name
-  assert:
+    win_tempfile:
-    that:
+      path: '{{ test_tempfile_path }}\TESTIN~1'
-    - create_tmp_file_difference_path is changed
+    register: create_tmp_file_dos_path
-    - create_tmp_file_difference_path.state == 'file'
-    - create_tmp_file_difference_path.path | regex_replace('\\\\', '/')  is match(test_tempfile_path_regex + '/ansible.*')
-    - actual_creat_tmp_file_different_path.stat.exists == True
-    - actual_creat_tmp_file_different_path.stat.isdir == False
 
-- name: delete temp file folder
+  - name: get stat of temp file with different path
+    win_stat:
+      path: '{{ create_tmp_file_dos_path.path }}'
+    register: actual_create_tmp_file_dos_path
+
+  - name: assert create temp file with different path
+    assert:
+      that:
+      - create_tmp_file_dos_path is changed
+      - create_tmp_file_dos_path.state == 'file'
+      - create_tmp_file_dos_path.path.startswith(test_tempfile_path + '\\testing folder\\ansible.')
+      - actual_create_tmp_file_dos_path.stat.exists == True
+      - actual_create_tmp_file_dos_path.stat.isdir == False
+
+  always:
+  - name: delete temp file folder
+    win_file:
+      path: "{{test_tempfile_path}}"
+      state: absent
+
+- name: get current working directory
+  win_shell: $pwd.Path
+  register: current_dir
+
+- name: create directory for relative dir tests
   win_file:
-    path: "{{test_tempfile_path}}"
+    path: '{{ current_dir.stdout | trim }}\win_tempfile'
-    state: absent
+    state: directory
+
+- block:
+  - name: create temp folder with relative path
+    win_tempfile:
+      path: win_tempfile
+      state: directory
+    register: create_relative
+
+  - name: get stat of temp folder with relative path
+    win_stat:
+      path: '{{ create_relative.path }}'
+    register: actual_create_relative
+
+  - name: assert create temp folder with relative path
+    assert:
+      that:
+      - create_relative is changed
+      - create_relative.state == 'directory'
+      - create_relative.path.startswith((current_dir.stdout | trim) + '\\win_tempfile\\ansible.')
+      - actual_create_relative.stat.exists == True
+      - actual_create_relative.stat.isdir == True
+
+  always:
+  - name: remove relative directory tests
+    win_file:
+      path: '{{ current_dir.stdout | trim }}\win_tempfile'
+      state: absent