[ansible] Upgrade version tested for Windows (#6288)

* [chore][ansible] Upgrade version tested for Windows

* fix ansible lint

* touch log file

* change log_path to be a host path (rather than windows)

* debug: upload msi install logs to github artifact ouput

* Don't stop ansible deploy on failure, collector log file

* change path used for win install log file

* use absolute path without substitutes

* use unique name for log files from windows ansible msi install

* fail job if molecule test fails, but still upload logs

* Change to show step failure, but still execute uploading of logs

* Always fetch logs as github workflow determines whether to upload them

* Only upload log files if molecule tests failed

* Upload logs even if successful molecule test

* ignoring errors, upload all matching files, not directory

* attempt to add timeout to msi install

* save async results file, give github artifacts unique names

* fix upload naming to include ansible version, add more log debugging

* add win registry variable output

* use regex replace for surrounding MSI arg values with spaces

* all tests failed with escaped double-quotes, test un-escaped

* no escaping failed lint, try two backslashes for escaping

* separate out regex and replacement strings into vars

* double escape didn't work, the group specifiers were broken. attempt no escaping again

* only use one backslash for group replacement regex

* Existing code was working for parsing, but still failing msi install. Try leading space

* Move back to no leading space, extend timeout

* use backticks around double quotes

* Join msi argument list into space separated string, remove whoami output

* properly get variable value for join

* add debugging to check env vars set on windows ansible

* debugging: attempt to only do regex when arg contains spaces

* split when into list of and conditions

* make two lists of args, differentiated by spaces. Only add quotes to space args

* remove backticks in regex replace, remove async behavior

* splunk_config_override and splunk_otel_collector_config_* arguments are still valid

* use set additional vars in msi package install args

* Only add additional env vars when they're defined

* Fix variable reference to correct one

* Set win reg keys for custom variables

* remove empty lines at beginning of file

* debug: get existing contents of windows registry

* append existing win reg with custom vars

* fix linting of line too long

* add proper when qualifiers to otel_win_reg

* Make win reg entry unique for the sake of idempotence, use not-deprecated config in test

* Remove debugging and fix typos and formatting

* test if MSI arguments must be space separated string, or if array works

* Fix when check to resolve error saying variable doesn't have properties

* Join msi arguments is required for values with spaces

* add changelog for ansible fixing bugs

* Update deployments/ansible/CHANGELOG.md

Co-authored-by: Paulo Janotti <[email protected]>

* Update deployments/ansible/CHANGELOG.md

Co-authored-by: Paulo Janotti <[email protected]>

---------

Co-authored-by: Paulo Janotti <[email protected]>

Author: crobert-1

deployments/ansible/CHANGELOG.md

@@ -8,6 +8,11 @@
   configure the command line arguments for the Splunk OpenTelemetry Collector
   service.
 
+### 🧰 Bug fixes 🧰
+
+- Fix bug causing Windows deployment failure when specified variables had spaces in their values (relevant when `splunk_otel_collector_version` >= `0.98.0`). ([#6288](https://github.com/signalfx/splunk-otel-collector/pull/6288))
+- Fix bug causing custom variables to not be set on Windows deployment (relevant when `splunk_otel_collector_version` >= `0.98.0`). ([#6288](https://github.com/signalfx/splunk-otel-collector/pull/6288))
+
 ## ansible-v0.31.0
 
 ### 🛑 Breaking changes 🛑

deployments/ansible/molecule/custom_vars/windows-converge.yml

@@ -8,9 +8,9 @@
     splunk_api_url: https://fake-splunk-api.com
     splunk_hec_url: https://fake-splunk-hec.com
     splunk_hec_token: fake-hec-token
-    splunk_otel_collector_version: 0.48.0
+    splunk_otel_collector_version: 0.126.0
     splunk_otel_collector_config: '{{ansible_env.ProgramData}}\Splunk\OpenTelemetry Collector\custom_config.yml'
-    splunk_otel_collector_config_source: ./custom_collector_config_deprecated.yml
+    splunk_otel_collector_config_source: ./custom_collector_config.yml
     splunk_memory_total_mib: 256
     gomemlimit: 230
     install_fluentd: yes

deployments/ansible/molecule/custom_vars/windows-verify.yml

@@ -45,20 +45,20 @@
       assert:
         that: not service_status.changed
 
-    - name: Download splunk-otel-collector 0.48.0 MSI
+    - name: Download splunk-otel-collector 0.126.0 MSI
       ansible.windows.win_get_url:
-        url: https://dl.signalfx.com/splunk-otel-collector/msi/release/splunk-otel-collector-0.48.0-amd64.msi
+        url: https://dl.signalfx.com/splunk-otel-collector/msi/release/splunk-otel-collector-0.126.0-amd64.msi
         dest: "{{ansible_env.TEMP}}"
       register: otel_msi_package
 
-    - name: Install splunk-otel-collector 0.48.0 MSI
+    - name: Install splunk-otel-collector 0.126.0 MSI
       ansible.windows.win_package:
         path: "{{otel_msi_package.dest}}"
         state: present
       check_mode: yes
       register: msi_installed
 
-    - name: Assert splunk-otel-collector 0.48.0 MSI is already installed
+    - name: Assert splunk-otel-collector 0.126.0 MSI is already installed
       assert:
         that: not msi_installed.changed
 

deployments/ansible/roles/collector/tasks/otel_win_install.yml

@@ -61,10 +61,41 @@
   set_fact:
     msi_arguments: "{{ msi_unfiltered_arguments | reject('eq', '') | list }}"
 
+- set_fact:
+    args_without_spaces: []
+    args_with_spaces: []
+
+- name: Surround msi argument values with quotes to properly handle spaces in values
+  when:
+    - splunk_collector_msi_is_configurable is defined
+    - item is search(' ')
+  set_fact:
+    args_with_spaces: "{{ args_with_spaces + [item | ansible.builtin.regex_replace(_regex, _replacement)] }}"
+  vars:
+    _regex: '^(.*)=(.*)$'
+    _replacement: '\1="\2"'
+  loop: "{{ msi_arguments }}"
+
+- name: compile args without spaces
+  set_fact:
+    args_without_spaces: "{{ args_without_spaces + [item] }}"
+  loop: "{{ msi_arguments }}"
+  when:
+    - splunk_collector_msi_is_configurable is defined
+    - item is not search(' ')
+
+- set_fact:
+    msi_arguments: "{{ args_with_spaces + args_without_spaces }}"
+
+- name: Join msi argument list into space separated string
+  when: splunk_collector_msi_is_configurable is defined
+  set_fact:
+    msi_arguments: "{{ msi_arguments | join(' ') }}"
+
 - name: Install splunk-otel-collector-msi
   when: splunk_collector_msi_is_configurable is defined
   ansible.windows.win_package:
-    path: "{{otel_msi_package.dest}}"
+    path: "{{ otel_msi_package.dest }}"
     state: present
     arguments: "{{ msi_arguments }}"
 
@@ -76,22 +107,16 @@
 
 - name: Merge custom config into the default config
   ansible.builtin.import_tasks: config_override.yml
-  when:
-    - splunk_collector_msi_is_configurable is undefined
-    - splunk_config_override != ''
+  when: splunk_config_override != ''
 
 - name: Copy the custom config
   ansible.windows.win_copy:
     content: '{{ updated_config | to_nice_yaml (indent=2) }}'
     dest: "{{ splunk_otel_collector_config }}"
-  when:
-    - splunk_collector_msi_is_configurable is undefined
-    - splunk_config_override != ''
+  when: splunk_config_override != ''
 
 - name: Push Custom Config file for splunk-otel-collector, If provided
   ansible.windows.win_template:
     src: "{{splunk_otel_collector_config_source}}"
     dest: "{{splunk_otel_collector_config}}"
-  when:
-    - splunk_collector_msi_is_configurable is undefined
-    - splunk_otel_collector_config_source != ""
+  when: splunk_otel_collector_config_source != ""

deployments/ansible/roles/collector/tasks/otel_win_reg.yml

@@ -1,17 +1,45 @@
 ---
-- name: Get Splunk OpenTelemetry Collector options list
+- name: Get Splunk OpenTelemetry Collector options list (including default options)
+  when: splunk_collector_msi_is_configurable is not defined
   set_fact:
     splunk_otel_collector_options_list: |-
       {%- set value = item.value -%}
       {{ (splunk_otel_collector_options_list | default([])) + [item.key + '=' + (value | string)] }}
   loop: >
     {{ splunk_otel_collector_options | default({}) | combine(splunk_otel_collector_additional_env_vars) | dict2items }}
 
+- name: Get Splunk OpenTelemetry Collector options list (only custom config variables)
+  when: splunk_collector_msi_is_configurable is defined
+  set_fact:
+    splunk_otel_collector_options_list: |-
+      {%- set value = item.value -%}
+      {{ (splunk_otel_collector_options_list | default([])) + [item.key + '=' + (value | string)] }}
+  loop: >
+    {{ splunk_otel_collector_additional_env_vars | dict2items }}
+
+- name: Get existing registry contents
+  when:
+    - splunk_collector_msi_is_configurable is defined
+    - splunk_otel_collector_options_list is defined
+  ansible.windows.win_reg_stat:
+    path: "{{ splunk_otel_collector_service_registry_key }}"
+  register: registry_contents
+
+- name: Append custom variables to existing registry contents
+  when:
+    - splunk_collector_msi_is_configurable is defined
+    - splunk_otel_collector_options_list is defined
+  set_fact:
+    splunk_otel_collector_options_list:
+      "{{ registry_contents.properties.Environment.value + splunk_otel_collector_options_list }}"
+
 - name: Set Splunk OpenTelemetry Collector registry value
+  when:
+    - splunk_otel_collector_options_list is defined
   ansible.windows.win_regedit:
     path: "{{ splunk_otel_collector_service_registry_key }}"
     state: present
     name: Environment
-    data: "{{ splunk_otel_collector_options_list | sort }}"
+    data: "{{ splunk_otel_collector_options_list | sort | unique }}"
     type: multistring
   notify: "restart windows splunk-otel-collector"

deployments/ansible/roles/collector/tasks/win_install.yml

@@ -1,11 +1,9 @@
 ---
-
 - name: Install Splunk OpenTelemetry Collector with msi package manager
   ansible.builtin.import_tasks: otel_win_install.yml
 
 - name: Set Windows Registry values
   ansible.builtin.import_tasks: otel_win_reg.yml
-  when: splunk_collector_msi_is_configurable is undefined
 
 - name: Install Fluentd with msi package manager
   ansible.builtin.import_tasks: win_fluentd_install.yml