build: add coverage report

Author: mattfors

.github/workflows/build.yml

@@ -24,8 +24,17 @@ jobs:
     - name: Install dependencies
       run: npm install
 
-    - name: Build Angular project
-      run: npm run build -- --prod
+    - name: Run CI build
+      run: npm run ci:build
+
+    - name: Run CI tests
+      run: npm run ci:test
+
+    - name: Upload coverage report
+      uses: actions/upload-artifact@v3
+      with:
+        name: coverage-report
+        path: coverage
 
     - name: Publish Package
       uses: JS-DevTools/npm-publish@v3

package.json

@@ -1,6 +1,6 @@
 {
   "name": "angular-web-serial",
-  "version": "0.0.5",
+  "version": "0.0.6",
   "description": "Angular library for Web Serial API with RxJS",
   "repository": {
     "type": "git",
@@ -17,7 +17,9 @@
     "start": "ng serve",
     "build": "ng build",
     "watch": "ng build --watch --configuration development",
-    "test": "ng test"
+    "test": "ng test",
+    "ci:build": "ng build --prod",
+    "ci:test": "ng test --watch=false --browsers ChromeHeadless --code-coverage"
   },
   "private": false,
   "dependencies": {

projects/angular-serial/package.json

@@ -1,6 +1,6 @@
 {
   "name": "angular-web-serial",
-  "version": "0.0.5",
+  "version": "0.0.6",
   "peerDependencies": {
     "@angular/common": "^17.3.0",
     "@angular/core": "^17.3.0"

projects/angular-serial/src/lib/angular-serial-testing.module.ts

@@ -0,0 +1,21 @@
+import { NgModule } from '@angular/core';
+import { CommonModule, DOCUMENT } from '@angular/common';
+import { AngularSerialService } from './angular-serial.service';
+import { MockSerial } from './mock-serial';
+
+
+
+@NgModule({
+  declarations: [],
+  imports: [
+    CommonModule
+  ],
+  providers: [
+    AngularSerialService,
+    {
+      provide: 'Serial',
+      useClass: MockSerial
+    }
+  ]
+})
+export class AngularSerialTestingModule { }

projects/angular-serial/src/lib/angular-serial.module.ts

@@ -0,0 +1,18 @@
+import { NgModule } from '@angular/core';
+import { CommonModule, DOCUMENT } from '@angular/common';
+import { AngularSerialService } from './angular-serial.service';
+
+@NgModule({
+  imports: [
+    CommonModule
+  ],
+  providers: [
+    AngularSerialService,
+    {
+      provide: 'Serial',
+      useFactory: (document: Document) => document.defaultView?.navigator?.serial,
+      deps: [DOCUMENT]
+    }
+  ]
+})
+export class AngularSerialModule { }

projects/angular-serial/src/lib/angular-serial.service.spec.ts

@@ -1,16 +1,45 @@
 import { TestBed } from '@angular/core/testing';
 
 import { AngularSerialService } from './angular-serial.service';
+import { AngularSerialTestingModule } from './angular-serial-testing.module';
+import { switchMap } from 'rxjs';
 
 describe('AngularSerialService', () => {
   let service: AngularSerialService;
 
   beforeEach(() => {
-    TestBed.configureTestingModule({});
+    TestBed.configureTestingModule({
+      imports: [AngularSerialTestingModule]
+    });
     service = TestBed.inject(AngularSerialService);
   });
 
   it('should be created', () => {
     expect(service).toBeTruthy();
   });
+
+  it('should flag service as opened', (done) => {
+    service.open().subscribe(() => {
+      service.isConnected().subscribe((connected) => {
+        expect(connected).toBeTrue();
+        done();
+      });
+    });
+  });
+
+
+  it('should echo back write value on read', (done) => {
+    service.open().pipe(
+      switchMap(() => service.write('test')),
+      switchMap(() => service.read())
+    ).subscribe((value) => {
+      expect(value).toBe('test');
+      service.close();
+      done();
+    });
+  });
+
+
+
+
 });

projects/angular-serial/src/lib/angular-serial.service.ts

@@ -12,12 +12,9 @@ import {
 } from 'rxjs';
 import { DOCUMENT } from '@angular/common';
 
-@Injectable({
-  providedIn: 'root'
-})
+@Injectable()
 export class AngularSerialService {
 
-  readonly serial: Serial | undefined;
   private port: SerialPort | null = null;
   private abortController: AbortController | null = null;
   private dataStream: WritableStream | null = null;
@@ -34,10 +31,9 @@ export class AngularSerialService {
   }
 
   constructor(
-    @Inject(DOCUMENT) private document: Document,
+    @Inject('Serial') readonly serial: Serial | undefined,
     private ngZone: NgZone
   ) {
-    this.serial = this.document?.defaultView?.navigator?.serial;
   }
 
   /**

projects/angular-serial/src/lib/mock-serial.ts

@@ -0,0 +1,24 @@
+export class MockSerial {
+  private readableController: ReadableStreamDefaultController<Uint8Array> | null = null;
+
+  requestPort(options?: SerialPortRequestOptions): Promise<SerialPort> {
+    return Promise.resolve({
+      open: () => Promise.resolve(),
+      close: () => Promise.resolve(),
+      readable: new ReadableStream({
+        start: (controller) => {
+          this.readableController = controller;
+        }
+      }),
+      writable: new WritableStream({
+        write: (chunk) => {
+          const input = new TextDecoder().decode(chunk);
+          let response: string = input.trim();
+          if (this.readableController) {
+            this.readableController.enqueue(new TextEncoder().encode(response));
+          }
+        }
+      })
+    } as any as SerialPort);
+  }
+}