diff --git a/.github/workflows/test-cdbportal.yml b/.github/workflows/test-cdbportal.yml new file mode 100644 index 000000000..4e341ba0f --- /dev/null +++ b/.github/workflows/test-cdbportal.yml @@ -0,0 +1,44 @@ +name: Test CDB Portal + +on: + pull_request: + paths: + - 'src/java/CdbWebPortal/src/java/**' + - 'tools/developer_tools/code_testing/CdbWebPortalTest/**' + - '.github/workflows/test-cdbportal.yml' + workflow_dispatch: + +permissions: + contents: read + +jobs: + test: + name: Run CDB Portal Java Tests + runs-on: ubuntu-latest + + defaults: + run: + working-directory: tools/developer_tools/code_testing/CdbWebPortalTest + + steps: + - name: Checkout code + uses: actions/checkout@v4 + + - name: Set up JDK 11 and Maven cache + uses: actions/setup-java@v4 + with: + distribution: temurin + java-version: '11' + cache: maven + cache-dependency-path: tools/developer_tools/code_testing/CdbWebPortalTest/pom.xml + + - name: Run tests + run: mvn --batch-mode --no-transfer-progress test + + - name: Upload test results + if: always() + uses: actions/upload-artifact@v4 + with: + name: cdb-portal-test-results + path: tools/developer_tools/code_testing/CdbWebPortalTest/target/surefire-reports/ + if-no-files-found: warn diff --git a/.gitignore b/.gitignore index 1c99e42d2..a35762907 100644 --- a/.gitignore +++ b/.gitignore @@ -55,3 +55,4 @@ docs/python/_build/ # Temporary testing csv files tools/developer_tools/python-client/packages/cli/cdbCli/service/cli/Spreadsheets/ +/tools/developer_tools/portal_testing/PythonSeleniumTest/conda-env diff --git a/CLAUDE.md b/CLAUDE.md index 123492a39..49430ada4 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -63,8 +63,8 @@ mvn test -Dtest=ClassName#methodName # single test # Python API tests — require the portal to be running on localhost:8080 cd tools/developer_tools/python-client && ./generatePyClient.sh http://localhost:8080/cdb -cd tools/developer_tools/python-client/test && pytest api_test.py -pytest api_test.py::TestClass::test_method # single test +cd tools/developer_tools/python-client && pytest test/ +pytest test/item_test.py::ItemTest::test_method # single test # Selenium GUI tests cd tools/developer_tools/portal_testing/PythonSeleniumTest && pytest gui_test.py @@ -127,7 +127,7 @@ MariaDB 10.5. Authoritative schema is the set of `create_cdb_tables.sql`, `creat - **`cdb` vs `cdb_dev`**: every db, deploy, undeploy, and backup target has a `-dev` variant that targets a separate database name and Payara domain, so a developer can run both side-by-side. When adding new admin scripts, follow the same pattern (first arg is DB name, defaulting to `cdb`). - **Single canonical version string**: run `make prepare-release` (`sbin/cdb_prepare_release.py`) to bump `etc/version`, `openapi.yaml`, the web `?v=` cache-busters, the python-client `packages/*/pyproject.toml`/conda recipes, and scaffold `docs/release-notes/.md` together. It also flags any file that drifted out of sync in a prior manual release, and refreshes `uv.lock`. - **Plugins** under `tools/developer_tools/cdb_plugins/plugins//` extend both the Java portal (deployed via `make deploy-cdb-plugin` → `update_plugin_generated_files.py`) and the Python web service. `pluginTemplates/` is the scaffold. -- **REST changes touch three places**: the Java route, `openapi.yaml`, and (after `generatePyClient.sh`) the regenerated `cdbApi/` package. The Python API tests in `tools/developer_tools/python-client/test/api_test.py` are the integration check. +- **REST changes touch three places**: the Java route, `openapi.yaml`, and (after `generatePyClient.sh`) the regenerated `cdbApi/` package. The Python API tests under `tools/developer_tools/python-client/test/` are the integration check. ## Reference docs diff --git a/README.md b/README.md index a0c1c99fe..ea33bfed3 100644 --- a/README.md +++ b/README.md @@ -187,6 +187,15 @@ The python web service is deprecated but is still a part of the distribution for ./sbin/cdbWebService.sh ``` +## Running Tests + +```sh +source setup.sh +make test +``` + +See the test setup in `tools/developer_tools/{python-client,portal_testing/PythonSeleniumTest}/README.md`. + ## Preparing a Release `make prepare-release` bumps the version string across the repo (`etc/version`, `openapi.yaml`, web asset cache-busters, python-client `packages/*/pyproject.toml`/conda recipes) and scaffolds `docs/release-notes/.md`. Run it, review the diff, then commit. ```sh diff --git a/db/sql/test/populate_entity_info.sql b/db/sql/test/populate_entity_info.sql index 00d3bc47b..0de8ce640 100644 --- a/db/sql/test/populate_entity_info.sql +++ b/db/sql/test/populate_entity_info.sql @@ -185,6 +185,9 @@ INSERT INTO `entity_info` VALUES (183,1,1,1,'2025-03-05 08:52:22',1,'2025-03-05 09:00:46',1,NULL,NULL), (184,1,1,1,'2025-04-02 08:43:08',1,'2025-04-02 08:44:46',1,NULL,NULL), (185,1,1,1,'2025-04-02 08:43:08',1,'2025-04-02 08:43:08',1,NULL,NULL), -(186,1,1,1,'2025-04-02 08:43:31',1,'2025-04-02 08:43:31',1,NULL,NULL); +(186,1,1,1,'2025-04-02 08:43:31',1,'2025-04-02 08:43:31',1,NULL,NULL), +(187,1,1,1,'2026-10-27 10:43:43',1,'2026-10-27 10:44:07',1,NULL,NULL), +(188,1,1,1,'2026-10-27 10:44:00',1,'2026-10-27 10:44:00',1,NULL,NULL), +(189,1,1,1,'2026-10-27 10:44:00',1,'2026-10-27 10:44:19',1,NULL,NULL); /*!40000 ALTER TABLE `entity_info` ENABLE KEYS */; UNLOCK TABLES; diff --git a/db/sql/test/populate_item.sql b/db/sql/test/populate_item.sql index 959c0b77d..bdd687ec2 100644 --- a/db/sql/test/populate_item.sql +++ b/db/sql/test/populate_item.sql @@ -126,6 +126,8 @@ INSERT INTO `item` VALUES (124,2,'Item With Connectors 2',NULL,'','',NULL), (125,9,'TEST CABLE 2',NULL,'KABEL',NULL,NULL), (126,6,'Item with Ports 3',NULL,NULL,NULL,NULL), -(127,2,'Item With Connectors 3',NULL,'','',NULL); +(127,2,'Item With Connectors 3',NULL,'','',NULL), +(128,6,'Another Top Level ',NULL,NULL,NULL,NULL), +(129,6,'Inventory Assignment Test Destination',NULL,NULL,NULL,NULL); /*!40000 ALTER TABLE `item` ENABLE KEYS */; UNLOCK TABLES; diff --git a/db/sql/test/populate_item_element.sql b/db/sql/test/populate_item_element.sql index 66d083f28..1cf2d91c5 100644 --- a/db/sql/test/populate_item_element.sql +++ b/db/sql/test/populate_item_element.sql @@ -185,6 +185,9 @@ INSERT INTO `item_element` VALUES (183,NULL,125,NULL,71,NULL,NULL,0,1,'Cable with metadata and endpoints with ports defined',NULL,183), (184,'E3',120,126,NULL,NULL,NULL,0,1,NULL,2.00,185), (185,NULL,126,NULL,127,NULL,NULL,0,1,'',NULL,184), -(186,NULL,127,NULL,NULL,NULL,NULL,0,1,'',NULL,186); +(186,NULL,127,NULL,NULL,NULL,NULL,0,1,'',NULL,186), +(187,NULL,128,NULL,NULL,NULL,NULL,0,1,'',NULL,187), +(188,'E1',128,129,NULL,NULL,NULL,0,1,NULL,0.00,188), +(189,NULL,129,NULL,40,NULL,NULL,0,1,'',NULL,189); /*!40000 ALTER TABLE `item_element` ENABLE KEYS */; UNLOCK TABLES; diff --git a/db/sql/test/populate_item_element_history.sql b/db/sql/test/populate_item_element_history.sql index f65eff9f8..f274d7e9f 100644 --- a/db/sql/test/populate_item_element_history.sql +++ b/db/sql/test/populate_item_element_history.sql @@ -203,6 +203,10 @@ INSERT INTO `item_element_history` VALUES (200,'E3',184,'Machine2',120,'Item with Ports 3',126,NULL,NULL,NULL,NULL,0,1,NULL,2.00,'2025-04-02 08:43:21',1), (201,NULL,185,'Item with Ports 3',NULL,NULL,NULL,NULL,NULL,NULL,NULL,0,1,'',NULL,'2025-04-02 08:43:21',1), (202,NULL,186,'Item With Connectors 3',NULL,NULL,NULL,NULL,NULL,NULL,NULL,0,1,'',NULL,'2025-04-02 08:43:31',1), -(203,NULL,185,'Item with Ports 3',NULL,NULL,NULL,'Item With Connectors 3',127,NULL,NULL,0,1,'',NULL,'2025-04-02 08:44:46',1); +(203,NULL,185,'Item with Ports 3',NULL,NULL,NULL,'Item With Connectors 3',127,NULL,NULL,0,1,'',NULL,'2025-04-02 08:44:46',1), +(204,NULL,187,'Another Top Level ',NULL,NULL,NULL,NULL,NULL,NULL,NULL,0,1,'',NULL,'2026-10-27 10:43:43',1), +(205,'E1',188,'Another Top Level ',128,'Inventory Assignment Test Destination',129,NULL,NULL,NULL,NULL,0,1,NULL,0.00,'2026-10-27 10:44:07',1), +(206,NULL,189,'Inventory Assignment Test Destination',NULL,NULL,NULL,NULL,NULL,NULL,NULL,0,1,'',NULL,'2026-10-27 10:44:07',1), +(207,NULL,189,'Inventory Assignment Test Destination',NULL,NULL,NULL,'Test Item',40,NULL,NULL,0,1,'',NULL,'2026-10-27 10:44:19',1); /*!40000 ALTER TABLE `item_element_history` ENABLE KEYS */; UNLOCK TABLES; diff --git a/db/sql/test/populate_item_item_project.sql b/db/sql/test/populate_item_item_project.sql index 2da8b303e..d4e081c2f 100644 --- a/db/sql/test/populate_item_item_project.sql +++ b/db/sql/test/populate_item_item_project.sql @@ -118,6 +118,8 @@ INSERT INTO `item_item_project` VALUES (124,3), (125,3), (126,3), -(127,3); +(127,3), +(128,3), +(129,3); /*!40000 ALTER TABLE `item_item_project` ENABLE KEYS */; UNLOCK TABLES; diff --git a/db/sql/test/populate_log.sql b/db/sql/test/populate_log.sql index 5e5d5110c..bac533291 100644 --- a/db/sql/test/populate_log.sql +++ b/db/sql/test/populate_log.sql @@ -8,6 +8,10 @@ INSERT INTO `log` VALUES (5,'User: cdb | Created: Template Holder [Item Id: 116]','2023-10-09 10:24:50',1,NULL,NULL,NULL), (6,'User: cdb | Updated: Template Holder [Item Id: 116]','2023-10-09 10:25:54',1,NULL,NULL,NULL), (7,'Authentication Succeeded: cdb','2023-10-12 13:08:58',1,NULL,NULL,NULL), -(8,'User: cdb | Created: TEST MAARC [Item Id: 119]','2023-10-12 13:09:09',1,NULL,NULL,NULL); +(8,'User: cdb | Created: TEST MAARC [Item Id: 119]','2023-10-12 13:09:09',1,NULL,NULL,NULL), +(9,'Authentication Succeeded: cdb','2026-10-27 10:43:40',1,NULL,NULL,NULL), +(10,'User: cdb | Created: Another Top Level [Item Id: 128]','2026-10-27 10:43:53',1,NULL,NULL,NULL), +(11,'User: cdb | Updated: Another Top Level [Item Id: 128]','2026-10-27 10:44:07',1,NULL,NULL,NULL), +(12,'User: cdb | Updated: Inventory Assignment Test Destination [Item Id: 129]','2026-10-27 10:44:19',1,NULL,NULL,NULL); /*!40000 ALTER TABLE `log` ENABLE KEYS */; UNLOCK TABLES; diff --git a/db/sql/test/populate_system_log.sql b/db/sql/test/populate_system_log.sql index 2c4905ff9..afa4ef96c 100644 --- a/db/sql/test/populate_system_log.sql +++ b/db/sql/test/populate_system_log.sql @@ -8,6 +8,10 @@ INSERT INTO `system_log` VALUES (5,3), (6,3), (7,2), -(8,3); +(8,3), +(9,2), +(10,3), +(11,3), +(12,3); /*!40000 ALTER TABLE `system_log` ENABLE KEYS */; UNLOCK TABLES; diff --git a/sbin/cdb_test.sh b/sbin/cdb_test.sh index ba00a2478..b64aad8b0 100755 --- a/sbin/cdb_test.sh +++ b/sbin/cdb_test.sh @@ -22,15 +22,27 @@ cd $MY_DIR/.. CDB_DIST_DIR=`pwd` cd $CURRENT_DIR -$MY_DIR/cdb_backup_db.sh - -timestamp=`date +%Y%m%d` -CDB_BACKUP_DIR=$CDB_INSTALL_DIR/backup/cdb/$timestamp +printf "\nBack up the current database and restore it after testing? [Y/n] " +read -r backup_response + +backup_database=1 +case "$backup_response" in + [Nn]*) backup_database=0 ;; + *) + $MY_DIR/cdb_backup_db.sh + timestamp=`date +%Y%m%d` + CDB_BACKUP_DIR=$CDB_INSTALL_DIR/backup/cdb/$timestamp + ;; +esac yes $db_password | $MY_DIR/cdb_create_db.sh cdb $CDB_DIST_DIR/db/sql/test || exit 1 +printf "\nRestart Payara so it uses the newly deployed test database, then press enter to continue..." +read -r + # Regenerate the API with current code base -API_CLIENT_PATH=$CDB_DIST_DIR/tools/developer_tools/python-client/ +API_CLIENT_PATH=$CDB_DIST_DIR/tools/developer_tools/python-client +export PYTHONPATH="$API_CLIENT_PATH/packages/api:$API_CLIENT_PATH/packages/cli${PYTHONPATH:+:$PYTHONPATH}" cd $API_CLIENT_PATH ./generatePyClient.sh http://localhost:8080/cdb @@ -42,59 +54,24 @@ cd $CDB_DIST_DIR/tools/developer_tools/code_testing/CdbWebPortalTest mvn test printf "$PRINTF_HEADER" "API" -cd $API_CLIENT_PATH/test -pytest api_test.py +cd $API_CLIENT_PATH +pytest test/ printf "$PRINTF_HEADER" "Selenium" cd $CDB_DIST_DIR/tools/developer_tools/portal_testing/PythonSeleniumTest -if [ ! -d "support_bin" ]; then - mkdir support_bin -fi - -cd support_bin - -skiptest=0 -needs_download=1 - -chromedriver_version_start=`google-chrome --version | grep -oP "[^A-Z ][0-9]+.[0-9]+.[0-9]+"` -chromedriver_version_regex="$chromedriver_version_start.[0-9]+/chromedriver_linux64.zip" -chromedriver_version=(`curl https://chromedriver.storage.googleapis.com/ | grep -oP $chromedriver_version_regex`) -echo ${chromedriver_version[0]} - -count_results=`echo $chromedriver_version | wc -l` - -if [ $count_results > 1 ]; then - chromedriver_version=`echo ${chromedriver_version%%$'\n'*}` -fi - -if [ -f "chromedriver" ]; then - current_version_result=`./chromedriver --version | grep -oP $chromedriver_version` - if [[ -z "$current_version_result" ]]; then - rm chromedriver - else - needs_download=0 - fi -fi - -if [[ $needs_download == 1 ]]; then - wget https://chromedriver.storage.googleapis.com/$chromedriver_version || skiptest=1 - unzip chromedriver_linux64.zip - rm chromedriver_linux64.zip -fi +# Selenium Manager resolves and downloads a compatible driver when Chrome starts. +pytest tests/ -n auto --dist loadfile --reruns 1 --reruns-delay 1 -rR - -if [[ $skiptest == 0 ]]; then - export PATH=`pwd`:$PATH - cd .. - pytest gui_test.py +if [[ $backup_database == 1 ]]; then + printf "\n\nRestore the original database from the backup? [Y/n] " + read -r restore_response + case "$restore_response" in + [Nn]*) printf "The test database remains installed as cdb.\n" ;; + *) yes $db_password | $MY_DIR/cdb_create_db.sh cdb $CDB_BACKUP_DIR ;; + esac else - echo "Error finding required chromedriver" + printf "\n\nBackup was skipped; the test database remains installed as cdb.\n" fi -printf "\n\nPress enter to proceed restoring original database back to cdb..." -read -s - -yes $db_password | $MY_DIR/cdb_create_db.sh cdb $CDB_BACKUP_DIR - -cd $CURRENT_DIR \ No newline at end of file +cd $CURRENT_DIR diff --git a/src/java/CdbWebPortal/src/java/gov/anl/aps/cdb/portal/controllers/ItemDomainInventoryController.java b/src/java/CdbWebPortal/src/java/gov/anl/aps/cdb/portal/controllers/ItemDomainInventoryController.java index aff3442de..e99c5cf1c 100644 --- a/src/java/CdbWebPortal/src/java/gov/anl/aps/cdb/portal/controllers/ItemDomainInventoryController.java +++ b/src/java/CdbWebPortal/src/java/gov/anl/aps/cdb/portal/controllers/ItemDomainInventoryController.java @@ -4,6 +4,8 @@ */ package gov.anl.aps.cdb.portal.controllers; +import gov.anl.aps.cdb.common.constants.CdbRole; +import gov.anl.aps.cdb.common.exceptions.CdbException; import gov.anl.aps.cdb.portal.constants.ItemDomainName; import gov.anl.aps.cdb.portal.import_export.import_.helpers.ImportHelperInventory; import gov.anl.aps.cdb.portal.controllers.extensions.ItemCreateWizardController; @@ -12,9 +14,12 @@ import gov.anl.aps.cdb.portal.controllers.extensions.ItemEnforcedPropertiesDomainInventoryController; import gov.anl.aps.cdb.portal.controllers.extensions.ItemMultiEditController; import gov.anl.aps.cdb.portal.controllers.extensions.ItemMultiEditDomainInventoryController; +import gov.anl.aps.cdb.portal.view.objects.InventoryMachineAssignmentSelection; import gov.anl.aps.cdb.portal.controllers.settings.ItemDomainInventorySettings; import gov.anl.aps.cdb.portal.controllers.utilities.ItemDomainInventoryControllerUtility; +import gov.anl.aps.cdb.portal.controllers.utilities.ItemDomainMachineDesignBaseControllerUtility; import gov.anl.aps.cdb.portal.model.ItemDomainInventoryLazyDataModel; +import gov.anl.aps.cdb.portal.model.ItemDomainMachineDesignTreeNode; import gov.anl.aps.cdb.portal.model.db.beans.ItemDomainInventoryFacade; import gov.anl.aps.cdb.portal.model.db.entities.EntityType; import gov.anl.aps.cdb.portal.model.db.entities.Item; @@ -23,6 +28,8 @@ import gov.anl.aps.cdb.portal.model.db.entities.ItemElement; import gov.anl.aps.cdb.portal.model.db.entities.ItemElementRelationship; import gov.anl.aps.cdb.portal.model.db.entities.ItemProject; +import gov.anl.aps.cdb.portal.model.db.entities.UserInfo; +import gov.anl.aps.cdb.portal.utilities.AuthorizationUtility; import gov.anl.aps.cdb.portal.utilities.SessionUtility; import gov.anl.aps.cdb.portal.view.objects.DomainImportExportInfo; import gov.anl.aps.cdb.portal.view.objects.ImportExportFormatInfo; @@ -52,15 +59,255 @@ public class ItemDomainInventoryController extends ItemDomainInventoryBaseContro private static final String DEFAULT_DOMAIN_NAME = ItemDomainName.inventory.getValue(); private final String DEFAULT_DOMAIN_DERIVED_FROM_ITEM_DOMAIN_NAME = "Catalog"; - private static final Logger logger = LogManager.getLogger(ItemDomainInventoryController.class.getName()); + private static final Logger logger = LogManager.getLogger(ItemDomainInventoryController.class.getName()); @EJB private ItemDomainInventoryFacade itemDomainInventoryFacade; + private final InventoryMachineAssignmentSelection machineAssignmentSelection + = new InventoryMachineAssignmentSelection(); + public boolean isInventory(Item item) { return item instanceof ItemDomainInventory; } + public InventoryMachineAssignmentSelection getMachineAssignmentSelection() { + return machineAssignmentSelection; + } + + public ItemDomainMachineDesignTreeNode getMachineAssignmentTree() { + return machineAssignmentSelection.getTree(); + } + + public ItemDomainMachineDesignTreeNode getSelectedMachineAssignmentNode() { + return machineAssignmentSelection.getSelectedNode(); + } + + public void setSelectedMachineAssignmentNode(ItemDomainMachineDesignTreeNode node) { + machineAssignmentSelection.setSelectedNode(node); + machineAssignmentSelection.setReplacementConfirmation(false); + } + + public boolean isMachineAssignmentInstalled() { + return machineAssignmentSelection.isInstalled(); + } + + public void setMachineAssignmentInstalled(boolean installed) { + machineAssignmentSelection.setInstalled(installed); + } + + public boolean isMachineAssignmentReplacementConfirmation() { + return machineAssignmentSelection.isReplacementConfirmation(); + } + + public void setMachineAssignmentReplacementConfirmation(boolean confirmation) { + machineAssignmentSelection.setReplacementConfirmation(confirmation); + } + + public void prepareMachineAssignment() { + resetMachineAssignmentState(); + ItemDomainMachineDesign assignedMachine = getAssignedMachine(); + if (assignedMachine != null) { + selectMachineAssignment(assignedMachine); + machineAssignmentSelection.setInstalled(assignedMachine.isIsHoused()); + } + } + + protected void selectMachineAssignment(ItemDomainMachineDesign machine) { + machineAssignmentSelection.selectMachine(machine); + } + + public void cancelMachineAssignment() { + resetMachineAssignmentState(); + reloadCurrent(); + } + + public void saveMachineAssignment() { + saveMachineAssignment(false); + } + + public void confirmMachineAssignmentReplacement() { + machineAssignmentSelection.resetReplacementProgress(); + saveMachineAssignment(true); + } + + public void cancelMachineAssignmentReplacement() { + machineAssignmentSelection.setReplacementConfirmation(false); + } + + public void completeMachineAssignmentReplacement() { + finishMachineAssignmentUpdate(); + } + + public Item getSelectedMachineCurrentAssignment() { + ItemDomainMachineDesign machine = machineAssignmentSelection.getSelectedMachine(); + return machine == null ? null : machine.getAssignedItem(); + } + + public Item getSelectedMachineCurrentCatalog() { + return getCatalogItem(getSelectedMachineCurrentAssignment()); + } + + public Item getCurrentInventoryCatalog() { + return getCatalogItem(getCurrent()); + } + + public boolean isCurrentAssignedToMachine() { + return getAssignedMachine() != null; + } + + public boolean isSourceMachineReleaseRequired() { + ItemDomainMachineDesign sourceMachine = getAssignedMachine(); + ItemDomainMachineDesign destinationMachine = machineAssignmentSelection.getSelectedMachine(); + return sourceMachine != null && !sourceMachine.equals(destinationMachine); + } + + public void clearMachineAssignment() { + ItemDomainMachineDesign machine = getAssignedMachine(); + if (machine == null) { + SessionUtility.addInfoMessage("No update", "Inventory item is not assigned to a machine element."); + return; + } + if (!verifyMachineAssignmentPermission(machine)) { + return; + } + try { + logger.info("Clearing inventory {} from machine {}", getCurrent(), machine); + updateMachineAssignment(machine, getCatalogItem(machine.getAssignedItem()), null); + finishMachineAssignmentUpdate(); + } catch (CdbException | RuntimeException ex) { + logger.error("Could not clear inventory machine assignment", ex); + SessionUtility.addErrorMessage("Error", ex.getMessage()); + } + } + + private void saveMachineAssignment(boolean replacementConfirmed) { + ItemDomainMachineDesign machine = machineAssignmentSelection.getSelectedMachine(); + if (machine == null) { + SessionUtility.addErrorMessage("Invalid Selection", "Select a machine element to continue."); + return; + } + if (!verifyMachineAssignmentPermission(machine)) { + return; + } + if (!replacementConfirmed + && requiresCatalogReplacementConfirmation(machine)) { + machineAssignmentSelection.setReplacementConfirmation(true); + SessionUtility.executeRemoteCommand("showMachineAssignmentReplacementConfirmDialog()"); + return; + } + + ItemDomainMachineDesign previousMachine = getAssignedMachine(); + if (previousMachine != null && !previousMachine.equals(machine) + && !verifyMachineAssignmentPermission(previousMachine)) { + return; + } + + boolean previousMachineCleared = false; + boolean previousMachineInstalled = previousMachine != null && previousMachine.isIsHoused(); + try { + if (replacementConfirmed) { + logger.info("Replacing catalog assignment on destination machine {}", machine); + updateMachineAssignment(machine, getCurrentInventoryCatalog(), null); + machineAssignmentSelection.setDestinationPrepared(true); + SessionUtility.addInfoMessage("Machine Assignment", "Updated destination machine catalog assignment."); + } + if (previousMachine != null && !previousMachine.equals(machine)) { + logger.info("Releasing inventory {} from source machine {}", getCurrent(), previousMachine); + updateMachineAssignment(previousMachine, + getCatalogItem(previousMachine.getAssignedItem()), null); + previousMachineCleared = true; + machineAssignmentSelection.setSourceReleased(true); + SessionUtility.addInfoMessage("Machine Assignment", "Released inventory from source machine element."); + reloadCurrent(); + } + logger.info("Assigning inventory {} to destination machine {}", getCurrent(), machine); + updateMachineAssignment(machine, getCurrent(), + machineAssignmentSelection.isInstalled()); + machineAssignmentSelection.setInventoryAssigned(true); + SessionUtility.addInfoMessage("Machine Assignment", "Assigned inventory to destination machine element."); + if (replacementConfirmed) { + ItemDomainMachineDesignController.getInstance().resetListDataModel(); + reloadCurrent(); + } else { + finishMachineAssignmentUpdate(); + } + } catch (CdbException | RuntimeException ex) { + logger.error("Could not update inventory machine assignment", ex); + machineAssignmentSelection.setReplacementError(ex.getMessage()); + if (previousMachineCleared) { + restoreMachineAssignment(previousMachine, previousMachineInstalled); + } + if (!replacementConfirmed) { + SessionUtility.addErrorMessage("Error", ex.getMessage()); + } + } + } + + private boolean verifyMachineAssignmentPermission(ItemDomainMachineDesign machine) { + UserInfo user = SessionUtility.getUser(); + boolean permitted = user != null && (SessionUtility.getRole() == CdbRole.ADMIN + || (AuthorizationUtility.isEntityWriteableByUser(getCurrent(), user) + && AuthorizationUtility.isEntityWriteableByUser(machine, user))); + if (!permitted) { + SessionUtility.addErrorMessage("Error", "Write permission is required for both the inventory item and machine element."); + } + return permitted; + } + + private void restoreMachineAssignment(ItemDomainMachineDesign machine, boolean installed) { + try { + updateMachineAssignment(machine, getCurrent(), installed); + } catch (CdbException | RuntimeException ex) { + logger.error("Could not restore previous inventory machine assignment", ex); + SessionUtility.addErrorMessage("Error", "The previous machine assignment could not be restored."); + } + } + + protected void updateMachineAssignment(ItemDomainMachineDesign machine, Item assignment, + Boolean installed) throws CdbException { + ItemDomainMachineDesignBaseControllerUtility utility = machine.getItemControllerUtility(); + utility.updateAssignedItem(machine, assignment, SessionUtility.getUser(), installed); + utility.update(machine, SessionUtility.getUser()); + } + + protected ItemDomainMachineDesign getAssignedMachine() { + for (ItemElement element : getCurrent().getItemElementMemberList2()) { + Item parent = element.getParentItem(); + if (parent instanceof ItemDomainMachineDesign) { + ItemDomainMachineDesign machine = (ItemDomainMachineDesign) parent; + if (getCurrent().equals(machine.getAssignedItem())) { + return machine; + } + } + } + return null; + } + + protected Item getCatalogItem(Item item) { + return item instanceof ItemDomainInventory ? item.getDerivedFromItem() : item; + } + + protected boolean requiresCatalogReplacementConfirmation(ItemDomainMachineDesign machine) { + Item assignment = machine.getAssignedItem(); + if (assignment == null || assignment.equals(getCurrent())) { + return false; + } + Item assignedCatalog = getCatalogItem(assignment); + return assignedCatalog == null || !assignedCatalog.equals(getCurrentInventoryCatalog()); + } + + protected void finishMachineAssignmentUpdate() { + ItemDomainMachineDesignController.getInstance().resetListDataModel(); + resetMachineAssignmentState(); + reloadCurrent(); + SessionUtility.executeRemoteCommand("machineAssignmentUpdateSuccess()"); + } + + public void resetMachineAssignmentState() { + machineAssignmentSelection.reset(); + } + @Override protected ItemDomainInventoryFacade getEntityDbFacade() { return itemDomainInventoryFacade; diff --git a/src/java/CdbWebPortal/src/java/gov/anl/aps/cdb/portal/controllers/ItemDomainMachineDesignIOCController.java b/src/java/CdbWebPortal/src/java/gov/anl/aps/cdb/portal/controllers/ItemDomainMachineDesignIOCController.java index 02f07754a..4bdd144a9 100644 --- a/src/java/CdbWebPortal/src/java/gov/anl/aps/cdb/portal/controllers/ItemDomainMachineDesignIOCController.java +++ b/src/java/CdbWebPortal/src/java/gov/anl/aps/cdb/portal/controllers/ItemDomainMachineDesignIOCController.java @@ -5,6 +5,7 @@ package gov.anl.aps.cdb.portal.controllers; import gov.anl.aps.cdb.common.exceptions.CdbException; +import gov.anl.aps.cdb.portal.view.objects.MachineDesignTreeSelection; import gov.anl.aps.cdb.portal.controllers.settings.ItemDomainMachineDesignIOCSettings; import gov.anl.aps.cdb.portal.controllers.utilities.ItemDomainMachineDesignIOCControllerUtility; import gov.anl.aps.cdb.portal.controllers.utilities.ItemElementControllerUtility; @@ -47,8 +48,7 @@ public class ItemDomainMachineDesignIOCController extends ItemDomainMachineDesig + "2. Power cycling may interrupt system communications temporarily\n" + "3. Verify all dependent systems are in safe state before proceeding"; - private ItemDomainMachineDesignTreeNode parentMachineSelectionTreeNode; - private ItemDomainMachineDesignTreeNode parentMachineSelectedTreeNode = null; + private final MachineDesignTreeSelection parentMachineSelection = new MachineDesignTreeSelection(); public static ItemDomainMachineDesignIOCController getInstance() { return (ItemDomainMachineDesignIOCController) SessionUtility.findBean(CONTROLLER_NAMED); @@ -136,20 +136,27 @@ public boolean getDisplayCreatedFromTemplateForCurrent() { @Override public String prepareClone(ItemDomainMachineDesign entity) { - // Reset variables - parentMachineSelectionTreeNode = null; + parentMachineSelection.reset(); return super.prepareClone(entity); } @Override public String prepareCreate() { - // Reset variables - parentMachineSelectionTreeNode = null; + parentMachineSelection.reset(); return super.prepareCreate(); } + public void prepareMachineParentSelection() { + ItemDomainMachineDesign current = getCurrent(); + // Unsaved items use the parent selected in the UI because no relationship exists yet. + ItemDomainMachineDesign parentMachine = current.getId() == null + ? current.getParentMachineDesignPlaceholder() + : current.getParentMachineDesign(); + parentMachineSelection.selectMachine(parentMachine); + } + public String clearMachineParent() { ItemDomainMachineDesign current = getCurrent(); UserInfo user = SessionUtility.getUser(); @@ -202,33 +209,18 @@ private void prepareSetParentMachineAttributes() { } public ItemDomainMachineDesignTreeNode getParentMachineSelectionTreeNode() { - if (parentMachineSelectionTreeNode == null) { - ItemDomainMachineDesignController instance = ItemDomainMachineDesignController.getInstance(); - parentMachineSelectionTreeNode = instance.loadMachineDesignRootTreeNode(); - - } - return parentMachineSelectionTreeNode; + return parentMachineSelection.getTree(); } public ItemDomainMachineDesignTreeNode getParentMachineSelectedTreeNode() { - return parentMachineSelectedTreeNode; + return parentMachineSelection.getSelectedNode(); } - public void setParentMachineSelectedTreeNode(ItemDomainMachineDesignTreeNode parentMachineSelectedTreeNode) { - this.parentMachineSelectedTreeNode = parentMachineSelectedTreeNode; - - if (parentMachineSelectedTreeNode != null) { - ItemElement machineElement = (ItemElement) parentMachineSelectedTreeNode.getData(); - - if (machineElement.getId() == null) { - return; - } - - ItemDomainMachineDesign current = getCurrent(); - ItemDomainMachineDesign parentItem = (ItemDomainMachineDesign) machineElement.getContainedItem(); - - current.setParentMachineDesignPlaceholder(parentItem); - + public void setParentMachineSelectedTreeNode(ItemDomainMachineDesignTreeNode selectedNode) { + parentMachineSelection.setSelectedNode(selectedNode); + ItemDomainMachineDesign selectedMachine = parentMachineSelection.getSelectedMachine(); + if (selectedMachine != null) { + getCurrent().setParentMachineDesignPlaceholder(selectedMachine); } } diff --git a/src/java/CdbWebPortal/src/java/gov/anl/aps/cdb/portal/view/objects/InventoryMachineAssignmentSelection.java b/src/java/CdbWebPortal/src/java/gov/anl/aps/cdb/portal/view/objects/InventoryMachineAssignmentSelection.java new file mode 100644 index 000000000..feead7ac6 --- /dev/null +++ b/src/java/CdbWebPortal/src/java/gov/anl/aps/cdb/portal/view/objects/InventoryMachineAssignmentSelection.java @@ -0,0 +1,81 @@ +/* + * Copyright (c) UChicago Argonne, LLC. All rights reserved. + * See LICENSE file. + */ +package gov.anl.aps.cdb.portal.view.objects; + +/** + * Inventory-specific state layered on reusable machine-tree selection. + */ +public class InventoryMachineAssignmentSelection extends MachineDesignTreeSelection { + + private boolean installed = true; + private boolean replacementConfirmation; + private boolean destinationPrepared; + private boolean sourceReleased; + private boolean inventoryAssigned; + private String replacementError; + + public boolean isInstalled() { + return installed; + } + + public void setInstalled(boolean installed) { + this.installed = installed; + } + + public boolean isReplacementConfirmation() { + return replacementConfirmation; + } + + public void setReplacementConfirmation(boolean replacementConfirmation) { + this.replacementConfirmation = replacementConfirmation; + } + + public boolean isDestinationPrepared() { + return destinationPrepared; + } + + public void setDestinationPrepared(boolean destinationPrepared) { + this.destinationPrepared = destinationPrepared; + } + + public boolean isSourceReleased() { + return sourceReleased; + } + + public void setSourceReleased(boolean sourceReleased) { + this.sourceReleased = sourceReleased; + } + + public boolean isInventoryAssigned() { + return inventoryAssigned; + } + + public void setInventoryAssigned(boolean inventoryAssigned) { + this.inventoryAssigned = inventoryAssigned; + } + + public String getReplacementError() { + return replacementError; + } + + public void setReplacementError(String replacementError) { + this.replacementError = replacementError; + } + + public void resetReplacementProgress() { + destinationPrepared = false; + sourceReleased = false; + inventoryAssigned = false; + replacementError = null; + } + + @Override + public void reset() { + super.reset(); + installed = true; + replacementConfirmation = false; + resetReplacementProgress(); + } +} diff --git a/src/java/CdbWebPortal/src/java/gov/anl/aps/cdb/portal/view/objects/MachineDesignTreeSelection.java b/src/java/CdbWebPortal/src/java/gov/anl/aps/cdb/portal/view/objects/MachineDesignTreeSelection.java new file mode 100644 index 000000000..f6427af3e --- /dev/null +++ b/src/java/CdbWebPortal/src/java/gov/anl/aps/cdb/portal/view/objects/MachineDesignTreeSelection.java @@ -0,0 +1,60 @@ +/* + * Copyright (c) UChicago Argonne, LLC. All rights reserved. + * See LICENSE file. + */ +package gov.anl.aps.cdb.portal.view.objects; + +import gov.anl.aps.cdb.portal.controllers.ItemDomainMachineDesignController; +import gov.anl.aps.cdb.portal.model.ItemDomainMachineDesignTreeNode; +import gov.anl.aps.cdb.portal.model.db.entities.Item; +import gov.anl.aps.cdb.portal.model.db.entities.ItemDomainMachineDesign; +import gov.anl.aps.cdb.portal.model.db.entities.ItemElement; + +/** + * Reusable state for selecting one item from the machine-design tree. + */ +public class MachineDesignTreeSelection { + + private ItemDomainMachineDesignTreeNode tree; + private ItemDomainMachineDesignTreeNode selectedNode; + + public ItemDomainMachineDesignTreeNode getTree() { + if (tree == null) { + tree = ItemDomainMachineDesignController.getInstance().loadMachineDesignRootTreeNode(); + } + return tree; + } + + public ItemDomainMachineDesignTreeNode getSelectedNode() { + return selectedNode; + } + + public void setSelectedNode(ItemDomainMachineDesignTreeNode selectedNode) { + this.selectedNode = selectedNode; + } + + public void selectMachine(ItemDomainMachineDesign machine) { + reset(); + if (machine != null) { + selectedNode = (ItemDomainMachineDesignTreeNode) + ItemDomainMachineDesignController.expandToSpecificMachineDesignItem(getTree(), machine); + if (selectedNode != null) { + selectedNode.setSelected(true); + } + } + } + + public ItemDomainMachineDesign getSelectedMachine() { + if (selectedNode == null || selectedNode.getData() == null) { + return null; + } + ItemElement element = (ItemElement) selectedNode.getData(); + Item item = element.getContainedItem(); + return item instanceof ItemDomainMachineDesign ? (ItemDomainMachineDesign) item : null; + } + + public void reset() { + tree = null; + selectedNode = null; + } +} diff --git a/src/java/CdbWebPortal/web/views/itemDomainInventory/private/componentInventoryViewPanelGrid.xhtml b/src/java/CdbWebPortal/web/views/itemDomainInventory/private/componentInventoryViewPanelGrid.xhtml index 90ee1acd7..cc50387c2 100644 --- a/src/java/CdbWebPortal/web/views/itemDomainInventory/private/componentInventoryViewPanelGrid.xhtml +++ b/src/java/CdbWebPortal/web/views/itemDomainInventory/private/componentInventoryViewPanelGrid.xhtml @@ -14,7 +14,16 @@ See LICENSE file. - + + + + + + + diff --git a/src/java/CdbWebPortal/web/views/itemDomainInventory/private/itemDomainInventoryMachineAssignmentDialog.xhtml b/src/java/CdbWebPortal/web/views/itemDomainInventory/private/itemDomainInventoryMachineAssignmentDialog.xhtml new file mode 100644 index 000000000..2511a1f76 --- /dev/null +++ b/src/java/CdbWebPortal/web/views/itemDomainInventory/private/itemDomainInventoryMachineAssignmentDialog.xhtml @@ -0,0 +1,61 @@ + + + + + + + + + + + + Installed items use the machine location. Planned items retain their current location. + + + + + + + + + + + + + + + + + diff --git a/src/java/CdbWebPortal/web/views/itemDomainInventory/private/itemDomainInventoryMachineAssignmentReplacementConfirmDialog.xhtml b/src/java/CdbWebPortal/web/views/itemDomainInventory/private/itemDomainInventoryMachineAssignmentReplacementConfirmDialog.xhtml new file mode 100644 index 000000000..490399f69 --- /dev/null +++ b/src/java/CdbWebPortal/web/views/itemDomainInventory/private/itemDomainInventoryMachineAssignmentReplacementConfirmDialog.xhtml @@ -0,0 +1,68 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/src/java/CdbWebPortal/web/views/itemDomainInventory/private/itemDomainInventoryMachineAssignmentTree.xhtml b/src/java/CdbWebPortal/web/views/itemDomainInventory/private/itemDomainInventoryMachineAssignmentTree.xhtml new file mode 100644 index 000000000..44c252a6b --- /dev/null +++ b/src/java/CdbWebPortal/web/views/itemDomainInventory/private/itemDomainInventoryMachineAssignmentTree.xhtml @@ -0,0 +1,20 @@ + + + + + + + + + + + + + + + diff --git a/src/java/CdbWebPortal/web/views/itemDomainInventory/view.xhtml b/src/java/CdbWebPortal/web/views/itemDomainInventory/view.xhtml index ecce1347f..74ee3ac6c 100644 --- a/src/java/CdbWebPortal/web/views/itemDomainInventory/view.xhtml +++ b/src/java/CdbWebPortal/web/views/itemDomainInventory/view.xhtml @@ -65,6 +65,7 @@ See LICENSE file. + diff --git a/src/java/CdbWebPortal/web/views/itemDomainMachineDesignBase/private/itemDomainMachineDesignTreeSelection.xhtml b/src/java/CdbWebPortal/web/views/itemDomainMachineDesignBase/private/itemDomainMachineDesignTreeSelection.xhtml new file mode 100644 index 000000000..f28e2f6b4 --- /dev/null +++ b/src/java/CdbWebPortal/web/views/itemDomainMachineDesignBase/private/itemDomainMachineDesignTreeSelection.xhtml @@ -0,0 +1,50 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/src/java/CdbWebPortal/web/views/itemDomainMachineDesignBase/private/templates/itemDomainMachineDesignListObjectTemplate.xhtml b/src/java/CdbWebPortal/web/views/itemDomainMachineDesignBase/private/templates/itemDomainMachineDesignListObjectTemplate.xhtml index 8599216df..74d0bb9e5 100644 --- a/src/java/CdbWebPortal/web/views/itemDomainMachineDesignBase/private/templates/itemDomainMachineDesignListObjectTemplate.xhtml +++ b/src/java/CdbWebPortal/web/views/itemDomainMachineDesignBase/private/templates/itemDomainMachineDesignListObjectTemplate.xhtml @@ -30,6 +30,11 @@ See LICENSE file. + + @@ -209,8 +214,7 @@ See LICENSE file. value="#{mdTreeListObject != null ? mdTreeListObject.assignedItem : itemTreeListObject}"/> diff --git a/src/java/CdbWebPortal/web/views/itemDomainMachineDesignIOC/create.xhtml b/src/java/CdbWebPortal/web/views/itemDomainMachineDesignIOC/create.xhtml index 19959d4a9..8973dbc56 100644 --- a/src/java/CdbWebPortal/web/views/itemDomainMachineDesignIOC/create.xhtml +++ b/src/java/CdbWebPortal/web/views/itemDomainMachineDesignIOC/create.xhtml @@ -28,7 +28,10 @@ See LICENSE file. - + diff --git a/src/java/CdbWebPortal/web/views/itemDomainMachineDesignIOC/private/iocMachineParentSelectionTree.xhtml b/src/java/CdbWebPortal/web/views/itemDomainMachineDesignIOC/private/iocMachineParentSelectionTree.xhtml index e70a487e4..15b801683 100644 --- a/src/java/CdbWebPortal/web/views/itemDomainMachineDesignIOC/private/iocMachineParentSelectionTree.xhtml +++ b/src/java/CdbWebPortal/web/views/itemDomainMachineDesignIOC/private/iocMachineParentSelectionTree.xhtml @@ -5,35 +5,10 @@ See LICENSE file. --> - - - - - - - - - - - - - - - - - - - - - - - - - + xmlns:ui="http://java.sun.com/jsf/facelets"> + + + + + - - diff --git a/src/java/CdbWebPortal/web/views/itemDomainMachineDesignIOC/view.xhtml b/src/java/CdbWebPortal/web/views/itemDomainMachineDesignIOC/view.xhtml index c4ed6337b..228510b3b 100644 --- a/src/java/CdbWebPortal/web/views/itemDomainMachineDesignIOC/view.xhtml +++ b/src/java/CdbWebPortal/web/views/itemDomainMachineDesignIOC/view.xhtml @@ -35,7 +35,9 @@ See LICENSE file. + action="#{itemDomainMachineDesignIOCController.prepareMachineParentSelection()}" + update="@form:iocMachineParentSelectionDialog" + oncomplete="PF('iocMachineParentSelectionDialogWidget').show(); scrollMachineSelectionToSelectedcreateIocMachineSelectionDialog()"/> diff --git a/src/java/CdbWebPortal/web/views/locatableItem/private/locatableItemListLocationObject.xhtml b/src/java/CdbWebPortal/web/views/locatableItem/private/locatableItemListLocationObject.xhtml index acad52844..54b1bae96 100644 --- a/src/java/CdbWebPortal/web/views/locatableItem/private/locatableItemListLocationObject.xhtml +++ b/src/java/CdbWebPortal/web/views/locatableItem/private/locatableItemListLocationObject.xhtml @@ -46,9 +46,13 @@ See LICENSE file. + + - + rendered="#{rendredHousing}" + filterBy="#{housingItem.name}" + filterable="#{filterable}" + filterMatchMode="contains">
- - - - + + + + + + + + + diff --git a/tools/developer_tools/code_testing/CdbWebPortalTest/pom.xml b/tools/developer_tools/code_testing/CdbWebPortalTest/pom.xml index 2dae21c89..9545f919f 100644 --- a/tools/developer_tools/code_testing/CdbWebPortalTest/pom.xml +++ b/tools/developer_tools/code_testing/CdbWebPortalTest/pom.xml @@ -69,7 +69,7 @@ junit junit - 4.13.1 + 4.13.2 test @@ -85,37 +85,37 @@ org.apache.logging.log4j log4j-core - 2.17.1 + 2.26.0 org.apache.logging.log4j log4j-api - 2.17.1 + 2.26.0 com.google.code.gson gson - 2.8.9 + 2.10.1 org.primefaces primefaces - 11.0.0-RC2 + 11.0.0 org.primefaces.extensions primefaces-extensions - 11.0.0-RC1 + 11.0.0 com.itextpdf itextpdf - 5.5.13.3 + 5.5.13.1 org.apache.commons commons-lang3 - 3.5 + 3.11 org.apache.pdfbox @@ -123,14 +123,9 @@ 2.0.24 - org.apache.pdfbox - pdfbox - 2.0.24 - - - mysql - mysql-connector-java - 8.0.16 + org.mariadb.jdbc + mariadb-java-client + 3.1.0 org.eclipse.persistence @@ -165,33 +160,41 @@ com.fasterxml.jackson.core jackson-annotations - 2.9.9 - jar + 2.19.4 + + + com.fasterxml.jackson.core + jackson-databind + 2.19.4 io.swagger.core.v3 swagger-annotations - 2.0.8 + 2.2.52 jar org.glassfish.jersey.media jersey-media-json-jackson - 2.29 + 2.28 jar io.swagger.core.v3 swagger-jaxrs2 - 2.0.8 + 2.2.52 jar com.drewnoakes metadata-extractor 2.17.0 - jar - + + + com.vladsch.flexmark + flexmark + 0.64.8 + com.hazelcast @@ -248,13 +251,6 @@ 1.1 test - - fish.payara.extras - payara-embedded-all - 5.194 - provided - - fish.payara.extras payara-embedded-all diff --git a/tools/developer_tools/code_testing/CdbWebPortalTest/preparebuild.sh b/tools/developer_tools/code_testing/CdbWebPortalTest/preparebuild.sh old mode 100644 new mode 100755 index 2a59a87e6..df11e4012 --- a/tools/developer_tools/code_testing/CdbWebPortalTest/preparebuild.sh +++ b/tools/developer_tools/code_testing/CdbWebPortalTest/preparebuild.sh @@ -1,4 +1,27 @@ -#!/bin/sh +#!/bin/bash -source ../../../../setup.sh -python ../../cdb_plugins/update_plugin_generated_files.py +set -eo pipefail + +TEST_DIR=$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd) +CDB_ROOT_DIR=$(cd "$TEST_DIR/../../../.." && pwd) +REGISTRAR_DIR="$CDB_ROOT_DIR/src/java/CdbWebPortal/src/java/gov/anl/aps/cdb/portal/plugins/support" +REGISTRAR_FILE="$REGISTRAR_DIR/PluginRegistrar.java" + +if [ -n "${CI:-}" ]; then + mkdir -p "$REGISTRAR_DIR" + cat > "$REGISTRAR_FILE" <<'EOF' +package gov.anl.aps.cdb.portal.plugins.support; + +import gov.anl.aps.cdb.portal.plugins.CdbPluginManager; + +public abstract class PluginRegistrar { + + public static void registerPlugins(CdbPluginManager cdbPluginManager) { + // No plugins are installed in CI. + } +} +EOF +else + source "$CDB_ROOT_DIR/setup.sh" + python "$CDB_ROOT_DIR/tools/developer_tools/cdb_plugins/update_plugin_generated_files.py" +fi diff --git a/tools/developer_tools/code_testing/CdbWebPortalTest/src/test/java/gov/anl/aps/cdb/portal/controllers/ItemDomainInventoryControllerTest.java b/tools/developer_tools/code_testing/CdbWebPortalTest/src/test/java/gov/anl/aps/cdb/portal/controllers/ItemDomainInventoryControllerTest.java new file mode 100644 index 000000000..420f8e64d --- /dev/null +++ b/tools/developer_tools/code_testing/CdbWebPortalTest/src/test/java/gov/anl/aps/cdb/portal/controllers/ItemDomainInventoryControllerTest.java @@ -0,0 +1,334 @@ +/* + * Copyright (c) UChicago Argonne, LLC. All rights reserved. + * See LICENSE file. + */ +package gov.anl.aps.cdb.portal.controllers; + +import gov.anl.aps.cdb.common.exceptions.CdbException; +import gov.anl.aps.cdb.portal.controllers.settings.ItemDomainInventorySettings; +import gov.anl.aps.cdb.portal.model.ItemDomainMachineDesignTreeNode; +import gov.anl.aps.cdb.portal.model.db.entities.ItemDomainCatalog; +import gov.anl.aps.cdb.portal.model.db.entities.ItemDomainInventory; +import gov.anl.aps.cdb.portal.model.db.entities.ItemDomainMachineDesign; +import gov.anl.aps.cdb.portal.model.db.entities.EntityInfo; +import gov.anl.aps.cdb.portal.model.db.entities.Item; +import gov.anl.aps.cdb.portal.model.db.entities.ItemElement; +import gov.anl.aps.cdb.portal.model.db.entities.UserInfo; +import gov.anl.aps.cdb.portal.utilities.SessionUtility; +import gov.anl.aps.cdb.portal.view.objects.InventoryMachineAssignmentSelection; +import java.util.ArrayList; +import java.util.Collections; +import org.junit.Before; +import org.junit.Test; +import static org.junit.Assert.*; + +public class ItemDomainInventoryControllerTest { + + private int nextMachineId; + private TestInventoryController controller; + private ItemDomainCatalog catalog; + private ItemDomainInventory inventory; + + @Before + public void setUp() { + nextMachineId = 100; + catalog = catalog(1); + inventory = inventory(catalog); + UserInfo user = user(1); + SessionUtility.reset(); + SessionUtility.setUser(user); + setOwner(inventory, user); + controller = new TestInventoryController(inventory); + } + + @Test + public void normalizesInventoryAssignmentsToCatalog() { + assertNull(controller.getCatalogItem(null)); + assertSame(catalog, controller.getCatalogItem(catalog)); + assertSame(catalog, controller.getCatalogItem(inventory)); + } + + @Test + public void requestsConfirmationOnlyForDifferentCatalogAssignment() { + ItemDomainMachineDesign destination = machine(); + + assertFalse(controller.requiresCatalogReplacementConfirmation(destination)); + + destination.setAssignedItem(inventory); + assertFalse(controller.requiresCatalogReplacementConfirmation(destination)); + + destination.setAssignedItem(inventory(catalog)); + assertFalse(controller.requiresCatalogReplacementConfirmation(destination)); + + destination.setAssignedItem(inventory(catalog(2))); + assertTrue(controller.requiresCatalogReplacementConfirmation(destination)); + } + + @Test + public void exposesSelectedDestinationAndAssignment() { + ItemDomainMachineDesign destination = machine(); + destination.setAssignedItem(inventory); + controller.setSelectedMachineAssignmentNode(node(destination)); + + assertSame(destination, controller.getMachineAssignmentSelection().getSelectedMachine()); + assertSame(inventory, controller.getSelectedMachineCurrentAssignment()); + assertSame(catalog, controller.getSelectedMachineCurrentCatalog()); + assertSame(catalog, controller.getCurrentInventoryCatalog()); + } + + @Test + public void identifiesSourceAndWhetherItMustBeReleased() { + assertFalse(controller.isCurrentAssignedToMachine()); + assertFalse(controller.isSourceMachineReleaseRequired()); + + ItemDomainMachineDesign source = house(inventory, true); + assertTrue(controller.isCurrentAssignedToMachine()); + + controller.setSelectedMachineAssignmentNode(node(source)); + assertFalse(controller.isSourceMachineReleaseRequired()); + + controller.setSelectedMachineAssignmentNode(node(machine())); + assertTrue(controller.isSourceMachineReleaseRequired()); + } + + @Test + public void prepareAssignmentRestoresPlannedSourceState() { + ItemDomainMachineDesign source = house(inventory, false); + + controller.prepareMachineAssignment(); + + assertSame(source, controller.getMachineAssignmentSelection().getSelectedMachine()); + assertFalse(controller.isMachineAssignmentInstalled()); + } + + @Test + public void rejectsAssignmentWithoutInventoryPermission() { + ItemDomainMachineDesign destination = machine(); + controller.setSelectedMachineAssignmentNode(node(destination)); + setOwner(inventory, user(2)); + + controller.saveMachineAssignment(); + + assertTrue(controller.updates.isEmpty()); + assertEquals("Write permission is required for both the inventory item and machine element.", SessionUtility.getErrorMessage()); + } + + @Test + public void rejectsAssignmentWithoutDestinationPermission() { + ItemDomainMachineDesign destination = machine(); + controller.setSelectedMachineAssignmentNode(node(destination)); + setOwner(destination, user(2)); + + controller.saveMachineAssignment(); + + assertTrue(controller.updates.isEmpty()); + assertEquals("Write permission is required for both the inventory item and machine element.", SessionUtility.getErrorMessage()); + } + + @Test + public void rejectsMoveWithoutSourcePermission() { + ItemDomainMachineDesign source = house(inventory, true); + ItemDomainMachineDesign destination = machine(); + controller.setSelectedMachineAssignmentNode(node(destination)); + setOwner(source, user(2)); + + controller.saveMachineAssignment(); + + assertTrue(controller.updates.isEmpty()); + assertEquals("Write permission is required for both the inventory item and machine element.", SessionUtility.getErrorMessage()); + } + + @Test + public void differentCatalogRequiresConfirmationBeforeUpdates() { + ItemDomainMachineDesign destination = machine(); + destination.setAssignedItem(inventory(catalog(2))); + controller.setSelectedMachineAssignmentNode(node(destination)); + + controller.saveMachineAssignment(); + + assertTrue(controller.isMachineAssignmentReplacementConfirmation()); + assertEquals("showMachineAssignmentReplacementConfirmDialog()", SessionUtility.getRemoteCommand()); + assertTrue(controller.updates.isEmpty()); + } + + @Test + public void clearAssignmentRestoresCatalogOnSource() { + ItemDomainMachineDesign source = house(inventory, true); + + controller.clearMachineAssignment(); + + assertEquals(1, controller.updates.size()); + assertUpdate(controller.updates.get(0), source, catalog, null); + assertTrue(controller.finished); + } + + @Test + public void clearWithNoHousingDoesNotUpdate() { + controller.clearMachineAssignment(); + + assertTrue(controller.updates.isEmpty()); + assertEquals("Inventory item is not assigned to a machine element.", SessionUtility.getInfoMessage()); + } + + @Test + public void movingInventoryReleasesSourceThenAssignsDestination() { + ItemDomainMachineDesign source = house(inventory, false); + ItemDomainMachineDesign destination = machine(); + destination.setAssignedItem(catalog); + controller.setSelectedMachineAssignmentNode(node(destination)); + controller.setMachineAssignmentInstalled(true); + + controller.saveMachineAssignment(); + + assertEquals(2, controller.updates.size()); + assertUpdate(controller.updates.get(0), source, catalog, null); + assertUpdate(controller.updates.get(1), destination, inventory, true); + assertTrue(controller.finished); + } + + @Test + public void tracksInstalledAndReplacementProgressAndResetsState() { + InventoryMachineAssignmentSelection selection = controller.getMachineAssignmentSelection(); + controller.setMachineAssignmentInstalled(false); + controller.setMachineAssignmentReplacementConfirmation(true); + selection.setDestinationPrepared(true); + selection.setSourceReleased(true); + selection.setInventoryAssigned(true); + selection.setReplacementError("failed"); + + assertFalse(controller.isMachineAssignmentInstalled()); + assertTrue(controller.isMachineAssignmentReplacementConfirmation()); + + controller.cancelMachineAssignmentReplacement(); + assertFalse(controller.isMachineAssignmentReplacementConfirmation()); + + controller.resetMachineAssignmentState(); + assertTrue(controller.isMachineAssignmentInstalled()); + assertNull(controller.getSelectedMachineAssignmentNode()); + assertFalse(selection.isDestinationPrepared()); + assertFalse(selection.isSourceReleased()); + assertFalse(selection.isInventoryAssigned()); + assertNull(selection.getReplacementError()); + } + + private static UserInfo user(int id) { + UserInfo user = new UserInfo(); + user.setId(id); + return user; + } + + private static void setOwner(Item item, UserInfo owner) { + EntityInfo entityInfo = new EntityInfo(); + entityInfo.setOwnerUser(owner); + item.setEntityInfo(entityInfo); + } + + private static ItemDomainCatalog catalog(int id) { + ItemDomainCatalog item = new ItemDomainCatalog(); + item.setId(id); + return item; + } + + private static ItemDomainInventory inventory(ItemDomainCatalog catalogItem) { + ItemDomainInventory item = new ItemDomainInventory(); + item.setCatalogItem(catalogItem); + item.setItemElementMemberList2(new ArrayList<>()); + ItemElement selfElement = new ItemElement(); + selfElement.setParentItem(item); + item.setFullItemElementList(Collections.singletonList(selfElement)); + return item; + } + + private ItemDomainMachineDesign machine() { + ItemDomainMachineDesign machine = new ItemDomainMachineDesign(); + machine.setId(nextMachineId++); + ItemElement selfElement = new ItemElement(); + selfElement.setParentItem(machine); + machine.setFullItemElementList(Collections.singletonList(selfElement)); + setOwner(machine, SessionUtility.getUser()); + return machine; + } + + private ItemDomainMachineDesign house(ItemDomainInventory item, boolean installed) { + ItemDomainMachineDesign machine = machine(); + machine.setAssignedItem(item); + machine.setIsHoused(installed); + ItemElement housing = new ItemElement(); + housing.setParentItem(machine); + item.appendItemElementMemberList2(housing); + return machine; + } + + private static void assertUpdate(Update update, ItemDomainMachineDesign machine, + Item assignment, Boolean installed) { + assertSame(machine, update.machine); + assertSame(assignment, update.assignment); + assertEquals(installed, update.installed); + } + + private static ItemDomainMachineDesignTreeNode node(ItemDomainMachineDesign machine) { + ItemElement element = new ItemElement(); + element.setContainedItem(machine); + ItemDomainMachineDesignTreeNode node = new ItemDomainMachineDesignTreeNode(); + node.setData(element); + return node; + } + + private static class TestInventoryController extends ItemDomainInventoryController { + + private final ItemDomainInventory current; + private final ArrayList updates = new ArrayList<>(); + private boolean finished; + + TestInventoryController(ItemDomainInventory current) { + this.current = current; + } + + @Override + protected ItemDomainInventorySettings createNewSettingObject() { + return null; + } + + @Override + public ItemDomainInventory getCurrent() { + return current; + } + + @Override + protected void selectMachineAssignment(ItemDomainMachineDesign machine) { + setSelectedMachineAssignmentNode(ItemDomainInventoryControllerTest.node(machine)); + } + + @Override + protected void updateMachineAssignment(ItemDomainMachineDesign machine, + Item assignment, Boolean installed) throws CdbException { + updates.add(new Update(machine, assignment, installed)); + machine.setAssignedItem(assignment); + if (installed != null) { + machine.setIsHoused(installed); + } + } + + @Override + public void reloadCurrent() { + } + + @Override + protected void finishMachineAssignmentUpdate() { + finished = true; + } + } + + private static class Update { + + private final ItemDomainMachineDesign machine; + private final Item assignment; + private final Boolean installed; + + Update(ItemDomainMachineDesign machine, Item assignment, Boolean installed) { + this.machine = machine; + this.assignment = assignment; + this.installed = installed; + } + } +} diff --git a/tools/developer_tools/code_testing/CdbWebPortalTest/src/test/java/gov/anl/aps/cdb/portal/utilities/SessionUtility.java b/tools/developer_tools/code_testing/CdbWebPortalTest/src/test/java/gov/anl/aps/cdb/portal/utilities/SessionUtility.java index b9673e98e..b5bff2942 100644 --- a/tools/developer_tools/code_testing/CdbWebPortalTest/src/test/java/gov/anl/aps/cdb/portal/utilities/SessionUtility.java +++ b/tools/developer_tools/code_testing/CdbWebPortalTest/src/test/java/gov/anl/aps/cdb/portal/utilities/SessionUtility.java @@ -4,20 +4,78 @@ */ package gov.anl.aps.cdb.portal.utilities; +import gov.anl.aps.cdb.common.constants.CdbRole; import gov.anl.aps.cdb.portal.model.db.entities.UserInfo; +/** Test session state without a JSF container. */ +public class SessionUtility { -/** - * Class overrides the session utility for test purposes. - * - * @author djarosz - */ -public class SessionUtility { - - private static UserInfo userInfo; - - public static Object getUser() { - return userInfo; - } - + private static UserInfo user; + private static Object role; + private static String errorMessage; + private static String infoMessage; + private static String remoteCommand; + + public static UserInfo getUser() { + return user; + } + + public static void setUser(UserInfo value) { + user = value; + } + + public static Object getRole() { + return role; + } + + public static void setRole(Object value) { + role = value; + } + + public static boolean runningFaces() { + return false; + } + + public static Object findFacade(String facadeName) { + return null; + } + + public static void addErrorMessage(String summary, String detail) { + errorMessage = detail; + } + + public static void addWarningMessage(String summary, String detail) { + } + + public static void addInfoMessage(String summary, String detail) { + infoMessage = detail; + } + + public static void executeRemoteCommand(String command) { + remoteCommand = command; + } + + public static void reset() { + user = null; + role = null; + errorMessage = null; + infoMessage = null; + remoteCommand = null; + } + + public static String getErrorMessage() { + return errorMessage; + } + + public static String getInfoMessage() { + return infoMessage; + } + + public static String getRemoteCommand() { + return remoteCommand; + } + + public static void setAdmin(boolean admin) { + role = admin ? CdbRole.ADMIN : null; + } } diff --git a/tools/developer_tools/portal_testing/PythonSeleniumTest/README.md b/tools/developer_tools/portal_testing/PythonSeleniumTest/README.md new file mode 100644 index 000000000..46ab8155d --- /dev/null +++ b/tools/developer_tools/portal_testing/PythonSeleniumTest/README.md @@ -0,0 +1,26 @@ +# CDB Portal Selenium Tests + +## Requirements + +- Python 3.10+ +- Chrome or Chromium +- `selenium` +- `pytest` +- `pytest-xdist` +- `pytest-rerunfailures` +- A running portal using the test database + +Install the Python dependencies in the Selenium Conda environment: + +```sh +python -m pip install selenium pytest pytest-xdist pytest-rerunfailures +``` + +## Run the full test suite + +From the repository root: + +```sh +source setup.sh +make test +``` diff --git a/tools/developer_tools/portal_testing/PythonSeleniumTest/cdbSeleniumModules/cdbSeleniumModuleBase.py b/tools/developer_tools/portal_testing/PythonSeleniumTest/cdbSeleniumModules/cdbSeleniumModuleBase.py index 905a91936..3dbe6e9c9 100644 --- a/tools/developer_tools/portal_testing/PythonSeleniumTest/cdbSeleniumModules/cdbSeleniumModuleBase.py +++ b/tools/developer_tools/portal_testing/PythonSeleniumTest/cdbSeleniumModules/cdbSeleniumModuleBase.py @@ -8,7 +8,7 @@ import time from selenium import webdriver -from selenium.common.exceptions import StaleElementReferenceException, NoSuchElementException +from selenium.common.exceptions import ElementClickInterceptedException, ElementNotInteractableException, NoSuchElementException, StaleElementReferenceException from selenium.webdriver import ActionChains from selenium.webdriver.support.wait import WebDriverWait from selenium.webdriver.support import expected_conditions as EC @@ -24,6 +24,8 @@ class CdbSeleniumModuleBase: WAIT_FOR_ELEMENT_TIMEOUT = 10 VISIBLE_ID_TIMEOUT = 10 + CLICK_RETRY_COUNT = 5 + CLICK_RETRY_DELAY = 0.1 LOADING_DIALOG_ID = 'loadingDialog' def __init__(self, driver): @@ -50,7 +52,10 @@ def _clear_notifications(self): action.move_to_element(growl_container) action.perform() time.sleep(.1) - growl_close.click() + try: + growl_close.click() + except ElementNotInteractableException: + self._click_using_javascript(growl_close) time.sleep(0.5) growl_container = next_growl @@ -89,15 +94,21 @@ def _find_by_xpath(self, xpath): return self.driver.find_element(by=By.XPATH, value=xpath) def _wait_for_id_and_click(self, id): - element = self._wait_for_id(id) - element.click() + for attempt in range(self.CLICK_RETRY_COUNT): + try: + element = self._wait_for_clickable_id(id) + element.click() + return + except (ElementClickInterceptedException, StaleElementReferenceException): + if attempt < self.CLICK_RETRY_COUNT - 1: + time.sleep(self.CLICK_RETRY_DELAY) + continue + raise def _wait_for_visible_id(self, id): return self._wait_for_visible(By.ID, id) def _wait_for_invisible_loading_dialog(self, timeout=VISIBLE_ID_TIMEOUT): - # Needs to be visible before checked for invisible - self._wait_for_visible_id(self.LOADING_DIALOG_ID) self._wait_for_invisible_by_id(self.LOADING_DIALOG_ID, timeout) def _wait_for_visible_xpath(self, xpath): @@ -288,14 +299,19 @@ def _export(self, form_name, result_file_name, test, has_levels=False): self._wait_for_clickable_id_with_stale_protection(download_button_id) self._click_on_id_with_stale_protection(download_button_id) - # Wait for download to complete - time.sleep(1) - test.verify_file_downloaded(result_file_name) + def _expand_panel(self, form_name, panel_id): + panel = self._wait_for_id('%s:%s' % (form_name, panel_id)) + content = panel.find_element(by=By.CSS_SELECTOR, value='.ui-panel-content') + if not content.is_displayed(): + self._click_on_id('%s:%s_toggler' % (form_name, panel_id)) + WebDriverWait(self.driver, CdbSeleniumModuleBase.WAIT_FOR_ELEMENT_TIMEOUT).until( + lambda driver: content.is_displayed()) + def _add_log_to_item(self, form_name, entity_name, log_entry, needs_toggler=True): if needs_toggler: - self._click_on_id('%s:%sViewLogEntriesPanel_toggler' % (form_name, entity_name)) + self._expand_panel(form_name, '%sViewLogEntriesPanel' % entity_name) self._wait_for_id_and_click('%s:%sLogAddButton' % (form_name, entity_name)) logEntry = self._wait_for_id('%s:logEntryValue' % form_name) @@ -307,12 +323,11 @@ def _add_log_to_item(self, form_name, entity_name, log_entry, needs_toggler=True def _add_property_to_item(self, test, form_name, entity_name, prop_value_text, needs_toggler=True): if needs_toggler: - toggle_id = '%s:%sViewPropertiesPanel_toggler' % (form_name, entity_name) - self._click_on_id(toggle_id) + self._expand_panel(form_name, '%sViewPropertiesPanel' % entity_name) add_btn_id = '%s:%sPropertyAddButton' % (form_name, entity_name) self._wait_for_id_and_click(add_btn_id) - categorySelectionXpath = "//div[@id='%s:filterViewItemCategorySelection']/div[2]/ul/li" % form_name + categorySelectionXpath = "//*[@id='%s:filterViewItemCategorySelection']//li[1]" % form_name categorySel = self._wait_for_visible_xpath(categorySelectionXpath) categorySel.click() @@ -339,8 +354,7 @@ def _add_property_to_item(self, test, form_name, entity_name, prop_value_text, n def _add_image_to_item(self, form_name, entity_name, sample_file_name='AnlLogo.png', needs_toggler=True): if needs_toggler: - toggle_id = "%s:%sViewGalleryPanel_toggler" % (form_name, entity_name) - self._click_on_id(toggle_id) + self._expand_panel(form_name, '%sViewGalleryPanel' % entity_name) add_btn_id = "%s:%sPropertyAddImagesCommandButton" % (form_name, entity_name) self._wait_for_id_and_click(add_btn_id) diff --git a/tools/developer_tools/portal_testing/PythonSeleniumTest/cdbSeleniumModules/connector_type.py b/tools/developer_tools/portal_testing/PythonSeleniumTest/cdbSeleniumModules/connector_type.py index fb8fc35c8..03dce7066 100644 --- a/tools/developer_tools/portal_testing/PythonSeleniumTest/cdbSeleniumModules/connector_type.py +++ b/tools/developer_tools/portal_testing/PythonSeleniumTest/cdbSeleniumModules/connector_type.py @@ -19,7 +19,8 @@ def navigate_to_connector_type_list(self): def test_connector_type_pages(self): dataTableXpathFormula = '//*[@id="%s:%sListDataTable_data"]/tr[1]/td[%d]/a' - self._click_on_xpath(dataTableXpathFormula % (self.LIST_FORM_NAME, self.ENTITY_TYPE_NAME, self.COLUMN_IDX)) + self._click_on_x_path_with_stale_protection( + dataTableXpathFormula % (self.LIST_FORM_NAME, self.ENTITY_TYPE_NAME, self.COLUMN_IDX)) self._wait_for_url_contains('%s/view' % self.VIEW_BASE_NAME) self._click_on_id('%s:%sViewEditButton' % (self.VIEW_FORM_NAME, self.ENTITY_TYPE_NAME)) diff --git a/tools/developer_tools/portal_testing/PythonSeleniumTest/cdbSeleniumModules/inventory.py b/tools/developer_tools/portal_testing/PythonSeleniumTest/cdbSeleniumModules/inventory.py index 2109243f2..bde6b77f9 100644 --- a/tools/developer_tools/portal_testing/PythonSeleniumTest/cdbSeleniumModules/inventory.py +++ b/tools/developer_tools/portal_testing/PythonSeleniumTest/cdbSeleniumModules/inventory.py @@ -1,3 +1,5 @@ +from selenium.webdriver.common.by import By + from cdbSeleniumModules.itemBase import ItemBase @@ -16,10 +18,19 @@ class Inventory(ItemBase): IMPORT_FILE_NAME = "Inventory Import.xlsx" + ASSIGNMENT_DIALOG_ID = VIEW_FORM_NAME + ':machineAssignmentDialog' + ASSIGNMENT_TREE_ID = VIEW_FORM_NAME + ':itemMachineDesignListDataTableinventoryMachineAssignment' + REPLACEMENT_DIALOG_ID = VIEW_FORM_NAME + ':machineAssignmentReplacementConfirmDialog' + + TEST_MACHINE = ['Test Machine'] + TEST_MACHINE_COMPONENT_1 = ['Test Machine', 'Component 1'] + TEST_MACHINE_COMPONENT_2 = ['Test Machine', 'Another Needed Component'] + TEST_REPLACEMENT_DESTINATION = ['Another Top Level', 'Inventory Assignment Test Destination'] + def navigate_to_inventory_list(self): self._navigate_to_dropdown('inventoryDropdownButton', 'componentInstanceButton', '%s/list' % self.VIEW_BASE_NAME) - def test_inventory_pages(self): + def test_inventory_pages(self): self._click_on_xpath(self.DATA_TABLE_XPATH_FORMULA % (self.LIST_FORM_NAME, self.ENTITY_TYPE_NAME, self.COLUMN_IDX)) self._wait_for_url_contains('%s/view' % self.VIEW_BASE_NAME) @@ -29,7 +40,7 @@ def test_inventory_pages(self): self._click_on_id('%s:%sEditViewButton' % (self.EDIT_FORM_NAME, self.ENTITY_TYPE_NAME)) self._wait_for_url_contains('%s/view' % self.VIEW_BASE_NAME) - def test_inventory_detail_page(self, test): + def test_inventory_detail_page(self, test): self._click_on_xpath(self.DATA_TABLE_XPATH_FORMULA % (self.LIST_FORM_NAME, self.ENTITY_TYPE_NAME, self.COLUMN_IDX)) self._wait_for_url_contains('%s/view' % self.VIEW_BASE_NAME) @@ -37,9 +48,121 @@ def test_inventory_detail_page(self, test): self._clear_notifications() self._add_property_to_item(test, self.VIEW_FORM_NAME, self.ENTITY_TYPE_NAME, "Inventory Property.") self._add_image_to_item(self.VIEW_FORM_NAME, self.ENTITY_TYPE_NAME) - + + def test_machine_assignment_acceptance(self, test): + """Acceptance coverage for inventory-side machine assignment.""" + self._open_inventory_by_id(41) + + # Selection and Installed/Planned state are available from Housing edit. + self._open_machine_assignment() + test.assertTrue(self._wait_for_visible_id(self.ASSIGNMENT_DIALOG_ID).is_displayed()) + install_button = self._wait_for_id(self.VIEW_FORM_NAME + ':machineAssignmentInstalled') + test.assertIn('Installed', install_button.text) + + # Select an empty destination and save as Planned; persistence/view refresh + # are verified by reopening the dialog and checking its restored state. + self._select_machine(self.TEST_MACHINE_COMPONENT_1) + install_button.click() + save_button = self._wait_for_xpath( + "//*[@id='%s:machineAssignmentDialogFooter']//button[span[text()='Save']]" % self.VIEW_FORM_NAME) + save_button.click() + self._wait_for_invisible_by_id(self.ASSIGNMENT_DIALOG_ID) + self._open_machine_assignment() + selected = self._wait_for_xpath( + "//*[@id='%s']//tr[@aria-selected='true']" % self.ASSIGNMENT_TREE_ID) + test.assertIn(self.TEST_MACHINE_COMPONENT_1[-1], selected.text) + test.assertIn('Planned', self._wait_for_id(self.VIEW_FORM_NAME + ':machineAssignmentInstalled').text) + + # Moving to another destination releases the source assignment first. + self._select_machine(self.TEST_MACHINE_COMPONENT_2) + save_button = self._wait_for_xpath( + "//*[@id='%s:machineAssignmentDialogFooter']//button[span[text()='Save']]" % self.VIEW_FORM_NAME) + save_button.click() + self._wait_for_invisible_by_id(self.ASSIGNMENT_DIALOG_ID) + self._open_machine_assignment() + selected = self._wait_for_xpath( + "//*[@id='%s']//tr[@aria-selected='true']" % self.ASSIGNMENT_TREE_ID) + test.assertIn(self.TEST_MACHINE_COMPONENT_2[-1], selected.text) + + # Clear swaps inventory for its catalog and removes Housing assignment. + clear_button = self._wait_for_xpath( + "//*[@id='%s:machineAssignmentDialogFooter']//button[span[text()='Clear']]" % self.VIEW_FORM_NAME) + clear_button.click() + self._wait_for_invisible_by_id(self.ASSIGNMENT_DIALOG_ID) + self._open_machine_assignment() + test.assertFalse(self._has_selected_machine()) + + # Different-catalog destination requires confirmation and completes all steps. + self._select_machine(self.TEST_REPLACEMENT_DESTINATION) + save_button = self._wait_for_xpath( + "//*[@id='%s:machineAssignmentDialogFooter']//button[span[text()='Save']]" % self.VIEW_FORM_NAME) + save_button.click() + confirm_dialog = self._wait_for_visible_id(self.REPLACEMENT_DIALOG_ID) + test.assertTrue(confirm_dialog.is_displayed()) + test.assertIn('Clear destination assignment and update catalog', confirm_dialog.text) + test.assertIn('Assign inventory to destination machine element', confirm_dialog.text) + + self._click_on_xpath( + "//*[@id='%s']//button[span[text()='Clear Destination and Assign']]" % self.REPLACEMENT_DIALOG_ID) + done_button = self._wait_for_clickable_xpath( + "//*[@id='%s']//button[span[text()='Done']]" % self.REPLACEMENT_DIALOG_ID) + completed_icons = self.driver.find_elements( + By.CSS_SELECTOR, '#%s .fa-check-square-o' % self.REPLACEMENT_DIALOG_ID.replace(':', '\\:')) + test.assertEqual(2, len(completed_icons), 'Destination preparation and assignment should complete') + done_button.click() + self._wait_for_invisible_by_id(self.ASSIGNMENT_DIALOG_ID) + + # Reopen to verify replacement persistence, then clear for test cleanup. + self._open_machine_assignment() + selected = self._wait_for_xpath( + "//*[@id='%s']//tr[@aria-selected='true']" % self.ASSIGNMENT_TREE_ID) + test.assertIn(self.TEST_REPLACEMENT_DESTINATION[-1], selected.text) + clear_button = self._wait_for_xpath( + "//*[@id='%s:machineAssignmentDialogFooter']//button[span[text()='Clear']]" % self.VIEW_FORM_NAME) + clear_button.click() + self._wait_for_invisible_by_id(self.ASSIGNMENT_DIALOG_ID) + + def _open_inventory_by_id(self, inventory_id): + self.driver.get('%s/views/%s/view.xhtml?id=%s' % ( + self.driver.current_url.split('/views/')[0], self.VIEW_BASE_NAME, inventory_id)) + self._wait_for_url_contains('%s/view' % self.VIEW_BASE_NAME) + + def _open_machine_assignment(self): + self._wait_for_id_and_click(self.VIEW_FORM_NAME + ':machineAssignmentEditButton') + self._wait_for_visible_id(self.ASSIGNMENT_DIALOG_ID) + + def _select_machine(self, hierarchy): + """Expand the known test hierarchy and select its exact leaf.""" + for name in hierarchy[:-1]: + row = self._wait_for_machine_row(name) + toggler = row.find_element(By.CSS_SELECTOR, '.ui-treetable-toggler') + if 'ui-icon-triangle-1-e' in toggler.get_attribute('class'): + toggler.click() + self._wait_for_machine_row(hierarchy[-1]) + + self._wait_for_machine_row(hierarchy[-1]).click() + + def _wait_for_machine_row(self, name): + row_xpath = ("//*[@id='%s']//tr[.//span[normalize-space(text())=%s]]" + % (self.ASSIGNMENT_TREE_ID, self._xpath_literal(name))) + return self._wait_for_clickable_xpath(row_xpath) + + @staticmethod + def _xpath_literal(value): + if "'" not in value: + return "'%s'" % value + if '"' not in value: + return '"%s"' % value + parts = value.split("'") + return "concat(%s)" % ", \"'\", ".join("'%s'" % part for part in parts) + + def _has_selected_machine(self): + selected = self.driver.find_elements( + By.XPATH, "//*[@id='%s']//tr[@aria-selected='true']" % self.ASSIGNMENT_TREE_ID) + return len(selected) > 0 + def test_import_create(self, test): self._wait_for_id_and_click('%s:%sImportButton' % (self.LIST_FORM_NAME, self.ENTITY_TYPE_NAME)) table_results = self._import_navigate_to_verification_data_table(self.IMPORT_FORM_NAME, self.IMPORT_FILE_NAME) test.assertEqual(len(table_results), 25, msg='25 items were imported in the spreadsheet') - self._import_complete(self.IMPORT_FORM_NAME, self.VIEW_BASE_NAME) \ No newline at end of file + self._import_complete(self.IMPORT_FORM_NAME, self.VIEW_BASE_NAME) diff --git a/tools/developer_tools/portal_testing/PythonSeleniumTest/cdbSeleniumModules/location.py b/tools/developer_tools/portal_testing/PythonSeleniumTest/cdbSeleniumModules/location.py index f5048bf13..7a9b33804 100644 --- a/tools/developer_tools/portal_testing/PythonSeleniumTest/cdbSeleniumModules/location.py +++ b/tools/developer_tools/portal_testing/PythonSeleniumTest/cdbSeleniumModules/location.py @@ -16,7 +16,8 @@ def navigate_to_location_list(self): def test_location_pages(self): dataTableXpathFormula = '//*[@id="%s:%sListTreeTable_node_0"]/td[%d]/a' - self._click_on_xpath(dataTableXpathFormula % (self.LIST_FORM_NAME, self.ENTITY_TYPE_NAME, self.COLUMN_IDX)) + self._click_on_x_path_with_stale_protection( + dataTableXpathFormula % (self.LIST_FORM_NAME, self.ENTITY_TYPE_NAME, self.COLUMN_IDX)) self._wait_for_url_contains('%s/view' % self.VIEW_BASE_NAME) self._click_on_id('%s:%sViewEditButton' % (self.VIEW_FORM_NAME, self.ENTITY_TYPE_NAME)) diff --git a/tools/developer_tools/portal_testing/PythonSeleniumTest/cdbSeleniumModules/propertyType.py b/tools/developer_tools/portal_testing/PythonSeleniumTest/cdbSeleniumModules/propertyType.py index a388053ad..cc485ccf3 100644 --- a/tools/developer_tools/portal_testing/PythonSeleniumTest/cdbSeleniumModules/propertyType.py +++ b/tools/developer_tools/portal_testing/PythonSeleniumTest/cdbSeleniumModules/propertyType.py @@ -56,8 +56,9 @@ def delete_sample_test_property_type(self): nameFilter = self._wait_for_id("viewPropertyTypeListForm:propertyTypeListDataTable:propertyTypeNameFilter:filter") nameFilter.send_keys(SAMPLE_PROPERTY_TYPE_NAME) - samplePropertyLink = self._wait_for(By.LINK_TEXT, SAMPLE_PROPERTY_TYPE_NAME) - samplePropertyLink.click() + samplePropertyXpath = "//a[normalize-space()='%s']" % SAMPLE_PROPERTY_TYPE_NAME + self._wait_for_xpath(samplePropertyXpath) + self._click_on_x_path_with_stale_protection(samplePropertyXpath) self._wait_for_id_and_click('viewPropertyTypeForm:propertyTypeViewDeleteButton') confirmDelete = self._wait_for_visible_xpath('//*[@id="viewPropertyTypeForm:confirmDestroyPropertyType"]') diff --git a/tools/developer_tools/portal_testing/PythonSeleniumTest/cdbSeleniumModules/source.py b/tools/developer_tools/portal_testing/PythonSeleniumTest/cdbSeleniumModules/source.py index 05a7acf29..1e0b17c34 100644 --- a/tools/developer_tools/portal_testing/PythonSeleniumTest/cdbSeleniumModules/source.py +++ b/tools/developer_tools/portal_testing/PythonSeleniumTest/cdbSeleniumModules/source.py @@ -21,7 +21,8 @@ def navigate_to_source_list(self): def test_source_pages(self): dataTableXpathFormula = '//*[@id="%s:%sListDataTable_data"]/tr[1]/td[%d]/a' - self._click_on_xpath(dataTableXpathFormula % (self.LIST_FORM_NAME, self.ENTITY_TYPE_NAME, self.COLUMN_IDX)) + self._click_on_x_path_with_stale_protection( + dataTableXpathFormula % (self.LIST_FORM_NAME, self.ENTITY_TYPE_NAME, self.COLUMN_IDX)) self._wait_for_url_contains('%s/view' % self.VIEW_BASE_NAME) self._click_on_id('%s:%sViewEditButton' % (self.VIEW_FORM_NAME, self.ENTITY_TYPE_NAME)) diff --git a/tools/developer_tools/portal_testing/PythonSeleniumTest/cdbSeleniumModules/user_info.py b/tools/developer_tools/portal_testing/PythonSeleniumTest/cdbSeleniumModules/user_info.py index 2461d61e3..aed212a52 100644 --- a/tools/developer_tools/portal_testing/PythonSeleniumTest/cdbSeleniumModules/user_info.py +++ b/tools/developer_tools/portal_testing/PythonSeleniumTest/cdbSeleniumModules/user_info.py @@ -19,7 +19,8 @@ def navigate_to_user_info_list(self): def test_user_info_pages(self): dataTableXpathFormula = '//*[@id="%s:%sListDataTable_data"]/tr[1]/td[%d]/a' - self._click_on_xpath(dataTableXpathFormula % (self.LIST_FORM_NAME, self.ENTITY_TYPE_NAME, self.COLUMN_IDX)) + self._click_on_x_path_with_stale_protection( + dataTableXpathFormula % (self.LIST_FORM_NAME, self.ENTITY_TYPE_NAME, self.COLUMN_IDX)) self._wait_for_url_contains('%s/view' % self.VIEW_BASE_NAME) self._click_on_id('%s:%sViewEditButton' % (self.VIEW_FORM_NAME, self.ENTITY_TYPE_NAME)) diff --git a/tools/developer_tools/portal_testing/PythonSeleniumTest/docs/INVENTORY_MACHINE_ASSIGNMENT_ACCEPTANCE.md b/tools/developer_tools/portal_testing/PythonSeleniumTest/docs/INVENTORY_MACHINE_ASSIGNMENT_ACCEPTANCE.md new file mode 100644 index 000000000..a13f5d04a --- /dev/null +++ b/tools/developer_tools/portal_testing/PythonSeleniumTest/docs/INVENTORY_MACHINE_ASSIGNMENT_ACCEPTANCE.md @@ -0,0 +1,20 @@ +# Inventory Machine Assignment Acceptance Coverage + +Automated by `tests/test_inventory.py::InventoryTest::test_inventory_machine_assignment` using the test database fixtures. + +## Automated scenarios + +- Open Housing edit and verify the machine-selection dialog and Installed/Planned control. +- Assign inventory as **Planned**, reopen the dialog, and verify the selected machine and state persisted. +- Move assigned inventory to another machine and verify the destination becomes selected after refresh (source release and view refresh). +- Clear the assignment and verify no machine remains selected (inventory is replaced by its catalog on the machine). +- Expand `Another Top Level`, select `Inventory Assignment Test Destination`, confirm the different-catalog replacement, verify applicable progress steps complete, reopen to verify persistence, and clear for cleanup. + +## Manual acceptance scenarios + +These require fixture/user manipulation or an injected persistence failure and remain manual: + +- Verify assignment is rejected unless the user can write the inventory, source machine, and destination machine. +- Force destination persistence to fail after source release and verify the source inventory assignment and Installed/Planned state are restored. + +Logging is intentionally not asserted as acceptance behavior. diff --git a/tools/developer_tools/portal_testing/PythonSeleniumTest/gui_test.py b/tools/developer_tools/portal_testing/PythonSeleniumTest/gui_test.py deleted file mode 100644 index 9d667a3fa..000000000 --- a/tools/developer_tools/portal_testing/PythonSeleniumTest/gui_test.py +++ /dev/null @@ -1,236 +0,0 @@ -#!/usr/bin/env python - -""" -Copyright (c) UChicago Argonne, LLC. All rights reserved. -See LICENSE file. -""" -import os -import unittest - -from selenium import webdriver - -from cdbSeleniumModules.browse_by import BrowseBy -from cdbSeleniumModules.cable_catalog import CableCatalog -from cdbSeleniumModules.cable_design import CableDesign -from cdbSeleniumModules.cable_inventory import CableInventory -from cdbSeleniumModules.catalog import Catalog -from cdbSeleniumModules.connector_type import ConnectorType -from cdbSeleniumModules.inventory import Inventory -from cdbSeleniumModules.location import Location -from cdbSeleniumModules.machineDesign import MachineDesign -from cdbSeleniumModules.portal import Portal -from cdbSeleniumModules.propertyType import PropertyType -from cdbSeleniumModules.source import Source -from cdbSeleniumModules.user_info import UserInfo - - -class CdbPortalFunctionalTestSuite(unittest.TestCase): - - PORTAL_URL = 'http://localhost:8080/cdb' - MACHINE_DESIGN_CSV_PATH = 'data/md-test.csv' - MACHINE_DESIGN_PROJECT = 'APS-U' - - DATA_PATH = "%s/data-dw" % os.getcwd() - - def setUp(self): - self.prepare_download_area() - opts = webdriver.ChromeOptions() - prefs = {"download.default_directory": self.DATA_PATH} - opts.add_experimental_option("prefs", prefs) - - headless = os.getenv("CDB_TEST_HEADLESS", 'False').lower() in ('true', '1', 't', 'y', 'yes') - if headless: - opts.add_argument("headless") - - self.driver = webdriver.Chrome(options=opts) - self.driver.set_window_position(0, 0) - self.driver.maximize_window() - self.driver.get(self.PORTAL_URL) - - self.portal = Portal(self.driver) - self.property_type = PropertyType(self.driver) - self.catalog = Catalog(self.driver) - self.inventory = Inventory(self.driver) - self.cable_inventory = CableInventory(self.driver) - self.cable_catalog = CableCatalog(self.driver) - self.cable_design = CableDesign(self.driver) - self.machine_design = MachineDesign(self.driver) - self.location = Location(self.driver) - self.browse_by = BrowseBy(self.driver) - self.source = Source(self.driver) - self.user_info = UserInfo(self.driver) - self.connector_type = ConnectorType(self.driver) - - self.portal.login() - - def tearDown(self): - self.portal.logout() - self.driver.close() - - def prepare_download_area(self): - if os.path.exists(self.DATA_PATH): - # Clean up any residual downloads - for file in os.scandir(self.DATA_PATH): - os.remove(file.path) - else: - # Create directory - os.mkdir(self.DATA_PATH) - - def verify_file_downloaded(self, file_name): - file_path = "%s/%s" % (self.DATA_PATH, file_name) - exits = os.path.exists(file_path) - self.assertEqual(True, exits, msg='Downloaded file %s was not found' % file_name) - - def test_create_property_type(self): - self.property_type.add_sample_test_property_type() - self.property_type.delete_sample_test_property_type() - - def test_create_catalog_item(self): - self.catalog.start_create_sample_catalog_item() - self.catalog.finish_create_sample_catalog_item() - - self.catalog.display_more_columns() - self.catalog.search_for_sample_catalog_item() - self.catalog.add_log_to_catalog_item() - self.catalog.add_property_to_catalog_item(self) - self.catalog.add_image_to_catalog_item() - - self.catalog.delete_current_item() - - def test_machine_design(self): - self.machine_design.navigate_to_machine_design() - self.machine_design.input_hierarchy_from_sample_file(csvFile=self.MACHINE_DESIGN_CSV_PATH, - project=self.MACHINE_DESIGN_PROJECT) - - def test_machine_design_export(self): - self.machine_design.navigate_to_machine_design() - self.machine_design.filter_machine() - self.machine_design.export_machine(self) - - def test_machine_design_import(self): - self.machine_design.navigate_to_machine_design() - self.machine_design.import_machine(self) - - def test_machine_design_details_page(self): - self.machine_design.navigate_to_machine_design() - self.machine_design.test_detail_page(self) - - def test_machine_pages(self): - self.machine_design.navigate_to_machine_design() - self.machine_design.test_machine_pages() - - def test_browse_by_function_pages(self): - self.browse_by.navigate_to_browse_by_function() - self.browse_by.test_browse_by_function(self) - - def test_browse_by_owner(self): - self.browse_by.navigate_to_browse_by_owner() - self.browse_by.test_browse_by_owner(self) - - def test_browse_by_location(self): - self.browse_by.navigate_to_browse_by_location() - self.browse_by.test_browse_by_location(self) - - def test_catalog_pages(self): - self.catalog.navigate_to_catalog_list() - self.catalog.test_catalog_pages() - - def test_catalog_export(self): - self.catalog.navigate_to_catalog_list() - self.catalog.export_catalog(self) - - def test_catalog_import(self): - self.catalog.navigate_to_catalog_list() - self.catalog.test_import_create(self) - - def test_cable_catalog_pages(self): - self.cable_catalog.navigate_to_cable_catalog_list() - self.cable_catalog.test_cable_catalog_pages() - - def test_cable_catalog_detail_page(self): - self.cable_catalog.navigate_to_cable_catalog_list() - self.cable_catalog.test_cable_catalog_detail_page(self) - - def test_cable_catalog_export(self): - self.cable_catalog.navigate_to_cable_catalog_list() - self.cable_catalog.export_cable_catalog(self) - - def test_cable_catalog_import(self): - self.cable_catalog.navigate_to_cable_catalog_list() - self.cable_catalog.test_import_create(self) - - def test_inventory_pages(self): - self.inventory.navigate_to_inventory_list() - self.inventory.test_inventory_pages() - - def test_inventory_detail_page(self): - self.inventory.navigate_to_inventory_list() - self.inventory.test_inventory_detail_page(self) - - def test_inventory_import(self): - self.inventory.navigate_to_inventory_list() - self.inventory.test_import_create(self) - - def test_cable_inventory_pages(self): - self.cable_inventory.navigate_to_cable_inventory_list() - self.cable_inventory.test_cable_inventory_pages() - - def test_cable_inventory_detail_page(self): - self.cable_inventory.navigate_to_cable_inventory_list() - self.cable_inventory.test_cable_inventory_detail_page(self) - - def test_cable_inventory_import(self): - self.cable_inventory.navigate_to_cable_inventory_list() - self.cable_inventory.test_import_create(self) - - def test_cable_design_pages(self): - self.cable_design.navigate_to_cable_design_list() - self.cable_design.test_cable_design_pages() - - def test_cable_design_detail_page(self): - self.cable_design.navigate_to_cable_design_list() - self.cable_design.test_cable_design_detail_page(self) - - def test_cable_design_export(self): - self.cable_design.navigate_to_cable_design_list() - self.cable_design.export_cable_design(self) - - def test_cable_design_import(self): - self.cable_design.navigate_to_cable_design_list() - self.cable_design.test_import_create(self) - - def test_source_pages(self): - self.source.navigate_to_source_list() - self.source.test_source_pages() - - def test_source_export(self): - self.source.navigate_to_source_list() - self.source.export_source(self) - - def test_source_import_pages(self): - self.source.navigate_to_source_list() - self.source.test_import_create(self) - - def test_user_info_pages(self): - self.user_info.navigate_to_user_info_list() - self.user_info.test_user_info_pages() - - def test_user_info_export(self): - self.user_info.navigate_to_user_info_list() - self.user_info.export_user_info(self) - - def test_connector_type_pages(self): - self.connector_type.navigate_to_connector_type_list() - self.connector_type.test_connector_type_pages() - - def test_connector_type_export(self): - self.connector_type.navigate_to_connector_type_list() - self.connector_type.export_connector_type(self) - - def test_location_pages(self): - self.location.navigate_to_location_list() - self.location.test_location_pages() - - -if __name__ == '__main__': - unittest.main() \ No newline at end of file diff --git a/tools/developer_tools/portal_testing/PythonSeleniumTest/tests/__init__.py b/tools/developer_tools/portal_testing/PythonSeleniumTest/tests/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/tools/developer_tools/portal_testing/PythonSeleniumTest/tests/base.py b/tools/developer_tools/portal_testing/PythonSeleniumTest/tests/base.py new file mode 100644 index 000000000..8d52d5a71 --- /dev/null +++ b/tools/developer_tools/portal_testing/PythonSeleniumTest/tests/base.py @@ -0,0 +1,74 @@ +#!/usr/bin/env python + +""" +Copyright (c) UChicago Argonne, LLC. All rights reserved. +See LICENSE file. +""" +import os +import shutil +import time +import unittest + +from selenium import webdriver + +from cdbSeleniumModules.portal import Portal + + +class CdbPortalTestCase(unittest.TestCase): + + PORTAL_URL = 'http://localhost:8080/cdb' + DATA_PATH = "%s/data-dw" % os.getcwd() + DOWNLOAD_TIMEOUT = 10 + + def setUp(self): + worker = os.getenv("PYTEST_XDIST_WORKER") + if worker: + self.DATA_PATH = os.path.join(self.DATA_PATH, worker) + self.prepare_download_area() + opts = webdriver.ChromeOptions() + prefs = {"download.default_directory": self.DATA_PATH} + opts.add_experimental_option("prefs", prefs) + + headless = os.getenv("CDB_TEST_HEADLESS", 'True').lower() in ('true', '1', 't', 'y', 'yes') + if headless: + opts.add_argument("headless") + opts.add_argument("window-size=1920,1080") + + self.driver = webdriver.Chrome(options=opts) + self.driver.set_window_position(0, 0) + if not headless: + self.driver.maximize_window() + self.driver.get(self.PORTAL_URL) + + self.portal = Portal(self.driver) + self.portal.login() + + def tearDown(self): + self.driver.quit() + + def prepare_download_area(self): + if os.path.exists(self.DATA_PATH): + # Clean up any residual downloads + for entry in os.scandir(self.DATA_PATH): + if entry.is_dir(): + shutil.rmtree(entry.path) + else: + os.remove(entry.path) + else: + # Create directory + os.makedirs(self.DATA_PATH) + + def verify_file_downloaded(self, file_name): + file_path = os.path.join(self.DATA_PATH, file_name) + deadline = time.monotonic() + self.DOWNLOAD_TIMEOUT + + while time.monotonic() < deadline: + partial_downloads = [ + entry for entry in os.scandir(self.DATA_PATH) + if entry.name.endswith('.crdownload') + ] + if os.path.exists(file_path) and not partial_downloads: + return + time.sleep(0.1) + + self.fail('Downloaded file %s was not found or did not finish downloading' % file_name) diff --git a/tools/developer_tools/portal_testing/PythonSeleniumTest/tests/test_browse_by.py b/tools/developer_tools/portal_testing/PythonSeleniumTest/tests/test_browse_by.py new file mode 100644 index 000000000..384effb5f --- /dev/null +++ b/tools/developer_tools/portal_testing/PythonSeleniumTest/tests/test_browse_by.py @@ -0,0 +1,28 @@ +#!/usr/bin/env python + +""" +Copyright (c) UChicago Argonne, LLC. All rights reserved. +See LICENSE file. +""" + +from cdbSeleniumModules.browse_by import BrowseBy +from tests.base import CdbPortalTestCase + + +class BrowseByTest(CdbPortalTestCase): + + def setUp(self): + super().setUp() + self.browse_by = BrowseBy(self.driver) + + def test_browse_by_function_pages(self): + self.browse_by.navigate_to_browse_by_function() + self.browse_by.test_browse_by_function(self) + + def test_browse_by_owner(self): + self.browse_by.navigate_to_browse_by_owner() + self.browse_by.test_browse_by_owner(self) + + def test_browse_by_location(self): + self.browse_by.navigate_to_browse_by_location() + self.browse_by.test_browse_by_location(self) diff --git a/tools/developer_tools/portal_testing/PythonSeleniumTest/tests/test_cable_catalog.py b/tools/developer_tools/portal_testing/PythonSeleniumTest/tests/test_cable_catalog.py new file mode 100644 index 000000000..e9ac540bc --- /dev/null +++ b/tools/developer_tools/portal_testing/PythonSeleniumTest/tests/test_cable_catalog.py @@ -0,0 +1,32 @@ +#!/usr/bin/env python + +""" +Copyright (c) UChicago Argonne, LLC. All rights reserved. +See LICENSE file. +""" + +from cdbSeleniumModules.cable_catalog import CableCatalog +from tests.base import CdbPortalTestCase + + +class CableCatalogTest(CdbPortalTestCase): + + def setUp(self): + super().setUp() + self.cable_catalog = CableCatalog(self.driver) + + def test_cable_catalog_pages(self): + self.cable_catalog.navigate_to_cable_catalog_list() + self.cable_catalog.test_cable_catalog_pages() + + def test_cable_catalog_detail_page(self): + self.cable_catalog.navigate_to_cable_catalog_list() + self.cable_catalog.test_cable_catalog_detail_page(self) + + def test_cable_catalog_export(self): + self.cable_catalog.navigate_to_cable_catalog_list() + self.cable_catalog.export_cable_catalog(self) + + def test_cable_catalog_import(self): + self.cable_catalog.navigate_to_cable_catalog_list() + self.cable_catalog.test_import_create(self) diff --git a/tools/developer_tools/portal_testing/PythonSeleniumTest/tests/test_cable_design.py b/tools/developer_tools/portal_testing/PythonSeleniumTest/tests/test_cable_design.py new file mode 100644 index 000000000..636ad4548 --- /dev/null +++ b/tools/developer_tools/portal_testing/PythonSeleniumTest/tests/test_cable_design.py @@ -0,0 +1,32 @@ +#!/usr/bin/env python + +""" +Copyright (c) UChicago Argonne, LLC. All rights reserved. +See LICENSE file. +""" + +from cdbSeleniumModules.cable_design import CableDesign +from tests.base import CdbPortalTestCase + + +class CableDesignTest(CdbPortalTestCase): + + def setUp(self): + super().setUp() + self.cable_design = CableDesign(self.driver) + + def test_cable_design_pages(self): + self.cable_design.navigate_to_cable_design_list() + self.cable_design.test_cable_design_pages() + + def test_cable_design_detail_page(self): + self.cable_design.navigate_to_cable_design_list() + self.cable_design.test_cable_design_detail_page(self) + + def test_cable_design_export(self): + self.cable_design.navigate_to_cable_design_list() + self.cable_design.export_cable_design(self) + + def test_cable_design_import(self): + self.cable_design.navigate_to_cable_design_list() + self.cable_design.test_import_create(self) diff --git a/tools/developer_tools/portal_testing/PythonSeleniumTest/tests/test_cable_inventory.py b/tools/developer_tools/portal_testing/PythonSeleniumTest/tests/test_cable_inventory.py new file mode 100644 index 000000000..566d6d588 --- /dev/null +++ b/tools/developer_tools/portal_testing/PythonSeleniumTest/tests/test_cable_inventory.py @@ -0,0 +1,28 @@ +#!/usr/bin/env python + +""" +Copyright (c) UChicago Argonne, LLC. All rights reserved. +See LICENSE file. +""" + +from cdbSeleniumModules.cable_inventory import CableInventory +from tests.base import CdbPortalTestCase + + +class CableInventoryTest(CdbPortalTestCase): + + def setUp(self): + super().setUp() + self.cable_inventory = CableInventory(self.driver) + + def test_cable_inventory_pages(self): + self.cable_inventory.navigate_to_cable_inventory_list() + self.cable_inventory.test_cable_inventory_pages() + + def test_cable_inventory_detail_page(self): + self.cable_inventory.navigate_to_cable_inventory_list() + self.cable_inventory.test_cable_inventory_detail_page(self) + + def test_cable_inventory_import(self): + self.cable_inventory.navigate_to_cable_inventory_list() + self.cable_inventory.test_import_create(self) diff --git a/tools/developer_tools/portal_testing/PythonSeleniumTest/tests/test_catalog.py b/tools/developer_tools/portal_testing/PythonSeleniumTest/tests/test_catalog.py new file mode 100644 index 000000000..bfeec3459 --- /dev/null +++ b/tools/developer_tools/portal_testing/PythonSeleniumTest/tests/test_catalog.py @@ -0,0 +1,40 @@ +#!/usr/bin/env python + +""" +Copyright (c) UChicago Argonne, LLC. All rights reserved. +See LICENSE file. +""" + +from cdbSeleniumModules.catalog import Catalog +from tests.base import CdbPortalTestCase + + +class CatalogTest(CdbPortalTestCase): + + def setUp(self): + super().setUp() + self.catalog = Catalog(self.driver) + + def test_create_catalog_item(self): + self.catalog.start_create_sample_catalog_item() + self.catalog.finish_create_sample_catalog_item() + + self.catalog.display_more_columns() + self.catalog.search_for_sample_catalog_item() + self.catalog.add_log_to_catalog_item() + self.catalog.add_property_to_catalog_item(self) + self.catalog.add_image_to_catalog_item() + + self.catalog.delete_current_item() + + def test_catalog_pages(self): + self.catalog.navigate_to_catalog_list() + self.catalog.test_catalog_pages() + + def test_catalog_export(self): + self.catalog.navigate_to_catalog_list() + self.catalog.export_catalog(self) + + def test_catalog_import(self): + self.catalog.navigate_to_catalog_list() + self.catalog.test_import_create(self) diff --git a/tools/developer_tools/portal_testing/PythonSeleniumTest/tests/test_connector_type.py b/tools/developer_tools/portal_testing/PythonSeleniumTest/tests/test_connector_type.py new file mode 100644 index 000000000..5c0a78035 --- /dev/null +++ b/tools/developer_tools/portal_testing/PythonSeleniumTest/tests/test_connector_type.py @@ -0,0 +1,24 @@ +#!/usr/bin/env python + +""" +Copyright (c) UChicago Argonne, LLC. All rights reserved. +See LICENSE file. +""" + +from cdbSeleniumModules.connector_type import ConnectorType +from tests.base import CdbPortalTestCase + + +class ConnectorTypeTest(CdbPortalTestCase): + + def setUp(self): + super().setUp() + self.connector_type = ConnectorType(self.driver) + + def test_connector_type_pages(self): + self.connector_type.navigate_to_connector_type_list() + self.connector_type.test_connector_type_pages() + + def test_connector_type_export(self): + self.connector_type.navigate_to_connector_type_list() + self.connector_type.export_connector_type(self) diff --git a/tools/developer_tools/portal_testing/PythonSeleniumTest/tests/test_inventory.py b/tools/developer_tools/portal_testing/PythonSeleniumTest/tests/test_inventory.py new file mode 100644 index 000000000..c7085578d --- /dev/null +++ b/tools/developer_tools/portal_testing/PythonSeleniumTest/tests/test_inventory.py @@ -0,0 +1,31 @@ +#!/usr/bin/env python + +""" +Copyright (c) UChicago Argonne, LLC. All rights reserved. +See LICENSE file. +""" + +from cdbSeleniumModules.inventory import Inventory +from tests.base import CdbPortalTestCase + + +class InventoryTest(CdbPortalTestCase): + + def setUp(self): + super().setUp() + self.inventory = Inventory(self.driver) + + def test_inventory_pages(self): + self.inventory.navigate_to_inventory_list() + self.inventory.test_inventory_pages() + + def test_inventory_detail_page(self): + self.inventory.navigate_to_inventory_list() + self.inventory.test_inventory_detail_page(self) + + def test_inventory_machine_assignment(self): + self.inventory.test_machine_assignment_acceptance(self) + + def test_inventory_import(self): + self.inventory.navigate_to_inventory_list() + self.inventory.test_import_create(self) diff --git a/tools/developer_tools/portal_testing/PythonSeleniumTest/tests/test_location.py b/tools/developer_tools/portal_testing/PythonSeleniumTest/tests/test_location.py new file mode 100644 index 000000000..774d809ba --- /dev/null +++ b/tools/developer_tools/portal_testing/PythonSeleniumTest/tests/test_location.py @@ -0,0 +1,20 @@ +#!/usr/bin/env python + +""" +Copyright (c) UChicago Argonne, LLC. All rights reserved. +See LICENSE file. +""" + +from cdbSeleniumModules.location import Location +from tests.base import CdbPortalTestCase + + +class LocationTest(CdbPortalTestCase): + + def setUp(self): + super().setUp() + self.location = Location(self.driver) + + def test_location_pages(self): + self.location.navigate_to_location_list() + self.location.test_location_pages() diff --git a/tools/developer_tools/portal_testing/PythonSeleniumTest/tests/test_machine_design.py b/tools/developer_tools/portal_testing/PythonSeleniumTest/tests/test_machine_design.py new file mode 100644 index 000000000..9bb97b099 --- /dev/null +++ b/tools/developer_tools/portal_testing/PythonSeleniumTest/tests/test_machine_design.py @@ -0,0 +1,41 @@ +#!/usr/bin/env python + +""" +Copyright (c) UChicago Argonne, LLC. All rights reserved. +See LICENSE file. +""" + +from cdbSeleniumModules.machineDesign import MachineDesign +from tests.base import CdbPortalTestCase + + +class MachineDesignTest(CdbPortalTestCase): + + MACHINE_DESIGN_CSV_PATH = 'data/md-test.csv' + MACHINE_DESIGN_PROJECT = 'APS-U' + + def setUp(self): + super().setUp() + self.machine_design = MachineDesign(self.driver) + + def test_machine_design(self): + self.machine_design.navigate_to_machine_design() + self.machine_design.input_hierarchy_from_sample_file(csvFile=self.MACHINE_DESIGN_CSV_PATH, + project=self.MACHINE_DESIGN_PROJECT) + + def test_machine_design_export(self): + self.machine_design.navigate_to_machine_design() + self.machine_design.filter_machine() + self.machine_design.export_machine(self) + + def test_machine_design_import(self): + self.machine_design.navigate_to_machine_design() + self.machine_design.import_machine(self) + + def test_machine_design_details_page(self): + self.machine_design.navigate_to_machine_design() + self.machine_design.test_detail_page(self) + + def test_machine_pages(self): + self.machine_design.navigate_to_machine_design() + self.machine_design.test_machine_pages() diff --git a/tools/developer_tools/portal_testing/PythonSeleniumTest/tests/test_portal.py b/tools/developer_tools/portal_testing/PythonSeleniumTest/tests/test_portal.py new file mode 100644 index 000000000..fd890bfff --- /dev/null +++ b/tools/developer_tools/portal_testing/PythonSeleniumTest/tests/test_portal.py @@ -0,0 +1,26 @@ +#!/usr/bin/env python + +""" +Copyright (c) UChicago Argonne, LLC. All rights reserved. +See LICENSE file. +""" + +from cdbSeleniumModules.catalog import Catalog +from cdbSeleniumModules.inventory import Inventory +from tests.base import CdbPortalTestCase + + +class PortalTest(CdbPortalTestCase): + + def setUp(self): + super().setUp() + self.catalog = Catalog(self.driver) + self.inventory = Inventory(self.driver) + + def test_login_and_logout(self): + self.catalog.navigate_to_catalog_list() + self.portal.logout() + + self.portal.login() + self.inventory.navigate_to_inventory_list() + self.portal.logout() diff --git a/tools/developer_tools/portal_testing/PythonSeleniumTest/tests/test_property_type.py b/tools/developer_tools/portal_testing/PythonSeleniumTest/tests/test_property_type.py new file mode 100644 index 000000000..1cfdf5d3f --- /dev/null +++ b/tools/developer_tools/portal_testing/PythonSeleniumTest/tests/test_property_type.py @@ -0,0 +1,20 @@ +#!/usr/bin/env python + +""" +Copyright (c) UChicago Argonne, LLC. All rights reserved. +See LICENSE file. +""" + +from cdbSeleniumModules.propertyType import PropertyType +from tests.base import CdbPortalTestCase + + +class PropertyTypeTest(CdbPortalTestCase): + + def setUp(self): + super().setUp() + self.property_type = PropertyType(self.driver) + + def test_create_property_type(self): + self.property_type.add_sample_test_property_type() + self.property_type.delete_sample_test_property_type() diff --git a/tools/developer_tools/portal_testing/PythonSeleniumTest/tests/test_source.py b/tools/developer_tools/portal_testing/PythonSeleniumTest/tests/test_source.py new file mode 100644 index 000000000..f05bee4db --- /dev/null +++ b/tools/developer_tools/portal_testing/PythonSeleniumTest/tests/test_source.py @@ -0,0 +1,28 @@ +#!/usr/bin/env python + +""" +Copyright (c) UChicago Argonne, LLC. All rights reserved. +See LICENSE file. +""" + +from cdbSeleniumModules.source import Source +from tests.base import CdbPortalTestCase + + +class SourceTest(CdbPortalTestCase): + + def setUp(self): + super().setUp() + self.source = Source(self.driver) + + def test_source_pages(self): + self.source.navigate_to_source_list() + self.source.test_source_pages() + + def test_source_export(self): + self.source.navigate_to_source_list() + self.source.export_source(self) + + def test_source_import_pages(self): + self.source.navigate_to_source_list() + self.source.test_import_create(self) diff --git a/tools/developer_tools/portal_testing/PythonSeleniumTest/tests/test_user_info.py b/tools/developer_tools/portal_testing/PythonSeleniumTest/tests/test_user_info.py new file mode 100644 index 000000000..8ad711ddf --- /dev/null +++ b/tools/developer_tools/portal_testing/PythonSeleniumTest/tests/test_user_info.py @@ -0,0 +1,24 @@ +#!/usr/bin/env python + +""" +Copyright (c) UChicago Argonne, LLC. All rights reserved. +See LICENSE file. +""" + +from cdbSeleniumModules.user_info import UserInfo +from tests.base import CdbPortalTestCase + + +class UserInfoTest(CdbPortalTestCase): + + def setUp(self): + super().setUp() + self.user_info = UserInfo(self.driver) + + def test_user_info_pages(self): + self.user_info.navigate_to_user_info_list() + self.user_info.test_user_info_pages() + + def test_user_info_export(self): + self.user_info.navigate_to_user_info_list() + self.user_info.export_user_info(self) diff --git a/tools/developer_tools/python-client/README.md b/tools/developer_tools/python-client/README.md index 09ef706be..f357e1d4b 100644 --- a/tools/developer_tools/python-client/README.md +++ b/tools/developer_tools/python-client/README.md @@ -27,7 +27,7 @@ If you'd rather use uv directly (editable installs into a real virtualenv): ```sh uv sync # installs both packages editable + dev deps (pytest) -uv run pytest test/api_test.py +uv run pytest test/ uv run cdb-cli --help ``` @@ -78,7 +78,7 @@ reminder to upload the resulting `cdb-api-cli-env.txt` with the c2 tool. ## Tests ```sh -uv run pytest test/api_test.py # requires the portal running on localhost:8080 +uv run pytest test/ # requires the portal running on localhost:8080 ``` `sbin/cdb_test.sh` (invoked by `make test`) regenerates the client and runs this as part of the