Test Automation for Date-only and Time-only Fields #1836

labkey-danield · 2024-02-23T21:11:45Z

Rationale

Test automation for the date-only and time-only fields.

I honestly tried to put the new date-only and time-only tests into ListTest. However the ListTest is an older tests and several "one-off" checks have been added to it that made it difficult to insert new tests. Several of the older tests use a globally defined list that made it very difficult to add new columns to without causing other tests to fail. Several tests used column positions as part of validation which also made adding new fields difficult. I cleaned up the List test a bit but it was still easier to add the date and time only tests in a separate file.

This change also include a consolidation of the site "look and feel" page with the folder "configuration" page. Some of the tests for this story needed to validate the reconciliation of formate setting in site vs. folder. Consolidating the two pages made the tests cleaner.

@XingY The new test cases for date & time only fields are:

There are also several data files that have been updated I'll leave up to you if want to review.

The ListTest was also change but was primarily for clean up, using new helpers, etc... There are no specific date and time only tests in this file.

I have TeamCity run that exercises all of theses tests.

@labkey-tchad I believe you have already reviewed the setting page changes. I haven't changed them since the initial draft review. For completeness the changes mostly focused on the form change are:

DiscussionLinkTest.java was updated to use the new settings page.

A new method, setTypeWithDialog, was added to DomainFieldRow.java. This was added to accommodate the test that validate changing a dateTime field to a date or time only field.

Related Pull Requests

Changes

Added DomainFieldRow.setTypeWithDialog. This returns the dialog so the warning message when converting a field can be validated.
Consolidated the settings page for Site and Folder.
- Created BaseSettingsPage which has the shared functionality between the site and folder settings page.
- Changed LookAndFeelSettingsPage to derive from BaseSettingsPage
- Changed ProjectSettingsPage to derive from BaseSettingsPage
- Had to update a few tests because of this change.
Added tests to ProjectSettingsTest to validate site and folder settings are scoped correctly.
Changed VarListDefinition.addField to validate that the assumed key field is of a valid key type.
Added date-only and time-only tests to ParsingPatternForDateTest
Added ListDateAndTimeTest.
"Cleaned up" ListTest
- This test needs to be refactored.
Added AssayTest
- Validate date and time only fields in results and run fields.
Added DataClasses
- Possibly redundant with the list tests and may not add much value.

Add a date and time fields to ParsingPatternForDateTest.java Update ProjectSettingsTest to actually check the menu.

Add time and date format fields to setting page. Updated test to use consolidated page.

Clean up test that uses additional pattern parsing.

Replaced a DateTime field with a TextChoice field. Moved checks for DateTime field into separate tests. Added tests for import and sorting date-only and time-only fields. Added a check to VarListDefinition to validate that the assumed field to be the key is of the correct type.

… It was making the test too large and unmanageable. Added tests for formatting and bad values validation.

…to validate warning message. Add test that converts a DateTime field to a date-only field and a time-only field.

XingY

Will there be a separate story for checking date/time values in Assay Run domains? Samples/dataclass can be checked additionally in apps, dataset can probably be skipped. But it would be good to have some test coverage for Assay Run fields since its backend implementation is different

XingY · 2024-02-26T18:52:10Z

src/org/labkey/test/tests/ParsingPatternForDateTest.java

    }

-    private void setUpDataParsing(String pattern)
+    private void setAdditionalParsingPatterns(String dateTimePattern, String datePattern, String timePattern)


Do we have any coverage for site/project level setting for those fields?

I have added tests that validate parsing mode set at site and project levels.

XingY · 2024-02-26T18:52:49Z

src/org/labkey/test/tests/ParsingPatternForDateTest.java

-        String pattern = "ddMMMyyyy:HH:mm:ss";
-        setUpDataParsing(pattern);
+        log("Setting the additional parsing patterns.");
+        String dateTimePattern = "ddMMMyyyy:HH:mm:ss";


Do we have test coverage for US vs non-US parsing mode?

I've added a test for non-US parsing.

XingY · 2024-02-26T18:57:29Z

src/org/labkey/test/tests/list/ListDateAndTimeTest.java

+
+        List<Date> dates = new ArrayList<>();
+
+        dates.add(new Calendar.Builder()


For regression testing for issue 47341, it would be useful to have a datetime value with actual time portion that's before 1970. The test can test 2 things: before converting to time field, export will export datetime as expected. After converting to time, the column in UI and exported are both as expected. This can be a separate test case.

There are test dates that happen before 1970 (Date-only, Time-only and DateTime values). I think the test date is 1952, or sometime in the 50's, so we should be good there.

I've added test that validate the round trip import / export issue with excel called out in issue 47341. The roundtrip does include dates before 1970.

XingY · 2024-02-26T19:01:00Z

src/org/labkey/test/tests/ParsingPatternForDateTest.java

-        click(Locator.tagWithText("h3", "Upload file (.xlsx, .xls, .csv, .txt)"));
+        click(Locator.tagContainingText("h3", "Upload file"));
+
+        // Note: the date and time columns in this xlsx are formatted as date and time types. Excel does not have a date-time format, that is a string.


Hmm.. Date/Time/Datetime in excel are all "Numbers", with different format. The field should be a "Number" type, not a string type.

Though it would be good to have separate coverage that test import from excel with "String" type date/time/datetime too.

I have added a xlsx file for import that has Date, Time and DateTime fields in text format.

Add a test that validates dates & times in a xlsx that are in string format.

src/org/labkey/test/params/list/VarListDefinition.java

src/org/labkey/test/pages/core/admin/ProjectSettingsPage.java

src/org/labkey/test/tests/ProjectSettingsTest.java

Add better check for assay tests.

Validate export to excel of list data. Validate export to excel of assay runs grid.

Cleaned up some other checks.

XingY · 2024-03-12T20:44:11Z

src/org/labkey/test/tests/GpatAssayTest.java

+        setAssayResultsProperties(assayDesignerPage, 11);
+
+        DomainFormPanel domainFormPanel = assayDesignerPage.expandFieldsPanel("Run Fields");
+        domainFormPanel.addField(new FieldDefinition("Date", FieldDefinition.ColumnType.Date));


Is there coverage for converting assay run fields from datetime -> date/time?

There is now.

labkey-tchad

There are a lot of places that could be sped up by using APIs

src/org/labkey/test/tests/list/ListDateAndTimeTest.java

labkey-tchad · 2024-03-12T23:55:08Z

src/org/labkey/test/tests/list/ListDateAndTimeTest.java

+    private void prepForDateAndTimeOnlyTest(String listName) throws IOException, CommandException
+    {
+        log("Reset site setting to have default formats for date and time values.");
+        LookAndFeelSettingsPage settingsPage = LookAndFeelSettingsPage.beginAt(this);
+        settingsPage.reset();
+
+        // Reset doesn't wait for page (page may or may not refresh).
+        sleep(500);
+
+        // Use java's Date object and SimpleDateFormatter (not strings) to enter the data.
+        _defaultDateFormat = new SimpleDateFormat(settingsPage.getDefaultDateDisplay());
+        _defaultTimeFormat = new SimpleDateFormat(settingsPage.getDefaultTimeDisplay());
+        _defaultDateTimeFormat = new SimpleDateFormat(settingsPage.getDefaultDateTimeDisplay());
+
+        deleteListIfPresent(getProjectName(), listName);
+
+    }


This does a lot of unnecessary UI groveling. Only getting the default formats requires going through the UI and that only needs to happen once (during doSetup would be good). The rest of this (resetting the look and feel and deleting the list) can be done via API.

…n assay run. Fixed some typos. Removing use of AfterClass method. Adding a site look and feel reset to TestScrubber.

labkey-tchad

Still a lot of places that could be sped up by using APIs. ListDateAndTimeTest creates a lot of lists via UI.

labkey-tchad · 2024-03-14T19:19:25Z

src/org/labkey/test/TestScrubber.java

+            new SimplePostCommand("admin", "resetProperties")
+                    .execute(createDefaultConnection(), "/");


Move this to a static method in BaseSettingsPage to be shared with test.

labkey-tchad · 2024-03-14T19:22:19Z

src/org/labkey/test/tests/ParsingPatternForDateTest.java

+        catch (IOException | CommandException e)
+        {
+            TestLogger.error("Failed to reset site look and settings.", e);
+        }


I don't think this error should be ignored. Swallowing the exception could lead to hard-to-diagnose failures.

Changed to throw a new runtime exception.

labkey-tchad · 2024-03-14T19:28:02Z

src/org/labkey/test/tests/ParsingPatternForDateTest.java

+        catch (IOException | CommandException e)
+        {
+            TestLogger.error("Failed to reset project settings.", e);
+        }


Rethrow this instead of ignoring it.

Suggested change

catch (IOException | CommandException e)

{

TestLogger.error("Failed to reset project settings.", e);

}

catch (IOException | CommandException e)

{

throw new RuntimeException("Failed to reset project settings.", e);

}

labkey-tchad · 2024-03-14T19:31:18Z

src/org/labkey/test/tests/ParsingPatternForDateTest.java

+        goToProjectHome();
+        if(goToManageLists().getGrid().getListNames().contains(listName))
+        {
+            _listHelper.goToList(listName);
+            _listHelper.deleteList();
+        }


Did DomainUtils.ensureDeleted(getProjectName(), "lists", listName); not work for this?

It did, but I must have missed this reference or undid the change as I was doing other updates.
Added it back.

labkey-tchad · 2024-03-14T19:36:38Z

src/org/labkey/test/tests/ProjectSettingsTest.java

+    private void createDateAndTimeList(String project, List<Map<String, String>> listData)
+    {
+        _listHelper.createList(project, DT_LIST_NAME, ListHelper.ListColumnType.AutoInteger, DT_LIST_ID_COL,
+                new FieldDefinition(DT_LIST_DATE_COL, FieldDefinition.ColumnType.Date),
+                new FieldDefinition(DT_LIST_TIME_COL, FieldDefinition.ColumnType.Time),
+                new FieldDefinition(DT_LIST_DATETIME_COL, FieldDefinition.ColumnType.DateAndTime));
+
+
+        // Use the default format to initially populate the lists.
+        StringBuilder bulkImportData = new StringBuilder();
+        bulkImportData.append(String.format("%s\t%s\t%s\n", DT_LIST_DATE_COL, DT_LIST_TIME_COL, DT_LIST_DATETIME_COL));
+
+        for(Map<String, String> listRow : listData)
+        {
+            bulkImportData.append(String.format("%s\t%s\t%s\n",
+                    listRow.get(DT_LIST_DATE_COL),
+                    listRow.get(DT_LIST_TIME_COL),
+                    listRow.get(DT_LIST_DATETIME_COL))
+            );
+        }
+
+        _listHelper.bulkImportData(bulkImportData.toString());
+
    }


This isn't a list or domain designer focused test, it shouldn't spend a bunch of time in UI that is tested elsewhere. Use API helpers for list creation (IntListDefinition) and data import (TestDataGenerator).

labkey-tchad · 2024-03-14T19:37:36Z

src/org/labkey/test/tests/ProjectSettingsTest.java

+    private void resetSiteSettings()
+    {
+        LookAndFeelSettingsPage settingsPage = LookAndFeelSettingsPage.beginAt(this);
+        settingsPage.reset();
+    }
+
+    private void resetProjectSettings()
+    {
+        ProjectSettingsPage settingsPage = ProjectSettingsPage.beginAt(this, PROJ_CHANGE);
+        settingsPage.reset();
    }


Use API to reset site/project settings

labkey-tchad · 2024-03-14T19:42:21Z

src/org/labkey/test/tests/list/ListDateAndTimeTest.java

+    private SimpleDateFormat _defaultDateFormat = new SimpleDateFormat("yyyy-MM-dd");
+    private SimpleDateFormat _defaultTimeFormat = new SimpleDateFormat("HH:mm:ss");
+    private SimpleDateFormat _defaultDateTimeFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm");


It is misleading to give these initial values since they get defined in doSetup. They also need to be static for tests to see the value set in doSetup (each @Test is run with a different instance of the test class).

Suggested change

private SimpleDateFormat _defaultDateFormat = new SimpleDateFormat("yyyy-MM-dd");

private SimpleDateFormat _defaultTimeFormat = new SimpleDateFormat("HH:mm:ss");

private SimpleDateFormat _defaultDateTimeFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm");

// Fetched from look and feel page in 'doSetup'

private static SimpleDateFormat _defaultDateFormat = null;

private static SimpleDateFormat _defaultTimeFormat = null;

private static SimpleDateFormat _defaultDateTimeFormat = null;

labkey-tchad · 2024-03-14T19:44:52Z

src/org/labkey/test/tests/list/ListDateAndTimeTest.java

+        int rowIndex = 0;
+        for(Map<String, String> expectedRowMap : expectedData)
+        {
+            // Protect against expecting more rows than are present in the grid.


Why protect against this? You've already verified that the table has the correct number of rows.

So it does not get an index out of bounds error and stops the entire tests.

labkey-tchad · 2024-03-14T19:56:07Z

src/org/labkey/test/pages/core/admin/BaseSettingsPage.java

+import org.openqa.selenium.WebDriver;
+import org.openqa.selenium.WebElement;
+
+public class BaseSettingsPage extends LabKeyPage<LabKeyPage<?>.ElementCache>


If you change how this is declared, you won't have to override elementCache below.

Suggested change

public class BaseSettingsPage extends LabKeyPage<LabKeyPage<?>.ElementCache>

public class BaseSettingsPage extends LabKeyPage<BaseSettingsPage.ElementCache>

… empty fields. Take into account different format between MSSQL and postgres after converting a date, time or dateTime field to String.

labkey-danield added 17 commits February 5, 2024 18:36

Add date and time types to FieldDefinition.

f367b9e

Add a date and time fields to ParsingPatternForDateTest.java Update ProjectSettingsTest to actually check the menu.

Merge branch 'develop' into fb_dateAndTimeAutomation

0be3b4f

Merge branch 'develop' into fb_dateAndTimeAutomation

943b685

Merge from develop.

19d30d6

Consolidate LookAndFeelSettingsPage and ProjectSettingsPage.

dee0c41

Add time and date format fields to setting page. Updated test to use consolidated page.

Clean up tests validating checking site settings vs project settings.

875bbb4

Clean up test that uses additional pattern parsing.

Merge branch 'develop' into fb_dateAndTimeAutomation

98134ba

Merge branch 'develop' into fb_dateAndTimeAutomation

9b70169

Use a date object and a date formatter for the expected data checks.

95a6e08

Merge branch 'develop' into fb_dateAndTimeAutomation

f33fa34

Merge branch 'develop' into fb_dateAndTimeAutomation

d430de2

Merge branch 'develop' into fb_dateAndTimeAutomation

953224f

Breaking the daet-only and time-only tests out of the older ListTest.…

cefc8af

… It was making the test too large and unmanageable. Added tests for formatting and bad values validation.

Add more comments.

b9362c0

Add a method to DomainFieldRow that returns the dialog. This is used …

122565c

…to validate warning message. Add test that converts a DateTime field to a date-only field and a time-only field.

Change test to expect 00:00:00 if a date is given for a time-only field.

777575d

labkey-danield requested review from XingY and labkey-tchad February 26, 2024 18:15

XingY reviewed Feb 26, 2024

View reviewed changes

labkey-danield added 7 commits February 27, 2024 11:43

Merge branch 'develop' into fb_dateAndTimeAutomation

b2e2663

Merge branch 'develop' into fb_dateAndTimeAutomation

3e38995

Merge branch 'develop' into fb_dateAndTimeAutomation

c6bef5d

Test for site-wide vs project specific import formats.

80243ed

Add a test that validates dates & times in a xlsx that are in string format.

Merge branch 'develop' into fb_dateAndTimeAutomation

b1f28a9

Date-only and Time-only Tests for Assays

20b2f7d

DataClass tests for date-only and time-only fields.

8335273

labkey-tchad reviewed Mar 6, 2024

View reviewed changes

src/org/labkey/test/params/list/VarListDefinition.java Outdated Show resolved Hide resolved

src/org/labkey/test/pages/core/admin/ProjectSettingsPage.java Outdated Show resolved Hide resolved

src/org/labkey/test/tests/ProjectSettingsTest.java Outdated Show resolved Hide resolved

labkey-danield added 2 commits March 7, 2024 06:28

Remove unused / unneeded code.

adafea1

Add better check for assay tests.

Merge branch 'develop' into fb_dateAndTimeAutomation

618e3ba

labkey-danield added 3 commits March 7, 2024 17:01

Merge branch 'develop' into fb_dateAndTimeAutomation

ed88035

Add test to validate date-only and time-only fields in assay run fields.

c1bb451

Validate export to excel of list data. Validate export to excel of assay runs grid.

Merge branch 'develop' into fb_dateAndTimeAutomation

d402d57

labkey-danield marked this pull request as ready for review March 11, 2024 22:37

labkey-danield added 3 commits March 11, 2024 15:40

Remove check from VarListDefinition.

06fc497

Cleaned up some other checks.

Fix setting the date in the future.

9d64c83

Adding a couple of comments.

942999a

labkey-danield requested review from XingY and labkey-tchad March 12, 2024 19:57

XingY approved these changes Mar 12, 2024

View reviewed changes

Remove unused import.

ccc1260

labkey-tchad requested changes Mar 12, 2024

View reviewed changes

labkey-danield added 2 commits March 12, 2024 18:21

Merge branch 'develop' into fb_dateAndTimeAutomation

811f04b

Added test that converts date, time and dateTime fields that are in a…

63dd712

…n assay run. Fixed some typos. Removing use of AfterClass method. Adding a site look and feel reset to TestScrubber.

labkey-danield requested a review from labkey-tchad March 14, 2024 01:42

Merge branch 'develop' into fb_dateAndTimeAutomation

c86162e

labkey-tchad approved these changes Mar 14, 2024

View reviewed changes

labkey-tchad reviewed Mar 14, 2024

View reviewed changes

labkey-danield added 4 commits March 14, 2024 16:07

Yet more code review feedback.

4b2d459

Merge branch 'develop' into fb_dateAndTimeAutomation

4c9ccbf

Make sure project settings are reset before test.

d8ba9de

Take into account different sort order between MSSQL and postgres for…

105aaa4

… empty fields. Take into account different format between MSSQL and postgres after converting a date, time or dateTime field to String.

labkey-danield merged commit bb131fe into develop Mar 18, 2024
2 checks passed

labkey-danield deleted the fb_dateAndTimeAutomation branch March 18, 2024 20:12

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Test Automation for Date-only and Time-only Fields #1836

Test Automation for Date-only and Time-only Fields #1836

labkey-danield commented Feb 23, 2024 •

edited

Loading

XingY left a comment

XingY Feb 26, 2024

labkey-danield Mar 4, 2024

XingY Feb 26, 2024

labkey-danield Mar 5, 2024

XingY Feb 26, 2024

labkey-danield Mar 11, 2024 •

edited

Loading

XingY Feb 26, 2024

XingY Feb 26, 2024

labkey-danield Mar 4, 2024

XingY Mar 12, 2024

labkey-danield Mar 13, 2024

labkey-tchad left a comment

labkey-tchad Mar 12, 2024

labkey-danield Mar 14, 2024 •

edited

Loading

labkey-tchad left a comment

labkey-tchad Mar 14, 2024

labkey-danield Mar 14, 2024

labkey-tchad Mar 14, 2024

labkey-danield Mar 14, 2024 •

edited

Loading

labkey-tchad Mar 14, 2024

labkey-danield Mar 14, 2024

labkey-tchad Mar 14, 2024

labkey-danield Mar 14, 2024

labkey-tchad Mar 14, 2024

labkey-danield Mar 14, 2024

labkey-tchad Mar 14, 2024

labkey-danield Mar 14, 2024

labkey-tchad Mar 14, 2024

labkey-danield Mar 14, 2024

labkey-tchad Mar 14, 2024

labkey-danield Mar 14, 2024

labkey-tchad Mar 14, 2024

labkey-danield Mar 14, 2024


		List<Date> dates = new ArrayList<>();

		dates.add(new Calendar.Builder()

		new SimplePostCommand("admin", "resetProperties")
		.execute(createDefaultConnection(), "/");

-    private SimpleDateFormat _defaultDateFormat = new SimpleDateFormat("yyyy-MM-dd");
-    private SimpleDateFormat _defaultTimeFormat = new SimpleDateFormat("HH:mm:ss");
-    private SimpleDateFormat _defaultDateTimeFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm");
+    // Fetched from look and feel page in 'doSetup'
+    private static SimpleDateFormat _defaultDateFormat = null;
+    private static SimpleDateFormat _defaultTimeFormat = null;
+    private static SimpleDateFormat _defaultDateTimeFormat = null;

	public class BaseSettingsPage extends LabKeyPage<LabKeyPage<?>.ElementCache>
	public class BaseSettingsPage extends LabKeyPage<BaseSettingsPage.ElementCache>

Test Automation for Date-only and Time-only Fields #1836

Test Automation for Date-only and Time-only Fields #1836

Conversation

labkey-danield commented Feb 23, 2024 • edited Loading

Rationale

Test automation for the date-only and time-only fields.

Related Pull Requests

Changes

XingY left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

labkey-danield Mar 11, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

labkey-tchad left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

labkey-danield Mar 14, 2024 • edited Loading

Choose a reason for hiding this comment

labkey-tchad left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

labkey-danield Mar 14, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

labkey-danield commented Feb 23, 2024 •

edited

Loading

labkey-danield Mar 11, 2024 •

edited

Loading

labkey-danield Mar 14, 2024 •

edited

Loading

labkey-danield Mar 14, 2024 •

edited

Loading