ci: split UI tests for the input page in 3 groups (#393)

* ci: split UI tests for the input page in 3 groups

* test: use add_account fixture in alert_actions UI tests

* test: use proper path

* chore: remove addonfactory_test_matrix_splunk submodule as not needed

Author: artemrys

.github/workflows/build-test-release.yaml

@@ -136,7 +136,9 @@ jobs:
           "test_splunk_ta_example_addon_logging",
           "test_splunk_ta_example_addon_account",
           "test_splunk_ta_example_addon_proxy",
-          "test_splunk_ta_example_addon_input",
+          "test_splunk_ta_example_addon_input_common",
+          "test_splunk_ta_example_addon_input_1",
+          "test_splunk_ta_example_addon_input_2",
           "test_splunk_ta_example_addon_custom",
           "test_splunk_ta_example_addon_alert_actions"
         ]
@@ -208,12 +210,12 @@ jobs:
       - uses: actions/upload-artifact@v3
         if: always()
         with:
-          name: test-results-${{ matrix.splunk }}_${{ matrix.python-version }}_${{ matrix.browser }}_${{ matrix.test_suite }}
+          name: test-results-${{ matrix.splunk.version }}_${{ matrix.python-version }}_${{ matrix.browser }}_${{ matrix.test_suite }}
           path: test-results/*
       - uses: dorny/test-reporter@v1
         if: always()
         with:
-          name: test-report-${{ matrix.splunk }}_${{ matrix.python-version }}_${{ matrix.browser }}_${{ matrix.test_suite }}
+          name: test-report-${{ matrix.splunk.version }}_${{ matrix.python-version }}_${{ matrix.browser }}_${{ matrix.test_suite }}
           path: "test-results/*.xml"
           reporter: java-junit
 

.gitmodules

@@ -1,4 +0,0 @@
-[submodule "tests/deps/build/addonfactory_test_matrix_splunk"]
-	path = tests/deps/build/addonfactory_test_matrix_splunk
-	url = https://github.com/splunk/addonfactory_test_matrix_splunk
-	branch = master

Dockerfile-splunk

@@ -20,7 +20,4 @@ ARG SPLUNK_APP_ID=TA_UNKNOWN
 ARG SPLUNK_APP_PACKAGE=package
 RUN echo Splunk VERSION=$SPLUNK_VERSION SPLUNK_APP_PACKAGE=$SPLUNK_APP_PACKAGE
 
-COPY tests/deps/build/addonfactory_test_matrix_splunk/packages/all/common /opt/splunk/etc/apps/
-COPY tests/deps/build/addonfactory_test_matrix_splunk/packages/all/sh /opt/splunk/etc/apps/
-
 COPY $SPLUNK_APP_PACKAGE /opt/splunk/etc/apps/$SPLUNK_APP_ID

pytest_splunk_addon_ui_smartx/plugin.py

@@ -154,7 +154,7 @@ def ucc_smartx_configs(request):
 
 def get_browser_scope(fixture_name, config):
     """
-    Set the scope of the browser dyncamically.
+    Set the scope of the browser dynamically.
     """
     if config.getoption("--local") and config.getoption("--persist-browser"):
         return "session"
@@ -186,7 +186,7 @@ def ucc_smartx_selenium_helper(
             break
         except Exception as e:
             last_exc = e
-            LOGGER.warn(
+            LOGGER.warning(
                 "Failed to configure the browser or login to Splunk instance for - Try={} \nTRACEBACK::{}".format(
                     try_number, traceback.format_exc()
                 )
@@ -212,7 +212,7 @@ def ucc_smartx_selenium_helper(
                     "Could not notify to sauce labs because scope of fixture is not set to function"
                 )
         except:
-            LOGGER.warn(
+            LOGGER.warning(
                 "Could not notify to Saucelabs \nTRACEBACK::{}".format(
                     traceback.format_exc()
                 )
@@ -232,7 +232,7 @@ def ucc_smartx_rest_helper(ucc_smartx_configs, splunk, splunk_rest_uri):
             break
         except Exception as e:
             last_exc = e
-            LOGGER.warn(
+            LOGGER.warning(
                 "Failed to configure rest endpint for Splunk instance - Try={} \nTRACEBACK::{}".format(
                     try_number, traceback.format_exc()
                 )
@@ -290,13 +290,15 @@ def pytest_runtest_makereport(item, call):
 
                         report.extra = [pytest_html.extras.image(screenshot_path)]
                     except:
-                        LOGGER.warn(
+                        LOGGER.warning(
                             "Screenshot can not be captured. Scope of the fixture test_helper must be 'function' to capture the screenshot. "
                         )
         else:
-            LOGGER.warn(
+            LOGGER.warning(
                 "pytest-html is not installed. Install by using: pip install pytest-html"
             )
     except Exception as e:
-        LOGGER.warn("Got exception while making test report. Exception  {}".format(e))
+        LOGGER.warning(
+            "Got exception while making test report. Exception  {}".format(e)
+        )
         LOGGER.debug("test_report, Exception: {}".format(traceback.format_exc()))

tests/deps/build/addonfactory_test_matrix_splunk

@@ -0,0 +1,29 @@
+import pytest
+
+from .Example_UccLib.account import AccountPage
+
+
+@pytest.fixture
+def add_account(ucc_smartx_rest_helper):
+    account = AccountPage(
+        ucc_smartx_rest_helper=ucc_smartx_rest_helper, open_page=False
+    )
+    url = account._get_account_endpoint()
+    kwargs = {
+        "name": "test_input",
+        "account_checkbox": 1,
+        "account_multiple_select": "one",
+        "account_radio": "yes",
+        "auth_type": "basic",
+        "custom_endpoint": "login.example.com",
+        "username": "TestUser",
+        "password": "TestPassword",
+        "token": "TestToken",
+        "client_id": "",
+        "client_secret": "",
+        "redirect_url": "",
+        "endpoint": "",
+        "example_help_link": "",
+    }
+    yield account.backend_conf.post_stanza(url, kwargs)
+    account.backend_conf.delete_all_stanzas()

tests/ui/conftest.py

@@ -4,7 +4,6 @@
 from pytest_splunk_addon_ui_smartx.components.controls.button import Button
 
 from .Example_UccLib.alert_action import AlertPage
-from .test_splunk_ta_example_addon_input import add_account
 
 
 @pytest.fixture(autouse=True)
@@ -85,7 +84,7 @@ def test_dropdown_list(self, ucc_smartx_selenium_helper):
 
     @pytest.mark.execute_enterprise_cloud_true
     @pytest.mark.forwarder
-    def test_account_functionality(self, ucc_smartx_selenium_helper):
+    def test_account_functionality(self, ucc_smartx_selenium_helper, add_account):
         alert_page = AlertPage(ucc_smartx_selenium_helper, None)
         alert_page.alert_entity.open()
         alert_page.alert_entity.add_action_dropdown.wait_for_values()
@@ -144,7 +143,9 @@ def test_toggle(self, ucc_smartx_selenium_helper):
     @pytest.mark.execute_enterprise_cloud_true
     @pytest.mark.forwarder
     @pytest.mark.sanity_test
-    def test_alert_action_save(self, ucc_smartx_selenium_helper, clean_alert):
+    def test_alert_action_save(
+        self, ucc_smartx_selenium_helper, add_account, clean_alert
+    ):
         alert_page = AlertPage(ucc_smartx_selenium_helper, None)
         alert_page.alert_entity.open()
         alert_page.alert_entity.add_action_dropdown.wait_for_values()
@@ -168,7 +169,7 @@ def test_alert_action_save(self, ucc_smartx_selenium_helper, clean_alert):
 
     @pytest.mark.execute_enterprise_cloud_true
     @pytest.mark.forwarder
-    def test_alert_help_text_entity(self, ucc_smartx_selenium_helper):
+    def test_alert_help_text_entity(self, add_account, ucc_smartx_selenium_helper):
         alert_page = AlertPage(ucc_smartx_selenium_helper, None)
         alert_page.alert_entity.open()
         alert_page.alert_entity.add_action_dropdown.wait_for_values()