test: get planet

.github/workflows/pipeline.yml

@@ -1,11 +1,12 @@
-name: Render
+name: Deploy + Tests
 on:
   push:
     branches: [main]
 jobs:
-  deploy:
-    name: Wait for Deploy
+  check-deploy:
+    timeout-minutes: 60
     runs-on: ubuntu-latest
+    name: 👷🏻‍♀️ Check deploy
     steps:
       - name: Wait for Render Deployment
         uses: bounceapp/render-action@0.6.0
@@ -16,3 +17,33 @@ jobs:
           retries: 20
           wait: 16000
           sleep: 30000
+  testing:
+    needs: [check-deploy]
+    runs-on: ubuntu-latest
+    name: 🧐 Testing
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: '18.x'
+      - name: Install dependencies
+        run: npm ci
+      - name: Install Playwright
+        run: npx playwright install --with-deps
+      - name: Run Playwright tests
+        run: npx playwright test
+      - uses: actions/upload-artifact@v3
+        if: always()
+        with:
+          name: playwright-test-results
+          path: test-results/
+      - uses: actions/upload-artifact@v3
+        if: always()
+        with:
+          name: allure-test-results
+          path: allure-report/
+      - name: Publish JUnit Report
+        uses: mikepenz/action-junit-report@v3
+        if: always() # always run even if the previous step fails
+        with:
+          report_paths: 'junit-results/*.xml'

.gitignore

@@ -1,3 +1,6 @@
 build
 node_modules
-.env
+.env
+/*-results/
+/playwright-report/
+/playwright/.cache/

README.md

@@ -75,7 +75,31 @@ Local: localhost:8000/api/planet
 ```http
   GET /api/planet
 ```
+# Ejecutando las pruebas con Playwright
 
+```bash
+  # Runs the end-to-end tests.
+  npx playwright test
+```
+```bash
+  # Starts the interactive UI mode.
+  npx playwright test --ui
+```
+
+```bash
+  # Runs the tests only on Desktop Chrome.
+  npx playwright test --project=chromium
+```
+
+```bash
+  # Runs the tests in a specific file.
+  npx playwright test example
+```
+
+```bash
+  # Runs the tests in debug mode.
+  npx playwright test --debug
+```
 
 ## Diagrama de la base de datos
 

package.json

@@ -34,6 +34,7 @@
   "devDependencies": {
     "@commitlint/cli": "17.0.3",
     "@commitlint/config-conventional": "17.0.3",
+    "@playwright/test": "^1.36.2",
     "@types/cors": "2.8.12",
     "@types/express": "4.17.13",
     "@types/morgan": "1.9.3",

playwright.config.ts

@@ -0,0 +1,48 @@
+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', { open: 'never' }],
+		['junit', { outputFile: './junit-results/results.xml' }],
+	],
+	/* 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: 'ping',
+			testMatch: /ping\.setup\.ts/,
+		},
+		{
+			name: 'chromium',
+			use: { ...devices['Desktop Chrome'] },
+			dependencies: ['ping'],
+		},
+	],
+})

tests/ping.setup.ts

@@ -0,0 +1,28 @@
+import { test as ping, expect, APIRequestContext, test } from '@playwright/test'
+
+// Request context is reused by all tests in the file.
+let apiContext: APIRequestContext
+
+ping.beforeAll(async ({ playwright }) => {
+	apiContext = await playwright.request.newContext({
+		// All requests we send go to this API endpoint.
+		baseURL: 'https://planetas-api.onrender.com/',
+		extraHTTPHeaders: {
+			Accept: 'application/json',
+		},
+	})
+})
+
+ping.afterAll(async () => {
+	// Dispose all responses.
+	await apiContext.dispose()
+})
+
+/**
+ * API call to wake up our app
+ */
+ping('ping a planet', async () => {
+	const planet = await apiContext.get('/api/planet')
+	test.slow()
+	expect(planet.ok()).toBeTruthy()
+})

tests/planets.spec.ts

@@ -0,0 +1,49 @@
+import { test, expect, APIRequestContext } from '@playwright/test'
+
+// Request context is reused by all tests in the file.
+let apiContext: APIRequestContext
+
+// Before all tests, create a new API request context.
+test.beforeAll(async ({ playwright }) => {
+	apiContext = await playwright.request.newContext({
+		// All requests we send go to this API endpoint.
+		baseURL: 'https://planetas-api.onrender.com/',
+		extraHTTPHeaders: {
+			Accept: 'application/json',
+		},
+	})
+})
+
+// After all tests, dispose all responses.
+test.afterAll(async () => {
+	// Dispose all responses.
+	await apiContext.dispose()
+})
+
+/**
+ * Get a planet.
+ */
+test('get a planet', async () => {
+	const planet = await apiContext.get('/api/planet/jupiter')
+	// Expect the response to be OK.
+	expect(planet.ok()).toBeTruthy()
+	// Expect the response to contain the expected data.
+	expect(await planet.json()).toEqual(
+		expect.objectContaining({
+			id: '64c3ad5358fda7cddbe38a63',
+			name: 'Jupiter',
+			rotation: '9.93 hours',
+			revolution: '11.86 years',
+			radius: '69,911 km',
+			temperature: '-108°c',
+		}),
+	)
+})
+
+/**
+ * Try to get an inexistent planet
+ */
+test('get an inexistent planet', async () => {
+	const planet = await apiContext.get('/api/planet/badplanet')
+	expect(planet.status()).toEqual(404)
+})