feat(tests): enhance integration tests and add cleanup fixture for compiled themes

Author: Ang-m4

plugins/tutor-contrib-paragon/Makefile

@@ -25,7 +25,7 @@ unittest: ## Run code tests cases
 	pytest tests --ignore=tests/integration
 
 integration-test: ## Run integration tests cases
-	pytest tests/integration
+	pytest tests/integration --order-scope=module
 
 dev-requirements: ## Install dev requirements
 	pip install -e .[dev]

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

@@ -7,6 +7,9 @@
 """
 
 import os
+import shutil
+import pytest
+import re
 
 from .helpers import (
     execute_tutor_command,
@@ -16,6 +19,19 @@
 )
 
 
+@pytest.fixture(autouse=True)
+def clear_compiled_themes_folder():
+    """
+    Fixture to clear the PARAGON_COMPILED_THEMES_FOLDER after each test.
+    """
+    yield
+    tutor_root = get_tutor_root_path()
+    compiled_path = os.path.join(tutor_root, PARAGON_COMPILED_THEMES_FOLDER)
+    if os.path.exists(compiled_path):
+        shutil.rmtree(compiled_path)
+
+
+@pytest.mark.order(1)
 def test_build_tokens_without_options():
     """
     Verify that running the build-tokens job without additional options
@@ -32,6 +48,7 @@ def test_build_tokens_without_options():
     assert contents, f"No files were generated in {compiled_path}."
 
 
+@pytest.mark.order(2)
 def test_build_tokens_with_specific_theme():
     """
     Verify that running the build-tokens job with the --themes option
@@ -53,12 +70,78 @@ def test_build_tokens_with_specific_theme():
     assert os.listdir(theme_path), f"No files were generated inside {theme_path}."
 
 
-def test_build_tokens_with_invalid_flag_or_parameter():
+@pytest.mark.order(3)
+def test_build_tokens_excluding_core():
+    """
+    Verify that running the build-tokens job with the --exclude-core option
+    excludes the core theme from the output.
+    """
+    result = execute_tutor_command(["local", "do", PARAGON_JOB, "--exclude-core"])
+    assert result.returncode == 0, f"Error excluding core theme: {result.stderr}"
+
+    tutor_root = get_tutor_root_path()
+    compiled_path = os.path.join(tutor_root, PARAGON_COMPILED_THEMES_FOLDER)
+
+    entries = os.listdir(compiled_path)
+    assert "core" not in entries, "Core theme should be excluded but was found."
+
+
+@pytest.mark.order(4)
+def test_build_tokens_without_output_token_references():
+    """
+    Ensure that when the build-tokens job is run with --output-references=false,
+    the generated variables.css file does not contain any CSS variable references (var(--...)).
+    """
+    result = execute_tutor_command(
+        ["local", "do", PARAGON_JOB, "--output-references=false"]
+    )
+    assert (
+        result.returncode == 0
+    ), f"Error running build-tokens with --output-references=false: {result.stderr}"
+
+    tutor_root = get_tutor_root_path()
+    compiled_path = os.path.join(tutor_root, PARAGON_COMPILED_THEMES_FOLDER)
+
+    core_variables_css = os.path.join(compiled_path, "core", "variables.css")
+    theme_variables_css = os.path.join(compiled_path, "themes", "light", "variables.css")
+
+    assert os.path.exists(core_variables_css), f"{core_variables_css} does not exist."
+    assert os.path.exists(theme_variables_css), f"{theme_variables_css} does not exist."
+
+    with open(core_variables_css, "r", encoding="utf-8") as f:
+        core_content = f.read()
+    with open(theme_variables_css, "r", encoding="utf-8") as f:
+        theme_content = f.read()
+
+    token_reference_pattern = re.compile(r"var\(--.*?\)")
+    core_references = token_reference_pattern.findall(core_content)
+    theme_references = token_reference_pattern.findall(theme_content)
+
+    assert (
+        not core_references
+    ), f"{core_variables_css} should not contain token references, but found: {core_references}"
+    assert (
+        not theme_references
+    ), f"{theme_variables_css} should not contain token references, but found: {theme_references}"
+
+
+@pytest.mark.order(5)
+def test_build_tokens_with_source_tokens_only():
     """
-    Verify that running the build-tokens job with an invalid flag or parameter
-    returns a non-zero exit code.
+    Ensure that when the build-tokens job is run with --source-tokens-only,
+    the utility-classes.css file is not generated.
     """
-    result = execute_tutor_command(["local", "do", PARAGON_JOB, "--invalid-flag"])
+    result = execute_tutor_command(["local", "do", PARAGON_JOB, "--source-tokens-only"])
     assert (
-        result.returncode != 0
-    ), "Expected non-zero return code when using an invalid flag."
+        result.returncode == 0
+    ), f"Error running build-tokens with --source-tokens-only: {result.stderr}"
+
+    tutor_root = get_tutor_root_path()
+    light_theme_path = os.path.join(
+        tutor_root, PARAGON_COMPILED_THEMES_FOLDER, "themes", "light"
+    )
+    utility_classes_css = os.path.join(light_theme_path, "utility-classes.css")
+
+    assert not os.path.exists(
+        utility_classes_css
+    ), f"{utility_classes_css} should not exist when --source-tokens-only is used."

plugins/tutor-contrib-paragon/tutorparagon/templates/paragon/build/paragon-builder/entrypoint.sh

@@ -53,6 +53,7 @@ npx paragon build-tokens \
 # Moves the built themes to the final volume directory.
 mkdir -p "$FINAL_BUILD_DIR"
 cp -a "$TMP_BUILD_DIR/." "$FINAL_BUILD_DIR/"
+chmod -R a+rw "$FINAL_BUILD_DIR"
 
 # Clean up
 rm -rf "$TMP_BUILD_DIR"