Skip to content

Add the implementation of Onion-Architecture#3532

Open
HattoriHenzo wants to merge 2 commits into
iluwatar:masterfrom
HattoriHenzo:onion-architecture-impl
Open

Add the implementation of Onion-Architecture#3532
HattoriHenzo wants to merge 2 commits into
iluwatar:masterfrom
HattoriHenzo:onion-architecture-impl

Conversation

@HattoriHenzo

@HattoriHenzo HattoriHenzo commented Jun 29, 2026

Copy link
Copy Markdown
Contributor

issue: #3231

What does this PR do?

This PR is the implementation of the Onion Architecture architectural pattern.

The project contains 3 modules:

  • Domain Layer: Contains the model and the logic
  • Application Layer: Contains the use case of the application. Is implemented through interfaces
  • Infrastructure Layer: Implements external concerns (e.g., database access, messaging, user interfaces).

This os the first Pr and there is no fix for the moment

@github-actions

github-actions Bot commented Jun 29, 2026

Copy link
Copy Markdown

PR Summary

Implemented Onion Architecture with domain, application, and infrastructure layers, including domain models, use cases, repository abstractions, adapters, REST API, tests, and documentation. The solution enforces dependency direction: domain stays core, while application orchestrates use cases and infrastructure handles HTTP/JPA concerns. See issue 3231 for context. Key components include Person, Category, PersonRepository, GetPersonUseCase, SavePersonUseCase, DTOs, and a Spring Boot REST API.

Changes

File Summary
onion-architecture/README.md Introduces the Onion Architecture description, module roles (Domain, Application, Infrastructure), and how to build and run the multi-module project. Includes diagram references and API usage guidance.
onion-architecture/application/pom.xml Adds the application-layer POM, declaring dependency on domain, and test-scoped testing libraries (JUnit 5, Mockito).
onion-architecture/application/src/main/java/com/iluwatar/onion/application/dto/PersonResponse.java Adds PersonResponse DTO to convey domain data to the outer layers; fields include id, name, age, contact, and category info.
onion-architecture/application/src/main/java/com/iluwatar/onion/application/dto/SavePersonCommand.java Adds SavePersonCommand DTO carrying data required to create a person, including category details and address.
onion-architecture/application/src/main/java/com/iluwatar/onion/application/usecase/GetPersonUseCase.java Implements GetPersonUseCase with methods execute(Long id) and executeAll() to fetch and map domain Person to PersonResponse via PersonRepository.
onion-architecture/application/src/main/java/com/iluwatar/onion/application/usecase/SavePersonUseCase.java Implements SavePersonUseCase to create a domain Person from SavePersonCommand, persist via PersonRepository, and return a PersonResponse.
onion-architecture/application/src/test/java/com/iluwatar/onion/application/usecase/GetPersonUseCaseTest.java Unit tests for GetPersonUseCase: happy path, not-found error, and repository failure; using Mockito to mock PersonRepository.
onion-architecture/application/src/test/java/com/iluwatar/onion/application/usecase/SavePersonUseCaseTest.java Unit tests for SavePersonUseCase: happy path, validation failures (DomainException), repository exceptions and argument capture.
onion-architecture/domain/pom.xml Domain module POM with JUnit test dependency.
onion-architecture/domain/src/main/java/com/iluwatar/onion/domain/exception/DomainException.java Defines DomainException used for domain invariants violation.
onion-architecture/domain/src/main/java/com/iluwatar/onion/domain/model/Category.java Domain model Category with id and type; validates non-null/empty type; getters.
onion-architecture/domain/src/main/java/com/iluwatar/onion/domain/model/Person.java Domain model Person with validation for name, age (>=18), phone, email, and category; getters.
onion-architecture/domain/src/main/java/com/iluwatar/onion/domain/repository/PersonRepository.java Domain repository interface for Person with find/save/delete operations.
onion-architecture/domain/src/test/java/com/iluwatar/onion/domain/model/CategoryTest.java Tests for Category domain model including valid and invalid type scenarios.
onion-architecture/domain/src/test/java/com/iluwatar/onion/domain/model/PersonTest.java Tests for Person domain model, covering valid and invalid instantiations and invariants.
onion-architecture/etc/onion-architecture.png Architecture diagram image file (PNG).
onion-architecture/etc/onion-architecture.puml PlantUML diagram for Onion Architecture with layers and mappings.
onion-architecture/etc/postman/onion-architecture.postman_collection.json Postman collection scaffolding for API endpoints (/api/persons, /api/persons/{id}).
onion-architecture/infrastructure/pom.xml Infrastructure module POM with dependencies on domain, application, Spring Web, JPA, H2, and test support.
onion-architecture/infrastructure/src/main/java/com/iluwatar/onion/infrastructure/Application.java Spring Boot application entry point for infrastructure module.
onion-architecture/infrastructure/src/main/java/com/iluwatar/onion/infrastructure/config/ApplicationConfig.java Bean configuration wiring SavePersonUseCase and GetPersonUseCase with PersonRepository.
onion-architecture/infrastructure/src/main/java/com/iluwatar/onion/infrastructure/persistence/JpaCategoryEntity.java JPA entity JpaCategoryEntity for persistence.
onion-architecture/infrastructure/src/main/java/com/iluwatar/onion/infrastructure/persistence/JpaPersonEntity.java JPA entity JpaPersonEntity for persistence and mapping to Category.
onion-architecture/infrastructure/src/main/java/com/iluwatar/onion/infrastructure/persistence/PersonRepositoryAdapter.java Repository adapter implementing PersonRepository and mapping between domain and JPA; includes mapToEntity/mapToDomain.
onion-architecture/infrastructure/src/main/java/com/iluwatar/onion/infrastructure/persistence/SpringDataPersonRepository.java Spring Data repository interface for JpaPersonEntity with finders by name.
onion-architecture/infrastructure/src/main/java/com/iluwatar/onion/infrastructure/web/PersonController.java REST controller exposing /api/persons endpoints and delegating to use cases.
onion-architecture/infrastructure/src/main/resources/application.properties Configuration for H2 database, JPA, and SQL initialization.
onion-architecture/infrastructure/src/main/resources/data.sql Initial seed data for category table.
onion-architecture/infrastructure/src/test/java/com/iluwatar/onion/infrastructure/persistence/PersonRepositoryAdapterTest.java Tests for PersonRepositoryAdapter covering mapping and repository integration.
onion-architecture/infrastructure/src/test/java/com/iluwatar/onion/infrastructure/web/PersonControllerTest.java Web-layer tests for PersonController validating endpoints and error handling.

autogenerated by presubmit.ai

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

Review Summary

Commits Considered (1)
  • 1086832: Add the implementation of Onion-Architecture
Files Processed (30)
  • onion-architecture/README.md (1 hunk)
  • onion-architecture/application/pom.xml (1 hunk)
  • onion-architecture/application/src/main/java/com/iluwatar/onion/application/dto/PersonResponse.java (1 hunk)
  • onion-architecture/application/src/main/java/com/iluwatar/onion/application/dto/SavePersonCommand.java (1 hunk)
  • onion-architecture/application/src/main/java/com/iluwatar/onion/application/usecase/GetPersonUseCase.java (1 hunk)
  • onion-architecture/application/src/main/java/com/iluwatar/onion/application/usecase/SavePersonUseCase.java (1 hunk)
  • onion-architecture/application/src/test/java/com/iluwatar/onion/application/usecase/GetPersonUseCaseTest.java (1 hunk)
  • onion-architecture/application/src/test/java/com/iluwatar/onion/application/usecase/SavePersonUseCaseTest.java (1 hunk)
  • onion-architecture/domain/pom.xml (1 hunk)
  • onion-architecture/domain/src/main/java/com/iluwatar/onion/domain/exception/DomainException.java (1 hunk)
  • onion-architecture/domain/src/main/java/com/iluwatar/onion/domain/model/Category.java (1 hunk)
  • onion-architecture/domain/src/main/java/com/iluwatar/onion/domain/model/Person.java (1 hunk)
  • onion-architecture/domain/src/main/java/com/iluwatar/onion/domain/repository/PersonRepository.java (1 hunk)
  • onion-architecture/domain/src/test/java/com/iluwatar/onion/domain/model/CategoryTest.java (1 hunk)
  • onion-architecture/domain/src/test/java/com/iluwatar/onion/domain/model/PersonTest.java (1 hunk)
  • onion-architecture/etc/onion-architecture.png (0 hunks)
  • onion-architecture/etc/onion-architecture.puml (1 hunk)
  • onion-architecture/etc/postman/onion-architecture.postman_collection.json (1 hunk)
  • onion-architecture/infrastructure/pom.xml (1 hunk)
  • onion-architecture/infrastructure/src/main/java/com/iluwatar/onion/infrastructure/Application.java (1 hunk)
  • onion-architecture/infrastructure/src/main/java/com/iluwatar/onion/infrastructure/config/ApplicationConfig.java (1 hunk)
  • onion-architecture/infrastructure/src/main/java/com/iluwatar/onion/infrastructure/persistence/JpaCategoryEntity.java (1 hunk)
  • onion-architecture/infrastructure/src/main/java/com/iluwatar/onion/infrastructure/persistence/JpaPersonEntity.java (1 hunk)
  • onion-architecture/infrastructure/src/main/java/com/iluwatar/onion/infrastructure/persistence/PersonRepositoryAdapter.java (1 hunk)
  • onion-architecture/infrastructure/src/main/java/com/iluwatar/onion/infrastructure/persistence/SpringDataPersonRepository.java (1 hunk)
  • onion-architecture/infrastructure/src/main/java/com/iluwatar/onion/infrastructure/web/PersonController.java (1 hunk)
  • onion-architecture/infrastructure/src/main/resources/application.properties (1 hunk)
  • onion-architecture/infrastructure/src/main/resources/data.sql (1 hunk)
  • onion-architecture/infrastructure/src/test/java/com/iluwatar/onion/infrastructure/persistence/PersonRepositoryAdapterTest.java (1 hunk)
  • onion-architecture/infrastructure/src/test/java/com/iluwatar/onion/infrastructure/web/PersonControllerTest.java (1 hunk)
Actionable Comments (0)
Skipped Comments (2)
  • onion-architecture/domain/src/main/java/com/iluwatar/onion/domain/model/Person.java [57-61]

    best_practice: "Validate non-empty names in domain model"

  • onion-architecture/domain/src/main/java/com/iluwatar/onion/domain/repository/PersonRepository.java [31-40]

    maintainability: "Repository findAll return type design"

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

Review Summary

Commits Considered (1)
  • 49fa99d: Execute maven command: mvn spotless:apply
Files Processed (21)
  • onion-architecture/application/src/main/java/com/iluwatar/onion/application/dto/PersonResponse.java (1 hunk)
  • onion-architecture/application/src/main/java/com/iluwatar/onion/application/dto/SavePersonCommand.java (1 hunk)
  • onion-architecture/application/src/main/java/com/iluwatar/onion/application/usecase/GetPersonUseCase.java (1 hunk)
  • onion-architecture/application/src/main/java/com/iluwatar/onion/application/usecase/SavePersonUseCase.java (1 hunk)
  • onion-architecture/application/src/test/java/com/iluwatar/onion/application/usecase/GetPersonUseCaseTest.java (1 hunk)
  • onion-architecture/application/src/test/java/com/iluwatar/onion/application/usecase/SavePersonUseCaseTest.java (1 hunk)
  • onion-architecture/domain/src/main/java/com/iluwatar/onion/domain/exception/DomainException.java (1 hunk)
  • onion-architecture/domain/src/main/java/com/iluwatar/onion/domain/model/Category.java (1 hunk)
  • onion-architecture/domain/src/main/java/com/iluwatar/onion/domain/model/Person.java (1 hunk)
  • onion-architecture/domain/src/main/java/com/iluwatar/onion/domain/repository/PersonRepository.java (1 hunk)
  • onion-architecture/domain/src/test/java/com/iluwatar/onion/domain/model/CategoryTest.java (1 hunk)
  • onion-architecture/domain/src/test/java/com/iluwatar/onion/domain/model/PersonTest.java (1 hunk)
  • onion-architecture/infrastructure/src/main/java/com/iluwatar/onion/infrastructure/Application.java (1 hunk)
  • onion-architecture/infrastructure/src/main/java/com/iluwatar/onion/infrastructure/config/ApplicationConfig.java (1 hunk)
  • onion-architecture/infrastructure/src/main/java/com/iluwatar/onion/infrastructure/persistence/JpaCategoryEntity.java (1 hunk)
  • onion-architecture/infrastructure/src/main/java/com/iluwatar/onion/infrastructure/persistence/JpaPersonEntity.java (1 hunk)
  • onion-architecture/infrastructure/src/main/java/com/iluwatar/onion/infrastructure/persistence/PersonRepositoryAdapter.java (1 hunk)
  • onion-architecture/infrastructure/src/main/java/com/iluwatar/onion/infrastructure/persistence/SpringDataPersonRepository.java (1 hunk)
  • onion-architecture/infrastructure/src/main/java/com/iluwatar/onion/infrastructure/web/PersonController.java (1 hunk)
  • onion-architecture/infrastructure/src/test/java/com/iluwatar/onion/infrastructure/persistence/PersonRepositoryAdapterTest.java (1 hunk)
  • onion-architecture/infrastructure/src/test/java/com/iluwatar/onion/infrastructure/web/PersonControllerTest.java (1 hunk)
Actionable Comments (0)
Skipped Comments (4)
  • onion-architecture/application/src/main/java/com/iluwatar/onion/application/usecase/GetPersonUseCase.java [60-75]

    best_practice: "Potential Java version compatibility issue in executeAll"

  • onion-architecture/application/src/main/java/com/iluwatar/onion/application/dto/SavePersonCommand.java [29-37]

    maintainability: "DTO includes unused address field"

  • onion-architecture/infrastructure/src/main/java/com/iluwatar/onion/infrastructure/web/PersonController.java [63-70]

    maintainability: "Improve error response on validation failure"

  • onion-architecture/domain/src/main/java/com/iluwatar/onion/domain/model/Person.java [64-68]

    maintainability: "Validate names should also check for blank values"

@codecov

codecov Bot commented Jun 29, 2026

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 95.23810% with 8 lines in your changes missing coverage. Please review.
✅ Project coverage is 83.39%. Comparing base (fcdf639) to head (49fa99d).

Files with missing lines Patch % Lines
...onion/infrastructure/config/ApplicationConfig.java 0.00% 3 Missing ⚠️
...com/iluwatar/onion/infrastructure/Application.java 33.33% 2 Missing ⚠️
...n/java/com/iluwatar/onion/domain/model/Person.java 97.22% 0 Missing and 1 partial ⚠️
.../infrastructure/persistence/JpaCategoryEntity.java 85.71% 1 Missing ⚠️
...on/infrastructure/persistence/JpaPersonEntity.java 94.11% 1 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff              @@
##             master    #3532      +/-   ##
============================================
+ Coverage     83.28%   83.39%   +0.11%     
- Complexity     4023     4089      +66     
============================================
  Files          1060     1073      +13     
  Lines         14246    14414     +168     
  Branches        686      687       +1     
============================================
+ Hits          11865    12021     +156     
- Misses         2094     2107      +13     
+ Partials        287      286       -1     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant