feat(tests): add integration tests to tutor paragon plugin

[Ang-m4]

Description

This PR introduces integration tests for the Tutor Paragon plugin, utilizing Pytest to validate the plugin's setup and functionality. These tests ensure that the plugin is correctly installed, enabled, and operates as expected within the Tutor environment.

Key Enhancements

Logging Improvements

• Replaced print statements with logger.info for logging plugin installation processes. This change enhances log management and prevents interference with test output, especially when retrieving the Tutor installation root.

Pytest Fixtures and Configuration

• Introduced Pytest fixtures in integration/conftest.py with package level scope to:

  • Enable the Tutor Paragon plugin before tests run.
  • Build the Paragon builder Docker image prior to test execution.

• These fixtures ensure a consistent and isolated testing environment, adhering to Pytest's best practices for setup and teardown processes.

Helper Module

• Added a helpers.py module within the integration/ directory containing:

  • Global variable declarations for plugin names, image names, and directory paths.
  • Utility functions to execute Tutor commands and retrieve the Tutor root path.

Integration Test Suite

• Developed integration tests within the integration/ directory to verify:

  • The Paragon plugin is installed and enabled (plugin_setup_test.py).
  • Essential directories (theme-sources and compiled-themes) are created.
  • The paragon-build-tokens job is available in Tutor's configuration.
  • Core plugin functionality behaves as expected (plugin_functionality_tests.py).

Makefile Update

• Added a new Makefile target make integration-tests to streamline the execution of integration tests.

---

Project Structure

tests/
└── integration/
    ├── conftest.py
    ├── helpers.py
    ├── plugin_setup_test.py
    └── plugin_functionality_tests.py

---

How to Run Integration Tests

Execute the following command to run the integration tests:

make integration-tests

[Ang-m4]

This PR was reviewed and successfully merged, take a look at openedx#36