Offer a Quarkus Dev Services compatible way to launch Kafka and PostgreSQL containers with API server #1188
Labels
component/api-server
dx
Issues related to developer experience (DX)
enhancement
New feature or request
good first issue
Good for newcomers
p3
Nice-to-have features
size/M
Medium effort
Comments
nscuro
added
enhancement
|
Hey, I will replicate the issue and take it up. Can you assign this to me? |
|
@withPrasheel Are you still planning to work on this? |
|
Hi @nscuro , I worked on the setup and understanding of the documentation. I have an exam due tomo 5pm right now, after which I will be available complete summer. So I can work on it after it. Is there a deadline you are expecting for this? |
|
Thanks for reporting back @withPrasheel! No deadline at all, just checking in to see if we need to un-assign people from issues they don't have the capacity to work on. Otherwise they'd be blocked for other contributors interested to work on them. :) Please let me know if you need help in any way! |
|
@nscuro Can you unassign this issue? It's taken too much time, and I am not able to find time. I will continue to work in my capacity, learning a few things first in case no one takes it up later. |
|
Sure, no worries! |
|
Related quarkusio/quarkus#40376 |
nscuro
added a commit
to DependencyTrack/hyades-apiserver
that referenced
this issue
Jun 14, 2024
Adds a new `dev-services` Maven profile. It is intended to be used in conjunction with the Jetty plugin. A respective IntelliJ run configuration is included. When enabled, PostgreSQL and Redpanda containers will be launched automatically, and disposed when the application stops. Dependency-Track will be auto-configured to use the containers, no manual configuration required. To avoid introducing runtime dependencies on test libraries for production builds, the logic uses reflection to interact with the `testcontainers` library. Topics required by the API server will be created automatically. Database migrations are executed as usual. The containers are not currently discoverable and re-usable by the Quarkus-based services. That capability is planned for a future iteration, see DependencyTrack/hyades#1188 With this functionality, it becomes easier to test features that do not rely on the other Hyades services (e.g. REST API related stuff), or frontend modifications. In those scenarios, using Docker Compose is no longer needed. Signed-off-by: nscuro <nscuro@protonmail.com>
1 task
nscuro
added a commit
to DependencyTrack/hyades-apiserver
that referenced
this issue
Jun 14, 2024
Adds a new `dev-services` Maven profile. It is intended to be used in conjunction with the Jetty plugin. A respective IntelliJ run configuration is included. When enabled, PostgreSQL and Redpanda containers will be launched automatically, and disposed when the application stops. Dependency-Track will be auto-configured to use the containers, no manual configuration required. To avoid introducing runtime dependencies on test libraries for production builds, the logic uses reflection to interact with the `testcontainers` library. Topics required by the API server will be created automatically. Database migrations are executed as usual. The containers are not currently discoverable and re-usable by the Quarkus-based services. That capability is planned for a future iteration, see DependencyTrack/hyades#1188 With this functionality, it becomes easier to test features that do not rely on the other Hyades services (e.g. REST API related stuff), or frontend modifications. In those scenarios, using Docker Compose is no longer needed. Signed-off-by: nscuro <nscuro@protonmail.com>
nscuro
added a commit
to DependencyTrack/hyades-apiserver
that referenced
this issue
Jun 14, 2024
Adds a new `dev-services` Maven profile. It is intended to be used in conjunction with the Jetty plugin. A respective IntelliJ run configuration is included. When enabled, PostgreSQL and Redpanda containers will be launched automatically, and disposed when the application stops. Dependency-Track will be auto-configured to use the containers, no manual configuration required. To avoid introducing runtime dependencies on test libraries for production builds, the logic uses reflection to interact with the `testcontainers` library. Topics required by the API server will be created automatically. Database migrations are executed as usual. The containers are not currently discoverable and re-usable by the Quarkus-based services. That capability is planned for a future iteration, see DependencyTrack/hyades#1188 With this functionality, it becomes easier to test features that do not rely on the other Hyades services (e.g. REST API related stuff), or frontend modifications. In those scenarios, using Docker Compose is no longer needed. Signed-off-by: nscuro <nscuro@protonmail.com>
nscuro
added a commit
to DependencyTrack/hyades-apiserver
that referenced
this issue
Jun 15, 2024
Adds a new `dev-services` Maven profile. It is intended to be used in conjunction with the Jetty plugin. A respective IntelliJ run configuration is included. When enabled, PostgreSQL and Redpanda containers will be launched automatically, and disposed when the application stops. Dependency-Track will be auto-configured to use the containers, no manual configuration required. To avoid introducing runtime dependencies on test libraries for production builds, the logic uses reflection to interact with the `testcontainers` library. Topics required by the API server will be created automatically. Database migrations are executed as usual. The containers are not currently discoverable and re-usable by the Quarkus-based services. That capability is planned for a future iteration, see DependencyTrack/hyades#1188 With this functionality, it becomes easier to test features that do not rely on the other Hyades services (e.g. REST API related stuff), or frontend modifications. In those scenarios, using Docker Compose is no longer needed. Signed-off-by: nscuro <nscuro@protonmail.com>
nscuro
added a commit
to DependencyTrack/hyades-apiserver
that referenced
this issue
Jun 15, 2024
Adds a new `dev-services` Maven profile. It is intended to be used in conjunction with the Jetty plugin. A respective IntelliJ run configuration is included. When enabled, PostgreSQL and Redpanda containers will be launched automatically, and disposed when the application stops. Dependency-Track will be auto-configured to use the containers, no manual configuration required. To avoid introducing runtime dependencies on test libraries for production builds, the logic uses reflection to interact with the `testcontainers` library. Topics required by the API server will be created automatically. Database migrations are executed as usual. The containers are not currently discoverable and re-usable by the Quarkus-based services. That capability is planned for a future iteration, see DependencyTrack/hyades#1188 With this functionality, it becomes easier to test features that do not rely on the other Hyades services (e.g. REST API related stuff), or frontend modifications. In those scenarios, using Docker Compose is no longer needed. Signed-off-by: nscuro <nscuro@protonmail.com>
nscuro
added a commit
to DependencyTrack/hyades-apiserver
that referenced
this issue
Jun 16, 2024
Adds a new `dev-services` Maven profile. It is intended to be used in conjunction with the Jetty plugin. A respective IntelliJ run configuration is included. When enabled, PostgreSQL and Redpanda containers will be launched automatically, and disposed when the application stops. Dependency-Track will be auto-configured to use the containers, no manual configuration required. To avoid introducing runtime dependencies on test libraries for production builds, the logic uses reflection to interact with the `testcontainers` library. Topics required by the API server will be created automatically. Database migrations are executed as usual. The containers are not currently discoverable and re-usable by the Quarkus-based services. That capability is planned for a future iteration, see DependencyTrack/hyades#1188 With this functionality, it becomes easier to test features that do not rely on the other Hyades services (e.g. REST API related stuff), or frontend modifications. In those scenarios, using Docker Compose is no longer needed. Signed-off-by: nscuro <nscuro@protonmail.com>
nscuro
added a commit
to DependencyTrack/hyades-apiserver
that referenced
this issue
Jun 20, 2024
Adds a new `dev-services` Maven profile. It is intended to be used in conjunction with the Jetty plugin. A respective IntelliJ run configuration is included. When enabled, PostgreSQL and Redpanda containers will be launched automatically, and disposed when the application stops. Dependency-Track will be auto-configured to use the containers, no manual configuration required. To avoid introducing runtime dependencies on test libraries for production builds, the logic uses reflection to interact with the `testcontainers` library. Topics required by the API server will be created automatically. Database migrations are executed as usual. The containers are not currently discoverable and re-usable by the Quarkus-based services. That capability is planned for a future iteration, see DependencyTrack/hyades#1188 With this functionality, it becomes easier to test features that do not rely on the other Hyades services (e.g. REST API related stuff), or frontend modifications. In those scenarios, using Docker Compose is no longer needed. Signed-off-by: nscuro <nscuro@protonmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Current Behavior
Currently, local development on the API server requires Kafka and PostgreSQL to be launched via Docker Compose.
While this works, it's a bit fiddly and not a good experience for new contributors.
Quarkus has Dev Services, which can automatically launch containers for infrastructure dependencies such as message buses and databases. Further, multiple services can discover and re-use existing containers started by another service.
The API server, being based on Alpine, does not offer a comparable capability. However, Dependency-Track v4.x already offers a dev-only feature to enable the H2 web console (DependencyTrack/dependency-track#2592), which can only be enabled through the
h2-consoleMaven profile.Proposed Behavior
Implement a new dev-only capability to automatically start Kafka and PostgreSQL containers.
Optimally, make it so that containers started by the API server can be reused by Quarkus services, and vice versa. This needs a bit of investigation as to how Quarkus performs discovery on existing containers. Based on my current understanding, container labels play a role.
Similar to the H2 console, leverage a Maven profile to ensure that production builds will not have this behavior.
Implementation notes:
ServletContextListenerso it's run on application startupweb.xmlso it executes before the database or Kafka clients are initializedChecklist
The text was updated successfully, but these errors were encountered: