update readme

Author: thostetler

.env.sample

@@ -0,0 +1,3 @@
+MAILSLURP_API_KEY=
+TEST_EMAIL=
+TEST_PASSWORD=

README.md

@@ -0,0 +1,36 @@
+# UI Integration Testing
+
+## Repository Structure
+
+- **/tests**: Contains all test cases and scenarios.
+- **/perf-results**: Stores performance test results. 
+
+## Getting Started
+
+To set up and run the tests locally:
+
+1. **Clone the Repository**:
+```bash
+   git clone https://github.com/adsabs/ui-integration-testing.git
+   cd ui-integration-testing
+   
+   # Install dependencies
+   pnpm install
+```
+
+2. **Run the Tests**:
+```bash
+   # Run all tests
+   pnpm test
+   
+   # Run tests in watch mode
+   pnpm test:watch
+```
+
+In order to do the account creation tests, you'll need to create a mailslurp API key and set it in the `MAILSLURP_API_KEY` environment variable.
+https://docs.mailslurp.com/api/
+
+For the other account login tests make sure you have a good test account created in the environment and add the `TEST_EMAIL` and `TEST_PASSWORD` environment variables.
+
+The tests watch for these variables and will be skipped if they are not set.
+

tests/ui.adsabs.harvard.edu/smoke/account.spec.ts

@@ -1,5 +1,5 @@
 import { test, expect } from '@playwright/test';
-import {getInbox, getTestEmailAccount, waitForLatestEmail} from '../../../util/email';
+import {ms, getInbox, getTestEmailAccount, waitForLatestEmail, getRandomPassword} from '../../../util/email';
 import {configDotenv} from 'dotenv';
 import { Email } from 'mailslurp-client';
 
@@ -9,7 +9,6 @@ test.use({
   baseURL: 'https://qa.adsabs.harvard.edu'
 });
 
-
 function extractRegisterToken(email: Email): string | null {
   const html = email.body;
   if (typeof html === 'string') {
@@ -21,10 +20,10 @@ function extractRegisterToken(email: Email): string | null {
   throw new Error(`${html} is not a string`)
 }
 
-const password = 'XZHFjvCpDWrF8sAb1d0Npg50nH1xg'
-
 test('Can register an account', async ({ page }) => {
+  test.skip(!ms, 'MailSlurp API key not set');
   const {id, emailAddress} = await getInbox();
+  const password = await getRandomPassword(page);
   await page.goto("/user/account/register");
 
   // fill out form
@@ -65,6 +64,9 @@ test('Can register an account', async ({ page }) => {
 
 test('Can login and get to all settings pages', async ({ page }) => {
   const { emailAddress, password } = getTestEmailAccount();
+  test.skip(!emailAddress, 'TEST_EMAIL not set');
+  test.skip(!password, 'TEST_PASSWORD not set');
+
   await page.goto("/user/account/login");
 
   // fill out form
@@ -115,25 +117,3 @@ test('Can login and get to all settings pages', async ({ page }) => {
   await page.goto('/user/libraries');
   await expect(page.locator('span.h2')).toHaveText('My Libraries');
 });
-
-
-
-
-
-
-// test("register and delete account", async ({ page }) =>{
-//
-//
-//   // go to account page
-//   await page.goto('/user/settings/delete');
-//   page.on('dialog', async dialog => {
-//     await dialog.accept();
-//   });
-//   await page.locator('#delete-account').click();
-//   await page.waitForURL('/user/account/login');
-//   await expect(page).toHaveURL('/user/account/login');
-// });
-
-
-
-

util/email.ts

@@ -1,18 +1,20 @@
-import { InboxDto, MailSlurp } from 'mailslurp-client';
-import { configDotenv } from 'dotenv';
+import {InboxDto, MailSlurp} from 'mailslurp-client';
+import {configDotenv} from 'dotenv';
+import {Page} from '@playwright/test';
 
 configDotenv();
-const ms = new MailSlurp({
-  apiKey: process.env.MAILSLURP_API_KEY,
-});
 
 export const getMailSlurp = () => {
   if (!process.env.MAILSLURP_API_KEY) {
-    throw new Error('Environment variable MAILSLURP_API_KEY must be defined');
+    return;
   }
-  return ms;
+  return new MailSlurp({
+    apiKey: process.env.MAILSLURP_API_KEY,
+  });
 }
 
+export const ms = getMailSlurp();
+
 export const getInbox = async () => {
   try {
     let inbox: InboxDto;
@@ -40,12 +42,17 @@ export const getTestEmailAccount = () => {
   const emailAddress = process.env.TEST_EMAIL;
   const password = process.env.TEST_PASSWORD;
 
-  if (!emailAddress || !password) {
-    throw new Error('Environment variables TEST_EMAIL and TEST_PASSWORD must be defined');
-  }
-
   return {
     emailAddress,
     password
   }
 }
+
+export const getRandomPassword = async (page: Page, len=16) => {
+  return await page.evaluate(() => {
+    const chars = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789';
+    const ranVals = new Uint8Array(len);
+    crypto.getRandomValues(ranVals);
+    return Array.from(ranVals, byte => chars[byte % chars.length]).join('');
+  });
+}