test: switched to MACRO_CASE for test constants (#4078)

Author: mrtopsyt

explorer/e2e/anvil-catalog/anvilcatalog-select-tabs.spec.ts

@@ -3,32 +3,32 @@ import {
   testPreSelectedColumns,
   testSelectableColumns,
 } from "../testFunctions";
-import { anvilcatalogTabs } from "./anvilcatalog-tabs";
+import { ANVIL_CATALOG_TABS } from "./anvilcatalog-tabs";
 
 test("Expect the checkboxes in the 'Edit Columns' menu to add those columns to the tab in the Consortia tab", async ({
   page,
 }) => {
-  const tab = anvilcatalogTabs.consortia;
+  const tab = ANVIL_CATALOG_TABS.CONSORTIA;
   await testSelectableColumns(page, tab);
 });
 
 test("Expect the checkboxes for preselected columns in the 'Edit Columns' menu to be checked and disabled on the consortia tab", async ({
   page,
 }) => {
-  const tab = anvilcatalogTabs.consortia;
+  const tab = ANVIL_CATALOG_TABS.CONSORTIA;
   await testPreSelectedColumns(page, tab);
 });
 
 test("Expect the checkboxes for preselected columns in the 'Edit Columns' menu to be checked and disabled on the studies tab", async ({
   page,
 }) => {
-  const tab = anvilcatalogTabs.studies;
+  const tab = ANVIL_CATALOG_TABS.STUDIES;
   await testPreSelectedColumns(page, tab);
 });
 
 test("Expect the checkboxes for preselected columns in the 'Edit Columns' menu to be checked and disabled on the workspaces tab", async ({
   page,
 }) => {
-  const tab = anvilcatalogTabs.workspaces;
+  const tab = ANVIL_CATALOG_TABS.WORKSPACES;
   await testPreSelectedColumns(page, tab);
 });

explorer/e2e/anvil-catalog/anvilcatalog-sort.spec.ts

@@ -1,21 +1,21 @@
 import { test } from "@playwright/test";
 import { testSortCatalog } from "../testFunctions";
-import { anvilcatalogTabs } from "./anvilcatalog-tabs";
+import { ANVIL_CATALOG_TABS } from "./anvilcatalog-tabs";
 
 test("On the Consortia tab, expect clicking the column header (the sort button) to keep the first element of the column visible", async ({
   page,
 }) => {
-  await testSortCatalog(page, anvilcatalogTabs.consortia);
+  await testSortCatalog(page, ANVIL_CATALOG_TABS.CONSORTIA);
 });
 
 test("On the Studies tab, expect clicking the column header (the sort button) to keep the first element of the column visible", async ({
   page,
 }) => {
-  await testSortCatalog(page, anvilcatalogTabs.studies);
+  await testSortCatalog(page, ANVIL_CATALOG_TABS.STUDIES);
 });
 
 test("On the Workspaces tab, expect clicking the column header (the sort button) to keep the first element of the column visible", async ({
   page,
 }) => {
-  await testSortCatalog(page, anvilcatalogTabs.workspaces);
+  await testSortCatalog(page, ANVIL_CATALOG_TABS.WORKSPACES);
 });

explorer/e2e/anvil-catalog/anvilcatalog-tabs-buttons.spec.ts

@@ -1,21 +1,29 @@
 import { test } from "@playwright/test";
 import { testTab } from "../testFunctions";
-import { anvilcatalogTabs } from "./anvilcatalog-tabs";
+import { ANVIL_CATALOG_TABS } from "./anvilcatalog-tabs";
 
 test("Expect clicking the consortia tab to go to the correct url and to show all of the relevant columns when selected", async ({
   page,
 }) => {
-  await testTab(page, anvilcatalogTabs.studies, anvilcatalogTabs.consortia);
+  await testTab(page, ANVIL_CATALOG_TABS.STUDIES, ANVIL_CATALOG_TABS.CONSORTIA);
 });
 
 test("Expect clicking the studies tab to go to the correct url and to show all of the relevant columns when selected", async ({
   page,
 }) => {
-  await testTab(page, anvilcatalogTabs.workspaces, anvilcatalogTabs.studies);
+  await testTab(
+    page,
+    ANVIL_CATALOG_TABS.WORKSPACES,
+    ANVIL_CATALOG_TABS.STUDIES
+  );
 });
 
 test("Expect clicking the workspaces tab to go to the correct url and to show all of the relevant columns when selected", async ({
   page,
 }) => {
-  await testTab(page, anvilcatalogTabs.consortia, anvilcatalogTabs.workspaces);
+  await testTab(
+    page,
+    ANVIL_CATALOG_TABS.CONSORTIA,
+    ANVIL_CATALOG_TABS.WORKSPACES
+  );
 });

explorer/e2e/anvil-catalog/anvilcatalog-tabs.ts

@@ -1,8 +1,8 @@
 /* eslint-disable sonarjs/no-duplicate-string  -- ignoring duplicate strings here */
 import { AnvilCatalogTabCollection, TabDescription } from "../testInterfaces";
 
-export const anvilcatalogTabs: AnvilCatalogTabCollection = {
-  consortia: {
+export const ANVIL_CATALOG_TABS: AnvilCatalogTabCollection = {
+  CONSORTIA: {
     emptyFirstColumn: false,
     preselectedColumns: [
       { name: "Consortium", sortable: true },
@@ -21,7 +21,7 @@ export const anvilcatalogTabs: AnvilCatalogTabCollection = {
     tabName: "Consortia",
     url: "/data/consortia",
   },
-  studies: {
+  STUDIES: {
     emptyFirstColumn: false,
     preselectedColumns: [
       { name: "Study", sortable: true },
@@ -39,7 +39,7 @@ export const anvilcatalogTabs: AnvilCatalogTabCollection = {
     tabName: "Studies",
     url: "/data/studies",
   },
-  workspaces: {
+  WORKSPACES: {
     emptyFirstColumn: false,
     preselectedColumns: [
       { name: "Consortium", sortable: true },
@@ -59,10 +59,10 @@ export const anvilcatalogTabs: AnvilCatalogTabCollection = {
   },
 };
 
-export const anvilCatalogTabList: TabDescription[] = [
-  anvilcatalogTabs.consortia,
-  anvilcatalogTabs.studies,
-  anvilcatalogTabs.workspaces,
+export const ANVIL_CATALOG_TAB_LIST: TabDescription[] = [
+  ANVIL_CATALOG_TABS.CONSORTIA,
+  ANVIL_CATALOG_TABS.STUDIES,
+  ANVIL_CATALOG_TABS.WORKSPACES,
 ];
 
 /* eslint-enable sonarjs/no-duplicate-string -- Checking duplicate strings again*/

explorer/e2e/anvil-catalog/anvilcatalog-url.spec.ts

@@ -1,24 +1,27 @@
 import { test } from "@playwright/test";
 import { testUrl } from "../testFunctions";
-import { anvilCatalogTabList, anvilcatalogTabs } from "./anvilcatalog-tabs";
+import {
+  ANVIL_CATALOG_TABS,
+  ANVIL_CATALOG_TAB_LIST,
+} from "./anvilcatalog-tabs";
 
 test("Expect the consortia tab to appear as selected when the corresponding url is accessed", async ({
   page,
 }) => {
-  const tab = anvilcatalogTabs.consortia;
-  await testUrl(page, tab, anvilCatalogTabList);
+  const tab = ANVIL_CATALOG_TABS.CONSORTIA;
+  await testUrl(page, tab, ANVIL_CATALOG_TAB_LIST);
 });
 
 test("Expect the studies tab to appear as selected when the corresponding url is accessedb", async ({
   page,
 }) => {
-  const tab = anvilcatalogTabs.studies;
-  await testUrl(page, tab, anvilCatalogTabList);
+  const tab = ANVIL_CATALOG_TABS.STUDIES;
+  await testUrl(page, tab, ANVIL_CATALOG_TAB_LIST);
 });
 
 test("Expect the workspaces tab to appear as selected when the corresponding url is accessed", async ({
   page,
 }) => {
-  const tab = anvilcatalogTabs.workspaces;
-  await testUrl(page, tab, anvilCatalogTabList);
+  const tab = ANVIL_CATALOG_TABS.WORKSPACES;
+  await testUrl(page, tab, ANVIL_CATALOG_TAB_LIST);
 });

explorer/e2e/anvil/anvil-backpages.spec.ts

@@ -4,26 +4,26 @@ import {
   testBackpageDetails,
   testExportBackpage,
 } from "../testFunctions";
-import { anvilTabs } from "./anvil-tabs";
+import { ANVIL_TABS } from "./anvil-tabs";
 
 test.skip("Smoke test `Export to Terra` button on the first available dataset", async ({
   context,
   page,
 }) => {
   test.setTimeout(120000);
-  await testExportBackpage(context, page, anvilTabs.datasets);
+  await testExportBackpage(context, page, ANVIL_TABS.DATASETS);
 });
 
 test.skip("Check access controls on the datasets backpages work for the first two tabs", async ({
   page,
 }) => {
   test.setTimeout(120000);
-  await testBackpageAccess(page, anvilTabs.datasets);
+  await testBackpageAccess(page, ANVIL_TABS.DATASETS);
 });
 
 test("Check that information on the backpages matches information in the data tables", async ({
   page,
 }) => {
   test.setTimeout(120000);
-  await testBackpageDetails(page, anvilTabs.datasets);
+  await testBackpageDetails(page, ANVIL_TABS.DATASETS);
 });

explorer/e2e/anvil/anvil-filters.spec.ts

@@ -9,9 +9,9 @@ import {
   testFilterTags,
 } from "../testFunctions";
 import {
-  anvilFilterNames,
-  anvilTabs,
-  anvilTabTestOrder,
+  ANVIL_FILTER_NAMES,
+  ANVIL_TABS,
+  ANVIL_TAB_TEST_ORDER,
   BIOSAMPLE_TYPE_INDEX,
   CONSENT_GROUP_INDEX,
   DATASET_INDEX,
@@ -38,49 +38,51 @@ const FILTER_INDEX_LIST_SHORT = [
 test("Check that all filters exist on the Datasets tab and are clickable", async ({
   page,
 }) => {
-  await testFilterPresence(page, anvilTabs.datasets, anvilFilterNames);
+  await testFilterPresence(page, ANVIL_TABS.DATASETS, ANVIL_FILTER_NAMES);
 });
 
 test("Check that all filters exist on the Donors tab and are clickable", async ({
   page,
 }) => {
-  await testFilterPresence(page, anvilTabs.donors, anvilFilterNames);
+  await testFilterPresence(page, ANVIL_TABS.DONORS, ANVIL_FILTER_NAMES);
 });
 
 test("Check that all filters exist on the BioSamples tab and are clickable", async ({
   page,
 }) => {
-  await testFilterPresence(page, anvilTabs.biosamples, anvilFilterNames);
+  await testFilterPresence(page, ANVIL_TABS.BIOSAMPLES, ANVIL_FILTER_NAMES);
 });
 
 test("Check that all filters exist on the Activities tab and are clickable", async ({
   page,
 }) => {
-  await testFilterPresence(page, anvilTabs.activities, anvilFilterNames);
+  await testFilterPresence(page, ANVIL_TABS.ACTIVITIES, ANVIL_FILTER_NAMES);
 });
 
 test("Check that all filters exist on the Files tab and are clickable", async ({
   page,
 }) => {
-  await testFilterPresence(page, anvilTabs.files, anvilFilterNames);
+  await testFilterPresence(page, ANVIL_TABS.FILES, ANVIL_FILTER_NAMES);
 });
 
 test("Check that the first filter on the Datasets tab creates at least one checkbox, and that checking up to the first five does not cause an error and does not cause there to be no entries in the table", async ({
   page,
 }) => {
   test.setTimeout(120000);
   // Goto the datasets tab
-  await page.goto(anvilTabs.datasets.url);
+  await page.goto(ANVIL_TABS.DATASETS.url);
   await expect(
-    page.getByRole("tab").getByText(anvilTabs.datasets.tabName)
+    page.getByRole("tab").getByText(ANVIL_TABS.DATASETS.tabName)
   ).toBeVisible();
 
   // Select a filter
   await page
     .getByRole("button")
     .getByText(
       filterRegex(
-        anvilFilterNames[Math.floor(Math.random() * anvilFilterNames.length)]
+        ANVIL_FILTER_NAMES[
+          Math.floor(Math.random() * ANVIL_FILTER_NAMES.length)
+        ]
       )
     )
     .click();
@@ -104,8 +106,8 @@ test("Check that filter checkboxes are persistent across pages on an arbitrary f
   test.setTimeout(120000);
   const result = await testFilterPersistence(
     page,
-    anvilFilterNames[FILE_FORMAT_INDEX],
-    anvilTabTestOrder.map((x) => anvilTabs[x])
+    ANVIL_FILTER_NAMES[FILE_FORMAT_INDEX],
+    ANVIL_TAB_TEST_ORDER.map((x) => ANVIL_TABS[x])
   );
   if (!result) {
     test.fail();
@@ -118,9 +120,9 @@ test("Check that filter menu counts match actual counts on the Datasets tab", as
   test.setTimeout(120000);
   const result = await testFilterCounts(
     page,
-    anvilTabs.datasets,
-    FILTER_INDEX_LIST.map((x) => anvilFilterNames[x]),
-    anvilTabs.datasets.maxPages ?? 0
+    ANVIL_TABS.DATASETS,
+    FILTER_INDEX_LIST.map((x) => ANVIL_FILTER_NAMES[x]),
+    ANVIL_TABS.DATASETS.maxPages ?? 0
   );
   if (!result) {
     test.fail();
@@ -133,9 +135,9 @@ test("Check that filter menu counts match actual counts on the Activities tab",
   test.setTimeout(120000);
   await testFilterCounts(
     page,
-    anvilTabs.activities,
-    FILTER_INDEX_LIST.map((x) => anvilFilterNames[x]),
-    anvilTabs.activities.maxPages ?? 0
+    ANVIL_TABS.ACTIVITIES,
+    FILTER_INDEX_LIST.map((x) => ANVIL_FILTER_NAMES[x]),
+    ANVIL_TABS.ACTIVITIES.maxPages ?? 0
   );
 });
 
@@ -145,8 +147,8 @@ test("Check that the filter tags match the selected filter for an arbitrary filt
   test.setTimeout(120000);
   await testFilterTags(
     page,
-    anvilTabs.files,
-    FILTER_INDEX_LIST_SHORT.map((x) => anvilFilterNames[x])
+    ANVIL_TABS.FILES,
+    FILTER_INDEX_LIST_SHORT.map((x) => ANVIL_FILTER_NAMES[x])
   );
 });
 
@@ -156,8 +158,8 @@ test("Check that the filter tags match the selected filter for an arbitrary filt
   test.setTimeout(120000);
   await testFilterTags(
     page,
-    anvilTabs.biosamples,
-    FILTER_INDEX_LIST_SHORT.map((x) => anvilFilterNames[x])
+    ANVIL_TABS.BIOSAMPLES,
+    FILTER_INDEX_LIST_SHORT.map((x) => ANVIL_FILTER_NAMES[x])
   );
 });
 
@@ -167,7 +169,7 @@ test("Check that the clear all button functions on the files tab", async ({
   test.setTimeout(120000);
   await testClearAll(
     page,
-    anvilTabs.files,
-    FILTER_INDEX_LIST_SHORT.map((x) => anvilFilterNames[x])
+    ANVIL_TABS.FILES,
+    FILTER_INDEX_LIST_SHORT.map((x) => ANVIL_FILTER_NAMES[x])
   );
 });

explorer/e2e/anvil/anvil-pagination.spec.ts

@@ -4,12 +4,16 @@ import {
   testFirstPagePagination,
   testPaginationContent,
 } from "../testFunctions";
-import { anvilFilterNames, anvilTabs, FILE_FORMAT_INDEX } from "./anvil-tabs";
+import {
+  ANVIL_FILTER_NAMES,
+  ANVIL_TABS,
+  FILE_FORMAT_INDEX,
+} from "./anvil-tabs";
 
 test("Check first page has disabled back and enabled forward pagination buttons on Donors Page", async ({
   page,
 }) => {
-  await testFirstPagePagination(page, anvilTabs.donors);
+  await testFirstPagePagination(page, ANVIL_TABS.DONORS);
 });
 
 test("Paginate through the entire Files tab to confirm that the page number stays consistent and that paginating forwards is disabled on the last page. Uses filters to reduce the amount of calls necessary", async ({
@@ -18,8 +22,8 @@ test("Paginate through the entire Files tab to confirm that the page number stay
   test.setTimeout(500000);
   const result = await filterAndTestLastPagePagination(
     page,
-    anvilTabs.files,
-    anvilFilterNames[FILE_FORMAT_INDEX]
+    ANVIL_TABS.FILES,
+    ANVIL_FILTER_NAMES[FILE_FORMAT_INDEX]
   );
   if (!result) {
     test.fail();
@@ -30,5 +34,5 @@ test("Check forward and backwards pagination causes the page content to change o
   page,
 }) => {
   test.setTimeout(90000);
-  await testPaginationContent(page, anvilTabs.biosamples);
+  await testPaginationContent(page, ANVIL_TABS.BIOSAMPLES);
 });