130 lines
5.5 KiB
TypeScript
130 lines
5.5 KiB
TypeScript
/* istanbul ignore file */
|
|
import { createAxiosError } from '../../testUtils';
|
|
import * as api from './api';
|
|
|
|
/**
|
|
* Mock for `getLibraryBlockTypes()`
|
|
*/
|
|
export async function mockLibraryBlockTypes(): Promise<api.LibraryBlockType[]> {
|
|
return [
|
|
{ blockType: 'about', displayName: 'overview' },
|
|
{ blockType: 'annotatable', displayName: 'Annotation' },
|
|
{ blockType: 'chapter', displayName: 'Section' },
|
|
{ blockType: 'conditional', displayName: 'Conditional' },
|
|
{ blockType: 'course', displayName: 'Empty' },
|
|
{ blockType: 'course_info', displayName: 'Text' },
|
|
{ blockType: 'discussion', displayName: 'Discussion' },
|
|
{ blockType: 'done', displayName: 'Completion' },
|
|
{ blockType: 'drag-and-drop-v2', displayName: 'Drag and Drop' },
|
|
{ blockType: 'edx_sga', displayName: 'Staff Graded Assignment' },
|
|
{ blockType: 'google-calendar', displayName: 'Google Calendar' },
|
|
{ blockType: 'google-document', displayName: 'Google Document' },
|
|
{ blockType: 'html', displayName: 'Text' },
|
|
{ blockType: 'library', displayName: 'Library' },
|
|
{ blockType: 'library_content', displayName: 'Randomized Content Block' },
|
|
{ blockType: 'lti', displayName: 'LTI' },
|
|
{ blockType: 'lti_consumer', displayName: 'LTI Consumer' },
|
|
{ blockType: 'openassessment', displayName: 'Open Response Assessment' },
|
|
{ blockType: 'poll', displayName: 'Poll' },
|
|
{ blockType: 'problem', displayName: 'Problem' },
|
|
{ blockType: 'scorm', displayName: 'Scorm module' },
|
|
{ blockType: 'sequential', displayName: 'Subsection' },
|
|
{ blockType: 'split_test', displayName: 'Content Experiment' },
|
|
{ blockType: 'staffgradedxblock', displayName: 'Staff Graded Points' },
|
|
{ blockType: 'static_tab', displayName: 'Empty' },
|
|
{ blockType: 'survey', displayName: 'Survey' },
|
|
{ blockType: 'thumbs', displayName: 'Thumbs' },
|
|
{ blockType: 'unit', displayName: 'Unit' },
|
|
{ blockType: 'vertical', displayName: 'Unit' },
|
|
{ blockType: 'video', displayName: 'Video' },
|
|
{ blockType: 'videoalpha', displayName: 'Video' },
|
|
{ blockType: 'word_cloud', displayName: 'Word cloud' },
|
|
];
|
|
}
|
|
mockLibraryBlockTypes.applyMock = () => {
|
|
jest.spyOn(api, 'getLibraryBlockTypes').mockImplementation(mockLibraryBlockTypes);
|
|
};
|
|
|
|
/**
|
|
* Mock for `getContentLibrary()`
|
|
*
|
|
* This mock returns different data/responses depending on the ID of the library
|
|
* that you request.
|
|
*/
|
|
export async function mockContentLibrary(libraryId: string): Promise<api.ContentLibrary> {
|
|
// This mock has many different behaviors, depending on the library ID:
|
|
switch (libraryId) {
|
|
case mockContentLibrary.libraryIdThatNeverLoads:
|
|
// Return a promise that never resolves, to simulate never loading:
|
|
return new Promise<any>(() => {});
|
|
case mockContentLibrary.library404:
|
|
throw createAxiosError({ code: 400, message: 'Not found.', path: api.getContentLibraryApiUrl(libraryId) });
|
|
case mockContentLibrary.library500:
|
|
throw createAxiosError({ code: 500, message: 'Internal Error.', path: api.getContentLibraryApiUrl(libraryId) });
|
|
case mockContentLibrary.libraryId:
|
|
return mockContentLibrary.libraryData;
|
|
case mockContentLibrary.libraryIdReadOnly:
|
|
return {
|
|
...mockContentLibrary.libraryData,
|
|
id: mockContentLibrary.libraryIdReadOnly,
|
|
slug: 'readOnly',
|
|
allowPublicRead: true,
|
|
canEditLibrary: false,
|
|
};
|
|
default:
|
|
throw new Error(`mockContentLibrary: unknown library ID "${libraryId}"`);
|
|
}
|
|
}
|
|
mockContentLibrary.libraryId = 'lib:Axim:TEST';
|
|
mockContentLibrary.libraryData = {
|
|
// This is captured from a real API response:
|
|
id: mockContentLibrary.libraryId,
|
|
type: 'complex', // 'type' is a deprecated field; don't use it.
|
|
org: 'Axim',
|
|
slug: 'TEST',
|
|
title: 'Test Library',
|
|
description: 'A library for testing',
|
|
numBlocks: 10,
|
|
version: 18,
|
|
lastPublished: null, // or e.g. '2024-08-30T16:37:42Z',
|
|
publishedBy: null, // or e.g. 'test_author',
|
|
lastDraftCreated: '2024-07-22T21:37:49Z',
|
|
lastDraftCreatedBy: null,
|
|
allowLti: false,
|
|
allowPublicLearning: false,
|
|
allowPublicRead: false,
|
|
hasUnpublishedChanges: true,
|
|
hasUnpublishedDeletes: false,
|
|
license: '',
|
|
canEditLibrary: true,
|
|
created: '2024-06-26T14:19:59Z',
|
|
updated: '2024-07-20T17:36:51Z',
|
|
} satisfies api.ContentLibrary;
|
|
mockContentLibrary.libraryIdReadOnly = 'lib:Axim:readOnly';
|
|
mockContentLibrary.libraryIdThatNeverLoads = 'lib:Axim:infiniteLoading';
|
|
mockContentLibrary.library404 = 'lib:Axim:error404';
|
|
mockContentLibrary.library500 = 'lib:Axim:error500';
|
|
mockContentLibrary.applyMock = () => { jest.spyOn(api, 'getContentLibrary').mockImplementation(mockContentLibrary); };
|
|
|
|
/**
|
|
* Mock for `getXBlockFields()`
|
|
*
|
|
* This mock returns different data/responses depending on the ID of the block
|
|
* that you request. Use `mockXBlockFields.applyMock()` to apply it to the whole
|
|
* test suite.
|
|
*/
|
|
export async function mockXBlockFields(usageKey: string): Promise<api.XBlockFields> {
|
|
const thisMock = mockXBlockFields;
|
|
switch (usageKey) {
|
|
case thisMock.usageKeyHtml: return thisMock.dataHtml;
|
|
default: throw new Error(`No mock has been set up for usageKey "${usageKey}"`);
|
|
}
|
|
}
|
|
mockXBlockFields.usageKeyHtml = 'lb:Axim:TEST:html:571fe018-f3ce-45c9-8f53-5dafcb422fdd';
|
|
mockXBlockFields.dataHtml = {
|
|
displayName: 'Introduction to Testing',
|
|
data: '<p>This is a text component which uses <strong>HTML</strong>.</p>',
|
|
metadata: { displayName: 'Introduction to Testing' },
|
|
} satisfies api.XBlockFields;
|
|
mockXBlockFields.applyMock = () => { jest.spyOn(api, 'getXBlockFields').mockImplementation(mockXBlockFields); };
|