Migrate the E2E tests to the new URLs and use TB Accounts for sign-in (#1314)

* Migrate the E2E tests to the new URLs and use TB Accounts for sign-in

* Remove unused const and import

Author: rwood-moz

.github/workflows/deploy-production.yml

@@ -128,8 +128,8 @@ jobs:
     runs-on: ubuntu-latest
     environment: production
     env:
-      APPT_LOGIN_EMAIL: ${{ secrets.E2E_APPT_PROD_LOGIN_EMAIL }}
-      APPT_LOGIN_PWORD: ${{ secrets.E2E_APPT_PROD_LOGIN_PASSWORD }}
+      TB_ACCTS_EMAIL: ${{ secrets.E2E_APPT_PROD_TB_ACCTS_EMAIL }}
+      TB_ACCTS_PWORD: ${{ secrets.E2E_APPT_PROD_TB_ACCTS_PWORD }}
       APPT_DISPLAY_NAME: ${{ secrets.E2E_APPT_PROD_DISPLAY_NAME }}
       APPT_MY_SHARE_LINK: ${{ secrets.E2E_APPT_PROD_MY_SHARE_LINK }}
       APPT_BOOKEE_EMAIL: ${{ secrets.E2E_APPT_PROD_BOOKEE_EMAIL }}

.github/workflows/deploy-staging.yml

@@ -235,8 +235,8 @@ jobs:
     runs-on: ubuntu-latest
     environment: staging
     env:
-      APPT_LOGIN_EMAIL: ${{ secrets.E2E_APPT_STAGE_LOGIN_EMAIL }}
-      APPT_LOGIN_PWORD: ${{ secrets.E2E_APPT_STAGE_LOGIN_PASSWORD }}
+      TB_ACCTS_EMAIL: ${{ secrets.E2E_APPT_STAGE_TB_ACCTS_EMAIL }}
+      TB_ACCTS_PWORD: ${{ secrets.E2E_APPT_STAGE_TB_ACCTS_PWORD }}
       APPT_DISPLAY_NAME: ${{ secrets.E2E_APPT_STAGE_DISPLAY_NAME }}
       APPT_MY_SHARE_LINK: ${{ secrets.E2E_APPT_STAGE_MY_SHARE_LINK }}
       APPT_BOOKEE_EMAIL: ${{ secrets.E2E_APPT_STAGE_BOOKEE_EMAIL }}

.github/workflows/nightly-tests-desktop.yml

@@ -20,8 +20,8 @@ jobs:
     runs-on: ubuntu-latest
     environment: production
     env:
-      APPT_LOGIN_EMAIL: ${{ secrets.E2E_APPT_PROD_LOGIN_EMAIL }}
-      APPT_LOGIN_PWORD: ${{ secrets.E2E_APPT_PROD_LOGIN_PASSWORD }}
+      TB_ACCTS_EMAIL: ${{ secrets.E2E_APPT_PROD_TB_ACCTS_EMAIL }}
+      TB_ACCTS_PWORD: ${{ secrets.E2E_APPT_PROD_TB_ACCTS_PWORD }}
       APPT_DISPLAY_NAME: ${{ secrets.E2E_APPT_PROD_DISPLAY_NAME }}
       APPT_MY_SHARE_LINK: ${{ secrets.E2E_APPT_PROD_MY_SHARE_LINK }}
       APPT_BOOKEE_EMAIL: ${{ secrets.E2E_APPT_PROD_BOOKEE_EMAIL }}

.github/workflows/nightly-tests-mobile.yml

@@ -20,8 +20,8 @@ jobs:
     runs-on: ubuntu-latest
     environment: production
     env:
-      APPT_LOGIN_EMAIL: ${{ secrets.E2E_APPT_PROD_LOGIN_EMAIL }}
-      APPT_LOGIN_PWORD: ${{ secrets.E2E_APPT_PROD_LOGIN_PASSWORD }}
+      TB_ACCTS_EMAIL: ${{ secrets.E2E_APPT_PROD_TB_ACCTS_EMAIL }}
+      TB_ACCTS_PWORD: ${{ secrets.E2E_APPT_PROD_TB_ACCTS_PWORD }}
       APPT_DISPLAY_NAME: ${{ secrets.E2E_APPT_PROD_DISPLAY_NAME }}
       APPT_MY_SHARE_LINK: ${{ secrets.E2E_APPT_PROD_MY_SHARE_LINK }}
       APPT_BOOKEE_EMAIL: ${{ secrets.E2E_APPT_PROD_BOOKEE_EMAIL }}

backend/src/appointment/database/repo/external_connection.py

@@ -145,12 +145,8 @@ def get_subscriber_without_oidc_by_email(db: Session, email: str):
         .filter(models.ExternalConnections.type == models.ExternalConnectionType.oidc)
         .exists()
     )
-    
+
     # Find subscribers without an OIDC connection that match the email
-    query = (
-        db.query(models.Subscriber)
-        .filter(~oidc_exists)
-        .filter(models.Subscriber.email == email)
-    )
+    query = db.query(models.Subscriber).filter(~oidc_exists).filter(models.Subscriber.email == email)
 
     return query.first()

backend/test/integration/test_auth.py

@@ -854,10 +854,7 @@ def test_oidc_token_not_enabled(self, with_client):
         """Test that endpoint returns 405 when AUTH_SCHEME is not OIDC"""
         os.environ['AUTH_SCHEME'] = 'password'
 
-        response = with_client.post(
-            '/oidc/token',
-            json={'access_token': 'test_token', 'timezone': 'America/Vancouver'}
-        )
+        response = with_client.post('/oidc/token', json={'access_token': 'test_token', 'timezone': 'America/Vancouver'})
 
         assert response.status_code == 405, response.text
 
@@ -870,8 +867,7 @@ def test_oidc_token_invalid_token(self, with_client):
             mock_introspect.return_value = None
 
             response = with_client.post(
-                '/oidc/token',
-                json={'access_token': 'invalid_token', 'timezone': 'America/Vancouver'}
+                '/oidc/token', json={'access_token': 'invalid_token', 'timezone': 'America/Vancouver'}
             )
 
             assert response.status_code == 403, response.text
@@ -887,10 +883,7 @@ def test_oidc_token_existing_subscriber(self, with_client, make_pro_subscriber,
 
         # Create existing OIDC external connection
         make_external_connections(
-            subscriber_id=subscriber.id,
-            type=models.ExternalConnectionType.oidc,
-            type_id=oidc_id,
-            name=subscriber.email
+            subscriber_id=subscriber.id, type=models.ExternalConnectionType.oidc, type_id=oidc_id, name=subscriber.email
         )
 
         # Mock OIDCClient to return valid token data
@@ -903,8 +896,7 @@ def test_oidc_token_existing_subscriber(self, with_client, make_pro_subscriber,
             }
 
             response = with_client.post(
-                '/oidc/token',
-                json={'access_token': 'valid_token', 'timezone': 'America/Vancouver'}
+                '/oidc/token', json={'access_token': 'valid_token', 'timezone': 'America/Vancouver'}
             )
 
             assert response.status_code == 200, response.text
@@ -923,13 +915,12 @@ def test_oidc_token_fallback_match_by_email(self, with_db, with_client, make_pro
             mock_introspect.return_value = {
                 'sub': oidc_id,
                 'email': subscriber.email,
-                'preferred_username': subscriber.email, # preferred_username is the thundermail address
+                'preferred_username': subscriber.email,  # preferred_username is the thundermail address
                 'name': subscriber.name,
             }
 
             response = with_client.post(
-                '/oidc/token',
-                json={'access_token': 'valid_token', 'timezone': 'America/Vancouver'}
+                '/oidc/token', json={'access_token': 'valid_token', 'timezone': 'America/Vancouver'}
             )
 
             assert response.status_code == 200, response.text

test/e2e/.env.dev.example

@@ -5,8 +5,8 @@ APPT_TARGET_ENV=dev
 APPT_URL=http://localhost:8080/
 
 # Local sign-in credentials
-APPT_LOGIN_EMAIL=
-APPT_LOGIN_PWORD=
+TB_ACCTS_EMAIL=
+TB_ACCTS_PWORD=
 
 # Local Appointment user display name (settings => account => display name) for above user
 APPT_DISPLAY_NAME=

test/e2e/.env.prod.example

@@ -2,13 +2,13 @@
 APPT_TARGET_ENV=prod
 
 # URLs
-APPT_URL=https://appointment.day/
-APPT_SHORT_SHARE_LINK_PREFIX=https://apmt.day/
-APPT_LONG_SHARE_LINK_PREFIX=https://appointment.day/user/
+APPT_URL=https://appointment.tb.pro/
+APPT_SHORT_SHARE_LINK_PREFIX=https://apt.mt/
+APPT_LONG_SHARE_LINK_PREFIX=https://appointment.tb.pro/user/
 
-# Sign-in (FxA) credentials
-APPT_LOGIN_EMAIL=
-APPT_LOGIN_PWORD=
+# Sign-in credentials
+TB_ACCTS_EMAIL=
+TB_ACCTS_PWORD=
 
 # Appointment user display name (settings => account => display name) for above user
 APPT_DISPLAY_NAME=
@@ -18,5 +18,5 @@ APPT_MY_SHARE_LINK=
 
 # Booking requester's name and email address (used when a booking slot is requested via the
 # share link). Important: real appointment booking emails will be sent to the provided email.
-APPT_BOOKEE_NAME='Automated-Test-Bot-Prod'
+APPT_BOOKEE_NAME=
 APPT_BOOKEE_EMAIL=

test/e2e/.env.stage.example

@@ -2,13 +2,13 @@
 APPT_TARGET_ENV=stage
 
 # URLs
-APPT_URL=https://stage.appointment.day/
-APPT_SHORT_SHARE_LINK_PREFIX=https://stage.apmt.day/
-APPT_LONG_SHARE_LINK_PREFIX=https://stage.appointment.day/user/
+APPT_URL=https://appointment-stage.tb.pro/
+APPT_SHORT_SHARE_LINK_PREFIX=https://stage.apt.mt/
+APPT_LONG_SHARE_LINK_PREFIX=https://appointment-stage.tb.pro/user/
 
-# Sign-in (FxA) credentials
-APPT_LOGIN_EMAIL=
-APPT_LOGIN_PWORD=
+# Sign-in credentials
+TB_ACCTS_EMAIL=
+TB_ACCTS_PWORD=
 
 # Appointment user display name (settings => account => display name) for above user
 APPT_DISPLAY_NAME=
@@ -18,5 +18,5 @@ APPT_MY_SHARE_LINK=
 
 # Booking requester's name and email address (used when a booking slot is requested via the
 # share link). Important: real appointment booking emails will be sent to the provided email.
-APPT_BOOKEE_NAME='Automated-Test-Bot-Stage'
+APPT_BOOKEE_NAME=
 APPT_BOOKEE_EMAIL=

test/e2e/README.md

@@ -18,8 +18,9 @@ npx playwright install
 ```
 
 ## E2E Test Prerequisites
-The E2E tests require an existing Appointment (and corresponding FxA account) and associated data, and reads this from your local .env file. This includes:
-- Credentials for an existing Appointment (FxA) account (email address, password)
+
+The E2E tests require an existing TB Pro account and other settings that are read this from your local .env file. This includes:
+- Credentials for an existing TB Pro account (TB Pro email and associated password)
 - The account user's display name and share link:
     - The display name is found in Appointment => Settings => Account => Display name.
     - The share link is found in Appointment => Settings => Account => My Link.
@@ -28,7 +29,7 @@ The E2E tests require an existing Appointment (and corresponding FxA account) an
 The tests expect the following Appointment application settings:
 - The user scheduling availability hasn't been changed from the default settings;
 - In the dashboard the default calendar view is the current month view; this is important so that the tests can find an available booking slot, etc.
-- In `Booking Settings`, the `Booking Confirmation` option is enabled, so that requested appointments generate HOLD appointments that need to be confirmed
+- In `Booking Settings`, the `Automatically confirm bookings if time is available` option is checked / turned on
 
 ## Running the E2E tests against your local dev environment
 
@@ -43,8 +44,8 @@ cp .env.dev.example .env
 
 Then edit your local `.env` file and provide the following values:
 ```dotenv
-APPT_LOGIN_EMAIL=<existing-dev-FxA-user-email>
-APPT_LOGIN_PWORD=<exisiting-dev-FxA-user-password>
+TB_ACCTS_EMAIL=<existing-local-account-user-email>
+TB_ACCTS_PWORD=<exisiting-local-user-password>
 APPT_DISPLAY_NAME=<appointment-dev-user-display-name>
 APPT_MY_SHARE_LINK=<apointment-dev-user-share-link>
 APPT_BOOKEE_EMAIL=<booking-requesters-email>
@@ -99,8 +100,8 @@ cp .env.stage.example .env
 
 Then edit your local `.env` file and provide the following values:
 ```dotenv
-APPT_LOGIN_EMAIL=<existing-stage-FxA-user-email>
-APPT_LOGIN_PWORD=<exisiting-stage-FxA-user-password>
+TB_ACCTS_EMAIL=<existing-stage-tb-accounts-user-email>
+TB_ACCTS_PWORD=<exisiting-stage-tb-accounts-user-password>
 APPT_DISPLAY_NAME=<appointment-stage-user-display-name>
 APPT_MY_SHARE_LINK=<apointment-stage-user-share-link>
 APPT_BOOKEE_EMAIL=<booking-requesters-email>
@@ -129,8 +130,8 @@ cp .env.prod.example .env
 
 Then edit your local `.env` file and provide the following values:
 ```dotenv
-APPT_LOGIN_EMAIL=<existing-prod-FxA-user-email>
-APPT_LOGIN_PWORD=<exisiting-prod-FxA-user-password>
+TB_ACCTS_EMAIL=<existing-prod-tb-accounts-user-email>
+TB_ACCTS_PWORD=<exisiting-prod-tb-accounts-user-password>
 APPT_DISPLAY_NAME=<appointment-prod-user-display-name>
 APPT_MY_SHARE_LINK=<apointment-prod-user-share-link>
 APPT_BOOKEE_EMAIL=<booking-requesters-email>
@@ -152,13 +153,13 @@ npm run prod-sanity-test-headed
 
 You can run the E2E tests from your local machine but against browsers provided in the BrowserStack Automate cloud.
 
-<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>
+<b>For security reasons when running the tests on BrowserStack I recommend that you use a dedicated test Appointment account / credentials (NOT your own personal Appointment credentials).</b>
 
-Once you have credentials for an existing Appointemnt test account, edit your local `.env` file and add these details (more information found above):
+Once you have credentials for an existing TB Pro test account, edit your local `.env` file and add these details (more information found above):
 
 ```dotenv
-APPT_LOGIN_EMAIL=<existing-test-FxA-user-email>
-APPT_LOGIN_PWORD=<exisiting-test-FxA-user-password>
+TB_ACCTS_EMAIL=<existing-tb-accounts-user-email>
+TB_ACCTS_PWORD=<exisiting-tb-accounts-user-password>
 APPT_DISPLAY_NAME=<appointment-user-display-name>
 APPT_MY_SHARE_LINK=<apointment-user-share-link>
 APPT_BOOKEE_EMAIL=<booking-requesters-email>