Merge pull request #135 from splunk/test/new_ucc

fix: update selectors for new ucc ui

Author: dhruvanshus-crest

.circleci/config.yml

@@ -18,82 +18,82 @@ commands:
         type: string
         default: latest
     steps:
-    - run:
-        name: Downloading Example-TA
-        command: |
-          cd tests/deps/splunk-add-on-for-ucc-example
-          mkdir output 
-          cd output
-          pwd
-          curl -s https://api.github.com/repos/splunk/splunk-add-on-for-ucc-example/releases/latest | grep "Splunk_TA.*tar.gz" | grep -v search_head | grep -v indexer | grep -v forwarder | cut -d : -f 2,3 | tr -d \" | wget -qi - || true
-          ls
-          tar -xzf *.tar.gz
-          ls
-          rm *.tar.gz
-          ls
-    - run:
-        name: Setup for testing
-        command: |
-          echo "Setup for Testing..."
-          pip install git+https://github.com/pixelb/crudini
-          mkdir test-results
-          cp -r /tmp/workspace/dist dist
-          cp -r tests/deps/splunk-add-on-for-ucc-example/output output
-    - run:
-        name: Splunk Testing
-        command: |
-          export SPLUNK_VERSION=$(crudini --get tests/deps/build/addonfactory_test_matrix_splunk/splunk_matrix.conf "<<parameters.splunk_version>>" VERSION)
-          export SPLUNK_APP_ID=$(crudini --get tests/deps/splunk-add-on-for-ucc-example/package/default/app.conf id name)
-          export SPLUNK_APP_PACKAGE=tests/deps/splunk-add-on-for-ucc-example/output/$(ls tests/deps/splunk-add-on-for-ucc-example/output/)
-          export TEST_SET=tests/ui
-          export TEST_BROWSER="<<parameters.browser>>"
-          export TEST_SUITE="-k <<parameters.test_suite>>"
-          export JOB_NAME="CircleCI::$CIRCLE_PROJECT_REPONAME[$CIRCLE_BRANCH][$TEST_BROWSER] #$CIRCLE_BUILD_NUM"
-          export SAUCE_IDENTIFIER=$SAUCE_IDENTIFIER-$(cat /proc/sys/kernel/random/uuid)
-          echo "environment setup..."
-          echo $SPLUNK_VERSION
-          echo $SPLUNK_APP_ID
-          echo $SPLUNK_APP_PACKAGE
-          echo $TEST_SET
-          echo $TEST_BROWSER
-          echo $TEST_SUITE
-          echo "Testing..."
-          docker-compose -f docker-compose-ci.yml build
+      - run:
+          name: Downloading Example-TA
+          command: |
+            cd tests/deps/splunk-add-on-for-ucc-example
+            mkdir output 
+            cd output
+            pwd
+            # curl -s https://api.github.com/repos/splunk/splunk-add-on-for-ucc-example/releases/latest | grep "Splunk_TA.*tar.gz" | grep -v search_head | grep -v indexer | grep -v forwarder | cut -d : -f 2,3 | tr -d \" | wget -qi - || true
+            ls
+            mv ../../Splunk_TA_UCCExample-8.0.1-R56b2ace.tar.gz ./
+            tar -xzf *.tar.gz
+            ls
+            rm *.tar.gz
+            ls
+      - run:
+          name: Setup for testing
+          command: |
+            echo "Setup for Testing..."
+            pip install git+https://github.com/pixelb/crudini
+            mkdir test-results
+            cp -r /tmp/workspace/dist dist
+            cp -r tests/deps/splunk-add-on-for-ucc-example/output output
+      - run:
+          name: Splunk Testing
+          command: |
+            export SPLUNK_VERSION=$(crudini --get tests/deps/build/addonfactory_test_matrix_splunk/splunk_matrix.conf "<<parameters.splunk_version>>" VERSION)
+            export SPLUNK_APP_ID=$(crudini --get tests/deps/splunk-add-on-for-ucc-example/package/default/app.conf id name)
+            export SPLUNK_APP_PACKAGE=tests/deps/splunk-add-on-for-ucc-example/output/$(ls tests/deps/splunk-add-on-for-ucc-example/output/)
+            export TEST_SET=tests/ui
+            export TEST_BROWSER="<<parameters.browser>>"
+            export TEST_SUITE="-k <<parameters.test_suite>>"
+            export JOB_NAME="CircleCI::$CIRCLE_PROJECT_REPONAME[$CIRCLE_BRANCH][$TEST_BROWSER] #$CIRCLE_BUILD_NUM"
+            export SAUCE_IDENTIFIER=$SAUCE_IDENTIFIER-$(cat /proc/sys/kernel/random/uuid)
+            echo "environment setup..."
+            echo $SPLUNK_VERSION
+            echo $SPLUNK_APP_ID
+            echo $SPLUNK_APP_PACKAGE
+            echo $TEST_SET
+            echo $TEST_BROWSER
+            echo $TEST_SUITE
+            echo "Testing..."
+            docker-compose -f docker-compose-ci.yml build
+
+            # Saucelab connection
+            docker-compose -f docker-compose-ci.yml up -d sauceconnect 
 
-          # Saucelab connection
-          docker-compose -f docker-compose-ci.yml up -d sauceconnect 
+            # Start Splunk
+            docker-compose -f docker-compose-ci.yml up -d splunk
+            until docker-compose -f docker-compose-ci.yml logs splunk | grep "Ansible playbook complete" ; do sleep 1; done
 
-          # Start Splunk
-          docker-compose -f docker-compose-ci.yml up -d splunk
-          until docker-compose -f docker-compose-ci.yml logs splunk | grep "Ansible playbook complete" ; do sleep 1; done
+            # Normal Inspecting
+            docker-compose -f docker-compose-ci.yml logs sauceconnect
+            docker ps -a
 
-          # Normal Inspecting
-          docker-compose -f docker-compose-ci.yml logs sauceconnect
-          docker ps -a
+            # Run the tests
+            test_exit_code=0
+            docker-compose -f docker-compose-ci.yml up  --abort-on-container-exit test || test_exit_code=$?
 
-          # Run the tests
-          test_exit_code=0
-          docker-compose -f docker-compose-ci.yml up  --abort-on-container-exit test || test_exit_code=$?
-          
-          # Collect Results
-          docker container create --name dummy \
-                              -v project_results:/home/circleci/work \
-                              registry.access.redhat.com/ubi7/ubi
-          docker cp dummy:/home/circleci/work/test-results/test.xml test-results/  || true
-          docker cp dummy:/home/circleci/work/assets test-results/assets  || true
-          docker cp dummy:/home/circleci/work/report.html test-results/report.html  || true
-          
-          docker-compose -f docker-compose-ci.yml down || true
-          
-          echo exit code "$test_exit_code"
-          exit "$test_exit_code"
+            # Collect Results
+            docker container create --name dummy \
+                                -v project_results:/home/circleci/work \
+                                registry.access.redhat.com/ubi7/ubi
+            docker cp dummy:/home/circleci/work/test-results/test.xml test-results/  || true
+            docker cp dummy:/home/circleci/work/assets test-results/assets  || true
+            docker cp dummy:/home/circleci/work/report.html test-results/report.html  || true
 
+            docker-compose -f docker-compose-ci.yml down || true
 
-    - store_artifacts:
-        path: test-results
-        destination: test-results
-    - store_test_results:
-        path: test-results
+            echo exit code "$test_exit_code"
+            exit "$test_exit_code"
+
+      - store_artifacts:
+          path: test-results
+          destination: test-results
+      - store_test_results:
+          path: test-results
 
 jobs:
   build:
@@ -167,16 +167,16 @@ jobs:
       - attach_workspace:
           at: /tmp/workspace
       - setup_remote_docker:
-          docker_layer_caching: true            
+          docker_layer_caching: true
       - test_smartx:
-            splunk_version: <<parameters.splunk_version>>
-            browser: <<parameters.browser>>
-            test_suite: <<parameters.test_suite>>
+          splunk_version: <<parameters.splunk_version>>
+          browser: <<parameters.browser>>
+          test_suite: <<parameters.test_suite>>
 
   semgrep:
     environment:
-        SEMGREP_REPO_URL: << pipeline.project.git_url >>
-        SEMGREP_BRANCH: << pipeline.git.branch >>
+      SEMGREP_REPO_URL: << pipeline.project.git_url >>
+      SEMGREP_BRANCH: << pipeline.git.branch >>
     docker:
       - image: returntocorp/semgrep-agent:v1
         user: root
@@ -196,13 +196,13 @@ jobs:
             export REPO_BRANCH=$(echo "<< pipeline.git.branch >>")
             DASHBOARD_URL=$(python3 -c "from urllib.parse import quote; import os; print('https://semgrep.dev/manage/findings?repo=' + quote(os.environ['SEMGREP_REPO_NAME'], safe='') + '&tab=findings&ref_type=branch&ref=' + quote(os.environ['REPO_BRANCH'], safe=''))")
             echo "View Result at Semgrep Dashboard: $DASHBOARD_URL"
-            
+
             # Semgrep Exclude files
             dos2unix .semgrepignore
             SEMGREP_EXCLUDE=$(sed "/^#/d" .semgrepignore | sed "/^:/d" | sed -r '/^\s*$/d' | sed ':a;N;$!ba;s/\n/ --exclude /g')
             echo "Excluding Semgrep Files: --exclude $SEMGREP_EXCLUDE"
             # Generate xml file
-            semgrep --config="p/r2c-ci" --config="p/r2c-security-audit" --config="p/bandit" --error --strict --timeout=0 --junit-xml -o /root/project/test-results/semgrep-scan.xml --exclude $SEMGREP_EXCLUDE     
+            semgrep --config="p/r2c-ci" --config="p/r2c-security-audit" --config="p/bandit" --error --strict --timeout=0 --junit-xml -o /root/project/test-results/semgrep-scan.xml --exclude $SEMGREP_EXCLUDE
       - store_artifacts:
           path: test-results
           destination: test-results
@@ -260,7 +260,7 @@ workflows:
       - build
       - semgrep:
           context:
-            - gdi-semgrep      
+            - gdi-semgrep
           filters:
             branches:
               only: /.*/
@@ -274,7 +274,7 @@ workflows:
             parameters:
               splunk_version: ["8.1"]
               browser: ["firefox", "chrome"]
-              test_suite: 
+              test_suite:
                 - "test_splunk_ta_example_addon_logging"
                 - "test_splunk_ta_example_addon_account"
                 - "test_splunk_ta_example_addon_input"
@@ -296,4 +296,4 @@ workflows:
             branches:
               ignore: /.*/
             tags:
-              only: /^v\d*\.\d*\.\d*.*$/
+              only: /^v\d*\.\d*\.\d*.*$/

docs/example_code.py

@@ -27,18 +27,18 @@ def __init__(self, browser, container):
             :param browser: The selenium webdriver
             :param container: The container in which the entity is located in
         """
-        add_btn = Button(browser, Selector(by=By.ID, select="addInputBtn"))
-        entity_container = Selector(select= ".modal-content")
+        add_btn = Button(browser, Selector(by=By.ID, select='addInputBtn'))
+        entity_container = Selector(select='[data-test="modal"]')
         super(ExampleTAInputEntity, self).__init__(browser, entity_container, add_btn=add_btn)
         # Controls
-        self.name = TextBox(browser, Selector(select=".name"))
-        self.interval = TextBox(browser, Selector(select=".interval"))
-        self.index = SingleSelect(browser, Selector(select= ".index"))
-        self.object = TextBox(browser, Selector(select=".object"))
-        self.object_fields = TextBox(browser, Selector(select=".object_fields"))
-        self.title = BaseComponent(browser, Selector(select= "h4.modal-title"))
-        self.use_existing_input = Toggle(browser, Selector(select= ".use_existing_checkpoint"))
-        self.help_link = LearnMore(browser, Selector(select=" #accountDefaultTooltip a"))
+        self.name = TextBox(browser, Selector(select='[data-test="control-group"][data-name="name"]'))
+        self.interval = TextBox(browser, Selector(select='[data-test="control-group"][data-name="interval"]'))
+        self.index = SingleSelect(browser, Selector(select= '[data-test="control-group"][data-name="index"]'))
+        self.object = TextBox(browser, Selector(select='[data-test="control-group"][data-name="object"]'))
+        self.object_fields = TextBox(browser, Selector(select='[data-test="control-group"][data-name="object_fields"]'))
+        self.title = BaseComponent(browser, Selector(select= '[data-test="title"]'))
+        self.use_existing_input = Toggle(browser, Selector(select= '[data-test="control-group"][data-name="use_existing_checkpoint"]'))
+        self.help_link = LearnMore(browser, Selector(select='[data-test="control-group"] [data-test="link"]'))
 
 class ExampleTALogEntity(Entity):
     """
@@ -49,16 +49,16 @@ def __init__(self, browser, container):
             :param browser: The selenium webdriver
             :param container: The container in which the entity is located in
         """
-        add_btn = Button(browser, Selector(by=By.ID, select="addInputBtn"))
-        entity_container = Selector(select= ".modal-content")
+        add_btn = Button(browser, Selector(by=By.ID, select='[id="addInputBtn"]'))
+        entity_container = Selector(select='[data-test="modal"]')
         super(ExampleTALogEntity, self).__init__(browser, entity_container, add_btn=add_btn)
         # Controls
-        self.name = TextBox(browser, Selector(select=".name"))
-        self.interval = TextBox(browser, Selector(select=".interval"))
-        self.index = SingleSelect(browser, Selector(select= ".index"))
-        self.title = BaseComponent(browser, Selector(select= "h4.modal-title"))
-        self.use_existing_input = Toggle(browser, Selector(select= ".use_existing_checkpoint"))
-        self.help_link = LearnMore(browser, Selector(select=" #accountDefaultTooltip a"))
+        self.name = TextBox(browser, Selector(select='[data-test="control-group"][data-name="name"]'))
+        self.interval = TextBox(browser, Selector(select='[data-test="control-group"][data-name="interval"]'))
+        self.index = SingleSelect(browser, Selector(select='[data-test="control-group"][data-name="index"]'))
+        self.title = BaseComponent(browser, Selector(select='[data-test="title"]'))
+        self.use_existing_input = Toggle(browser, Selector(select='[data-test="control-group"][data-name="use_existing_checkpoint"]'))
+        self.help_link = LearnMore(browser, Selector(select='[data-test="control-group"] [data-test="link"]'))
 
 
 class Inputs(Page):
@@ -72,16 +72,16 @@ def __init__(self, ucc_smartx_selenium_helper=None, ucc_smartx_rest_helper=None,
         """
         super(Inputs, self).__init__(ucc_smartx_selenium_helper, ucc_smartx_rest_helper, open_page=True)
 
-        input_container = Selector(select= "div.inputsContainer")
+        input_container = Selector(select='div[role="main"]')
         if ucc_smartx_selenium_helper:
-            self.title = Message(ucc_smartx_selenium_helper.browser, Selector(by=By.CLASS_NAME, select="tool-title"))
-            self.description = Message(ucc_smartx_selenium_helper.browser, Selector(by=By.CLASS_NAME, select="tool-description"))
+            self.title = Message(ucc_smartx_selenium_helper.browser, Selector(select='[data-test="column"] .pageTitle'))
+            self.description = Message(ucc_smartx_selenium_helper.browser, Selector(select='[data-test="column"] .pageSubtitle'))
             self.table = InputTable(ucc_smartx_selenium_helper.browser, input_container, mapping={"account_name": "account", "status": "disabled"})
-            self.create_new_input = Dropdown(ucc_smartx_selenium_helper.browser, Selector(select=".add-button"))
+            self.create_new_input = Dropdown(ucc_smartx_selenium_helper.browser, Selector(by=By.ID, select='addInputBtn'))
             self.ExampleTALogEntity = ExampleTALogEntity(ucc_smartx_selenium_helper.browser, input_container)
             self.ExampleTAInputEntity = ExampleTAInputEntity(ucc_smartx_selenium_helper.browser, input_container)
-            self.pagination = Dropdown(ucc_smartx_selenium_helper.browser, Selector(select="control btn-group shared-controls-syntheticselectcontrol control-default"))
-            self.type_filter = Dropdown(ucc_smartx_selenium_helper.browser, Selector(select=" .type-filter"))
+            self.pagination = Dropdown(ucc_smartx_selenium_helper.browser, Selector(select='.dropdownPage'))    # Selector for dropdown for selecting number of records shown in a single page
+            self.type_filter = Dropdown(ucc_smartx_selenium_helper.browser, Selector(select='.dropdownInput'))  # Selector for dropdown for showing records of perticular input type.
             self.message_tray = MessageTray(ucc_smartx_selenium_helper.browser)
 
         if ucc_smartx_rest_helper:

pytest_splunk_addon_ui_smartx/alert_actions/__init__.py

@@ -7,10 +7,10 @@
 
 from ..backend_confs import SingleBackendConf
 from ..components.entity import Entity
-from ..components.base_component import Selector
+from .components.alert_base_component import Selector
 
 from .components.button import Button
-from .components.textbox import TextBox
+from .components.textbox import AlertTextBox
 from .components.searchbox import SearchBox
 from .components.dropdown import ActionDropdown
 
@@ -32,8 +32,8 @@ def __init__(self, ucc_smartx_selenium_helper, ucc_smartx_rest_helper):
             self.splunk_web_url = ucc_smartx_selenium_helper.splunk_web_url
 
             # Controls 
-            self.name = TextBox(ucc_smartx_selenium_helper.browser, Selector(select="div[data-name=name]"))
-            self.description = TextBox(ucc_smartx_selenium_helper.browser, Selector(select="div[data-name=description]"))
+            self.name = AlertTextBox(ucc_smartx_selenium_helper.browser, Selector(select="div[data-name=name]"))
+            self.description = AlertTextBox(ucc_smartx_selenium_helper.browser, Selector(select="div[data-name=description]"))
             self.search = SearchBox(ucc_smartx_selenium_helper.browser, Selector(select=".search-bar-input"))
             self.add_action_dropdown = ActionDropdown(ucc_smartx_selenium_helper.browser, Selector(select=".add-action-btn"))
             self.add_alert = Button(ucc_smartx_selenium_helper.browser, Selector(select=".new-alert-button"))