test: add unit tests for GameXBlock by pganesh-apphelix · Pull Request #20 · edx/gamesxblock

pganesh-apphelix · 2025-12-08T10:04:23Z

Description

Adds new unit tests for GameXBlock to improve overall test coverage and ensure core functionality behaves as expected.

Jira

https://2u-internal.atlassian.net/browse/TNL2-447

…handlers

…n support

…ting setup

- Updated test paths in GitHub Actions workflow and Makefile to reflect new directory structure. - Created new test settings file for Django tests. - Added comprehensive unit tests for GamesXBlock core functionality, handlers, and utilities. - Implemented tests for flashcards and matching handlers. - Added tests for internationalization support and toggle functions. - Updated URLs configuration for tests.

…workflow

Copilot

Pull request overview

This pull request adds comprehensive unit test coverage for the GameXBlock project along with supporting test infrastructure, Spanish translations, API documentation, and minor code quality improvements.

Key Changes

Added full test suite with 80%+ coverage requirement using pytest and pytest-django
Introduced CI/CD pipeline with GitHub Actions for automated testing across Python 3.11 and Django 3.2/4.2
Added Spanish (es_419) translations and updated locale configuration

Reviewed changes

Copilot reviewed 25 out of 28 changed files in this pull request and generated 24 comments.

Show a summary per file

File	Description
tests/test_games.py	Core GamesXBlock tests covering initialization, defaults, views, handlers, and field scopes
tests/test_utils.py	Tests for storage utilities including custom storage configuration and image deletion
tests/test_translations.py	Tests for i18n support covering English and Spanish translations
tests/test_toggles.py	Tests for waffle flag functionality with exception handling
tests/handlers/test_common_handlers.py	Tests for shared handlers including encryption, settings, image upload, and obfuscation
tests/handlers/test_matching_handlers.py	Tests for matching game handlers including student view, game completion, and key mapping
tests/handlers/test_flashcards_handlers.py	Tests for flashcards game handlers including student view rendering
tests/settings.py	Django test settings configuration (has ROOT_URLCONF path issue)
tests/urls.py	Empty URL configuration placeholder for tests
pytest.ini	Pytest configuration with 80% coverage requirement and test discovery patterns
.coveragerc	Coverage configuration excluding migrations, tests, and locale files
.github/workflows/test.yml	CI/CD workflow for running tests and quality checks with codecov integration
test-requirements.txt	Test dependencies including pytest, faker, and code quality tools
requirements/base.txt	Base runtime dependencies for the XBlock
requirements/test.txt	Test requirements extending base requirements
requirements/ci.txt	CI-specific requirements for coverage reporting
Makefile	Added targets for test execution, coverage reporting, and quality checks
API.md	Comprehensive API documentation (has multiple constant value mismatches)
MANIFEST.in	Package manifest for distribution
.gitignore	Updated to exclude test and coverage artifacts
games/utils.py	Added docstring to delete_image function
games/toggles.py	Fixed trailing whitespace issues
games/handlers/flashcards.py	Added blank line for PEP 8 compliance
games/locale/config.yaml	Updated locale configuration structure (has potential configuration issue)
games/locale/es_419/LC_MESSAGES/django.po	Spanish translation file (has outdated dates)
games/locale/es_419/LC_MESSAGES/django.mo	Compiled Spanish translations

Comments suppressed due to low confidence (5)

tests/handlers/test_common_handlers.py:6

Import of 'MagicMock' is not used.

from unittest.mock import Mock, patch, MagicMock

tests/handlers/test_flashcards_handlers.py:4

Import of 'json' is not used.

import json

tests/handlers/test_flashcards_handlers.py:5

Import of 'MagicMock' is not used.

from unittest.mock import Mock, patch, MagicMock

tests/handlers/test_matching_handlers.py:5

Import of 'MagicMock' is not used.

from unittest.mock import Mock, patch, MagicMock

tests/test_toggles.py:4

Import of 'MagicMock' is not used.

from unittest.mock import patch, MagicMock

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

.coveragerc

Copilot · 2025-12-08T10:17:55Z

API.md

+Key configuration values (from `games/constants.py`):
+
+- **`MATCHES_PER_PAGE`**: 6 - Number of term-definition pairs per page in matching game
+- **`RANDOM_STRING_LENGTH`**: 16 - Length of random keys for obfuscation


The API documentation states that RANDOM_STRING_LENGTH is 16, but in the actual code (games/constants.py line 55), it's defined as 8. The documentation should be updated to reflect the correct value of 8.

Suggested change

- **`RANDOM_STRING_LENGTH`**: 16 - Length of random keys for obfuscation

- **`RANDOM_STRING_LENGTH`**: 8 - Length of random keys for obfuscation

Copilot · 2025-12-08T10:17:56Z

games/locale/config.yaml

 # Directories to search for translatable strings
-locales:
-  - games/locale
+locales_dir: games/locale


The key locales_dir should typically be locales according to standard Django i18n configuration. The value 'games/locale' appears to be a directory path rather than a list of locale codes. Please verify this configuration matches the expected format for the translation tooling being used.

Suggested change

locales_dir: games/locale

API.md

Copilot · 2025-12-08T10:17:57Z

tests/handlers/test_common_handlers.py

+"""
+import json
+import hashlib
+from unittest.mock import Mock, patch, MagicMock


The import MagicMock is not used in this test file. Consider removing it to keep the imports clean.

Suggested change

from unittest.mock import Mock, patch, MagicMock

from unittest.mock import Mock, patch

Copilot · 2025-12-08T10:18:01Z

API.md

+### Settings-Scoped Fields
+- **`display_name`** (string): Display name for the XBlock. Default: `"Games XBlock"`.
+- **`game_type`** (string): Type of game - either `"flashcards"` or `"matching"`. Default: `"matching"`.
+- **`is_shuffled`** (boolean): Whether cards should be shuffled. Default: `true`.


The API documentation states that is_shuffled has a default value of true, but in the actual code (games/constants.py line 24), DEFAULT.IS_SHUFFLED is defined as False. The documentation should be updated to reflect the correct default value of false.

Copilot · 2025-12-08T10:18:02Z

tests/handlers/test_flashcards_handlers.py

+import json
+from unittest.mock import Mock, patch, MagicMock


The imports json and MagicMock are not used in this test file. Consider removing them to keep the imports clean.

Suggested change

import json

from unittest.mock import Mock, patch, MagicMock

from unittest.mock import Mock, patch

Copilot · 2025-12-08T10:18:02Z

tests/handlers/test_common_handlers.py

+Tests for common handlers.
+"""
+import json
+import hashlib


Import of 'hashlib' is not used.

Suggested change

import hashlib

Copilot · 2025-12-08T10:18:02Z

tests/handlers/test_common_handlers.py

+
+from games.games import GamesXBlock
+from games.handlers.common import CommonHandlers
+from games.constants import GAME_TYPE, DEFAULT


Import of 'DEFAULT' is not used.

Suggested change

from games.constants import GAME_TYPE, DEFAULT

from games.constants import GAME_TYPE

Copilot · 2025-12-08T10:18:02Z

tests/handlers/test_matching_handlers.py

+"""
+Tests for flashcards and matching handlers.
+"""
+import json


Import of 'json' is not used.

Suggested change

import json

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Copilot

Pull request overview

Copilot reviewed 25 out of 28 changed files in this pull request and generated 4 comments.

Comments suppressed due to low confidence (4)

tests/handlers/test_common_handlers.py:6

Import of 'MagicMock' is not used.

from unittest.mock import Mock, patch, MagicMock

tests/handlers/test_flashcards_handlers.py:4

Import of 'json' is not used.

import json

tests/handlers/test_flashcards_handlers.py:5

Import of 'MagicMock' is not used.

from unittest.mock import Mock, patch, MagicMock

tests/handlers/test_matching_handlers.py:5

Import of 'MagicMock' is not used.

from unittest.mock import Mock, patch, MagicMock

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-12-08T10:32:01Z

tests/test_translations.py

+from faker import Faker
+
+
+class TestTranslations(TestCase):
+    """Tests for translation support."""
+
+    def setUp(self):
+        """Set up test fixtures."""
+        self.fake = Faker()
+


The Faker import and self.fake initialization are unused in this test file. Consider removing them to keep the code clean.

Suggested change

from faker import Faker

class TestTranslations(TestCase):

"""Tests for translation support."""

def setUp(self):

"""Set up test fixtures."""

self.fake = Faker()

class TestTranslations(TestCase):

"""Tests for translation support."""

def setUp(self):

"""Set up test fixtures."""

Copilot · 2025-12-08T10:32:01Z

tests/handlers/test_matching_handlers.py

+    def test_student_view_with_multiple_pages(self, mock_resource_string):
+        """Test student view with multiple pages of cards."""
+        mock_resource_string.return_value = b'<div>{{ total_pages }}</div>'
+        # Add enough cards to create multiple pages (6 cards per page by default)


The comment states "6 cards per page by default" but the actual CONFIG.MATCHES_PER_PAGE constant is set to 5 (see games/constants.py:57). Update this to "5 cards per page by default".

Suggested change

# Add enough cards to create multiple pages (6 cards per page by default)

# Add enough cards to create multiple pages (5 cards per page by default)

Copilot · 2025-12-08T10:32:02Z

requirements/ci.txt

+
+# Coverage reporting
+coverage==7.4.0
+codecov==2.1.13


The codecov Python package (version 2.1.13 from 2021) is deprecated and unnecessary since the GitHub Actions workflow uses codecov/codecov-action@v4 which handles coverage upload directly. Consider removing this dependency.

Suggested change

codecov==2.1.13

Copilot · 2025-12-08T10:32:02Z

tests/test_toggles.py

+"""
+Tests for games toggles.
+"""
+from unittest.mock import patch, MagicMock


Import of 'MagicMock' is not used.

Suggested change

from unittest.mock import patch, MagicMock

from unittest.mock import patch

pganesh-apphelix added 6 commits December 4, 2025 22:55

feat: Add unit tests and coverage configuration for Games XBlock

c25c436

feat: Update unit tests and improve code structure

5450b02

feat: Enhance unit tests and coverage configuration for Games XBlock

ef52d9f

feat: Add additional unit tests for common, flashcards, and matching …

82afb29

…handlers

feat: Add Spanish translations and unit tests for internationalizatio…

62d85b7

…n support

feat: Update requirements files and CI configuration for improved tes…

8b41887

…ting setup

Copilot AI review requested due to automatic review settings December 8, 2025 10:04

Copilot started reviewing on behalf of pganesh-apphelix December 8, 2025 10:04 View session

pganesh-apphelix requested review from djoseph-apphelix, papphelix and viv-helix December 8, 2025 10:05

pganesh-apphelix added 3 commits December 8, 2025 15:43

feat: Add comprehensive API documentation for Games XBlock

76c2335

feat: Update Python version matrix and upgrade action versions in CI …

1ce4c0b

…workflow

papphelix force-pushed the feat/unit_test branch from 027f85c to 1ce4c0b Compare December 8, 2025 10:14

papphelix approved these changes Dec 8, 2025

View reviewed changes

Copilot AI reviewed Dec 8, 2025

View reviewed changes

feat: Apply suggestions from code review

6f350e6

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Copilot AI review requested due to automatic review settings December 8, 2025 10:22

Copilot started reviewing on behalf of papphelix December 8, 2025 10:22 View session

pganesh-apphelix merged commit 7355bfd into main Dec 8, 2025
8 checks passed

Copilot AI reviewed Dec 8, 2025

View reviewed changes

papphelix deleted the feat/unit_test branch December 8, 2025 10:44

	- `RANDOM_STRING_LENGTH`: 16 - Length of random keys for obfuscation
	- `RANDOM_STRING_LENGTH`: 8 - Length of random keys for obfuscation

	from unittest.mock import Mock, patch, MagicMock
	from unittest.mock import Mock, patch

	from games.constants import GAME_TYPE, DEFAULT
	from games.constants import GAME_TYPE

	# Add enough cards to create multiple pages (6 cards per page by default)
	# Add enough cards to create multiple pages (5 cards per page by default)

	from unittest.mock import patch, MagicMock
	from unittest.mock import patch

Conversation

pganesh-apphelix commented Dec 8, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Key Changes

Reviewed changes

Uh oh!

Uh oh!

Copilot AI Dec 8, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 8, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI Dec 8, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 8, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 8, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 8, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 8, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 8, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Dec 8, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 8, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 8, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 8, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants