@serenity-js/web 3.0.0-rc.0

package/src/stage/crew/photographer/strategies/TakePhotosBeforeAndAfterInteractions.ts

@@ -0,0 +1,28 @@
+import { DomainEvent, InteractionFinished, InteractionStarts } from '@serenity-js/core/lib/events';
+
+import { PhotoTakingStrategy } from './PhotoTakingStrategy';
+
+/**
+ * @desc
+ *  Configures the {@link Photographer} to take photos (a.k.a. screenshots) both before and after
+ *  every single {@link @serenity-js/core/lib/screenplay~Interaction} performed
+ *  by the {@link @serenity-js/core/lib/screenplay/actor~Actor} in the spotlight.
+ *
+ *  *Please note* that this strategy will result in _a lot_ of screenshots being taken,
+ *  which will seriously affect the performance of your tests.
+ *  For this reason, it's best to use it only for debugging purposes.
+ *
+ * @extends {PhotoTakingStrategy}
+ */
+export class TakePhotosBeforeAndAfterInteractions extends PhotoTakingStrategy {
+    protected shouldTakeAPhotoOf(event: DomainEvent): boolean {
+        return event instanceof InteractionStarts
+            || event instanceof InteractionFinished;
+    }
+
+    protected photoNameFor(event: InteractionStarts | InteractionFinished): string {
+        return event instanceof InteractionStarts
+            ? `Before ${ event.details.name.value }`
+            : `After ${ event.details.name.value }`;
+    }
+}

package/src/stage/crew/photographer/strategies/TakePhotosOfFailures.ts

@@ -0,0 +1,26 @@
+import { DomainEvent, InteractionFinished } from '@serenity-js/core/lib/events';
+import { ImplementationPending } from '@serenity-js/core/lib/model';
+
+import { PhotoTakingStrategy } from './PhotoTakingStrategy';
+
+/**
+ * @desc
+ *  Configures the {@link Photographer} to take photos (a.k.a. screenshots) when
+ *  the {@link @serenity-js/core/lib/screenplay~Interaction} performed
+ *  by the {@link @serenity-js/core/lib/screenplay/actor~Actor} in the spotlight results in an error.
+ *
+ *  This strategy works best when you are interested in the screenshots only when
+ *  a scenario fails.
+ *
+ * @extends {PhotoTakingStrategy}
+ */
+export class TakePhotosOfFailures extends PhotoTakingStrategy {
+    protected shouldTakeAPhotoOf(event: DomainEvent): boolean {
+        return event instanceof InteractionFinished
+            && event.outcome.isWorseThan(ImplementationPending);
+    }
+
+    protected photoNameFor(event: InteractionFinished): string {
+        return event.details.name.value;
+    }
+}

package/src/stage/crew/photographer/strategies/TakePhotosOfInteractions.ts

@@ -0,0 +1,26 @@
+import { DomainEvent, InteractionFinished } from '@serenity-js/core/lib/events';
+
+import { PhotoTakingStrategy } from './PhotoTakingStrategy';
+
+/**
+ * @desc
+ *  Configures the {@link Photographer} to take photos (a.k.a. screenshots) when
+ *  the the {@link @serenity-js/core/lib/screenplay/actor~Actor} in the spotlight
+ *  performs any {@link @serenity-js/core/lib/screenplay~Interaction}.
+ *
+ *  This strategy works best when you want the results of your automated tests
+ *  to become comprehensive living documentation of your system.
+ *
+ *  *Please note* that taking screenshots affects the performance of your tests.
+ *
+ * @extends {PhotoTakingStrategy}
+ */
+export class TakePhotosOfInteractions extends PhotoTakingStrategy {
+    protected shouldTakeAPhotoOf(event: DomainEvent): boolean {
+        return event instanceof InteractionFinished;
+    }
+
+    protected photoNameFor(event: InteractionFinished): string {
+        return event.details.name.value;
+    }
+}

package/src/stage/crew/photographer/strategies/index.ts

@@ -0,0 +1,4 @@
+export * from './PhotoTakingStrategy';
+export * from './TakePhotosBeforeAndAfterInteractions';
+export * from './TakePhotosOfFailures';
+export * from './TakePhotosOfInteractions';

package/src/stage/index.ts

@@ -0,0 +1 @@
+export * from './crew';

package/tsconfig.eslint.json

@@ -0,0 +1,10 @@
+{
+  "extends": "./tsconfig",
+  "include": [
+    "src/**/*.ts",
+    "spec/**/*.ts"
+  ],
+  "exclude": [
+    "node_modules"
+  ]
+}