Fix broken StudioHome tests (#2291)

There were a ton of problems with these tests, but the main one was the use of `waitFor` without `await`, causing all of the code inside each `waitFor` block to essentially be ignored.

Other problems fixed:
* Rendering a router inside a router was causing most of the render() calls to fail (our custom `render()` already provides a router so there's no need to provide one in the test case)
* Use of `testid` instead of queries based on what users see
* Tests could match on content in the body when trying to make assertions about the header
* Mock imported via `index.js` was causing `jest-haste-map` to print warnings about duplicate mock names (this is still happening for other mocks)
* Passing `courses: null` instead of `courses: []` was causing a broken render on two of the tests.

I also made other cleanups to follow best practices.

Author: bradenmacdonald

src/course-rerun/CourseRerun.test.jsx

@@ -5,8 +5,8 @@ import {
   fireEvent,
   render,
   waitFor,
-} from '../testUtils';
-import { studioHomeMock } from '../studio-home/__mocks__';
+} from '@src/testUtils';
+import studioHomeMock from '@src/studio-home/__mocks__/studioHomeMock';
 import { getStudioHomeApiUrl } from '../studio-home/data/api';
 import { RequestStatus } from '../data/constants';
 import messages from './messages';

src/course-rerun/course-rerun-form/CourseRerunForm.test.jsx

@@ -5,7 +5,7 @@ import { initializeMockApp } from '@edx/frontend-platform';
 import { IntlProvider } from '@edx/frontend-platform/i18n';
 import { AppProvider } from '@edx/frontend-platform/react';
 
-import { studioHomeMock } from '../../studio-home/__mocks__';
+import studioHomeMock from '@src/studio-home/__mocks__/studioHomeMock';
 import initializeStore from '../../store';
 import CourseRerunForm from '.';
 

src/generic/create-or-rerun-course/CreateOrRerunCourseForm.test.jsx

@@ -14,7 +14,7 @@ import { getAuthenticatedHttpClient } from '@edx/frontend-platform/auth';
 import { AppProvider } from '@edx/frontend-platform/react';
 import MockAdapter from 'axios-mock-adapter';
 
-import { studioHomeMock } from '../../studio-home/__mocks__';
+import studioHomeMock from '@src/studio-home/__mocks__/studioHomeMock';
 import { getStudioHomeApiUrl } from '../../studio-home/data/api';
 import { fetchStudioHomeData } from '../../studio-home/data/thunks';
 import { RequestStatus } from '../../data/constants';

src/generic/create-or-rerun-course/factories/mockApiResponses.jsx

@@ -1,5 +1,5 @@
-import { RequestStatus } from '../../../data/constants';
-import { studioHomeMock } from '../../../studio-home/__mocks__';
+import { RequestStatus } from '@src/data/constants';
+import studioHomeMock from '@src/studio-home/__mocks__/studioHomeMock';
 
 export const courseId = 'course-v1:edX+DemoX+Demo_Course';
 

src/library-authoring/LibraryAuthoringPage.test.tsx

@@ -8,7 +8,8 @@ import {
   screen,
   waitFor,
   within,
-} from '../testUtils';
+} from '@src/testUtils';
+import studioHomeMock from '@src/studio-home/__mocks__/studioHomeMock';
 import mockResult from './__mocks__/library-search.json';
 import mockEmptyResult from '../search-modal/__mocks__/empty-search-result.json';
 import {
@@ -19,7 +20,6 @@ import {
   mockXBlockFields,
 } from './data/api.mocks';
 import { mockContentSearchConfig } from '../search-manager/data/api.mock';
-import { studioHomeMock } from '../studio-home/__mocks__';
 import { getStudioHomeApiUrl } from '../studio-home/data/api';
 import { LibraryLayout } from '.';
 import { getLibraryCollectionsApiUrl, getLibraryContainersApiUrl } from './data/api';

src/library-authoring/add-content/AddContentWorkflow.test.tsx

@@ -8,7 +8,8 @@ import {
   waitFor,
   screen,
   initializeMocks,
-} from '../../testUtils';
+} from '@src/testUtils';
+import studioHomeMock from '@src/studio-home/__mocks__/studioHomeMock';
 import mockResult from '../__mocks__/library-search.json';
 import editorCmsApi from '../../editors/data/services/cms/api';
 import * as textEditorHooks from '../../editors/containers/TextEditor/hooks';
@@ -19,7 +20,6 @@ import {
 } from '../data/api.mocks';
 import { mockClipboardEmpty } from '../../generic/data/api.mock';
 import { mockContentSearchConfig, mockSearchResult } from '../../search-manager/data/api.mock';
-import { studioHomeMock } from '../../studio-home/__mocks__';
 import { getStudioHomeApiUrl } from '../../studio-home/data/api';
 import LibraryLayout from '../LibraryLayout';
 

src/library-authoring/add-content/PickLibraryContentModal.test.tsx

@@ -1,12 +1,12 @@
-import { mockContentSearchConfig, mockSearchResult } from '../../search-manager/data/api.mock';
+import { mockContentSearchConfig, mockSearchResult } from '@src/search-manager/data/api.mock';
 import {
   fireEvent,
   render as baseRender,
   waitFor,
   screen,
   initializeMocks,
-} from '../../testUtils';
-import { studioHomeMock } from '../../studio-home/__mocks__';
+} from '@src/testUtils';
+import studioHomeMock from '@src/studio-home/__mocks__/studioHomeMock';
 import { getStudioHomeApiUrl } from '../../studio-home/data/api';
 import mockResult from '../__mocks__/library-search.json';
 import { LibraryProvider } from '../common/context/LibraryContext';

src/library-authoring/create-library/CreateLibrary.test.tsx

@@ -8,10 +8,10 @@ import {
   render,
   screen,
   waitFor,
-} from '../../testUtils';
-import { studioHomeMock } from '../../studio-home/__mocks__';
-import { getStudioHomeApiUrl } from '../../studio-home/data/api';
-import { getApiWaffleFlagsUrl } from '../../data/api';
+} from '@src/testUtils';
+import studioHomeMock from '@src/studio-home/__mocks__/studioHomeMock';
+import { getStudioHomeApiUrl } from '@src/studio-home/data/api';
+import { getApiWaffleFlagsUrl } from '@src/data/api';
 import { CreateLibrary } from '.';
 import { getContentLibraryV2CreateApiUrl } from './data/api';
 

src/library-authoring/routes.test.tsx

@@ -1,13 +1,13 @@
 import { useEffect } from 'react';
 import fetchMock from 'fetch-mock-jest';
+import { initializeMocks, render } from '@src/testUtils';
+import studioHomeMock from '@src/studio-home/__mocks__/studioHomeMock';
 import {
   mockContentLibrary,
 } from './data/api.mocks';
 import { LibraryLayout } from '.';
 import { ContentType, useLibraryRoutes } from './routes';
 import mockResult from './__mocks__/library-search.json';
-import { initializeMocks, render } from '../testUtils';
-import { studioHomeMock } from '../studio-home/__mocks__';
 import { getStudioHomeApiUrl } from '../studio-home/data/api';
 
 const mockNavigate = jest.fn();