add support for group restrictions (minimum group size, maximum group size and exceptions to this rule)

Author: palves-ulht

src/main/kotlin/org/dropProject/controllers/AssignmentController.kt

@@ -78,6 +78,7 @@ class AssignmentController(
     val buildReportRepository: BuildReportRepository,
     val jUnitReportRepository: JUnitReportRepository,
     val jacocoReportRepository: JacocoReportRepository,
+    val projectGroupRestrictionsRepository: ProjectGroupRestrictionsRepository,
     val gitClient: GitClient,
     val assignmentTeacherFiles: AssignmentTeacherFiles,
     val submissionService: SubmissionService,
@@ -132,30 +133,52 @@ class AssignmentController(
                                redirectAttributes: RedirectAttributes,
                                principal: Principal): String {
 
-        if (bindingResult.hasErrors()) {
-            return "assignment-form"
-        }
-
         var mustSetupGitConnection = false
 
         if (assignmentForm.acceptsStudentTests &&
             (assignmentForm.minStudentTests == null || assignmentForm.minStudentTests!! < 1)) {
             LOG.warn("Error: You must require at least one student test")
             bindingResult.rejectValue("acceptsStudentTests", "acceptsStudentTests.atLeastOne", "Error: You must require at least one student test")
-            return "assignment-form"
         }
 
         if (!assignmentForm.acceptsStudentTests && assignmentForm.minStudentTests != null) {
             LOG.warn("If you require ${assignmentForm.minStudentTests} student tests, you must check 'Accepts student tests'")
             bindingResult.rejectValue("acceptsStudentTests", "acceptsStudentTests.mustCheck",
                 "Error: If you require ${assignmentForm.minStudentTests} student tests, you must check 'Accepts student tests'")
-            return "assignment-form"
         }
 
         if (!assignmentForm.acceptsStudentTests && assignmentForm.calculateStudentTestsCoverage) {
             LOG.warn("If you want to calculate coverage of student tests, you must check 'Accepts student tests'")
             bindingResult.rejectValue("acceptsStudentTests", "acceptsStudentTests.mustCheck",
                 "Error: If you want to calculate coverage of student tests, you must check 'Accepts student tests'")
+        }
+
+        if (assignmentForm.minGroupSize != null && assignmentForm.minGroupSize!! < 1) {
+            LOG.warn("Min group size must be >= 1")
+            bindingResult.rejectValue("minGroupSize", "minGroupSize.greaterThan1",
+                "Error: Min group size must be >= 1")
+        }
+
+        if (assignmentForm.maxGroupSize != null && assignmentForm.minGroupSize == null) {
+            LOG.warn("If you fill in the max group size, you must also fill in the min group size")
+            bindingResult.rejectValue("minGroupSize", "minGroupSize.mustExist",
+                "Error: If you fill in the max group size, you must also fill in the min group size")
+        }
+
+        if (assignmentForm.minGroupSize != null && assignmentForm.maxGroupSize != null &&
+            assignmentForm.minGroupSize!! > assignmentForm.maxGroupSize!!) {
+            LOG.warn("Max must be greater or equal to min")
+            bindingResult.rejectValue("minGroupSize", "minGroupSize.maxGreaterThanMin",
+                "Error: Max must be greater or equal to min")
+        }
+
+        if (!assignmentForm.exceptions.isNullOrBlank() && assignmentForm.minGroupSize == null) {
+            LOG.warn("Max must be greater or equal to min")
+            bindingResult.rejectValue("exceptions", "exceptions.minSizeNotSet",
+                "Error: Exceptions to group size should only be filled in when you set the min group size")
+        }
+
+        if (bindingResult.hasErrors()) {
             return "assignment-form"
         }
 
@@ -320,6 +343,15 @@ class AssignmentController(
             hiddenTestsVisibility = assignmentForm.hiddenTestsVisibility,
             leaderboardType = assignmentForm.leaderboardType)
 
+        // we only need to check minGroupSize since maxGroupSize and exceptions depend on this field
+        if (assignmentForm.minGroupSize != null) {
+            val projectGroupRestrictions = ProjectGroupRestrictions(minGroupSize = assignmentForm.minGroupSize!!,
+                maxGroupSize = assignmentForm.maxGroupSize,
+                exceptions = assignmentForm.exceptions)
+            projectGroupRestrictionsRepository.save(projectGroupRestrictions)
+            newAssignment.projectGroupRestrictions = projectGroupRestrictions
+        }
+
         // associate tags
         val tagNames = assignmentForm.assignmentTags?.lowercase(Locale.getDefault())?.split(",")
         tagNames?.forEach {
@@ -436,7 +468,10 @@ class AssignmentController(
             cooloffPeriod = assignment.cooloffPeriod,
             hiddenTestsVisibility = assignment.hiddenTestsVisibility,
             maxMemoryMb = assignment.maxMemoryMb,
-            leaderboardType = assignment.leaderboardType
+            leaderboardType = assignment.leaderboardType,
+            minGroupSize = assignment.projectGroupRestrictions?.minGroupSize,
+            maxGroupSize = assignment.projectGroupRestrictions?.maxGroupSize,
+            exceptions = assignment.projectGroupRestrictions?.exceptions,
         )
 
         val assignees = assigneeRepository.findByAssignmentIdOrderByAuthorUserId(assignment.id)

src/main/kotlin/org/dropProject/controllers/InvalidProjectGroupException.kt

@@ -0,0 +1,25 @@
+/*-
+ * ========================LICENSE_START=================================
+ * DropProject
+ * %%
+ * Copyright (C) 2019 Pedro Alves
+ * %%
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * 
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * =========================LICENSE_END==================================
+ */
+package org.dropProject.controllers
+
+/**
+ * Represents an Exception that is raised when the group that submitted a project doesn't comply with the restrictions of the assignment.
+ */
+class InvalidProjectGroupException(message: String?, cause: Throwable? = null) : RuntimeException(message, cause)

src/main/kotlin/org/dropProject/controllers/UploadController.kt

@@ -754,13 +754,19 @@ class UploadController(
     }
 
     @ExceptionHandler(StorageException::class)
-    fun handleStorageError(e: StorageException): ResponseEntity<String> {
+    fun handleError(e: StorageException): ResponseEntity<String> {
         LOG.error(e.message)
         return ResponseEntity("{\"error\": \"Falha a gravar ficheiro => ${e.message}\"}", HttpStatus.INTERNAL_SERVER_ERROR);
     }
 
     @ExceptionHandler(InvalidProjectStructureException::class)
-    fun handleStorageError(e: InvalidProjectStructureException): ResponseEntity<String> {
+    fun handleError(e: InvalidProjectStructureException): ResponseEntity<String> {
+        LOG.warn(e.message)
+        return ResponseEntity("{\"error\": \"${e.message}\"}", HttpStatus.INTERNAL_SERVER_ERROR);
+    }
+
+    @ExceptionHandler(InvalidProjectGroupException::class)
+    fun handleError(e: InvalidProjectGroupException): ResponseEntity<String> {
         LOG.warn(e.message)
         return ResponseEntity("{\"error\": \"${e.message}\"}", HttpStatus.INTERNAL_SERVER_ERROR);
     }

src/main/kotlin/org/dropProject/dao/Assignment.kt

@@ -180,6 +180,10 @@ data class Assignment(
     @JsonView(JSONViews.StudentAPI::class)
     @Transient
     var instructions: AssignmentInstructions? = null,
+
+    @OneToOne(cascade = [CascadeType.REMOVE])
+    @JoinColumn(name = "project_group_restrictions_id")
+    var projectGroupRestrictions: ProjectGroupRestrictions? = null,
 ) {
 
     fun dueDateFormatted(): String? {

src/main/kotlin/org/dropProject/dao/ProjectGroupRestrictions.kt

@@ -0,0 +1,29 @@
+package org.dropProject.dao
+
+import javax.persistence.Entity
+import javax.persistence.GeneratedValue
+import javax.persistence.Id
+import javax.persistence.PrePersist
+
+@Entity
+data class ProjectGroupRestrictions(
+    @Id @GeneratedValue
+    val id: Long = 0,
+
+    var minGroupSize: Int = 1,
+    var maxGroupSize: Int? = null,
+    var exceptions: String? = null  // comma separated list of users that are exempt from the restrictions
+) {
+
+    @PrePersist
+    fun prePersist() {
+        exceptions = exceptions?.replace(" ", "")?.replace("\n", "")
+    }
+
+    fun exceptionsAsList(): List<String>? {
+        if (exceptions == null) {
+            return null
+        }
+        return exceptions!!.split(",").sorted()
+    }
+}

src/main/kotlin/org/dropProject/forms/AssignmentForm.kt

@@ -77,6 +77,10 @@ data class AssignmentForm(
         @field:NotEmpty(message = "Error: Git repository must not be empty")
         var gitRepositoryUrl: String? = null,
 
-        var acl: String? = null
+        var acl: String? = null,
+
+        var minGroupSize: Int? = null,
+        var maxGroupSize: Int? = null,
+        var exceptions: String? = null
 )
 

src/main/kotlin/org/dropProject/repository/ProjectGroupRestrictionsRepository.kt

@@ -0,0 +1,28 @@
+/*-
+ * ========================LICENSE_START=================================
+ * DropProject
+ * %%
+ * Copyright (C) 2019 Pedro Alves
+ * %%
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * 
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * =========================LICENSE_END==================================
+ */
+package org.dropProject.repository
+
+import org.dropProject.dao.ProjectGroupRestrictions
+import org.springframework.data.jpa.repository.JpaRepository
+
+/**
+ * Provides functions to query [ProjectGroupRestrictions]s that have been persisted in the database.
+ */
+interface ProjectGroupRestrictionsRepository : JpaRepository<ProjectGroupRestrictions, Long>

src/main/kotlin/org/dropProject/services/AssignmentService.kt

@@ -73,6 +73,7 @@ class AssignmentService(
     val buildReportRepository: BuildReportRepository,
     val jUnitReportRepository: JUnitReportRepository,
     val jacocoReportRepository: JacocoReportRepository,
+    val projectGroupRestrictionsRepository: ProjectGroupRestrictionsRepository,
     val zipService: ZipService,
     val pendingTasks: PendingTasks,
     val projectGroupService: ProjectGroupService,
@@ -330,6 +331,27 @@ class AssignmentService(
         existingAssignment.hiddenTestsVisibility = assignmentForm.hiddenTestsVisibility
         existingAssignment.leaderboardType = assignmentForm.leaderboardType
 
+        // remove projectGroupRestrictions if minGroupSize was updated to null
+        if (assignmentForm.minGroupSize == null && existingAssignment.projectGroupRestrictions != null) {
+            val projectGroupRestrictions = existingAssignment.projectGroupRestrictions!!
+            existingAssignment.projectGroupRestrictions = null
+            projectGroupRestrictionsRepository.delete(projectGroupRestrictions)
+        }
+
+        if (assignmentForm.minGroupSize != null) {
+            if (existingAssignment.projectGroupRestrictions != null) {
+                existingAssignment.projectGroupRestrictions!!.minGroupSize = assignmentForm.minGroupSize!!
+                existingAssignment.projectGroupRestrictions!!.maxGroupSize = assignmentForm.maxGroupSize
+                existingAssignment.projectGroupRestrictions!!.exceptions = assignmentForm.exceptions
+                projectGroupRestrictionsRepository.save(existingAssignment.projectGroupRestrictions!!)
+            } else {
+                val newProjectGroupRestrictions = ProjectGroupRestrictions(minGroupSize = assignmentForm.minGroupSize!!,
+                    maxGroupSize = assignmentForm.maxGroupSize, exceptions = assignmentForm.exceptions)
+                projectGroupRestrictionsRepository.save(newProjectGroupRestrictions)
+                existingAssignment.projectGroupRestrictions = newProjectGroupRestrictions
+            }
+        }
+
         // update tags
         val tagNames = assignmentForm.assignmentTags?.lowercase(Locale.getDefault())?.split(",")
         clearAllTags(existingAssignment)

src/main/kotlin/org/dropProject/services/SubmissionService.kt

@@ -22,6 +22,7 @@ package org.dropProject.services
 import org.apache.any23.encoding.TikaEncodingDetector
 import org.apache.commons.io.FileUtils
 import org.dropProject.Constants
+import org.dropProject.controllers.InvalidProjectGroupException
 import org.dropProject.controllers.InvalidProjectStructureException
 import org.dropProject.controllers.UploadController
 import org.dropProject.dao.*
@@ -237,15 +238,20 @@ class SubmissionService(
 
             // check if the principal is one of group elements
             if (authors.filter { it.number == principal.realName() }.isEmpty()) {
-                throw InvalidProjectStructureException(
-                    i18n.getMessage(
-                        "student.submit.notAGroupElement",
-                        null,
-                        currentLocale
-                    )
+                throw InvalidProjectStructureException(i18n.getMessage("student.submit.notAGroupElement", null, currentLocale)
                 )
             }
 
+            // check if the group complies with possible group restrictions
+            if (assignment.projectGroupRestrictions != null) {
+                val restrictions = assignment.projectGroupRestrictions!!
+                if (authors.size !in restrictions.minGroupSize .. (restrictions.maxGroupSize ?: 50) &&
+                    restrictions.exceptionsAsList()?.contains(principal.realName()) != true) {
+                    throw InvalidProjectGroupException(i18n.getMessage("student.submit.invalidGroup",
+                        arrayOf(restrictions.minGroupSize, restrictions.maxGroupSize ?: ""), currentLocale))
+                }
+            }
+
             val group = projectGroupService.getOrCreateProjectGroup(authors)
 
             // verify that there is not another submission with the Submitted status

src/main/resources/drop-project.properties

@@ -41,9 +41,9 @@ server.servlet.session.timeout=3600
 spring.jpa.open-in-view=false
 
 # developer mode - uncomment this to be able to live reload changes in thymeleaf templates
-#spring.thymeleaf.prefix=file:src/main/resources/templates/
-#spring.thymeleaf.cache=false
-#spring.resources.static-locations=file:src/main/resources/static/
+spring.thymeleaf.prefix=file:src/main/resources/templates/
+spring.thymeleaf.cache=false
+spring.web.resources.static-locations=file:src/main/resources/static/
 
 # configuration for H2 embedded in-memory database
 spring.datasource.url=jdbc:h2:mem:test;MODE=LEGACY