A place to start

jan-molak · jan-molak · commit b8c62d96f4ed · 2017-05-16T13:09:08.000+01:00
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,13 @@
+# IntelliJ
+.idea
+*.iml
+
+# Node
+node_modules
+target/
+*.log
+
+# Build artifacts
+.nyc_output
+lib
+staging
diff --git a/features/saving_time/journey_planner.feature b/features/saving_time/journey_planner.feature
@@ -0,0 +1,12 @@
+Feature: Journey Planner
+
+  As a commuter,
+   I’d like to know the fastest route between two stations,
+   So that I get to my destination as quickly as possible
+
+  Scenario: Connie looks for the next train
+
+    Given Jubilee line trains from Stratford leave Canary Wharf at 16:59, 17:01, 17:03, 17:09
+     When Connie wants to travel from Canary Wharf to Waterloo Underground Station at 17:00, avoiding travelling by Bus, National Rail
+     Then she should be told about the trains departing at 16:59, 17:01, 17:03
+
diff --git a/features/step_definitions/journey_planner.steps.ts b/features/step_definitions/journey_planner.steps.ts
@@ -0,0 +1,62 @@
+import {
+    AvoidTravelling,
+    Check,
+    ChooseDestination,
+    ChooseOrigin,
+    ChooseTime,
+    ConfirmSelection,
+    SpecifyPreferences,
+} from '../../src/journey_planner';
+
+import { Navigate, PlanAJourney } from '../../src';
+
+import { following } from '../../src/text';
+
+import { containTrainsDepartingAt } from '../../src/journey_planner/questions/journeys_found';
+
+export = function journeyPlannerSteps() {
+
+    this.Given(/(.*) line trains from (.*) leave (.*) at (.*)$/, function(tubeLine, origin, station, departureTimes) {
+        // return this.stage.theActorCalled('Adam the admin').attemptsTo(
+            // ... Perform some data setup tasks
+        // );
+    });
+
+    this.When(/(.*) wants to travel from (.*) to (.*) at (.*), avoiding travelling by (.*)$/, function(name, origin, destination, departureTime, ignoredTravelOptions) {
+
+        return this.stage.theActorCalled(name).attemptsTo(
+
+            PlanAJourney.from(origin).
+                to(destination).
+                departingAt(departureTime).
+                avoiding(ignoredTravelOptions),
+
+            // Note: The `PlanAJourney` task above is a composite of the below sub-tasks.
+            //       If you'd like, you could use them here instead:
+
+            // Navigate.to('https://tfl.gov.uk/'),
+            //
+            // ChooseOrigin.of(origin),
+            // ChooseDestination.of(destination),
+            // ChooseTime.ofDeparture(departureTime),
+            // SpecifyPreferences.to(
+            //     AvoidTravelling.by(following(ignoredTravelOptions)),
+            // ),
+            // ConfirmSelection(),
+        );
+    });
+
+    this.Then(/s?he should be told about the trains departing at (.*)$/, function(departureTimes) {
+
+        return this.stage.theActorInTheSpotlight().attemptsTo(
+
+            Check.ifJourneysFound(containTrainsDepartingAt(following(departureTimes))),
+
+            // Note: the `Check` task above is a composite of the below sub-tasks:
+
+            // Wait.until(JourneyPlanner.Results, Is.visible()),
+            // Scroll.to(JourneyPlanner.Results),
+            // See.if(Journeys.found(), containTrainsDepartingAt(following(departureTimes))),
+        );
+    });
+};
diff --git a/features/support/world.ts b/features/support/world.ts
@@ -0,0 +1,11 @@
+import { serenity } from 'serenity-js';
+import { Actors } from '../../src/actors';
+
+export = function() {
+
+    this.setDefaultTimeout(60 * 1000);
+
+    this.World = function() {
+        this.stage = serenity.callToStageFor(new Actors());
+    };
+};
diff --git a/package.json b/package.json
@@ -0,0 +1,44 @@
+{
+  "name": "tutorial-journey-planner",
+  "version": "1.0.0",
+  "description": "Serenity.js with Protractor and Cucumber",
+  "main": "index.js",
+  "scripts": {
+    "clean": "rimraf target",
+    "lint": "tslint --config ./tslint.json --project ./tsconfig.json --format stylish",
+    "pretest": "serenity update",
+    "pree2e": "npm run lint && npm run webdriver:update -- --standalone --versions.standalone=2.53.1 --versions.chrome=2.29",
+    "e2e": "protractor ./protractor.conf.js --cucumberOpts.name 'Connie looks for the next train'",
+    "report": "serenity run",
+    "test": "failsafe e2e report",
+    "webdriver:update": "webdriver-manager update"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/serenity-js/tutorial-journey-planner.git"
+  },
+  "author": "Jan Molak <jan.molak@smartcodeltd.co.uk>",
+  "license": "Apache-2.0",
+  "dependencies": {},
+  "devDependencies": {
+    "@types/chai": "3.5.2",
+    "@types/chai-as-promised": "0.0.30",
+    "@types/node": "7.0.18",
+    "chai": "3.5.0",
+    "chai-as-promised": "6.0.0",
+    "chai-smoothie": "0.x",
+    "cucumber": "1.3.2",
+    "npm-failsafe": "0.x",
+    "protractor": "5.1.1",
+    "rimraf": "2.6.1",
+    "serenity-cli": "^0.1.4",
+    "serenity-js": "^1.x",
+    "ts-node": "3.0.2",
+    "tslint": "5.1.0",
+    "tslint-microsoft-contrib": "5.0.0",
+    "typescript": "2.2.2"
+  },
+  "engines": {
+    "node": ">= 6.9.x"
+  }
+}
diff --git a/protractor.conf.js b/protractor.conf.js
@@ -0,0 +1,27 @@
+exports.config = {
+
+    baseUrl: 'https://tfl.gov.uk',
+
+    allScriptsTimeout: 110000,
+
+    framework: 'custom',
+    frameworkPath: require.resolve('serenity-js'),
+
+    specs: [ 'features/**/*.feature' ],
+    cucumberOpts: {
+        require:    [ 'features/**/*.ts' ],
+        format:     'pretty',
+        compiler:   'ts:ts-node/register'
+    },
+
+    capabilities: {
+        browserName: 'chrome',
+        chromeOptions: {
+            args: [
+                // 'incognito',
+                // 'disable-extensions',
+                // 'show-fps-counter=true'
+            ]
+        }
+    }
+};
diff --git a/readme.md b/readme.md
@@ -0,0 +1,33 @@
+# Journey Planner
+
+
+
+This project demonstrates how a Serenity/JS test scenario can interact with 
+a non-Angular app - the [TFL's Journey Planner](https://tfl.gov.uk/) 
+and acts as a supporting material for my Devoxx UK 2017 talk ["Test-driving modern web apps at scale"](https://cfp.devoxx.co.uk/2017/talk/UTM-3900/Test-driving_modern_web_apps._At_scale._)
+
+To run the example:
+```
+npm install
+npm test
+```
+
+Once the test execution is complete, you'll find the test report at:
+
+```
+target/site/serenity/index.html
+```
+
+To remove the test report and start fresh run:
+
+```
+npm run clean
+```
+
+Please make sure that you're using the latest [long-term support](https://nodejs.org/en/download/) of Node.js
+
+----
+
+Have fun!
+
+[Jan Molak](https://janmolak.com)
diff --git a/src/actors.ts b/src/actors.ts
@@ -0,0 +1,12 @@
+import { protractor } from 'protractor';
+import { Actor, BrowseTheWeb, Cast } from 'serenity-js/lib/screenplay-protractor';
+
+// note: it's important to use `protractor.browser` not simply `browser`
+//       a bug in Protractor makes the latter to fail upon a browser restart
+//       see: https://github.com/angular/protractor/issues/2001
+
+export class Actors implements Cast {
+    actor(name: string): Actor {
+        return Actor.named(name).whoCan(BrowseTheWeb.using(protractor.browser));
+    }
+}
diff --git a/src/expect.ts b/src/expect.ts
@@ -0,0 +1,6 @@
+import chai = require('chai');
+import chaiAsPromised = require('chai-as-promised');
+
+chai.use(chaiAsPromised);
+
+export const expect = chai.expect;
diff --git a/src/index.ts b/src/index.ts
@@ -0,0 +1,3 @@
+export * from './actors';
+export * from './navigate';
+export * from './plan_a_journey';
diff --git a/src/journey_planner/avoid_travelling.ts b/src/journey_planner/avoid_travelling.ts
@@ -0,0 +1,21 @@
+import { Click } from 'serenity-js/lib/serenity-protractor';
+import { step } from 'serenity-js/lib/serenity/recording';
+import { PerformsTasks, Task } from 'serenity-js/lib/serenity/screenplay';
+
+import { JourneyPlannerPreferences } from './ui/journey_planner_preferences';
+
+export class AvoidTravelling implements Task {
+    static by(options: string[]) {
+        return new AvoidTravelling(options);
+    }
+
+    @step('#actor chooses to avoid travelling by #options')
+    performAs(actor: PerformsTasks): PromiseLike<void> {
+        return actor.attemptsTo(
+            ...this.options.map(option => Click.on(JourneyPlannerPreferences.Journey_Option.of(option))),
+        );
+    }
+
+    constructor(private options: string[]) {
+    }
+}
diff --git a/src/journey_planner/check.ts b/src/journey_planner/check.ts
@@ -0,0 +1,11 @@
+import { Is, Scroll, See, Task, Wait } from 'serenity-js/lib/screenplay-protractor';
+import { Assertion } from 'serenity-js/lib/serenity/screenplay/expectations';
+
+import { Journeys, JourneySummary } from '../../src/journey_planner/questions/journeys_found';
+import { JourneyPlanner } from '../../src/journey_planner/ui';
+
+export const Check = { ifJourneysFound: (assertion: Assertion<JourneySummary[]>) => Task.where(`#actor checks the results`,
+    Wait.until(JourneyPlanner.Results, Is.visible()),
+    Scroll.to(JourneyPlanner.Results),
+    See.if(Journeys.found(), assertion),
+)};
diff --git a/src/journey_planner/choose_origin_and_destination.ts b/src/journey_planner/choose_origin_and_destination.ts
@@ -0,0 +1,25 @@
+import { protractor } from 'protractor';
+import { Enter, Hit, Is, Target, Wait } from 'serenity-js/lib/serenity-protractor';
+import { Task } from 'serenity-js/lib/serenity/screenplay';
+
+import { JourneyPlanner } from './ui';
+
+export const ChooseOrigin = { of: (origin: string) => Task.where(`#actor wants to travel from ${origin}`,
+    Enter.theValue(origin).into(JourneyPlanner.Origin_Field),
+    PickTheFirstSuggestion.of(JourneyPlanner.Origin_Field).from(JourneyPlanner.Origin_Suggestions),
+)};
+
+export const ChooseDestination = { of: (destination: string) => Task.where(`#actor wants to travel to ${destination}`,
+    Enter.theValue(destination).into(JourneyPlanner.Destination_Field),
+    PickTheFirstSuggestion.of(JourneyPlanner.Destination_Field).from(JourneyPlanner.Destination_Suggestions),
+)};
+
+const PickTheFirstSuggestion = {
+    of: (field: Target) => ({
+        from: (suggestions: Target) => Task.where(`#actor picks the first suggestion for ${field} from ${suggestions}`,
+            Wait.until(suggestions, Is.visible()),
+            Hit.the(protractor.Key.ARROW_DOWN).into(field),
+            Hit.the(protractor.Key.ENTER).into(field),
+        ),
+    }),
+};
diff --git a/src/journey_planner/choose_time.ts b/src/journey_planner/choose_time.ts
@@ -0,0 +1,17 @@
+import { Click, Select } from 'serenity-js/lib/serenity-protractor';
+import { Task } from 'serenity-js/lib/serenity/screenplay';
+import { JourneyPlanner } from './ui';
+
+export const ChooseTime = {
+    ofDeparture: (time: string) => Task.where(`#actor wants to depart at ${time}`,
+        Click.on(JourneyPlanner.Change_Time_Link),
+        Click.on(JourneyPlanner.Leaving_Button),
+        Select.theValue(time).from(JourneyPlanner.Time_Selector),
+    ),
+
+    ofArrival: (time: string) => Task.where(`#actor wants to depart at ${time}`,
+        Click.on(JourneyPlanner.Change_Time_Link),
+        Click.on(JourneyPlanner.Arriving_Button),
+        Select.theValue(time).from(JourneyPlanner.Time_Selector),
+    ),
+};
diff --git a/src/journey_planner/confirm_selection.ts b/src/journey_planner/confirm_selection.ts
@@ -0,0 +1,8 @@
+import { Click } from 'serenity-js/lib/serenity-protractor';
+import { Task } from 'serenity-js/lib/serenity/screenplay';
+
+import { JourneyPlanner } from './ui';
+
+export const ConfirmSelection = () => Task.where(`#actor confirms their selection`,
+    Click.on(JourneyPlanner.Plan_My_Journey),
+);
diff --git a/src/journey_planner/index.ts b/src/journey_planner/index.ts
@@ -0,0 +1,6 @@
+export * from './avoid_travelling';
+export * from './check';
+export * from './choose_origin_and_destination';
+export * from './choose_time';
+export * from './confirm_selection';
+export * from './specify_preferences';
diff --git a/src/journey_planner/questions/journeys_found.ts b/src/journey_planner/questions/journeys_found.ts
@@ -0,0 +1,36 @@
+import { BrowseTheWeb, Target } from 'serenity-js/lib/serenity-protractor';
+
+import { by } from 'protractor';
+import { Question, UsesAbilities } from 'serenity-js/lib/serenity/screenplay';
+import { expect } from '../../expect';
+
+export interface JourneySummary {
+    departureTime: string;
+    arrivalTime:   string;
+}
+
+export class Journeys implements Question<JourneySummary[]> {
+
+    static found = () => new Journeys();
+
+    answeredBy(actor: UsesAbilities): PromiseLike<JourneySummary[]> {
+        return BrowseTheWeb.as(actor).locateAll(
+            Target.the('results').located(by.css('.publictransport-box')),
+        ).map(result => result.all(by.css('.time-boxes .time-box .time')).getText().then(times => ({
+            departureTime: times[0],
+            arrivalTime:   times[1],
+        }))) as PromiseLike<JourneySummary[]>;
+    }
+
+    toString = () => `the results`;
+}
+
+export const containTrainsDepartingAt = (expectedDepartureTimes: string[]) => foundJourneys => {
+    return foundJourneys.then(journeys => {
+        expect(journeys).to.have.lengthOf(expectedDepartureTimes.length);
+
+        journeys.forEach(journey => {
+            expect(journey.departureTime).to.to.be.oneOf(expectedDepartureTimes);
+        });
+    });
+};
diff --git a/src/journey_planner/specify_preferences.ts b/src/journey_planner/specify_preferences.ts
@@ -0,0 +1,21 @@
+import { Click } from 'serenity-js/lib/serenity-protractor';
+import { PerformsTasks, Task } from 'serenity-js/lib/serenity/screenplay';
+import { JourneyPlanner } from './ui';
+
+export class SpecifyPreferences implements Task {
+    static to(...tasks: Task[]) {
+        return new SpecifyPreferences(tasks);
+    }
+
+    performAs(actor: PerformsTasks): PromiseLike<void> {
+        return actor.attemptsTo(
+            Click.on(JourneyPlanner.Edit_Preferences_Link),
+            ...this.tasks,
+        );
+    }
+
+    toString = () => `#actor specifies their preferences`;
+
+    constructor(private tasks: Task[]) {
+    }
+}
diff --git a/src/journey_planner/ui/index.ts b/src/journey_planner/ui/index.ts
@@ -0,0 +1,2 @@
+export * from './journey_planner_form';
+export * from './journey_planner_preferences';
diff --git a/src/journey_planner/ui/journey_planner_form.ts b/src/journey_planner/ui/journey_planner_form.ts
diff --git a/src/journey_planner/ui/journey_planner_preferences.ts b/src/journey_planner/ui/journey_planner_preferences.ts
diff --git a/src/navigate.ts b/src/navigate.ts
diff --git a/src/plan_a_journey.ts b/src/plan_a_journey.ts
diff --git a/src/text.ts b/src/text.ts
diff --git a/tsconfig.json b/tsconfig.json
diff --git a/tslint.json b/tslint.json

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+export * from './actors';`
	`2`	`+export * from './navigate';`
	`3`	`+export * from './plan_a_journey';`