feat: lab1

Author: AxelHowe

lab1/README.md

@@ -0,0 +1,22 @@
+# Lab1
+
+## Introduction
+
+In this lab, you will write unit tests for functions implemented in `main.js`. You can learn how to use classes and functions in it by uncommenting the code in it. (But remember don't commit them on GitHub)
+
+## Requirement
+
+1. Write test cases in `main_test.js` and achieve 100% code coverage. (100%)
+
+You can run `validate.sh` in your local to test if you satisfy the requirements.
+
+Please note that you must not alter files other than `main_test.js`. You will get 0 points if
+
+1. you modify other files to achieve requirements.
+2. you can't pass all CI on your PR.
+
+## Submission
+
+You need to open a pull request to your branch (e.g. 311XXXXXX, your student number) and contain the code that satisfies the abovementioned requirements.
+
+Moreover, please submit the URL of your PR to E3. Your submission will only be accepted when you present at both places.

lab1/main.js

@@ -0,0 +1,55 @@
+// NOTICE: DO NOT MODIFY THE CODE IN THIS FILE
+// But you can uncomment code below and run this file to understand how to use the classes
+
+class MyClass {
+    constructor() {
+        this.students = [];
+    }
+
+    addStudent(student) {
+        if (!(student instanceof Student)) {
+            return -1;
+        }
+        this.students.push(student);
+        return this.students.length - 1;
+    }
+
+    getStudentById(id) {
+        if (id < 0 || id >= this.students.length) {
+            return null;
+        }
+        return this.students[id];
+    }
+}
+
+class Student {
+    constructor() {
+        this.name = undefined;
+    }
+
+    setName(userName) {
+        if (typeof userName !== 'string') {
+            return;
+        }
+        this.name = userName;
+    }
+
+    getName() {
+        if (this.name === undefined) {
+            return '';
+        }
+        return this.name;
+    }
+}
+
+// const myClass = new MyClass();
+// const names = ['John', 'Jane', 'Doe', 'Smith'];
+// names.forEach(name => {
+//     const student = new Student();
+//     student.setName(name);
+//     const newStudentId = myClass.addStudent(student);
+//     const newStudentName = myClass.getStudentById(newStudentId).getName();
+//     console.log('[+] Added student with id: %d, name: %s', newStudentId, newStudentName);
+// });
+
+module.exports = { MyClass, Student };

lab1/main_test.js

@@ -0,0 +1,23 @@
+const test = require('node:test');
+const assert = require('assert');
+const { MyClass, Student } = require('./main');
+
+test("Test MyClass's addStudent", () => {
+    // TODO
+    throw new Error("Test not implemented");
+});
+
+test("Test MyClass's getStudentById", () => {
+    // TODO
+    throw new Error("Test not implemented");
+});
+
+test("Test Student's setName", () => {
+    // TODO
+    throw new Error("Test not implemented");
+});
+
+test("Test Student's getName", () => {
+    // TODO
+    throw new Error("Test not implemented");
+});

lab1/validate.sh

@@ -0,0 +1,38 @@
+#!/bin/bash
+
+# Check for unwanted files
+for file in *; do
+  if [[ $file != "main.js" && $file != "main_test.js" && $file != "README.md" && $file != "validate.sh" ]]; then
+    echo "[!] Unwanted file detected: $file."
+    exit 1
+  fi
+done
+
+node=$(which node)
+test_path="${BASH_SOURCE[0]}"
+solution_path="$(realpath .)"
+tmp_dir=$(mktemp -d -t lab1-XXXXXXXXXX)
+
+cd $tmp_dir
+
+rm -rf *
+cp $solution_path/*.js .
+result=$($"node" --test --experimental-test-coverage) ; ret=$?
+if [ $ret -ne 0 ] ; then
+  echo "[!] testing fails."
+  exit 1
+else
+  coverage=$(echo "$result" | grep 'all files' | awk -F '|' '{print $2}' | sed 's/ //g')
+  if (( $(echo "$coverage < 100" | bc -l) )); then
+    echo "[!] Coverage is only $coverage%, should be 100%."
+    exit 1
+  else
+    echo "[V] Coverage is 100%, great job!"
+  fi
+fi
+
+rm -rf $tmp_dir
+
+exit 0
+
+# vim: set fenc=utf8 ff=unix et sw=2 ts=2 sts=2: