test: support an external proxy

This PR allows to specify an external global proxy for testing purposes.
The format of `SR_RHC_EXTERNAL_PROXY` is scheme://hostname.port e.g.
`http://my.hostname.com:3128`

Signed-off-by: Rich Megginson <rmeggins@redhat.com>

Author: richm

tests/tasks/check_candlepin.yml

@@ -5,3 +5,5 @@
     url: "https://{{ lsr_rhc_test_data.candlepin_host }}:{{ lsr_rhc_test_data.candlepin_port }}{{ lsr_rhc_test_data.candlepin_prefix }}"  # yamllint disable-line
     method: HEAD
     validate_certs: false
+  environment: "{{ {'http_proxy': __rhc_external_proxy_url, 'https_proxy': __rhc_external_proxy_url}
+    if __rhc_external_proxy_url | length > 0 else {} }}"

tests/tasks/setup_test_data.yml

@@ -37,3 +37,36 @@
     - name: Set flag to indicate system is ostree
       set_fact:
         __rhc_is_ostree: "{{ __ostree_booted_stat.stat.exists }}"
+
+- name: Set flag to indicate use of external proxy
+  set_fact:
+    __rhc_use_external_proxy: "{{ lookup('env', 'SR_RHC_EXTERNAL_PROXY') | length > 0 }}"
+    __rhc_external_proxy_url: "{{ lookup('env', 'SR_RHC_EXTERNAL_PROXY') }}"
+
+- name: Set rhc_external_proxy to empty when external proxy is not used
+  set_fact:
+    rhc_external_proxy: {}
+  when: not __rhc_use_external_proxy
+
+- name: Handle external proxy
+  when: __rhc_use_external_proxy
+  block:
+    - name: Parse and set rhc_external_proxy
+      set_fact:
+        rhc_external_proxy:
+          scheme: "{{ __rhc_external_proxy_url | urlsplit('scheme') }}"
+          hostname: "{{ __rhc_external_proxy_url | urlsplit('hostname') }}"
+          port: "{{ (__rhc_external_proxy_url | urlsplit('port')) | default('') | string }}"
+
+    # unfortunately this doesn't work in all cases, so we have to add the environment
+    # explicitly to the check_candlepin.yml task as well
+    - name: Add proxy vars to bashrc
+      lineinfile:
+        path: /root/.bashrc
+        regexp: "^export https?="
+        line: "{{ item }}"
+        create: true
+        mode: "0644"
+      loop:
+        - export http_proxy={{ __rhc_external_proxy_url }}
+        - export https_proxy={{ __rhc_external_proxy_url }}

tests/tests_environments.yml

@@ -51,6 +51,7 @@
                 rhc_baseurl: "{{ lsr_rhc_test_data.baseurl | d(omit) }}"
                 rhc_environments:
                   - "{{ lsr_rhc_test_data.env_nonworking }}"
+                rhc_proxy: "{{ rhc_external_proxy | default({}) }}"
 
             - name: Unreachable task
               fail:
@@ -80,6 +81,7 @@
                   insecure: "{{ lsr_rhc_test_data.candlepin_insecure }}"
                 rhc_baseurl: "{{ lsr_rhc_test_data.baseurl | d(omit) }}"
                 rhc_environments: "{{ lsr_rhc_test_data.envs_register }}"
+                rhc_proxy: "{{ rhc_external_proxy | default({}) }}"
 
             # 'subscription-manager environments' has a '--list' option only
             # in RHEL 8.6+ and greater (incl. RHEL 9+)

tests/tests_insights_ansible_host.yml

@@ -31,6 +31,7 @@
               prefix: "{{ lsr_rhc_test_data.candlepin_prefix }}"
               insecure: "{{ lsr_rhc_test_data.candlepin_insecure }}"
             rhc_baseurl: "{{ lsr_rhc_test_data.baseurl | d(omit) }}"
+            rhc_proxy: "{{ rhc_external_proxy | default({}) }}"
 
         - name: Check ansible_host is set to 'host' in config file
           command:
@@ -89,7 +90,7 @@
                 state: absent
               check_mode: true
               register: __test_ansible_host_absent
-              failed_when: __test_ansible_host_absent.found
+              failed_when: __test_ansible_host_absent.found != 0
 
         - name: Test ansible_host is removed during insights unregistration
           block:
@@ -117,7 +118,7 @@
                 state: absent
               check_mode: true
               register: __test_ansible_host_removed
-              failed_when: __test_ansible_host_removed.found
+              failed_when: __test_ansible_host_removed.found != 0
 
       always:
         - name: Unregister

tests/tests_insights_autoupdate.yml

@@ -31,6 +31,7 @@
               prefix: "{{ lsr_rhc_test_data.candlepin_prefix }}"
               insecure: "{{ lsr_rhc_test_data.candlepin_insecure }}"
             rhc_baseurl: "{{ lsr_rhc_test_data.baseurl | d(omit) }}"
+            rhc_proxy: "{{ rhc_external_proxy | default({}) }}"
 
         - name: Check that auto_update is true in config file
           command:

tests/tests_insights_client_register.yml

@@ -28,6 +28,7 @@
               prefix: "{{ lsr_rhc_test_data.candlepin_prefix }}"
               insecure: "{{ lsr_rhc_test_data.candlepin_insecure }}"
             rhc_baseurl: "{{ lsr_rhc_test_data.baseurl | d(omit) }}"
+            rhc_proxy: "{{ rhc_external_proxy | default({}) }}"
 
         - name: Register insights (noop)
           include_role:
@@ -47,6 +48,7 @@
               prefix: "{{ lsr_rhc_test_data.candlepin_prefix }}"
               insecure: "{{ lsr_rhc_test_data.candlepin_insecure }}"
             rhc_baseurl: "{{ lsr_rhc_test_data.baseurl | d(omit) }}"
+            rhc_proxy: "{{ rhc_external_proxy | default({}) }}"
 
         - name: Get insights UUID
           include_tasks: tasks/get_insights_uuid.yml
@@ -73,6 +75,7 @@
               insecure: "{{ lsr_rhc_test_data.candlepin_insecure }}"
             rhc_state: reconnect
             rhc_baseurl: "{{ lsr_rhc_test_data.baseurl | d(omit) }}"
+            rhc_proxy: "{{ rhc_external_proxy | default({}) }}"
 
         - name: Get rhsm UUID
           include_tasks: tasks/get_rhsm_uuid.yml

tests/tests_insights_display_name.yml

@@ -31,6 +31,7 @@
               prefix: "{{ lsr_rhc_test_data.candlepin_prefix }}"
               insecure: "{{ lsr_rhc_test_data.candlepin_insecure }}"
             rhc_baseurl: "{{ lsr_rhc_test_data.baseurl | d(omit) }}"
+            rhc_proxy: "{{ rhc_external_proxy | default({}) }}"
 
         - name: Check display_name is set to 'name' in config file
           command:
@@ -99,7 +100,7 @@
                 state: absent
               check_mode: true
               register: __test_display_name_removed
-              failed_when: __test_display_name_removed.found
+              failed_when: __test_display_name_removed.found != 0
 
       always:
         - name: Unregister

tests/tests_insights_remediation.yml

@@ -41,6 +41,7 @@
               prefix: "{{ lsr_rhc_test_data.candlepin_prefix }}"
               insecure: "{{ lsr_rhc_test_data.candlepin_insecure }}"
             rhc_baseurl: "{{ lsr_rhc_test_data.baseurl | d(omit) }}"
+            rhc_proxy: "{{ rhc_external_proxy | default({}) }}"
 
         - name: Set the fact for the systemd service
           set_fact:

tests/tests_insights_tags.yml

@@ -32,6 +32,7 @@
               prefix: "{{ lsr_rhc_test_data.candlepin_prefix }}"
               insecure: "{{ lsr_rhc_test_data.candlepin_insecure }}"
             rhc_baseurl: "{{ lsr_rhc_test_data.baseurl | d(omit) }}"
+            rhc_proxy: "{{ rhc_external_proxy | default({}) }}"
 
         - name: Get state of insights tags.yaml file
           include_tasks: tasks/get_insights_tags.yml

tests/tests_proxy.yml

@@ -331,9 +331,11 @@
           vars:
             rhc_state: absent
 
+        # skip this test if external proxy is used
         - name: Register (without proxy)
           include_role:
             name: linux-system-roles.rhc
+          when: not __rhc_use_external_proxy
           vars:
             rhc_auth:
               login: