Skip to content

Commit e85b2f9

Browse files
JohnAllenTechJohnAllenTech
authored
Fix/e2e tests (#1061)
Add auth to tests
1 parent 42cf381 commit e85b2f9

15 files changed

Lines changed: 369 additions & 441 deletions

File tree

‎.github/workflows/e2e-tests.yml‎

Lines changed: 76 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -18,20 +18,20 @@ jobs:
1818
initial-checks:
1919
runs-on: ubuntu-latest
2020
steps:
21-
- name: Checkout repository
22-
uses: actions/checkout@v4
23-
with:
24-
ref: ${{ github.event.pull_request.head.sha }}
25-
fetch-depth: 0
21+
- name: Checkout repository
22+
uses: actions/checkout@v4
23+
with:
24+
ref: ${{ github.event.pull_request.head.sha }}
25+
fetch-depth: 0
2626

27-
- name: Setup Node.js
28-
uses: actions/setup-node@v4
29-
with:
30-
node-version: 'lts/*'
31-
cache: 'npm'
27+
- name: Setup Node.js
28+
uses: actions/setup-node@v4
29+
with:
30+
node-version: "lts/*"
31+
cache: "npm"
3232

33-
- name: Install dependencies
34-
run: npm ci
33+
- name: Install dependencies
34+
run: npm ci
3535

3636
e2e:
3737
needs: initial-checks
@@ -44,66 +44,69 @@ jobs:
4444
GITHUB_ID: ${{ secrets.E2E_GITHUB_ID }}
4545
GITHUB_SECRET: ${{ secrets.E2E_GITHUB_SECRET }}
4646
NEXTAUTH_SECRET: ${{ secrets.NEXTAUTH_SECRET }}
47+
E2E_USER_EMAIL: e2e@codu.co
48+
E2E_USER_ID: 8e3179ce-f32b-4d0a-ba3b-234d66b836ad
49+
E2E_USER_SESSION_ID: df8a11f2-f20a-43d6-80a0-a213f1efedc1
4750

4851
steps:
49-
- name: Checkout repository
50-
uses: actions/checkout@v4
51-
with:
52-
ref: ${{ github.event.pull_request.head.sha }}
53-
fetch-depth: 0
54-
55-
- name: Setup Node.js
56-
uses: actions/setup-node@v4
57-
with:
58-
node-version: 'lts/*'
59-
cache: 'npm'
60-
61-
- name: Cache Playwright browsers
62-
uses: actions/cache@v3
63-
with:
64-
path: ~/.cache/ms-playwright
65-
key: ${{ runner.os }}-playwright-${{ hashFiles('**/package-lock.json') }}
66-
restore-keys: |
67-
${{ runner.os }}-playwright-
68-
69-
- name: Run docker-compose
70-
uses: isbang/compose-action@v1.5.1
71-
with:
72-
compose-file: "./docker-compose.yml"
73-
down-flags: "--volumes"
74-
services: |
75-
db
76-
77-
- name: Wait for DB to be ready
78-
run: |
79-
timeout 60s bash -c 'until nc -z localhost 5432; do echo "Waiting for database connection..."; sleep 2; done'
80-
shell: bash
81-
82-
- name: Install dependencies
83-
run: npm ci
84-
85-
- name: Install Playwright browsers
86-
run: npx playwright install --with-deps
87-
if: steps.playwright-cache.outputs.cache-hit != 'true'
88-
89-
- name: Seed database
90-
run: |
91-
npm run db:push
92-
npm run db:seed
93-
94-
- name: Run Playwright tests
95-
id: playwright-tests
96-
run: npx playwright test
97-
continue-on-error: true
98-
99-
- name: Upload Playwright report
100-
uses: actions/upload-artifact@v4
101-
if: always()
102-
with:
103-
name: playwright-report
104-
path: playwright-report/
105-
retention-days: 30
106-
107-
- name: Check test results
108-
if: steps.playwright-tests.outcome == 'failure'
109-
run: exit 1
52+
- name: Checkout repository
53+
uses: actions/checkout@v4
54+
with:
55+
ref: ${{ github.event.pull_request.head.sha }}
56+
fetch-depth: 0
57+
58+
- name: Setup Node.js
59+
uses: actions/setup-node@v4
60+
with:
61+
node-version: "lts/*"
62+
cache: "npm"
63+
64+
- name: Cache Playwright browsers
65+
uses: actions/cache@v3
66+
with:
67+
path: ~/.cache/ms-playwright
68+
key: ${{ runner.os }}-playwright-${{ hashFiles('**/package-lock.json') }}
69+
restore-keys: |
70+
${{ runner.os }}-playwright-
71+
72+
- name: Run docker-compose
73+
uses: isbang/compose-action@v1.5.1
74+
with:
75+
compose-file: "./docker-compose.yml"
76+
down-flags: "--volumes"
77+
services: |
78+
db
79+
80+
- name: Wait for DB to be ready
81+
run: |
82+
timeout 60s bash -c 'until nc -z localhost 5432; do echo "Waiting for database connection..."; sleep 2; done'
83+
shell: bash
84+
85+
- name: Install dependencies
86+
run: npm ci
87+
88+
- name: Install Playwright browsers
89+
run: npx playwright install --with-deps
90+
if: steps.playwright-cache.outputs.cache-hit != 'true'
91+
92+
- name: Seed database
93+
run: |
94+
npm run db:push
95+
npm run db:seed
96+
97+
- name: Run Playwright tests
98+
id: playwright-tests
99+
run: npx playwright test
100+
continue-on-error: true
101+
102+
- name: Upload Playwright report
103+
uses: actions/upload-artifact@v4
104+
if: always()
105+
with:
106+
name: playwright-report
107+
path: playwright-report/
108+
retention-days: 30
109+
110+
- name: Check test results
111+
if: steps.playwright-tests.outcome == 'failure'
112+
run: exit 1

‎.gitignore‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,4 +67,4 @@ ssmSetup.zsh
6767

6868

6969
# open-next
70-
.open-next
70+
.open-next

‎README.md‎

Lines changed: 60 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ We have a fantastic community growing on Discord. Click [here](https://discord.g
2626
```bash
2727
npm install
2828
```
29+
2930
- If you have any issues installing dependencies, check your node version against that defined in the `.nvmrc`. If you're using `nvm`, you can run `nvm use` before installing dependencies.
3031

3132
5. Create a `.env` file and add the following variables. You can copy the contents of `sample.env` with `cat sample.env > .env`.
@@ -46,17 +47,18 @@ For a more detailed how to guide on setting them up [go to the Environment Varia
4647

4748
6. Setup the tables in the database with Drizzle by running:
4849

49-
5050
```bash
5151
npm run db:push
5252
```
53+
5354
The full command can be seen in our [package.json](/package.json#16) file
5455

5556
7. Seed the database with some mock data by running:
5657

5758
```bash
5859
npm run db:seed
5960
```
61+
6062
The full command can be seen in our [package.json](/package.json#19) file
6163

6264
8. Finally, run the development server:
@@ -94,17 +96,21 @@ Alternatively, if you have PostgreSQL running locally then you can use your loca
9496
Currently, we only allow authentication via GitHub. To enable this you need to have a `GITHUB_ID` and `GITHUB_SECRET` value.
9597

9698
Setup your GitHub ID & Secret on GitHub:
97-
- [Click here](https://github.com/settings/applications/new) to setup New OAuth App and fill in the details as shown below.
9899

100+
- [Click here](https://github.com/settings/applications/new) to setup New OAuth App and fill in the details as shown below.
99101

100102
For development, make sure you setup this with a **Homepage URL** of
103+
101104
```
102105
http://localhost:3000/
103106
```
107+
104108
and **Authorization callback URL** of
105-
```
109+
110+
```
106111
http://localhost:3000/api/auth
107112
```
113+
108114
as shown in the image below:
109115

110116
![Screenshot 2022-10-25 at 08 22 03](https://user-images.githubusercontent.com/12615742/197709325-50766dc2-2245-438c-8f71-09064fc3b123.png)
@@ -135,6 +141,16 @@ You shouldn't need to change the default value here. This is a variable used by
135141
NEXTAUTH_URL=http://localhost:3000/api/auth
136142
```
137143

144+
### E2E_USER_SESSION_ID
145+
146+
This is the sessionToken uuid that .
147+
This is currently hardcoded and there is no reason to change this until we require multiple E2E test users within the same test suite
148+
149+
### E2E_USER_ID
150+
151+
This is the userId if the E2E user used for testing .
152+
This is currently hardcoded and there is no reason to change this until we require multiple E2E test users within the same test suite
153+
138154
For more information, you can read the documentation [here](https://next-auth.js.org/configuration/options).
139155
**Example .env file can be found [here](./sample.env). You can rename this to .env to get started**
140156

@@ -147,6 +163,47 @@ For more information, you can read the documentation [here](https://next-auth.js
147163
- Run Tests
148164
- Also, Style Guide for Commit Messages
149165

166+
## End-to-End Testing with Playwright
167+
168+
To run the end-to-end tests using Playwright, you need to configure your environment and follow these steps:
169+
170+
### Environment Variables
171+
172+
Please ensure you have the following variables set in your `.env` file:
173+
174+
- `E2E_USER_ID`: The id of the E2E user for testing.
175+
- `E2E_USER_EMAIL`: The email of the E2E user for testing.
176+
- `E2E_USER_SESSION_ID`: The session id that the user will use to authenticate.
177+
178+
179+
Note the sample .env [here](./sample.env) is fine to use.
180+
181+
### Session and User setup
182+
183+
First you need to add your E2E test user to your locally running database. Do this by running the following script if you havent already
184+
185+
```
186+
npm run db:seed
187+
```
188+
189+
This will create a user and session for your E2E tests. Details of the E2E user created can be seen [here](./drizzle/seedE2E.ts)
190+
191+
### Running the Tests
192+
193+
You can run the end-to-end tests using one of the following commands:
194+
195+
For headless mode:
196+
197+
```zsh
198+
npx playwright test
199+
```
200+
201+
For UI mode:
202+
203+
```zsh
204+
npx playwright test --ui
205+
```
206+
150207
## 📙 Prerequisite Skills to Contribute
151208

152209
- [Git](https://git-scm.com/)

‎app/(app)/get-started/_client.tsx‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,7 @@ const GetStarted: NextPage = () => {
8787
)}
8888

8989
<button
90+
data-testid="github-login-button"
9091
type="button"
9192
onClick={async () => {
9293
await signIn("github", { callbackUrl: redirectTo });
@@ -117,6 +118,7 @@ const GetStarted: NextPage = () => {
117118
Continue with GitHub
118119
</button>
119120
<button
121+
data-testid="gitlab-login-button"
120122
type="button"
121123
onClick={async () => {
122124
await signIn("gitlab", { callbackUrl: redirectTo });

0 commit comments

Comments
 (0)