Merge pull request #1 from Bahmni/feature/framework-dev

Praveen-SWE · web-flow · commit 45a7ade8560e · 2025-09-30T18:20:51.000+05:30
Initial commit
diff --git a/.DS_Store b/.DS_Store
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,2 @@
+mochawesome-report
+node_modules
diff --git a/.husky/pre-commit b/.husky/pre-commit
@@ -0,0 +1,3 @@
+yarn lint
+yarn format:check
+talisman --githook pre-commit
diff --git a/.mocharc.json b/.mocharc.json
@@ -0,0 +1,16 @@
+{
+    "spec": "tests/**/*.spec.js",
+    "extension": ["js"],
+    "file": ["tests/fixtures/rootHooks.js"],
+    "reporter": "mochawesome",
+    "reporterOptions": {
+        "reportDir": "./reports/json",
+        "reportFilename": "testresult",
+        "inline": true,
+        "charts": true,
+        "saveJson": true,
+        "saveHtml": false,
+        "overwrite": true,
+        "quiet": true
+    }
+}
diff --git a/.prettierignore b/.prettierignore
@@ -0,0 +1,3 @@
+node_modules
+mochawesome_report
+.vscode
diff --git a/eslint.config.js b/eslint.config.js
@@ -0,0 +1,61 @@
+import js from "@eslint/js";
+import mochaPlugin from "eslint-plugin-mocha";
+import prettierPlugin from "eslint-plugin-prettier";
+import nodePlugin from "eslint-plugin-node";
+
+export default [
+  {
+    ignores: [
+        "node_modules/**", 
+        "mochawesome-report/**", 
+        ".vscode/**",
+        "eslint.config.js",
+        "*.log"]
+  },
+  {
+    languageOptions: {
+    globals: {
+      global: "readonly"
+    }
+  }
+  },
+  js.configs.recommended,
+  {
+    files: ["**/*.js"],
+    ignores: ["node_modules/**", "mochawesome-report/**", ".vscode/**", "*.log", "eslint.config.js"],
+    languageOptions: {
+      ecmaVersion: 2021,
+      sourceType: "module",
+      globals: {
+        describe: "readonly",
+        it: "readonly",
+        before: "readonly",
+        after: "readonly",
+        beforeEach: "readonly",
+        afterEach: "readonly",
+        global: "readonly"
+      }
+    },
+    plugins: {
+      mocha: mochaPlugin,
+      prettier: prettierPlugin,
+      node: nodePlugin
+    },
+    rules: {
+      "no-unused-vars": ["warn"],
+      "no-console": "off",
+      "mocha/no-exclusive-tests": "error",
+      "node/no-unsupported-features/es-syntax": [
+        "error",
+        { ignores: ["modules"] }
+      ],
+      "prettier/prettier": "warn",
+    }
+  },
+  {
+    files: ["tests/specs/**/*.js"],
+    rules: {
+      "func-names": "off"
+    }
+  }
+];
diff --git a/jsconfig.json b/jsconfig.json
@@ -0,0 +1,11 @@
+{
+    "compilerOptions": {
+        "checkJs": false,
+        "allowJs": true,
+    },
+    "include": [
+        "src/**/*.js",
+        "tests/**/*.js",
+        "tests/fixtures/globals.d.ts"
+    ]
+}
diff --git a/package.json b/package.json
@@ -0,0 +1,42 @@
+{
+  "name": "systemx-apitest-automation",
+  "version": "1.0.0",
+  "description": "",
+  "type": "module",
+  "main": "index.js",
+  "scripts": {
+    "test": "mocha --config .mocharc.json",
+    "prepare": "husky",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "format:check": "prettier --check .",
+    "format": "prettier --write ."
+  },
+  "keywords": [],
+  "author": "IOM",
+  "license": "MPL-2.0",
+  "devDependencies": {
+    "@eslint/eslintrc": "^3.3.1",
+    "@eslint/js": "^9.36.0",
+    "@types/chai": "^5.2.2",
+    "chai": "^6.0.1",
+    "chai-as-promised": "^8.0.2",
+    "eslint": "^9.36.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-chai-expect": "^3.1.0",
+    "eslint-plugin-chai-friendly": "^1.1.0",
+    "eslint-plugin-import": "^2.32.0",
+    "eslint-plugin-mocha": "^11.1.0",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-prettier": "^5.5.4",
+    "eslint-plugin-promise": "^7.2.1",
+    "eslint-plugin-security": "^3.0.1",
+    "husky": "^9.1.7",
+    "mocha": "^11.7.2",
+    "mochawesome": "^7.1.4",
+    "mochawesome-merge": "^5.0.0",
+    "mochawesome-report-generator": "^6.3.0",
+    "prettier": "^3.6.2",
+    "supertest": "^7.1.4"
+  }
+}
diff --git a/src/config/apiClient.js b/src/config/apiClient.js
@@ -0,0 +1,6 @@
+import supertest from "supertest";
+import { config } from "../config/index.js";
+
+export function request() {
+    return supertest(config.baseURI);
+}
diff --git a/src/config/environments.js b/src/config/environments.js
@@ -0,0 +1,17 @@
+export let environments = {
+    dev: {
+        baseUri: "https://gorest.co.in/",
+        userName: "",
+        password: ""
+    }, 
+    qa: {
+        baseUri: "",
+        userName: "",
+        password: ""
+    },
+    uat: {
+        baseUri: "",
+        userName: "",
+        password: ""
+    }
+}
diff --git a/src/config/index.js b/src/config/index.js
@@ -0,0 +1,23 @@
+import { environments } from "./environments.js";
+
+function environmentName() {
+    const env = process.env.TEST_ENV;
+    if (!env) {
+        throw new Error (`Test environment has not been specified!!`)
+    }
+    env.trim().toLowerCase();
+    if (!environments[env]) {
+        throw new Error (`Invalid environment ${env}. Provide a valid environment name: DEV | QA | UAT.`)
+    }
+    return env;
+}
+
+const environment = environmentName();
+const envDetails = environments[environment];
+
+export const config = {
+    env: environment,
+    baseURI: envDetails.baseUri,
+    username: process.env.USERNAME,
+    password: process.env.PASSWORD
+}  
diff --git a/src/services/userService.js b/src/services/userService.js
@@ -0,0 +1,4 @@
+export const users = {
+    createUser: 'public/v2/users',
+    getUsers: (id)=> `public/v2/users/${id}`
+}
diff --git a/tests/fixtures/globals.d.ts b/tests/fixtures/globals.d.ts
@@ -0,0 +1,7 @@
+import { expect as ChaiExpect } from "chai";
+
+declare global {
+  let expect: typeof ChaiExpect;
+}
+
+export {};
diff --git a/tests/fixtures/rootHooks.js b/tests/fixtures/rootHooks.js
@@ -0,0 +1,7 @@
+import chai from "chai";
+import { expect } from "chai";
+import chaiAsPromised from "chai-as-promised";
+
+chai.use(chaiAsPromised);
+
+global.expect = expect;
diff --git a/tests/specs/createUser.spec.js b/tests/specs/createUser.spec.js
@@ -0,0 +1,27 @@
+import { request } from "../../src/config/apiClient.js";
+import { users } from "../../src/services/userService.js";
+import { user } from "../testdata/createUser.js";
+
+const token = "";
+let userId = "";
+
+describe('Test the Users API', async function () {
+    it('Create a new user', async function () {
+        const createUserResponse = await request().post(users.createUser)
+        .set('Authorization', `Bearer ${token}`)
+        .send(user)
+        .expect(201);
+
+        expect(createUserResponse.body).to.have.property('id').to.exist;
+
+        userId = createUserResponse.body.id;
+    })
+    it('Retrieve user details', async function () {
+        const getUserDetailsResponse = await request()
+        .get(users.getUsers(userId))
+        .set('Authorization', `Bearer ${token}`)
+        .expect(200);
+
+        expect(getUserDetailsResponse.body.name).to.be.equal(user.name)
+    })
+})
diff --git a/tests/testdata/createUser.js b/tests/testdata/createUser.js
@@ -0,0 +1,6 @@
+export const user = {
+    name: "Joh1n1 Do1e1s1018",
+    gender: "male",
+    email: "joh1n11sac221802s.doe@ayz.com",
+    status: "active"
+}
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+yarn lint`
	`2`	`+yarn format:check`
	`3`	`+talisman --githook pre-commit`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+node_modules`
	`2`	`+mochawesome_report`
	`3`	`+.vscode`