docs: add comments around how to set up env.config.js and testing with Jest

This commit is contained in:
Jason Wesson
2023-11-30 22:49:18 +00:00
parent d22dc31208
commit ec4e9e8c60
2 changed files with 32 additions and 0 deletions

View File

@@ -67,6 +67,23 @@ jest.mock('@edx/frontend-platform/i18n', () => {
};
});
/*
When .env.test is removed, uncomment the env vars below and add any environment variables for testing with Jest
Context: Snapshot is not currently not set up to be able to parse the environment variables in env.config.js
*/
// jest.mock('@edx/frontend-platform', () => ({
// getConfig: jest.fn(() => ({
// LMS_BASE_URL: 'http://localhost:18000',
// LOGOUT_URL: 'http://localhost:18000/logout',
// LOGO_URL: 'https://edx-cdn.org/v3/default/logo.svg',
// MARKETING_SITE_BASE_URL: 'http://localhost:18000',
// SUPPORT_URL: 'http://localhost:18000/support',
// OPTIMIZELY_FULL_STACK_SDK_KEY: 'SDK Key',
// })),
// }));
jest.mock('@edx/paragon', () => jest.requireActual('testUtils').mockNestedComponents({
Alert: {
Heading: 'Alert.Heading',