Refactor tests so that snapshots aren't used

Signed-off-by: Paulo Pinto <paulo.pinto@automattic.com>
pull/21833/head
Paulo Pinto 2021-08-11 11:40:33 +01:00
parent 45fd3d83b0
commit 79cf69bedb
2 changed files with 59 additions and 139 deletions

View File

@ -23,64 +23,97 @@ function mockPinnedEvent(
}); });
} }
// Helper function that renders a component to a plain text string.
// Once snapshots are introduced in tests, this function will no longer be necessary,
// and should be replaced with snapshots.
function renderComponent(component): string {
const serializeObject = (object): string => {
if (typeof object === 'string') {
return object === ' ' ? '' : object;
}
if (Array.isArray(object) && object.length === 1 && typeof object[0] === 'string') {
return object[0];
}
if (object['type'] !== undefined && typeof object['children'] !== undefined) {
return serializeObject(object.children);
}
if (!Array.isArray(object)) {
return '';
}
return object.map(child => {
return serializeObject(child);
}).join('');
};
return serializeObject(component.toJSON());
}
describe('TextForEvent', () => { describe('TextForEvent', () => {
describe("TextForPinnedEvent", () => { describe("TextForPinnedEvent", () => {
SettingsStore.setValue("feature_pinning", null, SettingLevel.DEVICE, true); SettingsStore.setValue("feature_pinning", null, SettingLevel.DEVICE, true);
it("mentions message when a single message was pinned, with no previously pinned messages", () => { it("mentions message when a single message was pinned, with no previously pinned messages", () => {
const event = mockPinnedEvent(['message-1']); const event = mockPinnedEvent(['message-1']);
expect(textForEvent(event)).toBe( const plainText = textForEvent(event);
"@foo:example.com pinned a message to this room. See all pinned messages.",
);
const component = renderer.create(textForEvent(event, true)); const component = renderer.create(textForEvent(event, true));
expect(component.toJSON()).toMatchSnapshot();
const expectedText = "@foo:example.com pinned a message to this room. See all pinned messages.";
expect(plainText).toBe(expectedText);
expect(renderComponent(component)).toBe(expectedText);
}); });
it("mentions message when a single message was pinned, with multiple previously pinned messages", () => { it("mentions message when a single message was pinned, with multiple previously pinned messages", () => {
const event = mockPinnedEvent(['message-3'], ['message-1', 'message-2']); const event = mockPinnedEvent(['message-3'], ['message-1', 'message-2']);
expect(textForEvent(event)).toBe( const plainText = textForEvent(event);
"@foo:example.com pinned a message to this room. See all pinned messages.",
);
const component = renderer.create(textForEvent(event, true)); const component = renderer.create(textForEvent(event, true));
expect(component.toJSON()).toMatchSnapshot();
const expectedText = "@foo:example.com pinned a message to this room. See all pinned messages.";
expect(plainText).toBe(expectedText);
expect(renderComponent(component)).toBe(expectedText);
}); });
it("shows generic text when multiple messages were pinned", () => { it("shows generic text when multiple messages were pinned", () => {
const event = mockPinnedEvent(['message-1', 'message-2', 'message-3'], ['message-1']); const event = mockPinnedEvent(['message-1', 'message-2', 'message-3'], ['message-1']);
expect(textForEvent(event)).toBe("@foo:example.com changed the pinned messages for the room."); const plainText = textForEvent(event);
const component = renderer.create(textForEvent(event, true)); const component = renderer.create(textForEvent(event, true));
expect(component.toJSON()).toMatchSnapshot();
const expectedText = "@foo:example.com changed the pinned messages for the room.";
expect(plainText).toBe(expectedText);
expect(renderComponent(component)).toBe(expectedText);
}); });
it("mentions message when a single message was unpinned, with a single message previously pinned", () => { it("mentions message when a single message was unpinned, with a single message previously pinned", () => {
const event = mockPinnedEvent([], ['message-1']); const event = mockPinnedEvent([], ['message-1']);
expect(textForEvent(event)).toBe( const plainText = textForEvent(event);
"@foo:example.com unpinned a message from this room. See all pinned messages.",
);
const component = renderer.create(textForEvent(event, true)); const component = renderer.create(textForEvent(event, true));
expect(component.toJSON()).toMatchSnapshot();
const expectedText = "@foo:example.com unpinned a message from this room. See all pinned messages.";
expect(plainText).toBe(expectedText);
expect(renderComponent(component)).toBe(expectedText);
}); });
it("mentions message when a single message was unpinned, with multiple previously pinned messages", () => { it("mentions message when a single message was unpinned, with multiple previously pinned messages", () => {
const event = mockPinnedEvent(['message-2'], ['message-1', 'message-2']); const event = mockPinnedEvent(['message-2'], ['message-1', 'message-2']);
expect(textForEvent(event)).toBe( const plainText = textForEvent(event);
"@foo:example.com unpinned a message from this room. See all pinned messages.",
);
const component = renderer.create(textForEvent(event, true)); const component = renderer.create(textForEvent(event, true));
expect(component.toJSON()).toMatchSnapshot();
const expectedText = "@foo:example.com unpinned a message from this room. See all pinned messages.";
expect(plainText).toBe(expectedText);
expect(renderComponent(component)).toBe(expectedText);
}); });
it("shows generic text when multiple messages were unpinned", () => { it("shows generic text when multiple messages were unpinned", () => {
const event = mockPinnedEvent(['message-3'], ['message-1', 'message-2', 'message-3']); const event = mockPinnedEvent(['message-3'], ['message-1', 'message-2', 'message-3']);
expect(textForEvent(event)).toBe("@foo:example.com changed the pinned messages for the room."); const plainText = textForEvent(event);
const component = renderer.create(textForEvent(event, true)); const component = renderer.create(textForEvent(event, true));
expect(component.toJSON()).toMatchSnapshot();
const expectedText = "@foo:example.com changed the pinned messages for the room.";
expect(plainText).toBe(expectedText);
expect(renderComponent(component)).toBe(expectedText);
}); });
}); });
}); });

View File

@ -1,113 +0,0 @@
// Jest Snapshot v1, https://goo.gl/fbAQLP
exports[`TextForEvent TextForPinnedEvent mentions message when a single message was pinned, with multiple previously pinned messages 1`] = `
<span>
<span>
@foo:example.com pinned
<a
onClick={[Function]}
>
a message
</a>
to this room. See all
<a
onClick={[Function]}
>
pinned messages
</a>
.
</span>
</span>
`;
exports[`TextForEvent TextForPinnedEvent mentions message when a single message was pinned, with no previously pinned messages 1`] = `
<span>
<span>
@foo:example.com pinned
<a
onClick={[Function]}
>
a message
</a>
to this room. See all
<a
onClick={[Function]}
>
pinned messages
</a>
.
</span>
</span>
`;
exports[`TextForEvent TextForPinnedEvent mentions message when a single message was unpinned, with a single message previously pinned 1`] = `
<span>
<span>
@foo:example.com unpinned
<a
onClick={[Function]}
>
a message
</a>
from this room. See all
<a
onClick={[Function]}
>
pinned messages
</a>
.
</span>
</span>
`;
exports[`TextForEvent TextForPinnedEvent mentions message when a single message was unpinned, with multiple previously pinned messages 1`] = `
<span>
<span>
@foo:example.com unpinned
<a
onClick={[Function]}
>
a message
</a>
from this room. See all
<a
onClick={[Function]}
>
pinned messages
</a>
.
</span>
</span>
`;
exports[`TextForEvent TextForPinnedEvent shows generic text when multiple messages were pinned 1`] = `
<span>
<span>
@foo:example.com changed the
<a
onClick={[Function]}
>
pinned messages
</a>
for the room.
</span>
</span>
`;
exports[`TextForEvent TextForPinnedEvent shows generic text when multiple messages were unpinned 1`] = `
<span>
<span>
@foo:example.com changed the
<a
onClick={[Function]}
>
pinned messages
</a>
for the room.
</span>
</span>
`;