Update coverage configuration and Travis CI setup for frontend tests (#4948)

* Update coverage configuration and Travis CI setup for frontend tests

- Adjusted source paths in .coveragerc to include 'apps/' alongside 'evalai/'.
- Modified .travis.yml to create a directory for frontend coverage reports before running tests.
- Updated karma.conf.js to change the coverage report directory structure for consistency.

* Enhance pre-commit configuration and cleanup script for improved code formatting

- Updated .pre-commit-config.yaml to include isort in the cleanup code hook and adjusted arguments for black and isort to enforce a line length of 79.
- Modified cleanup_code.sh to run isort for fixing import ordering, ensuring compatibility with the black profile.

* Enhance Travis CI configuration for frontend and backend tests

- Updated .travis.yml to use 'set -e' for fail-fast behavior in frontend and backend test scripts.
- Improved logging messages for better clarity during test execution.
- Refactored code quality checks to also utilize 'set -e' for consistent error handling.
- Adjusted Dockerfile for nodejs to ensure necessary packages are installed for Chrome and Chromium on both AMD64 and ARM64 architectures.

* Refactor Dockerfile to clean up Chrome locale files

- Updated the Dockerfile for Node.js to refine the cleanup process for Chrome by preserving essential locale files while removing unnecessary ones. This change enhances the efficiency of the image build process.

Author: RishabhJain2018

.coveragerc

@@ -16,7 +16,9 @@ omit =
     scripts/seed.py
     node_modules/
     bower_components/
-source = evalai/
+source = 
+    evalai/
+    apps/
 
 [report]
 exclude_lines =

.pre-commit-config.yaml

@@ -2,7 +2,7 @@ repos:
   - repo: local
     hooks:
       - id: cleanup-code
-        name: Clean up code (autoflake, autopep8, black)
+        name: Clean up code (autoflake, autopep8, black, isort)
         entry: bash scripts/tools/cleanup_code.sh
         language: system
         types: [python]
@@ -14,14 +14,14 @@ repos:
     hooks:
       - id: black
         language_version: python3.9
-        args: ['--check', '--diff', '--verbose']
+        args: ['--line-length=79', '--check', '--diff', '--verbose']
         verbose: true
 
   - repo: https://github.com/pycqa/isort
     rev: 5.12.0
     hooks:
       - id: isort
-        args: ['--profile=black', '--verbose']
+        args: ['--profile=black', '--line-length=79', '--check', '--diff', '--verbose']
         verbose: true
 
   - repo: https://github.com/pycqa/flake8

.travis.yml

@@ -42,26 +42,53 @@ jobs:
         - if [ "$TRAVIS_PULL_REQUEST" = "false" ]; then echo "$DOCKER_PASSWORD" | docker login -u "$DOCKER_USERNAME" --password-stdin || travis_terminate 1; fi
         - docker-compose --profile worker_py3_7 --profile worker_py3_8 --profile worker_py3_9 --profile statsd build || travis_terminate 1;
 
-        # Frontend Tests
-        - docker-compose run nodejs bash -c "npm install && gulp dev && karma start --single-run --reporters=junit,coverage && pkill -f chrome || true && pkill -f chromium || true && gulp staging" || travis_terminate 1;
+        # Frontend Tests - using set -e to fail fast on any error
+        - |
+          docker-compose run nodejs bash -c '
+            set -e
+            echo "=== Installing dependencies ==="
+            npm install
+            echo "=== Building frontend (dev) ==="
+            gulp dev
+            echo "=== Running frontend tests ==="
+            mkdir -p coverage/frontend
+            karma start --single-run --reporters=junit,coverage
+            echo "=== Frontend tests passed ==="
+            # Cleanup browser processes (ignore errors if not found)
+            pkill -f chrome 2>/dev/null || true
+            pkill -f chromium 2>/dev/null || true
+            echo "=== Building frontend (staging) ==="
+            gulp staging
+            echo "=== Frontend build complete ==="
+          ' || travis_terminate 1;
 
-        # Backend Tests
-        - docker-compose run -e DJANGO_SETTINGS_MODULE=settings.test django python manage.py flush --noinput || travis_terminate 1;
-        - docker-compose run -e DJANGO_SETTINGS_MODULE=settings.test django pytest --cov . --cov-config .coveragerc --cov-report=xml:coverage-backend.xml --junitxml=junit-backend.xml -o junit_family=legacy || travis_terminate 1;
+        # Backend Tests - using set -e to fail fast on any error
+        - |
+          docker-compose run -e DJANGO_SETTINGS_MODULE=settings.test django bash -c '
+            set -e
+            echo "=== Flushing database ==="
+            python manage.py flush --noinput
+            echo "=== Running backend tests with coverage ==="
+            pytest --cov . --cov-config .coveragerc --cov-report=xml:coverage-backend.xml --junitxml=junit-backend.xml -o junit_family=legacy
+            echo "=== Backend tests passed ==="
+          ' || travis_terminate 1;
 
-        # Check Code Quality
-        - docker-compose run -e DJANGO_SETTINGS_MODULE=settings.dev -e VERBOSE=1 django bash -c "
-          echo 'Installing black, flake8, pylint and isort...' &&
-          pip install black==24.8.0 flake8==3.8.2 pylint==3.3.6 isort==5.12.0 &&
-          echo 'Running black check...' &&
-          black --check --diff ./ || { echo 'Black check failed!'; travis_terminate 1; } &&
-          echo 'Running isort check...' &&
-          isort --check-only --diff --profile=black ./ || { echo 'isort check failed!'; travis_terminate 1; } &&
-          echo 'Running flake8 check...' &&
-          flake8 --config=.flake8 ./ || { echo 'Flake8 check failed!'; travis_terminate 1; } &&
-          echo 'Running pylint check...' &&
-          pylint --rcfile=.pylintrc --output-format=colorized --score=y --fail-under=7.5 ./ || { echo 'Pylint check failed!'; travis_terminate 1; } &&
-          echo 'All code quality checks passed!'" || travis_terminate 1;
+        # Check Code Quality - using set -e to fail fast on any error
+        - |
+          docker-compose run -e DJANGO_SETTINGS_MODULE=settings.dev -e VERBOSE=1 django bash -c '
+            set -e
+            echo "=== Installing code quality tools ==="
+            pip install black==24.8.0 flake8==3.8.2 pylint==3.3.6 isort==5.12.0
+            echo "=== Running black check ==="
+            black --check --diff ./
+            echo "=== Running isort check ==="
+            isort --check-only --diff --profile=black ./
+            echo "=== Running flake8 check ==="
+            flake8 --config=.flake8 ./
+            echo "=== Running pylint check ==="
+            pylint --rcfile=.pylintrc --output-format=colorized --score=y --fail-under=7.5 ./
+            echo "=== All code quality checks passed ==="
+          ' || travis_terminate 1;
 
       after_success:
         # Install Codecov CLI

docker/dev/nodejs/Dockerfile

@@ -91,22 +91,23 @@ COPY --from=builder /code/bower_components /code/bower_components
 
 # AMD64-specific stage for Chrome
 FROM base AS amd64
-RUN wget -q -O - https://dl-ssl.google.com/linux/linux_signing_key.pub | apt-key add - && \
+RUN apt-get update && \
+    apt-get install -y --no-install-recommends --fix-missing wget gnupg procps && \
+    wget -q -O - https://dl-ssl.google.com/linux/linux_signing_key.pub | apt-key add - && \
     echo "deb [arch=amd64] http://dl.google.com/linux/chrome/deb/ stable main" >> /etc/apt/sources.list.d/google.list && \
     apt-get update && \
     apt-get install -y --no-install-recommends --fix-missing google-chrome-stable libxss1 \
     || (apt-get update && apt-get install -y --no-install-recommends --fix-missing google-chrome-stable libxss1) && \
     rm -rf /var/lib/apt/lists/* && \
     rm -rf /var/cache/apt/* && \
-    # Clean Chrome unnecessary files
-    rm -rf /opt/google/chrome/locales/*.pak && \
-    find /opt/google/chrome -name "*.pak" ! -name "en-US.pak" -delete 2>/dev/null || true
+    # Clean Chrome unnecessary locale files only (preserve essential .pak files)
+    find /opt/google/chrome/locales -name "*.pak" ! -name "en-US.pak" -delete 2>/dev/null || true
 
 # ARM64-specific stage for Chromium
 FROM base AS arm64
 RUN apt-get update && \
-    apt-get install -y --no-install-recommends --fix-missing chromium libxss1 \
-    || (apt-get update && apt-get install -y --no-install-recommends --fix-missing chromium libxss1) && \
+    apt-get install -y --no-install-recommends --fix-missing chromium libxss1 procps \
+    || (apt-get update && apt-get install -y --no-install-recommends --fix-missing chromium libxss1 procps) && \
     ln -sf /usr/bin/chromium /usr/bin/google-chrome && \
     rm -rf /var/lib/apt/lists/* && \
     rm -rf /var/cache/apt/*

frontend/tests/controllers-test/challengeListCtrl.test.js

@@ -19,13 +19,12 @@ describe('Unit tests for challenge list controller', function () {
 
     describe('Global variables', function () {
         it('has default values', function () {
-            spyOn(utilities, 'getData');
             spyOn(utilities, 'showLoader');
+            spyOn(utilities, 'hideButton');
 
             vm = createController();
-            expect(utilities.getData).toHaveBeenCalledWith('userKey');
-            expect(vm.userKey).toEqual(utilities.getData('userKey'));
             expect(utilities.showLoader).toHaveBeenCalled();
+            expect(utilities.hideButton).toHaveBeenCalled();
             expect(vm.currentList).toEqual([]);
             expect(vm.upcomingList).toEqual([]);
             expect(vm.pastList).toEqual([]);

karma.conf.js

@@ -125,9 +125,9 @@ module.exports = function(config) {
 
     coverageReporter: {
         includeAllSources: true,
-        dir: 'coverage/frontend/',
+        dir: 'coverage/',
         reporters: [
-            { type: 'lcovonly', subdir: '.', file: 'lcov.info' },
+            { type: 'lcovonly', subdir: 'frontend', file: 'lcov.info' },
             { type: 'text-summary' }
         ]
     }

scripts/tools/cleanup_code.sh

@@ -80,6 +80,13 @@ for file in $FILTERED_FILES; do
     black --line-length 79 --quiet "$file" || true
 done
 
+# Fix import ordering with isort (using black-compatible profile)
+echo ""
+echo "Running isort to fix import ordering..."
+for file in $FILTERED_FILES; do
+    isort --profile=black --line-length=79 --quiet "$file" || true
+done
+
 # Stage the modified files so pylint/flake8 check the cleaned versions
 # Only stage files that were already staged
 echo ""