Remove everything relating to old ini-based config (SatelliteQE#8662)

* Remove ini-based config functionality
Refactor config helpers and references

* Remove everything related to old ini-based configs
Remove ini base config, facade, casts
Refactor sections that referenced ini-based configs
Consolidate settings helpers
Refactor virt-who settings
Update settings template files
And many more!

.github/workflows/merge_to_master.yml

@@ -38,9 +38,7 @@ jobs:
           pip install --compile --no-cache-dir pycurl
           pip install -U -r requirements.txt -r requirements-optional.txt
           for conffile in conf/*.yaml.template; do mv -- "$conffile" "${conffile%.yaml.template}.yaml"; done
-          cp robottelo.properties.sample robottelo.properties
           cp broker_settings.yaml.example broker_settings.yaml
-          cp virtwho.properties.sample virtwho.properties
 
       - name: Pre Commit Checks
         uses: pre-commit/[email protected]

.github/workflows/pull_request.yml

@@ -37,9 +37,7 @@ jobs:
           pip install --compile --no-cache-dir pycurl
           pip install -U -r requirements.txt -r requirements-optional.txt
           for conffile in conf/*.yaml.template; do mv -- "$conffile" "${conffile%.yaml.template}.yaml"; done
-          cp robottelo.properties.sample robottelo.properties
           cp broker_settings.yaml.example broker_settings.yaml
-          cp virtwho.properties.sample virtwho.properties
 
       - name: Pre Commit Checks
         uses: pre-commit/[email protected]

.gitignore

@@ -27,11 +27,6 @@ logs/**
 /htmlcov/
 /robottelo_collection.log
 
-# Varies per-deployment.
-/robottelo.properties
-/robottelo.yaml
-/virtwho.properties
-
 # broker local files
 /broker_settings.yaml
 /inventory.yaml
@@ -52,6 +47,9 @@ logs/**
 # For Pycharm
 /.idea
 
+# For VS Code
+/.vscode/
+
 # For backup files.
 *~
 

conf/azure.yaml.template

@@ -1,19 +1,19 @@
 AZURERM:
   # Client ID of the AzureRM account
-  # CLIENT_ID:
+  CLIENT_ID:
   # Client Secret of the AzureRM account
-  # CLIENT_SECRET:
+  CLIENT_SECRET:
   # The subscription ID is a GUID that uniquely identifies your subscription to use Azure services.
-  # SUBSCRIPTION_ID:
+  SUBSCRIPTION_ID:
   # Tenant ID, the ID of the AAD directory in which you created the application
-  # TENANT_ID:
+  TENANT_ID:
   # Azure Region
   AZURE_REGION: East US
   # SSH Public Key of the user from which login as passwordless in VM
-  # SSH_PUB_KEY:
+  SSH_PUB_KEY:
   # Username of admin user(non-root)
-  # USERNAME:
+  USERNAME:
   # Password of the admin user
-  # PASSWORD:
+  PASSWORD:
   # Azure Private subnet details
   AZURE_SUBNET: SATQE-vnet-default 10.0.0.0/24

conf/bugzilla.yaml.template

@@ -2,4 +2,4 @@ BUGZILLA:
   # url default value is set to 'https://bugzilla.redhat.com' even if not provided.
   URL: https://bugzilla.redhat.com
   # Provide api_key to access Bugzilla REST API
-  # API_KEY: replace-with-bugzilla-api-key
+  API_KEY: replace-with-bugzilla-api-key

conf/capsule.yaml.template

@@ -1,10 +1,10 @@
 CAPSULE:
   # Capsule name to be used in the CapsuleVirtualMachine class (will be deprecated)
-  # SATELLITE_VERSION_TAG: "@jinja {{this.robottelo.satellite_version | replace('.', '')}}"
-  # INSTANCE_NAME: "@format qe-sat{this[capsule].satellite_version_tag}-rhel7-tierX-capsule"
+  SATELLITE_VERSION_TAG: "@jinja {{this.robottelo.satellite_version | replace('.', '')}}"
+  INSTANCE_NAME: "@format qe-sat{this[capsule].satellite_version_tag}-rhel7-tierX-capsule"
   VERSION:
     # The full release version (6.9.2)
-    # RELEASE: populate with capsule version
+    RELEASE:  # populate with capsule version
     # The snap version currently testing (if applicable)
     # SNAP:
     # The source of Capsule packages. Can be one of:

conf/certs.yaml.template

@@ -1,6 +1,6 @@
 CERTS:
-  # CERT_FILE: "~/certs/server.crt"
-  # KEY_FILE: "~/certs/server.key"
-  # REQ_FILE: "~/certs/server.csr"
+  CERT_FILE: "~/certs/server.crt"
+  KEY_FILE: "~/certs/server.key"
+  REQ_FILE: "~/certs/server.csr"
   # CA cert (a.k.a cacert.crt or rootCA.pem) can be used as bundle file.
-  # CA_BUNDLE_FILE: "~/certs/rootCA.pem"
+  CA_BUNDLE_FILE: "~/certs/rootCA.pem"

conf/clients.yaml.template

@@ -0,0 +1,5 @@
+CLIENTS:
+  # Provisioning server hostname where the clients will be created
+  PROVISIONING_SERVER:
+  # Path on the provisioning server where the virtual images will be stored, default "/var/lib/libvirt/images/"
+  IMAGE_DIR:

conf/discovery.yaml.template

@@ -1,3 +1,3 @@
 DISCOVERY:
- # SATELLITE_VERSION_SHORT: "@jinja {{this.robottelo.satellite_version | replace('.', '')}}"
- # DISCOVERY_ISO: "discovery_image_sat{this[discovery].satellite_version_short}.iso"
+  SATELLITE_VERSION_SHORT: "@jinja {{this.robottelo.satellite_version | replace('.', '')}}"
+  DISCOVERY_ISO: "discovery_image_sat{this[discovery].satellite_version_short}.iso"

conf/docker.yaml.template

@@ -1,11 +1,11 @@
 DOCKER:
   # External docker registry URL in the format http[s]://<server>[:<port>]
-  # EXTERNAL_REGISTRY_1:
+  EXTERNAL_REGISTRY_1:
   # Private docker registry URL in the format http[s]://<server>[:<port>]
   PRIVATE_REGISTRY_URL: https://registry.hub.docker.com
   # Private docker registry name
-  # PRIVATE_REGISTRY_NAME: username/imagename
+  PRIVATE_REGISTRY_NAME: username/imagename
   # Private docker registry username
-  # PRIVATE_REGISTRY_USERNAME:
+  PRIVATE_REGISTRY_USERNAME:
   # Private docker registry password
-  # PRIVATE_REGISTRY_PASSWORD:
+  PRIVATE_REGISTRY_PASSWORD:

conf/ec2.yaml.template

@@ -1,18 +1,18 @@
 EC2:
   # AWS EC2 to be added as a compute resource.
   # Access key ID of the IAM user
-  # ACCESS_KEY: access_key
+  ACCESS_KEY: access_key
   # Secret access key of the IAM user
-  # SECRET_KEY: secret_key
+  SECRET_KEY: secret_key
   # AWS region for the compute resources
   REGION: us-west-2
   # Compute resource profile image
-  # IMAGE: ami-image
+  IMAGE: ami-image
   # Compute resource profile availability zone
   AVAILABILITY_ZONE: us-west-2a
   # Compute resource profile subnet <IP>/<bitmask>
-  # SUBNET:
+  SUBNET:
   # Compute resource profile security groups list
-  # SECURITY_GROUPS: secgrp
+  SECURITY_GROUPS: secgrp
   # Compute resource profile security managed ip, available values Private, Public
   MANAGED_IP: Private

conf/gce.yaml.template

@@ -1,12 +1,12 @@
 GCE:
   # Google Provider as Compute Resource
   # Project name in Google provider
-  # PROJECT_ID: example-project-id
+  PROJECT_ID:  # example-project-id
   # Service Account email id which has compute admin permission
-  # CLIENT_EMAIL: [email protected]
+  CLIENT_EMAIL: [email protected]
   # client json Certificate path which is local path on satellite
-  # CERT_PATH: /path/to/certificate.json
+  CERT_PATH: /path/to/certificate.json
   # Zones
-  # ZONE: example-zone
+  ZONE: example-zone
   # client certificate URL
-  # CERT_URL: /path/to/certificate/url
+  CERT_URL: /path/to/certificate/url

conf/http_proxy.yaml.template

@@ -1,5 +1,5 @@
 HTTP_PROXY:
-  # UN_AUTH_PROXY_URL: http://proxy-01.example.com:3423
-  # AUTH_PROXY_URL: http://proxy-02.example.com:3423
-  # USERNAME: auth-proxy-user
-  # PASSWORD: auth-proxy-password
+  UN_AUTH_PROXY_URL:  # http://proxy-01.example.com:3423
+  AUTH_PROXY_URL:  # http://proxy-02.example.com:3423
+  USERNAME: auth-proxy-user
+  PASSWORD: auth-proxy-password

conf/ipa.yaml.template

@@ -1,13 +1,13 @@
 # For LDAP freeIPA Authentication.
 IPA:
-  # HOSTNAME_IPA: replace with hostname
-  # USERNAME_IPA: replace with username
-  # PASSWORD_IPA: update the password
-  # BASEDN_IPA: replace with basedn
-  # GROUPBASEDN_IPA: replace with group basedn
-  USER_IPA: foreman
+  HOSTNAME:  # replace with hostname
+  USERNAME:  # replace with username
+  PASSWORD:  # update the password
+  BASEDN:  # replace with basedn
+  GRPBASEDN:  # replace with group basedn
+  USER: foreman
   OTP_USER: otp_user
-  # TIME_BASED_SECRET: update the time based token secret
+  TIME_BASED_SECRET:  # update the time based token secret
   DISABLED_IPA_USER: disabled_user
   GROUP_USERS:
     - satadmin_01

conf/ldap.yaml.template

@@ -1,16 +1,16 @@
 # For Active Directory LDAP Authentication.
 LDAP:
-  # HOSTNAME: replace with AD ldap server name
-      # 2016: <ad server 2016>
-      # 2019: <ad server 2019>
+  HOSTNAME:  # replace with AD ldap server name
+      2016:  # <ad server 2016>
+      2019:  # <ad server 2019>
   USERNAME: foobar
-  # PASSWORD: update with password
-  # BASEDN: update base dn
-  # GRPBASEDN: update with group base dn
-  # REALM: update with realm address
-  # NAMESERVER: update with the ip of the ad ldap server name
-      # 2016: <ip_address of 2016 ad server>
-      # 2019: <ip_address of 2019 ad server>
-  # WORKGROUP: udpate with ldap server's domain name
-      # 2016: <workgroup 2016 server>
-      # 2019: <workgroup 2019 server>
+  PASSWORD:  # update with password
+  BASEDN:  # update base dn
+  GRPBASEDN:  # update with group base dn
+  REALM:  # update with realm address
+  NAMESERVER:  # update with the ip of the ad ldap server name
+      2016:  # <ip_address of 2016 ad server>
+      2019:  # <ip_address of 2019 ad server>
+  WORKGROUP:  # udpate with ldap server's domain name
+      2016:  # <workgroup 2016 server>
+      2019:  # <workgroup 2019 server>

conf/libvirt.yaml.template

@@ -1,6 +1,6 @@
 COMPUTE_RESOURCES:
   # External Libvirt Hostname
-  # LIBVIRT_HOSTNAME: libvirt.example.com
+  LIBVIRT_HOSTNAME:  # libvirt.example.com
   # Path on the Libvirt host, where the virtual images will be stored.
   # The default libvirt image dir will be used i.e., "/var/lib/libvirt/images/".
   LIBVIRT_IMAGE_DIR: /var/lib/libvirt/images

conf/openldap.yaml.template

@@ -1,8 +1,8 @@
 # For Open Ldap Authentication
 OPEN_LDAP:
-  # HOSTNAME: replace with env openldap server
+  HOSTNAME:  # replace with env openldap server
   USERNAME: cn=ldapadmin,dc=example,dc=com
   OPEN_LDAP_USER: foreman
-  # PASSWORD: replace with actual password
+  PASSWORD:  # replace with actual password
   BASE_DN: dc=example,dc=com
   GROUP_BASE_DN: ou=foobargroup,ou=users,dc=example,dc=com

conf/oscap.yaml.template

@@ -1,3 +1,3 @@
 OSCAP:
-  # CONTENT_PATH: /usr/share/xml/scap/ssg/content/ssg-rhel7-ds.xml
-  # TAILORING_PATH: http://server.example.com/pub/ssg-rhel7-ds-tailoring.xml
+  CONTENT_PATH: /usr/share/xml/scap/ssg/content/ssg-rhel7-ds.xml
+  TAILORING_PATH: http://server.example.com/pub/ssg-rhel7-ds-tailoring.xml

conf/report_portal.yaml.template

@@ -1,9 +1,9 @@
 REPORT_PORTAL:
   # URL of the Report portal instance
-  # PORTAL_URL: https://reportportal.example.com
-  # PROJECT: Satellite6
+  PORTAL_URL: https://reportportal.example.com
+  PROJECT: Satellite6
   # API key
-  # API_KEY: rp-user-api-token
+  API_KEY: rp-user-api-token
   # To skip the rerun, if the failed tests in last run more than fail_threshold
   # if its not set, 20% by default will be considered
-  # FAIL_THRESHOLD: 0
+  FAIL_THRESHOLD: 0

conf/rhev.yaml.template

@@ -1,30 +1,30 @@
 RHEV:
   # RHEV to be added as a compute resource.
   # RHEV API URL, e.g. https://ovirt.example.com/ovirt-engine/api
-  # HOSTNAME:
+  HOSTNAME:
   # Login for RHEVM, e.g. admin@internal
-  # USERNAME:
+  USERNAME:
   # Password for RHEVM
-  # PASSWORD:
+  PASSWORD:
   # RHEVM datacenter, e.g. Default
-  # DATACENTER:
+  DATACENTER:
   # Name of VM that should be used
-  # VM_NAME:
+  VM_NAME:
   # VM storage domain name
-  # STORAGE_DOMAIN:
+  STORAGE_DOMAIN:
 
   # RHEV Compute resource image data
   # Operating system of the image
-  # IMAGE_OS:
+  IMAGE_OS:
   # Architecture of the image
-  # IMAGE_ARCH:
+  IMAGE_ARCH:
   # Login to the image
-  # IMAGE_USERNAME: root
+  IMAGE_USERNAME: root
   # Password of that user
-  # IMAGE_PASSWORD:
+  IMAGE_PASSWORD:
   # Image name on the external provider
-  # IMAGE_NAME:
+  IMAGE_NAME:
   # Image UUID
-  # IMAGE_UUID:
+  IMAGE_UUID:
   # RHV CA cert url for adding RHV as compute resource, e.g. http://example.com/pub/rhev-ca.pem
-  # CA_CERT:
+  CA_CERT:

conf/rhsso.yaml.template

@@ -1,13 +1,13 @@
 # section for RH-SSO integration
 RHSSO:
-# RH-SSO Hostname
-  # HOST_NAME: update with rhsso host name
-# RH-SSO Host Url
-  # HOST_URL: update with rhsso environment url
-# RH-SSO Host Admin of Realm
+  # RH-SSO Hostname
+  HOST_NAME:  # update with rhsso host name
+  # RH-SSO Host Url
+  HOST_URL:  # update with rhsso environment url
+  # RH-SSO Host Admin of Realm
   RHSSO_USER: sat_admin
-# RH-SSO Host Admin Password
-  # USER_PASSWORD: update with password
-# RH-SSO Host Realm
+  # RH-SSO Host Admin Password
+  RHSSO_PASSWORD:  # update with password
+  # RH-SSO Host Realm
   REALM: satqe
-  # TOTP_SECRET: update with the totp secret token
+  TOTP_SECRET:  # update with the totp secret token

conf/robottelo.yaml.template

@@ -10,7 +10,7 @@ ROBOTTELO:
   # Directory for temporary files
   TMP_DIR: /var/tmp
   # Web Server to provide various test artifacts
-  # ARTIFACTS_SERVER: replace-with-artifacts-server
+  ARTIFACTS_SERVER: replace-with-artifacts-server
   # Webdriver logging options
   # A list of commands to be logged
   LOG_DRIVER_COMMANDS:
@@ -24,7 +24,7 @@ ROBOTTELO:
   # - The URL of container hosting repos on SatLab
   # Example url - http://<container_hostname_or_ip>:<port>
   # Use https://github.com/SatelliteQE/fedorapeople-repos to deploy and configure the repos hosting container
-  # REPOS_HOSTING_URL: replace-with-repo-hosting-url
+  REPOS_HOSTING_URL: replace-with-repo-hosting-url
   # browser tells robottelo which browser to use when testing UI. Valid values
   # are:
   # * selenium
@@ -38,24 +38,23 @@ ROBOTTELO:
   # Webdriver to use. Valid values are chrome, firefox, ie, edge, phantomjs
   WEBDRIVER: chrome
   # Run browser for UI tests with semicolon delimeted options such as headless. Currently supported for only chrome.
-  # BROWSEROPTIONS: replace-with-browser-options
+  BROWSEROPTIONS: replace-with-browser-options
   # The base DesiredCapabilities dict will be get by the browser
   # specified by webdriver config. If you override browserName then that
   # browser will be used instead.
-  # WEBDRIVER_DESIRED_CAPABILITIES:
-    # PLATFORM:
-    # MAXDURATION:
-    # IDLETIMEOUT:
-    # START-MAXIMISED:
-    # SCREENRESOLUTION:
-    # TAGS:
+  WEBDRIVER_DESIRED_CAPABILITIES:
+    PLATFORM:
+    MAXDURATION:
+    IDLETIMEOUT:
+    START-MAXIMISED:
+    SCREENRESOLUTION:
+    TAGS:
   # Binary location for selected wedriver (not needed if using saucelabs)
-  # WEBDRIVER_BINARY: /usr/bin/firefox
   # webdriver_binary=/usr/bin/chromedriver
   # webdriver_binary=C:\\Program Files (x86)\\Microsoft Web Driver\\MicrosoftWebDriver.exe
   WEBDRIVER_BINARY: /usr/bin/chromedriver
   # Zalenium command_executor
-  # COMMAND_EXECUTOR: http://127.0.0.1:4444/wd/hub
+  COMMAND_EXECUTOR: http://127.0.0.1:4444/wd/hub
   # CDN sync
   CDN: true
   # Run one datapoint or multiple datapoints for tests