AssignmentOS Lecturer & TA User Guide
  • 👋Welcome to AssignmentOS!
  • 🖌️Create Custom Assignment
    • 1️⃣Select/Create Course
    • 2️⃣Choose Language/Framework
    • 3️⃣Set Deadline
    • 4️⃣Add Description & Starter Code
    • 5️⃣Define Grading Criteria
  • 🤖Automated Grading
    • Automated Test-Suite Scoring
    • Hidden Tests
    • Language/Framework Guides
      • Java (Maven)
      • Java (Gradle)
      • Kotlin (Maven)
      • Kotlin (Gradle)
      • Scala
      • JavaScript
      • TypeScript
      • Python
      • Ruby
      • Go
      • PHP
      • .NET
      • C++
      • Rust
      • Haskell
      • Elixir
      • Solidity
      • SQL
      • Swift
      • R
      • Web
      • Angular
      • AngularJS
      • React
      • React Native
      • Vue.js
      • Svelte
      • Elm
      • Rails
      • Django
      • WordPress
      • Terraform
      • Ansible
      • Powershell
      • Full-Stack
  • 📤Sending Assignments
    • From UI
    • From LMS
    • From API
  • 🔎Tracking
    • Student Tracking
    • Self-Tracking For Students
  • 👁️Reviewing Results
    • View Score & Status
    • View Report
    • View AI Feedback
  • 💬Feedback
    • Leaving Feedback In-App
    • Leaving Feedback in GitHub/GitLab Repo
  • 🤹Management
    • Manage Courses
      • Create New Course
      • Duplicate Course
      • Delete Course
    • Manage Assignments
      • Update Assignment
      • Delete Assignment
    • Manage Users
      • Add New Users
      • User Roles
      • Delete Users
  • 🤍White-Labelling
    • Editing Email Templates
    • Editing From Email Address
  • 💫LMS Integrations
    • Moodle
      • 1️⃣Connect AssignmentOS
      • 2️⃣Add Assignment
      • 3️⃣Access Assignment
        • As a Lecturer/TA
        • As a Student
    • Blackboard
    • Canvas
      • 1️⃣Connect AssignmentOS
      • 2️⃣Add Assignment
      • 3️⃣Access Assignment
        • As a Lecturer/TA
        • As Student
    • Brightspace
    • Schoology
  • 🔐Plagiarism Checker
    • Plagiarism Checker
  • 📊Analytics
    • Course Level
    • Assignment Level
  • ⚙️API
    • Workflow
    • Authentication
    • Endpoints
      • Load Assignments Endpoint
      • Start Assignment Endpoint
      • Load Assignment Instance Endpoint
    • Error Responses
  • ❓FAQ
    • Can I edit an assignment after I send it?
Powered by GitBook
On this page

Was this helpful?

  1. Automated Grading
  2. Language/Framework Guides

Java (Maven)

PreviousLanguage/Framework GuidesNextJava (Gradle)

Last updated 1 year ago

Was this helpful?

To create a new assignment in Java (Maven), click into one of your courses, and then click Add assignment. Choose Java (Maven) from the drop-down list of available backend languages and set the the rest of your assignment's parameters (deadline, etc.). Once the assignment is created, a new folder will be created in the private GitHub/GitLab template repository for the course in which you are added this assignment. This folder will contain a standard Maven project structure:

Automated test-suite setup

If you would like to add tests that are automatically run by CodeScreen against each student's solution to your assignment, you can add these as test classes in the src/test/java/ directory.

All unit test class names must end with "Test" and all unit test classes with names that end with "HiddenTest" will not be visible to the student. These hidden unit tests allow you to test students' solutions against edge cases etc.

If you want to add files that your hidden unit tests use and hence are also not visible to the student, the names of these files must begin with hidden (case-insensitive), e.g., hiddenFoo.json, hiddenFoo.csv, HiddenFoo.java, etc.

The assignment must be compatible with Java 16.

GitHub Actions & GitLab CI/CD

AssignmentOS uses either GitHub Actions or GitLab CI/CD (depending on whether you use GitHub or GitLab) to run automated unit tests. We provide the following GitHub Action & GitLab CI/CD file for Java (Maven) assignments. Note that this file is added dynamically to the repo of each student taking your assignment, so please do not include it in your template repo. This file also cannot be changed.

GitHub Action .yml file
GitLab CI/CD .yml file

Examples

All unit tests must use the test framework and the pom.xml file may only be updated to add dependencies required for your assignment.

An example Java assignment that uses automated test suite scoring can be seen here: .

🤖
name: Java CI

on: push

jobs:

  run-unit-tests:

    runs-on: ubuntu-latest

    steps:
    
    - uses: actions/checkout@v3
    
    - name: Set up JDK 1.17
      uses: actions/setup-java@v3
      with:
        distribution: oracle
        java-version: 17
        
    - name: Build and Test
      run: mvn clean test --no-transfer-progress
image: maven:3-openjdk-11

cache:
  paths:
    - .m2/repository/
    - target/

stages:
  - test
  
run-unit-tests:
  stage: test
  script:
    - mvn clean test
    
    
    
    
    
    
    
Junit
https://github.com/AssignmentOS-HQ/Java-Maven-AssignmentOS-Fibonacci