@serenity-js/protractor/src/adapter/ProtractorFrameworkAdapter.ts

Adapter that integrates @serenity-js/web with Protractor, enabling Serenity/JS reporting and using the Screenplay Pattern to write end-to-end test scenarios

import type { Serenity } from '@serenity-js/core';
import { AnsiDiffFormatter, ArtifactArchiver, Cast, TakeNotes } from '@serenity-js/core';
import { CallAnApi } from '@serenity-js/rest';
import type { Runner } from 'protractor';
import { protractor } from 'protractor';
import { isRecord } from 'tiny-types/lib/objects';

import { BrowseTheWebWithProtractor } from '../screenplay';
import { BrowserDetector, StandardisedCapabilities } from './browser-detector';
import type { Config } from './Config';
import type { ProtractorReport } from './reporter';
import { ProtractorReporter } from './reporter';
import { TestRunnerDetector } from './runner';
import deepmerge = require('deepmerge');

const querySelectorShadowDomPlugin = require('query-selector-shadow-dom/plugins/protractor');   // eslint-disable-line @typescript-eslint/no-var-requires

/**
 * @private
 */
export class ProtractorFrameworkAdapter {
    constructor(
        private readonly serenity: Serenity,
        private readonly protractorRunner: Runner,
        private readonly detector: TestRunnerDetector,
    ) {
    }

    /**
     * @param specs
     *  Paths to spec files
     */
    run(specs: string[]): Promise<ProtractorReport> {

        if (! this.protractorRunner.plugins_?.pluginObjs?.some(plugin => plugin.name === querySelectorShadowDomPlugin.name)) {
            this.protractorRunner.plugins_?.pluginObjs?.push(querySelectorShadowDomPlugin);
        }

        const runner    = this.detector.runnerFor(this.protractorRunner.getConfig());
        const reporter  = new ProtractorReporter(this.protractorRunner, runner.successThreshold());

        const config    = deepmerge<Config>(this.defaultConfig(), this.protractorRunner.getConfig(), {
            isMergeableObject: isRecord,
        });

        this.serenity.configure({
            cueTimeout:         config.serenity.cueTimeout,
            interactionTimeout: config.serenity.interactionTimeout,

            diffFormatter:  config.serenity.diffFormatter ?? new AnsiDiffFormatter(),

            actors:         config.serenity.actors || Cast.where(actor => actor.whoCan(
                BrowseTheWebWithProtractor.using(protractor.browser),
                TakeNotes.usingAnEmptyNotepad(),
                CallAnApi.using({
                    baseURL: config.baseUrl,
                })
            )),

            crew:           [
                BrowserDetector.with(StandardisedCapabilities.of(() => protractor.browser)),
                ...config.serenity.crew,
                reporter,
            ],
        });

        return Promise.resolve()
            .then(() => this.protractorRunner.runTestPreparer(TestRunnerDetector.protractorCliOptions()))
            .then(() => runner.load(specs))
            .then(() => runner.run())
            .then(() => (config.onComplete || noop)())
            .then(() => reporter.report());
    }

    private defaultConfig(): Config {
        return {
            serenity: {
                crew: [
                    ArtifactArchiver.storingArtifactsAt(process.cwd(), 'target/site/serenity'),
                ],
            },
        };
    }
}

/** @private */
function noop() {
    // no-op
}