test: Add E2E tests

Author: javierbrea

.github/CONTRIBUTING.md

@@ -6,6 +6,7 @@ Thank you for being part of the Telefónica Innovación Digital Open Source Comm
 
 - [Getting started](#getting-started)
 - [Test the action locally](#test-the-action-locally)
+- [E2E tests](#e2e-tests)
 - [Branching model](#branching-model)
 - [Pull Request](#pull-request)
 - [Release process](#release-process)
@@ -68,6 +69,23 @@ variables used by the GitHub Actions Toolkit. For more information, see the exam
 file, [`.env.example`](./.env.example), and the
 [GitHub Actions Documentation](https://docs.github.com/en/actions/learn-github-actions/variables#default-environment-variables).
 
+## E2E tests
+
+This project includes end-to-end tests, consisting in a workflow that uses the action to sync the documentation of the project itself to a Confluence page, and then checks if the page was updated correctly.
+
+```bash
+npm run test:e2e
+```
+
+The tests require the following environment variables to be set, which can be defined in a `.env` file:
+
+```txt .env
+CONFLUENCE_URL=https://your-confluence-url.net
+CONFLUENCE_PAT=******
+CONFLUENCE_README_PAGE_ID=page-id-of-the-readme-page
+CONFLUENCE_CHANGELOG_PAGE_ID=page-id-of-the-changelog-page
+```
+
 ## Branching model
 
 In short, we have a "main" branch and a "release" branch. The "main" branch must always reflect the latest stable published version of the packages in the repository. The "release" branch is used to prepare the release of features without having to promote any unpublished changes to the "main" branch. It is the default branch for PRs.

.github/actions/setup-node/action.yml

@@ -0,0 +1,25 @@
+# SPDX-FileCopyrightText: 2024 Telefónica Innovación Digital and contributors
+# SPDX-License-Identifier: MIT
+
+name: Setup Node.js
+description: Setup the node.js environment
+
+runs:
+  using: composite
+  steps:
+    - name: Setup Node.js
+      id: setup-node
+      uses: actions/setup-node@v4
+      with:
+        node-version-file: .node-version
+        cache: npm
+    - uses: DamianReeves/[email protected]
+      with:
+        path: .npmrc
+        contents: |
+            @tid-xcut:registry=https://nexus.tid.es/repository/npm-xcut-components/
+            //nexus.tid.es/repository/npm-xcut-components/:_auth=${{ secrets.NPM_TOKEN_XCUT }}
+        write-mode: append
+    - name: Install Dependencies
+      id: npm-ci
+      run: npm ci

.github/workflows/build.yml

@@ -23,24 +23,8 @@ jobs:
         id: checkout
         uses: actions/checkout@v4
 
-      - name: Setup Node.js
+      - uses: ./.github/actions/setup-node
         id: setup-node
-        uses: actions/setup-node@v4
-        with:
-          node-version-file: .node-version
-          cache: npm
-
-      - uses: DamianReeves/[email protected]
-        with:
-          path: .npmrc
-          contents: |
-              @tid-xcut:registry=https://nexus.tid.es/repository/npm-xcut-components/
-              //nexus.tid.es/repository/npm-xcut-components/:_auth=${{ secrets.NPM_TOKEN_XCUT }}
-          write-mode: append
-
-      - name: Install Dependencies
-        id: npm-ci
-        run: npm ci
 
       - name: Lint
         id: npm-lint

.github/workflows/test-e2e.yml

@@ -49,3 +49,25 @@ jobs:
           confluence-root-page-name: "Cross"
           confluence-space-key: ${{ vars.CONFLUENCE_SPACE_KEY }}
           confluence-personal-access-token: ${{ secrets.CONFLUENCE_PAT }}
+
+  test-e2e:
+    environment: production
+    name: Test E2E
+    runs-on: ubuntu-latest
+    needs: sync-to-confluence
+
+    steps:
+      - name: Checkout
+        id: checkout
+        uses: actions/checkout@v4
+
+      - uses: ./.github/actions/setup-node
+        id: setup-node
+        
+      - name: Run E2E Tests
+        run: npm run test:e2e
+        env:
+          CONFLUENCE_URL: ${{ vars.CONFLUENCE_URL }}
+          CONFLUENCE_PAT: ${{ secrets.CONFLUENCE_PAT }}
+          CONFLUENCE_ROOT_PAGE_ID: ${{ vars.CONFLUENCE_ROOT_PAGE_ID }}
+          CONFLUENCE_CHANGELOG_PAGE_ID: ${{ vars.CONFLUENCE_CHANGELOG_PAGE_ID }}

eslint.config.js

@@ -119,14 +119,24 @@ export default [
     },
   },
   {
-    files: ["**/*.spec.js", "**/*.test.js", "**/*.spec.ts", "**/*.test.ts"],
+    files: ["test/**/*.ts"],
     plugins: {
       jest: pluginJest,
     },
     ...pluginJest.configs["flat/recommended"],
     languageOptions: {
       globals: pluginJest.environments.globals.globals,
     },
+    settings: {
+      "import/resolver": {
+        typescript: {
+          extensions: [".ts", ".tsx"],
+          alwaysTryTypes: true,
+          project: ["./test/tsconfig.json"],
+        },
+        node: true,
+      },
+    },
     rules: {
       ...pluginJest.configs["flat/all"].rules,
       "jest/no-disabled-tests": "error",

jest.e2e.config.js

@@ -0,0 +1,24 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} **/
+export default {
+  // Automatically clear mock calls and instances between every test
+  clearMocks: true,
+
+  // Indicates whether the coverage information should be collected while executing the test
+  collectCoverage: false,
+
+  testTimeout: 120000,
+
+  // The glob patterns Jest uses to detect test files
+  testMatch: ["<rootDir>/test/e2e/specs/*.spec.ts"],
+
+  setupFiles: ["<rootDir>/test/e2e/support/setup.ts"],
+
+  transform: {
+    "^.+.ts$": [
+      "ts-jest",
+      {
+        tsConfig: "test/tsconfig.json",
+      },
+    ],
+  },
+};