@serenity-js/web
Version:
Serenity/JS Screenplay Pattern library offering a flexible, web driver-agnostic approach for interacting with web-based user interfaces and components, suitable for various testing contexts
252 lines • 9.45 kB
JavaScript
;
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || (function () {
var ownKeys = function(o) {
ownKeys = Object.getOwnPropertyNames || function (o) {
var ar = [];
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
return ar;
};
return ownKeys(o);
};
return function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
__setModuleDefault(result, mod);
return result;
};
})();
Object.defineProperty(exports, "__esModule", { value: true });
exports.Photographer = void 0;
const core_1 = require("@serenity-js/core");
const events_1 = require("@serenity-js/core/lib/events");
const strategies = __importStar(require("./strategies"));
/**
* The Photographer is a [`StageCrewMember`](https://serenity-js.org/api/core/interface/StageCrewMember/) who takes screenshots
* using the web browser associated with the [actor](https://serenity-js.org/api/core/class/Actor/) that is
* currently [in the spotlight](https://serenity-js.org/api/core/function/actorInTheSpotlight/).
*
* ## Registering Photographer programmatically
*
* ```ts
* import { configure, ArtifactArchiver } from '@serenity-js/core'
* import { Photographer, TakePhotosOfFailures } from '@serenity-js/web'
*
* configure({
* crew: [
* ArtifactArchiver.storingArtifactsAt(process.cwd(), 'target/site/serenity'),
* Photographer.whoWill(TakePhotosOfFailures),
* ]
* })
* ```
*
* ## Using Photographer with Playwright Test
*
* ```ts
* // playwright.config.ts
* import { defineConfig } from '@playwright/test'
* import type { SerenityFixtures, SerenityWorkerFixtures } from '@serenity-js/playwright-test'
*
* export default defineConfig<SerenityFixtures, SerenityWorkerFixtures>({
* reporter: [
* [ '@serenity-js/playwright-test', {
* crew: [
* '@serenity-js/serenity-bdd',
* [ '@serenity-js/core:ArtifactArchiver', { outputDirectory: 'target/site/serenity' } ],
* ]
* // other Serenity/JS config
* }]
* ],
*
* use: {
* crew: [
* [ '@serenity-js/web:Photographer', {
* strategy: 'TakePhotosOfFailures',
* // strategy: 'TakePhotosOfInteractions',
* } ]
* ],
* },
* })
* ```
*
* #### Learn more
* - [`SerenityFixtures`](https://serenity-js.org/api/playwright-test/interface/SerenityFixtures/)
* - [`SerenityWorkerFixtures`](https://serenity-js.org/api/playwright-test/interface/SerenityWorkerFixtures/)
*
* ## Using Photographer with WebdriverIO
*
* ```ts
* // wdio.conf.ts
* import { ArtifactArchiver } from '@serenity-js/core'
* import { WebdriverIOConfig } from '@serenity-js/webdriverio'
*
* export const config: WebdriverIOConfig= {
*
* // Tell WebdriverIO to use Serenity/JS framework
* framework: '@serenity-js/webdriverio',
*
* serenity: {
* // Configure Serenity/JS to use an appropriate test runner adapter
* runner: 'cucumber',
* // runner: 'mocha',
* // runner: 'jasmine',
*
* // register custom Actors class to configure your Serenity/JS actors
* actors: new Actors(),
*
* // Register StageCrewMembers we've imported at the top of this file
* crew: [
* '@serenity-js/serenity-bdd',
* [ '@serenity-js/core:ArtifactArchiver', { outputDirectory: 'target/site/serenity' } ],
* [ '@serenity-js/web:Photographer', {
* strategy: 'TakePhotosOfFailures',
* // strategy: 'TakePhotosOfInteractions',
* } ]
* ]
* },
*
* // ... rest of the config omitted for brevity
* }
* ```
*
* ## Using Photographer with Protractor
*
* ```ts
* // protractor.conf.js
* exports.config = {
*
* // Tell Protractor to use the Serenity/JS framework Protractor Adapter
* framework: 'custom',
* frameworkPath: require.resolve('@serenity-js/protractor/adapter'),
*
* serenity: {
* runner: 'jasmine',
* // runner: 'cucumber',
* // runner: 'mocha',
* crew: [
* @serenity-js/serenity-bdd',
* '@serenity-js/core:ArtifactArchiver', { outputDirectory: 'target/site/serenity' } ],
* '@serenity-js/web:Photographer', {
* strategy: 'TakePhotosOfFailures',
* // strategy: 'TakePhotosOfInteractions',
* ]
* ]
* },
*
* // ... rest of the config omitted for brevity
* }
* ```
*
* ## Taking photos only upon failures only
*
* ```ts
* import { Photographer, TakePhotosOfFailures } from '@serenity-js/web'
*
* Photographer.whoWill(TakePhotosOfFailures)
* ```
*
* ## Taking photos of all the interactions
*
* ```ts
* import { Photographer, TakePhotosOfInteractions } from '@serenity-js/web'
*
* Photographer.whoWill(TakePhotosOfInteractions)
* ```
*
* ## Taking photos before and after all the interactions
*
* ```ts
* import { Photographer, TakePhotosBeforeAndAfterInteractions } from '@serenity-js/web'
*
* Photographer.whoWill(TakePhotosBeforeAndAfterInteractions)
* ```
*
* ## Learn more
* - [`Stage`](https://serenity-js.org/api/core/class/Stage/)
* - [`StageCrewMember`](https://serenity-js.org/api/core/interface/StageCrewMember/)
* - [`TakePhotosBeforeAndAfterInteractions`](https://serenity-js.org/api/web/class/TakePhotosBeforeAndAfterInteractions/)
* - [`TakePhotosOfFailures`](https://serenity-js.org/api/web/class/TakePhotosOfFailures/)
* - [`TakePhotosOfInteractions`](https://serenity-js.org/api/web/class/TakePhotosOfInteractions/)
*
* @group Stage
*/
class Photographer {
photoTakingStrategy;
stage;
/**
* Instantiates a new [`Photographer`](https://serenity-js.org/api/web/class/Photographer/) configured to take photos (screenshots)
* as per the specified [`PhotoTakingStrategy`](https://serenity-js.org/api/web/class/PhotoTakingStrategy/).
*
* @param strategy
* A no-arg constructor function that instantiates a [`PhotoTakingStrategy`](https://serenity-js.org/api/web/class/PhotoTakingStrategy/)
*/
static whoWill(strategy) {
return new Photographer(new strategy());
}
/**
* Instantiates a new [`Photographer`](https://serenity-js.org/api/web/class/Photographer/) configured to take photos (screenshots)
* as per the specified [`PhotoTakingStrategy`](https://serenity-js.org/api/web/class/PhotoTakingStrategy/).
*
* @param config
*/
static fromJSON(config) {
if (config && config.strategy) {
const availableStrategies = Object.keys(strategies).filter(strategy => strategy !== strategies.PhotoTakingStrategy.name); // not the abstract class
if (availableStrategies.includes(config.strategy)) {
return new Photographer(new strategies[config.strategy]());
}
throw new core_1.ConfigurationError(`'${config.strategy}' is not an available PhotoTakingStrategy, ` +
`available strategies: ${availableStrategies.join(', ')}.`);
}
return new Photographer(new strategies.TakePhotosOfFailures());
}
constructor(photoTakingStrategy, stage) {
this.photoTakingStrategy = photoTakingStrategy;
this.stage = stage;
}
/**
* Assigns this [`StageCrewMember`](https://serenity-js.org/api/core/interface/StageCrewMember/) to a given [`Stage`](https://serenity-js.org/api/core/class/Stage/).
*
* @param stage
* An instance of a [`Stage`](https://serenity-js.org/api/core/class/Stage/) this [`StageCrewMember`](https://serenity-js.org/api/core/interface/StageCrewMember/) will be assigned to
*/
assignedTo(stage) {
this.stage = stage;
return this;
}
/**
* Handles [`DomainEvent`](https://serenity-js.org/api/core-events/class/DomainEvent/) objects emitted by the [`Stage`](https://serenity-js.org/api/core/class/Stage/)
* this [`StageCrewMember`](https://serenity-js.org/api/core/interface/StageCrewMember/) is assigned to.
*
* @param event
*/
notifyOf(event) {
if (!this.stage) {
throw new core_1.LogicError(`Photographer needs to be assigned to the Stage before it can be notified of any DomainEvents`);
}
if (!this.stage.theShowHasStarted()) {
return void 0;
}
if (event instanceof events_1.ActivityStarts || event instanceof events_1.ActivityFinished) {
this.photoTakingStrategy.considerTakingPhoto(event, this.stage);
}
}
}
exports.Photographer = Photographer;
//# sourceMappingURL=Photographer.js.map