Run linting during CI (and other small cleanups) (#477)

* Run linting during CI

  Otherwise it tends to break over time.

* Fix lint errors about "Forbidden non-null assertion"

  regPC cannot be undefined at this point because we assert as much above, so
the non-null assertions are not needed. However the TypeScript compiler does
not know that and would error out because it does not understand
`expect(regPC).to.exist`. It does understand `assert(regPC !== undefined)`,
so replace it with that. (Not an exact replacement because `exist` also
checks for null, but that cannot occur here.)

* Fix typo in ignoring compiled test programs

* Run mocha with --forbid-only in CI

  To catch accidentally committed `.only(` on tests.

Signed-off-by: Christian Walther <[email protected]>

Author: cwalther

.github/workflows/build-pr.yml

@@ -28,7 +28,9 @@ jobs:
       - name: Build
         run: yarn
       - name: Verify code formatting is valid
-        run: yarn format-check
+        run: |
+          yarn format-check
+          yarn lint
       - name: Build Test Programs
         run: make -C src/integration-tests/test-programs
       - name: Test

package.json

@@ -36,16 +36,16 @@
     "test:integration-hw-breakpoint-on-remote-target": "cross-env JUNIT_REPORT_PATH=test-reports/integration-hw-breakpoint-on-remote-target.xml JUNIT_REPORT_STACK=1 JUNIT_REPORT_PACKAGES=1 ENV_TEST_VAR=VALUE1 mocha --exit --reporter mocha-jenkins-reporter -r ts-node/register src/integration-tests/*.spec.ts --test-hw-breakpoint-on --test-remote",
     "test:pty": "cross-env JUNIT_REPORT_PATH=test-reports/native.xml JUNIT_REPORT_STACK=1 JUNIT_REPORT_PACKAGES=1 mocha --exit --reporter mocha-jenkins-reporter dist/native/*.spec.js",
     "test-ci": "run-s --continue-on-error test-ci:integration test-ci:integration-remote-target test-ci:integration-gdb-async-off test-ci:integration-gdb-async-off-remote-target test-ci:integration-gdb-non-stop test-ci:integration-gdb-non-stop-remote-target test-ci:integration-hw-breakpoint-on-remote-target",
-    "test-ci:integration": "cross-env JUNIT_REPORT_PATH=test-reports/integration.xml JUNIT_REPORT_STACK=1 JUNIT_REPORT_PACKAGES=1 ENV_TEST_VAR=VALUE1 mocha --exit --skip-make --reporter mocha-jenkins-reporter -r ts-node/register src/integration-tests/*.spec.ts",
-    "test-ci:integration-run-in-terminal": "cross-env JUNIT_REPORT_PATH=test-reports/integration-run-in-terminal.xml JUNIT_REPORT_STACK=1 ENV_TEST_VAR=VALUE1 JUNIT_REPORT_PACKAGES=1 mocha --exit --skip-make --run-in-terminal --reporter mocha-jenkins-reporter -r ts-node/register src/integration-tests/*.spec.ts",
-    "test-ci:integration-remote-target": "cross-env JUNIT_REPORT_PATH=test-reports/integration-remote-target.xml JUNIT_REPORT_STACK=1 JUNIT_REPORT_PACKAGES=1 ENV_TEST_VAR=VALUE1 mocha --exit --skip-make --test-remote --reporter mocha-jenkins-reporter -r ts-node/register src/integration-tests/*.spec.ts",
-    "test-ci:integration-remote-target-run-in-terminal": "cross-env JUNIT_REPORT_PATH=test-reports/integration-remote-target-run-in-terminal.xml JUNIT_REPORT_STACK=1 JUNIT_REPORT_PACKAGES=1 ENV_TEST_VAR=VALUE1 mocha --exit --skip-make --test-remote --run-in-terminal --reporter mocha-jenkins-reporter -r ts-node/register src/integration-tests/*.spec.ts",
-    "test-ci:integration-gdb-async-off": "cross-env JUNIT_REPORT_PATH=test-reports/integration-gdb-async-off.xml JUNIT_REPORT_STACK=1 JUNIT_REPORT_PACKAGES=1 ENV_TEST_VAR=VALUE1 mocha --exit --skip-make --reporter mocha-jenkins-reporter -r ts-node/register src/integration-tests/*.spec.ts --test-gdb-async-off",
-    "test-ci:integration-gdb-async-off-remote-target": "cross-env JUNIT_REPORT_PATH=test-reports/integration-gdb-async-off-remote-target.xml JUNIT_REPORT_STACK=1 JUNIT_REPORT_PACKAGES=1 ENV_TEST_VAR=VALUE1 mocha --exit --skip-make --reporter mocha-jenkins-reporter -r ts-node/register src/integration-tests/*.spec.ts --test-gdb-async-off --test-remote",
-    "test-ci:integration-gdb-non-stop": "cross-env JUNIT_REPORT_PATH=test-reports/integration-gdb-non-stop.xml JUNIT_REPORT_STACK=1 JUNIT_REPORT_PACKAGES=1 ENV_TEST_VAR=VALUE1 mocha --exit --skip-make --reporter mocha-jenkins-reporter -r ts-node/register src/integration-tests/*.spec.ts --test-gdb-non-stop",
-    "test-ci:integration-gdb-non-stop-remote-target": "cross-env JUNIT_REPORT_PATH=test-reports/integration-gdb-non-stop-remote-target.xml JUNIT_REPORT_STACK=1 JUNIT_REPORT_PACKAGES=1 ENV_TEST_VAR=VALUE1 mocha --exit --skip-make --reporter mocha-jenkins-reporter -r ts-node/register src/integration-tests/*.spec.ts --test-gdb-non-stop --test-remote",
-    "test-ci:integration-hw-breakpoint-on-remote-target": "cross-env JUNIT_REPORT_PATH=test-reports/integration-hw-breakpoint-on-remote-target.xml JUNIT_REPORT_STACK=1 JUNIT_REPORT_PACKAGES=1 ENV_TEST_VAR=VALUE1 mocha --exit --skip-make --reporter mocha-jenkins-reporter -r ts-node/register src/integration-tests/*.spec.ts --test-hw-breakpoint-on --test-remote",
-    "test-ci:pty": "cross-env JUNIT_REPORT_PATH=test-reports/native.xml JUNIT_REPORT_STACK=1 JUNIT_REPORT_PACKAGES=1 mocha --exit --skip-make --reporter mocha-jenkins-reporter dist/native/*.spec.js"
+    "test-ci:integration": "cross-env JUNIT_REPORT_PATH=test-reports/integration.xml JUNIT_REPORT_STACK=1 JUNIT_REPORT_PACKAGES=1 ENV_TEST_VAR=VALUE1 mocha --exit --forbid-only --skip-make --reporter mocha-jenkins-reporter -r ts-node/register src/integration-tests/*.spec.ts",
+    "test-ci:integration-run-in-terminal": "cross-env JUNIT_REPORT_PATH=test-reports/integration-run-in-terminal.xml JUNIT_REPORT_STACK=1 ENV_TEST_VAR=VALUE1 JUNIT_REPORT_PACKAGES=1 mocha --exit --forbid-only --skip-make --run-in-terminal --reporter mocha-jenkins-reporter -r ts-node/register src/integration-tests/*.spec.ts",
+    "test-ci:integration-remote-target": "cross-env JUNIT_REPORT_PATH=test-reports/integration-remote-target.xml JUNIT_REPORT_STACK=1 JUNIT_REPORT_PACKAGES=1 ENV_TEST_VAR=VALUE1 mocha --exit --forbid-only --skip-make --test-remote --reporter mocha-jenkins-reporter -r ts-node/register src/integration-tests/*.spec.ts",
+    "test-ci:integration-remote-target-run-in-terminal": "cross-env JUNIT_REPORT_PATH=test-reports/integration-remote-target-run-in-terminal.xml JUNIT_REPORT_STACK=1 JUNIT_REPORT_PACKAGES=1 ENV_TEST_VAR=VALUE1 mocha --exit --forbid-only --skip-make --test-remote --run-in-terminal --reporter mocha-jenkins-reporter -r ts-node/register src/integration-tests/*.spec.ts",
+    "test-ci:integration-gdb-async-off": "cross-env JUNIT_REPORT_PATH=test-reports/integration-gdb-async-off.xml JUNIT_REPORT_STACK=1 JUNIT_REPORT_PACKAGES=1 ENV_TEST_VAR=VALUE1 mocha --exit --forbid-only --skip-make --reporter mocha-jenkins-reporter -r ts-node/register src/integration-tests/*.spec.ts --test-gdb-async-off",
+    "test-ci:integration-gdb-async-off-remote-target": "cross-env JUNIT_REPORT_PATH=test-reports/integration-gdb-async-off-remote-target.xml JUNIT_REPORT_STACK=1 JUNIT_REPORT_PACKAGES=1 ENV_TEST_VAR=VALUE1 mocha --exit --forbid-only --skip-make --reporter mocha-jenkins-reporter -r ts-node/register src/integration-tests/*.spec.ts --test-gdb-async-off --test-remote",
+    "test-ci:integration-gdb-non-stop": "cross-env JUNIT_REPORT_PATH=test-reports/integration-gdb-non-stop.xml JUNIT_REPORT_STACK=1 JUNIT_REPORT_PACKAGES=1 ENV_TEST_VAR=VALUE1 mocha --exit --forbid-only --skip-make --reporter mocha-jenkins-reporter -r ts-node/register src/integration-tests/*.spec.ts --test-gdb-non-stop",
+    "test-ci:integration-gdb-non-stop-remote-target": "cross-env JUNIT_REPORT_PATH=test-reports/integration-gdb-non-stop-remote-target.xml JUNIT_REPORT_STACK=1 JUNIT_REPORT_PACKAGES=1 ENV_TEST_VAR=VALUE1 mocha --exit --forbid-only --skip-make --reporter mocha-jenkins-reporter -r ts-node/register src/integration-tests/*.spec.ts --test-gdb-non-stop --test-remote",
+    "test-ci:integration-hw-breakpoint-on-remote-target": "cross-env JUNIT_REPORT_PATH=test-reports/integration-hw-breakpoint-on-remote-target.xml JUNIT_REPORT_STACK=1 JUNIT_REPORT_PACKAGES=1 ENV_TEST_VAR=VALUE1 mocha --exit --forbid-only --skip-make --reporter mocha-jenkins-reporter -r ts-node/register src/integration-tests/*.spec.ts --test-hw-breakpoint-on --test-remote",
+    "test-ci:pty": "cross-env JUNIT_REPORT_PATH=test-reports/native.xml JUNIT_REPORT_STACK=1 JUNIT_REPORT_PACKAGES=1 mocha --exit --forbid-only --skip-make --reporter mocha-jenkins-reporter dist/native/*.spec.js"
   },
   "repository": {
     "type": "git",

src/integration-tests/multithread.spec.ts

@@ -473,11 +473,12 @@ describe('multithread', async function () {
                 const regPC = vars.body.variables.find(
                     (v) => v.name === 'pc' || v.name === 'rip'
                 );
-                expect(regPC).to.exist;
+                // assert instead of expect to make tsc happy so we don't need forbidden non-null assertions below
+                assert(regPC !== undefined, 'expected regPC to exist');
                 const reg0 = vars.body.variables[0];
 
                 const setRegPC = await dc.setVariableRequest({
-                    name: regPC!.name,
+                    name: regPC.name,
                     value: '0x200',
                     variablesReference: vr,
                 });
@@ -503,12 +504,12 @@ describe('multithread', async function () {
                         variable.value,
                     ])
                 );
-                expect(varnameToValue1.get(regPC!.name)).to.equal('0x200');
+                expect(varnameToValue1.get(regPC.name)).to.equal('0x200');
                 expect(varnameToValue1.get(reg0.name)).to.equal('0x55555');
 
                 await dc.setVariableRequest({
-                    name: regPC!.name,
-                    value: regPC!.value,
+                    name: regPC.name,
+                    value: regPC.value,
                     variablesReference: vr,
                 });
                 await dc.setVariableRequest({

src/integration-tests/test-programs/.gitignore

@@ -7,7 +7,7 @@ evaluate
 mem
 vars
 vars_env
-var_globals
+vars_globals
 segv
 loopforever
 MultiThread