RecommendationRequestController.java

package edu.ucsb.cs156.rec.controllers;

import edu.ucsb.cs156.rec.entities.RecommendationRequest;
import edu.ucsb.cs156.rec.errors.EntityNotFoundException;
import edu.ucsb.cs156.rec.repositories.RecommendationRequestRepository;
import edu.ucsb.cs156.rec.repositories.UserRepository;
import edu.ucsb.cs156.rec.entities.User;
import edu.ucsb.cs156.rec.entities.RequestType;
import edu.ucsb.cs156.rec.repositories.RequestTypeRepository;

import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.tags.Tag;
import lombok.extern.slf4j.Slf4j;

import com.fasterxml.jackson.core.JsonProcessingException;

import org.checkerframework.checker.units.qual.g;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.context.properties.source.IterableConfigurationPropertySource;
import org.springframework.format.annotation.DateTimeFormat;
import org.springframework.http.ResponseEntity;
import org.springframework.security.access.prepost.PreAuthorize;
import org.springframework.web.bind.annotation.DeleteMapping;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.PutMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.security.access.AccessDeniedException;
import org.springframework.http.HttpStatus;

import jakarta.validation.Valid;

import java.time.LocalDate;
import java.util.List;

/**
 * This is a REST controller for RecommendationRequest
 */

@Tag(name = "RecommendationRequest")
@RequestMapping("/api/recommendationrequest")
@RestController
@Slf4j
public class RecommendationRequestController extends ApiController{
    
    @Autowired
    RecommendationRequestRepository recommendationRequestRepository;

    @Autowired
    UserRepository userRepository;

    @Autowired
    RequestTypeRepository requestTypeRepository;

    /**
     * List all recommendation requests
     * 
     * @return an iterable of RecommendationRequest
     */
    @Operation(summary= "List all recommendation requests")
    @PreAuthorize("hasRole('ROLE_ADMIN')")
    @GetMapping("/all")
    public Iterable<RecommendationRequest> allRecommendationRequests() {
        Iterable<RecommendationRequest> requests = recommendationRequestRepository.findAll();
        return requests;
    }

    /**
     * Get a single recommendation request by id
     * 
     * @param id the id of the recommendation request
     * @throws EntityNotFoundException if the recommendation request is not found
     * @return a recommendation request
     */
    @Operation(summary= "Get a single recommendation request")
    @PreAuthorize("hasRole('ROLE_ADMIN')")
    @GetMapping("")
    public RecommendationRequest getById(
            @Parameter(name="id") @RequestParam Long id) {
        RecommendationRequest recommendationRequest = recommendationRequestRepository.findById(id)
                .orElseThrow(() -> new EntityNotFoundException(RecommendationRequest.class, id));

        return recommendationRequest;
    }

    /**
     * Create a new recommendation request
     * @param professorEmail the email of the professor
     * @param recommendationType the type of recommendations
     * @param details the other details of the request
     * @throws EntityNotFoundException if the professor is not found or is hte user does not have the professor role
     * @return the created RecommendationRequest
    */
    
    @Operation(summary= "Create a new recommendation request")
    @PreAuthorize("hasRole('ROLE_STUDENT')")
    @PostMapping("/post")
    public RecommendationRequest postRecommendationRequest(
        @Parameter(name="professorEmail") @RequestParam String professorEmail,
        @Parameter(name="recommendationType") @RequestParam String recommendationType,
        @Parameter(name="details") @RequestParam String details)
        throws JsonProcessingException {

            User prof = userRepository.findByEmail(professorEmail)
                .orElseThrow(() -> new EntityNotFoundException(User.class, professorEmail));
            
            if (!prof.getProfessor()) {
                throw new EntityNotFoundException(User.class, professorEmail);
            }

            RequestType type = requestTypeRepository.findByRequestType(recommendationType)
                .orElseThrow(() -> new EntityNotFoundException(RequestType.class, recommendationType));

            LocalDate currDate = LocalDate.now();

            RecommendationRequest recommendationRequest = new RecommendationRequest();
            recommendationRequest.setProfessor(prof);
            recommendationRequest.setRequester(getCurrentUser().getUser());
            recommendationRequest.setRecommendationType(type);
            recommendationRequest.setDetails(details);
            recommendationRequest.setSubmissionDate(currDate);
            recommendationRequest.setStatus("pending");

            RecommendationRequest savedRecommendationRequest = recommendationRequestRepository.save(recommendationRequest);

            return savedRecommendationRequest;
    }

    /**
     * Delete a recommendation request
     * 
     * @param id the id of the recommendation request to delete
     * @throws EntityNotFoundException if the recommendation request is not found
     * @return a message indicating the recommedation request was deleted
     */
    @Operation(summary= "Delete a recommendation request")
    @PreAuthorize("hasRole('ROLE_USER')")
    @DeleteMapping("")
    public Object deleteRecommendationRequest(
            @Parameter(name="id") @RequestParam Long id) {
        RecommendationRequest recommendationRequest = recommendationRequestRepository.findById(id)
                .orElseThrow(() -> new EntityNotFoundException(RecommendationRequest.class, id));

        if( recommendationRequest.getRequester().getId() != getCurrentUser().getUser().getId()) {
            throw new AccessDeniedException(null);
        }

        recommendationRequestRepository.delete(recommendationRequest);
        return genericMessage("RecommendationRequest with id %s deleted".formatted(id));
    }

    /**
     * Update a single recommendation request
     * 
     * @param id       id of the recommendation request to update
     * @param incoming the new recommendation request
     * @throws EntityNotFoundException if the recommendation request is not found
     * @return the updated recommendation request object
     */
    @Operation(summary= "Update a single recommendation request")
    @PreAuthorize("hasAnyRole('ROLE_ADMIN', 'ROLE_PROFESSOR')")
    @PutMapping("")
    public RecommendationRequest updateRecommendationRequest(
            @Parameter(name="id") @RequestParam Long id,
            @RequestBody @Valid RecommendationRequest incoming) {

        RecommendationRequest recommendationRequest = recommendationRequestRepository.findById(id)
                .orElseThrow(() -> new EntityNotFoundException(RecommendationRequest.class, id));

        LocalDate currDate = LocalDate.now();

        recommendationRequest.setRecommendationType(incoming.getRecommendationType());
        recommendationRequest.setDetails(incoming.getDetails());
        recommendationRequest.setCompletionDate(currDate);
        recommendationRequest.setStatus(incoming.getStatus());

        recommendationRequestRepository.save(recommendationRequest);

        return recommendationRequest;
    }

    /**
     * Get all recommendation requests by Professor id
     * 
     * @param userId the user Id of the professor
     * @throws EntityNotFoundException if the professor is not found
     * @return a list of all rec reqs directed towards the professor with the given userId
     */
    @Operation(summary= "Get all recommendation requests by Professor's user id")
    @PreAuthorize("hasAnyRole('ROLE_ADMIN', 'ROLE_PROFESSOR')") 
    @GetMapping("/professor/{userId}")
    public List<RecommendationRequest> getAllRecommendationRequestsByProfessor(
        @PathVariable(value="userId") long userId) {

        if( !userRepository.existsById(userId)) {
            throw new EntityNotFoundException(User.class, userId);
        }
        List<RecommendationRequest> recommendationRequests = recommendationRequestRepository.findAllByProfessorId(userId);
        return recommendationRequests;
    }

    /** 
     * Get all recommendation requests by Requester id
     * @param userId the user Id of the requester
     * @throws EntityNotFoundException if the requester is not found
     * @return a list of all rec reqs made by the requester with the given userId
     */
    @Operation(summary = "Get all recommendation requests by Requester's user id")
    @PreAuthorize("hasAnyRole('ROLE_ADMIN', 'ROLE_STUDENT')")
    @GetMapping("/requester/{userId}")
    public List<RecommendationRequest> getAllRecommendationRequestsByRequester(
        @PathVariable(value="userId") long userId){

        if( !userRepository.existsById(userId)) {
            throw new EntityNotFoundException(User.class, userId);
        }
        List<RecommendationRequest> recommendationRequests = recommendationRequestRepository.findAllByRequesterId(userId);
        return recommendationRequests;

    }
}





























Active mutators

CONDITIONALS_BOUNDARY
EMPTY_RETURNS
FALSE_RETURNS
INCREMENTS
INVERT_NEGS
MATH
NEGATE_CONDITIONALS
NULL_RETURNS
PRIMITIVE_RETURNS
TRUE_RETURNS
VOID_METHOD_CALLS

Tests examined

edu.ucsb.cs156.rec.controllers.RecommendationRequestControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.rec.controllers.RecommendationRequestControllerTests]/[method:a_student_user_cant_post_a_new_recommendation_request_with_bad_request_type()] (13 ms)
edu.ucsb.cs156.rec.controllers.RecommendationRequestControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.rec.controllers.RecommendationRequestControllerTests]/[method:a_student_user_can_post_a_new_recommendation_request()] (10 ms)
edu.ucsb.cs156.rec.controllers.RecommendationRequestControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.rec.controllers.RecommendationRequestControllerTests]/[method:logged_in_user_cant_get_all_recommendation_requests_by_non_existent_professor_id()] (9 ms)
edu.ucsb.cs156.rec.controllers.RecommendationRequestControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.rec.controllers.RecommendationRequestControllerTests]/[method:logged_in_user_can_get_all_recommendation_requests_by_professor_id()] (39 ms)
edu.ucsb.cs156.rec.controllers.RecommendationRequestControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.rec.controllers.RecommendationRequestControllerTests]/[method:admin_can_edit_an_existing_recommendationrequest()] (38 ms)
edu.ucsb.cs156.rec.controllers.RecommendationRequestControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.rec.controllers.RecommendationRequestControllerTests]/[method:user_can_delete_a_recommendation_request()] (8 ms)
edu.ucsb.cs156.rec.controllers.RecommendationRequestControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.rec.controllers.RecommendationRequestControllerTests]/[method:user_cant_delete_a_recommendation_request_they_didnt_author()] (17 ms)
edu.ucsb.cs156.rec.controllers.RecommendationRequestControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.rec.controllers.RecommendationRequestControllerTests]/[method:logged_in_users_can_get_all()] (4 ms)
edu.ucsb.cs156.rec.controllers.RecommendationRequestControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.rec.controllers.RecommendationRequestControllerTests]/[method:logged_in_user_can_get_all_recommendation_requests()] (6 ms)
edu.ucsb.cs156.rec.controllers.RecommendationRequestControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.rec.controllers.RecommendationRequestControllerTests]/[method:test_that_logged_in_user_can_get_by_id_when_the_id_exists()] (5 ms)
edu.ucsb.cs156.rec.controllers.RecommendationRequestControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.rec.controllers.RecommendationRequestControllerTests]/[method:admin_cannot_edit_recommendationrequest_that_does_not_exist()] (6 ms)
edu.ucsb.cs156.rec.controllers.RecommendationRequestControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.rec.controllers.RecommendationRequestControllerTests]/[method:logged_in_user_can_get_all_recommendation_requests_by_requester_id()] (6 ms)
edu.ucsb.cs156.rec.controllers.RecommendationRequestControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.rec.controllers.RecommendationRequestControllerTests]/[method:a_student_user_cant_post_a_new_recommendation_request_with_non_existent_professor_user()] (7 ms)
edu.ucsb.cs156.rec.controllers.RecommendationRequestControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.rec.controllers.RecommendationRequestControllerTests]/[method:test_that_logged_in_user_can_get_by_id_when_the_id_does_not_exist()] (5 ms)
edu.ucsb.cs156.rec.controllers.RecommendationRequestControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.rec.controllers.RecommendationRequestControllerTests]/[method:user_tries_to_delete_non_existant_recommendation_request_and_gets_right_error_message()] (46 ms)
edu.ucsb.cs156.rec.controllers.RecommendationRequestControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.rec.controllers.RecommendationRequestControllerTests]/[method:a_student_user_cant_post_a_new_recommendation_request_with_user_whos_not_a_professor()] (7 ms)
edu.ucsb.cs156.rec.controllers.RecommendationRequestControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.rec.controllers.RecommendationRequestControllerTests]/[method:logged_in_user_cant_get_all_recommendation_requests_by_non_existent_requester_id()] (6 ms)

Report generated by PIT 1.17.0

1		package edu.ucsb.cs156.rec.controllers;
2
3		import edu.ucsb.cs156.rec.entities.RecommendationRequest;
4		import edu.ucsb.cs156.rec.errors.EntityNotFoundException;
5		import edu.ucsb.cs156.rec.repositories.RecommendationRequestRepository;
6		import edu.ucsb.cs156.rec.repositories.UserRepository;
7		import edu.ucsb.cs156.rec.entities.User;
8		import edu.ucsb.cs156.rec.entities.RequestType;
9		import edu.ucsb.cs156.rec.repositories.RequestTypeRepository;
10
11		import io.swagger.v3.oas.annotations.Operation;
12		import io.swagger.v3.oas.annotations.Parameter;
13		import io.swagger.v3.oas.annotations.tags.Tag;
14		import lombok.extern.slf4j.Slf4j;
15
16		import com.fasterxml.jackson.core.JsonProcessingException;
17
18		import org.checkerframework.checker.units.qual.g;
19		import org.springframework.beans.factory.annotation.Autowired;
20		import org.springframework.boot.context.properties.source.IterableConfigurationPropertySource;
21		import org.springframework.format.annotation.DateTimeFormat;
22		import org.springframework.http.ResponseEntity;
23		import org.springframework.security.access.prepost.PreAuthorize;
24		import org.springframework.web.bind.annotation.DeleteMapping;
25		import org.springframework.web.bind.annotation.GetMapping;
26		import org.springframework.web.bind.annotation.PathVariable;
27		import org.springframework.web.bind.annotation.PostMapping;
28		import org.springframework.web.bind.annotation.PutMapping;
29		import org.springframework.web.bind.annotation.RequestBody;
30		import org.springframework.web.bind.annotation.RequestMapping;
31		import org.springframework.web.bind.annotation.RequestParam;
32		import org.springframework.web.bind.annotation.RestController;
33		import org.springframework.security.access.AccessDeniedException;
34		import org.springframework.http.HttpStatus;
35
36		import jakarta.validation.Valid;
37
38		import java.time.LocalDate;
39		import java.util.List;
40

RecommendationRequestController.java

Mutations

Active mutators

Tests examined