WIP: Add Coffee management plugin for HackerBook training by Damans227 · Pull Request #1 · Damans227/cloudstack

Damans227 · 2025-11-26T23:07:43Z

Description

This PR implements a Coffee management plugin as part of the HackerBook training exercise, demonstrating CloudStack's plugin architecture from API layer to database persistence.

Features:

API Commands: CreateCoffee, ListCoffees, UpdateCoffee, RemoveCoffee
Service Layer: CoffeeManager interface and CoffeeManagerImpl with Spring DI
Database Layer: CoffeeVO entity, CoffeeDao, CoffeeDaoImpl with GenericDaoBase
Schema: coffee table with id, uuid, name, offering, size, state, account_id, created, removed

Supported Operations:

Create coffee orders with name, offering (Espresso/Cappuccino/Mocha/Latte), and size (SMALL/MEDIUM/LARGE)
List coffees with optional filtering by offering and size
Update coffee size
Remove coffee orders

Types of changes

Breaking change (fix or feature that would cause existing functionality to change)
New feature (non-breaking change which adds functionality)
Bug fix (non-breaking change which fixes an issue)
Enhancement (improves an existing feature and functionality)
Cleanup (Code refactoring and cleanup, that may add test cases)
Build/CI
Test (unit or integration test code)

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

Major
Minor

Bug Severity

Screenshots (if appropriate):

How Has This Been Tested?

Tested CRUD operations via direct API calls and using cmk
Verified database persistence using MySQL CLI
Tested filtering with various parameter combinations

How did you try to break this feature and the system with this change?

Signed-off-by: Daman Arora <daman.arora@shapeblue.com>

nvazquez

Thanks @Damans227 - looking good so far, please consider adding unit tests

nvazquez · 2025-11-27T10:31:53Z

+        </dependency>
+    </dependencies>
+    <properties>
+        <maven.compiler.source>11</maven.compiler.source>


Can you revisit these properties? We are currently using JDK 17

nvazquez · 2025-11-27T10:37:54Z

+
+    @Override
+    public void create() {
+        coffee = coffeeManager.createCoffee(this);


I think coffee can be defined as a local variable to this method and not outside of it

The coffee field needs to be an instance variable because it's set in create() and then accessed in execute(). If coffee were a local variable in create(), then execute() wouldn't have access to it.

nvazquez · 2025-11-27T10:39:31Z

+            } else if (ids != null && !ids.isEmpty()) {
+                response.setDisplayText("Successfully removed " + ids.size() + " coffee orders");
+            } else {
+                response.setDisplayText("Coffee removal completed");


I think these lines could be extracted into a method to set the display text based on the id and ids parameters

nvazquez · 2025-11-27T10:40:08Z

+            description = "the ID of the coffee order")
+    private Long id;
+
+    @Parameter(name = "size",


Can we use ApiConstants here?

Damans227 changed the title ~~Add Coffee management plugin for HackerBook training~~ WIP: Add Coffee management plugin for HackerBook training Nov 26, 2025

Damans227 marked this pull request as draft November 26, 2025 23:10

Daman Arora added 28 commits November 26, 2025 19:24

add new and update existing maven modules using respective pom.xml

7eea001

Signed-off-by: Daman Arora <daman.arora@shapeblue.com>

add module.properties

e4ff60f

Signed-off-by: Daman Arora <daman.arora@shapeblue.com>

add list and response class

b14b726

Signed-off-by: Daman Arora <daman.arora@shapeblue.com>

add service and inject it as a bean

72b9ca7

Signed-off-by: Daman Arora <daman.arora@shapeblue.com>

update apidocs

364cd4c

Signed-off-by: Daman Arora <daman.arora@shapeblue.com>

add CreateCoffeeCmd

5dacb24

Signed-off-by: Daman Arora <daman.arora@shapeblue.com>

add UpdateCoffeeCmd

cd7acf5

Signed-off-by: Daman Arora <daman.arora@shapeblue.com>

add RemoveCoffeeCmd

e06880f

Signed-off-by: Daman Arora <daman.arora@shapeblue.com>

load feature after backend by making it a child of backend.

5e72ab6

Signed-off-by: Daman Arora <daman.arora@shapeblue.com>

use coffeeManager and it's implementation instead of service

3319d2d

Signed-off-by: Daman Arora <daman.arora@shapeblue.com>

add coffee resource

f7cfda9

Signed-off-by: Daman Arora <daman.arora@shapeblue.com>

use dependency injection and coffee resource in api commands

c1cdfd6

Signed-off-by: Daman Arora <daman.arora@shapeblue.com>

remove un-needed comment

ff437da

Signed-off-by: Daman Arora <daman.arora@shapeblue.com>

use naming convention for static variable logger

6f8f8c5

Signed-off-by: Daman Arora <daman.arora@shapeblue.com>

add missing license

5a2404e

Signed-off-by: Daman Arora <daman.arora@shapeblue.com>

add zone scoped coffee.ttl.interval config key

1356b58

Signed-off-by: Daman Arora <daman.arora@shapeblue.com>

add coffee.gc.interval for running a background task

5bfc52c

Signed-off-by: Daman Arora <daman.arora@shapeblue.com>

add coffee table schema

ebacdbc

Signed-off-by: Daman Arora <daman.arora@shapeblue.com>

fix typo

e67c234

Signed-off-by: Daman Arora <daman.arora@shapeblue.com>

add CoffeeVO entity class

f9fc8ba

Signed-off-by: Daman Arora <daman.arora@shapeblue.com>

add size and offering getters again

027a1c4

Signed-off-by: Daman Arora <daman.arora@shapeblue.com>

add dao interface and class

1a9a1d2

Signed-off-by: Daman Arora <daman.arora@shapeblue.com>

update VO with missing getters

efd6a02

Signed-off-by: Daman Arora <daman.arora@shapeblue.com>

register dao class for dependency injection

155f23a

Signed-off-by: Daman Arora <daman.arora@shapeblue.com>

remove not null - not needed anymore

d517c7e

Signed-off-by: Daman Arora <daman.arora@shapeblue.com>

add size and offering to schema

ff504ac

Signed-off-by: Daman Arora <daman.arora@shapeblue.com>

remove hardcoded data and use dao

1380c08

Signed-off-by: Daman Arora <daman.arora@shapeblue.com>

fix filter and update logic

e0523c1

Signed-off-by: Daman Arora <daman.arora@shapeblue.com>

Daman Arora added 6 commits November 26, 2025 19:24

fix type for id

e75c4f9

Signed-off-by: Daman Arora <daman.arora@shapeblue.com>

Replace UUID with LONG for id param

b951b3a

Signed-off-by: Daman Arora <daman.arora@shapeblue.com>

code cleanup for api commands

d7d073f

Signed-off-by: Daman Arora <daman.arora@shapeblue.com>

code cleanup

9ec07cf

Signed-off-by: Daman Arora <daman.arora@shapeblue.com>

code cleanup

73f9dcb

Signed-off-by: Daman Arora <daman.arora@shapeblue.com>

code cleanup

5fb8b1c

Signed-off-by: Daman Arora <daman.arora@shapeblue.com>

Damans227 force-pushed the feature/coffee-api branch from 2b3a85c to 5fb8b1c Compare November 27, 2025 00:25

Daman Arora added 4 commits November 26, 2025 19:28

fix spacing

a77127a

Signed-off-by: Daman Arora <daman.arora@shapeblue.com>

code cleanup

0e11495

Signed-off-by: Daman Arora <daman.arora@shapeblue.com>

remove unused code

e6660dc

Signed-off-by: Daman Arora <daman.arora@shapeblue.com>

remove unused imports

0584c02

Signed-off-by: Daman Arora <daman.arora@shapeblue.com>

nvazquez reviewed Nov 27, 2025

View reviewed changes

Damans227 closed this Nov 28, 2025

Damans227 deleted the feature/coffee-api branch November 28, 2025 15:24

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

WIP: Add Coffee management plugin for HackerBook training#1

WIP: Add Coffee management plugin for HackerBook training#1
Damans227 wants to merge 38 commits into
mainfrom
feature/coffee-api

Damans227 commented Nov 26, 2025

Uh oh!

nvazquez left a comment

Uh oh!

nvazquez Nov 27, 2025

Uh oh!

nvazquez Nov 27, 2025

Uh oh!

Damans227 Nov 27, 2025

Uh oh!

nvazquez Nov 27, 2025

Uh oh!

nvazquez Nov 27, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

Damans227 commented Nov 26, 2025

Description

Types of changes

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

Bug Severity

Screenshots (if appropriate):

How Has This Been Tested?

How did you try to break this feature and the system with this change?

Uh oh!

nvazquez left a comment

Choose a reason for hiding this comment

Uh oh!

nvazquez Nov 27, 2025

Choose a reason for hiding this comment

Uh oh!

nvazquez Nov 27, 2025

Choose a reason for hiding this comment

Uh oh!

Damans227 Nov 27, 2025

Choose a reason for hiding this comment

Uh oh!

nvazquez Nov 27, 2025

Choose a reason for hiding this comment

Uh oh!

nvazquez Nov 27, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants