lc3-ensemble-test

lc3-ensemble-test: Python backend & autograder for LC-3 assembly

This project is built upon lc3-ensemble. This module is an autograder library to test programs written in LC-3 assembly. To see the functions and how to implement an autograder, see doc/API.md.

Installation

To install this package, you can use pip:

pip install lc3-ensemble-test

To install additional packages to help create autograders for GT CS 2110,

pip install "lc3-ensemble-test[std]"

Running

With standard dependencies

There are several ways to display test results using pytest's built-in functionality.

Display in command-line

pytest 

Display as HTML

pytest --html=report.html --self-contained-html

The conftest.py provided in examples/ will automatically open the generated page in a web browser.

Display as JUnitXML

pytest --junitxml=report.xml

Without standard dependencies

If standard dependencies are not included, autograders can still be run with unittest.

python3 -m unittest <DIR>

Development

Development Setup

• Create a Python virtual environment with python -m venv venv
• Activate the environment by running the activate script:
  • Windows: venv\Scripts\activate
  • Other: source venv/bin/activate
• Install maturin (pip install maturin)
• Run maturin develop
• Import the ensemble_test.core or ensemble_test.autograder modules while inside the virtual environment

You can run the autograder tests with the following:

cd tests
pytest

Development Installation

If installing directly from this repository,

• pip install .: Install the barebones autograder
• pip install ".[std]": Install the autograder and additional packages to help create autograders for CS 2110.