import path enhance using tsconfig-paths

Author: sadabnepal

.github/workflows/regression.yml

@@ -17,7 +17,7 @@ jobs:
       run: npm ci
 
     - name: Run lint and test
-      run: npm run lint&&export GO_RES_USER_TOKEN=${{ secrets.API_TOKEN }}&&npm test
+      run: npm run lint&&export GO_RES_USER_TOKEN=${{ secrets.API_TOKEN }}&&export ENV=dev&&npm test
 
     - name: Create Report
       uses: phoenix-actions/test-reporting@v8

.mocharc.js

@@ -21,7 +21,7 @@ module.exports = {
         'showSkipped=true',
         'showHooks=failed'
     ],
-    require: ['ts-node/register'],
+    require: ['ts-node/register', 'tsconfig-paths/register'],
     parallel: false,
     recursive: false,
     retries: 0,

package-lock.json

@@ -29,10 +29,11 @@
     "mochawesome": "^7.1.3",
     "supertest": "^6.3.4",
     "ts-node": "^10.7.0",
+    "tsconfig-paths": "^4.2.0",
     "typescript": "^4.6.4",
     "typescript-eslint": "^7.8.0"
   },
   "engines": {
     "node": ">=16.0.0 <20.0.0"
   }
-}
+}

package.json

@@ -1,5 +1,5 @@
 import { faker } from '@faker-js/faker';
-import { IUser, IUserOmittedID } from '../types/users';
+import { IUser, IUserOmittedID } from 'types/users';
 
 export const createUserData: IUserOmittedID = {
     name: faker.person.fullName(),

tests/data/faker.ts

@@ -1,16 +1,17 @@
+import { ENV } from 'env/manager';
 import supertest from 'supertest';
 
 export const queryGraphQl = async (token: string, graphQLQuery: string) => {
-    const response = await supertest('https://gorest.co.in/public')
-        .post('/v2/graphql')
+    const response = await supertest(ENV.BASEURL)
+        .post(ENV.ENDPOINT)
         .set({ 'authorization': `Bearer ${token}` })
         .send({ query: graphQLQuery });
     return response;
 };
 
 export const mutateGraphQl = async (token: string, mutationPayload: string) => {
-    const response = await supertest('https://gorest.co.in/public')
-        .post('/v2/graphql')
+    const response = await supertest(ENV.BASEURL)
+        .post(ENV.ENDPOINT)
         .set({ 'authorization': `Bearer ${token}` })
         .send({ query: mutationPayload });
     return response;

tests/helper/apiUtils.ts

@@ -1,6 +1,6 @@
 import { userResponseFields } from './fragments';
 
-export const queryUsersWithNodeDirectivePayload = (includeNodes = true) => {
+export const queryUsers = (includeNodes: boolean) => {
     return `{
         users {
             totalCount

tests/payload/directives.ts

@@ -1,4 +1,4 @@
-import { IUser, IUserOmittedID } from '../types/users';
+import { IUser, IUserOmittedID } from 'types/users';
 import { userFragments, userResponseFields } from './fragments';
 
 export const createUserPayload = (data: IUserOmittedID) => {

tests/payload/mutation.ts

@@ -1,11 +1,11 @@
 import { expect } from 'chai';
+import { createUserData, updateUserData } from 'data/faker';
 import { config } from 'dotenv';
-import { createUserData, updateUserData } from '../data/faker';
-import { mutateGraphQl, queryGraphQl } from '../helper/apiUtils';
-import { queryUsersWithNodeDirectivePayload } from '../payload/directives';
-import { createUserPayload, deleteUserPayload, updateUserPayload } from '../payload/mutation';
-import { queryAllUserPayload, queryUserByIdPayload } from '../payload/queries';
-import { INonExistingUserError, IUser, IUserCreate, IUserDelete, IUserUpdate, IUsers } from '../types/users';
+import { mutateGraphQl, queryGraphQl } from 'helper/apiUtils';
+import { queryUsers } from 'payload/directives';
+import { createUserPayload, deleteUserPayload, updateUserPayload } from 'payload/mutation';
+import { queryAllUserPayload, queryUserByIdPayload } from 'payload/queries';
+import { INonExistingUserError, IUser, IUserCreate, IUserDelete, IUserUpdate, IUsers } from 'types/users';
 config();
 
 const TOKEN = process.env.GO_RES_USER_TOKEN;
@@ -134,7 +134,7 @@ describe('go rest graphql tests', () => {
     });
 
     it('should query user count only using directives', async () => {
-        const response = await queryGraphQl(TOKEN, queryUsersWithNodeDirectivePayload(false));
+        const response = await queryGraphQl(TOKEN, queryUsers(false));
         expect(response.statusCode).equal(200);
 
         const responseData: IUsers = response.body.data;
@@ -145,7 +145,7 @@ describe('go rest graphql tests', () => {
     });
 
     it('should query user with all nodes using directives', async () => {
-        const response = await queryGraphQl(TOKEN, queryUsersWithNodeDirectivePayload(true));
+        const response = await queryGraphQl(TOKEN, queryUsers(true));
         expect(response.statusCode).equal(200);
 
         const responseData: IUsers = response.body.data;

tests/specs/goRestTests.ts

@@ -2,6 +2,7 @@
   "compilerOptions": {
     "esModuleInterop": true,
     "resolveJsonModule": true,
+    "baseUrl": "./tests"
     // "allowSyntheticDefaultImports": true,
     // "forceConsistentCasingInFileNames": true,
     // "strict": true,
@@ -19,6 +20,10 @@
     // "noImplicitOverride": true,
     // "skipLibCheck": true
   },
-  "include": ["tests/**/*.ts"],
-  "exclude": ["node_modules"]
+  "include": [
+    "tests/**/*.ts"
+  ],
+  "exclude": [
+    "node_modules"
+  ]
 }