From c6de119e92510af520de3bc537cba5df060ff4ff Mon Sep 17 00:00:00 2001 From: labkey-tchad Date: Wed, 10 Jan 2024 09:11:41 -0800 Subject: [PATCH] Stop using deprecated `GetDomainCommand` --- .../labkey/test/tests/DomainDesignerTest.java | 71 ++++++++++++------- .../labkey/test/tests/JavaClientApiTest.java | 9 +-- .../test/tests/issues/IssueDomainTest.java | 8 +-- src/org/labkey/test/util/DomainUtils.java | 7 +- .../labkey/test/util/TestDataGenerator.java | 10 +-- .../test/util/query/QueryApiHelper.java | 8 +-- 6 files changed, 64 insertions(+), 49 deletions(-) diff --git a/src/org/labkey/test/tests/DomainDesignerTest.java b/src/org/labkey/test/tests/DomainDesignerTest.java index 0bf459678e..eb274e878a 100644 --- a/src/org/labkey/test/tests/DomainDesignerTest.java +++ b/src/org/labkey/test/tests/DomainDesignerTest.java @@ -11,11 +11,13 @@ import org.junit.Test; import org.junit.experimental.categories.Category; import org.labkey.remoteapi.CommandException; +import org.labkey.remoteapi.Connection; import org.labkey.remoteapi.domain.ConditionalFormat; import org.labkey.remoteapi.domain.ConditionalFormatFilter; import org.labkey.remoteapi.domain.Domain; +import org.labkey.remoteapi.domain.DomainDetailsResponse; import org.labkey.remoteapi.domain.DomainResponse; -import org.labkey.remoteapi.domain.GetDomainCommand; +import org.labkey.remoteapi.domain.GetDomainDetailsCommand; import org.labkey.remoteapi.domain.PropertyDescriptor; import org.labkey.remoteapi.query.Filter; import org.labkey.remoteapi.query.SaveRowsResponse; @@ -227,8 +229,8 @@ public void testDeleteDomainField() throws Exception .clickRemoveField(true); domainDesignerPage.clickFinish(); - GetDomainCommand domainCommand = new GetDomainCommand("exp.materials", sampleType); - DomainResponse afterResponse = domainCommand.execute(createDefaultConnection(), getProjectName()); + GetDomainDetailsCommand domainCommand = new GetDomainDetailsCommand("exp.materials", sampleType); + DomainDetailsResponse afterResponse = domainCommand.execute(createDefaultConnection(), getProjectName()); Domain domain = afterResponse.getDomain(); assertEquals("expect only field in the domain to have been deleted", 0, domain.getFields().size()); @@ -781,7 +783,8 @@ public void setPhiLevel() throws Exception clickAndWait(Locator.linkWithText(sampleType)); DataRegionTable sampleTypeTable = DataRegionTable.findDataRegionWithinWebpart(this, "Sample Type Contents"); - DomainResponse domainResponse = dgen.getDomain(createDefaultConnection()); + Connection cn = createDefaultConnection(); + DomainDetailsResponse domainResponse = dgen.getQueryHelper(cn).getDomainDetails(); assertEquals("NotPHI", getColumn(domainResponse.getDomain(), "notPHI").getPHI()); assertEquals("Limited", getColumn(domainResponse.getDomain(), "limitedPHI").getPHI()); @@ -813,7 +816,8 @@ public void setMissingValue() throws Exception extraFieldRow.setMissingValuesEnabled(false); domainDesignerPage.clickFinish(); - DomainResponse domainResponse = dgen.getDomain(createDefaultConnection()); + Connection cn = createDefaultConnection(); + DomainDetailsResponse domainResponse = dgen.getQueryHelper(cn).getDomainDetails(); assertEquals("expect column to have MissingValue enabled", true, getColumn(domainResponse.getDomain(), "missingValue").getAllProperties().get("mvEnabled")); assertEquals("expect column not to have MissingValue enabled", false, getColumn(domainResponse.getDomain(), "extraField").getAllProperties().get("mvEnabled")); } @@ -841,7 +845,8 @@ public void setFieldAsDimension() throws Exception domainDesignerPage.clickFinish(); - DomainResponse domainResponse = dgen.getDomain(createDefaultConnection()); + Connection cn = createDefaultConnection(); + DomainDetailsResponse domainResponse = dgen.getQueryHelper(cn).getDomainDetails(); assertEquals("dimensionField should have dimension marked true", true, getColumn(domainResponse.getDomain(), "dimensionField").getDimension()); assertEquals("extraField should not have dimension marked true", false, getColumn(domainResponse.getDomain(), "extraField").getDimension()); } @@ -869,7 +874,8 @@ public void setFieldAsMeasure() throws Exception domainDesignerPage.clickFinish(); - DomainResponse domainResponse = dgen.getDomain(createDefaultConnection()); + Connection cn = createDefaultConnection(); + DomainDetailsResponse domainResponse = dgen.getQueryHelper(cn).getDomainDetails(); assertEquals("measureField should have dimension marked true", true, getColumn(domainResponse.getDomain(), "measureField").getMeasure()); assertEquals("extraField should not have dimension marked true", false, getColumn(domainResponse.getDomain(), "extraField").getMeasure()); @@ -898,7 +904,8 @@ public void setFieldAsVariable() throws Exception domainDesignerPage.clickFinish(); - DomainResponse domainResponse = dgen.getDomain(createDefaultConnection()); + Connection cn = createDefaultConnection(); + DomainDetailsResponse domainResponse = dgen.getQueryHelper(cn).getDomainDetails(); assertEquals("variableField should have recommendedVariable marked true", true, getColumn(domainResponse.getDomain(), "variableField").getAllProperties().get("recommendedVariable")); assertEquals("extraField should not have recommendedVariable marked true", false, getColumn(domainResponse.getDomain(), "extraField").getAllProperties().get("recommendedVariable")); } @@ -940,7 +947,8 @@ public void testLookUpFieldSampleType() throws IOException, CommandException domainDesignerPage.clickFinish(); - DomainResponse domainResponse = dgen.getDomain(createDefaultConnection()); + Connection cn = createDefaultConnection(); + DomainDetailsResponse domainResponse = dgen.getQueryHelper(cn).getDomainDetails(); PropertyDescriptor lookupFieldDescriptor = getColumn(domainResponse.getDomain(), "lookUpField"); assertEquals("lookUpField from folder is incorrect", null, lookupFieldDescriptor.getAllProperties().get("lookupContainer")); assertEquals("lookUpField schema name is incorrect", "lists", lookupFieldDescriptor.getAllProperties().get("lookupSchema")); @@ -983,7 +991,8 @@ public void testLookUpFieldList() throws IOException, CommandException assertEquals("Incorrect detail message", "New Field. Current Folder > lists > lookUpList", lookUpRow.detailsMessage()); domainDesignerPage.clickFinish(); - DomainResponse domainResponse = dgen.getDomain(createDefaultConnection()); + Connection cn = createDefaultConnection(); + DomainDetailsResponse domainResponse = dgen.getQueryHelper(cn).getDomainDetails(); PropertyDescriptor lookupColumn = getColumn(domainResponse.getDomain(), "lookUpField"); // getColumn asserts the column is non-null assertEquals("lookUpField schema name should be present", "lists", lookupColumn.getAllProperties().get("lookupSchema")); @@ -1028,7 +1037,8 @@ public void testLookupPropertyValidator() throws Exception domainDesignerPage.clickFinish(); // now make sure the validator is set - DomainResponse domainResponse = dgen.getDomain(createDefaultConnection()); + Connection cn = createDefaultConnection(); + DomainDetailsResponse domainResponse = dgen.getQueryHelper(cn).getDomainDetails(); PropertyDescriptor lookupColumn = getColumn(domainResponse.getDomain(), "looky"); Map propertyValidator = getPropertyValidator(lookupColumn, "Lookup Validator"); } @@ -1054,7 +1064,8 @@ public void testDefaultValues() throws Exception domainDesignerPage.clickFinish(); // now make sure the validator is not yet set - DomainResponse domainResponse = dgen.getDomain(createDefaultConnection()); + Connection cn1 = createDefaultConnection(); + DomainDetailsResponse domainResponse = dgen.getQueryHelper(cn1).getDomainDetails(); PropertyDescriptor colorCol = getColumn(domainResponse.getDomain(), "color"); assertNull("expect default value to not be set yet", colorCol.getAllProperties().get("defaultValue")); @@ -1067,7 +1078,8 @@ public void testDefaultValues() throws Exception setFormElement(Locator.input("color"), "green"); clickButton("Save Defaults"); - DomainResponse updatedResponse = dgen.getDomain(createDefaultConnection()); + Connection cn = createDefaultConnection(); + DomainDetailsResponse updatedResponse = dgen.getQueryHelper(cn).getDomainDetails(); PropertyDescriptor updatedColor = getColumn(updatedResponse.getDomain(), "color"); assertEquals("expect default value to be green", "green", updatedColor.getAllProperties().get("defaultValue")); } @@ -1120,7 +1132,8 @@ public void verifyExpectedWarningOnNavigateWithUncomittedChanges() throws Except domainDesignerPage.clickCancelWithUnsavedChanges().saveChanges(); // this should save the changes - DomainResponse response = dgen.getDomain(createDefaultConnection()); + Connection cn = createDefaultConnection(); + DomainDetailsResponse response = dgen.getQueryHelper(cn).getDomainDetails(); PropertyDescriptor faveSnackRow = getColumn(response.getDomain(), "favoriteSnack"); PropertyDescriptor newFieldRow = getColumn(response.getDomain(), "newField"); @@ -1201,7 +1214,8 @@ public void testMarkFieldRequired() throws Exception .setRequiredField(true); domainDesignerPage.clickFinish(); - DomainResponse response = dgen.getDomain(createDefaultConnection()); + Connection cn = createDefaultConnection(); + DomainDetailsResponse response = dgen.getQueryHelper(cn).getDomainDetails(); PropertyDescriptor manufacturerRow = getColumn(response.getDomain(), "manufacturer"); assertEquals("expect row to be marked 'required'", true, manufacturerRow.getRequired()); } @@ -1258,7 +1272,8 @@ public void testRangeValidator() throws Exception domainDesignerPage.clickFinish(); // now verify the expected validator is formed and added to the field's validator array - DomainResponse response = dgen.getDomain(createDefaultConnection()); + Connection cn = createDefaultConnection(); + DomainDetailsResponse response = dgen.getQueryHelper(cn).getDomainDetails(); PropertyDescriptor sizeCol = getColumn(response.getDomain(), "size"); Map validator = getPropertyValidator(sizeCol, "midsize"); assertEquals("expect expression to be ", "~gte=2&~lte=3", validator.get("expression")); @@ -1299,7 +1314,8 @@ public void testConditionalFormat() throws Exception domainDesignerPage.clickFinish(); // now verify the expected validator is formed and added to the field's validator array - DomainResponse response = dgen.getDomain(createDefaultConnection()); + Connection cn = createDefaultConnection(); + DomainDetailsResponse response = dgen.getQueryHelper(cn).getDomainDetails(); PropertyDescriptor faveSnackCol = getColumn(response.getDomain(), "favoriteSnack"); Map validator = getConditionalFormats(faveSnackCol, "format.column~doesnotcontain=almond"); assertEquals("expect italics to be set", true, validator.get("italic")); @@ -1336,7 +1352,8 @@ public void testRegexValidator() throws Exception domainDesignerPage.clickFinish(); // now verify the expected validator is formed and added to the field's validator array - DomainResponse response = dgen.getDomain(createDefaultConnection()); + Connection cn = createDefaultConnection(); + DomainDetailsResponse response = dgen.getQueryHelper(cn).getDomainDetails(); PropertyDescriptor faveSnackCol = getColumn(response.getDomain(), "favoriteSnack"); Map specialCharsValidator = getPropertyValidator(faveSnackCol, "neverTwizzlers"); assertEquals("validator we just created should be new", true, specialCharsValidator.get("new")); @@ -1389,7 +1406,8 @@ public void addUpdateRemoveRegexValidator() throws Exception domainDesignerPage.clickFinish(); // now verify the expected validator is formed and added to the field's validator array - DomainResponse response = dgen.getDomain(createDefaultConnection()); + Connection cn1 = createDefaultConnection(); + DomainDetailsResponse response = dgen.getQueryHelper(cn1).getDomainDetails(); PropertyDescriptor faveSnackCol = getColumn(response.getDomain(), "favoriteSnack"); Map specialCharsValidator = getPropertyValidator(faveSnackCol, "specialChars"); assertEquals("validator we just created should be new", true, specialCharsValidator.get("new")); @@ -1416,7 +1434,8 @@ public void addUpdateRemoveRegexValidator() throws Exception DataRegionTable.DataRegion(getDriver()).withName("query").waitFor(); // now confirm 2 validators on the field - DomainResponse newResponse = dgen.getDomain(createDefaultConnection()); + Connection cn = createDefaultConnection(); + DomainDetailsResponse newResponse = dgen.getQueryHelper(cn).getDomainDetails(); PropertyDescriptor snackField = getColumn(newResponse.getDomain(), "favoriteSnack"); List> validators = (List>) snackField.getAllProperties().get("propertyValidators"); @@ -1464,7 +1483,8 @@ public void addUpdateRemoveRangeValidator() throws Exception domainDesignerPage.clickFinish(); // now verify we have 3 formats on the size field - DomainResponse response = dgen.getDomain(createDefaultConnection()); + Connection cn1 = createDefaultConnection(); + DomainDetailsResponse response = dgen.getQueryHelper(cn1).getDomainDetails(); PropertyDescriptor sizeCol = getColumn(response.getDomain(), "size"); Map lte2 = getPropertyValidator(sizeCol, "lte2"); Map equals3 = getPropertyValidator(sizeCol, "equals3"); @@ -1487,7 +1507,8 @@ public void addUpdateRemoveRangeValidator() throws Exception DataRegionTable.DataRegion(getDriver()).withName("query").waitFor(); // now verify we have 2 formats on the size field - DomainResponse updatedResponse = dgen.getDomain(createDefaultConnection()); + Connection cn = createDefaultConnection(); + DomainDetailsResponse updatedResponse = dgen.getQueryHelper(cn).getDomainDetails(); PropertyDescriptor updatedSizeCol = getColumn(updatedResponse.getDomain(), "size"); List> validators = (List>) updatedSizeCol.getAllProperties().get("propertyValidators"); assertEquals("expect only 2 validators on the field", 2, validators.size()); @@ -1530,7 +1551,8 @@ public void addUpdateRemoveConditionalFormat() throws Exception domainDesignerPage.clickFinish(); // now verify we have 3 - DomainResponse response = dgen.getDomain(createDefaultConnection()); + Connection cn1 = createDefaultConnection(); + DomainDetailsResponse response = dgen.getQueryHelper(cn1).getDomainDetails(); PropertyDescriptor heroCol = getColumn(response.getDomain(), "superHero"); Map thorMap = getConditionalFormats(heroCol, "format.column~eq=Thor"); Map aquaMap = getConditionalFormats(heroCol, "format.column~eq=Aquaman"); @@ -1549,7 +1571,8 @@ public void addUpdateRemoveConditionalFormat() throws Exception dlg.clickApply(); domainDesignerPage.clickFinish(); - DomainResponse validationResponse = dgen.getDomain(createDefaultConnection()); + Connection cn = createDefaultConnection(); + DomainDetailsResponse validationResponse = dgen.getQueryHelper(cn).getDomainDetails(); PropertyDescriptor editedHeroCol = getColumn(validationResponse.getDomain(), "superHero"); List> formats = (List>) editedHeroCol.getAllProperties().get("conditionalFormats"); diff --git a/src/org/labkey/test/tests/JavaClientApiTest.java b/src/org/labkey/test/tests/JavaClientApiTest.java index 327584f13f..bcb2ac6a87 100644 --- a/src/org/labkey/test/tests/JavaClientApiTest.java +++ b/src/org/labkey/test/tests/JavaClientApiTest.java @@ -23,9 +23,10 @@ import org.labkey.remoteapi.Connection; import org.labkey.remoteapi.domain.CreateDomainCommand; import org.labkey.remoteapi.domain.Domain; +import org.labkey.remoteapi.domain.DomainDetailsResponse; import org.labkey.remoteapi.domain.DomainResponse; import org.labkey.remoteapi.domain.DropDomainCommand; -import org.labkey.remoteapi.domain.GetDomainCommand; +import org.labkey.remoteapi.domain.GetDomainDetailsCommand; import org.labkey.remoteapi.domain.PropertyDescriptor; import org.labkey.remoteapi.domain.SaveDomainCommand; import org.labkey.remoteapi.query.DeleteRowsCommand; @@ -357,9 +358,9 @@ public void doDomainTest() throws Exception Set expected = new HashSet<>(Arrays.asList("key", "foo", "bar", "baz")); verifyDomain(response.getDomain(), expected); - GetDomainCommand getCmd = new GetDomainCommand("lists", LIST_NAME); - response = getCmd.execute(cn, PROJECT_NAME); - verifyDomain(response.getDomain(), expected); + GetDomainDetailsCommand getCmd = new GetDomainDetailsCommand("lists", LIST_NAME); + DomainDetailsResponse detailsResponse = getCmd.execute(cn, PROJECT_NAME); + verifyDomain(detailsResponse.getDomain(), expected); log("modify the existing domain"); SaveDomainCommand saveCmd = new SaveDomainCommand("lists", LIST_NAME); diff --git a/src/org/labkey/test/tests/issues/IssueDomainTest.java b/src/org/labkey/test/tests/issues/IssueDomainTest.java index 3243dd0355..af511d3ae8 100644 --- a/src/org/labkey/test/tests/issues/IssueDomainTest.java +++ b/src/org/labkey/test/tests/issues/IssueDomainTest.java @@ -6,8 +6,8 @@ import org.junit.experimental.categories.Category; import org.labkey.remoteapi.CommandException; import org.labkey.remoteapi.domain.Domain; -import org.labkey.remoteapi.domain.DomainResponse; -import org.labkey.remoteapi.domain.GetDomainCommand; +import org.labkey.remoteapi.domain.DomainDetailsResponse; +import org.labkey.remoteapi.domain.GetDomainDetailsCommand; import org.labkey.remoteapi.domain.PropertyDescriptor; import org.labkey.remoteapi.domain.SaveDomainCommand; import org.labkey.test.BaseWebDriverTest; @@ -88,8 +88,8 @@ public void mandatoryFieldTest() throws Exception List mandatoryFields = Arrays.asList("title", "notifylist", "assignedto", "resolution"); for (String mandatoryField : mandatoryFields) { - GetDomainCommand getCmd = new GetDomainCommand(DOMAIN_NAME, ISSUES_NAME); - DomainResponse getDomainResponse = getCmd.execute(this.createDefaultConnection(), getContainerPath()); + GetDomainDetailsCommand getCmd = new GetDomainDetailsCommand(DOMAIN_NAME, ISSUES_NAME); + DomainDetailsResponse getDomainResponse = getCmd.execute(this.createDefaultConnection(), getContainerPath()); List getDomainCols = getDomainResponse.getDomain().getFields(); ListIterator getDomainColsIterator = getDomainCols.listIterator(); diff --git a/src/org/labkey/test/util/DomainUtils.java b/src/org/labkey/test/util/DomainUtils.java index 34d6f8d2e7..55f324dc95 100644 --- a/src/org/labkey/test/util/DomainUtils.java +++ b/src/org/labkey/test/util/DomainUtils.java @@ -3,9 +3,8 @@ import org.labkey.remoteapi.CommandException; import org.labkey.remoteapi.CommandResponse; import org.labkey.remoteapi.Connection; -import org.labkey.remoteapi.domain.DomainResponse; import org.labkey.remoteapi.domain.DropDomainCommand; -import org.labkey.remoteapi.domain.GetDomainCommand; +import org.labkey.remoteapi.domain.GetDomainDetailsCommand; import org.labkey.test.WebTestHelper; import java.io.IOException; @@ -54,10 +53,10 @@ public static CommandResponse deleteDomain(final String containerPath, final Str public static boolean doesDomainExist(final String containerPath, final String schema, final String queryName) { Connection connection = WebTestHelper.getRemoteApiConnection(); - GetDomainCommand cmd = new GetDomainCommand(schema, queryName); + GetDomainDetailsCommand cmd = new GetDomainDetailsCommand(schema, queryName); try { - DomainResponse response = cmd.execute(connection, containerPath); + cmd.execute(connection, containerPath); return true; } catch (CommandException ce) diff --git a/src/org/labkey/test/util/TestDataGenerator.java b/src/org/labkey/test/util/TestDataGenerator.java index d1dd057b60..d0b023dc90 100644 --- a/src/org/labkey/test/util/TestDataGenerator.java +++ b/src/org/labkey/test/util/TestDataGenerator.java @@ -34,6 +34,7 @@ import org.labkey.test.TestFileUtils; import org.labkey.test.WebTestHelper; import org.labkey.test.params.FieldDefinition; +import org.labkey.test.params.list.IntListDefinition; import org.labkey.test.util.query.QueryApiHelper; import java.io.File; @@ -423,15 +424,6 @@ public DomainResponse createList(Connection cn, String keyName) throws IOExcepti return createDomain(cn, "IntList", Map.of("keyName", keyName)); } - /** - * @deprecated Use {@link QueryApiHelper} - */ - @Deprecated(since = "22.4") - public DomainResponse getDomain(Connection cn) throws IOException, CommandException - { - return getQueryHelper(cn).getDomain(); - } - /** * @deprecated Use {@link QueryApiHelper} */ diff --git a/src/org/labkey/test/util/query/QueryApiHelper.java b/src/org/labkey/test/util/query/QueryApiHelper.java index 545b2722c4..ed19a881d7 100644 --- a/src/org/labkey/test/util/query/QueryApiHelper.java +++ b/src/org/labkey/test/util/query/QueryApiHelper.java @@ -4,9 +4,9 @@ import org.labkey.remoteapi.CommandException; import org.labkey.remoteapi.CommandResponse; import org.labkey.remoteapi.Connection; -import org.labkey.remoteapi.domain.DomainResponse; +import org.labkey.remoteapi.domain.DomainDetailsResponse; import org.labkey.remoteapi.domain.DropDomainCommand; -import org.labkey.remoteapi.domain.GetDomainCommand; +import org.labkey.remoteapi.domain.GetDomainDetailsCommand; import org.labkey.remoteapi.query.DeleteRowsCommand; import org.labkey.remoteapi.query.Filter; import org.labkey.remoteapi.query.InsertRowsCommand; @@ -118,9 +118,9 @@ public TruncateTableResponse truncateTable() throws IOException, CommandExceptio return truncateCommand.execute(_connection, _containerPath); } - public DomainResponse getDomain() throws IOException, CommandException + public DomainDetailsResponse getDomainDetails() throws IOException, CommandException { - GetDomainCommand cmd = new GetDomainCommand(_schema, _query); + GetDomainDetailsCommand cmd = new GetDomainDetailsCommand(_schema, _query); return cmd.execute(_connection, _containerPath); }