Skip to content

Commit

Permalink
Expand the production sanity E2E test so it actually requests a booking
Browse files Browse the repository at this point in the history
  • Loading branch information
rwood-moz committed Jan 8, 2025
1 parent 80dfb37 commit cc22b43
Show file tree
Hide file tree
Showing 12 changed files with 325 additions and 29 deletions.
3 changes: 3 additions & 0 deletions .github/workflows/deploy-production.yml
Original file line number Diff line number Diff line change
Expand Up @@ -242,6 +242,9 @@ jobs:
env:
APPT_PROD_LOGIN_EMAIL: ${{ secrets.E2E_APPT_PROD_LOGIN_EMAIL }}
APPT_PROD_LOGIN_PWORD: ${{ secrets.E2E_APPT_PROD_LOGIN_PASSWORD }}
APPT_PROD_DISPLAY_NAME: ${{ secrets.E2E_APPT_PROD_DISPLAY_NAME }}
APPT_PROD_MY_SHARE_LINK: ${{ secrets.E2E_APPT_PROD_MY_SHARE_LINK }}
APPT_BOOKING_REQUESTER_EMAIL: ${{ secrets.E2E_APPT_PROD_BOOKING_REQUESTER_EMAIL }}
steps:
- uses: actions/checkout@v4

Expand Down
3 changes: 3 additions & 0 deletions .github/workflows/nightly-tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,9 @@ jobs:
env:
APPT_PROD_LOGIN_EMAIL: ${{ secrets.E2E_APPT_PROD_LOGIN_EMAIL }}
APPT_PROD_LOGIN_PWORD: ${{ secrets.E2E_APPT_PROD_LOGIN_PASSWORD }}
APPT_PROD_DISPLAY_NAME: ${{ secrets.E2E_APPT_PROD_DISPLAY_NAME }}
APPT_PROD_MY_SHARE_LINK: ${{ secrets.E2E_APPT_PROD_MY_SHARE_LINK }}
APPT_BOOKING_REQUESTER_EMAIL: ${{ secrets.E2E_APPT_PROD_BOOKING_REQUESTER_EMAIL }}
steps:
- uses: actions/checkout@v4

Expand Down
12 changes: 12 additions & 0 deletions test/e2e/.env.example
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,19 @@

# URLs
APPT_PROD_URL=https://appointment.day/
APPT_PROD_SHORT_SHARE_LINK_PREFIX=https://apmt.day/
APPT_PROD_LONG_SHARE_LINK_PREFIX=https://appointment.day/user/

# Production sign-in (FxA) credentials
APPT_PROD_LOGIN_EMAIL=
APPT_PROD_LOGIN_PWORD=

# Appointment user display name (settings => account => display name) for above user
APPT_PROD_DISPLAY_NAME=

# Production booking share link for the existing user above (settings => account => my link)
APPT_PROD_MY_SHARE_LINK=

# Booking requester's email address (used when a booking slot is requested via the share link)
# Important: real appointment booking emails will be sent here
APPT_BOOKING_REQUESTER_EMAIL=
23 changes: 20 additions & 3 deletions test/e2e/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ Guide for running the Thunderbird Appointment E2E tests.

You must have a pre-existing Appointment user test account (using FxA credentials) on the platform where you are running the tests. ie. For the production sanity test you must have an Appointment test account on production (using production FxA credentials) already set up.

The tests expect that default Appointment application settings exist for the provided test user; for example the user scheduling availability hasn't been changed from the default settings; and the default calendar view is the current month view. This is important so that the tests can find an available booking slot, etc.

## Installation

First install the E2E suite (includes Playwright):
Expand All @@ -23,17 +25,29 @@ npx playwright install

## Running Locally

The E2E tests require credentials for an existing Appointment (FxA) account and reads these from your local env vars. First copy over the provided `.example.env` to a local `.env`:
The E2E tests require credentials for an existing Appointment (FxA) account and reads these from your local env vars.
This includes the existing Appointment account's email address, password, user's display name and share link.
<br><br>
The display name is found in Appointment => Settings => Account => Display name.
<br><br>
The share link is found in Appointment => Settings => Account => My Link.
<br><br>
The tests also require an email address to be used when actually requesting bookings. This is the email address entered on the `Book selection` dialog (after an appoitment slot was selected on the booking share link page). Note that real Appointment emails will be sent to this email address.
<br><br>
First copy over the provided `.example.env` to a local `.env`:

```bash
cd test/e2e
cp .env.example .env
```

Then edit your local `.env` file and provide the credentials for your Appointment test account:
Then edit your local `.env` file and provide the following values:
```dotenv
APPT_PROD_LOGIN_EMAIL=<existing-test-FxA-user-email>
APPT_PROD_LOGIN_PWORD=<exisiting-test-FxA-user-password>
APPT_PROD_DISPLAY_NAME=<appointment-user-display-name>
APPT_PROD_MY_SHARE_LINK=<apointment-user-share-link>
APPT_BOOKING_REQUESTER_EMAIL=<booking-requesters-email>
```

To run the production sanity test headless (still in `test/e2e`):
Expand All @@ -60,11 +74,14 @@ You can run the E2E tests from your local machine but against browsers provided

<b>For security reasons when running the tests on BrowserStack I recommend that you use a dedicated test Appointment FxA account / credentials (NOT your own personal Appointment (FxA) credentials).</b>

Once you have credentials for an existing Appointemnt test account, edit your local `.env` file and add the credentials:
Once you have credentials for an existing Appointemnt test account, edit your local `.env` file and add these details (more information found above):

```dotenv
APPT_PROD_LOGIN_EMAIL=<existing-test-FxA-user-email>
APPT_PROD_LOGIN_PWORD=<exisiting-test-FxA-user-password>
APPT_PROD_DISPLAY_NAME=<appointment-user-display-name>
APPT_PROD_MY_SHARE_LINK=<apointment-user-share-link>
APPT_BOOKING_REQUESTER_EMAIL=<booking-requesters-email>
```

Also in order to run on BrowserStack you need to provide your BrowserStack credentials. Sign into your BrowserStack account and navigate to your `User Profile` and find your auth username and access key. In your local terminal export the following env vars to set the BrowserStack credentials that the tests will use:
Expand Down
6 changes: 5 additions & 1 deletion test/e2e/browserstack.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,14 @@ platforms:
osVersion: Sequoia
browserName: playwright-firefox
browserVersion: latest
playwrightConfigOptions:
name: Firefox-OSX
- os: OS X
osVersion: Sequoia
browserName: playwright-chromium
browserVersion: latest
playwrightConfigOptions:
name: Chromium-OSX

# =======================
# Parallels per Platform
Expand Down Expand Up @@ -63,7 +67,7 @@ browserstackLocal: false # <boolean> (Default false)
# ===================
debug: false # <boolean> # Set to true if you need screenshots for every selenium command ran
networkLogs: false # <boolean> Set to true to enable HAR logs capturing; off as may contain sensitive info like login API requests
consoleLogs: errors # <string> Remote browser's console debug levels to be printed (Default: errors)
consoleLogs: info # <string> Remote browser's console debug levels to be printed (Default: errors)
# Available options are `disable`, `errors`, `warnings`, `info`, `verbose` (Default: errors)
framework: playwright
browserstack.playwrightLogs: false # disable playwright logs appearing on browserstack builds as may contain sensitive info like credentials
Expand Down
11 changes: 10 additions & 1 deletion test/e2e/const/constants.ts
Original file line number Diff line number Diff line change
@@ -1,10 +1,19 @@
// appointment urls
export const APPT_PROD_URL = process.env.APPT_PROD_URL;
export const APPT_PROD_MY_SHARE_LINK = String(process.env.APPT_PROD_MY_SHARE_LINK);
export const APPT_PROD_SHORT_SHARE_LINK_PREFIX = String(process.env.APPT_PROD_SHORT_SHARE_LINK_PREFIX);
export const APPT_PROD_LONG_SHARE_LINK_PREFIX = String(process.env.APPT_PROD_LONG_SHARE_LINK_PREFIX);

// page titles
export const APPT_PAGE_TITLE = 'Thunderbird Appointment';
export const FXA_PAGE_TITLE = 'Mozilla accounts';

// production sign-in credentials
// production sign-in credentials and corresponding account display name
export const PROD_LOGIN_EMAIL = process.env.APPT_PROD_LOGIN_EMAIL;
export const PROD_LOGIN_PWORD = process.env.APPT_PROD_LOGIN_PWORD;

// appointment user display name (settings => account) for above user
export const PROD_DISPLAY_NAME = String(process.env.APPT_PROD_DISPLAY_NAME);

// appointment requester's email address
export const APPT_BOOKING_REQUESTER_EMAIL = String(process.env.APPT_BOOKING_REQUESTER_EMAIL);
165 changes: 165 additions & 0 deletions test/e2e/pages/booking-page.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,165 @@
import { expect } from '@playwright/test';
import { type Page, type Locator } from '@playwright/test';
import { APPT_PROD_MY_SHARE_LINK, APPT_PROD_SHORT_SHARE_LINK_PREFIX, APPT_PROD_LONG_SHARE_LINK_PREFIX } from '../const/constants';

export class BookingPage {
readonly page: Page;
readonly titleText: Locator;
readonly invitingText: Locator;
readonly confirmBtn: Locator;
readonly bookingCalendar: Locator;
readonly calendarHeader: Locator;
readonly nextMonthArrow: Locator;
readonly availableBookingSlot: Locator;
readonly bookSelectionNameInput: Locator;
readonly bookSelectionEmailInput: Locator;
readonly bookSelectionBookBtn: Locator;
readonly requestSentTitleText: Locator;
readonly requestSentAvailabilityText: Locator;
readonly requestSentBookingSlot: Locator;
readonly requestSentCloseBtn: Locator;

constructor(page: Page) {
this.page = page;
this.titleText = this.page.getByTestId('booking-view-title-text');
this.invitingText = this.page.getByTestId('booking-view-inviting-you-text');
this.bookingCalendar = this.page.getByTestId('booking-view-calendar-div');
this.confirmBtn = this.page.getByTestId('booking-view-confirm-selection-button');
this.calendarHeader = this.page.locator('.calendar-header__period-name');
this.nextMonthArrow = this.page.locator('[data-icon="chevron-right"]');
this.availableBookingSlot = this.page.locator('[data-test="day-event"]', { hasNotText: 'Busy'});
this.bookSelectionNameInput = this.page.getByPlaceholder('First and last name');
this.bookSelectionEmailInput = this.page.getByPlaceholder('[email protected]');
this.bookSelectionBookBtn = this.page.getByRole('button', { name: 'Book' });
this.requestSentTitleText = this.page.getByText('Booking request sent');
this.requestSentAvailabilityText = this.page.getByText("'s Availability");
this.requestSentBookingSlot = this.page.locator('.todo');
this.requestSentCloseBtn = this.page.getByRole('button', { name: 'Close' });
}

/**
* Navigate to the booking page using the share link short URL.
*/
async gotoBookingPageShortUrl() {
// the default share link is a short URL
await this.page.goto(APPT_PROD_MY_SHARE_LINK);
await this.page.waitForLoadState('domcontentloaded');
}

/**
* Navigatge to the booking page using the share link long URL.
*/
async gotoBookingPageLongUrl() {
// the share link is short by default; build the corresponding long link first
const prodShareLinkUser: string = APPT_PROD_MY_SHARE_LINK.split(APPT_PROD_SHORT_SHARE_LINK_PREFIX)[1];
const longLink: string = `${APPT_PROD_LONG_SHARE_LINK_PREFIX}${prodShareLinkUser}`;
await this.page.goto(longLink);
await this.page.waitForLoadState('domcontentloaded');
}

/**
* Go to the booking page week view (via the booking share link)
*/
async gotoBookingPageWeekView() {
const weekLink: string = `${APPT_PROD_MY_SHARE_LINK}#week`;
await this.page.goto(weekLink);
await this.page.waitForLoadState('domcontentloaded');
await this.confirmBtn.isVisible();
}

/**
* With the booking page week view already displayed, go forward to the next week.
*/
async goForwardOneWeek() {
await this.nextMonthArrow.click();
await this.page.waitForLoadState('domcontentloaded');
await this.confirmBtn.isVisible();
}

/**
* With the booking page week view already displayed, select the first available booking slot.
* If there is no slot available on the current week, this methond will skip to the next week
* and look for slots there. If no slots are avaible on the next week either, then an error
* will be raised.
* @param userDisplayName String containing the display name of the Appointment user
* @returns String containing the reference text for the time slot that was requested
* as retrieved from the DOM ie. 'event-2025-01-08 09:30'.
*/
async selectAvailableBookingSlot(userDisplayName: string): Promise<string> {
// let's check if a non-busy appointment slot exists in the current week view
const slotCount: number = await this.availableBookingSlot.count();
console.log(`available slot count: ${slotCount}`);

// if no slots are available in current week view then fast forward to next week
if (slotCount === 0) {
console.log('no slots available in current week, skipping ahead to the next week');
await this.goForwardOneWeek();
// now check again for available slots; if none then fail out the test (safety catch but shouldn't happen)
const newSlotCount: number = await this.availableBookingSlot.count();
console.log(`available slot count: ${newSlotCount}`);
expect(newSlotCount, `no booking slots available, please check availability settings for ${userDisplayName}`).toBeGreaterThan(0);
}

// slots are available in current week view so get the first one
const firstSlot: Locator = this.availableBookingSlot.first();
let slotRef = await firstSlot.getAttribute('data-ref'); // ie. 'event-2025-01-08 09:30'
if (!slotRef)
slotRef = 'none';
expect(slotRef).toContain('event-');

// now that we've found an availalbe slot select it and confirm
await firstSlot.click();
return slotRef;
}

/**
* Fill out the 'book selection' dialog with the given values.
* The 'book selection' dialog appears after an appointment slot has been selected (on the
* booking page provided by the share link). This method will fill in the booking requester's
* name and email address and then click the 'book' button to finalize the booking request.
* @param bookerName String to fill in as the booking requester's name
* @param bookerEmail String to fill in as the booking requester's email
*/
async finishBooking(bookerName: string, bookerEmail: string) {
await this.bookSelectionNameInput.fill(bookerName);
await this.bookSelectionEmailInput.fill(bookerEmail);
await this.bookSelectionBookBtn.click();
}

/**
* Verify the given appointment time slot text is displayed in the current page
* @param expSlotDateStr Expected slot date string formatted as 'Friday, January 10, 2025'
* @param expSlotTimeStr Expected time slot time string formatted as '14:30' (24 hr time)
*/
async verifyRequestedSlotTextDisplayed(expSlotDateStr: string, expSlotTimeStr: string) {
// due to the way the element is we must locate by the date text only
const slotDisplayText: Locator = this.page.getByText(expSlotDateStr);
await expect(slotDisplayText).toBeVisible();
// the slot text has been found so now verify it contains both the given date and time
await expect(slotDisplayText).toHaveText(`${expSlotDateStr} ${expSlotTimeStr}`);
}

/**
* Utility to return a string containing the date abstracted from a given time slot string
* @param timeSlotString Slot string read from DOM (ie. 'event-2025-01-14 14:30')
* @returns Formatted date string (ie. 'Tuesday, January 14, 2025')
*/
async getDateFromSlotString(timeSlotString: string): Promise<string> {
const selectedSlotDateTime = new Date(timeSlotString.substring(6));
return selectedSlotDateTime.toLocaleDateString('default', { dateStyle: 'full' });
}

/**
* Utility to return a string containg the time abstracted from a given time slot string.
* The time in the given time slot string is in 24 hour format (i.e. 14:30), but we want
* it to be like '02:30 PM'
* @param timeSlotString Slot string read from DOM (ie. 'event-2025-01-14 14:30')
* @returns Formatted time string (ie. '02:30 PM')
*/
async getTimeFromSlotString(timeSlotString: string): Promise<string> {
const selectedSlotDateTime = new Date(timeSlotString.substring(6));
const expTimeStr = selectedSlotDateTime.toLocaleTimeString('default', { hour12: true, hour: '2-digit', minute: '2-digit' });
// now expTimeStr looks like this, for example: '04:30 p.m.' but need it to be like '04:30 PM'
return expTimeStr.toUpperCase().replace('.', '').replace('.', '');
}
}
3 changes: 1 addition & 2 deletions test/e2e/pages/dashboard-page.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
import { expect, type Page, type Locator } from '@playwright/test';
import exp from 'constants';
import { type Page, type Locator } from '@playwright/test';

export class DashboardPage {
readonly page: Page;
Expand Down
2 changes: 1 addition & 1 deletion test/e2e/playwright.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ export default defineConfig({
/* Opt out of parallel tests on CI. */
workers: process.env.CI ? 1 : 1, // actualy don't run in parallel locally either, for now
// Tests will timeout if still running after this time (ms)
timeout: 3 * 60 * 1000,
timeout: 1 * 60 * 1000,
/* Reporter to use. See https://playwright.dev/docs/test-reporters */
reporter: [['list']],
/* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */
Expand Down
Loading

0 comments on commit cc22b43

Please sign in to comment.