How to pass "createOptions" / "configOptions" to DB2 container

[rPraml]

I'm unsure, if this is related to ebean-test-containers or ebean-test in the ebean-orm project

My Issue is, I need to pass "createOptions" to the test container.

We have ebean-test as dependency and we use

ebean.test.platform=db2
ebean.test.createOptions=USING CODESET UTF-8 TERRITORY DE COLLATE USING IDENTITY PAGESIZE 32768
ebean.test.configOptions=USING STRING_UNITS SYSTEM
...

for creating a container. The container spins up, but with wrong collation/pagesize. I debugged and I found, that only some properties are "transfered" from the properties file. These propertis are listed here:

https://github.com/ebean-orm/ebean/blob/master/ebean-test/src/main/java/io/ebean/test/config/platform/Config.java#L22

configOptions/createOptions are missing there...

I grepped, which parameters are in ebean-test-containers used and which parameters ebean-test transfers:

grep -irF "prop(properties" * -r \
  | grep -vE '"containerName"|"image"|"internalPort"|"startMode"|"shutdownMode"|"maxReadyAttempts"|"tmpfs"|"collation"|"characterSet"' \
  | grep -vE '"fastStartMode"|"inMemory"|"initSqlFile"|"seedSqlFile"|"adminUser"|"adminPassword"|"extraDb"|"extraDb.dbName"|"extraDb.username"|"extraDb.password"|"extraDb.extensions"|"extraDb.initSqlFile"|"extraDb.seedSqlFile"' \
  | grep -vE '"port"|"dbName"|"schema"|"username"|"password"|"url"|"driver"' \
  | awk -F '"' '{ print $2 }' | sort -u

And I got this list:

adminInternalPort
adminPort
adminUsername
agreeToSapLicense -> e.g this is manually set to "false" in HanaSetup.java
awsRegion
configOptions
createOptions
extensions
host
instanceNumber
mountsDirectory
passwordsUrl
services
startWeb

I have to say, I have not yet fully understood the process of how the parameters are translated between ebean-test and ebean-test-containers. I just see, that ebean.test.username is passed as db2.username to the container factory.

So if there is an other way to pass parameters, please point me to the right direction

[rPraml]

FYI: If I add createOptions/configOptions to DOCKER_TEST_PARAMS in ebean-test, I can start the DB2 container with the correct collation etc. I can use this as workaround for now...

But the whole parameter transfer process feels a bit odd. (maybe, because I did not fully get the intentions)
Why does ebean-test needs so much knowledge, which parameters exists?

• Can we delegate this to ContainerFactory? Maybe just move the constant there or add a ContainerFactory.setDockerOptionalParams(srcProps, dstProps, prefix) ?
• Can we transfer all parameters by some conventions?

[rbygrave]

But the whole parameter transfer process feels a bit odd.

This could be because of history [this project started off as "Avaje Docker Commands" - org.avaje.docker:docker-commands so not even an ebean project]. That is, ebean-test-containers started off as completely independent from ebean [and it actually still is] ... so it started off with the properties names not having ebean.test prefixes because of that origin.

At this point, that looks like a mistake / a distinction that is not longer useful. It could be that all the properties names should exactly match what ebean-test uses with the ebean.test prefix - that seems reasonable to me.

So for example

ebean.test.platform=db2
ebean.test.db2.createOptions=USING CODESET UTF-8 TERRITORY DE COLLATE USING IDENTITY PAGESIZE 32768
ebean.test.db2.configOptions=USING STRING_UNITS SYSTEM

... the above should just be the same properties keys for both ebean-test and ebean-test-containers.

The below could also work with a convention of reading the keys first with the platform included in the key like ebean.test.{platform}.{key} and then if that is undefined reading the key like ebean.test.{key}

ebean.test.platform=db2
ebean.test.createOptions=USING CODESET UTF-8 TERRITORY DE COLLATE USING IDENTITY PAGESIZE 32768
ebean.test.configOptions=USING STRING_UNITS SYSTEM

... the benefit of doing this would be that we'd entirely remove all the "properties manipulation code".