From 2501dad0a3dd85e4b36467383d77307740d305f6 Mon Sep 17 00:00:00 2001
From: Michael Weimann <michaelw@matrix.org>
Date: Thu, 9 Feb 2023 12:23:34 +0100
Subject: [PATCH] Migrate LabelledCheckbox-test to react-testing-library
 (#10115)

---
 .../views/elements/LabelledCheckbox-test.tsx  |  66 ++++-------
 .../LabelledCheckbox-test.tsx.snap            | 112 +++++++-----------
 2 files changed, 67 insertions(+), 111 deletions(-)

diff --git a/test/components/views/elements/LabelledCheckbox-test.tsx b/test/components/views/elements/LabelledCheckbox-test.tsx
index eed94ab598..857fcdf1fe 100644
--- a/test/components/views/elements/LabelledCheckbox-test.tsx
+++ b/test/components/views/elements/LabelledCheckbox-test.tsx
@@ -14,10 +14,8 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
+import { fireEvent, render, screen } from "@testing-library/react";
 import React from "react";
-// eslint-disable-next-line deprecate/import
-import { mount } from "enzyme";
-import { act } from "react-dom/test-utils";
 
 import LabelledCheckbox from "../../../../src/components/views/elements/LabelledCheckbox";
 
@@ -30,32 +28,18 @@ jest.mock("matrix-js-sdk/src/randomstring", () => {
 
 describe("<LabelledCheckbox />", () => {
     type CompProps = React.ComponentProps<typeof LabelledCheckbox>;
-    const getComponent = (props: CompProps) => mount(<LabelledCheckbox {...props} />);
-    type CompClass = ReturnType<typeof getComponent>;
+    const getComponent = (props: CompProps) => <LabelledCheckbox {...props} />;
+    const getCheckbox = (): HTMLInputElement => screen.getByRole("checkbox");
 
-    const getCheckbox = (component: CompClass) => component.find(`input[type="checkbox"]`);
-    const getLabel = (component: CompClass) => component.find(`.mx_LabelledCheckbox_label`);
-    const getByline = (component: CompClass) => component.find(`.mx_LabelledCheckbox_byline`);
-
-    const isChecked = (checkbox: ReturnType<typeof getCheckbox>) => checkbox.is(`[checked=true]`);
-    const isDisabled = (checkbox: ReturnType<typeof getCheckbox>) => checkbox.is(`[disabled=true]`);
-    const getText = (span: ReturnType<typeof getLabel>) => (span.length > 0 ? span.at(0).text() : null);
-
-    test.each([null, "this is a byline"])("should render with byline of %p", (byline) => {
+    it.each([undefined, "this is a byline"])("should render with byline of %p", (byline) => {
         const props: CompProps = {
             label: "Hello world",
             value: true,
             byline: byline,
             onChange: jest.fn(),
         };
-        const component = getComponent(props);
-        const checkbox = getCheckbox(component);
-
-        expect(component).toMatchSnapshot();
-        expect(isChecked(checkbox)).toBe(true);
-        expect(isDisabled(checkbox)).toBe(false);
-        expect(getText(getLabel(component))).toBe(props.label);
-        expect(getText(getByline(component))).toBe(byline);
+        const renderResult = render(getComponent(props));
+        expect(renderResult.asFragment()).toMatchSnapshot();
     });
 
     it("should support unchecked by default", () => {
@@ -64,9 +48,8 @@ describe("<LabelledCheckbox />", () => {
             value: false,
             onChange: jest.fn(),
         };
-        const component = getComponent(props);
-
-        expect(isChecked(getCheckbox(component))).toBe(false);
+        render(getComponent(props));
+        expect(getCheckbox()).not.toBeChecked();
     });
 
     it("should be possible to disable the checkbox", () => {
@@ -76,9 +59,8 @@ describe("<LabelledCheckbox />", () => {
             disabled: true,
             onChange: jest.fn(),
         };
-        const component = getComponent(props);
-
-        expect(isDisabled(getCheckbox(component))).toBe(true);
+        render(getComponent(props));
+        expect(getCheckbox()).toBeDisabled();
     });
 
     it("should emit onChange calls", () => {
@@ -87,15 +69,11 @@ describe("<LabelledCheckbox />", () => {
             value: false,
             onChange: jest.fn(),
         };
-        const component = getComponent(props);
+        render(getComponent(props));
 
         expect(props.onChange).not.toHaveBeenCalled();
-
-        act(() => {
-            getCheckbox(component).simulate("change");
-        });
-
-        expect(props.onChange).toHaveBeenCalledTimes(1);
+        fireEvent.click(getCheckbox());
+        expect(props.onChange).toHaveBeenCalledWith(true);
     });
 
     it("should react to value and disabled prop changes", () => {
@@ -104,16 +82,18 @@ describe("<LabelledCheckbox />", () => {
             value: false,
             onChange: jest.fn(),
         };
-        const component = getComponent(props);
-        let checkbox = getCheckbox(component);
+        const { rerender } = render(getComponent(props));
 
-        expect(isChecked(checkbox)).toBe(false);
-        expect(isDisabled(checkbox)).toBe(false);
+        let checkbox = getCheckbox();
+        expect(checkbox).not.toBeChecked();
+        expect(checkbox).not.toBeDisabled();
 
-        component.setProps({ value: true, disabled: true });
-        checkbox = getCheckbox(component); // refresh reference to checkbox
+        props.disabled = true;
+        props.value = true;
+        rerender(getComponent(props));
 
-        expect(isChecked(checkbox)).toBe(true);
-        expect(isDisabled(checkbox)).toBe(true);
+        checkbox = getCheckbox();
+        expect(checkbox).toBeChecked();
+        expect(checkbox).toBeDisabled();
     });
 });
diff --git a/test/components/views/elements/__snapshots__/LabelledCheckbox-test.tsx.snap b/test/components/views/elements/__snapshots__/LabelledCheckbox-test.tsx.snap
index 286c69a8d0..0ce152015e 100644
--- a/test/components/views/elements/__snapshots__/LabelledCheckbox-test.tsx.snap
+++ b/test/components/views/elements/__snapshots__/LabelledCheckbox-test.tsx.snap
@@ -1,106 +1,82 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
 exports[`<LabelledCheckbox /> should render with byline of "this is a byline" 1`] = `
-<LabelledCheckbox
-  byline="this is a byline"
-  label="Hello world"
-  onChange={[MockFunction]}
-  value={true}
->
+<DocumentFragment>
   <label
-    className="mx_LabelledCheckbox"
+    class="mx_LabelledCheckbox"
   >
-    <StyledCheckbox
-      checked={true}
-      className=""
-      onChange={[Function]}
+    <span
+      class="mx_Checkbox mx_Checkbox_hasKind mx_Checkbox_kind_solid"
     >
-      <span
-        className="mx_Checkbox mx_Checkbox_hasKind mx_Checkbox_kind_solid"
+      <input
+        checked=""
+        id="checkbox_abdefghi"
+        type="checkbox"
+      />
+      <label
+        for="checkbox_abdefghi"
       >
-        <input
-          checked={true}
-          id="checkbox_abdefghi"
-          onChange={[Function]}
-          type="checkbox"
-        />
-        <label
-          htmlFor="checkbox_abdefghi"
+        <div
+          class="mx_Checkbox_background"
         >
           <div
-            className="mx_Checkbox_background"
-          >
-            <div
-              className="mx_Checkbox_checkmark"
-            />
-          </div>
-        </label>
-      </span>
-    </StyledCheckbox>
+            class="mx_Checkbox_checkmark"
+          />
+        </div>
+      </label>
+    </span>
     <div
-      className="mx_LabelledCheckbox_labels"
+      class="mx_LabelledCheckbox_labels"
     >
       <span
-        className="mx_LabelledCheckbox_label"
+        class="mx_LabelledCheckbox_label"
       >
         Hello world
       </span>
       <span
-        className="mx_LabelledCheckbox_byline"
+        class="mx_LabelledCheckbox_byline"
       >
         this is a byline
       </span>
     </div>
   </label>
-</LabelledCheckbox>
+</DocumentFragment>
 `;
 
-exports[`<LabelledCheckbox /> should render with byline of null 1`] = `
-<LabelledCheckbox
-  byline={null}
-  label="Hello world"
-  onChange={[MockFunction]}
-  value={true}
->
+exports[`<LabelledCheckbox /> should render with byline of undefined 1`] = `
+<DocumentFragment>
   <label
-    className="mx_LabelledCheckbox"
+    class="mx_LabelledCheckbox"
   >
-    <StyledCheckbox
-      checked={true}
-      className=""
-      onChange={[Function]}
+    <span
+      class="mx_Checkbox mx_Checkbox_hasKind mx_Checkbox_kind_solid"
     >
-      <span
-        className="mx_Checkbox mx_Checkbox_hasKind mx_Checkbox_kind_solid"
+      <input
+        checked=""
+        id="checkbox_abdefghi"
+        type="checkbox"
+      />
+      <label
+        for="checkbox_abdefghi"
       >
-        <input
-          checked={true}
-          id="checkbox_abdefghi"
-          onChange={[Function]}
-          type="checkbox"
-        />
-        <label
-          htmlFor="checkbox_abdefghi"
+        <div
+          class="mx_Checkbox_background"
         >
           <div
-            className="mx_Checkbox_background"
-          >
-            <div
-              className="mx_Checkbox_checkmark"
-            />
-          </div>
-        </label>
-      </span>
-    </StyledCheckbox>
+            class="mx_Checkbox_checkmark"
+          />
+        </div>
+      </label>
+    </span>
     <div
-      className="mx_LabelledCheckbox_labels"
+      class="mx_LabelledCheckbox_labels"
     >
       <span
-        className="mx_LabelledCheckbox_label"
+        class="mx_LabelledCheckbox_label"
       >
         Hello world
       </span>
     </div>
   </label>
-</LabelledCheckbox>
+</DocumentFragment>
 `;