Struct AntPlugin

pub struct AntPlugin { /* private fields */ }

Implementations

impl AntPlugin

pub fn new() -> Result<AntPlugin, JavaError>

pub fn copy_tmc_junit_runner(dest_path: &Path) -> Result<(), JavaError>

Writes the bundled tmc-junit-runner into dest_path/lib/testrunner/tmc-junit-runner.jar

Trait Implementations

impl LanguagePlugin for AntPlugin

Project directory: Contains build.xml file. OR Contains src and test directories.

fn scan_exercise( &self, path: &Path, exercise_name: String, ) -> Result<ExerciseDesc, TmcError>

Scans the exercise at the given path. Immediately exits if the target directory is not a valid exercise.

fn is_exercise_type_correct(path: &Path) -> bool

Checks if the directory contains a build.xml file, or a src and a test directory.

const PLUGIN_NAME: &'static str = "apache-ant"

const DEFAULT_SANDBOX_IMAGE: &'static str = "eu.gcr.io/moocfi-public/tmc-sandbox-java:latest"

const LINE_COMMENT: &'static str = "//"

const BLOCK_COMMENT: Option<(&'static str, &'static str)>

type StudentFilePolicy = AntStudentFilePolicy

fn check_code_style( &self, path: &Path, locale: Language, ) -> Result<Option<StyleValidationResult>, TmcError>

Run checkstyle or similar plugin to project if applicable, no-op by default

fn run_tests_with_timeout( &self, project_root_path: &Path, timeout: Option<Duration>, ) -> Result<RunResult, TmcError>

Runs the tests for the exercise with the given timeout. Used by run_tests with the timeout from the project config.

fn find_project_dir_in_archive<R>( archive: &mut Archive<R>, ) -> Result<PathBuf, TmcError>

where R: Read + Seek,

Searches the zip for a valid project directory. This function is used to detect the language plugin for the archive, so simply finding “src” is not sufficient, e.g. the Python plugin should check that there is an actual “src/*.py” file inside src. Note that the returned path may not actually have an entry in the zip.

fn clean(&self, path: &Path) -> Result<(), TmcError>

Runs clean command e.g make clean for make or mvn clean for maven.

fn points_parser(i: &str) -> Result<(&str, Vec<&str>), Err<VerboseError<&str>>>

A nom parser that recognizes a points annotation and returns the inner points value(s).

fn get_default_student_file_paths() -> Vec<PathBuf>

fn get_default_exercise_file_paths() -> Vec<PathBuf>

fn run_tests(&self, path: &Path) -> Result<RunResult, TmcError>

Runs the tests for the exercise.

fn extract_project<R>( archive: &mut Archive<R>, target_location: &Path, clean: bool, ) -> Result<(), TmcError>

where R: Read + Seek,

Extract a given archive file containing a compressed project to a target location.

fn extract_student_files( compressed_project: impl Read + Seek, compression: Compression, target_location: &Path, ) -> Result<(), TmcError>

Extracts student files from the compressed project. It finds the project dir from the zip and extracts the student files from there. Overwrites all files. Important: does not extract .tmcproject.yml from the students’ submission as they control that file and they could use it to modify the test files.

fn safe_find_project_dir_in_archive<R>(archive: &mut Archive<R>) -> PathBuf

where R: Read + Seek,

A safer variant of find_project_dir_in_archive used by default extraction helpers.

fn is_archive_type_correct<R>(archive: &mut Archive<R>) -> bool

where R: Read + Seek,

Tells if there’s a valid exercise in this archive. Unlike is_exercise_type_correct, searches the entire archive.

fn get_exercise_packaging_configuration( path: &Path, ) -> Result<ExercisePackagingConfiguration, TmcError>

Returns configuration which is used to package submission on tmc-server.

fn get_available_points(exercise_path: &Path) -> Result<Vec<String>, TmcError>

Parses exercise files using Self::LINE_COMMENT and Self::BLOCK_COMMENT to filter out comments and Self::points_parser to parse points from the actual code.