FI-1236 feat: add "full mocks" functionality

tests: add tests for "full mocks" functionality
fix: pack compilation errors `is not under 'rootDir'`

README.md

@@ -286,6 +286,8 @@ If `true`, page fires `touch` events when test interact with the page (instead o
 filters tests (tasks) by their static options —
 only those tests for which the function returned `true` get into the pack.
 
+`fullMocks: FullMocks | null`: functions that specify the "full mocks" functionality.
+
 `liteReportFileName: string | null`: the name of the file under which, after running the tests,
 the lite JSON report will be saved in the `autotests/reports` directory, for example, `lite-report.json`.
 If `null`, the lite report will not be saved.

autotests/configurator/fullMocks.ts

@@ -0,0 +1,36 @@
+import {readFile, writeFile} from 'node:fs/promises';
+import {join} from 'node:path';
+
+import {BAD_REQUEST_STATUS_CODE, READ_FILE_OPTIONS} from 'e2ed/constants';
+
+import type {FullMocks} from 'autotests/configurator';
+import type {FilePathFromRoot, FullMocksTestId, RequestKind, TestFullMocks} from 'e2ed/types';
+
+const fullMocksStoragePath = join('autotests', 'fixtures', 'fullMocks');
+
+const getTestFullMocksPath = (testId: FullMocksTestId): FilePathFromRoot =>
+  join(fullMocksStoragePath, `${testId}.json`) as FilePathFromRoot;
+
+export const fullMocks: FullMocks = {
+  filterTests: ({options: {meta}}) => meta.testId === '18',
+  getRequestKind: (method, {pathname}) => pathname as RequestKind,
+  getResponseFromFullMocks: ({responseWithRequest}) =>
+    responseWithRequest ?? {statusCode: BAD_REQUEST_STATUS_CODE},
+  getResponseToWriteToFullMocks: (requestKind, responseWithRequest) => responseWithRequest,
+  readTestFullMocks: async (testId) => {
+    const testFullMocksJson = await readFile(getTestFullMocksPath(testId), READ_FILE_OPTIONS).catch(
+      () => undefined,
+    );
+
+    if (testFullMocksJson === undefined) {
+      return undefined;
+    }
+
+    return JSON.parse(testFullMocksJson) as TestFullMocks;
+  },
+  writeTestFullMocks: async (testId, testFullMocks) => {
+    const testFullMocksJson = JSON.stringify(testFullMocks);
+
+    await writeFile(getTestFullMocksPath(testId), testFullMocksJson);
+  },
+};

autotests/configurator/index.ts

@@ -1,5 +1,6 @@
 export {doAfterPack} from './doAfterPack';
 export {doBeforePack} from './doBeforePack';
+export {fullMocks} from './fullMocks';
 export {mapBackendResponseErrorToLog} from './mapBackendResponseErrorToLog';
 export {mapBackendResponseToLog} from './mapBackendResponseToLog';
 export {mapLogPayloadInConsole} from './mapLogPayloadInConsole';
@@ -10,6 +11,7 @@ export type {
   DoAfterPack,
   DoBeforePack,
   FilterTestsIntoPack,
+  FullMocks,
   GetFullPackConfig,
   GetLogContext,
   GetMainTestRunParams,

autotests/configurator/types/index.ts

@@ -2,6 +2,7 @@ export type {
   DoAfterPack,
   DoBeforePack,
   FilterTestsIntoPack,
+  FullMocks,
   GetFullPackConfig,
   GetLogContext,
   GetMainTestRunParams,

autotests/configurator/types/packSpecific.ts

@@ -14,6 +14,7 @@ export type GetLogContext = PackSpecificTypes['GetLogContext'];
 export type GetMainTestRunParams = PackSpecificTypes['GetMainTestRunParams'];
 export type GetTestRunHash = PackSpecificTypes['GetTestRunHash'];
 export type FilterTestsIntoPack = PackSpecificTypes['FilterTestsIntoPack'];
+export type FullMocks = PackSpecificTypes['FullMocks'];
 export type IsTestSkipped = PackSpecificTypes['IsTestSkipped'];
 export type LiteReport = PackSpecificTypes['LiteReport'];
 export type MapBackendResponseErrorToLog = PackSpecificTypes['MapBackendResponseErrorToLog'];

autotests/entities/index.ts

@@ -1,3 +1,4 @@
 export {createDevice} from './device';
+export {addProduct} from './product';
 export {createUser} from './user';
 export {addUser, getUsers} from './worker';

autotests/entities/product.ts

@@ -0,0 +1,21 @@
+import {createClientFunction} from 'e2ed';
+
+import type {ApiProduct, Product} from 'autotests/types';
+
+/**
+ * Adds product.
+ */
+export const addProduct = createClientFunction(
+  (product: Product) =>
+    fetch(`https://reqres.in/api/product/${product.id}?size=${product.size}`, {
+      body: JSON.stringify({
+        cookies: [],
+        input: product.input,
+        model: product.model,
+        version: product.version,
+      }),
+      headers: {'Content-Type': 'application/json; charset=UTF-8'},
+      method: 'POST',
+    }).then((res) => res.json() as Promise<ApiProduct>),
+  {name: 'addProduct', timeout: 2_000},
+);

autotests/fixtures/fullMocks/jKDXNUZ75U.json

@@ -0,0 +1 @@
+{"/api/product/135865":[{"completionTimeInMs":1716205312921,"duration":"4ms","request":{"method":"POST","query":{"size":"13"},"requestBody":{"cookies":[],"input":17,"model":"samsung","version":"12"},"requestHeaders":{"accept":"*/*","content-type":"application/json; charset=UTF-8","referer":"https://joomcode.github.io/","user-agent":"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.35 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.35"},"url":"https://reqres.in/api/product/135865?size=13","utcTimeInMs":1716205312917},"responseBody":{"id":135865,"method":"POST","output":"17","payload":{"id":"135865","cookies":[],"input":17,"model":"samsung","version":"12"},"query":{"size":"13"},"url":"https://reqres.in/api/product/135865?size=13"},"responseHeaders":{"content-length":"201","content-type":"application/json; charset=UTF-8"},"statusCode":200},{"completionTimeInMs":1716205313198,"duration":"255ms","request":{"method":"POST","query":{"size":"13"},"requestBody":{"cookies":[],"input":17,"model":"samsung","version":"12"},"requestHeaders":{"accept":"*/*","content-type":"application/json; charset=UTF-8","referer":"https://joomcode.github.io/","user-agent":"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.35 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.35"},"url":"https://reqres.in/api/product/135865?size=13","utcTimeInMs":1716205312943},"responseBody":{"cookies":[],"input":17,"model":"samsung","version":"12","id":"713","createdAt":"2024-05-20T11:41:53.144Z"},"responseHeaders":{"date":"Mon, 20 May 2024 11:41:53 GMT","content-type":"application/json; charset=utf-8","content-length":"108","report-to":"{\"group\":\"heroku-nel\",\"max_age\":3600,\"endpoints\":[{\"url\":\"https://nel.heroku.com/reports?ts=1716205313&sid=c4c9725f-1ab0-44d8-820f-430df2718e11&s=mbk9hukht3cdEhvMVZlrntLk5LPKjfRJrh277niKK2Q%3D\"}]}","reporting-endpoints":"heroku-nel=https://nel.heroku.com/reports?ts=1716205313&sid=c4c9725f-1ab0-44d8-820f-430df2718e11&s=mbk9hukht3cdEhvMVZlrntLk5LPKjfRJrh277niKK2Q%3D","nel":"{\"report_to\":\"heroku-nel\",\"max_age\":3600,\"success_fraction\":0.005,\"failure_fraction\":0.05,\"response_headers\":[\"Via\"]}","x-powered-by":"Express","access-control-allow-origin":"*","etag":"W/\"6c-640Odu4IHdHX5uCM17XShtUIvGU\"","via":"1.1 vegur","cf-cache-status":"DYNAMIC","server":"cloudflare","cf-ray":"886c0f66bc3265cc-FRA"},"statusCode":201}]}

autotests/packs/allTests.ts

@@ -1,8 +1,8 @@
 /**
  * @file Pack file (file with configuration of pack).
  * Do not import anything (from `utils`, etc) into this file other than
- * the types and values from `../configurator`, `e2ed/configurator` or other packs
- * (because the pack is compiled separately from the tests themselves
+ * the types and values from `../configurator`, `e2ed/configurator`, `e2ed/constants`
+ * or other packs (because the pack is compiled separately from the tests themselves
  * and has separate TypeScript scope).
  */
 
@@ -11,6 +11,7 @@ import {isLocalRun} from 'e2ed/configurator';
 import {
   doAfterPack,
   doBeforePack,
+  fullMocks,
   mapBackendResponseErrorToLog,
   mapBackendResponseToLog,
   mapLogPayloadInConsole,
@@ -56,6 +57,7 @@ export const pack: Pack = {
   enableMobileDeviceMode: false,
   enableTouchEventEmulation: false,
   filterTestsIntoPack,
+  fullMocks,
   liteReportFileName: 'lite-report.json',
   logFileName: 'pack-logs.log',
   mapBackendResponseErrorToLog,
@@ -77,7 +79,7 @@ export const pack: Pack = {
   skipTests,
   takeFullPageScreenshotOnError: false,
   takeViewportScreenshotOnError: true,
-  testFileGlobs: ['./autotests/tests/**/*.ts', '!**/*.skip.ts'],
+  testFileGlobs: ['./autotests/tests/**/fullMocks.ts', '!**/*.skip.ts'],
   testIdleTimeout: 20_000,
   testTimeout: 60_000,
   viewportHeight: 1080,

autotests/pageObjects/MobilePage.ts

@@ -1,8 +1,8 @@
 import {Page} from 'e2ed';
 
-import type {MobileDevice} from 'autotests/types';
+import type {MobileDeviceModel} from 'autotests/types';
 
-type PageParams<CustomPageParams> = CustomPageParams & Readonly<{mobileDevice?: MobileDevice}>;
+type PageParams<CustomPageParams> = CustomPageParams & Readonly<{mobileDevice?: MobileDeviceModel}>;
 
 /**
  * Abstract mobile page.
@@ -11,5 +11,5 @@ export abstract class MobilePage<CustomPageParams> extends Page<PageParams<Custo
   /**
    * Type of mobile device.
    */
-  abstract readonly mobileDevice: MobileDevice;
+  abstract readonly mobileDevice: MobileDeviceModel;
 }

autotests/routes/apiRoutes/CreateDevice.ts

@@ -1,8 +1,12 @@
 import {ApiRoute} from 'autotests/routes';
 
-import type {ApiCreateDeviceRequest, ApiCreateDeviceResponse, MobileDevice} from 'autotests/types';
+import type {
+  ApiCreateDeviceRequest,
+  ApiCreateDeviceResponse,
+  MobileDeviceModel,
+} from 'autotests/types';
 
-type Params = Readonly<{model: MobileDevice}>;
+type Params = Readonly<{model: MobileDeviceModel}>;
 
 /**
  * Test API route for creating a device.

autotests/routes/apiRoutes/CreateProduct.ts

@@ -3,10 +3,10 @@ import {URL} from 'node:url';
 import {ApiRoute} from 'autotests/routes';
 import {assertValueIsTrue} from 'e2ed/utils';
 
-import type {ApiCreateProductRequest, ApiCreateProductResponse} from 'autotests/types';
+import type {ApiCreateProductRequest, ApiCreateProductResponse, ProductId} from 'autotests/types';
 import type {Url} from 'e2ed/types';
 
-type Params = Readonly<{id: number; size: number}>;
+type Params = Readonly<{id: ProductId; size: number}>;
 
 const pathStart = '/api/product/';
 
@@ -27,7 +27,7 @@ export class CreateProduct extends ApiRoute<
       {urlObject},
     );
 
-    const id = Number(urlObject.pathname.slice(pathStart.length));
+    const id = Number(urlObject.pathname.slice(pathStart.length)) as ProductId;
     const size = Number(urlObject.searchParams.get('size'));
 
     assertValueIsTrue(Number.isInteger(id), 'url has correct id', {id, size, urlObject});

autotests/tests/e2edReportExample/fullMocks.ts

@@ -0,0 +1,60 @@
+import {test} from 'autotests';
+import {addProduct} from 'autotests/entities';
+import {E2edReportExample} from 'autotests/pageObjects/pages';
+import {CreateProduct as CreateProductRoute} from 'autotests/routes/apiRoutes';
+import {expect} from 'e2ed';
+import {mockApiRoute, navigateToPage, unmockApiRoute} from 'e2ed/actions';
+
+import type {DeviceId, Product, ProductId} from 'autotests/types';
+import type {Url} from 'e2ed/types';
+
+test('full mocks works correctly', {meta: {testId: '18'}}, async () => {
+  await navigateToPage(E2edReportExample);
+
+  await mockApiRoute(CreateProductRoute, (routeParams, {method, query, requestBody, url}) => {
+    const responseBody = {
+      id: routeParams.id,
+      method,
+      output: String(requestBody.input),
+      payload: {id: String(routeParams.id) as DeviceId, ...requestBody},
+      query,
+      url,
+    };
+
+    return {responseBody};
+  });
+
+  const productId = Number('135865') as ProductId;
+  const product: Product = {
+    id: productId,
+    input: 17,
+    model: 'samsung',
+    size: '13',
+    version: '12',
+  };
+
+  const mockedProduct = await addProduct(product);
+
+  const fetchUrl = `https://reqres.in/api/product/${productId}?size=${product.size}` as Url;
+
+  await expect(mockedProduct, 'mocked API returns correct result').eql({
+    id: productId,
+    method: 'POST',
+    output: String(product.input),
+    payload: {
+      cookies: [],
+      id: String(productId) as DeviceId,
+      input: product.input,
+      model: product.model,
+      version: product.version,
+    },
+    query: {size: product.size},
+    url: fetchUrl,
+  });
+
+  await unmockApiRoute(CreateProductRoute);
+
+  const newMockedProduct = await addProduct(product);
+
+  await expect('createdAt' in newMockedProduct, 'API mock on CreateProductRoute was umocked').ok();
+});

autotests/tests/internalTypeTests/mockApiRoute.skip.ts

@@ -3,16 +3,22 @@ import {Main} from 'autotests/routes/pageRoutes';
 import {mockApiRoute, unmockApiRoute} from 'e2ed/actions';
 import {CREATED_STATUS_CODE, OK_STATUS_CODE} from 'e2ed/constants';
 
-import type {ApiCreateDeviceRequest, ApiCreateDeviceResponse, DeviceId} from 'autotests/types';
+import type {
+  ApiCreateDeviceRequest,
+  ApiCreateDeviceResponse,
+  DeviceId,
+  ProductId,
+} from 'autotests/types';
 
 const apiMockFunction = (
   routeParams: object,
   {method, query, requestBody, url}: ApiCreateDeviceRequest,
 ): Partial<ApiCreateDeviceResponse> => {
   const {input} = requestBody;
+  const productId = 12;
 
   const responseBody = {
-    id: 12,
+    id: productId as ProductId,
     method,
     output: String(input),
     payload: {id: '12' as DeviceId, ...requestBody},
@@ -49,9 +55,10 @@ void mockApiRoute(
     {method, requestBody, query, url}, // eslint-disable-next-line @typescript-eslint/require-await
   ) => {
     const {input} = requestBody;
+    const productId = 7;
 
     const responseBody = {
-      id: 7,
+      id: productId as ProductId,
       method,
       output: `${input}${routeParams.id}`,
       payload: {id: '7' as DeviceId, ...requestBody},

autotests/tests/internalTypeTests/pages.skip.ts

@@ -6,7 +6,7 @@ import {Main, Search, Services} from 'autotests/pageObjects/pages';
 import {navigateToPage} from 'e2ed/actions';
 
 /**
- * PageParams = Readonly<{mobileDevice?: MobileDevice, query?: string}>
+ * PageParams = Readonly<{mobileDevice?: MobileDeviceModel, query?: string}>
  */
 
 // ok

autotests/tests/internalTypeTests/request.skip.ts

@@ -3,10 +3,10 @@ import {Main} from 'autotests/routes/pageRoutes';
 import {getRandomId} from 'e2ed/generators';
 import {request} from 'e2ed/utils';
 
-import type {ApiDevice, ApiDeviceParams, ApiUserParams, MobileDevice} from 'autotests/types';
+import type {ApiDevice, ApiDeviceParams, ApiUserParams, MobileDeviceModel} from 'autotests/types';
 
 declare const apiUserParams: ApiUserParams;
-declare const model: MobileDevice;
+declare const model: MobileDeviceModel;
 declare const apiDeviceParams: ApiDeviceParams;
 
 // @ts-expect-error: request require API route as first argument

autotests/tests/mockApiRoute.ts

@@ -1,9 +1,10 @@
 import {test} from 'autotests';
+import {addProduct} from 'autotests/entities';
 import {CreateProduct as CreateProductRoute} from 'autotests/routes/apiRoutes';
-import {createClientFunction, expect} from 'e2ed';
+import {expect} from 'e2ed';
 import {mockApiRoute, unmockApiRoute} from 'e2ed/actions';
 
-import type {ApiCreateDeviceResponse, DeviceId} from 'autotests/types';
+import type {DeviceId, Product, ProductId} from 'autotests/types';
 import type {Url} from 'e2ed/types';
 
 test(
@@ -23,42 +24,45 @@ test(
       return {responseBody};
     });
 
-    const getMockedProduct = createClientFunction(
-      () =>
-        fetch('https://reqres.in/api/product/135865?size=13', {
-          body: JSON.stringify({cookies: [], input: 17, model: 'samsung', version: '12'}),
-          headers: {'Content-Type': 'application/json; charset=UTF-8'},
-          method: 'POST',
-        }).then((res) => res.json() as Promise<ApiCreateDeviceResponse['responseBody']>),
-      {name: 'getMockedProduct', timeout: 2_000},
-    );
+    const productId = 135865;
+    const product: Product = {
+      id: productId as ProductId,
+      input: 17,
+      model: 'samsung',
+      size: '13',
+      version: '12',
+    };
 
-    const mockedProduct = await getMockedProduct();
+    const mockedProduct = await addProduct(product);
 
-    const fetchUrl = 'https://reqres.in/api/product/135865?size=13' as Url;
+    const fetchUrl = `https://reqres.in/api/product/${productId}?size=${product.size}` as Url;
 
     const productRouteParams = CreateProductRoute.getParamsFromUrl(fetchUrl);
 
     const productRouteFromUrl = new CreateProductRoute(productRouteParams);
 
+    await expect(productRouteFromUrl.routeParams.id, 'route has correct params').eql(
+      productId as ProductId,
+    );
+
     await expect(mockedProduct, 'mocked API returns correct result').eql({
       id: productRouteFromUrl.routeParams.id,
       method: productRouteFromUrl.getMethod(),
-      output: '17',
+      output: String(product.input),
       payload: {
         cookies: [],
         id: String(productRouteFromUrl.routeParams.id) as DeviceId,
-        input: 17,
-        model: 'samsung',
-        version: '12',
+        input: product.input,
+        model: product.model,
+        version: product.version,
       },
-      query: {size: '13'},
+      query: {size: product.size},
       url: fetchUrl,
     });
 
     await unmockApiRoute(CreateProductRoute);
 
-    const newMockedProduct = (await getMockedProduct().catch(() => undefined)) ?? {createdAt: ''};
+    const newMockedProduct = await addProduct(product);
 
     await expect(
       'createdAt' in newMockedProduct,