refactor(material-experimental/mdc-paginator): de-duplicate test harness logic

Changes the MDC-based `MatPaginatorHarness` to extend the non-MDC version since
the logic is identical, apart from a few selectors.

Author: crisbeto

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

@@ -10,7 +10,6 @@ ts_library(
     ),
     module_name = "@angular/material-experimental/mdc-paginator/testing",
     deps = [
-        "//src/cdk/coercion",
         "//src/cdk/testing",
         "//src/material-experimental/mdc-select/testing",
         "//src/material/paginator/testing",

src/material-experimental/mdc-paginator/testing/paginator-harness-filters.ts

@@ -6,98 +6,35 @@
  * found in the LICENSE file at https://angular.io/license
  */
 
-import {ComponentHarness, HarnessPredicate} from '@angular/cdk/testing';
+import {HarnessPredicate} from '@angular/cdk/testing';
 import {MatSelectHarness} from '@angular/material-experimental/mdc-select/testing';
-import {coerceNumberProperty} from '@angular/cdk/coercion';
-import {PaginatorHarnessFilters} from './paginator-harness-filters';
+import {
+  PaginatorHarnessFilters,
+  MatPaginatorHarness as NonMdcMatPaginatorHarness,
+} from '@angular/material/paginator/testing';
 
 
 /** Harness for interacting with an MDC-based mat-paginator in tests. */
-export class MatPaginatorHarness extends ComponentHarness {
+export class MatPaginatorHarness extends NonMdcMatPaginatorHarness {
   /** Selector used to find paginator instances. */
   static hostSelector = '.mat-mdc-paginator';
-  private _nextButton = this.locatorFor('.mat-mdc-paginator-navigation-next');
-  private _previousButton = this.locatorFor('.mat-mdc-paginator-navigation-previous');
-  private _firstPageButton = this.locatorForOptional('.mat-mdc-paginator-navigation-first');
-  private _lastPageButton = this.locatorForOptional('.mat-mdc-paginator-navigation-last');
-  private _select = this.locatorForOptional(MatSelectHarness.with({
+  protected _nextButton = this.locatorFor('.mat-mdc-paginator-navigation-next');
+  protected _previousButton = this.locatorFor('.mat-mdc-paginator-navigation-previous');
+  protected _firstPageButton = this.locatorForOptional('.mat-mdc-paginator-navigation-first');
+  protected _lastPageButton = this.locatorForOptional('.mat-mdc-paginator-navigation-last');
+  protected _select = this.locatorForOptional(MatSelectHarness.with({
     ancestor: '.mat-mdc-paginator-page-size'
-  }));
-  private _pageSizeFallback = this.locatorFor('.mat-mdc-paginator-page-size-value');
-  private _rangeLabel = this.locatorFor('.mat-mdc-paginator-range-label');
+  })) as any; // TODO(crisbeto): should be able to remove the `as any` after #21460 is merged in.
+  protected _pageSizeFallback = this.locatorFor('.mat-mdc-paginator-page-size-value');
+  protected _rangeLabel = this.locatorFor('.mat-mdc-paginator-range-label');
 
   /**
    * Gets a `HarnessPredicate` that can be used to search for a `MatPaginatorHarness` that meets
    * certain criteria.
    * @param options Options for filtering which paginator instances are considered a match.
    * @return a `HarnessPredicate` configured with the given options.
    */
-  static with(options: PaginatorHarnessFilters = {}): HarnessPredicate<MatPaginatorHarness> {
-    return new HarnessPredicate(MatPaginatorHarness, options);
-  }
-
-  /** Goes to the next page in the paginator. */
-  async goToNextPage(): Promise<void> {
-    return (await this._nextButton()).click();
-  }
-
-  /** Goes to the previous page in the paginator. */
-  async goToPreviousPage(): Promise<void> {
-    return (await this._previousButton()).click();
-  }
-
-  /** Goes to the first page in the paginator. */
-  async goToFirstPage(): Promise<void> {
-    const button = await this._firstPageButton();
-
-    // The first page button isn't enabled by default so we need to check for it.
-    if (!button) {
-      throw Error('Could not find first page button inside paginator. ' +
-                  'Make sure that `showFirstLastButtons` is enabled.');
-    }
-
-    return button.click();
-  }
-
-  /** Goes to the last page in the paginator. */
-  async goToLastPage(): Promise<void> {
-    const button = await this._lastPageButton();
-
-    // The last page button isn't enabled by default so we need to check for it.
-    if (!button) {
-      throw Error('Could not find last page button inside paginator. ' +
-                  'Make sure that `showFirstLastButtons` is enabled.');
-    }
-
-    return button.click();
-  }
-
-  /**
-   * Sets the page size of the paginator.
-   * @param size Page size that should be select.
-   */
-  async setPageSize(size: number): Promise<void> {
-    const select = await this._select();
-
-    // The select is only available if the `pageSizeOptions` are
-    // set to an array with more than one item.
-    if (!select) {
-      throw Error('Cannot find page size selector in paginator. ' +
-                  'Make sure that the `pageSizeOptions` have been configured.');
-    }
-
-    return select.clickOptions({text: `${size}`});
-  }
-
-  /** Gets the page size of the paginator. */
-  async getPageSize(): Promise<number> {
-    const select = await this._select();
-    const value = select ? select.getValueText() : (await this._pageSizeFallback()).text();
-    return coerceNumberProperty(await value);
-  }
-
-  /** Gets the text of the range labe of the paginator. */
-  async getRangeLabel(): Promise<string> {
-    return (await this._rangeLabel()).text();
+  static with(options: PaginatorHarnessFilters = {}): HarnessPredicate<NonMdcMatPaginatorHarness> {
+    return new HarnessPredicate<NonMdcMatPaginatorHarness>(MatPaginatorHarness, options);
   }
 }

src/material-experimental/mdc-paginator/testing/paginator-harness.ts

@@ -7,4 +7,4 @@
  */
 
 export * from './paginator-harness';
-export * from './paginator-harness-filters';
+export {PaginatorHarnessFilters} from '@angular/material/paginator/testing';

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

@@ -16,15 +16,15 @@ import {PaginatorHarnessFilters} from './paginator-harness-filters';
 export class MatPaginatorHarness extends ComponentHarness {
   /** Selector used to find paginator instances. */
   static hostSelector = '.mat-paginator';
-  private _nextButton = this.locatorFor('.mat-paginator-navigation-next');
-  private _previousButton = this.locatorFor('.mat-paginator-navigation-previous');
-  private _firstPageButton = this.locatorForOptional('.mat-paginator-navigation-first');
-  private _lastPageButton = this.locatorForOptional('.mat-paginator-navigation-last');
-  private _select = this.locatorForOptional(MatSelectHarness.with({
+  protected _nextButton = this.locatorFor('.mat-paginator-navigation-next');
+  protected _previousButton = this.locatorFor('.mat-paginator-navigation-previous');
+  protected _firstPageButton = this.locatorForOptional('.mat-paginator-navigation-first');
+  protected _lastPageButton = this.locatorForOptional('.mat-paginator-navigation-last');
+  protected _select = this.locatorForOptional(MatSelectHarness.with({
     ancestor: '.mat-paginator-page-size'
   }));
-  private _pageSizeFallback = this.locatorFor('.mat-paginator-page-size-value');
-  private _rangeLabel = this.locatorFor('.mat-paginator-range-label');
+  protected _pageSizeFallback = this.locatorFor('.mat-paginator-page-size-value');
+  protected _rangeLabel = this.locatorFor('.mat-paginator-range-label');
 
   /**
    * Gets a `HarnessPredicate` that can be used to search for a `MatPaginatorHarness` that meets

src/material/paginator/testing/paginator-harness.ts

@@ -1,4 +1,11 @@
 export declare class MatPaginatorHarness extends ComponentHarness {
+    protected _firstPageButton: import("@angular/cdk/testing").AsyncFactoryFn<import("@angular/cdk/testing").TestElement | null>;
+    protected _lastPageButton: import("@angular/cdk/testing").AsyncFactoryFn<import("@angular/cdk/testing").TestElement | null>;
+    protected _nextButton: import("@angular/cdk/testing").AsyncFactoryFn<import("@angular/cdk/testing").TestElement>;
+    protected _pageSizeFallback: import("@angular/cdk/testing").AsyncFactoryFn<import("@angular/cdk/testing").TestElement>;
+    protected _previousButton: import("@angular/cdk/testing").AsyncFactoryFn<import("@angular/cdk/testing").TestElement>;
+    protected _rangeLabel: import("@angular/cdk/testing").AsyncFactoryFn<import("@angular/cdk/testing").TestElement>;
+    protected _select: import("@angular/cdk/testing").AsyncFactoryFn<MatSelectHarness | null>;
     getPageSize(): Promise<number>;
     getRangeLabel(): Promise<string>;
     goToFirstPage(): Promise<void>;