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

Updated Vault docs, uplifted Vault image version #3685

Conversation

RamazanYapparov
Copy link
Contributor

  • changed code example in the docs to codeinclude
  • removed VaultClientTest class and moved its test to VaultContainerTest
  • uplifted Vault image version
  • added getVaultAddress method for usage convenience

This PR is also related to #1158 issue

- removed VaultClientTest and moved its contest to VaultContainerTest
- uplifted Vault image version
- added getVaultAddress method for usage convenience
@vcvitaly
Copy link
Contributor

I'm not a vault user but looks good at a first glance.

}

@Test
public void readFirstSecretPathOverHttpApi() throws InterruptedException {
// readWithHttpApi {
Copy link
Member

@rnorth rnorth Mar 20, 2021

Choose a reason for hiding this comment

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

This comment isn't really necessary - we could have the codeinclude tag in the docs just say: inside_block:readFirstSecretPathOverHttpApi.

This way, we avoid having the method signature public void readFirstSecretPathOverHttpApi() appear in the docs, which is a bit distracting.

}

@Test
public void readFirstSecretPathOverHttpApi() throws InterruptedException {
// readWithHttpApi {
public void readFirstSecretPathOverHttpApi() {
given().
Copy link
Member

Choose a reason for hiding this comment

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

I know the given/when/then style test was here originally, but would mind refactoring these test methods to use plain style (e.g. readFirstSecretPathOverClientLibrary)?

It feels really strange to see given/when/then appearing in the documentation:
image

Copy link
Member

@rnorth rnorth left a comment

Choose a reason for hiding this comment

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

Thanks for the contribution - a couple of minor changes but I'm grateful that you're helping to improve the docs.

@stale
Copy link

stale bot commented Jun 18, 2021

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 stale bot added the stale label Jun 18, 2021
@rnorth rnorth removed the stale label Jun 24, 2021
Copy link
Member

@eddumelendez eddumelendez left a comment

Choose a reason for hiding this comment

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

I like the docs improvements and the new getVaultAddress. @RamazanYapparov is there a chance to rebase the branch, resolve the conflicts (for example, we already use assertj) and make the changes requested?

@eddumelendez eddumelendez requested a review from a team as a code owner November 1, 2022 20:33
@eddumelendez eddumelendez added this to the next milestone Nov 7, 2022
@eddumelendez eddumelendez merged commit 6e15e09 into testcontainers:main Nov 7, 2022
@eddumelendez
Copy link
Member

@RamazanYapparov thanks for this PR! few comments were addressed but now this is merged in main branch.

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

4 participants