Enhance webapp services' test cases organization

Author: mengdaming

webapp/src/app/services/tcr-build-info.service.spec.ts

@@ -21,41 +21,50 @@ describe('TcrBuildInfoService', () => {
     httpMock.verify();
   });
 
-  it('should be created', () => {
-    expect(service).toBeTruthy();
-  });
+  describe('service instance', () => {
 
-  it('should return expected build info when getBuildInfo is called', () => {
-    const sample: TcrBuildInfo = {
-      version: "1.0.0",
-      os: "some-os",
-      arch: "some-arch",
-      commit: "abc123",
-      date: "2024-01-01T00:00:00Z",
-      author: "some-author",
-    };
-
-    let actual: TcrBuildInfo | undefined;
-    service.getBuildInfo().subscribe(other => {
-      actual = other;
+    it('should be created', () => {
+      expect(service).toBeTruthy();
     });
 
-    const req = httpMock.expectOne(`/api/build-info`);
-    expect(req.request.method).toBe('GET');
-    expect(req.request.responseType).toEqual('json');
-    req.flush(sample);
-    expect(actual).toEqual(sample);
   });
 
-  it('should return undefined when getBuildInfo receives an error response', () => {
-    let actual: TcrBuildInfo | undefined;
-    service.getBuildInfo().subscribe(other => {
-      actual = other;
+  describe('getBuildInfo() function', () => {
+
+    it('should return build info when called', () => {
+      const sample: TcrBuildInfo = {
+        version: "1.0.0",
+        os: "some-os",
+        arch: "some-arch",
+        commit: "abc123",
+        date: "2024-01-01T00:00:00Z",
+        author: "some-author",
+      };
+
+      let actual: TcrBuildInfo | undefined;
+      service.getBuildInfo().subscribe(other => {
+        actual = other;
+      });
+
+      const req = httpMock.expectOne(`/api/build-info`);
+      expect(req.request.method).toBe('GET');
+      expect(req.request.responseType).toEqual('json');
+      req.flush(sample);
+      expect(actual).toEqual(sample);
+    });
+
+    it('should return undefined when receiving an error response', () => {
+      let actual: TcrBuildInfo | undefined;
+      service.getBuildInfo().subscribe(other => {
+        actual = other;
+      });
+
+      const req = httpMock.expectOne(`/api/build-info`);
+      expect(req.request.method).toBe('GET');
+      req.flush({message: 'Some network error'}, {status: 500, statusText: 'Server Error'});
+      expect(actual).toBeUndefined();
     });
 
-    const req = httpMock.expectOne(`/api/build-info`);
-    expect(req.request.method).toBe('GET');
-    req.flush({message: 'Some network error'}, {status: 500, statusText: 'Server Error'});
-    expect(actual).toBeUndefined();
   });
+
 });

webapp/src/app/services/tcr-session-info.service.spec.ts

@@ -21,44 +21,53 @@ describe('TcrSessionInfoService', () => {
     httpMock.verify();
   });
 
-  it('should be created', () => {
-    expect(service).toBeTruthy();
+  describe('service instance', () => {
+
+    it('should be created', () => {
+      expect(service).toBeTruthy();
+    });
+
   });
 
-  it('should return expected session info when getSessionInfo is called', () => {
-    const sample: TcrSessionInfo = {
-      baseDir: "/my/base/dir",
-      commitOnFail: false,
-      gitAutoPush: false,
-      language: "java",
-      messageSuffix: "my-suffix",
-      toolchain: "gradle",
-      vcsName: "git",
-      vcsSession: "my VCS session",
-      workDir: "/my/work/dir"
-    };
+  describe('getSessionInfo() function', () => {
+
+    it('should return session info when called', () => {
+      const sample: TcrSessionInfo = {
+        baseDir: "/my/base/dir",
+        commitOnFail: false,
+        gitAutoPush: false,
+        language: "java",
+        messageSuffix: "my-suffix",
+        toolchain: "gradle",
+        vcsName: "git",
+        vcsSession: "my VCS session",
+        workDir: "/my/work/dir"
+      };
 
-    let actual: TcrSessionInfo | undefined;
-    service.getSessionInfo().subscribe(other => {
-      actual = other;
+      let actual: TcrSessionInfo | undefined;
+      service.getSessionInfo().subscribe(other => {
+        actual = other;
+      });
+
+      const req = httpMock.expectOne(`/api/session-info`);
+      expect(req.request.method).toBe('GET');
+      expect(req.request.responseType).toEqual('json');
+      req.flush(sample);
+      expect(actual).toEqual(sample);
     });
 
-    const req = httpMock.expectOne(`/api/session-info`);
-    expect(req.request.method).toBe('GET');
-    expect(req.request.responseType).toEqual('json');
-    req.flush(sample);
-    expect(actual).toEqual(sample);
-  });
+    it('should return undefined when receiving an error response', () => {
+      let actual: TcrSessionInfo | undefined;
+      service.getSessionInfo().subscribe(other => {
+        actual = other;
+      });
 
-  it('should return undefined when getSessionInfo receives an error response', () => {
-    let actual: TcrSessionInfo | undefined;
-    service.getSessionInfo().subscribe(other => {
-      actual = other;
+      const req = httpMock.expectOne(`/api/session-info`);
+      expect(req.request.method).toBe('GET');
+      req.flush({message: 'Some network error'}, {status: 500, statusText: 'Server error'});
+      expect(actual).toBeUndefined();
     });
 
-    const req = httpMock.expectOne(`/api/session-info`);
-    expect(req.request.method).toBe('GET');
-    req.flush({message: 'Some network error'}, {status: 500, statusText: 'Server error'});
-    expect(actual).toBeUndefined();
   });
+
 });

webapp/src/app/services/websocket.service.spec.ts

@@ -32,35 +32,43 @@ describe('WebsocketService', () => {
     });
   });
 
-  it('should attempt a websocket connection on create', () => {
-    const expectedUrl = 'ws://' + window.location.host + '/ws';
-    expect(fakeSocketCtor).toHaveBeenCalledOnceWith(expectedUrl);
-  });
+  describe('service instance', () => {
 
-  it('should be able to receive TCR messages', (done) => {
-    let actual: TcrMessage | undefined;
-    service.webSocket$.subscribe((msg) => {
-      actual = msg;
-      done();
+    it('should be created', () => {
+      expect(service).toBeTruthy();
     });
-    fakeSocket.next(sampleMessage);
-    expect(actual).toBe(sampleMessage);
-  });
 
-  it('should handle websocket errors', () => {
-    const sampleError = new Error('WebSocket error');
-    let actual: Error | undefined;
-    service.webSocket$.asObservable().subscribe({
-      error: (err) => actual = err,
+    it('should attempt a websocket connection on create', () => {
+      const expectedUrl = 'ws://' + window.location.host + '/ws';
+      expect(fakeSocketCtor).toHaveBeenCalledOnceWith(expectedUrl);
+    });
+
+    it('should be able to forward received TCR messages', (done) => {
+      let actual: TcrMessage | undefined;
+      service.webSocket$.subscribe((msg) => {
+        actual = msg;
+        done();
+      });
+      fakeSocket.next(sampleMessage);
+      expect(actual).toBe(sampleMessage);
+    });
+
+    it('should handle websocket errors', () => {
+      const sampleError = new Error('WebSocket error');
+      let actual: Error | undefined;
+      service.webSocket$.asObservable().subscribe({
+        error: (err) => actual = err,
+      });
+      fakeSocket.error(sampleError);
+      expect(actual).toEqual(sampleError);
+    });
+
+    it('should close the websocket on destroy', () => {
+      spyOn(fakeSocket, 'complete');
+      service.ngOnDestroy();
+      expect(fakeSocket.complete).toHaveBeenCalled();
     });
-    fakeSocket.error(sampleError);
-    expect(actual).toEqual(sampleError);
-  });
 
-  it('should close the websocket on destroy', () => {
-    spyOn(fakeSocket, 'complete');
-    service.ngOnDestroy();
-    expect(fakeSocket.complete).toHaveBeenCalled();
   });
 
 });