Add tests

Change-type: patch

Author: Page-

package.json

@@ -2,13 +2,15 @@
   "name": "blinking",
   "version": "0.0.8",
   "description": "A module for \"blinking\" to a file (useful for writing to an LED file for actual blinks)",
+  "type": "commonjs",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
-    "prepare": "npx tsc",
+    "prepare": "npx tsc --project tsconfig.build.json",
     "lint": "balena-lint src",
     "lint-fix": "balena-lint --fix src",
-    "test": "npm run lint && npm run prepare"
+    "pretest": "npm run prepare",
+    "test": "mocha && npm run lint && npx tsc --noEmit"
   },
   "repository": {
     "type": "git",
@@ -22,9 +24,25 @@
   },
   "devDependencies": {
     "@balena/lint": "^8.0.2",
+    "@types/chai": "^4.3.16",
+    "@types/mocha": "^10.0.7",
+    "@types/mock-fs": "^4.13.4",
     "@types/node": "^16.18.96",
+    "@types/sinon": "^17.0.3",
+    "chai": "^4.5.0",
+    "mocha": "^10.7.0",
+    "mock-fs": "^5.2.0",
+    "sinon": "^18.0.0",
+    "ts-node": "^10.9.2",
     "typescript": "^5.4.5"
   },
+  "mocha": {
+    "reporter": "spec",
+    "recursive": true,
+    "require": "ts-node/register/transpile-only",
+    "bail": true,
+    "_": "test/*"
+  },
   "versionist": {
     "publishedAt": "2024-04-29T15:19:34.661Z"
   }

test/index.ts

@@ -0,0 +1,80 @@
+import { expect } from 'chai';
+import * as mockFs from 'mock-fs';
+import { useFakeTimers, SinonFakeTimers } from 'sinon';
+import { promises as fs } from 'fs';
+
+import blinking = require('..');
+
+describe('blinking', () => {
+	const LED_FILE_PATH = '/sys/class/leds/led0/brightness';
+	let clock: SinonFakeTimers;
+	const blink = blinking(LED_FILE_PATH);
+
+	const expectValue = async (path: string, expected: string) =>
+		expect(await fs.readFile(path, 'utf-8')).to.equal(expected);
+	const expectLedTurnedOn = async () => await expectValue(LED_FILE_PATH, '1');
+	const expectLedTurnedOff = async () => await expectValue(LED_FILE_PATH, '0');
+
+	beforeEach(() => {
+		clock = useFakeTimers();
+		mockFs({
+			[LED_FILE_PATH]: '0',
+		});
+	});
+
+	afterEach(() => {
+		mockFs.restore();
+		clock.restore();
+	});
+
+	it('blinks with default pattern', async () => {
+		blink.pattern.start();
+		await clock.tickAsync(1);
+		await expectLedTurnedOn();
+		await clock.tickAsync(200);
+		await expectLedTurnedOff();
+		blink.pattern.stop();
+	});
+
+	it('cancels blink on calling stop', async () => {
+		blink.pattern.start();
+		await clock.tickAsync(1);
+		await expectLedTurnedOn();
+		blink.pattern.stop();
+		await clock.tickAsync(1);
+		await expectLedTurnedOff();
+	});
+
+	it('blinks with custom pattern', async () => {
+		const pattern = {
+			blinks: 3,
+			onDuration: 500,
+			offDuration: 300,
+			pause: 100,
+		};
+		const expectPattern = async () => {
+			for (let i = 0; i < pattern.blinks; i++) {
+				await clock.tickAsync(1);
+				// 1 ms
+				await expectLedTurnedOn();
+				await clock.tickAsync(pattern.onDuration - 2);
+				// 499 ms
+				await expectLedTurnedOn();
+				await clock.tickAsync(1);
+				// 500 ms
+				await expectLedTurnedOff();
+				await clock.tickAsync(pattern.offDuration - 1);
+				// 799 ms
+				await expectLedTurnedOff();
+				await clock.tickAsync(1);
+				// 800 ms
+			}
+		};
+		blink.pattern.start(pattern);
+		await expectPattern();
+		// Should pause between blink sequences
+		await clock.tickAsync(pattern.pause);
+		await expectPattern();
+		blink.pattern.stop();
+	});
+});

tsconfig.build.json

@@ -0,0 +1,10 @@
+{
+    "extends": "./tsconfig.json",
+    "compilerOptions": {
+        "sourceMap": false,
+        "outDir": "./dist",
+    },
+    "include": [
+        "src/**/*"
+    ]
+}

tsconfig.json

@@ -5,14 +5,13 @@
         "strict": true,
         "removeComments": false,
         "preserveConstEnums": true,
-        "sourceMap": false,
         "target": "es2015",
         "noUnusedParameters": true,
         "noUnusedLocals": true,
-        "moduleResolution": "node",
-		"outDir": "./dist",
+        "moduleResolution": "node"
     },
     "include": [
-        "src/index.ts"
+        "src/**/*",
+        "test/**/*"
     ]
 }