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

feat: Database configuration integration with Spring Boot #1481

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

jmformenti
Copy link

Simplified database configuration using the new Spring Boot Docker Compose feature.

You can use MySQL or PostgreSQL by simply defining the Spring Boot profile:

./mvnw spring-boot:run -Dspring-boot.run.profiles=mysql

or

./mvnw spring-boot:run -Dspring-boot.run.profiles=postgres

@pivotal-cla
Copy link

@jmformenti Please sign the Contributor License Agreement!

Click here to manually synchronize the status of this Pull Request.

See the FAQ for frequently asked questions.

@pivotal-cla
Copy link

@jmformenti Thank you for signing the Contributor License Agreement!

Copy link
Contributor

@zyberzebra zyberzebra left a comment

Choose a reason for hiding this comment

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

You should also update the:/petclinic_db_setup_postgres.txt
and/petclinic_db_setup_mysql.txt

accordingly :)

@jmformenti
Copy link
Author

You should also update the:/petclinic_db_setup_postgres.txt and/petclinic_db_setup_mysql.txt

accordingly :)

Removed that documentation because with these changes no manual steps are needed anymore.

pom.xml Outdated
@@ -68,6 +68,10 @@
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<dependency>
Copy link
Member

Choose a reason for hiding this comment

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

I'm not super happy about having this not in test scope. The CLI examples would all work with mvn spring-boot:test-run would they not?

Copy link
Author

Choose a reason for hiding this comment

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

Good point, It doesn't work directly because of this:

[ERROR] Failed to execute goal org.springframework.boot:spring-boot-maven-plugin:3.2.1:test-run (default-cli) on project spring-petclinic: Execution default-cli of goal org.springframework.boot:spring-boot-maven-plugin:3.2.1:test-run failed: Unable to find a single main class from the following candidates [org.springframework.samples.petclinic.PostgresIntegrationTests, org.springframework.samples.petclinic.PetClinicIntegrationTests, org.springframework.samples.petclinic.MysqlTestApplication]

but I've modified the PR to keep the docker compose dependency in test scope.

@jmformenti jmformenti force-pushed the feature/database-configuration-integration-spring-boot branch from 21963ae to 5aedb47 Compare May 18, 2024 12:22
@dsyer
Copy link
Member

dsyer commented May 19, 2024

Looking at it in more detail I'm not really sure I know what the intention was here. I don't want docker-compose to be the only option to run a database, and that seems to be the main idea behind the change? Was there something else I missed?

@jmformenti jmformenti force-pushed the feature/database-configuration-integration-spring-boot branch from da50c9e to a9bcd80 Compare May 20, 2024 06:27
@jmformenti
Copy link
Author

Looking at it in more detail I'm not really sure I know what the intention was here. I don't want docker-compose to be the only option to run a database, and that seems to be the main idea behind the change? Was there something else I missed?

Yes, the idea was essentially to simplify database configuration by leveraging the integration with docker compose, but I understand your point of view.
I have modified the PR so that the integration with docker compose is optional. I hope this can be useful for those who want a quick way to start and/or integrate the application with a database.

@dsyer
Copy link
Member

dsyer commented May 20, 2024

Since we already support docker-compose for both mysql and postgres, this might end up being an empty pull request, once we whittle it down to what is actually needed. So far that looks like a few lines of documentation and some Maven profiles (but Gradle support is still missing, which we probably need if we are providing Maven examples). The details of what is in those profiles is still being debated, but I'm not convinced they are all that helpful. Maybe there is a problem with the documentation making it hard to understand the steps needed to run using docker compose? It could be that all we need is more clarity in the README?

@jmformenti
Copy link
Author

Personally I like the idea to run the application and the database with a single command:

./mvnw spring-boot:run -P<database>

with any other docker or docker compose extra command but I guess that is not in the scope of this project, so feel free to close the PR.

@dsyer
Copy link
Member

dsyer commented May 20, 2024

I usually run from the IDE, so I'm not that bothered, but if that is the objective then it seems reasonable to me. Whatever we decide to do, it shouldn't take much code, IMO. We also haven't tried to cover the Gradle users yet, so there's a bit more work to do still.

Lastly, I'm not sure if we can do exactly the same for MySQL as Postgres since one of them (currently MySQL) is being used to showcase test containers and the other is showing docker compose. I would be happy if mvn spring-boot:test-run -Pmysql worked, but used test containers.

If you're not able to complete the PR that's OK. I'll leave it open for a bit to see if anyone else feels like doing it.

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.

None yet

4 participants