Skip to content

Commit

Permalink
simple test that the swagger-ui is rendered
Browse files Browse the repository at this point in the history
  • Loading branch information
ivy-rew committed Jan 10, 2024
1 parent 1c74de1 commit 411b4dd
Show file tree
Hide file tree
Showing 6 changed files with 217 additions and 1 deletion.
25 changes: 25 additions & 0 deletions .github/workflows/playwright.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: Playwright Tests
on:
push:
pull_request:
jobs:
test:
timeout-minutes: 60
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
with:
node-version: 18
- name: Install dependencies
run: npm ci
- name: Install Playwright Browsers
run: npx playwright install --with-deps
- name: Run Playwright tests
run: npx playwright test
- uses: actions/upload-artifact@v3
if: always()
with:
name: playwright-report
path: playwright-report/
retention-days: 30
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
dist/
node_modules/
target/
/test-results/
/playwright-report/
/blob-report/
/playwright/.cache/
125 changes: 125 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 4 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,16 @@
"type": "module",
"scripts": {
"start": "vite",
"build": "vite build"
"build": "vite build",
"test": "npx playwright test"
},
"dependencies": {
"swagger-ui": "^5.10.5",
"vite": "^5.0.11"
},
"devDependencies": {
"@playwright/test": "^1.40.1",
"@types/node": "^20.10.8",
"prettier": "^3.1.1"
}
}
51 changes: 51 additions & 0 deletions playwright.config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
import { defineConfig, devices } from '@playwright/test';

/**
* Read environment variables from file.
* https://github.com/motdotla/dotenv
*/
// require('dotenv').config();

/**
* See https://playwright.dev/docs/test-configuration.
*/
export default defineConfig({
testDir: './tests',
/* Run tests in files in parallel */
fullyParallel: true,
/* Fail the build on CI if you accidentally left test.only in the source code. */
forbidOnly: !!process.env.CI,
/* Retry on CI only */
retries: process.env.CI ? 2 : 0,
/* Opt out of parallel tests on CI. */
workers: process.env.CI ? 1 : undefined,
/* Reporter to use. See https://playwright.dev/docs/test-reporters */
reporter: 'html',
/* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */
use: {
/* Base URL to use in actions like `await page.goto('/')`. */
// baseURL: 'http://127.0.0.1:3000',

/* Collect trace when retrying the failed test. See https://playwright.dev/docs/trace-viewer */
trace: 'on-first-retry',
},

/* Configure projects for major browsers */
projects: [
{
name: 'chromium',
use: { ...devices['Desktop Chrome'] },
},
// {
// name: 'firefox',
// use: { ...devices['Desktop Firefox'] },
// },
],

/* Run your local dev server before starting the tests */
webServer: {
command: 'npm run start',
url: 'http://127.0.0.1:5173',
reuseExistingServer: !process.env.CI,
},
});
8 changes: 8 additions & 0 deletions tests/swagger.spec.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
import { test, expect } from '@playwright/test';

test('swagger ui renderer', async ({ page }) => {
await page.goto('http://localhost:5173/');

await expect(page).toHaveTitle(/API Browser/);
await expect(page.getByText('Authorize')).toBeVisible();
});

0 comments on commit 411b4dd

Please sign in to comment.