dspace-angular/src/app/process-page/detail/process-detail.component.spec.ts

import { HttpClient } from '@angular/common/http';
import { AuthService } from '../../core/auth/auth.service';
import { BitstreamDataService } from '../../core/data/bitstream-data.service';
import { AuthServiceMock } from '../../shared/mocks/auth.service.mock';
import { ProcessDetailComponent } from './process-detail.component';
import {
  waitForAsync,
  ComponentFixture,
  discardPeriodicTasks,
  fakeAsync,
  flush,
  flushMicrotasks,
  TestBed,
  tick
} from '@angular/core/testing';
import { VarDirective } from '../../shared/utils/var.directive';
import { TranslateModule } from '@ngx-translate/core';
import { CUSTOM_ELEMENTS_SCHEMA } from '@angular/core';
import { ProcessDetailFieldComponent } from './process-detail-field/process-detail-field.component';
import { Process } from '../processes/process.model';
import { ActivatedRoute, Router } from '@angular/router';
import { of as observableOf } from 'rxjs';
import { By } from '@angular/platform-browser';
import { FileSizePipe } from '../../shared/utils/file-size-pipe';
import { Bitstream } from '../../core/shared/bitstream.model';
import { ProcessDataService } from '../../core/data/processes/process-data.service';
import { DSONameService } from '../../core/breadcrumbs/dso-name.service';
import {
  createFailedRemoteDataObject$,
  createSuccessfulRemoteDataObject,
  createSuccessfulRemoteDataObject$
} from '../../shared/remote-data.utils';
import { createPaginatedList } from '../../shared/testing/utils.test';
import { NotificationsServiceStub } from '../../shared/testing/notifications-service.stub';
import { NgbModal } from '@ng-bootstrap/ng-bootstrap';
import { NotificationsService } from '../../shared/notifications/notifications.service';
import { getProcessListRoute } from '../process-page-routing.paths';
import {ProcessStatus} from '../processes/process-status.model';

describe('ProcessDetailComponent', () => {
  let component: ProcessDetailComponent;
  let fixture: ComponentFixture<ProcessDetailComponent>;

  let processService: ProcessDataService;
  let nameService: DSONameService;
  let bitstreamDataService: BitstreamDataService;
  let httpClient: HttpClient;
  let route: ActivatedRoute;

  let process: Process;
  let fileName: string;
  let files: Bitstream[];

  let processOutput;

  let modalService;
  let notificationsService;

  let router;

  function init() {
    processOutput = 'Process Started';
    process = Object.assign(new Process(), {
      processId: 1,
      scriptName: 'script-name',
      processStatus: 'COMPLETED',
      parameters: [
        {
          name: '-f',
          value: 'file.xml'
        },
        {
          name: '-i',
          value: 'identifier'
        }
      ],
      _links: {
        self: {
          href: 'https://rest.api/processes/1'
        },
        output: {
          href: 'https://rest.api/processes/1/output'
        }
      }
    });
    fileName = 'fake-file-name';
    files = [
      Object.assign(new Bitstream(), {
        sizeBytes: 10000,
        metadata: {
          'dc.title': [
            {
              value: fileName,
              language: null
            }
          ]
        },
        _links: {
          content: { href: 'file-selflink' }
        }
      })
    ];
    const logBitstream = Object.assign(new Bitstream(), {
      id: 'output.log',
      _links: {
        content: { href: 'log-selflink' }
      }
    });
    processService = jasmine.createSpyObj('processService', {
      getFiles: createSuccessfulRemoteDataObject$(createPaginatedList(files)),
      delete: createSuccessfulRemoteDataObject$(null),
      findById: createSuccessfulRemoteDataObject$(process),
    });
    bitstreamDataService = jasmine.createSpyObj('bitstreamDataService', {
      findByHref: createSuccessfulRemoteDataObject$(logBitstream)
    });
    nameService = jasmine.createSpyObj('nameService', {
      getName: fileName
    });
    httpClient = jasmine.createSpyObj('httpClient', {
      get: observableOf(processOutput)
    });

    modalService = jasmine.createSpyObj('modalService', {
      open: {}
    });

    notificationsService = new NotificationsServiceStub();

    router = jasmine.createSpyObj('router', {
      navigateByUrl:{}
    });

    route = jasmine.createSpyObj('route', {
      data: observableOf({ process: createSuccessfulRemoteDataObject(process) }),
      snapshot: {
        params: { id: process.processId }
      }
    });
  }

  beforeEach(waitForAsync(() => {
    init();
    TestBed.configureTestingModule({
      declarations: [ProcessDetailComponent, ProcessDetailFieldComponent, VarDirective, FileSizePipe],
      imports: [TranslateModule.forRoot()],
      providers: [
        {
          provide: ActivatedRoute,
          useValue: { data: observableOf({ process: createSuccessfulRemoteDataObject(process) }) }
        },
        { provide: ProcessDataService, useValue: processService },
        { provide: BitstreamDataService, useValue: bitstreamDataService },
        { provide: DSONameService, useValue: nameService },
        { provide: AuthService, useValue: new AuthServiceMock() },
        { provide: HttpClient, useValue: httpClient },
        { provide: NgbModal, useValue: modalService },
        { provide: NotificationsService, useValue: notificationsService },
        { provide: Router, useValue: router },
      ],
      schemas: [CUSTOM_ELEMENTS_SCHEMA]
    }).compileComponents();
  }));

  beforeEach(() => {
    fixture = TestBed.createComponent(ProcessDetailComponent);
    component = fixture.componentInstance;
  });
  afterEach(fakeAsync(() => {
    TestBed.resetTestingModule();
    fixture.destroy();
    flush();
    flushMicrotasks();
    discardPeriodicTasks();
    component = null;
  }));

  it('should display the script\'s name', () => {
    fixture.detectChanges();
    const name = fixture.debugElement.query(By.css('#process-name')).nativeElement;
    expect(name.textContent).toContain(process.scriptName);
  });

  it('should display the process\'s parameters', () => {
    fixture.detectChanges();
    const args = fixture.debugElement.query(By.css('#process-arguments')).nativeElement;
    process.parameters.forEach((param) => {
      expect(args.textContent).toContain(`${param.name} ${param.value}`);
    });
  });

  it('should display the process\'s output files', () => {
    fixture.detectChanges();
    const processFiles = fixture.debugElement.query(By.css('#process-files')).nativeElement;
    expect(processFiles.textContent).toContain(fileName);
  });

  describe('if press show output logs', () => {
    beforeEach(fakeAsync(() => {
      spyOn(component, 'showProcessOutputLogs').and.callThrough();
      fixture.detectChanges();

      const showOutputButton = fixture.debugElement.query(By.css('#showOutputButton'));
      showOutputButton.triggerEventHandler('click', {
        preventDefault: () => {/**/
        }
      });
      tick();
    }));
    it('should trigger showProcessOutputLogs', () => {
      expect(component.showProcessOutputLogs).toHaveBeenCalled();
    });
    it('should display the process\'s output logs', () => {
      fixture.detectChanges();
      const outputProcess = fixture.debugElement.query(By.css('#process-output pre'));
      expect(outputProcess.nativeElement.textContent).toContain(processOutput);
    });
  });

  describe('if press show output logs and process has no output logs', () => {
    beforeEach(fakeAsync(() => {
      jasmine.getEnv().allowRespy(true);
      spyOn(httpClient, 'get').and.returnValue(observableOf(null));
      fixture = TestBed.createComponent(ProcessDetailComponent);
      component = fixture.componentInstance;
      spyOn(component, 'showProcessOutputLogs').and.callThrough();
      fixture.detectChanges();
      const showOutputButton = fixture.debugElement.query(By.css('#showOutputButton'));
      showOutputButton.triggerEventHandler('click', {
        preventDefault: () => {/**/
        }
      });
      tick();
      fixture.detectChanges();
    }));
    it('should not display the process\'s output logs', () => {
      const outputProcess = fixture.debugElement.query(By.css('#process-output pre'));
      expect(outputProcess).toBeNull();
    });
    it('should display message saying there are no output logs', () => {
      const noOutputProcess = fixture.debugElement.query(By.css('#no-output-logs-message')).nativeElement;
      expect(noOutputProcess).toBeDefined();
    });
  });

  describe('openDeleteModal', () => {
    it('should open the modal', () => {
      component.openDeleteModal({});
      expect(modalService.open).toHaveBeenCalledWith({});
    });
  });

  describe('deleteProcess', () => {
    it('should delete the process and navigate back to the overview page on success', () => {
      spyOn(component, 'closeModal');
      component.deleteProcess(process);

      expect(processService.delete).toHaveBeenCalledWith(process.processId);
      expect(notificationsService.success).toHaveBeenCalled();
      expect(component.closeModal).toHaveBeenCalled();
      expect(router.navigateByUrl).toHaveBeenCalledWith(getProcessListRoute());
    });
    it('should delete the process and not navigate on error', () => {
      (processService.delete as jasmine.Spy).and.returnValue(createFailedRemoteDataObject$());
      spyOn(component, 'closeModal');

      component.deleteProcess(process);

      expect(processService.delete).toHaveBeenCalledWith(process.processId);
      expect(notificationsService.error).toHaveBeenCalled();
      expect(component.closeModal).not.toHaveBeenCalled();
      expect(router.navigateByUrl).not.toHaveBeenCalled();
    });
  });

  describe('refresh counter', () => {
    const queryRefreshCounter = () => fixture.debugElement.query(By.css('.refresh-counter'));

    describe('if process is completed', () => {
      beforeEach(() => {
        process.processStatus = ProcessStatus.COMPLETED;
        route.data = observableOf({process: createSuccessfulRemoteDataObject(process)});
      });

      it('should not show',  () => {
        spyOn(component, 'startRefreshTimer');

        const refreshCounter = queryRefreshCounter();
        expect(refreshCounter).toBeNull();

        expect(component.startRefreshTimer).not.toHaveBeenCalled();
      });
    });

    describe('if process is not finished', () => {
      beforeEach(() => {
        process.processStatus = ProcessStatus.RUNNING;
        route.data = observableOf({process: createSuccessfulRemoteDataObject(process)});
        fixture.detectChanges();
        component.stopRefreshTimer();
      });

      it('should call startRefreshTimer',  () => {
        spyOn(component, 'startRefreshTimer');

        component.ngOnInit();
        fixture.detectChanges(); // subscribe to process observable with async pipe

        expect(component.startRefreshTimer).toHaveBeenCalled();
      });

      it('should call refresh method every 5 seconds, until process is completed', fakeAsync(() => {
        spyOn(component, 'refresh');
        spyOn(component, 'stopRefreshTimer');

        process.processStatus = ProcessStatus.COMPLETED;
        // set findbyId to return a completed process
        (processService.findById as jasmine.Spy).and.returnValue(observableOf(createSuccessfulRemoteDataObject(process)));

        component.ngOnInit();
        fixture.detectChanges(); // subscribe to process observable with async pipe

        expect(component.refresh).not.toHaveBeenCalled();

        expect(component.refreshCounter$.value).toBe(0);

        tick(1001); // 1 second + 1 ms by the setTimeout
        expect(component.refreshCounter$.value).toBe(5); // 5 - 0

        tick(2001); // 2 seconds + 1 ms by the setTimeout
        expect(component.refreshCounter$.value).toBe(3); // 5 - 2

        tick(2001); // 2 seconds + 1 ms by the setTimeout
        expect(component.refreshCounter$.value).toBe(1); // 3 - 2

        tick(1001); // 1 second + 1 ms by the setTimeout
        expect(component.refreshCounter$.value).toBe(0); // 1 - 1

        tick(1000); // 1 second

        expect(component.refresh).toHaveBeenCalledTimes(1);
        expect(component.stopRefreshTimer).toHaveBeenCalled();

        expect(component.refreshCounter$.value).toBe(0);

        tick(1001); // 1 second + 1 ms by the setTimeout
        // startRefreshTimer not called again
        expect(component.refreshCounter$.value).toBe(0);

        discardPeriodicTasks(); // discard any periodic tasks that have not yet executed
      }));

      it('should show if refreshCounter is different from 0', () => {
        component.refreshCounter$.next(1);
        fixture.detectChanges();

        const refreshCounter = queryRefreshCounter();
        expect(refreshCounter).not.toBeNull();
      });

    });

  });
});