Supply jdbc string through an env variable #7660
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mziolekda
requested review from
dasormeter,
fabiotudone-da,
gerolf-da,
miklos-da and
rautenrieth-da
as code owners
gerolf-da
approved these changes
Oct 13, 2020
...te/kvutils/app/src/test/scala/com/daml/ledger/participant/state/kvutils/app/ConfigSpec.scala
Outdated
Show resolved
Hide resolved
...te/kvutils/app/src/test/scala/com/daml/ledger/participant/state/kvutils/app/ConfigSpec.scala
Outdated
Show resolved
Hide resolved
...te/kvutils/app/src/test/scala/com/daml/ledger/participant/state/kvutils/app/ConfigSpec.scala
Outdated
Show resolved
Hide resolved
miklos-da
reviewed
Oct 14, 2020
| private val participantOption = "--participant" | ||
| private val participantId: ParticipantId = ParticipantId.assertFromString("dummy-participant") | ||
| private val fixedParticipantSubOptions = s"participant-id=$participantId,port=123" | ||
| private val jdbcUrlSubOption = "server-jdbc-url" |
There was a problem hiding this comment.
These magic strings must be referenced from Config.
| private val dumpIndexMetadataCommand = "dump-index-metadata" | ||
| private val participantOption = "--participant" | ||
| private val participantId: ParticipantId = ParticipantId.assertFromString("dummy-participant") | ||
| private val fixedParticipantSubOptions = s"participant-id=$participantId,port=123" |
There was a problem hiding this comment.
I'd suggest naming this as mandatoryParticipantOptions or mandatoryParticipantConfig or similar to hint that these must be provided.
| private val DumpIndexMetadataCommand = "dump-index-metadata" | ||
| private val ConfigParser: Seq[String] => Option[Config[Unit]] = | ||
| Config.parse("Test", (_: OptionParser[Config[Unit]]) => (), (), _) | ||
| private val dumpIndexMetadataCommand = "dump-index-metadata" |
There was a problem hiding this comment.
Constants should be UpperCamelCased -- please don't change this.
| @@ -75,8 +75,9 @@ object Config { | |||
| extraOptions: OptionParser[Config[Extra]] => Unit, | |||
| defaultExtra: Extra, | |||
| args: Seq[String], | |||
| getEnvVar: String => Option[String] = sys.env.get(_), | |||
| it should "get the jdbc string from the command line argument when provided" in { | ||
| val jdbcFromCli = "command-line-jdbc" | ||
| val config = configParser( | ||
| Seq(participantOption, s"$fixedParticipantSubOptions,$jdbcUrlSubOption=$jdbcFromCli")) |
There was a problem hiding this comment.
To improve test readability, I'd suggest putting the relevant config key first (i.e., from this test case's perspective).
cocreature
added a commit
that referenced
this pull request
Oct 14, 2020
This PR shuffles things around a bit to make it easier to test and adds `--query-store-jdbc-config-env` which specifies the name of an environment variable containing the jdbc URL. The UX for this is modeled after #7660. Added a test for the different formats. fixes #7667 changelog_begin - [JSON API] The JDBC url can now also be specified via `--query-store-jdbc-config-env` which reads it from the given environment variable. changelog_end
6 tasks
cocreature
added a commit
that referenced
this pull request
Oct 14, 2020
This PR shuffles things around a bit to make it easier to test and adds `--query-store-jdbc-config-env` which specifies the name of an environment variable containing the jdbc URL. The UX for this is modeled after #7660. Added a test for the different formats. fixes #7667 changelog_begin - [JSON API] The JDBC url can now also be specified via `--query-store-jdbc-config-env` which reads it from the given environment variable. changelog_end
cocreature
added a commit
that referenced
this pull request
Oct 14, 2020
This PR shuffles things around a bit to make it easier to test and adds `--query-store-jdbc-config-env` which specifies the name of an environment variable containing the jdbc URL. The UX for this is modeled after #7660. Added a test for the different formats. fixes #7667 changelog_begin - [JSON API] The JDBC url can now also be specified via `--query-store-jdbc-config-env` which reads it from the given environment variable. changelog_end
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
CHANGELOG_BEGIN
The
--participantcommand-line configuration syntax has been extended. It is now possible to use aserver-jdbc-url-envsub-option to specify the name of an environment variable that holds the JDBC string that should be used for connecting to the index database. This approach allows avoiding passing sensitive information in the command line launching the participant process.CHANGELOG_END