feat(input/testing): add test harnesses for native select and option

Adds test harnesses for native `select` and `option` elements that are placed inside a `mat-form-field`.

Author: crisbeto

src/material-experimental/mdc-input/testing/BUILD.bazel

@@ -22,10 +22,7 @@ filegroup(
 
 ng_test_library(
     name = "unit_tests_lib",
-    srcs = glob(
-        ["**/*.spec.ts"],
-        exclude = ["shared.spec.ts"],
-    ),
+    srcs = glob(["**/*.spec.ts"]),
     deps = [
         ":testing",
         "//src/material-experimental/mdc-input",

src/material-experimental/mdc-input/testing/input-harness.spec.ts

@@ -1,7 +1,7 @@
 import {MatInputModule} from '@angular/material-experimental/mdc-input';
-import {runHarnessTests} from '@angular/material/input/testing/shared.spec';
+import {runInputHarnessTests} from '@angular/material/input/testing/shared-input.spec';
 import {MatInputHarness} from './index';
 
 describe('MDC-based MatInputHarness', () => {
-  runHarnessTests(MatInputModule, MatInputHarness);
+  runInputHarnessTests(MatInputModule, MatInputHarness);
 });

src/material-experimental/mdc-input/testing/native-select-harness.spec.ts

@@ -0,0 +1,9 @@
+import {MatInputModule} from '@angular/material-experimental/mdc-input';
+import {
+  runNativeSelectHarnessTests
+} from '@angular/material/input/testing/shared-native-select.spec';
+import {MatNativeSelectHarness} from './index';
+
+describe('MDC-based MatNativeSelectHarness', () => {
+  runNativeSelectHarnessTests(MatInputModule, MatNativeSelectHarness);
+});

src/material-experimental/mdc-input/testing/public-api.ts

@@ -6,4 +6,11 @@
  * found in the LICENSE file at https://angular.io/license
  */
 
-export {InputHarnessFilters, MatInputHarness} from '@angular/material/input/testing';
+export {
+  InputHarnessFilters,
+  MatInputHarness,
+  MatNativeSelectHarness,
+  MatNativeOptionHarness,
+  NativeOptionHarnessFilters,
+  NativeSelectHarnessFilters,
+} from '@angular/material/input/testing';

src/material/input/testing/BUILD.bazel

@@ -23,7 +23,10 @@ filegroup(
 
 ng_test_library(
     name = "harness_tests_lib",
-    srcs = ["shared.spec.ts"],
+    srcs = [
+        "shared-input.spec.ts",
+        "shared-native-select.spec.ts",
+    ],
     deps = [
         ":testing",
         "//src/cdk/platform",
@@ -39,7 +42,10 @@ ng_test_library(
     name = "unit_tests_lib",
     srcs = glob(
         ["**/*.spec.ts"],
-        exclude = ["shared.spec.ts"],
+        exclude = [
+            "shared-input.spec.ts",
+            "shared-native-select.spec.ts",
+        ],
     ),
     deps = [
         ":harness_tests_lib",

src/material/input/testing/input-harness.spec.ts

@@ -1,7 +1,7 @@
 import {MatInputModule} from '@angular/material/input';
 import {MatInputHarness} from './input-harness';
-import {runHarnessTests} from './shared.spec';
+import {runInputHarnessTests} from './shared-input.spec';
 
 describe('Non-MDC-based MatInputHarness', () => {
-  runHarnessTests(MatInputModule, MatInputHarness);
+  runInputHarnessTests(MatInputModule, MatInputHarness);
 });

src/material/input/testing/native-option-harness.ts

@@ -0,0 +1,54 @@
+/**
+ * @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
+ */
+
+import {ComponentHarness, HarnessPredicate} from '@angular/cdk/testing';
+import {NativeOptionHarnessFilters} from './native-select-harness-filters';
+
+/** Harness for interacting with a native `option` in tests. */
+export class MatNativeOptionHarness extends ComponentHarness {
+  /** Selector used to locate option instances. */
+  static hostSelector = 'select[matNativeControl] option';
+
+  /**
+   * Gets a `HarnessPredicate` that can be used to search for a `MatNativeOptionHarness` that meets
+   * certain criteria.
+   * @param options Options for filtering which option instances are considered a match.
+   * @return a `HarnessPredicate` configured with the given options.
+   */
+  static with(options: NativeOptionHarnessFilters = {}) {
+    return new HarnessPredicate(MatNativeOptionHarness, options)
+        .addOption('text', options.text,
+            async (harness, title) =>
+                HarnessPredicate.stringMatches(await harness.getText(), title))
+        .addOption('index', options.index,
+            async (harness, index) => await harness.getIndex() === index)
+        .addOption('isSelected', options.isSelected,
+            async (harness, isSelected) => await harness.isSelected() === isSelected);
+
+  }
+
+  /** Gets the option's label text. */
+  async getText(): Promise<string> {
+    return (await this.host()).getProperty('label');
+  }
+
+  /** Index of the option within the native `select` element. */
+  async getIndex(): Promise<number> {
+    return (await this.host()).getProperty('index');
+  }
+
+  /** Gets whether the option is disabled. */
+  async isDisabled(): Promise<boolean> {
+    return (await this.host()).getProperty('disabled');
+  }
+
+  /** Gets whether the option is selected. */
+  async isSelected(): Promise<boolean> {
+    return (await this.host()).getProperty('selected');
+  }
+}

src/material/input/testing/native-select-harness-filters.ts

@@ -0,0 +1,19 @@
+/**
+ * @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
+ */
+
+import {BaseHarnessFilters} from '@angular/cdk/testing';
+
+/** A set of criteria that can be used to filter a list of `MatNativeSelectHarness` instances. */
+export interface NativeSelectHarnessFilters extends BaseHarnessFilters {}
+
+/** A set of criteria that can be used to filter a list of `MatNativeOptionHarness` instances. */
+export interface NativeOptionHarnessFilters extends BaseHarnessFilters {
+  text?: string | RegExp;
+  index?: number;
+  isSelected?: boolean;
+}

src/material/input/testing/native-select-harness.spec.ts

@@ -0,0 +1,7 @@
+import {MatInputModule} from '@angular/material/input';
+import {MatNativeSelectHarness} from './native-select-harness';
+import {runNativeSelectHarnessTests} from './shared-native-select.spec';
+
+describe('Non-MDC-based MatNativeSelectHarness', () => {
+  runNativeSelectHarnessTests(MatInputModule, MatNativeSelectHarness);
+});

src/material/input/testing/native-select-harness.ts

@@ -0,0 +1,104 @@
+/**
+ * @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
+ */
+
+import {HarnessPredicate} from '@angular/cdk/testing';
+import {MatFormFieldControlHarness} from '@angular/material/form-field/testing/control';
+import {MatNativeOptionHarness} from './native-option-harness';
+import {
+  NativeOptionHarnessFilters,
+  NativeSelectHarnessFilters,
+} from './native-select-harness-filters';
+
+
+/** Harness for interacting with a native `select` in tests. */
+export class MatNativeSelectHarness extends MatFormFieldControlHarness {
+  static hostSelector = 'select[matNativeControl]';
+
+  /**
+   * Gets a `HarnessPredicate` that can be used to search for a `MatNativeSelectHarness` that meets
+   * certain criteria.
+   * @param options Options for filtering which select instances are considered a match.
+   * @return a `HarnessPredicate` configured with the given options.
+   */
+  static with(options: NativeSelectHarnessFilters = {}): HarnessPredicate<MatNativeSelectHarness> {
+    return new HarnessPredicate(MatNativeSelectHarness, options);
+  }
+
+  /** Gets a boolean promise indicating if the select is disabled. */
+  async isDisabled(): Promise<boolean> {
+    return (await this.host()).getProperty('disabled');
+  }
+
+  /** Gets a boolean promise indicating if the select is required. */
+  async isRequired(): Promise<boolean> {
+    return (await this.host()).getProperty('required');
+  }
+
+  /** Gets a boolean promise indicating if the select is in multi-selection mode. */
+  async isMultiple(): Promise<boolean> {
+    return (await this.host()).getProperty('multiple');
+  }
+
+  /** Gets the name of the select. */
+  async getName(): Promise<string> {
+    // The "name" property of the native select is never undefined.
+    return (await (await this.host()).getProperty('name'))!;
+  }
+
+  /** Gets the id of the select. */
+  async getId(): Promise<string> {
+    // We're guaranteed to have an id, because the `matNativeControl` always assigns one.
+    return (await (await this.host()).getProperty('id'))!;
+  }
+
+  /** Focuses the select and returns a void promise that indicates when the action is complete. */
+  async focus(): Promise<void> {
+    return (await this.host()).focus();
+  }
+
+  /** Blurs the select and returns a void promise that indicates when the action is complete. */
+  async blur(): Promise<void> {
+    return (await this.host()).blur();
+  }
+
+  /** Whether the select is focused. */
+  async isFocused(): Promise<boolean> {
+    return (await this.host()).isFocused();
+  }
+
+  /** Gets the options inside the select panel. */
+  async getOptions(filter: NativeOptionHarnessFilters = {}):
+    Promise<MatNativeOptionHarness[]> {
+    return this.locatorForAll(MatNativeOptionHarness.with(filter))();
+  }
+
+  /**
+   * Selects the options that match the passed-in filter. If the select is in multi-selection
+   * mode all options will be clicked, otherwise the harness will pick the first matching option.
+   */
+  async selectOptions(filter: NativeOptionHarnessFilters = {}): Promise<void> {
+    const [isMultiple, options] = await Promise.all([this.isMultiple(), this.getOptions(filter)]);
+
+    if (options.length === 0) {
+      throw Error('Select does not have options matching the specified filter');
+    }
+
+    const [host, optionIndexes] = await Promise.all([
+      this.host(),
+      Promise.all(options.slice(0, isMultiple ? undefined : 1).map(option => option.getIndex()))
+    ]);
+
+    // @breaking-change 12.0.0 Error can be removed once `selectOptions` is a required method.
+    if (!host.selectOptions) {
+      throw Error('TestElement implementation does not support the selectOptions ' +
+                  'method which is required for this function.');
+    }
+
+    await host.selectOptions(...optionIndexes);
+  }
+}

src/material/input/testing/public-api.ts

@@ -8,3 +8,6 @@
 
 export * from './input-harness';
 export * from './input-harness-filters';
+export * from './native-select-harness';
+export * from './native-select-harness-filters';
+export * from './native-option-harness';

src/material/input/testing/shared.spec.ts renamed to src/material/input/testing/shared-input.spec.ts

@@ -9,7 +9,7 @@ import {NoopAnimationsModule} from '@angular/platform-browser/animations';
 import {MatInputHarness} from './input-harness';
 
 /** Shared tests to run on both the original and MDC-based input's. */
-export function runHarnessTests(
+export function runInputHarnessTests(
     inputModule: typeof MatInputModule, inputHarness: typeof MatInputHarness) {
   let fixture: ComponentFixture<InputHarnessTest>;
   let loader: HarnessLoader;