test: Deprecate react-unit-test-utils 1/15 (#640)

Author: diana-villalvazo-wgu

package-lock.json

@@ -73,6 +73,7 @@
     "@openedx/frontend-build": "^14.3.3",
     "@testing-library/jest-dom": "^6.6.3",
     "@testing-library/react": "^16.2.0",
+    "@testing-library/user-event": "^14.6.1",
     "copy-webpack-plugin": "^12.0.0",
     "identity-obj-proxy": "^3.0.0",
     "jest": "^29.7.0",

package.json

@@ -1,27 +1,30 @@
-import { shallow } from '@edx/react-unit-test-utils';
+import { render, screen } from '@testing-library/react';
+import Banner from './Banner';
 
-import { Alert } from '@openedx/paragon';
+jest.unmock('@openedx/paragon');
+jest.unmock('react');
 
-import Banner from './Banner';
+describe('Banner component', () => {
+  it('renders children content', () => {
+    render(<Banner>Test content</Banner>);
+    expect(screen.getByText('Test content')).toBeInTheDocument();
+  });
 
-describe('Banner', () => {
-  const props = {
-    children: 'Hello, world!',
-  };
-  describe('snapshot', () => {
-    test('renders default banner', () => {
-      const wrapper = shallow(<Banner {...props} />);
-      expect(wrapper.snapshot).toMatchSnapshot();
-    });
-    test('renders with variants', () => {
-      const wrapper = shallow(<Banner {...props} variant="success" />);
-      expect(wrapper.snapshot).toMatchSnapshot();
+  it('uses default props correctly', () => {
+    render(<Banner>Test content</Banner>);
+    const banner = screen.getByRole('alert');
+    expect(banner).toHaveClass('mb-0');
+  });
+
+  it('accepts custom variant prop', () => {
+    render(<Banner variant="success">Test content</Banner>);
+    const banner = screen.getByRole('alert');
+    expect(banner).toHaveClass('alert-success');
+  });
 
-      expect(wrapper.instance.findByType(Alert)[0].props.variant).toEqual('success');
-    });
-    test('renders with custom class', () => {
-      const wrapper = shallow(<Banner {...props} className="custom-class" />);
-      expect(wrapper.snapshot).toMatchSnapshot();
-    });
+  it('accepts custom className prop', () => {
+    render(<Banner className="custom-class">Test content</Banner>);
+    const banner = screen.getByRole('alert');
+    expect(banner).toHaveClass('custom-class');
   });
 });

src/components/Banner.test.jsx

@@ -1,36 +1,36 @@
-import React from 'react';
-import { shallow } from '@edx/react-unit-test-utils';
+import { render, screen } from '@testing-library/react';
 
 import useNoticesWrapperData from './hooks';
 import NoticesWrapper from '.';
 
 jest.mock('./hooks', () => jest.fn());
 
 const hookProps = { isRedirected: false };
-useNoticesWrapperData.mockReturnValue(hookProps);
 
-let el;
 const children = [<b key={1}>some</b>, <i key={2}>children</i>];
 describe('NoticesWrapper component', () => {
+  beforeEach(() => {
+    useNoticesWrapperData.mockClear();
+  });
   describe('behavior', () => {
     it('initializes hooks', () => {
-      el = shallow(<NoticesWrapper>{children}</NoticesWrapper>);
+      useNoticesWrapperData.mockReturnValue(hookProps);
+      render(<NoticesWrapper>{children}</NoticesWrapper>);
       expect(useNoticesWrapperData).toHaveBeenCalledWith();
     });
   });
   describe('output', () => {
     it('does not show children if redirected', () => {
       useNoticesWrapperData.mockReturnValueOnce({ isRedirected: true });
-      el = shallow(<NoticesWrapper>{children}</NoticesWrapper>);
-      expect(el.instance.children.length).toEqual(0);
+      render(<NoticesWrapper>{children}</NoticesWrapper>);
+      expect(screen.queryByText('some')).not.toBeInTheDocument();
+      expect(screen.queryByText('children')).not.toBeInTheDocument();
     });
     it('shows children if not redirected', () => {
-      el = shallow(<NoticesWrapper>{children}</NoticesWrapper>);
-      expect(el.instance.children.length).toEqual(2);
-      expect(el.instance.children[0].type).toEqual(shallow(children[0]).type);
-      expect(el.instance.props).toEqual(shallow(children[0]).props);
-      expect(el.instance.children[1].type).toEqual(shallow(children[1]).type);
-      expect(el.instance.props).toEqual(shallow(children[1]).props);
+      useNoticesWrapperData.mockReturnValue(hookProps);
+      render(<NoticesWrapper>{children}</NoticesWrapper>);
+      expect(screen.getByText('some')).toBeInTheDocument();
+      expect(screen.getByText('children')).toBeInTheDocument();
     });
   });
 });

src/components/NoticesWrapper/index.test.jsx

@@ -1,25 +1,30 @@
-import { shallow } from '@edx/react-unit-test-utils';
-
+import { render, screen } from '@testing-library/react';
 import ActionButton from '.';
 
 import useIsCollapsed from './hooks';
 
 jest.mock('./hooks', () => jest.fn());
 
+jest.unmock('@openedx/paragon');
+
 describe('ActionButton', () => {
   const props = {
-    arbitary: 'props',
+    className: 'custom-class',
+    children: 'Test',
   };
-  describe('snapshot', () => {
-    test('is collapsed', () => {
-      useIsCollapsed.mockReturnValueOnce(true);
-      const wrapper = shallow(<ActionButton {...props} />);
-      expect(wrapper.snapshot).toMatchSnapshot();
-    });
-    test('is not collapsed', () => {
-      useIsCollapsed.mockReturnValueOnce(false);
-      const wrapper = shallow(<ActionButton {...props} />);
-      expect(wrapper.snapshot).toMatchSnapshot();
-    });
+
+  it('is collapsed', async () => {
+    useIsCollapsed.mockReturnValue(true);
+    render(<ActionButton {...props} />);
+    const button = screen.getByRole('button', { name: 'Test' });
+    expect(button).toHaveClass('btn-sm', 'custom-class');
+  });
+
+  it('is not collapsed', () => {
+    useIsCollapsed.mockReturnValue(false);
+    render(<ActionButton {...props} />);
+    const button = screen.getByRole('button', { name: 'Test' });
+    expect(button).toBeInTheDocument();
+    expect(button).not.toHaveClass('size', 'sm');
   });
 });

src/components/__snapshots__/Banner.test.jsx.snap

@@ -1,10 +1,12 @@
-import { shallow } from '@edx/react-unit-test-utils';
-
+import { render, screen } from '@testing-library/react';
+import userEvent from '@testing-library/user-event';
 import { reduxHooks } from 'hooks';
 import track from 'tracking';
 import useActionDisabledState from '../hooks';
 import BeginCourseButton from './BeginCourseButton';
 
+jest.unmock('@openedx/paragon');
+
 jest.mock('tracking', () => ({
   course: {
     enterCourseClicked: jest.fn().mockName('segment.enterCourseClicked'),
@@ -18,10 +20,11 @@ jest.mock('hooks', () => ({
     useTrackCourseEvent: jest.fn(),
   },
 }));
+
 jest.mock('../hooks', () => jest.fn(() => ({ disableBeginCourse: false })));
-jest.mock('./ActionButton', () => 'ActionButton');
 
-let wrapper;
+jest.mock('./ActionButton/hooks', () => jest.fn(() => false));
+
 const homeUrl = 'home-url';
 reduxHooks.useCardCourseRunData.mockReturnValue({ homeUrl });
 const execEdPath = (cardId) => `exec-ed-tracking-path=${cardId}`;
@@ -37,49 +40,47 @@ describe('BeginCourseButton', () => {
   beforeEach(() => {
     jest.clearAllMocks();
   });
-  describe('behavior', () => {
+  describe('initiliaze hooks', () => {
     it('initializes course run data with cardId', () => {
-      wrapper = shallow(<BeginCourseButton {...props} />);
+      render(<BeginCourseButton {...props} />);
       expect(reduxHooks.useCardCourseRunData).toHaveBeenCalledWith(props.cardId);
     });
     it('loads exec education path param', () => {
-      wrapper = shallow(<BeginCourseButton {...props} />);
+      render(<BeginCourseButton {...props} />);
       expect(reduxHooks.useCardExecEdTrackingParam).toHaveBeenCalledWith(props.cardId);
     });
     it('loads disabled states for begin action from action hooks', () => {
-      wrapper = shallow(<BeginCourseButton {...props} />);
+      render(<BeginCourseButton {...props} />);
       expect(useActionDisabledState).toHaveBeenCalledWith(props.cardId);
     });
   });
-  describe('snapshot', () => {
+  describe('behavior', () => {
     describe('disabled', () => {
-      beforeEach(() => {
-        useActionDisabledState.mockReturnValueOnce({ disableBeginCourse: true });
-        wrapper = shallow(<BeginCourseButton {...props} />);
-      });
-      test('snapshot', () => {
-        expect(wrapper.snapshot).toMatchSnapshot();
-      });
       it('should be disabled', () => {
-        expect(wrapper.instance.props.disabled).toEqual(true);
+        useActionDisabledState.mockReturnValueOnce({ disableBeginCourse: true });
+        render(<BeginCourseButton {...props} />);
+        const button = screen.getByRole('button', { name: 'Begin Course' });
+        expect(button).toHaveClass('disabled');
+        expect(button).toHaveAttribute('aria-disabled', 'true');
       });
     });
     describe('enabled', () => {
-      beforeEach(() => {
-        wrapper = shallow(<BeginCourseButton {...props} />);
-      });
-      test('snapshot', () => {
-        expect(wrapper.snapshot).toMatchSnapshot();
-      });
       it('should be enabled', () => {
-        expect(wrapper.instance.props.disabled).toEqual(false);
+        render(<BeginCourseButton {...props} />);
+        const button = screen.getByRole('button', { name: 'Begin Course' });
+        expect(button).not.toHaveClass('disabled');
+        expect(button).not.toHaveAttribute('aria-disabled', 'true');
       });
-      it('should track enter course clicked event on click, with exec ed param', () => {
-        expect(wrapper.instance.props.onClick).toEqual(reduxHooks.useTrackCourseEvent(
+      it('should track enter course clicked event on click, with exec ed param', async () => {
+        render(<BeginCourseButton {...props} />);
+        const user = userEvent.setup();
+        const button = screen.getByRole('button', { name: 'Begin Course' });
+        user.click(button);
+        expect(reduxHooks.useTrackCourseEvent).toHaveBeenCalledWith(
           track.course.enterCourseClicked,
           props.cardId,
           homeUrl + execEdPath(props.cardId),
-        ));
+        );
       });
     });
   });