122 lines
3.8 KiB
TypeScript
122 lines
3.8 KiB
TypeScript
/**
|
|
* @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.dev/license
|
|
*/
|
|
|
|
import {
|
|
ComponentHarnessConstructor,
|
|
ContentContainerComponentHarness,
|
|
HarnessPredicate,
|
|
parallel,
|
|
} from '@angular/cdk/testing';
|
|
import {
|
|
MatFooterRowHarness,
|
|
MatHeaderRowHarness,
|
|
MatRowHarness,
|
|
MatRowHarnessColumnsText,
|
|
} from './row-harness';
|
|
import {RowHarnessFilters, TableHarnessFilters} from './table-harness-filters';
|
|
|
|
/** Text extracted from a table organized by columns. */
|
|
export interface MatTableHarnessColumnsText {
|
|
[columnName: string]: {
|
|
text: string[];
|
|
headerText: string[];
|
|
footerText: string[];
|
|
};
|
|
}
|
|
|
|
/** Harness for interacting with a mat-table in tests. */
|
|
export class MatTableHarness extends ContentContainerComponentHarness<string> {
|
|
/** The selector for the host element of a `MatTableHarness` instance. */
|
|
static hostSelector = '.mat-mdc-table';
|
|
_headerRowHarness = MatHeaderRowHarness;
|
|
_rowHarness = MatRowHarness;
|
|
private _footerRowHarness = MatFooterRowHarness;
|
|
|
|
/**
|
|
* Gets a `HarnessPredicate` that can be used to search for a table with specific attributes.
|
|
* @param options Options for narrowing the search
|
|
* @return a `HarnessPredicate` configured with the given options.
|
|
*/
|
|
static with<T extends MatTableHarness>(
|
|
this: ComponentHarnessConstructor<T>,
|
|
options: TableHarnessFilters = {},
|
|
): HarnessPredicate<T> {
|
|
return new HarnessPredicate(this, options);
|
|
}
|
|
|
|
/** Gets all the header rows in a table. */
|
|
async getHeaderRows(filter: RowHarnessFilters = {}): Promise<MatHeaderRowHarness[]> {
|
|
return this.locatorForAll(this._headerRowHarness.with(filter))();
|
|
}
|
|
|
|
/** Gets all the regular data rows in a table. */
|
|
async getRows(filter: RowHarnessFilters = {}): Promise<MatRowHarness[]> {
|
|
return this.locatorForAll(this._rowHarness.with(filter))();
|
|
}
|
|
|
|
/** Gets all the footer rows in a table. */
|
|
async getFooterRows(filter: RowHarnessFilters = {}): Promise<MatFooterRowHarness[]> {
|
|
return this.locatorForAll(this._footerRowHarness.with(filter))();
|
|
}
|
|
|
|
/** Gets the text inside the entire table organized by rows. */
|
|
async getCellTextByIndex(): Promise<string[][]> {
|
|
const rows = await this.getRows();
|
|
return parallel(() => rows.map(row => row.getCellTextByIndex()));
|
|
}
|
|
|
|
/** Gets the text inside the entire table organized by columns. */
|
|
async getCellTextByColumnName(): Promise<MatTableHarnessColumnsText> {
|
|
const [headerRows, footerRows, dataRows] = await parallel(() => [
|
|
this.getHeaderRows(),
|
|
this.getFooterRows(),
|
|
this.getRows(),
|
|
]);
|
|
|
|
const text: MatTableHarnessColumnsText = {};
|
|
const [headerData, footerData, rowsData] = await parallel(() => [
|
|
parallel(() => headerRows.map(row => row.getCellTextByColumnName())),
|
|
parallel(() => footerRows.map(row => row.getCellTextByColumnName())),
|
|
parallel(() => dataRows.map(row => row.getCellTextByColumnName())),
|
|
]);
|
|
|
|
rowsData.forEach(data => {
|
|
Object.keys(data).forEach(columnName => {
|
|
const cellText = data[columnName];
|
|
|
|
if (!text[columnName]) {
|
|
text[columnName] = {
|
|
headerText: getCellTextsByColumn(headerData, columnName),
|
|
footerText: getCellTextsByColumn(footerData, columnName),
|
|
text: [],
|
|
};
|
|
}
|
|
|
|
text[columnName].text.push(cellText);
|
|
});
|
|
});
|
|
|
|
return text;
|
|
}
|
|
}
|
|
|
|
/** Extracts the text of cells only under a particular column. */
|
|
function getCellTextsByColumn(rowsData: MatRowHarnessColumnsText[], column: string): string[] {
|
|
const columnTexts: string[] = [];
|
|
|
|
rowsData.forEach(data => {
|
|
Object.keys(data).forEach(columnName => {
|
|
if (columnName === column) {
|
|
columnTexts.push(data[columnName]);
|
|
}
|
|
});
|
|
});
|
|
|
|
return columnTexts;
|
|
}
|