feat(tests): add integration tests for Tutor Paragon plugin functionality

Author: Ang-m4

plugins/tutor-contrib-paragon/tests/integration/plugin_functionality_test.py

@@ -0,0 +1,86 @@
+"""
+Integration tests for the Tutor Paragon plugin functionality.
+
+This module contains tests to verify that the Paragon plugin for Tutor
+is functioning correctly, including building tokens with and without options,
+and handling invalid flags or parameters.
+"""
+
+import pytest
+import os
+import shutil
+
+from .helpers import (
+    execute_tutor_command,
+    get_tutor_root_path,
+    PARAGON_JOB,
+    PARAGON_COMPILED_THEMES_FOLDER,
+)
+
+
+@pytest.fixture(autouse=True)
+def clean_compiled_themes_folder():
+    """
+    Ensure the compiled-themes folder is empty before each test.
+    """
+    tutor_root = get_tutor_root_path()
+    compiled_path = os.path.join(tutor_root, PARAGON_COMPILED_THEMES_FOLDER)
+
+    if os.path.isdir(compiled_path):
+        shutil.rmtree(compiled_path)
+
+    os.makedirs(compiled_path, exist_ok=True)
+
+
+def test_build_tokens_without_options():
+    """
+    Verify that running the build-tokens job without additional options
+    completes successfully and produces output in the compiled-themes folder.
+    """
+
+    result = execute_tutor_command(["local", "do", PARAGON_JOB])
+    assert result.returncode == 0, f"Error running build-tokens job: {result.stderr}"
+
+    tutor_root = get_tutor_root_path()
+    compiled_path = os.path.join(tutor_root, PARAGON_COMPILED_THEMES_FOLDER)
+
+    contents = os.listdir(compiled_path)
+    assert contents, f"No files were generated in {compiled_path}."
+
+
+def test_build_tokens_with_specific_theme():
+    """
+    Verify that running the build-tokens job with the --themes option
+    for a specific theme (e.g., 'indigo') produces the expected output.
+    """
+    theme = "indigo"
+
+    result = execute_tutor_command(["local", "do", PARAGON_JOB, "--themes", theme])
+    assert result.returncode == 0, f"Error building {theme} theme: {result.stderr}"
+
+    tutor_root = get_tutor_root_path()
+    compiled_path = os.path.join(tutor_root, PARAGON_COMPILED_THEMES_FOLDER, "themes")
+
+    entries = os.listdir(compiled_path)
+    assert theme in entries, f"'{theme}' theme not found in {compiled_path}."
+
+    theme_path = os.path.join(compiled_path, theme)
+    assert os.path.isdir(theme_path), f"Expected {theme_path} to be a directory."
+    assert os.listdir(theme_path), f"No files were generated inside {theme_path}."
+
+
+def test_build_tokens_with_invalid_flag_or_parameter():
+    """
+    Verify that running the build-tokens job with an invalid flag or parameter
+    returns a non-zero exit code and does not produce any files.
+    """
+    result = execute_tutor_command(["local", "do", PARAGON_JOB, "--invalid-flag"])
+    assert (
+        result.returncode != 0
+    ), "Expected non-zero return code when using an invalid flag."
+
+    tutor_root = get_tutor_root_path()
+    compiled_path = os.path.join(tutor_root, PARAGON_COMPILED_THEMES_FOLDER)
+
+    contents = os.listdir(compiled_path)
+    assert not contents, f"Expected no files in {compiled_path} after invalid command."