Drop Project - Continuous Auto-Grader

Videos (Setup and Results)

Setup video: https://youtu.be/-anDD6zGHr0

This video explains the process of setting Drop Project up either locally or using the Heroku deployment service. This is not a necessary process to run the project as the heroku link, found in the chapter found below, allows you to run it using a version of Drop Project deployed by the GitHub owner.

Demonstration video: https://youtu.be/YPrNa21vFEw

This video demonstrates how to achieve the results found in the report. This is not a guide of any sorts, serving simply as a means of showing that the results obtained can be found in the project. The user can also use this video to understand how the project works and how to move around it.

Server (Link and Description)

Server link: https://drop-project.duckdns.org/

In this Server you can use all of the services capabilities, excluding Android, without needing to set anything up. The service is ran on a server setup by the TFC advisor and is updated with the current version of the project.

Heroku (Deployment and Usage)

The button found above can be used to deploy the GitHub project to a server managed by Heroku but run by the user. Use this button in case you wish to setup the project using Heroku, therefore allowing it to be used by others who can access it.

In case you dont want to setup the project, you can use the link found below to run the version that was deployed by the GitHub owner. This is run using the Heroku servers and is the latest version of the project.

Link to Heroku: https://drop-project-tfc.herokuapp.com/

Additional GitHubs used

Maven Assignment (Kotlin): https://github.com/Diogo-a21905661/test-kotlin-maven-assignment

Gradle Assignment (Kotlin): https://github.com/Diogo-a21905661/test-kotlin-gradle-assignment

Gradle Assignment (Java): https://github.com/Diogo-a21905661/test-java-gradle-assignment

Kotlin Submission (usable in both Maven and Gradle): https://github.com/Diogo-a21905661/test-kotlin-submission

Android Assignment (Kotlin): https://github.com/Diogo-a21905661/test-kotlin-android-assignment

Android Submission (Kotlin): https://github.com/Diogo-a21905661/test-android-submission

Description

A web application where students drop their projects to check for correctness and quality.

Several checks are performed on each project:

• Does it have the right folder structure and all the mandatory files?
• Does it compile?
• Does it pass its own tests?
• Does it achieve a minimum coverage with its own tests?
• Does it pass the teacher tests?
• Does it conform to the coding guidelines defined by the teacher?
• Does it perform well? (tests with large datasets are measured)

Requirements

• Java 11 JDK (a compiler is needed)
• Maven
• Servlet Engine (Tested with tomcat and jetty)
• MySQL

Current limitations

• Only works for Java 8+ / Kotlin non-maven projects

How does it work?

Most of the work is done either by a Maven Invoker or a Gradle Invoker, running several goals on the project. The results are collected into a report that is viewable by the student and the teacher.

Projects must not be maven projects because they are "mavenized" by the server, after uploading. They can be gradle projects as they are checked for during compilation. In this context, "mavenizing", means copying the files into a proper Maven folder structure (e.g. putting the sources into /src/main/java), mixing the student files with the teacher unit tests and adding a pom.xml (also provided by the teacher).

Since checking a project may take some time, it is done asynchronously - the student submits the file and must come back later to check the report.

This video explains how to create a simple Java assignment in Drop Project. It shows both teacher and student perspectives:

https://www.youtube.com/watch?v=65IwIBuMDlE

Quick start

After cloning the repository, change the following properties:

dropProject.maven.home=<path_to_maven_home>
dropProject.maven.repository=<path_to_maven_repository>

in the following files:

 src/main/resources/drop-project.properties
 src/test/resources/drop-project-test.properties 

In case you want to upload Android assignments, via the Drop Project engine, you will also need to add the following property:

dropProject.android.home=<path_to_android_sdk>

in the following file:

 src/main/resources/drop-project.properties

This property is the Android SDK, and it will be used for the compilation of Android assignments and submissions. To install the SDK, first you have to install Android Studio. In this IDE you can install an SDK and then move it to a new folder. This folder will be the path to your Android SDK and is be the property you will want to use.

Note:

• Configuring the first file will allow you to run Drop Project.
• Configuring the second file will allow you to run Drop Project's unit tests.
• Linux users: the Maven Home is usually in /usr/share/maven (otherwise, try: whereis maven) and the Maven Repository is in /home/USERNAME>/.m2
• Windows users: the Maven Home is the installation directory and the Maven Repository is in c:\Users\<USERNAME>\.m2

And run the embedded tomcat runner:

mvn spring-boot:run

The application should now be accessible on http://localhost:8080

Running with docker

Demo mode (in memory database)

docker run -p 8080:8080 pedroalv3s/drop-project-demo

Production mode (using mysql)

Clone the project and in the root folder execute:

docker compose up

The application should now be accessible on http://localhost:8080

Documentation

https://drop-project-edu.github.io/drop-project/

To generate source code documentation, run:

mvn dokka:dokka

The generated documentation will be available in the following folder:

target/dokka/drop-project/index.html

Unit Tests

To execute the unit tests, run:

mvn test

Unit Test Coverage

To measure the unit test coverage, run:

mvn jacoco:report

Note: to run the coverage measurement, you must first run the unit tests themselves.

The test coverage report will be available in the following folder:

target/site/jacoco/index.html