Commit c7d44bee authored by Abbassy's avatar Abbassy
Browse files

Restore detailed README with assets and current behavior

parent c1364ffd
Dockerized Test Agent Feedback (assignfeedback_dta) Dockerized Test Agent Feedback (assignfeedback_dta)
================================================== ==================================================
Purpose Overview
------- --------
- Provides an informational column “Dockerized Test Agent Feedback” in the grading table. Feedback plugin of the MoDTA system. It reads the DTA submission results and shows an informational **percentage** in the grading table column “Dockerized Test Agent Feedback”. The feedback block itself is hidden. Optionally, it can **apply** the calculated grade to Moodle when “Grade automatically” is enabled (default is **off**).
- Shows only the suggested grade percentage from the DTA backend; feedback block stays hidden.
- Optional auto-grading: when “Grade automatically” is enabled, the plugin applies grades; otherwise it only displays the suggestion. How it works
------------
1. Student submits via `assignsubmission_dta`; backend writes results to `assignsubmission_dta_summary` / `assignsubmission_dta_result`.
2. This plugin reads those rows, calculates a suggested grade (50/50 tests vs. competencies; no “hard 0” rule), and:
- Always shows the percent in the DTA feedback column (if data exists).
- Applies the grade to Moodle only if “Grade automatically” is checked; otherwise the gradebook entry is cleared.
Scenarios
---------
- **Auto grading ON:** Column shows percent; grade is also applied to the assignment grade item.
- **Auto grading OFF:** Column shows percent; gradebook stays empty for manual grading.
- Missing DTA data: column stays empty (handled gracefully).
Installation Installation
------------ ------------
- Unzip into `{moodleroot}/mod/assign/feedback/dta`. - Unzip into `{moodleroot}/mod/assign/feedback/dta`.
- Visit Site administration → Notifications to complete installation. - Go to Site administration → Notifications to finish.
- Ensure the companion submission plugin `assignsubmission_dta` is installed and the DTA backend is reachable (HTTP allowlist/ports configured in Moodle security settings). - Ensure `assignsubmission_dta` is installed and backend access (HTTP allowlist/ports) is configured.
Configuration Configuration
------------- -------------
- Settings → “Grade automatically”: default is **disabled**. - **Grade automatically** (Feedback types): default **disabled**.
- Disabled: only the column shows the suggestion percent (info-only); no grades are applied. - Disabled: percent only (info), gradebook untouched.
- Enabled: the column still shows the suggestion; the plugin also writes the calculated grade. - Enabled: percent shown; grade also written to gradebook.
- Feedback block is suppressed (`is_empty` returns true); all user-facing text is English and sourced from `lang/en/assignfeedback_dta.php`. - Feedback block is suppressed (`is_empty` returns true). All strings are in `lang/en/assignfeedback_dta.php`.
Usage
-----
Teacher enables the feedback type in assignment settings (see `.assets/assignment_settings.png`). Students submit via the submission plugin; teachers see the percent in the grading table (see `.assets/submissions_table.png`). Students see it in their submission view (see `.assets/student_submission_view.png`).
Grade calculation (summary)
---------------------------
- Test score = passed / total (0–100).
- Competency score if present.
- Final percent = 50% tests + 50% competencies (tests 100% if no competencies).
- No “hard 0” for compilation errors; backend values are respected.
Data Data
---- ----
- No own database tables. Reads DTA results from `assignsubmission_dta` tables (`assignsubmission_dta_summary` / `assignsubmission_dta_result`). - No own tables; reads from `assignsubmission_dta_summary` and `assignsubmission_dta_result`.
Behavior notes (current)
------------------------
- Suggested grade is calculated with 50/50 weighting (tests/competencies) as provided by the backend; “hard 0” for compilation errors removed.
- Column renders percent when DTA data exists; nothing else is shown elsewhere. Missing DTA rows are handled gracefully (no output).
Release package Release package
--------------- ---------------
- Top-level folder: `assignfeedback_dta` (ready to unzip into `mod/assign/feedback`). - Top-level folder: `assignfeedback_dta` (unzip into `mod/assign/feedback`).
- ZIP excludes VCS and assets: `.git`, `.assets`. - ZIP excludes VCS/assets (`.git`, `.assets`).
Packaging Packaging
--------- ---------
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment