feat!: Migrate Testing Framework from Jest to Vitest (PalisadoesFound…

…ation#2457) * configuring vitest * migrating AddOn tests to vitest * removing unnecessary alias * eslint fix * suggestion PalisadoesFoundation#2 * workflow setup * fix: tsdoc workflow * reformat comment to tsdoc fmt * resolving jest, vitest workflow * lint error * add tsdoc comments * exit for workflow * format yml fix * fixing workflow * cleanup * ts error * Update .eslintignore * tsconfig edit * removing suggestions 2 * Update vitest.config.ts * fmt * config update * ignoring .spec files for cov * new suggestions * merge reports * Update vitest.config.ts * vitest run fix * report dir change * report dir change 2 * check workflow * workflow update * fixing merge report * suggestion reverted * merge cov reports * changing format of jest cov reports * Merge Coverage Reports Using lcov-result-merger * fixing merge report * final changes * final changes 2 --------- Co-authored-by: Vamshi Maskuri <[email protected]>
mohamedrehan1 · Dec 4, 2024 · cbe468f · cbe468f
1 parent 6098035
commit cbe468f
Show file tree

Hide file tree

Showing 8 changed files with 1,807 additions and 289 deletions.
diff --git a/.eslintignore b/.eslintignore
@@ -1,2 +1,6 @@
 # Contains the PDF file of the Tag as JSON string, thus does not need to be linted
-src/components/CheckIn/tagTemplate.ts
+src/components/CheckIn/tagTemplate.ts
+package.json
+package-lock.json
+tsconfig.json
+
diff --git a/.github/workflows/pull-request.yml b/.github/workflows/pull-request.yml
@@ -42,11 +42,11 @@ jobs:
 
       - name: Get changed TypeScript files
         id: changed-files
-        uses: tj-actions/changed-files@v45
+        uses: tj-actions/changed-files@v40
       - name: Check formatting
         if: steps.changed-files.outputs.only_changed != 'true'
         run: npm run format:check
-
+        
       - name: Run formatting if check fails
         if: failure()
         run: npm run format
@@ -57,10 +57,10 @@ jobs:
 
       - name: Check for linting errors in modified files
         if: steps.changed-files.outputs.only_changed != 'true'
-        env:
-          CHANGED_FILES: ${{ steps.changed-files.outputs.all_changed_files }}
+        env: 
+          CHANGED_FILES: ${{ steps.changed_files.outputs.all_changed_files }}
         run: npx eslint ${CHANGED_FILES} && python .github/workflows/eslint_disable_check.py
-
+        
       - name: Check for TSDoc comments
         run: npm run check-tsdoc # Run the TSDoc check script
 
@@ -89,13 +89,12 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
-
+      
       - name: Get Changed Unauthorized files
         id: changed-unauth-files
-        uses: tj-actions/changed-files@v45
+        uses: tj-actions/changed-files@v40
         with:
           files: |
-            .env*
             .github/**
             env.example
             .node-version
@@ -124,16 +123,10 @@ jobs:
             ISSUE_GUIDELINES.md
             PR_GUIDELINES.md
             README.md
-            *.pem
-            *.key
-            *.cert
-            *.password
-            *.secret
-            *.credentials
-
+            
       - name: List all changed unauthorized files
         if: steps.changed-unauth-files.outputs.any_changed == 'true' || steps.changed-unauth-files.outputs.any_deleted == 'true'
-        env:
+        env: 
           CHANGED_UNAUTH_FILES: ${{ steps.changed-unauth-files.outputs.all_changed_files }}
         run: |
           for file in ${CHANGED_UNAUTH_FILES}; do
@@ -151,17 +144,17 @@ jobs:
 
       - name: Get changed files
         id: changed-files
-        uses: tj-actions/changed-files@v45
+        uses: tj-actions/changed-files@v40
 
       - name: Echo number of changed files
-        env:
+        env: 
           CHANGED_FILES_COUNT: ${{ steps.changed-files.outputs.all_changed_files_count }}
         run: |
           echo "Number of files changed: $CHANGED_FILES_COUNT"
 
       - name: Check if the number of changed files is less than 100
         if: steps.changed-files.outputs.all_changed_files_count > 100
-        env:
+        env: 
           CHANGED_FILES_COUNT: ${{ steps.changed-files.outputs.all_changed_files_count }}
         run: |
           echo "Error: Too many files (greater than 100) changed in the pull request."
@@ -201,15 +194,34 @@ jobs:
 
       - name: Install Dependencies
         run: npm install
-
+      
       - name: Get changed TypeScript files
         id: changed-files
-        uses: tj-actions/changed-files@v45
+        uses: tj-actions/changed-files@v40
+
+      - name: Run Jest Tests
+        if: steps.changed-files.outputs.only_changed != 'true'
+        env:
+          NODE_V8_COVERAGE: './coverage/jest'
+        run: |
+          npm run test -- --watchAll=false --coverage
 
-      - name: Run tests
+      - name: Run Vitest Tests
         if: steps.changed-files.outputs.only_changed != 'true'
-        run: npm run test -- --watchAll=false --coverage
+        env:
+          NODE_V8_COVERAGE: './coverage/vitest'
+        run: |
+          npm run test:vitest:coverage
 
+      - name: Merge Coverage Reports
+        if: steps.changed-files.outputs.only_changed != 'true'
+        run: |
+          mkdir -p coverage
+          if ! npx lcov-result-merger 'coverage/*/lcov.info' > 'coverage/lcov.info'; then
+            echo "Failed to merge coverage reports"
+            exit 1
+          fi     
+      
       - name: TypeScript compilation for changed files
         run: |
           for file in ${{ steps.changed-files.outputs.all_files }}; do
@@ -218,18 +230,19 @@ jobs:
             fi
           done
 
-      - name: Present and Upload coverage to Codecov as ${{env.CODECOV_UNIQUE_NAME}}
+      - name: Upload Coverage to Codecov
         uses: codecov/codecov-action@v4
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           verbose: true
-          fail_ci_if_error: false
+          files: './coverage/lcov.info'
           name: '${{env.CODECOV_UNIQUE_NAME}}'
+          fail_ci_if_error: false
 
       - name: Test acceptable level of code coverage
-        uses: VeryGoodOpenSource/very_good_coverage@v3
+        uses: VeryGoodOpenSource/very_good_coverage@v2
         with:
-          path: './coverage/lcov.info'
+          path: "./coverage/lcov.info"
           min_coverage: 95.0
 
   Graphql-Inspector:
@@ -247,161 +260,26 @@ jobs:
 
       - name: resolve dependency
         run: npm install -g @graphql-inspector/cli
-
+      
       - name: Clone API Repository
         run: |
           # Retrieve the complete branch name directly from the GitHub context
           FULL_BRANCH_NAME=${{ github.base_ref }}
           echo "FULL_Branch_NAME: $FULL_BRANCH_NAME"
-
+          
           # Clone the specified repository using the extracted branch name
-          git clone --branch $FULL_BRANCH_NAME https://github.com/PalisadoesFoundation/talawa-api && ls -a
+          git clone --branch $FULL_BRANCH_NAME https://github.com/PalisadoesFoundation/talawa-api && ls -a 
 
       - name: Validate Documents
         run: graphql-inspector validate './src/GraphQl/**/*.ts' './talawa-api/schema.graphql'
 
-  Start-App-Without-Docker:
-    name: Check if Talawa Admin app starts (No Docker)
-    runs-on: ubuntu-latest
-    needs: [Code-Quality-Checks, Test-Application]
-    if: github.actor != 'dependabot'
-    steps:
-      - name: Checkout the Repository
-        uses: actions/checkout@v4
-
-      - name: Set up Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: '20.x'
-
-      - name: Install Dependencies
-        run: npm install
-
-      - name: Build Production App
-        run: npm run build
-
-      - name: Start Production App
-        run: |
-          npm run preview &
-          echo $! > .pidfile_prod
-
-      - name: Check if Production App is running
-        run: |
-          timeout=120
-          echo "Starting production health check with ${timeout}s timeout"
-          while ! nc -z localhost 4173 && [ $timeout -gt 0 ]; do
-            sleep 1
-            timeout=$((timeout-1))
-            if [ $((timeout % 10)) -eq 0 ]; then
-              echo "Still waiting for production app to start... ${timeout}s remaining"
-            fi
-          done
-
-          if [ $timeout -eq 0 ]; then
-            echo "Timeout waiting for production application to start"
-            exit 1
-          fi
-          echo "Production app started successfully"
-
-      - name: Stop Production App
-        run: |
-          if [ -f .pidfile_prod ]; then
-            kill "$(cat .pidfile_prod)"
-          fi
-
-      - name: Start Development App
-        run: |
-          npm run serve &
-          echo $! > .pidfile_dev
-
-      - name: Check if Development App is running
-        run: |
-          timeout=120
-          echo "Starting development health check with ${timeout}s timeout"
-          while ! nc -z localhost 4321 && [ $timeout -gt 0 ]; do
-            sleep 1
-            timeout=$((timeout-1))
-            if [ $((timeout % 10)) -eq 0 ]; then
-              echo "Still waiting for development app to start... ${timeout}s remaining"
-            fi
-          done
-
-          if [ $timeout -eq 0 ]; then
-            echo "Timeout waiting for development application to start"
-            exit 1
-          fi
-          echo "Development app started successfully"
-
-      - name: Stop Development App
-        if: always()
-        run: |
-          if [ -f .pidfile_dev ]; then
-            kill "$(cat .pidfile_dev)"
-          fi
-
-  Docker-Start-Check:
-    name: Check if Talawa Admin app starts in Docker
-    runs-on: ubuntu-latest
-    needs: [Code-Quality-Checks, Test-Application]
-    if: github.actor != 'dependabot'
-    steps:
-      - name: Checkout the Repository
-        uses: actions/checkout@v4
-
-      - name: Set up Docker
-        uses: docker/setup-buildx-action@v3
-        with:
-          driver-opts: |
-            image=moby/buildkit:latest
-
-      - name: Build Docker image
-        run: |
-          set -e
-          echo "Building Docker image..."
-          docker build -t talawa-admin-app .
-          echo "Docker image built successfully"
-
-      - name: Run Docker Container
-        run: |
-          set -e
-          echo "Started Docker container..."
-          docker run -d --name talawa-admin-app-container -p 4321:4321 talawa-admin-app
-          echo "Docker container started successfully"
-
-      - name: Check if Talawa Admin App is running
-        run: |
-          timeout="${HEALTH_CHECK_TIMEOUT:-120}"
-          echo "Starting health check with ${timeout}s timeout"
-          while ! nc -z localhost 4321 && [ $timeout -gt 0 ]; do
-            sleep 1
-
-            timeout=$((timeout-1))
-            if [ $((timeout % 10)) -eq 0 ]; then
-              echo "Still waiting for app to start... ${timeout}s remaining"
-            fi
-          done
-
-          if [ $timeout -eq 0 ]; then
-            echo "Timeout waiting for application to start"
-            echo "Container logs:"
-            docker logs talawa-admin-app-container
-            exit 1
-          fi
-          echo "Port check passed, verifying health endpoint..."
-
-      - name: Stop Docker Container
-        if: always()
-        run: |
-          docker stop talawa-admin-app-container
-          docker rm talawa-admin-app-container
-
   Check-Target-Branch:
     if: ${{ github.actor != 'dependabot[bot]' }}
     name: Check Target Branch
     runs-on: ubuntu-latest
     steps:
       - name: Check if the target branch is develop
-        if: github.event.pull_request.base.ref != 'develop-postgres'
+        if: github.event.pull_request.base.ref != 'develop'
         run: |
-          echo "Error: Pull request target branch must be 'develop-postgres'. Please refer PR_GUIDELINES.md"
-          exit 1
+          echo "Error: Pull request target branch must be 'develop'. Please refer PR_GUIDELINES.md"
+          exit 1
diff --git a/jest.config.js b/jest.config.js
@@ -1,12 +1,22 @@
 export default {
   roots: ['<rootDir>/src'],
-  collectCoverageFrom: ['src/**/*.{ts,tsx}', '!src/index.tsx'],
+  collectCoverageFrom: [
+    'src/**/*.{ts,tsx}',
+    '!src/index.tsx',
+    '!node_modules',
+    '!dist',
+    '!**/*.{spec,test}.{js,jsx,ts,tsx}',
+    '!coverage/**',
+    '!**/index.{js,ts}',
+    '!**/*.d.ts',
+    '!src/test/**',
+    '!vitest.config.ts',],
   // setupFiles: ['react-app-polyfill/jsdom'],
   setupFiles: ['whatwg-fetch'],
   setupFilesAfterEnv: ['<rootDir>/src/setupTests.ts'],
   testMatch: [
     '<rootDir>/src/**/__tests__/**/*.{js,jsx,ts,tsx}',
-    '<rootDir>/src/**/*.{spec,test}.{js,jsx,ts,tsx}',
+    '<rootDir>/src/**/*.test.{js,jsx,ts,tsx}',
   ],
   testEnvironment: 'jsdom',
   transform: {
@@ -30,8 +40,8 @@ export default {
     '^@dicebear/collection$':
       '<rootDir>/scripts/__mocks__/@dicebear/collection.ts',
     '\\.svg\\?react$': '<rootDir>/scripts/__mocks__/fileMock.js',
-    '\\.svg$': '<rootDir>/scripts/__mocks__/fileMock.js', 
-    '^@pdfme/generator$': '<rootDir>/scripts/__mocks__/@pdfme/generator.ts'
+    '\\.svg$': '<rootDir>/scripts/__mocks__/fileMock.js',
+    '^@pdfme/generator$': '<rootDir>/scripts/__mocks__/@pdfme/generator.ts',
   },
   moduleFileExtensions: [
     'web.js',
@@ -68,4 +78,6 @@ export default {
     '<rootDir>/build/',
     '<rootDir>/public/',
   ],
+  coverageDirectory: './coverage/jest',
+  coverageReporters: ['text', 'html', 'text-summary', 'lcov'],
 };