Dev to Main

.github/workflows/run_tests.yml

@@ -0,0 +1,112 @@
+name: run_api_tests
+
+on:
+  push:
+    branches-ignore:
+      - "**"
+    # Remove the line above to run when pushing to master
+  pull_request:
+    branches: [ main, dev ]
+  repository_dispatch:
+    types: [ run_api_tests ]
+  schedule:
+    - cron: "0 0 * * 0"  # Runs every day at midnight (UTC)
+
+jobs:
+  UnitTest:
+    name: Unit Test Cases
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v3
+        with:
+          # Full git history is needed to get a proper list of changed files within `super-linter`
+          fetch-depth: 0
+
+      - name: Install npm dependencies
+        run: npm install
+
+      - name: Determine output folder
+        id: set_output_folder
+        run: |
+          # For pull_request events, use the base branch; otherwise use the current branch reference
+          if [[ $GITHUB_EVENT_NAME == "pull_request" ]]; then
+            branch_name=$GITHUB_BASE_REF
+          else
+            branch_name=$GITHUB_REF_NAME
+          fi
+
+          if [[ $branch_name == "main" ]]; then
+            echo "output_folder=stage" >> $GITHUB_ENV
+          elif [[ $branch_name == "dev" ]]; then
+            echo "output_folder=dev" >> $GITHUB_ENV
+          else
+            echo "Unknown branch: $branch_name"
+            exit 1
+          fi
+
+      - name: Create env file
+        run: |
+          # For pull requests, choose the env file based on the base branch
+          if [ "${{ github.event_name }}" = "pull_request" ]; then
+            if [ "${{ github.event.pull_request.base.ref }}" = "main" ]; then
+              echo "${{ secrets.STAGE_ENV_FILE }}" > .env
+            else
+              echo "${{ secrets.ENV_FILE }}" > .env
+            fi
+          else
+            # For non-PR events (push, schedule, repository_dispatch), use the stage env file
+            echo "${{ secrets.STAGE_ENV_FILE }}" > .env
+          fi
+
+      - name: Set TIMESTAMP
+        run: |
+          # Save the timestamp as an environment variable for reuse in subsequent steps.
+          echo "TIMESTAMP=$(date '+%d.%m.%Y_%H.%M.%S')" >> $GITHUB_ENV
+
+      - name: Run tests with coverage
+        run: |
+          # Use the TIMESTAMP variable from the environment.
+          mkdir -p test_results
+          log_file="test_results/${TIMESTAMP}_report.log"
+          echo -e "\nTest Cases Report\n" >> "$log_file"
+          # Run the tests and append output to the log file
+          npm run test >> "$log_file" 2>&1
+          # Copy and rename the generated test report with the timestamp
+          cp test-report.html test_results/test-report_${TIMESTAMP}.html
+
+      - name: Set Date Folder
+        run: |
+          DATE_FOLDER=$(date '+%d.%m.%Y')
+          echo "date_folder=${DATE_FOLDER}" >> $GITHUB_ENV
+
+      - name: Upload report to Azure
+        uses: LanceMcCarthy/Action-AzureBlobUpload@v2
+        with:
+          source_folder: 'test_results'
+          destination_folder: '${{ env.date_folder }}'
+          connection_string: ${{ secrets.AZURE_STORAGE_CONNECTION_STRING }}
+          container_name: 'api-tester'
+          clean_destination_folder: false
+          delete_if_exists: false
+
+      - name: send email notification
+        if: always()
+        uses: dawidd6/action-send-mail@v3
+        with:
+          server_address: smtp.gmail.com
+          server_port: 587
+          username: ${{ secrets.EMAIL_USER }}
+          password: ${{ secrets.EMAIL_PASSWORD }}
+          subject: ${{ job.status }} - API Testing Report | ${{ github.event_name == 'pull_request' && format('{0}-{1}', 'PR', github.event.pull_request.title)  || 'Triggered via Schema Changed' }}
+          to: [email protected]
+          cc: [email protected]
+          bcc: [email protected], [email protected]
+          from: Workflow Notification
+          attachments: test-report.html
+          html_body: |
+            <h2>API Testing Report</h2>
+            <p>Workflow: <a href="${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}">${{ github.workflow }}</a></p>
+            <p>Repository: <a href="${{ github.server_url }}/${{ github.repository }}">${{ github.repository }}</a></p>
+            ${{ github.event_name == 'pull_request' && format('<p>Pull Request: <a href="{0}">{1}</a></p>', github.event.pull_request.html_url, github.event.pull_request.title)  || '<br>' }}

.gitignore

@@ -81,6 +81,7 @@ typings/
 # Nuxt.js build / generate output
 .nuxt
 dist
+build
 
 # Gatsby files
 .cache/
@@ -104,4 +105,9 @@ dist
 .tern-port
 .DS_Store
 src/test-harness.json
-test-report.html
+test-report.html
+wallaby.js
+
+jest-html-reporters-attach
+seed.data.json
+.idea/

README.md

@@ -1,9 +1,126 @@
 # TDEI-api-tester
-API tester for the client-API received from swagger
+
+This service repository contains automated test cases for TDEI API endpoints to verify their functionality and generate a comprehensive test report. The API specifications are received from Swagger (OpenAPI), ensuring tests are aligned with the latest API definition and remain reliable, functional, and compliant with their specifications
+
+1. Automated Testing of API Endpoints
+   - Executes test cases for all TDEI API endpoints to validate expected responses.
+2. Test Case Management
+	- Covers positive, negative, and edge cases to ensure robustness.
+3.	Report Generation
+	- Generates a detailed test report after execution.
+	- Includes test results for all endpoints, status codes, response validation, and errors.
+4.	Integration with CI/CD
+	- Can be integrated into GitHub Workflows or any CI/CD pipeline.
+
+## System requirements
+| Software | Version|
+|----|---|
+| NodeJS | 18.16.0|
+| Typescript | 4.8.2 |
+
+## Environment variables
+
+Application configuration is read from .env file. Below are the list of environemnt variables service is dependent on. Description of environment variable is presented in below table
+
+|Name| Description |
+|--|--|
+| PROVIDER | Provider for cloud service or local (optional)|
+|SEED_BASE_URL | User management portal api url  |
+|SEED_ADMIN_USER | admin user name|
+|SEED_ADMIN_PASSWORD |admin password|
+|SYSTEM_BASE_URL | TDEI API url|
+|ENVIRONMENT | Environement to run api tester dev, stage, prod|
+
+
+## API Tester Environment Data
+
+The API Tester requires environment-specific data to execute test cases. This data is essential for ensuring that tests run successfully with the required dependencies.
+
+Environment Data Dependencies stored in api.input.json.
+
+Types of Environment Data Included:
+1.	User Accounts:
+- Pre-verified users to bypass email verification in user registration tests.
+- Includes credentials for different roles like admin, data generators, API key testers, etc.
+2.	Dataset IDs:
+- Used for testing both positive and negative cases in dataset-related API endpoints.
+3. Other API-Specific Dependencies:
+- Any additional environment-specific data required by the API test cases.
+
+By maintaining this structured environment input data, the API Tester can run consistent and reliable test cases across different environments. 🚀
+
+## Seeder requirements
+- To enhance the testing with different personas and varied systems, it is imperative that we generate some scripts that allow generation of users and other seed data required for testing.
+
+Here are the requirements for seed data generation
+
+- Create an project group with random project group data
+- Assign the roles to the users for the generated project group
+- Create a service
+- Assign role to the users.
+
+When we start test , seeder process will start and start with above seed generation and generate one file with `seed.data.json` which is used while testing the API's with different personas. Json format shown below:
+
+```json
+{
+    "project_group": {
+        "tdei_project_group_id": "<PROJECT_GROUP_ID>",
+        "name": "<PROJECT_GROUP_NAME>"
+    },
+    "services": [
+        {
+            "tdei_service_id": "<SERVICE_ID_1>",
+            "service_type": "<SERVICE_TYPE_1>",
+            "service_name": "<SERVICE_NAME_1>",
+            "tdei_project_group_id": "<PROJECT_GROUP_ID>"
+        },
+        {
+            "tdei_service_id": "<SERVICE_ID_2>",
+            "service_type": "<SERVICE_TYPE_2>",
+            "service_name": "<SERVICE_NAME_2>",
+            "tdei_project_group_id": "<PROJECT_GROUP_ID>"
+        },
+        {
+            "tdei_service_id": "<SERVICE_ID_3>",
+            "service_type": "<SERVICE_TYPE_3>",
+            "service_name": "<SERVICE_NAME_3>",
+            "tdei_project_group_id": "<PROJECT_GROUP_ID>"
+        }
+    ],
+    "users": {
+        "poc": {
+            "username": "<POC_USERNAME>",
+            "password": "<POC_PASSWORD>"
+        },
+        "flex_data_generator": {
+            "username": "<FLEX_USERNAME>",
+            "password": "<FLEX_PASSWORD>"
+        },
+        "pathways_data_generator": {
+            "username": "<PATHWAYS_USERNAME>",
+            "password": "<PATHWAYS_PASSWORD>"
+        },
+        "osw_data_generator": {
+            "username": "<OSW_USERNAME>",
+            "password": "<OSW_PASSWORD>"
+        },
+        "api_key_tester": {
+            "username": "<API_KEY_TESTER_USERNAME>",
+            "password": "<API_KEY_TESTER_PASSWORD>"
+        },
+        "default_user": {
+            "username": "<DEFAULT_USER_USERNAME>",
+            "password": "<DEFAULT_USER_PASSWORD>"
+        }
+    },
+    "api_key": "<API_KEY>",
+    "api_key_tester": "<API_KEY_TESTER>"
+}
+
+```
 
 # Steps
-- The testing rig is currently configured based on `test-harness.json` file.
-- An example of the file is already given as `test-harness.example.json`
+- The testing rig is currently configured based on `.env` file.
 - `npm i`
 - `npm run test`
 
@@ -15,6 +132,28 @@ The above code runs the tests and generates a `test-report.html` (already includ
 - name it in the format `<group>.test.ts`
 - Write test cases based on [jest](https://jestjs.io/docs/getting-started)
 
+## Important notes on writing tests for better readability
+- Consider Adding tests in the below format
+> Given
+- Setup test data in this step
+- Give a line break
+> When
+- Perform some action
+- Give a line break
+> Then
+- Assert result
+
+```  
+describe('my-awesome-test', () => {
+	const getTestData => return {};
+	it('should validate schema response', () => {
+		let testData = getTestData();
+		let api = new myAwesomeApi();
+
+		const result = api.getVersions();
 
-## TODO:
- Document on what the component is and where it helps
+		expect(result.status).toBe(200);
+		expect(result.myAwesomeField).toBe('valid');
+	});
+});
+```

api.input.json

@@ -0,0 +1,77 @@
+{
+    "dev": {
+        "osw": {
+            "published_dataset": "40566429d02c4c80aee68c970977bed8",
+            "pre_release_dataset": "1978d16b-46f6-4d0c-b1d1-78123178a65b",
+            "test_dataset": "f5fd7445fbbf4f248ea1096f0e17b7b3",
+            "spatial_target_dataset": "fa8e12ea-6b0c-4d3e-8b38-5b87b268e76b",
+            "spatial_source_dataset": "0d661b69495d47fb838862edf699fe09"
+        },
+        "flex": {
+            "published_dataset": "309dea0b-0fb2-4c19-a771-9f3719b48030",
+            "pre_release_dataset": "8b0cac15-4f96-4ea8-aac7-934dad1e0367"
+        },
+        "pathways": {
+            "published_dataset": "cb472b40-38cf-4006-abab-5c819682b08c",
+            "pre_release_dataset": "b8e068b9-67b4-4fe9-8ddb-c1d64d3702ce"
+        },
+        "users": {
+            "poc": "[email protected]",
+            "flex_data_generator": "[email protected]",
+            "pathways_data_generator": "[email protected]",
+            "osw_data_generator": "[email protected]",
+            "api_key_tester": "[email protected]",
+            "default_user": "[email protected]"
+        }
+    },
+    "stage": {
+        "osw": {
+            "published_dataset": "047c8e5f-bfce-48ee-8dd0-3cdc16d72624",
+            "pre_release_dataset": "42982431-d983-4c0a-aadb-c88b4ef7d2b8",
+            "test_dataset": "74d2d6fc-db4a-4f72-8042-e521ef5c3520",
+            "spatial_target_dataset": "892897ec-d75e-47f5-84ed-efc08ca6a8c6",
+            "spatial_source_dataset": "0c384536b471477db07a4c6e9d8476bf"
+        },
+        "flex": {
+            "published_dataset": "3cb8a738-b274-4c6c-a8d4-a212de9a7623",
+            "pre_release_dataset": "80548cc3-0d49-4642-aa40-ec8da7f63fef"
+        },
+        "pathways": {
+            "published_dataset": "7912bddf-5333-4a6e-9af8-81b1efd01707",
+            "pre_release_dataset": "cc186aa4-8576-4d6e-bd89-f5df4e2e5851"
+        },
+        "users": {
+            "poc": "[email protected]",
+            "flex_data_generator": "[email protected]",
+            "pathways_data_generator": "[email protected]",
+            "osw_data_generator": "[email protected]",
+            "api_key_tester": "[email protected]",
+            "default_user": "[email protected]"
+        }
+    },
+    "prod": {
+        "osw": {
+            "published_dataset": "40566429d02c4c80aee68c970977bed8",
+            "pre_release_dataset": "26f0ec82-1434-4944-ae8c-dea8aa5e0075",
+            "test_dataset": "f5fd7445fbbf4f248ea1096f0e17b7b3",
+            "spatial_target_dataset": "fa8e12ea-6b0c-4d3e-8b38-5b87b268e76b",
+            "spatial_source_dataset": "0d661b69495d47fb838862edf699fe09"
+        },
+        "flex": {
+            "published_dataset": "309dea0b-0fb2-4c19-a771-9f3719b48030",
+            "pre_release_dataset": "8b0cac15-4f96-4ea8-aac7-934dad1e0367"
+        },
+        "pathways": {
+            "published_dataset": "cb472b40-38cf-4006-abab-5c819682b08c",
+            "pre_release_dataset": "b8e068b9-67b4-4fe9-8ddb-c1d64d3702ce"
+        },
+        "users": {
+            "poc": "[email protected]",
+            "flex_data_generator": "[email protected]",
+            "pathways_data_generator": "[email protected]",
+            "osw_data_generator": "[email protected]",
+            "api_key_tester": "[email protected]",
+            "default_user": "[email protected]"
+        }
+    }
+}