UsersController.java

1
package edu.ucsb.cs156.courses.controllers;
2
3
import com.fasterxml.jackson.core.JsonProcessingException;
4
import com.fasterxml.jackson.databind.ObjectMapper;
5
import edu.ucsb.cs156.courses.entities.User;
6
import edu.ucsb.cs156.courses.repositories.UserRepository;
7
import io.swagger.v3.oas.annotations.Operation;
8
import io.swagger.v3.oas.annotations.Parameter;
9
import io.swagger.v3.oas.annotations.tags.Tag;
10
import java.util.Arrays;
11
import java.util.List;
12
import org.springframework.beans.factory.annotation.Autowired;
13
import org.springframework.data.domain.PageRequest;
14
import org.springframework.data.domain.Sort.Direction;
15
import org.springframework.http.ResponseEntity;
16
import org.springframework.security.access.prepost.PreAuthorize;
17
import org.springframework.web.bind.annotation.GetMapping;
18
import org.springframework.web.bind.annotation.RequestMapping;
19
import org.springframework.web.bind.annotation.RequestParam;
20
import org.springframework.web.bind.annotation.RestController;
21
22
@Tag(name = "User information (admin only)")
23
@RequestMapping("/api/admin/users")
24
@RestController
25
public class UsersController extends ApiController {
26
  @Autowired UserRepository userRepository;
27
28
  @Autowired ObjectMapper mapper;
29
30
  @Operation(summary = "Get a list of all users")
31
  @PreAuthorize("hasRole('ROLE_ADMIN')")
32
  @GetMapping("")
33
  public ResponseEntity<String> users() throws JsonProcessingException {
34
    Iterable<User> users = userRepository.findAll();
35
    String body = mapper.writeValueAsString(users);
36 1 1. users : replaced return value with null for edu/ucsb/cs156/courses/controllers/UsersController::users → KILLED
    return ResponseEntity.ok().body(body);
37
  }
38
39
  public static final int AUTOCOMPLETE_MIN_CHARS = 2;
40
  // One more than the frontend's maxSuggestions (10), so the UI can tell
41
  // "exactly 10 matches" apart from "more than 10 matches".
42
  public static final int AUTOCOMPLETE_MAX_RESULTS = 11;
43
44
  @Operation(summary = "Autocomplete users by name or email (case-insensitive substring match)")
45
  @PreAuthorize("hasRole('ROLE_ADMIN')")
46
  @GetMapping("/autocomplete")
47
  public List<User> autocomplete(
48
      @Parameter(
49
              name = "q",
50
              description = "text to look for in the user's full name or email",
51
              example = "ph",
52
              required = true)
53
          @RequestParam
54
          String q) {
55
    String trimmed = q.trim();
56 2 1. autocomplete : negated conditional → KILLED
2. autocomplete : changed conditional boundary → KILLED
    if (trimmed.length() < AUTOCOMPLETE_MIN_CHARS) {
57
      return List.of();
58
    }
59 1 1. autocomplete : replaced return value with Collections.emptyList for edu/ucsb/cs156/courses/controllers/UsersController::autocomplete → KILLED
    return userRepository.findByFullNameContainingIgnoreCaseOrEmailContainingIgnoreCase(
60
        trimmed, trimmed, PageRequest.of(0, AUTOCOMPLETE_MAX_RESULTS));
61
  }
62
63
  @Operation(summary = "Get a list of all users with pages")
64
  @PreAuthorize("hasRole('ROLE_ADMIN')")
65
  @GetMapping(params = {"page", "pageSize", "sortField", "sortDirection"})
66
  public Iterable<User> usersPaged(
67
      @Parameter(
68
              name = "page",
69
              description = "what page of the data",
70
              example = "0",
71
              required = true)
72
          @RequestParam
73
          int page,
74
      @Parameter(
75
              name = "pageSize",
76
              description = "size of each page",
77
              example = "5",
78
              required = true)
79
          @RequestParam
80
          int pageSize,
81
      @Parameter(
82
              name = "sortField",
83
              description = "field to sort by",
84
              example = "email",
85
              required = true)
86
          @RequestParam
87
          String sortField,
88
      @Parameter(
89
              name = "sortDirection",
90
              description = "sort direction",
91
              example = "ASC",
92
              required = true)
93
          @RequestParam
94
          String sortDirection)
95
      throws JsonProcessingException {
96
    List<String> allowedSortFields = Arrays.asList("givenName", "familyName", "email");
97 1 1. usersPaged : negated conditional → KILLED
    if (!allowedSortFields.contains(sortField)) {
98
      throw new IllegalArgumentException(
99
          String.format(
100
              "%s is not a valid sort field.  Valid values are %s", sortField, allowedSortFields));
101
    }
102
103
    List<String> allowedSortDirections = Arrays.asList("ASC", "DESC");
104 1 1. usersPaged : negated conditional → KILLED
    if (!allowedSortDirections.contains(sortDirection)) {
105
      throw new IllegalArgumentException(
106
          String.format(
107
              "%s is not a valid sort direction.  Valid values are %s",
108
              sortDirection, allowedSortDirections));
109
    }
110
111
    Direction sortDirectionObject = Direction.ASC;
112 1 1. usersPaged : negated conditional → KILLED
    if (sortDirection.equals("DESC")) {
113
      sortDirectionObject = Direction.DESC;
114
    }
115
116
    PageRequest pageRequest = PageRequest.of(page, pageSize, sortDirectionObject, sortField);
117
118
    Iterable<User> users = userRepository.findAll(pageRequest);
119 1 1. usersPaged : replaced return value with Collections.emptyList for edu/ucsb/cs156/courses/controllers/UsersController::usersPaged → KILLED
    return users;
120
  }
121
}

Mutations

36

1.1
Location : users
Killed by : edu.ucsb.cs156.courses.controllers.UsersControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.courses.controllers.UsersControllerTests]/[method:users__admin_logged_in()]
replaced return value with null for edu/ucsb/cs156/courses/controllers/UsersController::users → KILLED

56

1.1
Location : autocomplete
Killed by : edu.ucsb.cs156.courses.controllers.UsersControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.courses.controllers.UsersControllerTests]/[method:autocomplete__exactly_min_chars_queries_repository()]
negated conditional → KILLED

2.2
Location : autocomplete
Killed by : edu.ucsb.cs156.courses.controllers.UsersControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.courses.controllers.UsersControllerTests]/[method:autocomplete__exactly_min_chars_queries_repository()]
changed conditional boundary → KILLED

59

1.1
Location : autocomplete
Killed by : edu.ucsb.cs156.courses.controllers.UsersControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.courses.controllers.UsersControllerTests]/[method:autocomplete__admin_gets_matches_with_trimmed_query_and_limit()]
replaced return value with Collections.emptyList for edu/ucsb/cs156/courses/controllers/UsersController::autocomplete → KILLED

97

1.1
Location : usersPaged
Killed by : edu.ucsb.cs156.courses.controllers.UsersControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.courses.controllers.UsersControllerTests]/[method:usersPaged__fails_when_invalid_sortDirection()]
negated conditional → KILLED

104

1.1
Location : usersPaged
Killed by : edu.ucsb.cs156.courses.controllers.UsersControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.courses.controllers.UsersControllerTests]/[method:usersPaged__fails_when_invalid_sortDirection()]
negated conditional → KILLED

112

1.1
Location : usersPaged
Killed by : edu.ucsb.cs156.courses.controllers.UsersControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.courses.controllers.UsersControllerTests]/[method:usersPaged__admin_logged_in_desc()]
negated conditional → KILLED

119

1.1
Location : usersPaged
Killed by : edu.ucsb.cs156.courses.controllers.UsersControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.courses.controllers.UsersControllerTests]/[method:usersPaged__admin_logged_in_desc()]
replaced return value with Collections.emptyList for edu/ucsb/cs156/courses/controllers/UsersController::usersPaged → KILLED

Active mutators

Tests examined


Report generated by PIT 1.22.1