COMSW4156 Project - GroupGrub

This is the GitHub repository for the service portion of the Project associated with COMS 4156 Advanced Software Engineering. Our team ByteBuilders (Name: Zhengwen Fu, UNI: zf2314 | Name: Marian Abuhazi, UNI: ma4107 | Name: Beijia Zhang, UNI: bz2527 | Name: Chunyu Sui, UNI: cs4480) contributed to all the requirements individually.

Viewing the Service Repository

Please use the following link to view the repository relevant to the service: https://github.com/capsfly556/ase-4156project

Viewing the Front End Repository

Please use the following link to view the Front End repository : https://github.com/Foo2000/GroupGrubUI

Building and Running a Local Instance

In order to build and use this service you must install the following (This guide assumes Mac but the Maven README has instructions for both Windows and Mac):

Maven 3.9.9: https://maven.apache.org/download.cgi Download and follow the installation instructions, be sure to set the bin as described in Maven's README as a new path variable by editing the system variables if you are on windows or by following the instructions for MacOS.
OpenJDK 22: This project used OpenJDK 22 for development so that is what We recommend you use: https://formulae.brew.sh/formula/openjdk
IntelliJ IDE: We recommend using IntelliJ but you are free to use any other IDE that you are comfortable with: https://www.jetbrains.com/idea/download/?section=mac
When you open IntelliJ you have the option to clone from a GitHub repo, click the green code button and copy the http line that is provided there and give it to your IDE to clone.
To set up the database credentials (which is mandatory for running this project), if you are running it in terminal, source a script of this format:

#!/bin/bash

export GROUPGRUB_DB_URL=jdbc:mysql://{$YOUR_DB_IP}:3306/{$YOUR_DB_NAME}
export GROUPGRUB_DB_USER={$YOUR_DB_USER}
export GROUPGRUB_DB_PASSWORD={$YOUR_DB_PASSWORD}

Also, add these environment variables in IntelliJ run configuration. 6. cd to the repository folder in Terminal. In order to set up the project with maven you can run mvn clean install and then you can either run the tests via the test files described below or the main application by running GroupgrubserviceApplication.java from your IDE. You can use mvn clean package to package the project too. 7. If you wish to run the style checker you can with mvn checkstyle:check or mvn checkstyle:checkstyle if you wish to generate the report.

Running Tests

The unit tests are located under the directory src/test. To run the project's tests in IntelliJ using Java 22, you must first build the project.

From there, you can right-click any of the classes present in the src/test directory and click run to see the results.

mvn checkstyle:check

You can run the command mvn checkstyle:check > checkstyle-output.txt to verify if the repository adheres to Google's Java style guide. In this case, the check passed successfully with no violations or warnings.

Endpoints

This section describes the endpoints that the service provides, as well as their inputs and outputs.

Participants

GET /participants

Expected Input Parameters: N/A
Expected Output: A JSON array containing all participants.
Description: Retrieves all participants registered in the service.
Upon Success: HTTP 200 Status Code is returned along with the participants list in the response body.
Upon Failure:
- HTTP 404 Status Code with "No participants found" in the response body.

POST /participants

Expected Input Parameters: A JSON object containing participant details.
Expected Output: A JSON object containing the added participant's details.
Description: Adds a new participant.
Upon Success: HTTP 201 Status Code is returned along with the participant details in the response body.
Upon Failure:
- HTTP 400 Status Code with "Failed to add participant" in the response body.

GET /participants/{participantID}

Expected Input Parameters: participantID (String)
Expected Output: A JSON object containing the details of the specified participant.
Description: Retrieves details of a participant by participantID.
Upon Success: HTTP 200 Status Code is returned along with the participant details in the response body.
Upon Failure:
- HTTP 404 Status Code with "Participant not found" in the response body.

PUT /participants/{participantID}

Expected Input Parameters: participantID (String), A JSON object containing participant details.
Expected Output: A JSON object containing the updated participant's details.
Description: Updates a participant's details.
Upon Success: HTTP 200 Status Code is returned along with the updated participant details in the response body.
Upon Failure:
- HTTP 400 Status Code with "Failed to update participant" in the response body.
- HTTP 404 Status Code with "Participant not found" in the response body.

DELETE /participants/{participantID}

Expected Input Parameters: participantID (String)
Expected Output: N/A
Description: Deletes a participant.
Upon Success: HTTP 204 Status Code is returned.
Upon Failure:
- HTTP 404 Status Code with "Participant not found" in the response body.

GET /participants/{participantID}/orders

Expected Input Parameters: participantID (String)
Expected Output: A JSON array containing all orders for the specified participant.
Description: Retrieves all participant orders for a specific participant.
Upon Success: HTTP 200 Status Code is returned along with the participant orders in the response body.
Upon Failure:
- HTTP 404 Status Code with "No participant orders found" in the response body.

POST /participants/{participantID}/orders

Expected Input Parameters: participantID (String), A JSON object containing participant order details.
Expected Output: A JSON object containing the added participant's order details.
Description: Creates a new participant order.
Upon Success: HTTP 201 Status Code is returned along with the participant order details in the response body.
Upon Failure:
- HTTP 400 Status Code with "Failed to create a new order" in the response body.

GET /participants/{participantID}/orders/{participantOrderID}

Expected Input Parameters: participantID (String), participantOrderID (String)
Expected Output: A JSON object containing the details of the specified participant's order.
Description: Retrieves a specific participant's order.
Upon Success: HTTP 200 Status Code is returned along with the participant order details in the response body.
Upon Failure:
- HTTP 404 Status Code with "Order not found" in the response body.

PUT /participants/{participantID}/orders/{participantOrderID}

Expected Input Parameters: participantID (String), participantOrderID (String), A JSON object containing participant order details.
Expected Output: A JSON object containing the updated participant's order details.
Description: Updates a participant's order.
Upon Success: HTTP 200 Status Code is returned along with the updated participant order details in the response body.
Upon Failure:
- HTTP 400 Status Code with "Failed to update order" in the response body.
- HTTP 404 Status Code with "Order not found" in the response body.

DELETE /participants/{participantID}/orders/{participantOrderID}

Expected Input Parameters: participantID (String), participantOrderID (String)
Expected Output: N/A
Description: Deletes a participant's order.
Upon Success: HTTP 204 Status Code is returned.
Upon Failure:
- HTTP 404 Status Code with "Order not found" in the response body.

Groups

GET /groups/getAllGroups

Expected Input Parameters: N/A
Expected Output: A JSON array containing all groups.
Description: Retrieves a list of all groups in the service.
Upon Success: HTTP 200 Status Code is returned along with the groups list in the response body.
Upon Failure:
- HTTP 404 Status Code with "No groups found" in the response body.

POST /groups

Expected Input Parameters: A JSON object containing group details.
Expected Output: A JSON object containing the added group's details.
Description: Adds a new group to the service.
Upon Success: HTTP 201 Status Code is returned along with the group details in the response body.
Upon Failure:
- HTTP 400 Status Code with "Failed to add a new group" in the response body.

GET /groups/{groupId}

Expected Input Parameters: groupId (String)
Expected Output: A JSON object containing the details of the specified group.
Description: Retrieves details of a specific group.
Upon Success: HTTP 200 Status Code is returned along with the group details in the response body.
Upon Failure:
- HTTP 404 Status Code with "Group not found" in the response body.

PUT /groups/{groupId}

Expected Input Parameters: groupId (String), A JSON object containing group details.
Expected Output: A JSON object containing the updated group's details.
Description: Updates a group's details.
Upon Success: HTTP 200 Status Code is returned along with the updated group details in the response body.
Upon Failure:
- HTTP 404 Status Code with "Group not found" in the response body.

DELETE /groups/{groupId}

Expected Input Parameters: groupId (String)
Expected Output: N/A
Description: Deletes a group.
Upon Success: HTTP 204 Status Code is returned.
Upon Failure:
- HTTP 404 Status Code with "Group not found" in the response body.

GET /groups/{groupId}/orders

Expected Input Parameters: groupId (String)
Expected Output: A JSON array containing all orders for the specified group.
Description: Retrieves all group orders for a specific group.
Upon Success: HTTP 200 Status Code is returned along with the group orders in the response body.

POST /groups/{groupId}/orders

Expected Input Parameters: groupId (String), A JSON object containing group order details.
Expected Output: A JSON object containing the added group's order details.
Description: Creates a new group order.
Upon Success: HTTP 201 Status Code is returned along with the group order details in the response body.

GET /groups/{groupId}/orders/{orderId}

Expected Input Parameters: groupId (String), orderId (String)
Expected Output: A JSON object containing the details of the specified group order.
Description: Retrieves details of a specific group order.
Upon Success: HTTP 200 Status Code is returned along with the group order details in the response body.
Upon Failure:
- HTTP 404 Status Code with "Group order not found" in the response body.

PUT /groups/{groupId}/orders/{orderId}

Expected Input Parameters: groupId (String), orderId (String), A JSON object containing group order details.
Expected Output: A JSON object containing the updated group order's details.
Description: Updates a group order.
Upon Success: HTTP 200 Status Code is returned along with the updated group order details in the response body.
Upon Failure:
- HTTP 400 Status Code with "Failed to update the group order" in the response body.

DELETE /groups/{groupId}/orders/{orderId}

Expected Input Parameters: groupId (String), orderId (String)
Expected Output: N/A
Description: Deletes a group order.
Upon Success: HTTP 204 Status Code is returned.
Upon Failure:
- HTTP 404 Status Code with "Group order not found" in the response body.

Food Providers

GET /foodproviders

Expected Input Parameters: N/A
Expected Output: A JSON array containing all food providers.
Description: Retrieves a list of all food providers.
Upon Success: HTTP 200 Status Code is returned along with the food providers list in the response body.
Upon Failure:
- HTTP 404 Status Code with "No food providers found" in the response body.

POST /foodproviders

Expected Input Parameters: A JSON object containing food provider details.
Expected Output: A JSON object containing the added food provider's details.
Description: Adds a new food provider to the service.
Upon Success: HTTP 201 Status Code is returned along with the food provider details in the response body.
Upon Failure:
- HTTP 400 Status Code with "Failed to add food provider" in the response body.

GET /foodproviders/{foodProviderId}

Expected Input Parameters: foodProviderId (String)
Expected Output: A JSON object containing the details of the specified food provider.
Description: Retrieves details of a specific food provider.
Upon Success: HTTP 200 Status Code is returned along with the food provider details in the response body.
Upon Failure:
- HTTP 404 Status Code with "Food provider not found" in the response body.

PUT /foodproviders/{foodProviderId}

Expected Input Parameters: foodProviderId (String), A JSON object containing food provider details.
Expected Output: A JSON object containing the updated food provider's details.
Description: Updates a food provider's details.
Upon Success: HTTP 200 Status Code is returned along with the updated food provider details in the response body.
Upon Failure:
- HTTP 400 Status Code with "Failed to update food provider" in the response body.
- HTTP 404 Status Code with "Food provider not found" in the response body.

DELETE /foodproviders/{foodProviderId}

Expected Input Parameters: foodProviderId (String)
Expected Output: N/A
Description: Deletes a food provider.
Upon Success: HTTP 204 Status Code is returned.
Upon Failure:
- HTTP 404 Status Code with "Food provider not found" in the response body.

Style Checking Report

We used the tool "checkstyle" to check the style of the code and generate style checking reports. Here is the report as of the day of 2024/10/16 (these can be found in the images folder):

Branch Coverage Reporting

We used JaCoCo to perform branch analysis in order to see the branch coverage of the relevant code within the code base. See below for screenshots demonstrating output.

Static Analysis result

We used PMD as our static analysis tool and fixed all detected issues. You can run the following command to view the results

mvn pmd:check > pmdresult.txt

A screenshot of the results is also attached.

![](images/pmd output.png)

End-to-End Testing Document

This document outlines comprehensive end-to-end tests for validating the FoodProvider, Group, Participant, and ParticipantOrder APIs. Each section includes detailed test cases with sample input data, expected outputs, and manual testing instructions.

Test Environment

Testing Tools: Recommended tools include Postman, Curl, or other REST clients.
Base URL: Assuming the application is hosted at http://localhost:8080/api.
Data Preparation: In cases where IDs are not predefined, generate random UUIDs for testing.

{
  "name": "TestFoodProvider",
  "phoneNumber": "1234567890",
  "hoursOfOperation": "8hours",
  "location": "San Francisco",
  "menu": [
    {
      "name": "Burger",
      "image": "https://news.bk.com/media-assets/menu-item-and-campaign-images",
      "description": "A delicious beef burger",
      "cost": 11.00
    },
    {
      "name": "Fried chicken",
      "image": "https://www.allrecipes.com/recipe/8805/crispy-fried-chicken/",
      "description": "Crispy golden fried chicken",
      "cost": 11.00
    }
  ]
}

Expected Result:
- Status Code: 201 Created
- Response: No response body expected.
- Behavior: The FoodProvider is successfully created with the provided menu items.

Add FoodProvider with Missing Menu (Failure)

Objective: Validate that creating a FoodProvider without required fields fails.

Request:

Method: POST
URL: /foodproviders

Body:

{
  "name": "Test Provider",
  "phoneNumber": "1234567890"
}

Expected Result:
- Status Code: 400 Bad Request
- Response Message: Should specify the missing menu field.
- Behavior: The server rejects the request due to missing required fields.

Delete FoodProvider (Success)

Objective: Verify that an existing FoodProvider can be deleted by its ID.
Request:
- Method: DELETE
- URL: /foodproviders/{foodProviderId}
- Path Parameter: foodProviderId with an existing ID, e.g., 123e4567-e89b-12d3-a456-426614174000.
Expected Result:
- Status Code: 204 No Content
- Response: No response body expected.
- Behavior: The FoodProvider is deleted from the system, and subsequent retrieval attempts should return 404 Not Found.

Retrieve FoodProvider by ID (Success)

Objective: Confirm that retrieving a FoodProvider by ID returns the correct data.
Request:
- Method: GET
- URL: /foodproviders/{foodProviderId}
- Path Parameter: foodProviderId with a valid ID.

Expected Result:

Status Code: 200 OK

Response:

{
  "name": "TestFoodProvider",
  "phoneNumber": "1234567890",
  "hoursOfOperation": "8hours",
  "location": "San Francisco",
  "menu": [
    {
      "name": "Burger",
      "description": "A delicious beef burger",
      "cost": 11.00
    },
    {
      "name": "Fried chicken",
      "description": "Crispy golden fried chicken",
      "cost": 11.00
    }
  ]
}

Behavior: The server returns the FoodProvider details accurately, including the associated menu.

Group CRUD Operations

Retrieve All Groups (Success)

Objective: Verify that retrieving all groups returns a list of Group entries.
Request:
- Method: GET
- URL: /groups
Expected Result:
- Status Code: 200 OK
- Response: A list of all existing groups.
Behavior: The server should return a list of all Group objects. If no groups are present, it should respond with an empty list.

Retrieve Group by ID (Not Found)

Objective: Validate that attempting to retrieve a non-existent group returns a 404 Not Found.
Request:
- Method: GET
- URL: /groups/{groupId}
- Path Parameter: groupId with a non-existent ID.
Expected Result:
- Status Code: 404 Not Found
- Response: No response body expected.
- Behavior: The server should return 404 Not Found when the specified group ID does not exist.

Participant CRUD Operations

Add Participant (Success)

Objective: Ensure that a new Participant can be added.

Request:

Method: POST
URL: /participants

Body:

{
  "name": "John Doe",
  "participantID": "123e4567-e89b-12d3-a456-426614174001"
}

Expected Result:
- Status Code: 201 Created
- Response: The created Participant object.
Behavior: The Participant should be added to the database and returned in the response.

Retrieve All Participants (Not Found)

Objective: Verify that retrieving participants when none exist returns 404 Not Found.
Request:
- Method: GET
- URL: /participants
Expected Result:
- Status Code: 404 Not Found
- Response: Empty response body.
Behavior: The server should return 404 if no Participant records are found.

ParticipantOrder CRUD Operations

Retrieve All Orders for a Participant (Success)

Objective: Ensure that all orders for a specific participant can be retrieved.
Request:
- Method: GET
- URL: /participants/{participantId}/orders
- Path Parameter: participantId with an existing ID.
Expected Result:
- Status Code: 200 OK
- Response: List of ParticipantOrder entries.
Behavior: The server should return a list of all orders associated with the participant.

Update Participant Order (Success)

Objective: Confirm that a participant’s order can be updated.
Request:
- Method: PUT
- URL: /participants/{participantId}/orders/{orderId}
- Path Parameters: participantId and orderId with valid IDs.
- Body:
```
{
  "comments": "Updated comments",
  "menuItemIDs": {}
}
```
Expected Result:
- Status Code: 200 OK
- Response: Updated order details.
Behavior: The server updates the specified order and returns the updated information.

Certainly! Here’s a combined document explaining how Mock and Mockito are used in the provided unit tests:

Unit Testing with Mocking in `FoodProvider` API

This document details how mocking is applied in the unit tests for the FoodProvider API, using Mock and Mockito to simulate the behavior of service layer components. Mocking helps isolate the logic being tested by creating controllable test environments without relying on external dependencies.

Mocking in the Tests

In the provided unit tests, @Mock and Mockito are used to simulate the behavior of service classes such as FoodproviderService, GroupService, and GroupOrderService. This approach allows for focused testing on the controller logic without depending on actual implementations of these services.

Grouping of Testing Files

Our source files are organized into groups based on their roles: API, service, model, and repository. Similarly, our test files are grouped according to these same categories: API, service, model, and repository. This structure helps maintain consistency and makes it easy to locate and manage related files.

![](images/test files.png)

Use mocking in our test files

Creating Mocks with @Mock Annotation:
```
@Mock
private FoodproviderService service;
```
The @Mock annotation creates a mock instance of FoodproviderService, rather than using a real service instance. This allows for complete control over the behavior of FoodproviderService during the test, without relying on a database or any other external service.
Specifying Mock Behavior with Mockito.when:
```
Mockito.when(service.addFoodProvider(Mockito.any(FoodProvider.class)))
        .thenReturn(true);
```
The Mockito.when method specifies that when service.addFoodProvider() is called with any FoodProvider object, it should return true. This approach enables the test to simulate the expected behavior of the addFoodProvider method, ensuring predictable test outcomes and avoiding side effects from real service interactions.
Verifying Method Calls with Mockito.verify:
```
Mockito.verify(service, Mockito.times(1)).addFoodProvider(Mockito.any(FoodProvider.class));
```
The Mockito.verify method is used to check whether addFoodProvider was called exactly once during the test. This verification ensures that the expected service method is called as part of the controller logic, allowing for further validation of the controller's behavior.

Manual Testing Checklist

If automation is unavailable, follow these steps manually:

Set Up Initial Data: Ensure all entities (FoodProvider, Group, Participant, and ParticipantOrder) are created or available as needed.
Verify API Response Codes and Content: Use tools like Postman to send API requests for each endpoint. Compare the actual responses against the expected results documented above.
Log Each Result: Record whether each test passed or failed, noting discrepancies.
Repeat Tests as Needed: Re-run tests as the application evolves to ensure consistency.

Project management

We used the tool Trello for the project management. Here is the screenshot of the board:

Third-party code

The initial project skeleton is generated using openapi-generator with the OpenAPI specs wrote by our team. Specifically, in src/main/java/org/openapitools, the api/*Api.* files, the api/ApiUtil.java file, the configuration/* files, the GroupgrubserviceApplication.java file, and the RFC3339DateFormat.java file are auto-generated and are excluded from the test report.

Tools used

This section includes notes on tools and technologies used in building this project, as well as any additional details if applicable.

Maven Package Manager
Checkstyle
- We use Checkstyle for code reporting. Note that Checkstyle does NOT get run as part of the CI pipeline.
- For running Checkstyle manually, you can use the "Checkstyle-IDEA" plugin for IntelliJ.
JUnit
- JUnit tests get run automatically as part of the CI pipeline.
JaCoCo
- We use JaCoCo for generating code coverage reports.
openapi-generator
- We use openapi-generator for the initial project skeleton.
Trello
- We use Trello for the project management.

Name		Name	Last commit message	Last commit date
Latest commit History 66 Commits
.github/workflows		.github/workflows
.mvn/wrapper		.mvn/wrapper
.openapi-generator		.openapi-generator
config/pmd		config/pmd
images		images
src		src
.gitignore		.gitignore
.openapi-generator-ignore		.openapi-generator-ignore
README.md		README.md
checkstyle-output.txt		checkstyle-output.txt
checkstyle.xml		checkstyle.xml
mvnw		mvnw
mvnw.cmd		mvnw.cmd
pmdresult.txt		pmdresult.txt
pom.xml		pom.xml

Folders and files

Latest commit

History

Repository files navigation

COMSW4156 Project - GroupGrub

Viewing the Service Repository

Viewing the Front End Repository

Building and Running a Local Instance

Running Tests

mvn checkstyle:check

Endpoints

Participants

GET /participants

POST /participants

GET /participants/{participantID}

PUT /participants/{participantID}

DELETE /participants/{participantID}

GET /participants/{participantID}/orders

POST /participants/{participantID}/orders

GET /participants/{participantID}/orders/{participantOrderID}

PUT /participants/{participantID}/orders/{participantOrderID}

DELETE /participants/{participantID}/orders/{participantOrderID}

Groups

GET /groups/getAllGroups

POST /groups

GET /groups/{groupId}

PUT /groups/{groupId}

DELETE /groups/{groupId}

GET /groups/{groupId}/orders

POST /groups/{groupId}/orders

GET /groups/{groupId}/orders/{orderId}

PUT /groups/{groupId}/orders/{orderId}

DELETE /groups/{groupId}/orders/{orderId}

Food Providers

GET /foodproviders

POST /foodproviders

GET /foodproviders/{foodProviderId}

PUT /foodproviders/{foodProviderId}

DELETE /foodproviders/{foodProviderId}

Style Checking Report

Branch Coverage Reporting

Static Analysis result

End-to-End Testing Document

Test Environment

Table of Contents

FoodProvider CRUD Operations

Add a New FoodProvider (Success)

Add FoodProvider with Missing Menu (Failure)

Delete FoodProvider (Success)

Retrieve FoodProvider by ID (Success)

Group CRUD Operations

Retrieve All Groups (Success)

Retrieve Group by ID (Not Found)

Participant CRUD Operations

Add Participant (Success)

Retrieve All Participants (Not Found)

ParticipantOrder CRUD Operations

Retrieve All Orders for a Participant (Success)

Update Participant Order (Success)

Unit Testing with Mocking in FoodProvider API

Mocking in the Tests

Grouping of Testing Files

Use mocking in our test files

Manual Testing Checklist

Project management

Third-party code

Tools used

About

Resources

Uh oh!

Stars

Watchers

Forks

Releases 1

Packages 0

Uh oh!

Uh oh!

Contributors

Uh oh!

Languages

Unit Testing with Mocking in `FoodProvider` API

Packages