Skip to content

test(material/button-toggle): add disabled harness filter #26139

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

Merged
merged 2 commits into from
Dec 1, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
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 @@ -9,4 +9,7 @@
import {BaseHarnessFilters} from '@angular/cdk/testing';

/** Criteria that can be used to filter a list of `MatButtonToggleGroupHarness` instances. */
export interface ButtonToggleGroupHarnessFilters extends BaseHarnessFilters {}
export interface ButtonToggleGroupHarnessFilters extends BaseHarnessFilters {
/** Only find instances which match the given disabled state. */
disabled?: boolean;
}
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,13 @@ export class MatButtonToggleGroupHarness extends ComponentHarness {
static with(
options: ButtonToggleGroupHarnessFilters = {},
): HarnessPredicate<MatButtonToggleGroupHarness> {
return new HarnessPredicate(MatButtonToggleGroupHarness, options);
return new HarnessPredicate(MatButtonToggleGroupHarness, options).addOption(
'disabled',
options.disabled,
async (harness, disabled) => {
return (await harness.isDisabled()) === disabled;
},
);
}

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,24 @@ export function runHarnessTests(
expect(await group.isDisabled()).toBe(true);
});

it('should filter by whether the group is disabled', async () => {
let enabledGroups = await loader.getAllHarnesses(
buttonToggleGroupHarness.with({disabled: false}),
);
let disabledGroups = await loader.getAllHarnesses(
buttonToggleGroupHarness.with({disabled: true}),
);
expect(enabledGroups.length).toBe(1);
expect(disabledGroups.length).toBe(0);

fixture.componentInstance.disabled = true;

enabledGroups = await loader.getAllHarnesses(buttonToggleGroupHarness.with({disabled: false}));
disabledGroups = await loader.getAllHarnesses(buttonToggleGroupHarness.with({disabled: true}));
expect(enabledGroups.length).toBe(0);
expect(disabledGroups.length).toBe(1);
});

it('should get whether the group is vertical', async () => {
const group = await loader.getHarness(buttonToggleGroupHarness);
expect(await group.isVertical()).toBe(false);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,6 @@ export interface ButtonToggleHarnessFilters extends BaseHarnessFilters {
name?: string | RegExp;
/** Only find instances that are checked. */
checked?: boolean;
/** Only find instances which match the given disabled state. */
disabled?: boolean;
}
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,10 @@ export class MatButtonToggleHarness extends ComponentHarness {
'checked',
options.checked,
async (harness, checked) => (await harness.isChecked()) === checked,
);
)
.addOption('disabled', options.disabled, async (harness, disabled) => {
return (await harness.isDisabled()) === disabled;
});
}

/** Gets a boolean promise indicating if the button toggle is checked. */
Expand Down
11 changes: 11 additions & 0 deletions src/material/button-toggle/testing/button-toggle-shared.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,17 @@ export function runHarnessTests(
expect(await uncheckedToggle.isChecked()).toBe(false);
});

it('should filter by whether the group is disabled', async () => {
const enabledToggles = await loader.getAllHarnesses(
buttonToggleHarness.with({disabled: false}),
);
const disabledToggles = await loader.getAllHarnesses(
buttonToggleHarness.with({disabled: true}),
);
expect(enabledToggles.length).toBe(1);
expect(disabledToggles.length).toBe(1);
});

it('should get the toggle disabled state', async () => {
const [enabledToggle, disabledToggle] = await loader.getAllHarnesses(buttonToggleHarness);
expect(await enabledToggle.isDisabled()).toBe(false);
Expand Down
2 changes: 2 additions & 0 deletions tools/public_api_guard/material/button-toggle-testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,13 @@ import { MatButtonToggleAppearance } from '@angular/material/button-toggle';

// @public
export interface ButtonToggleGroupHarnessFilters extends BaseHarnessFilters {
disabled?: boolean;
}

// @public
export interface ButtonToggleHarnessFilters extends BaseHarnessFilters {
checked?: boolean;
disabled?: boolean;
name?: string | RegExp;
text?: string | RegExp;
}
Expand Down