From 6eb0af96debb620751a679e20db9da341397571a Mon Sep 17 00:00:00 2001
From: Jordan Borean <jborean93@gmail.com>
Date: Tue, 22 May 2018 07:15:34 +1000
Subject: [PATCH] win_environment: Added explicit check for null, empty string
 with state=present (#40468) (#40508)

* win_environment: Added explicit check for null, empty string with state=present

* Added changelog fragment

(cherry picked from commit db195831fda8f644f8e4b3085d19102e7d3586ea)
---
 .../win_environment-do-not-delete-on-null.yaml  |  2 ++
 lib/ansible/modules/windows/win_environment.ps1 |  2 ++
 lib/ansible/modules/windows/win_environment.py  |  1 +
 .../targets/win_environment/tasks/main.yml      | 17 +++++++++++++++++
 4 files changed, 22 insertions(+)
 create mode 100644 changelogs/fragments/win_environment-do-not-delete-on-null.yaml

diff --git a/changelogs/fragments/win_environment-do-not-delete-on-null.yaml b/changelogs/fragments/win_environment-do-not-delete-on-null.yaml
new file mode 100644
index 00000000000..1e590b71f75
--- /dev/null
+++ b/changelogs/fragments/win_environment-do-not-delete-on-null.yaml
@@ -0,0 +1,2 @@
+bugfixes:
+- win_environment - Fix for issue where the environment value was deleted when a null value or empty string was set - https://github.com/ansible/ansible/issues/40450
diff --git a/lib/ansible/modules/windows/win_environment.ps1 b/lib/ansible/modules/windows/win_environment.ps1
index 0eb7374decc..5c2ce2cc1a4 100644
--- a/lib/ansible/modules/windows/win_environment.ps1
+++ b/lib/ansible/modules/windows/win_environment.ps1
@@ -28,6 +28,8 @@ $result = @{
 if ($state -eq "absent" -and $value) {
     Add-Warning -obj $result -message "When removing environment variable '$name' it should not have a value '$value' set"
     $value = $null
+} elseif ($state -eq "present" -and (-not $value)) {
+    Fail-Json -obj $result -message "When state=present, value must be defined and not an empty string, if you wish to remove the envvar, set state=absent"
 }
 
 if ($state -eq "present" -and $before_value -ne $value) {
diff --git a/lib/ansible/modules/windows/win_environment.py b/lib/ansible/modules/windows/win_environment.py
index 59d1616bf1c..060cf69564f 100644
--- a/lib/ansible/modules/windows/win_environment.py
+++ b/lib/ansible/modules/windows/win_environment.py
@@ -30,6 +30,7 @@ options:
   value:
     description:
     - The value to store in the environment variable.
+    - Must be set when C(state=present) and cannot be an empty string.
     - Can be omitted for C(state=absent).
   level:
     description:
diff --git a/test/integration/targets/win_environment/tasks/main.yml b/test/integration/targets/win_environment/tasks/main.yml
index 79931c190c1..c779709948f 100644
--- a/test/integration/targets/win_environment/tasks/main.yml
+++ b/test/integration/targets/win_environment/tasks/main.yml
@@ -9,6 +9,23 @@
   - process
   - user
 
+- name: fail to create environment value with null value
+  win_environment:
+    name: "{{test_environment_name}}"
+    state: present
+    level: machine
+  register: create_fail_null
+  failed_when: create_fail_null.msg != "When state=present, value must be defined and not an empty string, if you wish to remove the envvar, set state=absent"
+
+- name: fail to create environment value with empty value
+  win_environment:
+    name: "{{test_environment_name}}"
+    value: ''
+    state: present
+    level: machine
+  register: create_fail_empty_string
+  failed_when: create_fail_null.msg != "When state=present, value must be defined and not an empty string, if you wish to remove the envvar, set state=absent"
+
 - name: create test environment value for machine check
   win_environment:
     name: "{{test_environment_name}}"