Updated dependencies and added documentation (#104)

* Updated dependencies and added documentation Co-authored-by: Sebastian Bär <[email protected]> Co-authored-by: Christoph Pirkl <[email protected]> Co-authored-by: Christoph Pirkl <[email protected]> * Fixed review findings enhanced unit tests * updated dependency documentation after adding org.junit-pioneer:junit-pioneer * fixed review findings. Co-authored-by: Sebastian Bär <[email protected]> Co-authored-by: Christoph Pirkl <[email protected]>
exasol · Sep 30, 2022 · e29b8ad · e29b8ad
1 parent 8cad97f
commit e29b8ad
Show file tree

Hide file tree

Showing 13 changed files with 232 additions and 100 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1,10 @@
+pk_generated_parent.pom                                          linguist-generated=true
+dependencies.md                                                  linguist-generated=true
+doc/changes/changelog.md                                         linguist-generated=true
+.github/workflows/broken_links_checker.yml                       linguist-generated=true
+.github/workflows/ci-build-next-java.yml			 linguist-generated=true
+.github/workflows/ci-build.yml					 linguist-generated=true
+.github/workflows/dependencies_check.yml			 linguist-generated=true
+.github/workflows/release_droid_prepare_original_checksum.yml	 linguist-generated=true
+.github/workflows/release_droid_print_quick_checksum.yml	 linguist-generated=true
+.github/workflows/release_droid_upload_github_release_assets.yml linguist-generated=true
diff --git a/.github/workflows/release_droid_upload_github_release_assets.yml b/.github/workflows/release_droid_upload_github_release_assets.yml
diff --git a/.gitignore b/.gitignore
@@ -33,4 +33,6 @@ target
 *.md.html
 .project
 .classpath
-*.flattened-pom.xml
+*.flattened-pom.xml
+/.apt_generated/
+/.apt_generated_tests/
diff --git a/.project-keeper.yml b/.project-keeper.yml
@@ -5,7 +5,7 @@ sources:
       - maven_central
       - integration_tests
 linkReplacements:
-  - LICENSE-exasol-jdbc.txt|https://www.exasol.com/support/secure/attachment/155343/EXASOL_SDK-7.0.11.tar.gz
   - https://www.mojohaus.org/flatten-maven-plugin/flatten-maven-plugin|https://www.mojohaus.org/flatten-maven-plugin
+  - https://jdbc.postgresql.org/about/license.html|https://jdbc.postgresql.org/license/
 excludes:
   - "E-PK-CORE-18: Outdated content: '.github/workflows/release_droid_release_on_maven_central.yml'"
diff --git a/dependencies.md b/dependencies.md
diff --git a/doc/changes/changelog.md b/doc/changes/changelog.md
diff --git a/doc/changes/changes_3.4.0.md b/doc/changes/changes_3.4.0.md
@@ -0,0 +1,23 @@
+# Test Database Builder for Java 3.4.0, released 2022-09-30
+
+Code name: Support system properties to set DEBUG_ADDRESS and LOG_LEVEL.
+
+## Summary
+
+This release adds support to use properties to set `DEBUG_ADDRESS` and `LOG_LEVEL` for virtual schemas, please see the [User Guide](https://github.com/exasol/test-db-builder-java/blob/main/doc/user_guide/user_guide.md#debug-output) for details.
+
+## Features
+
+* #103: Enabled to set `DEBUG_ADDRESS` and `LOG_LEVEL` based on properties.
+
+## Dependency Updates
+
+### Test Dependency Updates
+
+* Added `org.junit-pioneer:junit-pioneer:1.7.1`
+
+### Plugin Dependency Updates
+
+* Updated `com.exasol:error-code-crawler-maven-plugin:1.1.1` to `1.1.2`
+* Updated `com.exasol:project-keeper-maven-plugin:2.5.0` to `2.8.0`
+* Updated `org.apache.maven.plugins:maven-enforcer-plugin:3.0.0` to `3.1.0`
diff --git a/doc/user_guide/user_guide.md b/doc/user_guide/user_guide.md
@@ -277,7 +277,7 @@ final ExasolObjectFactory factory = new ExasolObjectFactory(connection,
         .withJvmOptions("-agentlib:jdwp=transport=dt_socket,server=n,address=<host>:<port>,suspend=y")
         .build()
 );
-``` 
+```
 
 ### Creating Virtual Schemas
 
@@ -288,11 +288,36 @@ final VirtualSchema virtualSchema=factory.createVirtualSchemaBuilder("THE_VIRTUA
         .dialectName("Exasol")
         .adapterScript(adapterScript)
         .connectionDefinition(connectionDefinition)
-        .properties(Map.of("IS_LOCAL","true"
-        "LOG_LEVEL","ALL"))
+        .properties(Map.of("IS_LOCAL", "true", "LOG_LEVEL", "ALL"))
         .build();
 ```
 
+#### Debug Output
+
+For virtual schemas Test DB Builder supports three special system properties to enable debug output to a remote machine:
+
+| System property | Sample value | Default value |
+|-----------------|--------------|---------------|
+| `com.exasol.virtualschema.debug.host` | `"192.168.1.2"` | (none) |
+| `com.exasol.virtualschema.debug.port` | `"3000"` | (none) |
+| `com.exasol.virtualschema.debug.level` | `"WARN"` | `"ALL"`, see explanation below |
+
+You can set some or all of these properties, see topics [Logging](https://docs.exasol.com/db/latest/database_concepts/virtual_schema/logging.htm) and [Debug UDF Script Output](https://docs.exasol.com/db/latest/database_concepts/udf_scripts/debug_udf_script_output.htm?Highlight=script_output) in the Exasol documentation. If `com.exasol.virtualschema.debug.level` is not specified and either `-Dcom.exasol.virtualschema.debug.host` or `-Dcom.exasol.virtualschema.debug.port` is specified then Test DB Builder Java sets `com.exasol.virtualschema.debug.level` to `ALL`.
+
+When running tests you can for example pass the following additional VM-arguments:
+```
+-Dcom.exasol.virtualschema.debug.host="127.0.0.1"
+-Dcom.exasol.virtualschema.debug.port="3000"
+-Dcom.exasol.virtualschema.debug.level="INFO"
+```
+
+This activates debug output in your local development environment without modifying any code and thereby preventing to commit debug settings by accident to your source code repository.
+
+You can use the following shell command to display the debug log, see  [Logging](https://docs.exasol.com/db/latest/database_concepts/virtual_schema/logging.htm):
+```shell
+nc -lkp 3000
+```
+
 ## Running Executable Database Content
 
 ### Executing Exasol Scripts