[LAB3] 312555001

.github/workflows/PR.yml

@@ -15,27 +15,31 @@ jobs:
                       const { owner, repo, number: issue_number } = context.issue;
                       const pr = await github.rest.pulls.get({ owner, repo, pull_number: issue_number });
                       const title = pr.data.title;
-                      const labRegex = /\[LAB(\d+)\]/;
-                      const titleRegex = /^\[LAB\d+\] [\da-zA-Z]+$/;
 
-                      if (!titleRegex.test(title)) {
-                        core.setFailed('PR title does not match the required format. Please use the format [LAB#] student#.');
+                      const titleRegex = /^\[LAB(\d+)\] [a-zA-Z]?\d+$/;
+                      const match = title.match(titleRegex);
+
+                      let labNumberStr = undefined;
+                      if (match) {
+                        labNumberStr = match[1];
+                      } else {
+                        core.setFailed('PR title does not match the required format. Please use the format: [LAB#] <studentId>.');
                       }
 
-                      if (pr.data.head.ref !== pr.data.base.ref) {
-                        core.setFailed('The source branch and target branch must be the same.');
+                      const labelToAdd = `lab${labNumberStr}`;
+                      if (labNumberStr) {
+                        await github.rest.issues.addLabels({ owner, repo, issue_number, labels: [labelToAdd] });
                       }
 
                       if (pr.data.base.ref === 'main') {
                         core.setFailed('The target branch cannot be main.');
                       }
 
-                      const match = title.match(labRegex);
-                      if (match) {
-                        const labelToAdd = 'lab' + match[1];
-                        await github.rest.issues.addLabels({ owner, repo, issue_number, labels: [labelToAdd] });
-                      } else {
-                        core.setFailed('No match found in PR title. Please add a label in the format [LAB#] to the PR title.');
+                      if (labNumberStr < 3 && pr.data.head.ref !== pr.data.base.ref) {
+                        core.setFailed('The source branch and target branch must be the same.');
+                      }
+                      if (labNumberStr >= 3 && pr.data.head.ref !== labelToAdd) {
+                        core.setFailed(`The source branch must be '${labelToAdd}'`);
                       }
     checklist-check:
         runs-on: ubuntu-latest
@@ -49,12 +53,12 @@ jobs:
                       const pr = await github.rest.pulls.get({ owner, repo, pull_number: issue_number });
                       const body = pr.data.body;
 
-                      const checkboxes = body.match(/\- \[[x ]\]/g);
+                      const checkboxes = body.match(/^ ?(-|\*) \[[x ]\]/gmi);
                       if (!checkboxes || checkboxes.length !== 5) {
                         core.setFailed('The PR description must contain exactly 5 checkboxes.');
                       }
 
-                      const unchecked = body.match(/\- \[ \]/g);
+                      const unchecked = body.match(/^ ?(-|\*) \[ \]/gm);
                       if (unchecked && unchecked.length > 0) {
-                        core.setFailed(`There are ${unchecked.length} unchecked items in the PR description.`);
+                        core.setFailed(`There are ${unchecked.length} unchecked item(s) in the PR description.`);
                       }

.github/workflows/lab-autograding.yml

@@ -0,0 +1,55 @@
+name: Autograding
+
+on:
+    pull_request_target:
+        types: [labeled, synchronize, opened, reopened, ready_for_review]
+
+jobs:
+    build:
+        runs-on: ${{ matrix.os }}
+        strategy:
+            matrix:
+                os: [ubuntu-22.04]
+            fail-fast: false
+        steps:
+            - uses: actions/checkout@v4
+              with:
+                  ref: "${{ github.event.pull_request.merge_commit_sha }}"
+                  fetch-depth: 1
+            - uses: actions/setup-node@v4
+              with:
+                  node-version: latest
+            - name: Extract lab number and Check no changes other than specific files
+              uses: actions/github-script@v5
+              id: lab
+              with:
+                  result-encoding: string
+                  github-token: ${{ secrets.GITHUB_TOKEN }}
+                  script: |
+                      const { owner, repo, number: issue_number } = context.issue;
+                      const pr = await github.rest.pulls.get({ owner, repo, pull_number: issue_number });
+                      const labels = pr.data.labels;
+                      const lab = labels.find((label) => label.name.startsWith('lab'));
+                      if (!lab) {
+                        core.setFailed('No lab label found on the PR.');
+                        return { number: 0 };
+                      }
+                      const labNumberMatch = lab.name.match(/lab(\d+)/);
+                      if (!labNumberMatch) {
+                        core.setFailed('Invalid lab label found on the PR.');
+                        return { number: 0 };
+                      }
+                      const labNumber = labNumberMatch[1];
+                      console.log(`Lab number: ${labNumber}`)
+
+                      const files = await github.rest.pulls.listFiles({ owner, repo, pull_number: issue_number });
+                      const changedFiles = files.data.map((file) => file.filename);
+                      const allowedFileRegex = /^lab\d+\/main_test.js$/;
+                      if (!changedFiles.every((file) => allowedFileRegex.test(file))) {
+                        core.setFailed('The PR contains changes to files other than the allowed files.');
+                      }
+                      return labNumber;
+            - name: Grading
+              run: |
+                  cd lab${{ steps.lab.outputs.result }}
+                  ./validate.sh

.gitignore

@@ -0,0 +1 @@
+node_modules/

lab3/README.md

@@ -0,0 +1,29 @@
+# Lab3
+
+## 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)
+
+## Preparation (Important!!!)
+
+1. Sync fork on GitHub
+2. `git checkout -b lab3` (**NOT** your student ID !!!)
+
+## Requirement
+
+1. (40%) Write test cases in `main_test.js` and achieve 100% code coverage.
+2. (30%) For each function, parameterize their testcases to test the error-results.
+3. (30%) For each function, use at least 3 parameterized testcases to test the non-error-results.
+
+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.

lab3/main.js

@@ -0,0 +1,34 @@
+class Calculator {
+    exp(x) {
+        if (!Number.isFinite(x)) {
+            throw Error('unsupported operand type');
+        }
+        const result = Math.exp(x);
+        if (result === Infinity) {
+            throw Error('overflow');
+        }
+        return result;
+    }
+
+    log(x) {
+        if (!Number.isFinite(x)) {
+            throw Error('unsupported operand type');
+        }
+        const result = Math.log(x);
+        if (result === -Infinity) {
+            throw Error('math domain error (1)');
+        }
+        if (Number.isNaN(result)) {
+            throw Error('math domain error (2)');
+        }
+        return result;
+    }
+}
+
+// const calculator = new Calculator();
+// console.log(calculator.exp(87));
+// console.log(calculator.log(48763));
+
+module.exports = {
+    Calculator
+};

lab3/main_test.js

@@ -0,0 +1,85 @@
+const {describe, it} = require('node:test');
+const assert = require('assert');
+const { Calculator } = require('./main');
+
+// TODO: write your tests here
+
+const { mock } = require('node:test');
+
+describe('Calculator', () => {
+    it('should throw an error on non-numeric input when calculate exponential of a number', () => {
+        const calculator = new Calculator();
+        const testcases = [
+            { params: 'a', expected: Error('unsupported operand type') },
+            { params: '123abc', expected: Error('unsupported operand type') },
+            { params: '1', expected: Error('unsupported operand type') },
+            { params: '0', expected: Error('unsupported operand type') },
+            { params: true, expected: Error('unsupported operand type') },
+            { params: false, expected: Error('unsupported operand type') },
+            { params: NaN, expected: Error('unsupported operand type') },
+            { params: Infinity, expected: Error('unsupported operand type') },
+            { params: -Infinity, expected: Error('unsupported operand type') },
+        ]
+        for (const testcase of testcases) {
+            assert.throws(() => calculator.exp(testcase.params), testcase.expected);
+        }
+    });
+    it('show throw an error on overflow when calculate exponential of a number', () => {
+        const calculator = new Calculator();
+        mock.method(Math, 'exp', () => Infinity);
+        assert.throws(() => calculator.exp(1), Error('overflow'));
+        mock.reset();
+    });
+    it('should return the exponential of a number', () => {
+        const calculator = new Calculator();
+
+        function getRndInteger(min, max) {
+            return Math.floor(Math.random() * (max - min + 1)) + min;
+        }
+
+        for (let i = 0; i < 20; i++) {
+            const number = getRndInteger(-100, 100);
+            assert.strictEqual(calculator.exp(number), Math.exp(number));
+        }
+    });
+    it('should throw an error on non-numeric input when calculate logarithm of a number', () => {
+        const calculator = new Calculator();
+        const testcases = [
+            { params: 'a', expected: Error('unsupported operand type') },
+            { params: '123abc', expected: Error('unsupported operand type') },
+            { params: '1', expected: Error('unsupported operand type') },
+            { params: '0', expected: Error('unsupported operand type') },
+            { params: true, expected: Error('unsupported operand type') },
+            { params: false, expected: Error('unsupported operand type') },
+            { params: NaN, expected: Error('unsupported operand type') },
+            { params: Infinity, expected: Error('unsupported operand type') },
+            { params: -Infinity, expected: Error('unsupported operand type') },
+        ]
+        for (const testcase of testcases) {
+            assert.throws(() => calculator.log(testcase.params), testcase.expected);
+        }
+    });
+    it('show throw an error on math domain error when calculate logarithm of a number', () => {
+        const calculator = new Calculator();
+
+        mock.method(Math, 'log', () => -Infinity);
+        assert.throws(() => calculator.log(1), Error('math domain error (1)'));
+        mock.reset();
+
+        mock.method(Math, 'log', () => NaN);
+        assert.throws(() => calculator.log(1), Error('math domain error (2)'));
+        mock.reset();
+    });
+    it('should return the logarithm of a number', () => {
+        const calculator = new Calculator();
+
+        function getRndInteger(min, max) {
+            return Math.floor(Math.random() * (max - min + 1)) + min;
+        }
+
+        for (let i = 0; i < 20; i++) {
+            const number = getRndInteger(1, 1000);
+            assert.strictEqual(calculator.log(number), Math.log(number));
+        }
+    });
+});

lab3/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 lab3-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%"
+    exit 1
+  else
+    echo "[V] Coverage is 100%"
+  fi
+fi
+
+rm -rf $tmp_dir
+
+exit 0
+
+# vim: set fenc=utf8 ff=unix et sw=2 ts=2 sts=2:

scripts/merge-all.sh

@@ -0,0 +1,29 @@
+#!/bin/bash
+
+if [ $# -ne 1 ]; then
+    echo "$0 <commit-message>"
+    exit 1
+fi
+
+git fetch origin
+
+for branch in $(git branch -r | grep -v HEAD); do
+    # Remove the "origin/" prefix
+    branch=${branch#origin/}
+
+    if [[ "$branch" != "main" ]]; then
+        git checkout "$branch"
+        if [[ $? -ne 0 ]]; then
+            echo "Checkout failed for branch $branch"
+            exit 1
+        fi
+        git merge --squash -s recursive -X theirs main
+        if [[ $? -ne 0 ]]; then
+            echo "Merge failed for branch $branch"
+            exit 1
+        fi
+        git commit -m "$1"
+    fi
+done
+
+git checkout main