BMBB-666: Add Set-EnvironmentState/set_environmentstate wrapper functions

Add PowerShell and Bash wrapper functions that emit the new
set-environmentstate service message (key/value/sensitive/type),
mirroring the existing Set-OctopusVariable/set_octopusvariable
conventions. Type is fixed to "State" for this function.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

Author: geofflamrock

source/Calamari.Common/Features/Scripting/Bash/Bootstrap.sh

@@ -113,6 +113,37 @@ function set_octopusvariable
   echo $MESSAGE
 }
 
+#	---------------------------------------------------------------------------
+# Function for setting environment state
+#   Accepts 3 arguments:
+#     string: value of the key of the environment state
+#     string: value of the value of the environment state
+#     string: optional '-sensitive' to make the value sensitive
+#	---------------------------------------------------------------------------
+function set_environmentstate
+{
+  MESSAGE="##octopus[set-environmentstate"
+
+  if [ -n "$1" ]
+  then
+    MESSAGE="$MESSAGE key='$(encode_servicemessagevalue "$1")'"
+  fi
+
+  if [ -n "$2" ]
+  then
+    MESSAGE="$MESSAGE value='$(encode_servicemessagevalue "$2")'"
+  fi
+
+  if [ ! -z "${3:-}" ] && [ "$3" = "-sensitive" ]
+  then
+    MESSAGE="$MESSAGE sensitive='$(encode_servicemessagevalue "True")'"
+  fi
+
+  MESSAGE="$MESSAGE type='$(encode_servicemessagevalue "State")']"
+
+  echo $MESSAGE
+}
+
 # -----------------------------------------------------------------------------
 # Function to create a new octopus artifact
 #	Accepts 2 arguments:

source/Calamari.Common/Features/Scripting/WindowsPowerShell/Bootstrap.ps1

@@ -165,6 +165,23 @@ function Set-OctopusVariable([string]$name, [string]$value, [switch]$sensitive)
     }
 }
 
+function Set-EnvironmentState([string]$key, [string]$value, [switch]$sensitive)
+{
+    $key = Convert-ServiceMessageValue($key)
+    $value = Convert-ServiceMessageValue($value)
+    $type = Convert-ServiceMessageValue("State")
+    $trueEncoded = Convert-ServiceMessageValue("True")
+
+    If ($sensitive)
+    {
+        Write-Host "##octopus[set-environmentstate key='$( $key )' value='$( $value )' sensitive='$( $trueEncoded )' type='$( $type )']"
+    }
+    Else
+    {
+        Write-Host "##octopus[set-environmentstate key='$( $key )' value='$( $value )' type='$( $type )']"
+    }
+}
+
 function Convert-ToServiceMessageParameter([string]$name, [string]$value)
 {
     $value = Convert-ServiceMessageValue($value)

source/Calamari.Testing/LogParser/ScriptServiceMessageNames.cs

@@ -12,6 +12,15 @@ public static class SetVariable
             public const string SensitiveAttribute = "sensitive";
         }
 
+        public static class EnvironmentState
+        {
+            public const string Name = "set-environmentstate";
+            public const string KeyAttribute = "key";
+            public const string ValueAttribute = "value";
+            public const string SensitiveAttribute = "sensitive";
+            public const string TypeAttribute = "type";
+        }
+
         public static class StdOutBehaviour
         {
             public const string Ignore = "stdout-ignore";

source/Calamari.Tests/Fixtures/Bash/BashFixture.cs

@@ -46,6 +46,34 @@ public void ShouldPrintSensitiveVariable(FeatureToggle? featureToggle)
                             });
         }
 
+        [TestCase(FeatureToggle.BashParametersArrayFeatureToggle)]
+        [TestCase(null)]
+        [RequiresBashDotExeIfOnWindows]
+        public void ShouldSetEnvironmentState(FeatureToggle? featureToggle)
+        {
+            var (output, _) = RunScript("set-environment-state.sh", new Dictionary<string, string>().AddFeatureToggleToDictionary(new List<FeatureToggle?>{featureToggle}));
+
+            Assert.Multiple(() =>
+                            {
+                                output.AssertSuccess();
+                                output.AssertOutput("##octopus[set-environmentstate key='TXlLZXk=' value='TXlWYWx1ZQ==' type='U3RhdGU=']");
+                            });
+        }
+
+        [TestCase(FeatureToggle.BashParametersArrayFeatureToggle)]
+        [TestCase(null)]
+        [RequiresBashDotExeIfOnWindows]
+        public void ShouldSetSensitiveEnvironmentState(FeatureToggle? featureToggle)
+        {
+            var (output, _) = RunScript("set-sensitive-environment-state.sh", new Dictionary<string, string>().AddFeatureToggleToDictionary(new List<FeatureToggle?>{featureToggle}));
+
+            Assert.Multiple(() =>
+                            {
+                                output.AssertSuccess();
+                                output.AssertOutput("##octopus[set-environmentstate key='U2VjcmV0S2V5' value='U2VjcmV0IFZhbHVl' sensitive='VHJ1ZQ==' type='U3RhdGU=']");
+                            });
+        }
+
         [TestCase(FeatureToggle.BashParametersArrayFeatureToggle)]
         [TestCase(null)]
         [RequiresBashDotExeIfOnWindows]

source/Calamari.Tests/Fixtures/Bash/Scripts/set-environment-state.sh

@@ -0,0 +1,2 @@
+#!/bin/bash
+set_environmentstate "MyKey" "MyValue"

source/Calamari.Tests/Fixtures/Bash/Scripts/set-sensitive-environment-state.sh

@@ -0,0 +1,2 @@
+#!/bin/bash
+set_environmentstate "SecretKey" "Secret Value" -sensitive

source/Calamari.Tests/Fixtures/PowerShell/PowerShellFixtureBase.cs

@@ -383,6 +383,24 @@ public void ShouldSetSensitiveVariables()
             AssertPowerShellEdition(output);
         }
 
+        [Test]
+        public void ShouldWriteServiceMessageForEnvironmentState()
+        {
+            var (output, _) = RunPowerShellScript("CanSetEnvironmentState.ps1");
+            output.AssertSuccess();
+            output.AssertOutput("##octopus[set-environmentstate key='TXlLZXk=' value='TXlWYWx1ZQ==' type='U3RhdGU=']");
+            AssertPowerShellEdition(output);
+        }
+
+        [Test]
+        public void ShouldWriteServiceMessageForSensitiveEnvironmentState()
+        {
+            var (output, _) = RunPowerShellScript("CanSetEnvironmentState.ps1");
+            output.AssertSuccess();
+            output.AssertOutput("##octopus[set-environmentstate key='U2VjcmV0S2V5' value='U2VjcmV0IFZhbHVl' sensitive='VHJ1ZQ==' type='U3RhdGU=']");
+            AssertPowerShellEdition(output);
+        }
+
         [Test]
         public void ShouldSetActionIndexedOutputVariables()
         {

source/Calamari.Tests/Fixtures/PowerShell/Scripts/CanSetEnvironmentState.ps1

@@ -0,0 +1,4 @@
+
+Set-EnvironmentState -Key "MyKey" -Value "MyValue"
+
+Set-EnvironmentState -Key "SecretKey" -Value "Secret Value" -Sensitive