java-gradescope-autograder-helper 1.2.9.1

A helper package for setting up Gradescope autograder tests for Java projects

Java Gradescope Autograder Helper

A tool for creating, running, and packaging Java autograders for Gradescope.

More easily and quickly create and test Gradescope autograders for Java assignments. By leveraging a reference solution and standard output, there is no need to hard code test cases. And, with a Python config file, you get the full benefits of writing tests in an easy-to-use coding language.

PyPi GitHub

Installation

pip install java-gradescope-autograder-helper

Quick Start

1. Initialize the Gradescope environment locally: autograder init.
2. Put reference solution with a main(String[] args) entry point and any other required files in autograder/source/.
3. Edit autograder/source/tests.py.
4. Put an example student submission in autograder/submission/.
5. Test by navigating to /autograder and running autograder run tests.py.
6. Check results in autograder/results/results.json.
7. Zip the contents inside autograder/source/ by runinng autograder zip.
8. Upload to Gradescope with "Base Image OS" Ubuntu 22.04 with "Base Image Variant" JDK 17.

The whole flow for working with this package rests on the structure Gradescope creates in the docker containers it spins up for each student submission. Having that structure locally allows you to quickly iterate without depending on uploading it to Gradescope. You can refer to the Gradescope autograder file hierarchy documentation for more information on how/why the autograder is structured this way.

More comprehensive documentation is available under the Examples section.

Commands

• autograder: Display the help menu.
• autograder init: Initialize the Gradescope environment in current directory.
• autograder run <tests.py>: Run the autograder locally.
• autograder zip: Zip the contents inside autograder/source/ when in base directory.

Features

The motivation for this package came after noticing the countless hours my professors had to spend creating Gradescope autograders for Java assignments. Additionally, I could not find packages that did exactly what I wanted online. I needed something with comprehensive documentation, that did not require much configuration. This package aims to provide a solution to these problems.

• No need to hardcode test cases, simply provide a reference solution.
• Independent of reference or student submission file structure, as long as it has the appropriate main(String[] args) entry point.
• Easily test autograder locally.
• Create custom functions for more versatility when testing student output.
• Test student syntax with Checkstyle by providing a custom config. You can edit or extend the default config by downloading it at: GitHub/bowdoin-checks.
• Easily package to uplaod to Gradescope.
• Comprehensive documentation and examples.
• Easily extensible because it uses a .py file for the configuration.
• Individually time out test cases instead of the global-only Gradescope timeout.
• TODO: Create custom style evaluation functions.

Examples

A comprehensive example is available on every execution of autograder init. Additionally, all generated files contain small descriptions and references to their purpose in the original Gradescope documentation.

Here is a sample of what autograder init generates: GitHub/examples.

The most important file is autograder/source/tests.py. This file contains all the configurations for the autograder and the test cases that will be run on the reference and student solutions.

Release Notes

• 1.2.9:
  • Hide student stderr and most of student stdout to not allow students to expose sensitive autograder information.
  • Writing student stderr and stdout and reference stdout to an "extra_data" field that is not shown on Gradescope.
  • Add to compilation error message that it was likely caused due to different JDK versions. As of now, Gradescope uses JDK 17.
  • Set a default timeout of 1 second.
  • Stopped using default of 0 for "max_score" and instead made it required.
  • Create the "results" folder in case it does not exist when writing "results.json".
  • Print package stdout and stderr to stdout so that Gradescope can capture it.
• 1.2.8:
  • Made autograder stdout visible to students.
• 1.2.7:
  • Improved file searching. Now displays all paths when multiple matches are found and uses exact matching with forward slashes to prevent partial matches (e.g., "my_file" will match "path/to/my_file" but not "path/to/hello_my_file").
  • When running autograder init, it will first check if an autograder environment already exists to remove the risk of overriding.
  • Added a warning when executing the autograder run command outside of the autograder directory.
• 1.2.6:
  • Removed dotenv dependency.
  • Now catches configuration error if javac is not installed.
• 1.2.5: Added additional option to time out student submissions.