DigitaleBibliothek / Frontend / c32e4ad7c79

Commits

Yury Bondarenko authored c32e4ad7c79 12 Sep 2022

93803: Add tests for create, search & put

src/app/core/data/base/create-data.spec.ts

Modified

-9
+import { RemoteDataBuildService } from '../../cache/builders/remote-data-build.service';
-10
+import { ObjectCacheService } from '../../cache/object-cache.service';
-11
+import { HALEndpointService } from '../../shared/hal-endpoint.service';
-12
+import { FindListOptions } from '../find-list-options.model';
-13
+import { Observable, of as observableOf } from 'rxjs';
-14
+import { CreateDataImpl } from './create-data';
-15
+import { NotificationsService } from '../../../shared/notifications/notifications.service';
-16
+import { getMockRequestService } from '../../../shared/mocks/request.service.mock';
-17
+import { HALEndpointServiceStub } from '../../../shared/testing/hal-endpoint-service.stub';
-18
+import { getMockRemoteDataBuildService } from '../../../shared/mocks/remote-data-build.service.mock';
--
+import { followLink } from '../../../shared/utils/follow-link-config.model';
--
+import { TestScheduler } from 'rxjs/testing';
-19
+import { RemoteData } from '../remote-data';
-20
+import { RequestEntryState } from '../request-entry-state.model';
-+
+import { createFailedRemoteDataObject, createSuccessfulRemoteDataObject } from '../../../shared/remote-data.utils';
-+
+import { RequestParam } from '../../cache/models/request-param.model';
-+
+import { RestRequestMethod } from '../rest-request-method';
-24
-25
+const endpoint = 'https://rest.api/core';
-26
-27
+class TestService extends CreateDataImpl<any> {
-28
+  constructor(
-29
+    protected requestService: RequestService,
-30
+    protected rdbService: RemoteDataBuildService,
-31
+    protected objectCache: ObjectCacheService,
-32
+    protected halService: HALEndpointService,
-33
+    protected notificationsService: NotificationsService,
-34
+  ) {
--
+    super(undefined, requestService, rdbService, objectCache, halService, notificationsService, undefined);
-+
+    super('test', requestService, rdbService, objectCache, halService, notificationsService, undefined);
-36
+  }
-37
--
+  public getBrowseEndpoint(options: FindListOptions = {}, linkPath: string = this.linkPath): Observable<string> {
-+
+  public getEndpoint(options: FindListOptions = {}, linkPath: string = this.linkPath): Observable<string> {
-39
+    return observableOf(endpoint);
-40
+  }
-41
+}
-42
-43
+describe('CreateDataImpl', () => {
-44
+  let service: TestService;
-45
+  let requestService;
-46
+  let halService;
-47
+  let rdbService;
-48
+  let objectCache;
-49
+  let notificationsService;
--
+  let selfLink;
--
+  let linksToFollow;
--
+  let testScheduler;
-50
+  let remoteDataMocks;
-+
+  let obj;
-+
-+
+  let MOCK_SUCCEEDED_RD;
-+
+  let MOCK_FAILED_RD;
-+
-+
+  let buildFromRequestUUIDSpy: jasmine.Spy;
-+
+  let createOnEndpointSpy: jasmine.Spy;
-58
-59
+  function initTestService(): TestService {
-60
+    requestService = getMockRequestService();
-61
+    halService = new HALEndpointServiceStub('url') as any;
-62
+    rdbService = getMockRemoteDataBuildService();
-63
+    objectCache = {
-64
-65
+      addPatch: () => {
-66
+        /* empty */
-67
+      },
-68
+      getObjectBySelfLink: () => {
-69
+        /* empty */
-70
+      },
-71
+      getByHref: () => {
-72
+        /* empty */
-73
+      },
-74
+    } as any;
--
+    notificationsService = {} as NotificationsService;
--
+    selfLink = 'https://rest.api/endpoint/1698f1d3-be98-4c51-9fd8-6bfedcbd59b7';
--
+    linksToFollow = [
--
+      followLink('a'),
--
+      followLink('b'),
--
+    ];
--
--
+    testScheduler = new TestScheduler((actual, expected) => {
--
+      // asserting the two objects are equal
--
+      // e.g. using chai.
--
+      expect(actual).toEqual(expected);
-+
+    notificationsService = jasmine.createSpyObj('notificationsService', {
-+
+      error: undefined,
-77
+    });
-78
-+
+    obj = {
-+
+      uuid: '1698f1d3-be98-4c51-9fd8-6bfedcbd59b7',
-+
+    };
-+
-83
+    const timeStamp = new Date().getTime();
-84
+    const msToLive = 15 * 60 * 1000;
-85
+    const payload = { foo: 'bar' };
-86
+    const statusCodeSuccess = 200;
-87
+    const statusCodeError = 404;
-88
+    const errorMessage = 'not found';
-89
+    remoteDataMocks = {
-90
+      RequestPending: new RemoteData(undefined, msToLive, timeStamp, RequestEntryState.RequestPending, undefined, undefined, undefined),
-91
+      ResponsePending: new RemoteData(undefined, msToLive, timeStamp, RequestEntryState.ResponsePending, undefined, undefined, undefined),
-92
+      Success: new RemoteData(timeStamp, msToLive, timeStamp, RequestEntryState.Success, undefined, payload, statusCodeSuccess),
-99
+      requestService,
-100
+      rdbService,
-101
+      objectCache,
-102
+      halService,
-103
+      notificationsService,
-104
+    );
-105
+  }
-106
-107
+  beforeEach(() => {
-108
+    service = initTestService();
-+
-+
+    buildFromRequestUUIDSpy = spyOn(rdbService, 'buildFromRequestUUID').and.callThrough();
-+
+    createOnEndpointSpy = spyOn(service, 'createOnEndpoint').and.callThrough();
-+
-+
+    MOCK_SUCCEEDED_RD = createSuccessfulRemoteDataObject({});
-+
+    MOCK_FAILED_RD = createFailedRemoteDataObject('something went wrong');
-115
+  });
-116
--
+  // todo: add specs (there were no ceate specs in original DataService suite!)
-+
+  describe('create', () => {
-+
+    it('should POST the object to the root endpoint with the given parameters and return the remote data', (done) => {
-+
+      const params = [
-+
+        new RequestParam('abc', 123), new RequestParam('def', 456)
-+
+      ];
-+
+      buildFromRequestUUIDSpy.and.returnValue(observableOf(remoteDataMocks.Success));
-+
-+
+      service.create(obj, ...params).subscribe(out => {
-+
+        expect(createOnEndpointSpy).toHaveBeenCalledWith(obj, jasmine.anything());
-+
+        expect(requestService.send).toHaveBeenCalledWith(jasmine.objectContaining({
-+
+          method: RestRequestMethod.POST,
-+
+          uuid: requestService.generateRequestId(),
-+
+          href: 'https://rest.api/core?abc=123&def=456',
-+
+          body: JSON.stringify(obj),
-+
+        }));
-+
+        expect(buildFromRequestUUIDSpy).toHaveBeenCalledWith(requestService.generateRequestId());
-+
+        expect(out).toEqual(remoteDataMocks.Success);
-+
+        done();
-+
+      });
-+
+    });
-+
+  });
-+
-+
+  describe('createOnEndpoint', () => {
-+
+    beforeEach(() => {
-+
+      buildFromRequestUUIDSpy.and.returnValue(observableOf(remoteDataMocks.Success));
-+
+    });
-+
-+
+    it('should send a POST request with the object as JSON', (done) => {
-+
+      service.createOnEndpoint(obj, observableOf('https://rest.api/core/custom?search')).subscribe(out => {
-+
+        expect(requestService.send).toHaveBeenCalledWith(jasmine.objectContaining({
-+
+          method: RestRequestMethod.POST,
-+
+          body: JSON.stringify(obj),
-+
+        }));
-+
+        done();
-+
+      });
-+
+    });
-+
-+
+    it('should send the POST request to the given endpoint', (done) => {
-+
-+
+      service.createOnEndpoint(obj, observableOf('https://rest.api/core/custom?search')).subscribe(out => {
-+
+        expect(requestService.send).toHaveBeenCalledWith(jasmine.objectContaining({
-+
+          method: RestRequestMethod.POST,
-+
+          href: 'https://rest.api/core/custom?search',
-+
+        }));
-+
+        done();
-+
+      });
-+
+    });
-+
-+
+    it('should return the remote data for the sent request', (done) => {
-+
+      service.createOnEndpoint(obj, observableOf('https://rest.api/core/custom?search')).subscribe(out => {
-+
+        expect(requestService.send).toHaveBeenCalledWith(jasmine.objectContaining({
-+
+          method: RestRequestMethod.POST,
-+
+          uuid: requestService.generateRequestId(),
-+
+        }));
-+
+        expect(buildFromRequestUUIDSpy).toHaveBeenCalledWith(requestService.generateRequestId());
-+
+        expect(notificationsService.error).not.toHaveBeenCalled();
-+
+        expect(out).toEqual(remoteDataMocks.Success);
-+
+        done();
-+
+      });
-+
+    });
-+
-+
+    it('should show an error notification if the request fails', (done) => {
-+
+      buildFromRequestUUIDSpy.and.returnValue(observableOf(remoteDataMocks.Error));
-+
-+
+      service.createOnEndpoint(obj, observableOf('https://rest.api/core/custom?search')).subscribe(out => {
-+
+        expect(requestService.send).toHaveBeenCalledWith(jasmine.objectContaining({
-+
+          method: RestRequestMethod.POST,
-+
+          uuid: requestService.generateRequestId(),
-+
+        }));
-+
+        expect(buildFromRequestUUIDSpy).toHaveBeenCalledWith(requestService.generateRequestId());
-+
+        expect(notificationsService.error).toHaveBeenCalled();
-+
+        expect(out).toEqual(remoteDataMocks.Error);
-+
+        done();
-+
+      });
-+
+    });
-+
+  });
-193
+});

Frontend

Commits

Jira Issues

Add shortcut