Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

test(sbb-divider): add visual spec #2800

Merged
merged 2 commits into from
Jun 21, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,71 @@ snapshots["sbb-divider A11y tree Firefox"] =
`;
/* end snapshot sbb-divider A11y tree Firefox */

snapshots["sbb-divider should render with default values DOM"] =
`<sbb-divider
aria-orientation="horizontal"
orientation="horizontal"
role="separator"
>
</sbb-divider>
`;
/* end snapshot sbb-divider should render with default values DOM */

snapshots["sbb-divider should render with default values Shadow DOM"] =
`<div class="sbb-divider">
</div>
`;
/* end snapshot sbb-divider should render with default values Shadow DOM */

snapshots["sbb-divider should render with default values A11y tree Chrome"] =
`<p>
{
"role": "WebArea",
"name": ""
}
</p>
`;
/* end snapshot sbb-divider should render with default values A11y tree Chrome */

snapshots["sbb-divider should render with orientation horizontal DOM"] =
`<sbb-divider
aria-orientation="horizontal"
orientation="horizontal"
role="separator"
>
</sbb-divider>
`;
/* end snapshot sbb-divider should render with orientation horizontal DOM */

snapshots["sbb-divider should render with orientation horizontal Shadow DOM"] =
`<div class="sbb-divider">
</div>
`;
/* end snapshot sbb-divider should render with orientation horizontal Shadow DOM */

snapshots["sbb-divider should render with orientation vertical DOM"] =
`<sbb-divider
aria-orientation="vertical"
orientation="vertical"
role="separator"
>
</sbb-divider>
`;
/* end snapshot sbb-divider should render with orientation vertical DOM */

snapshots["sbb-divider should render with orientation vertical Shadow DOM"] =
`<div class="sbb-divider">
</div>
`;
/* end snapshot sbb-divider should render with orientation vertical Shadow DOM */

snapshots["sbb-divider should render with default values A11y tree Firefox"] =
`<p>
{
"role": "document",
"name": ""
}
</p>
`;
/* end snapshot sbb-divider should render with default values A11y tree Firefox */

74 changes: 42 additions & 32 deletions src/elements/divider/divider.snapshot.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,48 +2,58 @@ import { expect } from '@open-wc/testing';
import { html } from 'lit/static-html.js';

import { fixture, testA11yTreeSnapshot } from '../core/testing/private.js';
import { waitForLitRender } from '../core/testing.js';

import type { SbbDividerElement } from './divider.js';

import './divider.js';

describe(`sbb-divider`, () => {
it('should render with default values', async () => {
const element: SbbDividerElement = await fixture(html`<sbb-divider></sbb-divider>`);
expect(element).dom.to.be.equal(
`<sbb-divider orientation='horizontal' aria-orientation='horizontal' role='separator'></sbb-divider>`,
);
expect(element).shadowDom.to.be.equal(`<div class='sbb-divider'></div>`);
});
describe('should render with default values', () => {
TomMenga marked this conversation as resolved.
Show resolved Hide resolved
let element: SbbDividerElement;

it('should render with orientation horizontal', async () => {
const element: SbbDividerElement = await fixture(
html`<sbb-divider orientation="horizontal"></sbb-divider>`,
);
expect(element).dom.to.be.equal(
`<sbb-divider orientation='horizontal' aria-orientation='horizontal' role='separator'></sbb-divider>`,
);
expect(element).shadowDom.to.be.equal(`<div class='sbb-divider'></div>`);
});
beforeEach(async () => {
element = await fixture(html`<sbb-divider></sbb-divider>`);
});

it('should render with orientation vertical', async () => {
const element: SbbDividerElement = await fixture(
html`<sbb-divider orientation="vertical"></sbb-divider>`,
);
expect(element).dom.to.be.equal(
`<sbb-divider orientation='vertical' aria-orientation='vertical' role='separator'></sbb-divider>`,
);
expect(element).shadowDom.to.be.equal(`<div class='sbb-divider'></div>`);
it('DOM', async () => {
await expect(element).dom.to.be.equalSnapshot();
});

it('Shadow DOM', async () => {
await expect(element).shadowDom.to.be.equalSnapshot();
});

testA11yTreeSnapshot();
});

it('should react to change of orientation', async () => {
const element: SbbDividerElement = await fixture(html`<sbb-divider></sbb-divider>`);
describe('should render with orientation horizontal', () => {
TomMenga marked this conversation as resolved.
Show resolved Hide resolved
let element: SbbDividerElement;

beforeEach(async () => {
element = await fixture(html`<sbb-divider orientation="horizontal"></sbb-divider>`);
});

element.orientation = 'vertical';
await waitForLitRender(element);
expect(element).to.have.attribute('aria-orientation', 'vertical');
it('DOM', async () => {
await expect(element).dom.to.be.equalSnapshot();
});

it('Shadow DOM', async () => {
await expect(element).shadowDom.to.be.equalSnapshot();
});
});

testA11yTreeSnapshot(html`<sbb-divider></sbb-divider>`);
describe('should render with orientation vertical', () => {
TomMenga marked this conversation as resolved.
Show resolved Hide resolved
let element: SbbDividerElement;

beforeEach(async () => {
element = await fixture(html`<sbb-divider orientation="vertical"></sbb-divider>`);
});

it('DOM', async () => {
await expect(element).dom.to.be.equalSnapshot();
});

it('Shadow DOM', async () => {
await expect(element).shadowDom.to.be.equalSnapshot();
});
});
});
11 changes: 10 additions & 1 deletion src/elements/divider/divider.spec.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
import { assert } from '@open-wc/testing';
import { assert, expect } from '@open-wc/testing';
import { html } from 'lit/static-html.js';

import { fixture } from '../core/testing/private.js';
import { waitForLitRender } from '../core/testing.js';

import { SbbDividerElement } from './divider.js';

Expand All @@ -10,4 +11,12 @@ describe(`sbb-divider`, () => {
const element: SbbDividerElement = await fixture(html`<sbb-divider></sbb-divider>`);
assert.instanceOf(element, SbbDividerElement);
});

it('should react to change of orientation', async () => {
const element: SbbDividerElement = await fixture(html`<sbb-divider></sbb-divider>`);

TomMenga marked this conversation as resolved.
Show resolved Hide resolved
element.orientation = 'vertical';
await waitForLitRender(element);
expect(element).to.have.attribute('aria-orientation', 'vertical');
});
});
41 changes: 41 additions & 0 deletions src/elements/divider/divider.visual.spec.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
import { html, nothing } from 'lit';

import {
describeEach,
describeViewports,
visualDiffDefault,
visualRegressionFixture,
} from '../core/testing/private.js';

import './divider.js';

describe(`sbb-divider`, () => {
let root: HTMLElement;

const cases = {
orientation: ['horizontal', 'vertical'],
negative: [false, true],
};

describeViewports({ viewports: ['zero'] }, () => {
describeEach(cases, ({ negative, orientation }) => {
beforeEach(async function () {
root = await visualRegressionFixture(
html`
<div style=${orientation === 'vertical' ? 'height: 340px' : nothing}>
<sbb-divider ?negative=${negative} orientation=${orientation}></sbb-divider>
</div>
`,
{ backgroundColor: negative ? 'var(--sbb-color-charcoal)' : undefined },
);
});

it(
visualDiffDefault.name,
visualDiffDefault.with((setup) => {
setup.withSnapshotElement(root);
}),
);
});
});
});
Loading