playwright/tests/bidi/expectationReporter.ts

76 lines
2.2 KiB
TypeScript
Raw Normal View History

/**
* Copyright (c) Microsoft Corporation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import type {
FullConfig, FullResult, Reporter, Suite, TestCase
} from '@playwright/test/reporter';
import fs from 'fs';
import { projectExpectationPath } from './expectationUtil';
type ReporterOptions = {
rebase?: boolean;
};
class ExpectationReporter implements Reporter {
private _suite: Suite;
private _options: ReporterOptions;
constructor(options: ReporterOptions) {
this._options = options;
}
onBegin(config: FullConfig, suite: Suite) {
this._suite = suite;
}
onEnd(result: FullResult) {
if (!this._options.rebase)
return;
for (const project of this._suite.suites)
this._updateProjectExpectations(project);
}
private _updateProjectExpectations(project: Suite) {
const results = project.allTests().map(test => {
const outcome = getOutcome(test);
const line = `${test.titlePath().slice(1).join(' ')} [${outcome}]`;
return line;
});
const outputFile = projectExpectationPath(project.title);
console.log('Writing new expectations to', outputFile);
fs.writeFileSync(outputFile, results.join('\n'));
}
printsToStdio(): boolean {
return false;
}
}
function getOutcome(test: TestCase): 'unknown' | 'flaky' | 'pass' | 'fail' | 'timeout' {
if (test.results.length === 0)
return 'unknown';
if (test.results.every(r => r.status === 'timedOut'))
return 'timeout';
if (test.outcome() === 'expected')
return 'pass';
if (test.outcome() === 'unexpected')
return 'fail';
if (test.outcome() === 'flaky')
return 'flaky';
return 'unknown';
}
export default ExpectationReporter;