Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: separate boot and connector modules and normalize module and package structure #4065

Merged
merged 14 commits into from
Mar 30, 2024

Conversation

jimmarino
Copy link
Contributor

@jimmarino jimmarino commented Mar 29, 2024

What this PR changes/adds

This PR separates the boot runtime modules from connector modules. It also normalizes the module and package naming scheme to make it consistent across the codebase. The following rules are applied:

Naming Conventions

Modules names adopt the following conventions:

  • SPI modules must have an -spi suffix
  • Library modules must have a -lib suffix
  • Control plane modules MAY have a control-plane- prefix (decided on a case-by-case basis)
  • Data plane modules MAY have a data-pane- prefix (decided on a case-by-case basis)

All package names begin with org.eclipse.edc and follow the module name:

  • Common modules append the module name to the package: auth-basic becomes org.eclipse.edc.auth.basic
  • Control plane modules append connector.controlplane to the package: control-plane-catalog becomes org.eclipse.edc.connector.controlplane.catalog
  • Data plane modules append connector.dataplane to the package: data-plane-http becomes org.eclipse.edc.connector.dataplane.http
  • Core modules may choose to include core in the package name or not
  • boot-spi does not include boot in the package name (this is for historical reasons)

Layout Conventions

/spi

Extension points and shared interfaces

/spi/common

Extension points used by various runtimes.

/core

Required extensions and libraries for various runtimes. These extensions implement basic functionality and are not designed to be substituted.

  • Core modules may opt to include core in package name

/core/common

Required extensions and libraries used across multiple runtimes. All common modules begin with org.edc.

/core/control-plane

Required extensions and libraries for control plane runtimes.
org.edc.connector.controlplane

/core/data-plane

Required extensions and libraries for data plane runtimes.
org.edc.connector.dataplane

/extensions

Optional extensions and libraries for various runtimes

/common/extensions

Optional extensions and libraries used across multiple runtimes

/extensions/control-plane

Optional extensions and libraries used in control plane runtime

/extensions/data-plane/

Optional extensions and libraries used in data plane runtimes

Linked Issue(s)

Relates to #4028

@jimmarino jimmarino added the refactoring Cleaning up code and dependencies label Mar 29, 2024
@codecov-commenter
Copy link

codecov-commenter commented Mar 30, 2024

Codecov Report

Attention: Patch coverage is 45.71429% with 19 lines in your changes are missing coverage. Please review.

Project coverage is 74.54%. Comparing base (7f20ba5) to head (e1abe7a).
Report is 181 commits behind head on main.

Files Patch % Lines
...va/org/eclipse/edc/boot/BootServicesExtension.java 0.00% 19 Missing ⚠️

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4065      +/-   ##
==========================================
+ Coverage   71.74%   74.54%   +2.80%     
==========================================
  Files         919      976      +57     
  Lines       18457    19988    +1531     
  Branches     1037     1122      +85     
==========================================
+ Hits        13242    14901    +1659     
+ Misses       4756     4602     -154     
- Partials      459      485      +26     

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

Copy link
Member

@paullatzelsperger paullatzelsperger left a comment

Choose a reason for hiding this comment

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

I went through it line-by-line, and all seems good.

@jimmarino jimmarino merged commit c0e67c6 into eclipse-edc:main Mar 30, 2024
18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
refactoring Cleaning up code and dependencies
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants