Skip to content

Commit

Permalink
chore: add test cases
Browse files Browse the repository at this point in the history
  • Loading branch information
@rjvelazco
rjvelazco committed Dec 13, 2024
1 parent 2a4cf4f commit 57deed3
Show file tree
Hide file tree
Showing 8 changed files with 88 additions and 78 deletions.
3 changes: 1 addition & 2 deletions ...tlet/src/lib/edit-ema-editor/components/dot-uve-toolbar/dot-uve-toolbar.component.spec.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -94,8 +94,7 @@ const baseUVEState = {
{ id: 1, translated: true },
{ id: 2, translated: false },
{ id: 3, translated: true }
]),
workflowActions: signal([])
])
};

describe('DotUveToolbarComponent', () => {
Expand Down
1 change: 0 additions & 1 deletion ...a/portlet/src/lib/edit-ema-editor/components/dot-uve-toolbar/dot-uve-toolbar.component.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,6 @@ import { EditEmaPersonaSelectorComponent } from '../edit-ema-persona-selector/ed
changeDetection: ChangeDetectionStrategy.OnPush
})
export class DotUveToolbarComponent {
// `viewChild` signal is not supported by ng-mocks. Ticket: https://github.com/help-me-mom/ng-mocks/issues/8634
$personaSelector = viewChild<EditEmaPersonaSelectorComponent>('personaSelector');
$languageSelector = viewChild<EditEmaLanguageSelectorComponent>('languageSelector');

Expand Down
152 changes: 83 additions & 69 deletions ...ema-editor/components/dot-uve-workflow-actions/dot-uve-workflow-actions.component.spec.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import { Spectator, createComponentFactory, mockProvider } from '@ngneat/spectat
import { Subject, of } from 'rxjs';

import { HttpClientTestingModule } from '@angular/common/http/testing';
import { signal } from '@angular/core';

import { MessageService } from 'primeng/api';

Expand All @@ -19,7 +20,6 @@ import {
DotWizardService,
DotWorkflowActionsFireService,
DotWorkflowEventHandlerService,
DotWorkflowsActionsService,
PushPublishService
} from '@dotcms/data-access';
import { CoreWebService, LoginService } from '@dotcms/dotcms-js';
Expand All @@ -34,6 +34,9 @@ import {

import { DotUveWorkflowActionsComponent } from './dot-uve-workflow-actions.component';

import { MOCK_RESPONSE_VTL } from '../../../shared/mocks';
import { UVEStore } from '../../../store/dot-uve.store';

const DOT_WORKFLOW_PAYLOAD_MOCK: DotWorkflowPayload = {
assign: '654b0931-1027-41f7-ad4d-173115ed8ec1',
comments: 'ds',
Expand Down Expand Up @@ -68,6 +71,8 @@ const workflowActionMock = {
]
};

const expectedInode = MOCK_RESPONSE_VTL.page.inode;

const messageServiceMock = new MockDotMessageService({
'Workflow-Action': 'Workflow Action',
'edit.content.fire.action.success': 'Success',
Expand All @@ -76,23 +81,49 @@ const messageServiceMock = new MockDotMessageService({
Loading: 'loading'
});

// const baseUVEState = {
// $uveToolbar: signal(baseUVEToolbarState),
// setDevice: jest.fn(),
// setSocialMedia: jest.fn(),
// pageParams: signal(params),
// pageAPIResponse: signal(MOCK_RESPONSE_VTL),
// workflowActions: signal([])
// };

const pageParams = {
url: 'test-url',
language_id: '1'
};

const uveStoreMock = {
pageAPIResponse: signal(MOCK_RESPONSE_VTL),
workflowActions: signal([]),
workflowLoading: signal(false),
canEditPage: signal(true),
pageParams: signal(pageParams),
loadPageAsset: jest.fn(),
reloadCurrentPage: jest.fn(),
setWorkflowActionLoading: jest.fn()
};

describe('DotUveWorkflowActionsComponent', () => {
let spectator: Spectator<DotUveWorkflowActionsComponent>;
let dotWizardService: DotWizardService;
let dotWorkflowsActionsService: DotWorkflowsActionsService;
let dotWorkflowEventHandlerService: DotWorkflowEventHandlerService;
let dotWorkflowActionsFireService: DotWorkflowActionsFireService;
let messageService: MessageService;

let store: InstanceType<typeof UVEStore>;

const createComponent = createComponentFactory({
component: DotUveWorkflowActionsComponent,
imports: [HttpClientTestingModule],
componentProviders: [
DotWizardService,
DotWorkflowsActionsService,
DotWorkflowEventHandlerService,
DotWorkflowActionsFireService,
MessageService,
mockProvider(UVEStore, uveStoreMock),
mockProvider(DotAlertConfirmService),
mockProvider(DotMessageDisplayService),
mockProvider(DotHttpErrorManagerService),
Expand All @@ -116,53 +147,56 @@ describe('DotUveWorkflowActionsComponent', () => {
detectChanges: false
});

store = spectator.inject(UVEStore, true);
dotWizardService = spectator.inject(DotWizardService, true);
dotWorkflowsActionsService = spectator.inject(DotWorkflowsActionsService, true);
dotWorkflowEventHandlerService = spectator.inject(DotWorkflowEventHandlerService, true);
dotWorkflowActionsFireService = spectator.inject(DotWorkflowActionsFireService, true);
messageService = spectator.inject(MessageService, true);
});

describe('Without Workflow Actions', () => {
beforeEach(() => {
spectator.setInput('inode', '123');
it('should set action as an empty array and loading to true', () => {
uveStoreMock.workflowLoading.set(true);
spectator.detectChanges();
});

it('should set action as an empty array and loading to true', () => {
const dotWorkflowActionsComponent = spectator.query(DotWorkflowActionsComponent);
expect(dotWorkflowActionsComponent.actions()).toEqual([]);
expect(dotWorkflowActionsComponent.loading()).toBeTruthy();
expect(dotWorkflowActionsComponent.size()).toBe('small');
});

it("should be disabled if user can't edit", () => {
uveStoreMock.canEditPage.set(false);
spectator.detectChanges();

const dotWorkflowActionsComponent = spectator.query(DotWorkflowActionsComponent);
expect(dotWorkflowActionsComponent.disabled()).toBeTruthy();
});
});

describe('With Workflow Actions', () => {
beforeEach(() => {
jest.spyOn(dotWorkflowsActionsService, 'getByInode').mockReturnValue(
of(mockWorkflowsActions)
);

spectator.setInput('inode', '123');
uveStoreMock.workflowLoading.set(false);
uveStoreMock.canEditPage.set(true);
uveStoreMock.workflowActions.set(mockWorkflowsActions);
spectator.detectChanges();
});

it('should load workflow actions', () => {
const dotWorkflowActionsComponent = spectator.query(DotWorkflowActionsComponent);

expect(dotWorkflowsActionsService.getByInode).toHaveBeenCalledWith('123');
expect(dotWorkflowActionsComponent.actions()).toEqual(mockWorkflowsActions);
expect(dotWorkflowActionsComponent.loading()).toBeFalsy();
expect(dotWorkflowActionsComponent.disabled()).toBeFalsy();
});

it('should fire workflow actions when it does not have inputs', () => {
jest.spyOn(dotWorkflowEventHandlerService, 'containsPushPublish').mockReturnValue(
false
);
it('should fire workflow actions and loadPageAssets', () => {
const spySetWorkflowActionLoading = jest.spyOn(store, 'setWorkflowActionLoading');
const spyLoadPageAsset = jest.spyOn(store, 'loadPageAsset');
const dotWorkflowActionsComponent = spectator.query(DotWorkflowActionsComponent);
const spy = jest
.spyOn(dotWorkflowActionsFireService, 'fireTo')
.mockReturnValue(of(dotcmsContentletMock));
// const spyNewPage = jest.spyOn(spectator.component.newPage, 'emit');
const spyMessage = jest.spyOn(messageService, 'add');

dotWorkflowActionsComponent.actionFired.emit({
Expand All @@ -171,16 +205,16 @@ describe('DotUveWorkflowActionsComponent', () => {
});

expect(spy).toHaveBeenCalledWith({
inode: '123',
inode: expectedInode,
actionId: mockWorkflowsActions[0].id,
data: undefined
});

// expect(spyNewPage).toHaveBeenCalledWith(dotcmsContentletMock);
expect(dotWorkflowsActionsService.getByInode).toHaveBeenCalledWith(
dotcmsContentletMock.inode
);

expect(spySetWorkflowActionLoading).toHaveBeenCalledWith(true);
expect(spyLoadPageAsset).toHaveBeenCalledWith({
language_id: dotcmsContentletMock.languageId.toString(),
url: dotcmsContentletMock.url
});
expect(spyMessage).toHaveBeenCalledTimes(2);

// Check the first message
Expand All @@ -199,6 +233,29 @@ describe('DotUveWorkflowActionsComponent', () => {
});
});

it('should fire workflow actions and reloadPage', () => {
const spySetWorkflowActionLoading = jest.spyOn(store, 'setWorkflowActionLoading');
const spyReloadCurrentPage = jest.spyOn(store, 'reloadCurrentPage');
const dotWorkflowActionsComponent = spectator.query(DotWorkflowActionsComponent);
const spy = jest
.spyOn(dotWorkflowActionsFireService, 'fireTo')
.mockReturnValue(of({ ...dotcmsContentletMock, ...pageParams }));

dotWorkflowActionsComponent.actionFired.emit({
...mockWorkflowsActions[0],
actionInputs: []
});

expect(spy).toHaveBeenCalledWith({
inode: expectedInode,
actionId: mockWorkflowsActions[0].id,
data: undefined
});

expect(spySetWorkflowActionLoading).toHaveBeenCalledWith(true);
expect(spyReloadCurrentPage).toHaveBeenCalledWith();
});

it('should open Wizard if it has inputs ', () => {
const output$ = new Subject<DotWorkflowPayload>();

Expand All @@ -207,9 +264,6 @@ describe('DotUveWorkflowActionsComponent', () => {
title: 'title'
};

jest.spyOn(dotWorkflowEventHandlerService, 'containsPushPublish').mockReturnValue(
false
);
jest.spyOn(dotWorkflowEventHandlerService, 'setWizardInput').mockReturnValue(
wizardInputMock
);
Expand All @@ -236,7 +290,7 @@ describe('DotUveWorkflowActionsComponent', () => {
workflowActionMock.actionInputs
);
expect(spyFireTo).toHaveBeenCalledWith({
inode: '123',
inode: expectedInode,
actionId: workflowActionMock.id,
data: DOT_PROCESSED_WORKFLOW_PAYLOAD_MOCK
});
Expand Down Expand Up @@ -272,44 +326,4 @@ describe('DotUveWorkflowActionsComponent', () => {
expect(spyWizard).not.toHaveBeenCalled();
});
});

// describe('dot-uve-workflow-actions', () => {
// it('should have attr', () => {
// const workflowActions = spectator.query(DotUveWorkflowActionsComponent);

// expect(workflowActions.inode).toBe('123-i');
// });

// it('should update page', () => {
// const spyloadPageAsset = jest.spyOn(store, 'loadPageAsset');
// spectator.triggerEventHandler(DotUveWorkflowActionsComponent, 'newPage', {
// pageURI: '/path-and-stuff',
// url: 'path',
// languageId: 1
// // eslint-disable-next-line @typescript-eslint/no-explicit-any
// } as any);

// spectator.detectChanges();

// expect(spyloadPageAsset).toHaveBeenCalledWith({
// url: '/path-and-stuff',
// language_id: '1'
// });
// });

// // it('should trigger a store reload if the URL from urlContentMap is the same as the current URL', () => {
// // jest.spyOn(store, 'pageAPIResponse').mockReturnValue(PAGE_RESPONSE_URL_CONTENT_MAP);

// // spectator.triggerEventHandler(DotUveWorkflowActionsComponent, 'newPage', {
// // pageURI: '/test-url',
// // url: '/test-url',
// // languageId: 1
// // // eslint-disable-next-line @typescript-eslint/no-explicit-any
// // } as any);

// // spectator.detectChanges();
// // expect(store.reloadCurrentPage).toHaveBeenCalled();
// // expect(router.navigate).not.toHaveBeenCalled();
// // });
// });
});
2 changes: 1 addition & 1 deletion ...edit-ema-editor/components/dot-uve-workflow-actions/dot-uve-workflow-actions.component.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ export class DotUveWorkflowActionsComponent {
workflow: DotCMSWorkflowAction,
data?: T
): void {
this.#uveStore.setWorflowActionLoading(true);
this.#uveStore.setWorkflowActionLoading(true);
this.messageService.add({
...this.successMessage,
detail: this.dotMessageService.get('edit.ema.page.executing.workflow.action'),
Expand Down
2 changes: 0 additions & 2 deletions ...portlet/src/lib/edit-ema-editor/components/edit-ema-toolbar/edit-ema-toolbar.component.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -77,8 +77,6 @@ export class EditEmaToolbarComponent {
readonly uveStore = inject(UVEStore);

protected readonly $toolbarProps = this.uveStore.$toolbarProps;
protected readonly $actions = this.uveStore.workflowActions;
protected readonly $workflowLoding = this.uveStore.workflowLoading;

/**
* Update the current device
Expand Down
2 changes: 1 addition & 1 deletion core-web/libs/portlets/edit-ema/portlet/src/lib/store/features/workflow/withWorkflow.spec.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ describe('withLoad', () => {
});

it('should set workflowLoading to true', () => {
store.setWorflowActionLoading(true);
store.setWorkflowActionLoading(true);
expect(store.workflowLoading()).toBe(true);
});
});
Expand Down
2 changes: 1 addition & 1 deletion core-web/libs/portlets/edit-ema/portlet/src/lib/store/features/workflow/withWorkflow.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ export function withWorkflow() {
})
)
),
setWorflowActionLoading: (loading: boolean) => {
setWorkflowActionLoading: (loading: boolean) => {
patchState(store, {
workflowLoading: loading
});
Expand Down
2 changes: 1 addition & 1 deletion dotCMS/src/main/webapp/html/portlet/ext/contentlet/edit_contentlet_js_inc.jsp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -943,7 +943,7 @@
}
function stealLock(contentletInode){
function stealLock(contentletInode){
ContentletAjax.unlockContent(contentletInode, stealLockContentCallback);
}
Expand Down

0 comments on commit 57deed3

Please sign in to comment.