Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Choco upgrade should preserve collector service custom env vars #5386

Merged
merged 3 commits into from
Sep 19, 2024
Merged

Choco upgrade should preserve collector service custom env vars #5386

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f81aff5
Add test for preserving env var during collector choco upgrade
pjanotti Sep 19, 2024
a55457c
Preserve custom env vars and ensure no error on MSI call
pjanotti Sep 19, 2024
0d7d6a4
Fix test of env var with spaces in the name
pjanotti Sep 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 11 additions & 4 deletions .github/workflows/win-package-test.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -378,7 +378,12 @@ jobs:
throw "choco install failed!"
}
$env_vars = Get-ItemPropertyValue -Path "HKLM:\SYSTEM\CurrentControlSet\Services\splunk-otel-collector" -Name "Environment"
$env_vars += "MY VAR WITH SPACES=my value"
$test_env_vars = @(
"MY VAR WITH SPACES=my value",
"GOOD_ENV_VAR_NAME=good value",
"GOOD_KEY_NEEDS_ESCAPING=`" that breaks MSI call if not escaped properly due to double-quote"
)
$env_vars += $test_env_vars
Set-ItemProperty -Path "HKLM:\SYSTEM\CurrentControlSet\Services\splunk-otel-collector" -Name "Environment" -Value $env_vars -type MultiString
Start-Sleep 30
write-host "Upgrading $choco_file_name ..."
Expand All @@ -387,9 +392,11 @@ jobs:
throw "choco upgrade failed!"
}
$env_vars = Get-ItemPropertyValue -Path "HKLM:\SYSTEM\CurrentControlSet\Services\splunk-otel-collector" -Name "Environment"
if (!($env_vars -contains "MY VAR WITH SPACES=my value")) {
$env_vars
throw "'MY VAR WITH SPACES=my value' not found!"
foreach ($test_env_var in $test_env_vars) {
if (!($env_vars -contains $test_env_var)) {
$env_vars
throw "'$test_env_var' not found!"
}
}
}
Start-Sleep -s 30
Expand Down
20 changes: 11 additions & 9 deletions internal/buildscripts/packaging/choco/splunk-otel-collector/tools/chocolateyinstall.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ $env_var_names = @(
"SPLUNK_BUNDLE_DIR",
"SPLUNK_LISTEN_INTERFACE"
)
$custom_entries = @()

$upgraded_from_version_with_machine_wide_env_vars = $false

Write-Host "Checking for previous installation..."
Expand Down Expand Up @@ -79,10 +79,10 @@ if (Test-Path $reg_path) {
Write-Host "Found previous environment variables for the $service_name service."
foreach ($entry in $previous_environment) {
$k, $v = $entry.Split("=", 2)
if ($k -Match "^[0-9A-Za-z_]+$") {
$env_vars[$k] = $v
} else {
$custom_entries += $entry
if ($k -and $k -Match "^[0-9A-Za-z_]+$" -and $v) {
# If the name is like a bash variable name, it is safe to pass them to the MSI even if
# they are not in the list of MSI properties. They will be just ignored by the MSI.
$env_vars[$k] = $v.Replace('"', '""') # Escape double quotes for MSI properties.
}
}
}
Expand Down Expand Up @@ -168,10 +168,12 @@ try {
Install-ChocolateyInstallPackage @packageArgs
} finally {
# Add any custom entries back to the reg key
if ($custom_entries) {
$custom_entries += (Get-ItemPropertyValue -Path $reg_path -Name "Environment")
$custom_entries = $custom_entries | Sort-Object -Unique
Set-ItemProperty -Path $reg_path -Name "Environment" -Value $custom_entries -Type MultiString
if ($previous_environment) {
# Preserve any environment variables that were set by the MSI installer, but add any other custom entries.
$svc_env_after_install = Get-ItemPropertyValue -Path $reg_path -Name "Environment"
$merged_environment = merge_multistring_env $svc_env_after_install $previous_environment
$merged_environment = $merged_environment | Sort-Object -Unique
Set-ItemProperty -Path $reg_path -Name "Environment" -Value $merged_environment -Type MultiString
}
}

Expand Down
24 changes: 24 additions & 0 deletions internal/buildscripts/packaging/choco/splunk-otel-collector/tools/common.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,30 @@ function set_env_var_value_from_package_params([hashtable] $env_vars, [hashtable
Write-Host "The $name package parameter was not set, using the default value: '$value'"
}

# merge array of strings, used as environment variables, given priority to the ones defined in the left array
function merge_multistring_env([string[]]$l, [string[]]$r) {
$keys = @{}
[string[]]$merged = @()
foreach ($lentry in $l) {
if (-not $lentry) {
continue
}
$keys[$lentry.Split('=',2)[0]] = $true
$merged += $lentry
}
foreach ($rentry in $r) {
if (-not $rentry) {
continue
}
$key = $rentry.Split('=',2)[0]
if (-not $keys.ContainsKey($key)) {
$merged += $rentry
}
}

return $merged
}

# check that we're not running with a restricted execution policy
function check_policy() {
$executionPolicy = (Get-ExecutionPolicy)
Expand Down
Loading