+# Test Helper
+
+Helpers for writing tests which use vvarious Squeep packages.
+
+Provides stub-builders for:
+
+- [Squeep Structured Logger](https://www.npmjs.com/package/@squeep/logger-json-console)
+- [Squeep Database Abstractor](https://git.squeep.com/?p=squeep-db-helper;a=tree)
+
+## Usage
+
+```javascript
+const { StubDatabase, StubLogger } = require('@squeep/test-helper');
+const assert = require('node:assert);
+const sinon = require('sinon');
+
+class AppDB extends StubDatabase {
+ constructor() {
+ super(sinon);
+ }
+ get _stubFns() {
+ return [
+ ...super._stubFns,
+ // Add database interface functions.
+ 'valueGet',
+ 'valueSet',
+ ];
+ }
+}
+
+const logger = new StubLogger(sinon);
+const db = new AppDB();
+
+describe('App Test', function () {
+ beforeEach(function () {
+ db._reset();
+ logger._reset();
+ });
+ it('uses stubs', function () {
+ const app = new App(logger, db);
+ app.doAThing();
+ assert(logger.error.called);
+ assert(db.valueGet.called);
+ });
+});
+```