Skip to content

feat(menu): move test harness out of experimental #17113

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 1 commit into from
Sep 17, 2019
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
17 changes: 1 addition & 16 deletions src/material-experimental/mdc-menu/BUILD.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,14 @@ package(default_visibility = ["//visibility:public"])

load("@io_bazel_rules_sass//:defs.bzl", "sass_binary", "sass_library")
load("//src/e2e-app:test_suite.bzl", "e2e_test_suite")
load("//tools:defaults.bzl", "ng_e2e_test_library", "ng_module", "ng_test_library", "ng_web_test_suite", "ts_library")
load("//tools:defaults.bzl", "ng_e2e_test_library", "ng_module", "ng_test_library", "ng_web_test_suite")

ng_module(
name = "mdc-menu",
srcs = glob(
["**/*.ts"],
exclude = [
"**/*.spec.ts",
"harness/**",
],
),
assets = [":menu_scss"] + glob(["**/*.html"]),
Expand All @@ -25,18 +24,6 @@ ng_module(
],
)

ts_library(
name = "harness",
srcs = glob(
["harness/**/*.ts"],
exclude = ["**/*.spec.ts"],
),
deps = [
"//src/cdk/coercion",
"//src/cdk/testing",
],
)

sass_library(
name = "mdc_menu_scss_lib",
srcs = glob(["**/_*.scss"]),
Expand Down Expand Up @@ -65,7 +52,6 @@ ng_test_library(
exclude = ["**/*.e2e.spec.ts"],
),
deps = [
":harness",
":mdc-menu",
"//src/cdk/a11y",
"//src/cdk/bidi",
Expand All @@ -74,7 +60,6 @@ ng_test_library(
"//src/cdk/private/testing",
"//src/cdk/scrolling",
"//src/cdk/testing",
"//src/cdk/testing/testbed",
"//src/material/core",
"//src/material/menu",
"@npm//@angular/platform-browser",
Expand Down
35 changes: 35 additions & 0 deletions src/material-experimental/mdc-menu/harness/BUILD.bazel
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
package(default_visibility = ["//visibility:public"])

load("//tools:defaults.bzl", "ng_module", "ng_test_library", "ng_web_test_suite")

ng_module(
name = "testing",
srcs = glob(
["**/*.ts"],
exclude = ["**/*.spec.ts"],
),
module_name = "@angular/material-experimental/mdc-menu/testing",
deps = [
"//src/cdk/coercion",
"//src/cdk/testing",
"//src/material/menu/testing",
],
)

ng_test_library(
name = "unit_tests_lib",
srcs = glob(["**/*.spec.ts"]),
deps = [
":testing",
"//src/material-experimental/mdc-menu",
"//src/material/menu/testing:harness_tests_lib",
],
)

ng_web_test_suite(
name = "unit_tests",
deps = [
":unit_tests_lib",
"//src/material-experimental:mdc_require_config.js",
],
)
9 changes: 9 additions & 0 deletions src/material-experimental/mdc-menu/harness/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
/**
* @license
* Copyright Google LLC All Rights Reserved.
*
* Use of this source code is governed by an MIT-style license that can be
* found in the LICENSE file at https://angular.io/license
*/

export * from './public-api';
117 changes: 4 additions & 113 deletions src/material-experimental/mdc-menu/harness/menu-harness.spec.ts
Original file line number Diff line number Diff line change
@@ -1,116 +1,7 @@
import {HarnessLoader} from '@angular/cdk/testing';
import {TestbedHarnessEnvironment} from '@angular/cdk/testing/testbed';
import {Component, Type} from '@angular/core';
import {ComponentFixture, TestBed, inject} from '@angular/core/testing';
import {MatMenuModule} from '@angular/material/menu';
import {OverlayContainer} from '@angular/cdk/overlay';
import {MatMenuModule as MatMdcMenuModule} from '../index';
import {MatMenuHarness as MatMdcMenuHarness} from './mdc-menu-harness';
import {runHarnessTests} from '@angular/material/menu/testing/shared.spec';
import {MatMenuModule} from '../index';
import {MatMenuHarness} from './menu-harness';

let fixture: ComponentFixture<MenuHarnessTest>;
let loader: HarnessLoader;
let menuHarness: typeof MatMenuHarness;
let overlayContainer: OverlayContainer;

describe('MatMenuHarness', () => {
describe('non-MDC-based', () => {
beforeEach(async () => {
await prepareTests(MatMenuModule, MenuHarnessTest);
menuHarness = MatMenuHarness;
});

runTests();
});

describe('MDC-based', () => {
beforeEach(async () => {
await prepareTests(MatMdcMenuModule, MenuHarnessTest);
// Public APIs are the same as MatMenuHarness, but cast is necessary because of different
// private fields.
menuHarness = MatMdcMenuHarness as any;
});

runTests();
});
describe('MDC-based MatMenuHarness', () => {
runHarnessTests(MatMenuModule, MatMenuHarness);
});

/** Shared test setup logic. */
async function prepareTests(moduleType: Type<any>, fixtureType: Type<any>) {
await TestBed.configureTestingModule({
imports: [moduleType],
declarations: [fixtureType],
}).compileComponents();

fixture = TestBed.createComponent(fixtureType);
fixture.detectChanges();
loader = TestbedHarnessEnvironment.loader(fixture);
inject([OverlayContainer], (oc: OverlayContainer) => {
overlayContainer = oc;
})();
}

/** Shared tests to run on both the original and MDC-based menues. */
function runTests() {
afterEach(() => {
// Angular won't call this for us so we need to do it ourselves to avoid leaks.
overlayContainer.ngOnDestroy();
overlayContainer = null!;
});

it('should load all menu harnesses', async () => {
const menues = await loader.getAllHarnesses(menuHarness);
expect(menues.length).toBe(2);
});

it('should load menu with exact text', async () => {
const menus = await loader.getAllHarnesses(menuHarness.with({triggerText: 'Settings'}));
expect(menus.length).toBe(1);
expect(await menus[0].getTriggerText()).toBe('Settings');
});

it('should load menu with regex label match', async () => {
const menus = await loader.getAllHarnesses(menuHarness.with({triggerText: /settings/i}));
expect(menus.length).toBe(1);
expect(await menus[0].getTriggerText()).toBe('Settings');
});

it('should get disabled state', async () => {
const [enabledMenu, disabledMenu] = await loader.getAllHarnesses(menuHarness);
expect(await enabledMenu.isDisabled()).toBe(false);
expect(await disabledMenu.isDisabled()).toBe(true);
});

it('should get menu text', async () => {
const [firstMenu, secondMenu] = await loader.getAllHarnesses(menuHarness);
expect(await firstMenu.getTriggerText()).toBe('Settings');
expect(await secondMenu.getTriggerText()).toBe('Disabled menu');
});

it('should focus and blur a menu', async () => {
const menu = await loader.getHarness(menuHarness.with({triggerText: 'Settings'}));
expect(getActiveElementId()).not.toBe('settings');
await menu.focus();
expect(getActiveElementId()).toBe('settings');
await menu.blur();
expect(getActiveElementId()).not.toBe('settings');
});
}

function getActiveElementId() {
return document.activeElement ? document.activeElement.id : '';
}

@Component({
template: `
<button type="button" id="settings" [matMenuTriggerFor]="settingsMenu">Settings</button>
<button type="button" disabled [matMenuTriggerFor]="settingsMenu">Disabled menu</button>

<mat-menu #settingsMenu>
<menu mat-menu-item>Profile</menu>
<menu mat-menu-item>Account</menu>
</mat-menu>
`
})
class MenuHarnessTest { }

4 changes: 2 additions & 2 deletions src/material-experimental/mdc-menu/harness/menu-harness.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@

import {ComponentHarness, HarnessPredicate} from '@angular/cdk/testing';
import {coerceBooleanProperty} from '@angular/cdk/coercion';
import {MenuHarnessFilters} from './menu-harness-filters';
import {MatMenuItemHarness} from './menu-item-harness';
import {MenuHarnessFilters} from '@angular/material/menu/testing/menu-harness-filters';

/**
* Harness for interacting with a standard mat-menu in tests.
* Harness for interacting with a MDC-based mat-menu in tests.
* @dynamic
*/
export class MatMenuHarness extends ComponentHarness {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

import {ComponentHarness, HarnessPredicate} from '@angular/cdk/testing';
import {coerceBooleanProperty} from '@angular/cdk/coercion';
import {MenuItemHarnessFilters} from './menu-harness-filters';
import {MenuItemHarnessFilters} from '@angular/material/menu/testing/menu-harness-filters';


/**
Expand All @@ -26,7 +26,7 @@ export class MatMenuItemHarness extends ComponentHarness {
* @return a `HarnessPredicate` configured with the given options.
*/
static with(options: MenuItemHarnessFilters = {}): HarnessPredicate<MatMenuItemHarness> {
return new HarnessPredicate(MatMenuItemHarness, options); // TODO: add options here
return new HarnessPredicate(MatMenuItemHarness, options);
}

/** Gets a boolean promise indicating if the menu is disabled. */
Expand Down
10 changes: 10 additions & 0 deletions src/material-experimental/mdc-menu/harness/public-api.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
/**
* @license
* Copyright Google LLC All Rights Reserved.
*
* Use of this source code is governed by an MIT-style license that can be
* found in the LICENSE file at https://angular.io/license
*/

export * from './menu-harness';
export * from './menu-item-harness';
47 changes: 47 additions & 0 deletions src/material/menu/testing/BUILD.bazel
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
package(default_visibility = ["//visibility:public"])

load("//tools:defaults.bzl", "ng_module", "ng_test_library", "ng_web_test_suite")

ng_module(
name = "testing",
srcs = glob(
["**/*.ts"],
exclude = ["**/*.spec.ts"],
),
module_name = "@angular/material/menu/testing",
deps = [
"//src/cdk/coercion",
"//src/cdk/testing",
],
)

ng_test_library(
name = "harness_tests_lib",
srcs = ["shared.spec.ts"],
deps = [
":testing",
"//src/cdk/overlay",
"//src/cdk/testing",
"//src/cdk/testing/testbed",
"//src/material/menu",
"@npm//@angular/platform-browser",
],
)

ng_test_library(
name = "unit_tests_lib",
srcs = glob(
["**/*.spec.ts"],
exclude = ["shared.spec.ts"],
),
deps = [
":harness_tests_lib",
":testing",
"//src/material/menu",
],
)

ng_web_test_suite(
name = "unit_tests",
deps = [":unit_tests_lib"],
)
9 changes: 9 additions & 0 deletions src/material/menu/testing/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
/**
* @license
* Copyright Google LLC All Rights Reserved.
*
* Use of this source code is governed by an MIT-style license that can be
* found in the LICENSE file at https://angular.io/license
*/

export * from './public-api';
7 changes: 7 additions & 0 deletions src/material/menu/testing/menu-harness.spec.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import {MatMenuModule} from '@angular/material/menu';
import {runHarnessTests} from '@angular/material/menu/testing/shared.spec';
import {MatMenuHarness} from './menu-harness';

describe('Non-MDC-based MatMenuHarness', () => {
runHarnessTests(MatMenuModule, MatMenuHarness);
});
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@

import {ComponentHarness, HarnessPredicate} from '@angular/cdk/testing';
import {coerceBooleanProperty} from '@angular/cdk/coercion';
import {MatMenuItemHarness} from './mdc-menu-item-harness';
import {MenuHarnessFilters} from './menu-harness-filters';
import {MatMenuItemHarness} from './menu-item-harness';

/**
* Harness for interacting with a MDC-based mat-menu in tests.
* Harness for interacting with a standard mat-menu in tests.
* @dynamic
*/
export class MatMenuHarness extends ComponentHarness {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

import {ComponentHarness, HarnessPredicate} from '@angular/cdk/testing';
import {coerceBooleanProperty} from '@angular/cdk/coercion';
import {MenuItemHarnessFilters} from './menu-harness-filters';
import {MenuItemHarnessFilters} from '@angular/material/menu/testing/menu-harness-filters';


/**
Expand All @@ -26,7 +26,7 @@ export class MatMenuItemHarness extends ComponentHarness {
* @return a `HarnessPredicate` configured with the given options.
*/
static with(options: MenuItemHarnessFilters = {}): HarnessPredicate<MatMenuItemHarness> {
return new HarnessPredicate(MatMenuItemHarness, options);
return new HarnessPredicate(MatMenuItemHarness, options); // TODO: add options here
}

/** Gets a boolean promise indicating if the menu is disabled. */
Expand Down
11 changes: 11 additions & 0 deletions src/material/menu/testing/public-api.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
/**
* @license
* Copyright Google LLC All Rights Reserved.
*
* Use of this source code is governed by an MIT-style license that can be
* found in the LICENSE file at https://angular.io/license
*/

export * from './menu-harness';
export * from './menu-harness-filters';
export * from './menu-item-harness';
Loading