CommonsController.java

package edu.ucsb.cs156.happiercows.controllers;

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import edu.ucsb.cs156.happiercows.entities.Commons;
import edu.ucsb.cs156.happiercows.entities.CommonsPlus;
import edu.ucsb.cs156.happiercows.entities.User;
import edu.ucsb.cs156.happiercows.entities.UserCommons;
import edu.ucsb.cs156.happiercows.errors.EntityNotFoundException;
import edu.ucsb.cs156.happiercows.models.CreateCommonsParams;
import edu.ucsb.cs156.happiercows.models.HealthUpdateStrategyList;
import edu.ucsb.cs156.happiercows.repositories.CommonsRepository;
import edu.ucsb.cs156.happiercows.repositories.UserCommonsRepository;
import edu.ucsb.cs156.happiercows.strategies.CowHealthUpdateStrategies;
import io.swagger.v3.oas.annotations.tags.Tag;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.security.access.prepost.PreAuthorize;
import org.springframework.web.bind.annotation.*;
import edu.ucsb.cs156.happiercows.services.CommonsPlusBuilderService;

import java.time.LocalDateTime;
import java.util.Optional;


@Slf4j
@Tag(name = "Commons")
@RequestMapping("/api/commons")
@RestController
public class CommonsController extends ApiController {
    @Autowired
    private CommonsRepository commonsRepository;

    @Autowired
    private UserCommonsRepository userCommonsRepository;

    @Autowired
    ObjectMapper mapper;

    @Autowired
    CommonsPlusBuilderService commonsPlusBuilderService;

    @Value("${app.commons.default.startingBalance}")
    private int defaultStartingBalance;

    @Value("${app.commons.default.cowPrice}")
    private int defaultCowPrice;

    @Value("${app.commons.default.milkPrice}")
    private int defaultMilkPrice;

    @Value("${app.commons.default.degradationRate}")
    private double defaultDegradationRate;

    @Value("${app.commons.default.carryingCapacity}")
    private int defaultCarryingCapacity;

    @Value("${app.commons.default.capacityPerUser}")
    private int defaultCapacityPerUser;

    @Value("${app.commons.default.aboveCapacityHealthUpdateStrategy}")
    private String defaultAboveCapacityHealthUpdateStrategy;

    @Value("${app.commons.default.belowCapacityHealthUpdateStrategy}")
    private String defaultBelowCapacityHealthUpdateStrategy;

    @Operation(summary = "Get a list of all commons")
    @GetMapping("/all")
    public ResponseEntity<String> getCommons() throws JsonProcessingException {
        log.info("getCommons()...");
        Iterable<Commons> commons = commonsRepository.findAll();
        String body = mapper.writeValueAsString(commons);
        return ResponseEntity.ok().body(body);
    }

    @Operation(summary = "Get a list of all commons and number of cows/users")
    @GetMapping("/allplus")
    public ResponseEntity<String> getCommonsPlus() throws JsonProcessingException {
        log.info("getCommonsPlus()...");
        Iterable<Commons> commonsListIter = commonsRepository.findAll();

        // convert Iterable to List for the purposes of using a Java Stream & lambda
        // below
        Iterable<CommonsPlus> commonsPlusList = commonsPlusBuilderService.convertToCommonsPlus(commonsListIter);

        String body = mapper.writeValueAsString(commonsPlusList);
        return ResponseEntity.ok().body(body);
    }

    @Operation(summary = "Get the number of cows/users in a commons")
    @PreAuthorize("hasRole('ROLE_USER')")
    @GetMapping("/plus")
    public CommonsPlus getCommonsPlusById(
            @Parameter(name="id") @RequestParam long id) throws JsonProcessingException {
                CommonsPlus commonsPlus = commonsPlusBuilderService.toCommonsPlus(commonsRepository.findById(id)
                .orElseThrow(() -> new EntityNotFoundException(Commons.class, id)));

        return commonsPlus;
    }
    
    @Operation(summary = "Get a commons object containing the default values")
    @PreAuthorize("hasRole('ROLE_USER')")
    @GetMapping("/defaults")
    public ResponseEntity<String> getDefaultCommons() throws JsonProcessingException {
        var builder = Commons.builder()
            .name("")
            .cowPrice(defaultCowPrice)
            .milkPrice(defaultMilkPrice)
            .startingBalance(defaultStartingBalance)
            .startingDate(LocalDateTime.now().withNano(0))
            .degradationRate(defaultDegradationRate)
            .showLeaderboard(false)
            .capacityPerUser(defaultCapacityPerUser)
            .carryingCapacity(defaultCarryingCapacity);
        
        Commons defaultCommons = builder.build();

        defaultCommons.setAboveCapacityHealthUpdateStrategy(CowHealthUpdateStrategies.valueOf(defaultAboveCapacityHealthUpdateStrategy));
        defaultCommons.setBelowCapacityHealthUpdateStrategy(CowHealthUpdateStrategies.valueOf(defaultBelowCapacityHealthUpdateStrategy));
    
        String body = mapper.writeValueAsString(defaultCommons);
        return ResponseEntity.ok().body(body);
    }


    @Operation(summary = "Update a commons")
    @PreAuthorize("hasRole('ROLE_ADMIN')")
    @PutMapping("/update")
    public ResponseEntity<String> updateCommons(
            @Parameter(name="commons identifier") @RequestParam long id,
            @Parameter(name="request body") @RequestBody CreateCommonsParams params
    ) {
        Optional<Commons> existing = commonsRepository.findById(id);

        Commons updated;
        HttpStatus status;

        if (existing.isPresent()) {
            updated = existing.get();
            status = HttpStatus.NO_CONTENT;
        } else {
            updated = new Commons();
            status = HttpStatus.CREATED;
        }

        updated.setName(params.getName());
        updated.setCowPrice(params.getCowPrice());
        updated.setMilkPrice(params.getMilkPrice());
        updated.setStartingBalance(params.getStartingBalance());
        updated.setStartingDate(params.getStartingDate());
        updated.setLastDay(params.getLastDay());
        updated.setShowLeaderboard(params.getShowLeaderboard());
        updated.setDegradationRate(params.getDegradationRate());
        updated.setCapacityPerUser(params.getCapacityPerUser());
        updated.setCarryingCapacity(params.getCarryingCapacity());
        if (params.getAboveCapacityHealthUpdateStrategy() != null) {
            updated.setAboveCapacityHealthUpdateStrategy(CowHealthUpdateStrategies.valueOf(params.getAboveCapacityHealthUpdateStrategy()));
        }
        if (params.getBelowCapacityHealthUpdateStrategy() != null) {
            updated.setBelowCapacityHealthUpdateStrategy(CowHealthUpdateStrategies.valueOf(params.getBelowCapacityHealthUpdateStrategy()));
        }

        if (params.getDegradationRate() < 0) {
            throw new IllegalArgumentException("Degradation Rate cannot be negative");
        }

        // Reference: frontend/src/main/components/Commons/CommonsForm.js
        if (params.getName().equals("")) {
            throw new IllegalArgumentException("Name cannot be empty");
        }

        if (params.getCowPrice() < 0.01) {
            throw new IllegalArgumentException("Cow Price cannot be less than 0.01");
        }

        if (params.getMilkPrice() < 0.01) {
            throw new IllegalArgumentException("Milk Price cannot be less than 0.01");
        }

        if (params.getStartingBalance() < 0) {
            throw new IllegalArgumentException("Starting Balance cannot be negative");
        }

        if (params.getCarryingCapacity() < 1) {
            throw new IllegalArgumentException("Carrying Capacity cannot be less than 1");
        }
        commonsRepository.save(updated);

        return ResponseEntity.status(status).build();
    }

    @Operation(summary = "Get a specific commons")
    @PreAuthorize("hasRole('ROLE_USER')")
    @GetMapping("")
    public Commons getCommonsById(
            @Parameter(name="id") @RequestParam Long id) throws JsonProcessingException {

        Commons commons = commonsRepository.findById(id)
                .orElseThrow(() -> new EntityNotFoundException(Commons.class, id));

        return commons;
    }

    @Operation(summary = "Create a new commons")
    @PreAuthorize("hasRole('ROLE_ADMIN')")
    @PostMapping(value = "/new", produces = "application/json")
    public ResponseEntity<String> createCommons(
            @Parameter(name="request body") @RequestBody CreateCommonsParams params
    ) throws JsonProcessingException {

        var builder = Commons.builder()
                .name(params.getName())
                .cowPrice(params.getCowPrice())
                .milkPrice(params.getMilkPrice())
                .startingBalance(params.getStartingBalance())
                .startingDate(params.getStartingDate())
                .lastDay(params.getLastDay())                             
                .degradationRate(params.getDegradationRate())
                .showLeaderboard(params.getShowLeaderboard())
                .capacityPerUser(params.getCapacityPerUser())
                .carryingCapacity(params.getCarryingCapacity());

        // ok to set null values for these, so old backend still works
        if (params.getAboveCapacityHealthUpdateStrategy() != null) {
            builder.aboveCapacityHealthUpdateStrategy(CowHealthUpdateStrategies.valueOf(params.getAboveCapacityHealthUpdateStrategy()));
        }
        if (params.getBelowCapacityHealthUpdateStrategy() != null) {
            builder.belowCapacityHealthUpdateStrategy(CowHealthUpdateStrategies.valueOf(params.getBelowCapacityHealthUpdateStrategy()));
        }

        Commons commons = builder.build();

        // Reference: frontend/src/main/components/Commons/CommonsForm.js
        if (params.getName().equals("")) {
            throw new IllegalArgumentException("Name cannot be empty");
        }

        if (params.getCowPrice() < 0.01) {
            throw new IllegalArgumentException("Cow Price cannot be less than 0.01");
        }

        if (params.getMilkPrice() < 0.01) {
            throw new IllegalArgumentException("Milk Price cannot be less than 0.01");
        }

        if (params.getStartingBalance() < 0) {
            throw new IllegalArgumentException("Starting Balance cannot be negative");
        }

        // throw exception for degradation rate
        if (params.getDegradationRate() < 0) {
            throw new IllegalArgumentException("Degradation Rate cannot be negative");
        }

        if (params.getCarryingCapacity() < 1) {
            throw new IllegalArgumentException("Carrying Capacity cannot be less than 1");
        }

        Commons saved = commonsRepository.save(commons);
        String body = mapper.writeValueAsString(saved);

        return ResponseEntity.ok().body(body);
    }


    @Operation(summary = "List all cow health update strategies")
    @PreAuthorize("hasRole('ROLE_USER')")
    @GetMapping("/all-health-update-strategies")
    public ResponseEntity<String> listCowHealthUpdateStrategies() throws JsonProcessingException {
        var result = HealthUpdateStrategyList.create();
        String body = mapper.writeValueAsString(result);
        return ResponseEntity.ok().body(body);
    }

    @Operation(summary = "Join a commons")
    @PreAuthorize("hasRole('ROLE_USER')")
    @PostMapping(value = "/join", produces = "application/json")
    public ResponseEntity<String> joinCommon(
            @Parameter(name="commonsId") @RequestParam Long commonsId) throws Exception {

        User u = getCurrentUser().getUser();
        Long userId = u.getId();
        String username = u.getFullName();

        Commons joinedCommons = commonsRepository.findById(commonsId)
                .orElseThrow(() -> new EntityNotFoundException(Commons.class, commonsId));
        Optional<UserCommons> userCommonsLookup = userCommonsRepository.findByCommonsIdAndUserId(commonsId, userId);

        if (userCommonsLookup.isPresent()) {
            // user is already a member of this commons
            String body = mapper.writeValueAsString(joinedCommons);
            return ResponseEntity.ok().body(body);
        }

        UserCommons uc = UserCommons.builder()
                .user(u)
                .commons(joinedCommons)
                .username(username)
                .totalWealth(joinedCommons.getStartingBalance())
                .numOfCows(0)
                .cowHealth(100)
                .cowsBought(0)
                .cowsSold(0)
                .cowDeaths(0)
                .build();

        userCommonsRepository.save(uc);

        String body = mapper.writeValueAsString(joinedCommons);
        return ResponseEntity.ok().body(body);
    }

    @Operation(summary = "Delete a Commons")
    @PreAuthorize("hasRole('ROLE_ADMIN')")
    @DeleteMapping("")
    public Object deleteCommons(
            @Parameter(name="id") @RequestParam Long id) {

        commonsRepository.findById(id)
                .orElseThrow(() -> new EntityNotFoundException(Commons.class, id));

        commonsRepository.deleteById(id);

        String responseString = String.format("commons with id %d deleted", id);
        return genericMessage(responseString);

    }

    @Operation(summary="Delete a user from a commons")
    @PreAuthorize("hasRole('ROLE_ADMIN')")
    @DeleteMapping("/{commonsId}/users/{userId}")
    public Object deleteUserFromCommon(@PathVariable("commonsId") Long commonsId,
                                       @PathVariable("userId") Long userId) throws Exception {

        UserCommons userCommons = userCommonsRepository.findByCommonsIdAndUserId(commonsId, userId)
                .orElseThrow(() -> new EntityNotFoundException(
                        UserCommons.class, "commonsId", commonsId, "userId", userId)
                );

        userCommonsRepository.delete(userCommons);

        String responseString = String.format("user with id %d deleted from commons with id %d, %d users remain", userId, commonsId, commonsRepository.getNumUsers(commonsId).orElse(0));

        return genericMessage(responseString);
    }

    
}





















































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.happiercows.controllers.CommonsControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.happiercows.controllers.CommonsControllerTests]/[method:createCommonsTest_withBoundaryParameters()] (13 ms)
edu.ucsb.cs156.happiercows.controllers.CommonsControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.happiercows.controllers.CommonsControllerTests]/[method:updateCommonsTest()] (16 ms)
edu.ucsb.cs156.happiercows.controllers.CommonsControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.happiercows.controllers.CommonsControllerTests]/[method:createCommonsTest_withNoCowHealthUpdateStrategies()] (20 ms)
edu.ucsb.cs156.happiercows.controllers.CommonsControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.happiercows.controllers.CommonsControllerTests]/[method:getCommonsByIdTest_valid()] (17 ms)
edu.ucsb.cs156.happiercows.controllers.CommonsControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.happiercows.controllers.CommonsControllerTests]/[method:UpdateCommonsTest_withIllegalParameters()] (58 ms)
edu.ucsb.cs156.happiercows.controllers.CommonsControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.happiercows.controllers.CommonsControllerTests]/[method:deleteUserFromCommonsTest()] (25 ms)
edu.ucsb.cs156.happiercows.controllers.CommonsControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.happiercows.controllers.CommonsControllerTests]/[method:UpdateCommonsTest_withBoundaryParameters()] (50 ms)
edu.ucsb.cs156.happiercows.controllers.CommonsControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.happiercows.controllers.CommonsControllerTests]/[method:createCommonsTest()] (23 ms)
edu.ucsb.cs156.happiercows.controllers.CommonsControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.happiercows.controllers.CommonsControllerTests]/[method:getCommonsTest()] (20 ms)
edu.ucsb.cs156.happiercows.controllers.CommonsControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.happiercows.controllers.CommonsControllerTests]/[method:updateCommonsTest_withNoCowHealthUpdateStrategy()] (15 ms)
edu.ucsb.cs156.happiercows.controllers.CommonsControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.happiercows.controllers.CommonsControllerTests]/[method:getDefaultCommons_valid()] (18 ms)
edu.ucsb.cs156.happiercows.controllers.CommonsControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.happiercows.controllers.CommonsControllerTests]/[method:deleteUserFromCommons_when_not_joined()] (21 ms)
edu.ucsb.cs156.happiercows.controllers.CommonsControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.happiercows.controllers.CommonsControllerTests]/[method:updateCommonsTest_withDegradationRate_Zero()] (17 ms)
edu.ucsb.cs156.happiercows.controllers.CSRFControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.happiercows.controllers.CSRFControllerTests]/[method:csrf_returns_ok()] (17 ms)
edu.ucsb.cs156.happiercows.controllers.CommonsControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.happiercows.controllers.CommonsControllerTests]/[method:already_joined_common_test()] (50 ms)
edu.ucsb.cs156.happiercows.controllers.CommonsControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.happiercows.controllers.CommonsControllerTests]/[method:getHealthUpdateStrategiesTest()] (16 ms)
edu.ucsb.cs156.happiercows.controllers.CommonsControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.happiercows.controllers.CommonsControllerTests]/[method:deleteCommons_test_admin_nonexists()] (21 ms)
edu.ucsb.cs156.happiercows.controllers.CommonsControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.happiercows.controllers.CommonsControllerTests]/[method:updateCommonsTest_withIllegalDegradationRate()] (16 ms)
edu.ucsb.cs156.happiercows.controllers.CommonsControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.happiercows.controllers.CommonsControllerTests]/[method:getCommonsPlusByIdTest_valid()] (16 ms)
edu.ucsb.cs156.happiercows.controllers.CommonsControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.happiercows.controllers.CommonsControllerTests]/[method:join_when_commons_with_id_does_not_exist()] (54 ms)
edu.ucsb.cs156.happiercows.controllers.CommonsControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.happiercows.controllers.CommonsControllerTests]/[method:getCommonsPlusTest()] (20 ms)
edu.ucsb.cs156.happiercows.controllers.CommonsControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.happiercows.controllers.CommonsControllerTests]/[method:deleteCommons_test_admin_exists()] (19 ms)
edu.ucsb.cs156.happiercows.controllers.CommonsControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.happiercows.controllers.CommonsControllerTests]/[method:createCommonsTest_zeroDegradation()] (17 ms)
edu.ucsb.cs156.happiercows.controllers.CommonsControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.happiercows.controllers.CommonsControllerTests]/[method:getCommonsByIdTest_invalid()] (19 ms)
edu.ucsb.cs156.happiercows.controllers.CommonsControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.happiercows.controllers.CommonsControllerTests]/[method:createCommonsTest_withIllegalDegradationRate()] (13 ms)
edu.ucsb.cs156.happiercows.controllers.CommonsControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.happiercows.controllers.CommonsControllerTests]/[method:joinCommonsTest()] (23 ms)
edu.ucsb.cs156.happiercows.controllers.CommonsControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.happiercows.controllers.CommonsControllerTests]/[method:getCommonsPlusByIdTest_invalid()] (14 ms)
edu.ucsb.cs156.happiercows.controllers.CommonsControllerTests.[engine:junit-jupiter]/[class:edu.ucsb.cs156.happiercows.controllers.CommonsControllerTests]/[method:createCommonsTest_withIllegalParameters()] (19 ms)

Report generated by PIT 1.7.3

1		package edu.ucsb.cs156.happiercows.controllers;
2
3		import com.fasterxml.jackson.core.JsonProcessingException;
4		import com.fasterxml.jackson.databind.ObjectMapper;
5		import edu.ucsb.cs156.happiercows.entities.Commons;
6		import edu.ucsb.cs156.happiercows.entities.CommonsPlus;
7		import edu.ucsb.cs156.happiercows.entities.User;
8		import edu.ucsb.cs156.happiercows.entities.UserCommons;
9		import edu.ucsb.cs156.happiercows.errors.EntityNotFoundException;
10		import edu.ucsb.cs156.happiercows.models.CreateCommonsParams;
11		import edu.ucsb.cs156.happiercows.models.HealthUpdateStrategyList;
12		import edu.ucsb.cs156.happiercows.repositories.CommonsRepository;
13		import edu.ucsb.cs156.happiercows.repositories.UserCommonsRepository;
14		import edu.ucsb.cs156.happiercows.strategies.CowHealthUpdateStrategies;
15		import io.swagger.v3.oas.annotations.tags.Tag;
16		import io.swagger.v3.oas.annotations.Operation;
17		import io.swagger.v3.oas.annotations.Parameter;
18		import lombok.extern.slf4j.Slf4j;
19		import org.springframework.beans.factory.annotation.Autowired;
20		import org.springframework.beans.factory.annotation.Value;
21		import org.springframework.http.HttpStatus;
22		import org.springframework.http.ResponseEntity;
23		import org.springframework.security.access.prepost.PreAuthorize;
24		import org.springframework.web.bind.annotation.*;
25		import edu.ucsb.cs156.happiercows.services.CommonsPlusBuilderService;
26
27		import java.time.LocalDateTime;
28		import java.util.Optional;
29
30
31		@Slf4j
32		@Tag(name = "Commons")
33		@RequestMapping("/api/commons")
34		@RestController
35		public class CommonsController extends ApiController {
36		@Autowired
37		private CommonsRepository commonsRepository;
38
39		@Autowired
40		private UserCommonsRepository userCommonsRepository;

CommonsController.java

Mutations

Active mutators

Tests examined