A modular, enterprise-grade Hotel Room Reservation System developed using Agile/Scrum methodology for Software Engineering (Team 7 / Team 203).
| Member | Role | Responsibilities |
|---|---|---|
| Coleman Smalls (ColeDakota) | Product Owner (SME) | Backlog ownership, feature definitions & acceptance criteria, domain expert. |
| John Hashim | Scrum Master | Agile ceremony facilitation, blocker removal, weekly reporting (Team Assignment 3). |
| Johnathan Youngquist | Developer 1 | Use case analysis, domain modeling, Java implementation. |
| Quoc Nguyen / Nguyen Hoai Nam (nguyenhoainam000) | Developer 2 | Use case & diagram analysis, core Java implementation, unit testing & CI/CD. |
| Jonathan Picardo | Developer 3 | Glossary, testing, Java implementation, documentation. |
Project backlog, user story tracking, and iteration progress are managed on GitHub Projects:
๐ Backlog ยท Room Reservation System for a Hotel
- โ
UC-1: View Room Availability: Real-time visibility into room vacancy and status (
AVAILABLE,BOOKED,CLEANING,OUT_OF_SERVICE). - โ UC-2: Room Selection by Size and Location: Multi-criteria room search with wildcard/blank parameter handling and availability filtering.
- โ
UC-3: Book Rooms for Guests (Create Reservation): Reserves available rooms, calculates total stay cost based on nightly rates, assigns confirmation numbers, updates room status to
BOOKED, and validates input (rejects blank guest names per Sequence Diagram Alternate Flow 5a). - โ
UC-4: Cancel Room Reservations: Cancels bookings by confirmation number, transitions reservation to
CANCELLED, releases room back toAVAILABLE, and handles Alternate Flow 4a (invalid confirmation number). - โ
UC-5: Room Preparation & Cleaning Alert (Update Room Status): Housekeeping workflow to trigger cleaning alerts on turnover, setting room to
CLEANING(making it unbookable), and restoring toAVAILABLEonce inspected and prepared. - โ UC-6: Generate Room Status Report: Consolidates hotel room inventory, calculates occupancy rates, room vacancy counts, and outputs formatted management reports.
- โ
Interactive Console Action Menu: CLI interface supporting 8 operations and automated demo sequence (
Main.java). - โ Automated Unit Testing & CI: 20 test cases covering UC-1 through UC-6, passing 100% on GitHub Actions.
The implementation strictly conforms to the UML design specifications (full_class_diagram.txt and sequence_diagram.txt):
- Enums:
- Location: POOL_SIDE, BALCONY, STANDARD
- RoomStatus: AVAILABLE, BOOKED, CLEANING, OUT_OF_SERVICE
- Domain Models:
- Hotel: Manages hotel details and room inventory (addRoom, getRoom).
- Room: Represents rooms with status, type, and location (updateStatus, isAvailable, isReadyForGuest).
- RoomType: Defines room category, bed size, and nightly rate (getNightlyRate, getBedSize).
- Guest: Encapsulates guest profile (getName, getPhone) with validation.
- Reservation: Encapsulates confirmed bookings, dates, and cost (calculateTotalCost, cancelReservation).
- Controllers & Services:
- HotelController: Orchestrates operations between UI and domain models per UML class diagram.
- HotelReservationService: Service facade providing business workflows and backwards-compatible APIs.
- Language: Java 17 LTS
- Build Tool: Apache Maven
- Testing: JUnit 5 (Jupiter) with parameterized tests & alternate flow coverage
- CI/CD: GitHub Actions (actions/checkout@v5, actions/setup-java@v5)
- Design Patterns: Controller / Service Layer, Separation of Concerns (Model - Controller - Service)
- JDK 17 or higher
- Apache Maven 3.8+ (or IntelliJ IDEA built-in Maven)
git clone https://github.com/nguyenhoainam000/hotel-room-reservation-system.git
cd hotel-room-reservation-system# Compile and run all 20 automated unit tests mvn clean test # Run interactive console application mvn compile exec:java -Dexec.mainClass="org.example.Main"
When launched, Main.java provides an interactive menu:
[1] View Available Rooms (UC-1)- Lists all rooms currently vacant and available.[2] Search Rooms by Type & Location (UC-2)- Searches with type/location criteria or blank wildcard.[3] Create Reservation (UC-3)- Books room, validates guest name, generates confirmation.[4] Cancel Reservation (UC-4)- Cancels booking and releases room inventory.[5] Trigger Cleaning Alert (UC-5)- Simulates room checkout and maintenance request.[6] Generate Room Status Report (UC-6)- Displays tabular report and occupancy statistics.[7] Run Automated Demo Sequence- Runs an automated end-to-end walkthrough of all use cases.[8] Enter Interactive CLI Loop- Prompts for continuous user commands.[0] Exit- Terminates the application.
This repository is configured with GitHub Actions Continuous Integration. Every push and pull_request to the main branch automatically triggers:
- Environment provisioning on ubuntu-latest.
- JDK 17 setup with dependency caching.
- Automated compilation and execution of unit tests via Maven Surefire.