search

testcontainers / testcontainers-java

Testcontainers is a Java library that supports JUnit tests, providing lightweight, throwaway instances of common databases, Selenium web browsers, or anything else that can run in a Docker container.
https://testcontainers.org
MIT License
7.97k stars 1.64k forks source link

Testcontainers MockServer module incomplete documentation #2710

Closed javiertoja closed 3 years ago

javiertoja commented 4 years ago

Hi,

Inside the official documentation of the mock server module appears the use of a class not bundled within the module (MockServerClient), the nexus artifact do not contain this class and after looking on the examples on this repository i found that it is imported from 

<dependency>
    <groupId>org.mock-server</groupId>
    <artifactId>mockserver-client-java</artifactId>
</dependency>

Please, could you consider to update the documentation to reflect that the client is not bundled with the server. Or include the client also inside the testcontainers mock server artifact.

bsideup commented 4 years ago

Testcontainers' MockServer module is just a helper to start the container with MockServer. It does not implement the mocking itself (nor the server), and it is expected that the user will bring the client (as with any other module).

Since these expectations are common for a Java library, I don't think mentioning this in the docs is a good idea.

@rnorth WDYT?

jordigarcl commented 4 years ago

I actually believed this too. I don't think mentioning would make any harm. What about just putting an hyperlink to maven on the MockServerClient word?

stale[bot] commented 3 years ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. If you believe this is a mistake, please reply to this comment to keep it open. If there isn't one already, a PR to fix or at least reproduce the problem in a test case will always help us get back on track to tackle this.

stale[bot] commented 3 years ago

This issue has been automatically closed due to inactivity. We apologise if this is still an active problem for you, and would ask you to re-open the issue if this is the case.