squash!: Improve way of mocking validateUserPermissions, remove unneeded changes

Author: rodmgwgu

src/library-authoring/create-container/CreateContainerModal.test.tsx

@@ -80,12 +80,10 @@ describe('CreateContainerModal container linking', () => {
     const createButton = await screen.findByRole('button', { name: /create/i });
     await user.click(createButton);
     await waitFor(() => {
-      const request = axiosMock.history.post.find(req => req.url.match(/\/api\/libraries\/.*\/containers/));
-      expect(request).toBeDefined();
+      expect(axiosMock.history.post).toHaveLength(1);
     });
-    const request = axiosMock.history.post.find(req => req.url.match(/\/api\/libraries\/.*\/containers/));
-    expect(request.url).toMatch(/\/api\/libraries\/.*\/containers/);
-    expect(JSON.parse(request.data)).toEqual({
+    expect(axiosMock.history.post[0].url).toMatch(/\/api\/libraries\/.*\/containers/);
+    expect(JSON.parse(axiosMock.history.post[0].data)).toEqual({
       can_stand_alone: true,
       container_type: 'section',
       display_name: 'Test Section',
@@ -116,11 +114,9 @@ describe('CreateContainerModal container linking', () => {
     const createButton = await screen.findByRole('button', { name: /create/i });
     await user.click(createButton);
     await waitFor(() => {
-      const request = axiosMock.history.post.find(req => req.url.match(/\/api\/libraries\/.*\/containers/));
-      expect(request).toBeDefined();
+      expect(axiosMock.history.post[0].url).toMatch(/\/api\/libraries\/.*\/containers/);
     });
-    const request = axiosMock.history.post.find(req => req.url.match(/\/api\/libraries\/.*\/containers/));
-    expect(JSON.parse(request.data)).toEqual({
+    expect(JSON.parse(axiosMock.history.post[0].data)).toEqual({
       can_stand_alone: false,
       container_type: 'subsection',
       display_name: 'Test Subsection',
@@ -148,4 +144,4 @@ describe('CreateContainerModal container linking', () => {
       expect(mockShowToast).toHaveBeenCalledWith(expect.stringMatching(/error/i));
     });
   });
-});
+});

src/library-authoring/library-info/LibraryInfo.test.tsx

@@ -8,6 +8,8 @@ import {
   waitFor,
   initializeMocks,
 } from '@src/testUtils';
+import { validateUserPermissions } from '@src/authz/data/api';
+import { CONTENT_LIBRARY_PERMISSIONS } from '@src/authz/constants';
 import { mockContentLibrary } from '../data/api.mocks';
 import { getCommitLibraryChangesUrl } from '../data/api';
 import { LibraryProvider } from '../common/context/LibraryContext';
@@ -33,6 +35,7 @@ const render = (libraryId: string = mockLibraryId) => baseRender(<LibraryInfo />
 
 let axiosMock: MockAdapter;
 let mockShowToast: (message: string) => void;
+let validateUserPermissionsMock: jest.SpiedFunction<typeof validateUserPermissions>;
 
 mockContentLibrary.applyMock();
 
@@ -41,6 +44,14 @@ describe('<LibraryInfo />', () => {
     const mocks = initializeMocks();
     axiosMock = mocks.axiosMock;
     mockShowToast = mocks.mockShowToast;
+    validateUserPermissionsMock = mocks.validateUserPermissionsMock;
+
+    validateUserPermissionsMock.mockResolvedValue([
+      {
+        action: CONTENT_LIBRARY_PERMISSIONS.PUBLISH_LIBRARY_CONTENT,
+        allowed: true,
+      },
+    ]);
   });
 
   afterEach(() => {

src/testUtils.tsx

@@ -27,12 +27,12 @@ import * as authzApi from '@src/authz/data/api';
 import { ToastContext, type ToastContextData } from './generic/toast-context';
 import initializeReduxStore, { type DeprecatedReduxState } from './store';
 import { getApiWaffleFlagsUrl } from './data/api';
-import { CONTENT_LIBRARY_PERMISSIONS } from './authz/constants';
 
 /** @deprecated Use React Query and/or regular React Context instead of redux */
 let reduxStore: Store;
 let queryClient: QueryClient;
 let axiosMock: MockAdapter;
+let validateUserPermissionsMock: jest.SpiedFunction<typeof authzApi.validateUserPermissions>;
 
 /** To use this: `const { mockShowToast } = initializeMocks()` and `expect(mockShowToast).toHaveBeenCalled()` */
 let mockToastContext: ToastContextData = {
@@ -195,19 +195,16 @@ export function initializeMocks({ user = defaultUser, initialState = undefined }
   jest.clearAllMocks();
 
   // Mock user permissions to avoid breaking tests that monitor axios calls
-  jest.spyOn(authzApi, 'validateUserPermissions').mockResolvedValue([
-    {
-      action: CONTENT_LIBRARY_PERMISSIONS.PUBLISH_LIBRARY_CONTENT,
-      allowed: true,
-    },
-  ]);
+  // If needed, override the mockResolvedValue in your test
+  validateUserPermissionsMock = jest.spyOn(authzApi, 'validateUserPermissions').mockResolvedValue([]);
 
   return {
     reduxStore,
     axiosMock,
     mockShowToast: mockToastContext.showToast,
     mockToastAction: mockToastContext.toastAction,
     queryClient,
+    validateUserPermissionsMock,
   };
 }