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<RosterStudent>> 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<RosterStudent> upsertResponse =
102
          upsertStudent(rosterStudent, course, RosterStatus.ROSTER);
103 1 1. uploadRosterFromCanvas : negated conditional → KILLED
      if (upsertResponse.getInsertStatus() == InsertStatus.REJECTED) {
104
        rejectedStudents.add(upsertResponse.entity());
105
      } else {
106
        InsertStatus s = upsertResponse.getInsertStatus();
107 1 1. uploadRosterFromCanvas : negated conditional → KILLED
        if (s == InsertStatus.INSERTED) {
108
          course.getRosterStudents().add(upsertResponse.entity());
109
        }
110 1 1. uploadRosterFromCanvas : Replaced integer addition with subtraction → KILLED
        counts[s.ordinal()]++;
111
      }
112
    }
113
114 1 1. uploadRosterFromCanvas : negated conditional → KILLED
    if (rejectedStudents.isEmpty()) {
115
      List<RosterStudent> droppedStudents =
116
          course.getRosterStudents().stream()
117 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)
118
              .toList();
119
      LoadResult<RosterStudent> successfulResult =
120
          new LoadResult<>(
121
              counts[InsertStatus.INSERTED.ordinal()],
122
              counts[InsertStatus.UPDATED.ordinal()],
123
              droppedStudents.size(),
124
              List.of());
125
      rosterStudentRepository.saveAll(course.getRosterStudents());
126 1 1. uploadRosterFromCanvas : removed call to edu/ucsb/cs156/frontiers/services/UpdateUserService::attachUsersToRosterStudents → KILLED
      updateUserService.attachUsersToRosterStudents(course.getRosterStudents());
127
      RemoveStudentsJob job =
128
          RemoveStudentsJob.builder()
129
              .students(droppedStudents)
130
              .organizationMemberService(organizationMemberService)
131
              .rosterStudentRepository(rosterStudentRepository)
132
              .build();
133
      jobService.runAsJob(job);
134 1 1. uploadRosterFromCanvas : replaced return value with null for edu/ucsb/cs156/frontiers/controllers/CanvasController::uploadRosterFromCanvas → KILLED
      return ResponseEntity.ok(successfulResult);
135
    } else {
136
      LoadResult<RosterStudent> conflictResult = new LoadResult<>(0, 0, 0, rejectedStudents);
137 1 1. uploadRosterFromCanvas : replaced return value with null for edu/ucsb/cs156/frontiers/controllers/CanvasController::uploadRosterFromCanvas → KILLED
      return ResponseEntity.status(HttpStatus.CONFLICT).body(conflictResult);
138
    }
139
  }
140
141
  @Operation(summary = "See available Canvas GroupSets")
142
  @GetMapping("/groupsets")
143
  @PreAuthorize("@CourseSecurity.hasInstructorPermissions(#root, #courseId)")
144
  public List<CanvasGroupSet> getCanvasGroupSets(
145
      @Parameter(name = "courseId") @RequestParam Long courseId) {
146
    Course course =
147
        courseRepository
148
            .findById(courseId)
149 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()));
150 1 1. getCanvasGroupSets : replaced return value with Collections.emptyList for edu/ucsb/cs156/frontiers/controllers/CanvasController::getCanvasGroupSets → KILLED
    return canvasService.getCanvasGroupSets(course);
151
  }
152
153
  @Operation(
154
      summary = "Pull teams from Canvas",
155
      description =
156
          "Launches a job that creates or updates the teams in Frontiers to match the groups in"
157
              + " the given Canvas group set.")
158
  @PostMapping("/teams/pull")
159
  @PreAuthorize("@CourseSecurity.hasInstructorPermissions(#root, #courseId)")
160
  public Job pullCanvasTeams(
161
      @Parameter(name = "courseId") @RequestParam Long courseId,
162
      @Parameter(name = "groupSetId") @RequestParam String groupSetId) {
163
    Course course =
164
        courseRepository
165
            .findById(courseId)
166 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()));
167
    PullTeamsFromCanvasJob job =
168
        PullTeamsFromCanvasJob.builder()
169
            .course(course)
170
            .canvasService(canvasService)
171
            .teamRepository(teamRepository)
172
            .teamMemberRepository(teamMemberRepository)
173
            .courseRepository(courseRepository)
174
            .groupsetId(groupSetId)
175
            .build();
176 1 1. pullCanvasTeams : replaced return value with null for edu/ucsb/cs156/frontiers/controllers/CanvasController::pullCanvasTeams → KILLED
    return jobService.runAsJob(job);
177
  }
178
179
  @Operation(
180
      summary = "Push teams to Canvas",
181
      description =
182
          "Launches a job that updates the groups in the given Canvas group set to match the teams"
183
              + " in Frontiers: groups are created, members added and removed, and groups with no"
184
              + " matching team deleted. Problems with individual students or groups are logged as"
185
              + " warnings in the job log and the job proceeds.")
186
  @PostMapping("/teams/push")
187
  @PreAuthorize("@CourseSecurity.hasInstructorPermissions(#root, #courseId)")
188
  public Job pushCanvasTeams(
189
      @Parameter(name = "courseId") @RequestParam Long courseId,
190
      @Parameter(name = "groupSetId") @RequestParam String groupSetId) {
191
    Course course =
192
        courseRepository
193
            .findById(courseId)
194 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()));
195
    PushTeamsToCanvasJob job =
196
        PushTeamsToCanvasJob.builder()
197
            .course(course)
198
            .groupSetId(groupSetId)
199
            .canvasService(canvasService)
200
            .courseRepository(courseRepository)
201
            .teamRepository(teamRepository)
202
            .build();
203 1 1. pushCanvasTeams : replaced return value with null for edu/ucsb/cs156/frontiers/controllers/CanvasController::pushCanvasTeams → KILLED
    return jobService.runAsJob(job);
204
  }
205
}

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_manualStudentStaysManual()]
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

103

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

107

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

110

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

114

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

117

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_manualStudentStaysManual()]
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_manualStudentStaysManual()]
replaced boolean return with true for edu/ucsb/cs156/frontiers/controllers/CanvasController::lambda$uploadRosterFromCanvas$3 → KILLED

126

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

134

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

137

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

149

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

150

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

166

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

176

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

194

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

203

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