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

Document how to run integration tests locally #6355

Merged
merged 2 commits into from Apr 11, 2024

Conversation

greg0ire
Copy link
Member

@greg0ire greg0ire commented Apr 10, 2024

I am also replacing the commented out connection parameters in
phpunit.xml.dist with a link to this paragraph because they have
diverged from the one we use in the CI since #4067.

I forgot to remove it in e7aef4e.
<var name="tmpdb_port" value="3306"/>
<var name="tmpdb_user" value="root" />
<var name="tmpdb_password" value="" />
<var name="tmpdb_dbname" value="doctrine_tests_tmp" />
Copy link
Member Author

Choose a reason for hiding this comment

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

Another reason for this removal is a discussion with @alli83 about how to run the test suite, where I recommended either using a CI file or these instructions. She reported that the latter did not work (and the former works 🙂 ).

derrabus
derrabus previously approved these changes Apr 10, 2024
Copy link
Member

@derrabus derrabus left a comment

Choose a reason for hiding this comment

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

We do not currently have a recommendation on how to spin up a database
server.

We could recommend Docker though.

@greg0ire
Copy link
Member Author

@derrabus if I'm honest, using Docker is exactly how I would do it, so I think it's fair to recommend it indeed. I also removed a previous sentence that felt out of place and replaced it with another one about versions.

SenseException
SenseException previously approved these changes Apr 10, 2024
@greg0ire greg0ire requested a review from derrabus April 11, 2024 07:00
server, but we do recommend Docker as a convenient way to do so.
We do not recommend running against a particular version of the chosen
RDBMS either, as long as you pick one of the `officially supported versions
<https://www.doctrine-project.org/projects/doctrine-dbal/en/4.0/reference/platforms.html>`_.
Copy link
Member

Choose a reason for hiding this comment

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

Shouldn't this be an internal link that should be resolved during rendering?

Copy link
Member Author

Choose a reason for hiding this comment

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

Oh right, definitely!

I am also replacing the commented out connection parameters in
phpunit.xml.dist with a link to this paragraph because they have
diverged from the one we use in the CI since f88dc28.
@greg0ire greg0ire merged commit 16cfdc8 into doctrine:3.8.x Apr 11, 2024
86 checks passed
@greg0ire greg0ire deleted the doc-local-tests branch April 11, 2024 14:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants