Skip to content

Latest commit

 

History

History
101 lines (71 loc) · 4.37 KB

README.md

File metadata and controls

101 lines (71 loc) · 4.37 KB
Raw

Manytask Checker

Test-workflow Publish-workflow codecov github-version pypi

Checker is a Python cli script to test students' solutions with built-in manytask integration.

  • production-like - setup for students with gitlab-ci, language-specific testing etc
  • customizable - testing pipeline configuration via yaml files
  • extensible - build-in plugins and ability to write custom plugins
    • manytask integration with plugin
    • gitlab merge-requests checks with plugin
    • etc
  • secure - sandbox execution of students' code
  • fast - lightweight script with testing parallelization

Requires Python 3.9+

How it works

The checker lib is a part of the manytask ecosystem and extends its functionality.
Please refer to the manytask documentation first to understand the drill.

tl;dr: Manytask is a web application to manage students', repos, grades and deadlines.
It stores grades in google sheet and deadlines on a web page.
It also automatically creates gitlab repositories for students as forks from Public Repo with tasks and solution templates.

So you have Public Repo and Students' Repositories and Web App to collect grades and deadlines.

For the checker this setup extends with Private Repo with tasks, tests and solutions and gitlab-ci to run tests in.

The checker in a nutshell is a CLI script providing the following functionality:

  • grade - to run in a student's repository to test solution against private and public tests and push scores.
  • validate - to run in a private (tutors') repository to validate tasks and deadlines integrity (will run in check automatically).
  • check - to run in a private (tutors') repository to test gold solutions against private and public tests.
  • export - to run in a private (tutors') repository to export tasks, templates and tests to the public repository.
flowchart LR
    private(Private Repo) -->|checker check| private
    private -->|checker export| public
    student([Student's Repo]) -->|checker grade| manytask
    subgraph gitlab
        public(Public Repo) -.->|fork| student
        public -->|updates| student
    end
Loading

The flow for tutors looks like:

  1. Have a manytask ready with empty public repo
  2. Create private repo with tasks, tests and solutions
  3. Configure checker with yaml files
  4. Make docker with your environment and checker installed
  5. Write ci file from students to run checker grade on each push/mr
  6. Setup private repo ci to run checker check on each push/mr
  7. Setup private repo ci to run checker export on each push/mr oor release or regularly or manually
  8. Profit!

The flow for students looks like:

  1. Register in manytask and get access to the public repo fork
  2. Clone this repo and start working on tasks
  3. Update from public repo regularly to get new tasks and tests
  4. Push your solution to gitlab where checker grade will run and push scores
  5. Profit!

It is a short description, please refer to the checker docs for more details.

Installation

The checker is available on pypi, so you can install it with pip

pip install manytask-checker

Or use pre-built docker image (you can base your image on it)

FROM manytask/checker:0.0.1-python3.12

Please check docker hub for available tags.

Contributing

Really appreciate any contributions!
For guidance on setting up a development environment see the development guide. For styleguide see organization contribution guide.