CanvasController.java

1
package edu.ucsb.cs156.frontiers.controllers;
2
3
import static edu.ucsb.cs156.frontiers.controllers.RosterStudentsController.upsertStudent;
4
5
import edu.ucsb.cs156.frontiers.entities.Course;
6
import edu.ucsb.cs156.frontiers.entities.RosterStudent;
7
import edu.ucsb.cs156.frontiers.enums.InsertStatus;
8
import edu.ucsb.cs156.frontiers.enums.RosterStatus;
9
import edu.ucsb.cs156.frontiers.errors.EntityNotFoundException;
10
import edu.ucsb.cs156.frontiers.jobs.PullTeamsFromCanvasJob;
11
import edu.ucsb.cs156.frontiers.jobs.PushTeamsToCanvasJob;
12
import edu.ucsb.cs156.frontiers.jobs.RemoveStudentsJob;
13
import edu.ucsb.cs156.frontiers.models.CanvasGroupSet;
14
import edu.ucsb.cs156.frontiers.models.LoadResult;
15
import edu.ucsb.cs156.frontiers.models.UpsertResponse;
16
import edu.ucsb.cs156.frontiers.repositories.CourseRepository;
17
import edu.ucsb.cs156.frontiers.repositories.RosterStudentRepository;
18
import edu.ucsb.cs156.frontiers.repositories.TeamMemberRepository;
19
import edu.ucsb.cs156.frontiers.repositories.TeamRepository;
20
import edu.ucsb.cs156.frontiers.services.CanvasService;
21
import edu.ucsb.cs156.frontiers.services.OrganizationMemberService;
22
import edu.ucsb.cs156.frontiers.services.UpdateUserService;
23
import edu.ucsb.cs156.jobs.entities.Job;
24
import edu.ucsb.cs156.jobs.services.JobService;
25
import io.swagger.v3.oas.annotations.Operation;
26
import io.swagger.v3.oas.annotations.Parameter;
27
import io.swagger.v3.oas.annotations.tags.Tag;
28
import java.util.ArrayList;
29
import java.util.List;
30
import lombok.extern.slf4j.Slf4j;
31
import org.springframework.http.HttpStatus;
32
import org.springframework.http.ResponseEntity;
33
import org.springframework.security.access.prepost.PreAuthorize;
34
import org.springframework.web.bind.annotation.GetMapping;
35
import org.springframework.web.bind.annotation.PostMapping;
36
import org.springframework.web.bind.annotation.RequestMapping;
37
import org.springframework.web.bind.annotation.RequestParam;
38
import org.springframework.web.bind.annotation.RestController;
39
40
@RestController
41
@RequestMapping("/api/courses/canvas")
42
@Tag(name = "Canvas")
43
@Slf4j
44
public class CanvasController extends ApiController {
45
46
  private final CourseRepository courseRepository;
47
  private final CanvasService canvasService;
48
  private final TeamRepository teamRepository;
49
  private final JobService jobService;
50
  private final RosterStudentRepository rosterStudentRepository;
51
  private final UpdateUserService updateUserService;
52
  private final OrganizationMemberService organizationMemberService;
53
  private final TeamMemberRepository teamMemberRepository;
54
55
  public CanvasController(
56
      CourseRepository courseRepository,
57
      CanvasService canvasService,
58
      TeamRepository teamRepository,
59
      JobService jobService,
60
      RosterStudentRepository rosterStudentRepository,
61
      UpdateUserService updateUserService,
62
      OrganizationMemberService organizationMemberService,
63
      TeamMemberRepository teamMemberRepository) {
64
    this.courseRepository = courseRepository;
65
    this.canvasService = canvasService;
66
    this.teamRepository = teamRepository;
67
    this.jobService = jobService;
68
    this.rosterStudentRepository = rosterStudentRepository;
69
    this.updateUserService = updateUserService;
70
    this.organizationMemberService = organizationMemberService;
71
    this.teamMemberRepository = teamMemberRepository;
72
  }
73
74
  /**
75
   * Upload Roster students for Course from Canvas. It is important to keep the code in this method
76
   * consistent with the code in uploadRosterStudentsCSV.
77
   *
78
   * @param courseId the internal course ID in Frontiers
79
   * @return LoadResult with counts of inserted, updated, dropped students and any rejected students
80
   */
81
  @Operation(summary = "Upload Roster students for Course from Canvas")
82
  @PreAuthorize("@CourseSecurity.hasInstructorPermissions(#root, #courseId)")
83
  @PostMapping("/sync/students")
84
  public ResponseEntity<LoadResult> uploadRosterFromCanvas(
85
      @Parameter(name = "courseId") @RequestParam Long courseId) {
86
87
    Course course =
88
        courseRepository
89
            .findById(courseId)
90 1 1. lambda$uploadRosterFromCanvas$0 : replaced return value with null for edu/ucsb/cs156/frontiers/controllers/CanvasController::lambda$uploadRosterFromCanvas$0 → KILLED
            .orElseThrow(() -> new EntityNotFoundException(Course.class, courseId.toString()));
91
92
    course.getRosterStudents().stream()
93 2 1. lambda$uploadRosterFromCanvas$1 : negated conditional → KILLED
2. lambda$uploadRosterFromCanvas$1 : replaced boolean return with true for edu/ucsb/cs156/frontiers/controllers/CanvasController::lambda$uploadRosterFromCanvas$1 → KILLED
        .filter(filteredStudent -> filteredStudent.getRosterStatus() == RosterStatus.ROSTER)
94 2 1. uploadRosterFromCanvas : removed call to java/util/stream/Stream::forEach → KILLED
2. lambda$uploadRosterFromCanvas$2 : removed call to edu/ucsb/cs156/frontiers/entities/RosterStudent::setRosterStatus → KILLED
        .forEach(student -> student.setRosterStatus(RosterStatus.DROPPED));
95
96
    int counts[] = {0, 0};
97
    List<RosterStudent> rejectedStudents = new ArrayList<>();
98
99
    List<RosterStudent> canvasStudents = canvasService.getCanvasRoster(course);
100
    for (RosterStudent rosterStudent : canvasStudents) {
101
      UpsertResponse upsertResponse = upsertStudent(rosterStudent, course, RosterStatus.ROSTER);
102 1 1. uploadRosterFromCanvas : negated conditional → KILLED
      if (upsertResponse.getInsertStatus() == InsertStatus.REJECTED) {
103
        rejectedStudents.add(upsertResponse.rosterStudent());
104
      } else {
105
        InsertStatus s = upsertResponse.getInsertStatus();
106 1 1. uploadRosterFromCanvas : negated conditional → KILLED
        if (s == InsertStatus.INSERTED) {
107
          course.getRosterStudents().add(upsertResponse.rosterStudent());
108
        }
109 1 1. uploadRosterFromCanvas : Replaced integer addition with subtraction → KILLED
        counts[s.ordinal()]++;
110
      }
111
    }
112
113 1 1. uploadRosterFromCanvas : negated conditional → KILLED
    if (rejectedStudents.isEmpty()) {
114
      List<RosterStudent> droppedStudents =
115
          course.getRosterStudents().stream()
116 2 1. lambda$uploadRosterFromCanvas$3 : negated conditional → KILLED
2. lambda$uploadRosterFromCanvas$3 : replaced boolean return with true for edu/ucsb/cs156/frontiers/controllers/CanvasController::lambda$uploadRosterFromCanvas$3 → KILLED
              .filter(student -> student.getRosterStatus() == RosterStatus.DROPPED)
117
              .toList();
118
      LoadResult successfulResult =
119
          new LoadResult(
120
              counts[InsertStatus.INSERTED.ordinal()],
121
              counts[InsertStatus.UPDATED.ordinal()],
122
              droppedStudents.size(),
123
              List.of());
124
      rosterStudentRepository.saveAll(course.getRosterStudents());
125 1 1. uploadRosterFromCanvas : removed call to edu/ucsb/cs156/frontiers/services/UpdateUserService::attachUsersToRosterStudents → KILLED
      updateUserService.attachUsersToRosterStudents(course.getRosterStudents());
126
      RemoveStudentsJob job =
127
          RemoveStudentsJob.builder()
128
              .students(droppedStudents)
129
              .organizationMemberService(organizationMemberService)
130
              .rosterStudentRepository(rosterStudentRepository)
131
              .build();
132
      jobService.runAsJob(job);
133 1 1. uploadRosterFromCanvas : replaced return value with null for edu/ucsb/cs156/frontiers/controllers/CanvasController::uploadRosterFromCanvas → KILLED
      return ResponseEntity.ok(successfulResult);
134
    } else {
135
      LoadResult conflictResult = new LoadResult(0, 0, 0, rejectedStudents);
136 1 1. uploadRosterFromCanvas : replaced return value with null for edu/ucsb/cs156/frontiers/controllers/CanvasController::uploadRosterFromCanvas → KILLED
      return ResponseEntity.status(HttpStatus.CONFLICT).body(conflictResult);
137
    }
138
  }
139
140
  @Operation(summary = "See available Canvas GroupSets")
141
  @GetMapping("/groupsets")
142
  @PreAuthorize("@CourseSecurity.hasInstructorPermissions(#root, #courseId)")
143
  public List<CanvasGroupSet> getCanvasGroupSets(
144
      @Parameter(name = "courseId") @RequestParam Long courseId) {
145
    Course course =
146
        courseRepository
147
            .findById(courseId)
148 1 1. lambda$getCanvasGroupSets$0 : replaced return value with null for edu/ucsb/cs156/frontiers/controllers/CanvasController::lambda$getCanvasGroupSets$0 → KILLED
            .orElseThrow(() -> new EntityNotFoundException(Course.class, courseId.toString()));
149 1 1. getCanvasGroupSets : replaced return value with Collections.emptyList for edu/ucsb/cs156/frontiers/controllers/CanvasController::getCanvasGroupSets → KILLED
    return canvasService.getCanvasGroupSets(course);
150
  }
151
152
  @Operation(
153
      summary = "Pull teams from Canvas",
154
      description =
155
          "Launches a job that creates or updates the teams in Frontiers to match the groups in"
156
              + " the given Canvas group set.")
157
  @PostMapping("/teams/pull")
158
  @PreAuthorize("@CourseSecurity.hasInstructorPermissions(#root, #courseId)")
159
  public Job pullCanvasTeams(
160
      @Parameter(name = "courseId") @RequestParam Long courseId,
161
      @Parameter(name = "groupSetId") @RequestParam String groupSetId) {
162
    Course course =
163
        courseRepository
164
            .findById(courseId)
165 1 1. lambda$pullCanvasTeams$0 : replaced return value with null for edu/ucsb/cs156/frontiers/controllers/CanvasController::lambda$pullCanvasTeams$0 → KILLED
            .orElseThrow(() -> new EntityNotFoundException(Course.class, courseId.toString()));
166
    PullTeamsFromCanvasJob job =
167
        PullTeamsFromCanvasJob.builder()
168
            .course(course)
169
            .canvasService(canvasService)
170
            .teamRepository(teamRepository)
171
            .teamMemberRepository(teamMemberRepository)
172
            .courseRepository(courseRepository)
173
            .groupsetId(groupSetId)
174
            .build();
175 1 1. pullCanvasTeams : replaced return value with null for edu/ucsb/cs156/frontiers/controllers/CanvasController::pullCanvasTeams → KILLED
    return jobService.runAsJob(job);
176
  }
177
178
  @Operation(
179
      summary = "Push teams to Canvas",
180
      description =
181
          "Launches a job that updates the groups in the given Canvas group set to match the teams"
182
              + " in Frontiers: groups are created, members added and removed, and groups with no"
183
              + " matching team deleted. Problems with individual students or groups are logged as"
184
              + " warnings in the job log and the job proceeds.")
185
  @PostMapping("/teams/push")
186
  @PreAuthorize("@CourseSecurity.hasInstructorPermissions(#root, #courseId)")
187
  public Job pushCanvasTeams(
188
      @Parameter(name = "courseId") @RequestParam Long courseId,
189
      @Parameter(name = "groupSetId") @RequestParam String groupSetId) {
190
    Course course =
191
        courseRepository
192
            .findById(courseId)
193 1 1. lambda$pushCanvasTeams$0 : replaced return value with null for edu/ucsb/cs156/frontiers/controllers/CanvasController::lambda$pushCanvasTeams$0 → KILLED
            .orElseThrow(() -> new EntityNotFoundException(Course.class, courseId.toString()));
194
    PushTeamsToCanvasJob job =
195
        PushTeamsToCanvasJob.builder()
196
            .course(course)
197
            .groupSetId(groupSetId)
198
            .canvasService(canvasService)
199
            .courseRepository(courseRepository)
200
            .teamRepository(teamRepository)
201
            .build();
202 1 1. pushCanvasTeams : replaced return value with null for edu/ucsb/cs156/frontiers/controllers/CanvasController::pushCanvasTeams → KILLED
    return jobService.runAsJob(job);
203
  }
204
}

Mutations

90

1.1
Location : lambda$uploadRosterFromCanvas$0
Killed by : edu.ucsb.cs156.frontiers.controllers.CanvasControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.frontiers.controllers.CanvasControllerTests]/[method:testUploadRosterFromCanvas_courseNotFound()]
replaced return value with null for edu/ucsb/cs156/frontiers/controllers/CanvasController::lambda$uploadRosterFromCanvas$0 → KILLED

93

1.1
Location : lambda$uploadRosterFromCanvas$1
Killed by : edu.ucsb.cs156.frontiers.controllers.CanvasControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.frontiers.controllers.CanvasControllerTests]/[method:testUploadRosterFromCanvas_handlesDroppedStudents()]
negated conditional → KILLED

2.2
Location : lambda$uploadRosterFromCanvas$1
Killed by : edu.ucsb.cs156.frontiers.controllers.CanvasControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.frontiers.controllers.CanvasControllerTests]/[method:testUploadRosterFromCanvas_manualStudentStaysManual()]
replaced boolean return with true for edu/ucsb/cs156/frontiers/controllers/CanvasController::lambda$uploadRosterFromCanvas$1 → KILLED

94

1.1
Location : uploadRosterFromCanvas
Killed by : edu.ucsb.cs156.frontiers.controllers.CanvasControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.frontiers.controllers.CanvasControllerTests]/[method:testUploadRosterFromCanvas_handlesDroppedStudents()]
removed call to java/util/stream/Stream::forEach → KILLED

2.2
Location : lambda$uploadRosterFromCanvas$2
Killed by : edu.ucsb.cs156.frontiers.controllers.CanvasControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.frontiers.controllers.CanvasControllerTests]/[method:testUploadRosterFromCanvas_handlesDroppedStudents()]
removed call to edu/ucsb/cs156/frontiers/entities/RosterStudent::setRosterStatus → KILLED

102

1.1
Location : uploadRosterFromCanvas
Killed by : edu.ucsb.cs156.frontiers.controllers.CanvasControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.frontiers.controllers.CanvasControllerTests]/[method:testUploadRosterFromCanvas_setsJOINCOURSEStatusWhenInstallationIdPresent()]
negated conditional → KILLED

106

1.1
Location : uploadRosterFromCanvas
Killed by : edu.ucsb.cs156.frontiers.controllers.CanvasControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.frontiers.controllers.CanvasControllerTests]/[method:testUploadRosterFromCanvas_insertsNewStudents()]
negated conditional → KILLED

109

1.1
Location : uploadRosterFromCanvas
Killed by : edu.ucsb.cs156.frontiers.controllers.CanvasControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.frontiers.controllers.CanvasControllerTests]/[method:testUploadRosterFromCanvas_updatesExistingStudents()]
Replaced integer addition with subtraction → KILLED

113

1.1
Location : uploadRosterFromCanvas
Killed by : edu.ucsb.cs156.frontiers.controllers.CanvasControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.frontiers.controllers.CanvasControllerTests]/[method:testUploadRosterFromCanvas_setsJOINCOURSEStatusWhenInstallationIdPresent()]
negated conditional → KILLED

116

1.1
Location : lambda$uploadRosterFromCanvas$3
Killed by : edu.ucsb.cs156.frontiers.controllers.CanvasControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.frontiers.controllers.CanvasControllerTests]/[method:testUploadRosterFromCanvas_updatesExistingStudents()]
negated conditional → KILLED

2.2
Location : lambda$uploadRosterFromCanvas$3
Killed by : edu.ucsb.cs156.frontiers.controllers.CanvasControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.frontiers.controllers.CanvasControllerTests]/[method:testUploadRosterFromCanvas_updatesExistingStudents()]
replaced boolean return with true for edu/ucsb/cs156/frontiers/controllers/CanvasController::lambda$uploadRosterFromCanvas$3 → KILLED

125

1.1
Location : uploadRosterFromCanvas
Killed by : edu.ucsb.cs156.frontiers.controllers.CanvasControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.frontiers.controllers.CanvasControllerTests]/[method:testUploadRosterFromCanvas_insertsNewStudents()]
removed call to edu/ucsb/cs156/frontiers/services/UpdateUserService::attachUsersToRosterStudents → KILLED

133

1.1
Location : uploadRosterFromCanvas
Killed by : edu.ucsb.cs156.frontiers.controllers.CanvasControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.frontiers.controllers.CanvasControllerTests]/[method:testUploadRosterFromCanvas_updatesExistingStudents()]
replaced return value with null for edu/ucsb/cs156/frontiers/controllers/CanvasController::uploadRosterFromCanvas → KILLED

136

1.1
Location : uploadRosterFromCanvas
Killed by : edu.ucsb.cs156.frontiers.controllers.CanvasControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.frontiers.controllers.CanvasControllerTests]/[method:testUploadRosterFromCanvas_handlesRejectedStudents()]
replaced return value with null for edu/ucsb/cs156/frontiers/controllers/CanvasController::uploadRosterFromCanvas → KILLED

148

1.1
Location : lambda$getCanvasGroupSets$0
Killed by : edu.ucsb.cs156.frontiers.controllers.CanvasControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.frontiers.controllers.CanvasControllerTests]/[method:testGetCanvasGroupSets_courseNotFound()]
replaced return value with null for edu/ucsb/cs156/frontiers/controllers/CanvasController::lambda$getCanvasGroupSets$0 → KILLED

149

1.1
Location : getCanvasGroupSets
Killed by : edu.ucsb.cs156.frontiers.controllers.CanvasControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.frontiers.controllers.CanvasControllerTests]/[method:testGetCanvasGroupSets_returnsGroupSets()]
replaced return value with Collections.emptyList for edu/ucsb/cs156/frontiers/controllers/CanvasController::getCanvasGroupSets → KILLED

165

1.1
Location : lambda$pullCanvasTeams$0
Killed by : edu.ucsb.cs156.frontiers.controllers.CanvasControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.frontiers.controllers.CanvasControllerTests]/[method:testPullCanvasTeams_courseNotFound()]
replaced return value with null for edu/ucsb/cs156/frontiers/controllers/CanvasController::lambda$pullCanvasTeams$0 → KILLED

175

1.1
Location : pullCanvasTeams
Killed by : edu.ucsb.cs156.frontiers.controllers.CanvasControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.frontiers.controllers.CanvasControllerTests]/[method:testPullCanvasTeams_startsJob()]
replaced return value with null for edu/ucsb/cs156/frontiers/controllers/CanvasController::pullCanvasTeams → KILLED

193

1.1
Location : lambda$pushCanvasTeams$0
Killed by : edu.ucsb.cs156.frontiers.controllers.CanvasControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.frontiers.controllers.CanvasControllerTests]/[method:testPushCanvasTeams_courseNotFound()]
replaced return value with null for edu/ucsb/cs156/frontiers/controllers/CanvasController::lambda$pushCanvasTeams$0 → KILLED

202

1.1
Location : pushCanvasTeams
Killed by : edu.ucsb.cs156.frontiers.controllers.CanvasControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.frontiers.controllers.CanvasControllerTests]/[method:testPushCanvasTeams_startsJob()]
replaced return value with null for edu/ucsb/cs156/frontiers/controllers/CanvasController::pushCanvasTeams → KILLED

Active mutators

Tests examined


Report generated by PIT 1.30.0 support