Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion jest.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,6 @@ module.exports = {
'<rootDir>/src/app/features/files/components',
'<rootDir>/src/app/features/files/pages/community-metadata',
'<rootDir>/src/app/features/files/pages/file-detail',
'<rootDir>/src/app/features/my-projects/',
'<rootDir>/src/app/features/preprints/',
'<rootDir>/src/app/features/project/contributors/',
'<rootDir>/src/app/features/project/overview/',
Expand Down
Original file line number Diff line number Diff line change
@@ -1,43 +1,89 @@
import { provideStore } from '@ngxs/store';
import { Store } from '@ngxs/store';

import { TranslatePipe } from '@ngx-translate/core';
import { MockPipe, MockProvider } from 'ng-mocks';
import { MockComponent, MockProvider } from 'ng-mocks';

import { DynamicDialogRef } from 'primeng/dynamicdialog';

import { provideHttpClient } from '@angular/common/http';
import { provideHttpClientTesting } from '@angular/common/http/testing';
import { of } from 'rxjs';

import { ComponentFixture, TestBed } from '@angular/core/testing';

import { TranslateServiceMock } from '@shared/mocks';
import { MyResourcesState } from '@shared/stores';
import { InstitutionsState } from '@shared/stores/institutions';
import { RegionsState } from '@shared/stores/regions';
import { MY_PROJECTS_TABLE_PARAMS } from '@osf/shared/constants';
import { ProjectFormControls } from '@osf/shared/enums';
import { MOCK_STORE } from '@osf/shared/mocks';
import { CreateProject, GetMyProjects, MyResourcesSelectors } from '@osf/shared/stores';
import { AddProjectFormComponent } from '@shared/components';

import { CreateProjectDialogComponent } from './create-project-dialog.component';

import { OSFTestingModule } from '@testing/osf.testing.module';

describe('CreateProjectDialogComponent', () => {
let component: CreateProjectDialogComponent;
let fixture: ComponentFixture<CreateProjectDialogComponent>;
let store: Store;
let dialogRef: DynamicDialogRef;

const fillValidForm = (
title = 'My Project',
description = 'Some description',
template = 'tmpl-1',
storageLocation = 'osfstorage',
affiliations: string[] = ['aff-1', 'aff-2']
) => {
component.projectForm.patchValue({
[ProjectFormControls.Title]: title,
[ProjectFormControls.Description]: description,
[ProjectFormControls.Template]: template,
[ProjectFormControls.StorageLocation]: storageLocation,
[ProjectFormControls.Affiliations]: affiliations,
});
};

beforeEach(async () => {
(MOCK_STORE.selectSignal as jest.Mock).mockImplementation((selector) => {
if (selector === MyResourcesSelectors.isProjectSubmitting) return () => false;
return () => undefined;
});

await TestBed.configureTestingModule({
imports: [CreateProjectDialogComponent, MockPipe(TranslatePipe)],
providers: [
provideStore([MyResourcesState, InstitutionsState, RegionsState]),
provideHttpClient(),
provideHttpClientTesting(),
TranslateServiceMock,
MockProvider(DynamicDialogRef),
],
imports: [CreateProjectDialogComponent, OSFTestingModule, MockComponent(AddProjectFormComponent)],
providers: [MockProvider(Store, MOCK_STORE)],
}).compileComponents();

fixture = TestBed.createComponent(CreateProjectDialogComponent);
component = fixture.componentInstance;

store = TestBed.inject(Store);
dialogRef = TestBed.inject(DynamicDialogRef);

fixture.detectChanges();
});

it('should create', () => {
expect(component).toBeTruthy();
});

it('should mark all controls touched and not dispatch when form is invalid', () => {
const markAllSpy = jest.spyOn(component.projectForm, 'markAllAsTouched');

(store.dispatch as unknown as jest.Mock).mockClear();

component.submitForm();

expect(markAllSpy).toHaveBeenCalled();
expect(store.dispatch).not.toHaveBeenCalled();
});

it('should submit, refresh list and close dialog when form is valid', () => {
fillValidForm('Title', 'Desc', 'Tpl', 'Storage', ['a1']);

(MOCK_STORE.dispatch as jest.Mock).mockReturnValue(of(undefined));

component.submitForm();

expect(MOCK_STORE.dispatch).toHaveBeenCalledWith(new CreateProject('Title', 'Desc', 'Tpl', 'Storage', ['a1']));
expect(MOCK_STORE.dispatch).toHaveBeenCalledWith(new GetMyProjects(1, MY_PROJECTS_TABLE_PARAMS.rows, {}));
expect((dialogRef as any).close).toHaveBeenCalled();
});
});
184 changes: 168 additions & 16 deletions src/app/features/my-projects/my-projects.component.spec.ts
Original file line number Diff line number Diff line change
@@ -1,50 +1,202 @@
import { provideStore } from '@ngxs/store';
import { Store } from '@ngxs/store';

import { TranslateModule } from '@ngx-translate/core';
import { MockProvider } from 'ng-mocks';
import { MockComponents, MockProvider } from 'ng-mocks';

import { DialogService } from 'primeng/dynamicdialog';

import { BehaviorSubject, of } from 'rxjs';

import { provideHttpClient } from '@angular/common/http';
import { provideHttpClientTesting } from '@angular/common/http/testing';
import { ComponentFixture, TestBed } from '@angular/core/testing';
import { ActivatedRoute } from '@angular/router';
import { ActivatedRoute, Router } from '@angular/router';

import { MyProjectsTab } from '@osf/features/my-projects/enums';
import { SortOrder } from '@osf/shared/enums';
import { IS_MEDIUM } from '@osf/shared/helpers';
import { MyResourcesState } from '@shared/stores/my-resources/my-resources.state';

import { InstitutionsState } from '../../shared/stores/institutions';
import { MOCK_STORE } from '@osf/shared/mocks';
import { BookmarksSelectors, GetMyProjects, MyResourcesSelectors } from '@osf/shared/stores';
import { MyProjectsTableComponent, SelectComponent, SubHeaderComponent } from '@shared/components';

import { MyProjectsComponent } from './my-projects.component';

describe.skip('MyProjectsComponent', () => {
import { OSFTestingModule } from '@testing/osf.testing.module';

describe('MyProjectsComponent', () => {
let component: MyProjectsComponent;
let fixture: ComponentFixture<MyProjectsComponent>;
let isMediumSubject: BehaviorSubject<boolean>;
let queryParamsSubject: BehaviorSubject<Record<string, string>>;
let store: jest.Mocked<Store>;
let router: jest.Mocked<Router>;

beforeEach(async () => {
isMediumSubject = new BehaviorSubject<boolean>(false);
queryParamsSubject = new BehaviorSubject<Record<string, string>>({});

(MOCK_STORE.selectSignal as jest.Mock).mockImplementation((selector) => {
if (
selector === MyResourcesSelectors.getTotalProjects ||
selector === MyResourcesSelectors.getTotalRegistrations ||
selector === MyResourcesSelectors.getTotalPreprints ||
selector === MyResourcesSelectors.getTotalBookmarks
)
return () => 0;
if (selector === BookmarksSelectors.getBookmarksCollectionId) return () => null;
if (
selector === MyResourcesSelectors.getProjects ||
selector === MyResourcesSelectors.getRegistrations ||
selector === MyResourcesSelectors.getPreprints ||
selector === MyResourcesSelectors.getBookmarks
)
return () => [];
return () => undefined;
});

await TestBed.configureTestingModule({
imports: [MyProjectsComponent, TranslateModule.forRoot()],
imports: [
MyProjectsComponent,
OSFTestingModule,
...MockComponents(SubHeaderComponent, MyProjectsTableComponent, SelectComponent),
],
providers: [
provideStore([MyResourcesState, InstitutionsState]),
provideHttpClient(),
provideHttpClientTesting(),
MockProvider(DialogService),
MockProvider(ActivatedRoute, { queryParams: of({}) }),
MockProvider(Store, MOCK_STORE),
MockProvider(DialogService, { open: jest.fn() }),
MockProvider(ActivatedRoute, { queryParams: queryParamsSubject.asObservable() }),
MockProvider(Router, { navigate: jest.fn() }),
MockProvider(IS_MEDIUM, isMediumSubject),
],
}).compileComponents();

fixture = TestBed.createComponent(MyProjectsComponent);
component = fixture.componentInstance;
store = TestBed.inject(Store) as jest.Mocked<Store>;
router = TestBed.inject(Router) as jest.Mocked<Router>;

store.dispatch.mockReturnValue(of(undefined));

fixture.detectChanges();
});

it('should create', () => {
expect(component).toBeTruthy();
});

it('should update component state from query params', () => {
component.updateComponentState({ page: 2, size: 20, search: 'q', sortColumn: 'name', sortOrder: SortOrder.Desc });

expect(component.currentPage()).toBe(2);
expect(component.currentPageSize()).toBe(20);
expect(component.searchControl.value).toBe('q');
expect(component.sortColumn()).toBe('name');
expect(component.sortOrder()).toBe(SortOrder.Desc);
expect(component.tableParams().firstRowIndex).toBe(20);
expect(component.tableParams().rows).toBe(20);
});

it('should create filters depending on tab', () => {
const filtersProjects = component.createFilters({
page: 1,
size: 10,
search: 's',
sortColumn: 'name',
sortOrder: SortOrder.Asc,
});
expect(filtersProjects.searchValue).toBe('s');
expect(filtersProjects.searchFields).toEqual(['title', 'tags', 'description']);

component.selectedTab.set(MyProjectsTab.Preprints);
const filtersPreprints = component.createFilters({
page: 2,
size: 25,
search: 's2',
sortColumn: 'date',
sortOrder: SortOrder.Desc,
});
expect(filtersPreprints.searchFields).toEqual(['title', 'tags']);
});

it('should fetch data for projects tab and stop loading', () => {
jest.clearAllMocks();
store.dispatch.mockReturnValue(of(undefined));

component.fetchDataForCurrentTab({ page: 1, size: 10, search: 's', sortColumn: 'name', sortOrder: SortOrder.Asc });

expect(store.dispatch).toHaveBeenCalledWith(expect.any(GetMyProjects));
expect(component.isLoading()).toBe(false);
});

it('should handle search and update query params', () => {
jest.clearAllMocks();
queryParamsSubject.next({ sortColumn: 'name', sortOrder: 'desc', size: '25' });

component.handleSearch('query');

expect(router.navigate).toHaveBeenCalledWith([], {
relativeTo: expect.anything(),
queryParams: { page: '1', size: '25', search: 'query', sortColumn: 'name', sortOrder: 'desc' },
});
});

it('should paginate and update query params', () => {
jest.clearAllMocks();
queryParamsSubject.next({ sortColumn: 'title', sortOrder: 'asc' });

component.onPageChange({ first: 30, rows: 15 } as any);

expect(router.navigate).toHaveBeenCalledWith([], {
relativeTo: expect.anything(),
queryParams: { page: '3', size: '15', sortColumn: 'title', sortOrder: 'asc' },
});
});

it('should sort and update query params', () => {
jest.clearAllMocks();

component.onSort({ field: 'updated', order: SortOrder.Desc } as any);

expect(router.navigate).toHaveBeenCalledWith([], {
relativeTo: expect.anything(),
queryParams: { sortColumn: 'updated', sortOrder: 'desc' },
});
});

it('should clear and reset on tab change', () => {
jest.clearAllMocks();
queryParamsSubject.next({ size: '50' });

component.onTabChange(1);

expect(router.navigate).toHaveBeenCalledWith([], {
relativeTo: expect.anything(),
queryParams: { page: '1', size: '50' },
});

expect(store.dispatch).toHaveBeenCalled();
});

it('should open create project dialog with responsive width', () => {
const openSpy = jest.spyOn(component.dialogService, 'open');

isMediumSubject.next(false);
component.createProject();
expect(openSpy).toHaveBeenCalledWith(expect.any(Function), expect.objectContaining({ width: '95vw' }));

openSpy.mockClear();
isMediumSubject.next(true);
component.createProject();
expect(openSpy).toHaveBeenCalledWith(expect.any(Function), expect.objectContaining({ width: '850px' }));
});

it('should navigate to project and set active project', () => {
const project = { id: 'p1' } as any;
component.navigateToProject(project);
expect(component.activeProject()).toEqual(project);
expect(router.navigate).toHaveBeenCalledWith(['p1']);
});

it('should navigate to registry and set active project', () => {
const reg = { id: 'r1' } as any;
component.navigateToRegistry(reg);
expect(component.activeProject()).toEqual(reg);
expect(router.navigate).toHaveBeenCalledWith(['r1']);
});
});
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { MetaJsonApi } from '../common';
import { UserDataJsonApi } from '../user';
import { BaseNodeDataJsonApi } from '../nodes';
import { UserDataJsonApi } from '../user';

export interface ViewOnlyLinksResponseJsonApi {
data: ViewOnlyLinkJsonApi[];
Expand Down
8 changes: 8 additions & 0 deletions src/testing/mocks/dynamic-dialog-ref.mock.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
import { DynamicDialogRef } from 'primeng/dynamicdialog';

export const DynamicDialogRefMock = {
provide: DynamicDialogRef,
useValue: {
close: jest.fn(),
},
};
2 changes: 2 additions & 0 deletions src/testing/osf.testing.module.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import { BrowserModule } from '@angular/platform-browser';
import { NoopAnimationsModule, provideNoopAnimations } from '@angular/platform-browser/animations';
import { provideRouter } from '@angular/router';

import { DynamicDialogRefMock } from './mocks/dynamic-dialog-ref.mock';
import { EnvironmentTokenMock } from './mocks/environment.token.mock';
import { StoreMock } from './mocks/store.mock';
import { ToastServiceMock } from './mocks/toast.service.mock';
Expand All @@ -31,6 +32,7 @@ import { TranslationServiceMock } from './mocks/translation.service.mock';
provideHttpClient(withInterceptorsFromDi()),
provideHttpClientTesting(),
TranslationServiceMock,
DynamicDialogRefMock,
EnvironmentTokenMock,
ToastServiceMock,
],
Expand Down
Loading