OBPIH-6952 Add test for asserting receiving bin location is created (#45)

* OBPIH-6952 add test for asserting creation of receiving bin location

* OBPIH-6952 add receiving bin prefix- to env and AppConfig

* OBPIH-6952 bring back accidentally removed changes

* OBPIH-6952 fix import order

* OBPIH-6952 Add receiving bin prefix default env var value

---------

Co-authored-by: Walkowiak <awalkowiak@soldevelo.com>

Author: kkrawczyk123

.env.example

@@ -18,3 +18,4 @@ PRODUCT_TWO=productId
 PRODUCT_THREE=productId
 PRODUCT_FOUR=productId
 PRODUCT_FIVE=productId
+RECEIVING_BIN_PREFIX=receivingBinPrefix

.github/workflows/playwright.yml

@@ -70,6 +70,7 @@ jobs:
         PRODUCT_THREE: ${{ secrets.PRODUCT_THREE }}
         PRODUCT_FOUR: ${{ secrets.PRODUCT_FOUR }}
         PRODUCT_FIVE: ${{ secrets.PRODUCT_FIVE }}
+        RECEIVING_BIN_PREFIX: ${{ secrets.RECEIVING_BIN_PREFIX != null && secrets.RECEIVING_BIN_PREFIX || 'R-' }}
       run: |
         echo "Running playwright tests on the ${{ inputs.environment || 'obdev5' }} server"
         npx playwright test

src/config/AppConfig.ts

@@ -66,6 +66,9 @@ class AppConfig {
   // test products used in all of the tests
   public products!: Record<PRODUCT_KEY, ProductConfig>;
 
+  //recivingbin configurable prefix
+  public receivingBinPrefix!: string;
+
   // Private constructor to enforce singleton pattern.
   private constructor() {
     this.uniqueIdentifier = new UniqueIdentifier();
@@ -284,6 +287,11 @@ class AppConfig {
         required: false,
       }),
     };
+
+    this.receivingBinPrefix = env
+      .get('RECEIVING_BIN_PREFIX')
+      .default('R-')
+      .asString();
   }
 }
 

src/pages/location/createLocation/tabs/BinLocationsTabSection.ts

@@ -1,4 +1,4 @@
-import { expect, Page } from '@playwright/test';
+import { expect, Locator, Page } from '@playwright/test';
 
 import BasePageModel from '@/pages/BasePageModel';
 import AddBinLocationDialog from '@/pages/location/createLocation/components/AddBinLocationDialog';
@@ -21,6 +21,18 @@ class BinLocationsTabSection extends BasePageModel {
     ).toBeVisible();
   }
 
+  get table() {
+    return this.page.locator('.box').getByRole('table');
+  }
+
+  get rows() {
+    return this.table.getByRole('row');
+  }
+
+  row(index: number) {
+    return new Row(this.page, this.rows.nth(index));
+  }
+
   get addBinLocationButton() {
     return this.page.getByRole('button', { name: 'Add Bin Location' });
   }
@@ -36,6 +48,21 @@ class BinLocationsTabSection extends BasePageModel {
   get editBinButton() {
     return this.page.getByRole('link', { name: 'Edit', exact: true });
   }
+
+  get emptyBinLocationTable() {
+    return this.table.getByText('No matching records found');
+  }
+}
+class Row extends BasePageModel {
+  row: Locator;
+  constructor(page: Page, row: Locator) {
+    super(page);
+    this.row = row;
+  }
+
+  get binLocation() {
+    return this.row.locator('td').nth(1).getByRole('link');
+  }
 }
 
 export default BinLocationsTabSection;

src/tests/receiving/assertCreationOfReceivingBin.test.ts

@@ -0,0 +1,138 @@
+import AppConfig from '@/config/AppConfig';
+import { ShipmentType } from '@/constants/ShipmentType';
+import { expect, test } from '@/fixtures/fixtures';
+import CreateLocationPage from '@/pages/location/createLocation/CreateLocationPage';
+import LocationListPage from '@/pages/location/LocationListPage';
+import { StockMovementResponse } from '@/types';
+
+test.describe('Assert creation of receiving bin', () => {
+  test.describe.configure({ timeout: 60000 });
+  //timeout has been added for this test to make sure that the content on bin location tab will load as it can include a lot of data
+  let STOCK_MOVEMENT: StockMovementResponse;
+
+  test.beforeEach(
+    async ({
+      supplierLocationService,
+      stockMovementService,
+      mainProductService,
+      otherProductService,
+    }) => {
+      const supplierLocation = await supplierLocationService.getLocation();
+      const PRODUCT_ONE = await mainProductService.getProduct();
+      const PRODUCT_TWO = await otherProductService.getProduct();
+
+      STOCK_MOVEMENT = await stockMovementService.createInbound({
+        originId: supplierLocation.id,
+      });
+
+      await stockMovementService.addItemsToInboundStockMovement(
+        STOCK_MOVEMENT.id,
+        [
+          {
+            productId: PRODUCT_ONE.id,
+            quantity: 100,
+          },
+          { productId: PRODUCT_TWO.id, quantity: 10 },
+        ]
+      );
+
+      await stockMovementService.sendInboundStockMovement(STOCK_MOVEMENT.id, {
+        shipmentType: ShipmentType.AIR,
+      });
+    }
+  );
+
+  test.afterEach(async ({ stockMovementShowPage, stockMovementService }) => {
+    await stockMovementShowPage.goToPage(STOCK_MOVEMENT.id);
+    await stockMovementShowPage.rollbackButton.click();
+    await stockMovementService.deleteStockMovement(STOCK_MOVEMENT.id);
+  });
+
+  test('Assert receiving bin is not created when shipment is shipped', async ({
+    stockMovementShowPage,
+    receivingPage,
+    page,
+    locationListPage,
+    mainLocationService,
+    createLocationPage,
+    browser,
+  }) => {
+    await test.step('Go to stock movement show page and assert shipped status', async () => {
+      await stockMovementShowPage.goToPage(STOCK_MOVEMENT.id);
+      await stockMovementShowPage.isLoaded();
+      await expect(stockMovementShowPage.statusTag).toHaveText('Shipped');
+    });
+
+    await test.step('Go to Bin location tab of edit location page', async () => {
+      const mainLocation = await mainLocationService.getLocation();
+      await page.goto('./location/list');
+      await locationListPage.searchByLocationNameField.fill(mainLocation.name);
+      await locationListPage.findButton.click();
+      await expect(
+        locationListPage.getLocationEditButton(mainLocation.name)
+      ).toBeVisible();
+      await locationListPage.getLocationEditButton(mainLocation.name).click();
+      await createLocationPage.binLocationTab.click();
+      await createLocationPage.binLocationTabSection.isLoaded();
+    });
+
+    await test.step('Assert Bin location is not created yet', async () => {
+      const receivingBin =
+        AppConfig.instance.receivingBinPrefix + STOCK_MOVEMENT.identifier;
+      await createLocationPage.binLocationTabSection.searchField.fill(
+        receivingBin
+      );
+      await createLocationPage.binLocationTabSection.searchField.press('Enter');
+      await createLocationPage.binLocationTabSection.isLoaded();
+      await expect(
+        createLocationPage.binLocationTabSection.emptyBinLocationTable
+      ).toBeVisible();
+    });
+
+    await test.step('Go to stock movement show page', async () => {
+      await stockMovementShowPage.goToPage(STOCK_MOVEMENT.id);
+      await stockMovementShowPage.isLoaded();
+    });
+
+    await test.step('Click on receive button', async () => {
+      await stockMovementShowPage.receiveButton.click();
+      await receivingPage.receivingStep.isLoaded();
+    });
+
+    await test.step('Assert receiving bin has been created', async () => {
+      const newPage = await browser.newPage();
+      const newLocationListPage = new LocationListPage(newPage);
+      const newCreateLocationPage = new CreateLocationPage(newPage);
+      const mainLocation = await mainLocationService.getLocation();
+      await newPage.goto('./location/list');
+      await newLocationListPage.searchByLocationNameField.fill(
+        mainLocation.name
+      );
+      await newLocationListPage.findButton.click();
+      await expect(
+        newLocationListPage.getLocationEditButton(mainLocation.name)
+      ).toBeVisible();
+      await newLocationListPage
+        .getLocationEditButton(mainLocation.name)
+        .click();
+      await newCreateLocationPage.binLocationTab.click();
+      await newCreateLocationPage.binLocationTabSection.isLoaded();
+      const receivingBin =
+        AppConfig.instance.receivingBinPrefix + STOCK_MOVEMENT.identifier;
+      await newCreateLocationPage.binLocationTabSection.searchField.fill(
+        receivingBin
+      );
+      await newCreateLocationPage.binLocationTabSection.searchField.press(
+        'Enter'
+      );
+      await newCreateLocationPage.binLocationTabSection.isLoaded();
+      await expect(
+        newCreateLocationPage.binLocationTabSection.emptyBinLocationTable
+      ).toBeHidden();
+      await expect(
+        newCreateLocationPage.binLocationTabSection.row(1).binLocation
+      ).toHaveText(receivingBin);
+      await newPage.close();
+    });
+  });
+});