OBPIH-6969 Replace hardcoded products with date from csv file

Author: alannadolny

src/config/AppConfig.ts

@@ -8,6 +8,7 @@ import TestUserConfig from '@/config/TestUserConfig';
 import { ActivityCode } from '@/constants/ActivityCodes';
 import { LocationTypeCode } from '@/constants/LocationTypeCode';
 import RoleType from '@/constants/RoleTypes';
+import { readCsvFile } from '@/utils/FileIOUtils';
 import UniqueIdentifier from '@/utils/UniqueIdentifier';
 
 export enum USER_KEY {
@@ -69,7 +70,7 @@ class AppConfig {
   public locations!: Record<LOCATION_KEY, LocationConfig>;
 
   // test products used in all of the tests
-  public products!: Record<PRODUCT_KEY, ProductConfig>;
+  public products: Record<string, ProductConfig> = {};
 
   //recivingbin configurable prefix
   public receivingBinPrefix!: string;
@@ -262,44 +263,16 @@ class AppConfig {
       }),
     };
 
-    this.products = {
-      productOne: new ProductConfig({
-        id: env.get('PRODUCT_ONE').asString(),
-        key: PRODUCT_KEY.ONE,
-        name: this.uniqueIdentifier.generateUniqueString('product-one'),
-        quantity: 122,
+    // Fulfill products data in app config dynamically based on the products.csv
+    const productsData = readCsvFile(AppConfig.PRODUCTS_IMPORT_FILE_PATH);
+    productsData.forEach((productData) => {
+      this.products[productData['ProductCode']] = new ProductConfig({
+        key: productData['ProductCode'],
+        name: productData['Name'],
+        quantity: parseInt(productData['Quantity']),
         required: false,
-      }),
-      productTwo: new ProductConfig({
-        id: env.get('PRODUCT_TWO').asString(),
-        key: PRODUCT_KEY.TWO,
-        name: this.uniqueIdentifier.generateUniqueString('product-two'),
-        quantity: 123,
-        required: false,
-      }),
-      productThree: new ProductConfig({
-        id: env.get('PRODUCT_THREE').asString(),
-        key: PRODUCT_KEY.THREE,
-        name: this.uniqueIdentifier.generateUniqueString('product-three'),
-        quantity: 150,
-        required: false,
-      }),
-      productFour: new ProductConfig({
-        id: env.get('PRODUCT_FOUR').asString(),
-        key: PRODUCT_KEY.FOUR,
-        name: this.uniqueIdentifier.generateUniqueString('product-four'),
-        quantity: 100,
-        required: false,
-      }),
-      productFive: new ProductConfig({
-        id: env.get('PRODUCT_FIVE').asString(),
-        key: PRODUCT_KEY.FIVE,
-        name: this.uniqueIdentifier.generateUniqueString('aa-product-five'),
-        //'aa' part was added to improve visibility of ordering products alphabetically
-        quantity: 160,
-        required: false,
-      }),
-    };
+      })
+    })
 
     this.receivingBinPrefix = env
       .get('RECEIVING_BIN_PREFIX')

src/config/ProductConfig.ts

@@ -44,7 +44,7 @@ class ProductConfig {
    * @returns {boolean}
    */
   get isCreateNew() {
-    return !this.id;
+    return !this.readId();
   }
 
   /**

src/setup/createData.setup.ts

@@ -1,58 +1,19 @@
 import AppConfig from '@/config/AppConfig';
 import { test } from '@/fixtures/fixtures';
 import { readFile, writeToFile } from '@/utils/FileIOUtils';
-import { parseUrl } from '@/utils/UrlUtils';
 
 test('create data', async ({
-  page,
-  createProductPage,
-  productShowPage,
   locationService,
   mainLocationService,
 }) => {
   // eslint-disable-next-line playwright/no-conditional-in-test
   const data = readFile(AppConfig.TEST_DATA_FILE_PATH) || {};
 
-  const seedData: Record<'products' | 'locations', Record<string, string>> = {
+  const seedData: Record<'locations', Record<string, string>> = {
     ...data,
-    products: {},
     locations: {},
   };
 
-  // // PRODUCST
-  const products = Object.values(AppConfig.instance.products).filter(
-    (product) => product.isCreateNew
-  );
-
-  for (const product of products) {
-    await test.step(`create product ${product.key}`, async () => {
-      await createProductPage.goToPage();
-      await createProductPage.waitForUrl();
-      await createProductPage.productDetails.nameField.fill(product.name);
-      await createProductPage.productDetails.categorySelect.click();
-      await createProductPage.productDetails.categorySelectDropdown
-        .getByRole('listitem')
-        .first()
-        .click();
-      await createProductPage.saveButton.click();
-
-      await productShowPage.recordStockButton.click();
-
-      await productShowPage.recordStock.lineItemsTable
-        .row(1)
-        .newQuantity.getByRole('textbox')
-        .fill(`${product.quantity}`);
-      await productShowPage.recordStock.lineItemsTable.saveButton.click();
-      await productShowPage.showStockCardButton.click();
-
-      const productUrl = parseUrl(
-        page.url(),
-        '/openboxes/inventoryItem/showStockCard/$id'
-      );
-      seedData.products[`${product.key}`] = productUrl.id;
-    });
-  }
-
   // LOCATIONS
   const { organization } = await mainLocationService.getLocation();
   const { data: locationTypes } = await locationService.getLocationTypes();

src/setup/dataImport.setup.ts

@@ -7,6 +7,11 @@ test('import data', async ({ request }) => {
   // eslint-disable-next-line playwright/no-conditional-in-test
   const data = readFile(AppConfig.TEST_DATA_FILE_PATH) || {};
 
+  const seedData: Record<'products', Record<string, string>> = {
+    ...data,
+    products: {},
+  };
+
   // PRODUCTS
   const productService = new ProductService(request);
 
@@ -15,9 +20,9 @@ test('import data', async ({ request }) => {
   await test.step(`importing ${productsData.length} products`, async () => {
     const importedData = await productService.importProducts(productsData);
     importedData.data.forEach((product) => {
-      data.products[product.productCode] = product.id;
+      seedData.products[product.productCode] = product.id;
     })
   })
 
-  writeToFile(AppConfig.TEST_DATA_FILE_PATH, data);
+  writeToFile(AppConfig.TEST_DATA_FILE_PATH, seedData);
 });

src/setup/dataImport/products.csv

@@ -1,8 +1,6 @@
 Id,ProductCode,ProductType,Name,ProductFamily,Category,GLAccount,Description,UnitOfMeasure,Tags,UnitCost,LotAndExpiryControl,ColdChain,ControlledSubstance,HazardousMaterial,Reconditioned,Manufacturer,BrandName,ManufacturerCode,ManufacturerName,Vendor,VendorCode,VendorName,UPC,NDC,Created,Updated
-,1,Default,E2E-product-one-T0SOek,,ARVS,,,,,,,,,,,,,,,,,,,,19/Dec/2024 02:43:40,19/Dec/2024 02:43:40
-,2,Default,E2E-product-two-T0SOek,,ARVS,,,,,,,,,,,,,,,,,,,,19/Dec/2024 02:43:46,19/Dec/2024 02:43:46
-,3,Default,E2E-product-three-sUuCcW,,ARVS,,,,,,,,,,,,,,,,,,,,18/Feb/2025 11:15:58,18/Feb/2025 11:15:58
-,4,Default,E2E-product-four-sUuCcW,,ARVS,,,,,,,,,,,,,,,,,,,,18/Feb/2025 11:16:03,18/Feb/2025 11:16:03
-,5,Default,E2E-product-five-sUuCcW,,ARVS,,,,,,,,,,,,,,,,,,,,18/Feb/2025 11:16:07,18/Feb/2025 11:16:07
-,10001,Default,test product 1,,Food,,,,,,,,,,,,,,,,,,,,20/Feb/2025 02:53:27,20/Feb/2025 02:53:27
-,10002,Default,test product 2,,Chronic Care,,,,,,,,,,,,,,,,,,,,20/Feb/2025 02:54:03,20/Feb/2025 02:54:03
+,1,Default,E2E-product-one,,ARVS,,,,,,,,,,,,,,,,,,,,,
+,2,Default,E2E-product-two,,ARVS,,,,,,,,,,,,,,,,,,,,,
+,3,Default,E2E-product-three,,ARVS,,,,,,,,,,,,,,,,,,,,,
+,4,Default,E2E-product-four,,ARVS,,,,,,,,,,,,,,,,,,,,,
+,5,Default,E2E-product-five,,ARVS,,,,,,,,,,,,,,,,,,,,,