Add fully automated Testing Façade for NMOS Controller testing

Development/src/components/PaginationButtons.js

@@ -36,7 +36,7 @@ export const PaginationButton = ({
     };
 
     return (
-        <Button onClick={() => nextPage(rel)} disabled={!enabled}>
+        <Button onClick={() => nextPage(rel)} disabled={!enabled} name={rel}>
             {getIcon(rel)}
             {label}
         </Button>

Development/src/pages/receivers/ConnectButtons.js

@@ -65,6 +65,7 @@ const ConnectButtons = ({ senderData, receiverData }) => {
                 onClick={event => handleConnect('active', event)}
                 color="primary"
                 startIcon={<ActivateImmediateIcon />}
+                name="activate"
             >
                 Activate
             </Button>

Development/src/pages/receivers/ConnectionManagementTab.js

@@ -201,6 +201,7 @@ const ConnectionManagementTab = ({ receiverData, basePath }) => {
                                             style={{
                                                 textDecoration: 'none',
                                             }}
+                                            name="label"
                                         >
                                             <LinkChipField record={item} />
                                         </Link>

Development/src/pages/receivers/ReceiversList.js

@@ -96,6 +96,7 @@ const ReceiversList = props => {
                                             basePath="/receivers"
                                             record={item}
                                             label={item.label}
+                                            name="label"
                                         />
                                     </TableCell>
                                     <TableCell>
@@ -117,6 +118,7 @@ const ReceiversList = props => {
                                             <ActiveField
                                                 record={item}
                                                 resource="receivers"
+                                                name="active"
                                             />
                                         </TableCell>
                                     )}

Development/src/pages/receivers/ReceiversShow.js

@@ -104,6 +104,7 @@ const ReceiversShowView = props => {
                                 disabled={
                                     !get(record, `$${key}`) || !useConnectionAPI
                                 }
+                                name={key}
                             />
                         ))}
                         <Tab
@@ -114,6 +115,7 @@ const ReceiversShowView = props => {
                             disabled={
                                 !get(record, '$staged') || !useConnectionAPI
                             }
+                            name="connect"
                         />
                     </Tabs>
                 </Paper>
@@ -140,10 +142,10 @@ const ShowSummaryTab = ({ record, ...props }) => {
     return (
         <ShowView {...props} title={<ResourceTitle />} actions={<Fragment />}>
             <SimpleShowLayout>
-                <TextField label="ID" source="id" />
+                <TextField label="ID" source="id" name="id" />
                 <TAIField source="version" />
-                <TextField source="label" />
-                <TextField source="description" />
+                <TextField source="label" name="label" />
+                <TextField source="description" name="description" />
                 <ObjectField source="tags" />
                 <SanitizedDivider />
                 <ParameterField source="transport" register={TRANSPORTS} />
@@ -181,7 +183,11 @@ const ShowSummaryTab = ({ record, ...props }) => {
                 )}
                 <ParameterField source="format" register={FORMATS} />
                 {queryVersion() >= 'v1.2' && (
-                    <BooleanField label="Active" source="subscription.active" />
+                    <BooleanField
+                        label="Active"
+                        source="subscription.active"
+                        name="active"
+                    />
                 )}
                 {queryVersion() >= 'v1.2' &&
                     get(record, 'subscription.sender_id') && (
@@ -220,13 +226,15 @@ const ShowActiveTab = ({ record, ...props }) => {
                         source="$active.sender_id"
                         reference="senders"
                         link="show"
+                        name="sender"
                     >
                         <LinkChipField />
                     </ReferenceField>
                 )}
                 <BooleanField
                     label="Master Enable"
                     source="$active.master_enable"
+                    name="master_enable"
                 />
                 <TextField label="Mode" source="$active.activation.mode" />
                 <TAIField

Development/src/pages/senders/SendersList.js

@@ -90,6 +90,7 @@ const SendersList = props => {
                                             basePath="/senders"
                                             record={item}
                                             label={item.label}
+                                            name="label"
                                         />
                                     </TableCell>
                                     <TableCell>

Development/src/pages/senders/SendersShow.js

@@ -120,10 +120,10 @@ const ShowSummaryTab = ({ record, ...props }) => {
     return (
         <ShowView {...props} title={<ResourceTitle />} actions={<Fragment />}>
             <SimpleShowLayout>
-                <TextField label="ID" source="id" />
+                <TextField label="ID" source="id" name="id" />
                 <TAIField source="version" />
-                <TextField source="label" />
-                <TextField source="description" />
+                <TextField source="label" name="label" />
+                <TextField source="description" name="description" />
                 <ObjectField source="tags" />
                 <SanitizedDivider />
                 <ParameterField source="transport" register={TRANSPORTS} />

Development/src/pages/settings.js

@@ -95,6 +95,7 @@ const Settings = () => {
                                     onFocus={selectOnFocus}
                                     disabled={disabledSetting(QUERY_API)}
                                     helperText="Used to show the registered Nodes and their sub-resources"
+                                    name="queryapi"
                                 />
                             </StyledListItem>
                         )}

TestingFacade/.flake8

@@ -0,0 +1,2 @@
+[flake8]
+max-line-length = 120

TestingFacade/Config.py

@@ -0,0 +1,12 @@
+# Port for Testing Facade to run on
+TESTING_FACADE_PORT = 5001
+# URL of nmos-js instance for testing
+NCUT_URL = "http://localhost:3000/#/"
+# URL of NMOS Testing Tool's mock registry
+MOCK_REGISTRY_URL = "http://127.0.0.1:5102/"
+# Browser to use for testing. Matching webdriver must be installed
+BROWSER = 'Chrome'
+# Use browser in headless mode. Set to False to have each test run in a visible window
+HEADLESS = True
+# Time in seconds to wait for elements to load
+WAIT_TIME = 5

TestingFacade/DataStore.py

@@ -0,0 +1,79 @@
+# Copyright (C) 2021 Advanced Media Workflow Association
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+class DataStore:
+    """
+    Store json with test question details for use with NMOS Controller
+    test suite and Testing Facade
+    """
+
+    def __init__(self):
+        self.test_type = None
+        self.question_id = None
+        self.name = None
+        self.description = None
+        self.question = None
+        self.answers = None
+        self.timeout = None
+        self.answer_uri = None
+        self.answer_response = None
+        self.metadata = None
+
+    def clear(self):
+        self.test_type = None
+        self.question_id = None
+        self.name = None
+        self.description = None
+        self.question = None
+        self.answers = None
+        self.timeout = None
+        self.answer_uri = None
+        self.answer_response = None
+        self.metadata = None
+
+    def setJson(self, json):
+        self.test_type = json["test_type"]
+        self.question_id = json["question_id"]
+        self.name = json["name"]
+        self.description = json["description"]
+        self.question = json["question"]
+        self.answers = json["answers"]
+        self.timeout = json['timeout']
+        self.answer_uri = json["answer_uri"]
+        self.metadata = json["metadata"]
+
+    def getAnswerJson(self):
+        json_data = {
+            "question_id": self.question_id,
+            "answer_response": self.answer_response
+        }
+        return json_data
+
+    def setAnswer(self, answer):
+        self.answer_response = answer
+
+    def getQuestionID(self):
+        return self.question_id
+
+    def getAnswers(self):
+        return self.answers
+
+    def getUrl(self):
+        return self.answer_uri
+
+    def getMetadata(self):
+        return self.metadata
+
+
+dataStore = DataStore()

TestingFacade/GenericAutoTest.py

@@ -0,0 +1,128 @@
+import time
+from selenium import webdriver
+from selenium.webdriver.common.keys import Keys
+from selenium.common.exceptions import NoSuchElementException
+from selenium.webdriver.common.by import By
+from selenium.webdriver.support import expected_conditions as EC
+from selenium.webdriver.support.ui import WebDriverWait
+import Config as CONFIG
+
+class GenericAutoTest:
+    """
+    Base test class for automated version of NMOS Controller test suite without Testing Façade
+    """
+    def __init__(self):
+        self.NCuT_url = CONFIG.NCUT_URL
+        self.mock_registry_url = CONFIG.MOCK_REGISTRY_URL
+        self.multipart_question_storage = {}
+
+    def set_up_test(self):
+        # Set up webdriver
+        browser = getattr(webdriver, CONFIG.BROWSER)
+        get_options = getattr(webdriver, CONFIG.BROWSER + 'Options', False)
+        if get_options:
+            options = get_options()   
+            options.headless = CONFIG.HEADLESS
+            self.driver = browser(options=options)
+        else:
+            self.driver = browser()
+        self.driver.implicitly_wait(CONFIG.WAIT_TIME)
+        # Launch browser, navigate to nmos-js and update query api url to mock registry
+        self.driver.get(self.NCuT_url + "Settings")
+        query_api = self.driver.find_element_by_name("queryapi")
+        query_api.clear()
+        if query_api.get_attribute('value') != '':
+            time.sleep(1)
+            query_api.send_keys(Keys.CONTROL + "a")
+            query_api.send_keys(Keys.DELETE)
+        query_api.send_keys(self.mock_registry_url + "x-nmos/query/v1.3")
+        # Open menu to show link names if not already open
+        open_menu = self.driver.find_elements_by_xpath('//*[@title="Open menu"]')
+        if open_menu:
+            open_menu[0].click()
+
+    def tear_down_test(self):
+        self.driver.close()
+
+    def refresh_page(self):
+        """
+        Click refresh button and sleep to allow loading time
+        """
+        self.driver.find_element_by_css_selector("[aria-label='Refresh']").click()
+        time.sleep(1)
+
+    def navigate_to_page(self, page):
+        """
+        Navigate to page by link text, refresh page and sleep to allow loading time
+        """
+        self.driver.find_element_by_link_text(page).click()
+        self.refresh_page()
+
+    def find_resource_labels(self):
+        """
+        Find all resources on a page by label
+        Returns list of labels
+        """
+        resources = self.driver.find_elements_by_name("label")
+        return [entry.text for entry in resources]
+
+    def next_page(self):
+        """
+        Navigate to next page via next button and sleep to allow loading time
+        """
+        self.driver.find_element_by_name('next').click()
+        time.sleep(1)
+
+    def check_connectable(self):
+        """
+        Check if connect tab is active
+        returns True if available, False if disabled
+        """
+        connect_button = WebDriverWait(self.driver, 10).until(EC.visibility_of_element_located((By.NAME,
+                                                                                                "connect")))
+        disabled = connect_button.get_attribute("aria-disabled")
+        return True if disabled == 'false' else False
+
+    def make_connection(self, sender):
+        """
+        Navigate to connect tab, activate connection to given sender
+        """
+        connect = WebDriverWait(self.driver, 10).until(EC.element_to_be_clickable((By.NAME, "connect")))
+        connect.click()
+
+        # Find the row containing the correct sender and activate connection
+        senders = self.find_resource_labels()
+        row = [i for i, s in enumerate(senders) if s == sender][0]
+        activate_button = self.driver.find_elements_by_name("activate")[row]
+        activate_button.click()
+        time.sleep(2)
+
+    def remove_connection(self, receiver):
+        """
+        Deactivate a connection on a given receiver
+        """
+        receivers = self.find_resource_labels()
+        row = [i for i, r in enumerate(receivers) if r == receiver][0]
+        deactivate_button = self.driver.find_elements_by_name("active")[row]
+        if deactivate_button.get_attribute('value') == "true":
+            deactivate_button.click()
+        time.sleep(2)
+
+    def get_active_receiver(self):
+        """
+        Identify an active receiver
+        Returns string of receiver label or None
+        """
+        active_buttons = self.driver.find_elements_by_name('active')
+        active_row = [i for i, b in enumerate(active_buttons) if b.get_attribute('value') == "true"]
+        return None if not active_row else self.driver.find_elements_by_name('label')[active_row[0]].text
+
+    def get_connected_sender(self):
+        """
+        Identify the sender a receiver is connected to
+        Returns string of sender label
+        """
+        active = WebDriverWait(self.driver, 10).until(EC.element_to_be_clickable((By.NAME, "active")))
+        active.click()
+
+        return self.driver.find_element_by_name('sender').text