Merge branch 'development' into 318-crud-endpoints-apidocs-testcases-for-coursework

Author: TejasNair9977

_apidoc.js

@@ -398,3 +398,28 @@
  * @apiSuccess {ObjectId} coursework.activity Id of the activity in Coursework.
  * @apiSuccess {Number} coursework.marks Marks in the Coursework.
  */
+=======
+// Module.
+// ------------------------------------------------------------------------------------------
+
+/**
+ * @api {get} module/list Get Module List
+ * @apiName GetModule
+ * @apiGroup Module
+ *
+ * @apiQuery {Number} [no] Module number.
+ * @apiQuery {String} [name] Name of the module.
+ * @apiQuery {String} [outcome] Module outcome.
+ * @apiQuery {String[]} [contents] Array of contents of the module.
+ * @apiQuery {Number} [hrsPerModule] Number of hours required per module.
+ * @apiQuery {String[]} [cognitiveLevels] Array of cognitive levels of attainment as per Bloom's Taxanomy (L1-L6).
+ *
+ * @apiSuccess {module[]} res Array of Filtered module Doc.
+ * @apiSuccess {String} module._id ID of document given by database.
+ * @apiSuccess {String} module.no Module number.
+ * @apiSuccess {String} module.name Name of the module.
+ * @apiSuccess {String} module.outcome Module outcome.
+ * @apiSuccess {String[]} module.contents Array of contents of the module.
+ * @apiSuccess {Number} module.hrsPerModule Number of hours required per module.
+ * @apiSuccess {String[]} module.cognitiveLevels Array of cognitive levels of attainment as per Bloom's Taxanomy (L1-L6).
+ */

app.js

@@ -11,6 +11,7 @@ import authRouter from "#routes/auth";
 import accreditationRouter from "#routes/accreditation";
 import infrastructureRouter from "#routes/infrastructure";
 import courseworkRouter from "#routes/coursework";
+import moduleRouter from "#routes/module";
 import { identifyUser } from "#middleware/identifyUser";
 
 const app = express();
@@ -35,5 +36,6 @@ app.use("/auth", authRouter);
 app.use("/accreditation", accreditationRouter);
 app.use("/infrastructure", infrastructureRouter);
 app.use("/coursework", courseworkRouter);
+app.use("/module", moduleRouter);
 
 export default app;

controller/module.js

@@ -0,0 +1,17 @@
+import { getModule } from "#services/module";
+import { logger } from "#util";
+
+async function showModule(req, res) {
+  try {
+    const modules = await getModule(req.query);
+    return res.json({ res: modules });
+  } catch (error) {
+    logger.error("Error while fetching", error);
+    res.status(500);
+    return res.json({ err: "Error while fetching the data" });
+  }
+}
+
+export default {
+  showModule,
+}

models/activityBlueprint.js

@@ -26,7 +26,7 @@ async function remove(filter) {
 async function create(activityBlueprintData) {
   const {
     number, academicYear, type, startDate, endDate,
-  } = activityBlueprintDataData;
+  } = activityBlueprintData;
   const activityblueprint = new ActivityBlueprint({
     number,
     academicYear,

models/semester.js

@@ -0,0 +1,59 @@
+import connector from "#models/databaseUtil";
+const semesterSchema = {
+  number:{ type: Number,enum: [1,2,3,4,5,6,7,8], required:true},
+  academicYear: {
+    type: String,
+    required: true,
+    validate: {
+      validator: (value) => /^20\d{2}$/.test(value),
+      message: (props) => `${props.value} is not a valid year format starting with "2"!`,
+    },
+  },
+  type:{ enum: ["ODD", "EVEN"], required: true },
+
+  startDate: { type: Date, required: true },
+  endDate: { type: Date, required: true },
+};
+
+// eslint-disable-next-line  no-unused-vars
+const Semester = connector.model("Semester", semesterSchema);
+
+//  CURD operations
+async function create(semesterData) {
+    const {
+      number,
+      academicYear,
+      type,
+      startDate,
+      endDate,
+    } = semesterData;
+    const semester = new Semester({
+      number,
+      academicYear,
+      type,
+      startDate,
+      endDate,
+
+    });
+    const semesterDoc = await semester.save();
+    return semesterDoc;
+  }
+  
+  async function read(filter, limit = 1) {
+    const semesterDoc = await Semester.find(filter).limit(limit);
+    return semesterDoc;
+  }
+  
+  async function update(filter, updateObject, options = { multi: true }) {
+    const updateResult = await Semester.updateMany(filter, { $set: updateObject }, options);
+    return updateResult.acknowledged;
+  }
+  
+  async function remove(filter) {
+    const deleteResult = await Semester.deleteMany(filter);
+    return deleteResult.acknowledged;
+  }
+  export default {
+    create, remove, update, read,
+  };
+  

routes/module.js

@@ -0,0 +1,8 @@
+import express from "express";
+import moduleController from "#controller/module";
+
+const router = express.Router();
+
+router.get("/list", moduleController.showModule);
+
+export default router;

services/module.js

@@ -0,0 +1,10 @@
+import Module from "#models/module";
+import databaseError from "#error/database";
+
+export async function getModule(filter) {
+  const modules = await Module.read(filter);
+  if (modules) {
+    return modules;
+  }
+  throw new databaseError.DataNotFoundError("Module");
+}

test/routes/module.test.js

@@ -0,0 +1,40 @@
+import request from "supertest";
+import { jest } from "@jest/globals"; // eslint-disable-line import/no-extraneous-dependencies
+import app from "#app";
+import connector from "#models/databaseUtil";
+
+jest.mock("#util");
+
+let server;
+let agent;
+beforeAll((done) => {
+  server = app.listen(null, () => {
+    agent = request.agent(server);
+    connector.set("debug", false);
+    done();
+  });
+});
+
+function cleanUp(callback) {
+  connector.disconnect((DBerr) => {
+    if (DBerr) console.log("Database dissconnnect error: ", DBerr);
+    server.close((serverErr) => {
+      if (serverErr) console.log(serverErr);
+      callback();
+    });
+  });
+}
+
+afterAll((done) => {
+  cleanUp(done);
+});
+
+describe("checking module functions", () => {
+  it("read module", async () => {
+    const response = await agent
+      .get("/module/list")
+      .send({ name: "xyz" });
+    expect(response.status).toBe(200);
+    expect(response.body.res).toBeDefined();
+  });
+});