Add opt-in TeX compilation test utility for good question fixtures by ammarokla123 · Pull Request #46 · edulinq/quiz-composer

ammarokla123 · 2026-02-25T05:51:59Z

This PR addresses #37 by adding a dedicated, opt-in test path that generates and compiles TeX for question fixtures without slowing the default Python test suite.

What changed

Added a new script: scripts/test_tex_compilation_questions.sh
Script behavior:
- Discovers all tests/questions/good/**/question.json fixtures
- Generates TeX per fixture using project converter logic
- Compiles each TeX file twice (local pdflatex or Docker mode)
- Verifies PDF output exists and has a minimum size
- Prints per-fixture pass/fail + summary, exits non-zero on failures
Added script options:
- --use-docker
- --pdflatex-bin <path>
- --python-bin <path>
- --keep-temp
Updated README.md:
- Added a Testing section
- Documented this as an optional TeX compilation check outside run_tests.py

Why

The existing suite validates parsing/conversion and PDF generation paths, but issue TeX Compilation Tests #37 asks for explicit TeX generation + compilation checks per good question fixture.
This is intentionally separate from normal test runs to avoid adding significant runtime overhead for regular contributors.

Validation

./scripts/test_tex_compilation_questions.sh --use-docker
Result: pass=63, fail=0, total=63

Closes #37.

eriq-augustine

A commendable first start.

The biggest problem here is complexity.
There are many places where this code is way more complex than it needs to be (I only noted a few).
In this project, we try to embrace KISS whenever we can.
The bash scripts in this project are meant to be simple.
Decide on what you need to do to make your test running more straightforward.

You need to also make sure these tests are run in CI.
One of the biggest reasons we have tests is to run them in CI,
so we don't want to miss out on that.

README.md

scripts/test_tex_compilation_questions.sh

README.md

scripts/test_tex_compilation_questions.sh

ammarokla123 · 2026-02-25T07:43:16Z

Thank you @eriq-augustine for your quick feedback.

I believe I have addressed all the changes. Ran the test again and passed.

eriq-augustine

Looking much better and simpler.

You should also compile the good quizzes.

README.md

scripts/test_tex_compilation_questions.sh

README.md

eriq-augustine

Getting pretty close.

Try to keep maintainability (which includes simplicity and readability) in mind when working on this.

Also, make sure to run the CI in your fork.

scripts/test_tex_compilation_questions.sh

README.md

ammarokla123 · 2026-02-26T11:09:37Z

CI run in my fork: https://github.com/ammarokla123/quiz-composer/actions/runs/22438951696

All tests passed

eriq-augustine

Getting pretty close.
There are still some complexity issues,
but you can see the design really getting good.

quizcomp/cli/pdf/create_question.py

quizcomp/pdf.py

scripts/test_tex_compilation_questions.sh

README.md

… and refactor PDF creation functions for improved argument handling

eriq-augustine

Getting closer.

SILL complexity is the biggest issue in your PR.
Really slow down and ask yourself how direct you are being.

KISS - Keep It Super Simple
(My version is a little nicer than the standard version.)

eriq-augustine · 2026-02-27T14:52:08Z

quizcomp/pdf.py

+    if (not os.path.exists(question_path)):
+        raise ValueError(f"Provided path '{question_path}' does not exist.")
+
+    if (not os.path.isfile(question_path)):
+        raise ValueError(f"Provided path '{question_path}' is not a file.")
+


Seem like duplicate work with make_from_question_with_args().

I would just do this here (and update make_with_args()/make_with_path()) to follow your pattern.

eriq-augustine · 2026-02-27T14:53:34Z

quizcomp/pdf.py

+def make_from_question(question, out_dir = None,
+        answer_key = False, skip_tex = False, skip_pdf = False):
+    if (out_dir is None):
+        out_dir = quizcomp.util.dirent.get_temp_path(prefix = 'quizcomp_pdf_question_', rm = False)


You have to make some sort of log so the user knows where the output is being written.

eriq-augustine · 2026-02-27T14:54:13Z

quizcomp/pdf.py

+    return make_from_question(question, **kwargs)
+
+def make_from_question(question, out_dir = None,
+        answer_key = False, skip_tex = False, skip_pdf = False):


This should accept a kwargs (since you are passing a splat elsewhere).

eriq-augustine · 2026-02-27T15:02:54Z

quizcomp/pdf.py


    return parser
+
+def set_cli_question_args(parser):


!

Share code with the exiting args function.

eriq-augustine · 2026-02-27T15:04:04Z

scripts/test_tex_compilation_questions.sh

+    local base_dir="$2"
+    local case_filename="$3"
+    local cli_module="$4"
+    local create_fail_message="$5"


Don't need this.
The path and vase type will tell the user what they need.

eriq-augustine · 2026-02-27T15:09:56Z

scripts/test_tex_compilation_questions.sh

+    local question_pass=0
+    local question_fail=0
+    run_tests "question" "${GOOD_QUESTIONS_DIR}" "question.json" "quizcomp.cli.pdf.create_question" \
+        "question PDF creation failed." "missing PDF output." question_pass question_fail || return $?


Why exit early?

eriq-augustine · 2026-02-27T15:12:03Z

scripts/test_tex_compilation_questions.sh

+
+    echo ''
+    echo "TeX compilation test summary: pass=${num_pass}, fail=${num_fail}, total=${total_count}"
+    echo "Output directory: ${OUTPUT_DIR}"


Mention the output directly early, not at the end.
(This is especially important if you are exiting early (which I don't want you to do here).)

eriq-augustine · 2026-02-27T15:12:43Z

README.md

+
+### Optional TeX Compilation Tests
+
+This optional script validates end-to-end TeX/PDF generation for good test fixtures.


eriq-augustine · 2026-02-27T15:13:36Z

README.md

+
+### Optional TeX Compilation Tests
+
+This optional script validates end-to-end TeX/PDF generation for good test fixtures.


You mention a script, but don't make it concrete for two more paragraphs.
No need to talk about it as a "script".

eriq-augustine · 2026-02-27T15:14:27Z

README.md

+
+### Optional TeX Compilation Tests
+
+This optional script validates end-to-end TeX/PDF generation for good test fixtures.


"test fixtures" is too abstract.
Remember, all users (regardless of experience) have access to the readme.

ammarokla123 added 2 commits February 25, 2026 09:47

Add TeX Compilation Tests

5a6e8cc

Update README.md

bf9bde3

github-project-automation bot added this to development Feb 25, 2026

github-project-automation bot moved this to Todo in development Feb 25, 2026

eriq-augustine requested changes Feb 25, 2026

View reviewed changes

ammarokla123 added 3 commits February 25, 2026 11:38

Update main.yml

0f0b03f

Update test_tex_compilation_questions.sh

ec96701

Update README.md

cc549a2

ammarokla123 requested a review from eriq-augustine February 25, 2026 08:23

eriq-augustine requested changes Feb 25, 2026

View reviewed changes

ammarokla123 added 2 commits February 26, 2026 07:25

Update test_tex_compilation_questions.sh

ff0e8e5

Update README.md

d66124b

ammarokla123 requested a review from eriq-augustine February 26, 2026 03:27

eriq-augustine requested changes Feb 26, 2026

View reviewed changes

Enhance PDF creation functionality and improve TeX compilation tests

48c258e

ammarokla123 requested a review from eriq-augustine February 26, 2026 10:34

ammarokla123 added 2 commits February 26, 2026 10:38

Clarify wording in README.md regarding TeX compilation tests

90361ef

Fix: Make test_tex_compilation_questions.sh executable

8e58268

eriq-augustine requested changes Feb 26, 2026

View reviewed changes

ammarokla123 added 2 commits February 27, 2026 07:23

Enhance README.md with description for optional TeX compilation tests…

18a02ff

… and refactor PDF creation functions for improved argument handling

Fix: Make test_tex_compilation_questions.sh executable

3e0057d

ammarokla123 requested a review from eriq-augustine February 27, 2026 08:36

eriq-augustine requested changes Feb 27, 2026

View reviewed changes


		### Optional TeX Compilation Tests

		This optional script validates end-to-end TeX/PDF generation for good test fixtures.

Uh oh!

Conversation

ammarokla123 commented Feb 25, 2026

What changed

Why

Validation

Uh oh!

eriq-augustine left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ammarokla123 commented Feb 25, 2026

Uh oh!

eriq-augustine left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

eriq-augustine left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ammarokla123 commented Feb 26, 2026

Uh oh!

eriq-augustine left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

eriq-augustine left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!