Skip to content

Latest commit

 

History

History
109 lines (69 loc) · 6.22 KB

README.md

File metadata and controls

109 lines (69 loc) · 6.22 KB
Raw

UDF Debugging Tools for Java

Build Status Maven Central – udf-debugging-java

Quality Gate Status

Security Rating Reliability Rating Maintainability Rating Technical Debt

Code Smells Coverage Duplicated Lines (%) Lines of Code

This repository contains tools for debugging UDFs.

Installation

Install as maven dependency. You can get the dependency declaration by clicking the maven badge above.

Typical Usage

Typically, you use this package together with test-db-builder-java and exasol-testcontainers as follows:

private static final ExasolContainer<?extends ExasolContainer<?>> EXASOL=new ExasolContainer<>();
final UdfTestSetup udfTestSetup=new UdfTestSetup(getTestHostIp(),EXASOL.getDefaultBucket());
final ExasolObjectFactory testDbBuilder=new ExasolObjectFactory(EXASOL.createConnection(),
        ExasolObjectConfiguration.builder().withJvmOptions(udfTestSetup.getJvmOptions()).build());

Modules

This package contains multiple modules that you can enable on runtime by setting the corresponding system property to true. Typically, you do so by appending -D<PROPERTY_NAME>="true" to your JVM call.

Debugging

System property: test.debug

This module instructs the UDF JVMs to connect to a Java debugger listening on the default port 8000 on you machine, running the tests.

Code Coverage

System property: test.coverage

This module installs a jacoco agent to the UDF JVM and receives the execution data using a TCP socket.

This module requires additional maven configuration. Use project-keeper module udf_coverage to verify it.

Please note that using a JaCoCo agent fails when running on Windows using a Docker image in a Linux virtual machine, see known issue Failing Integration Tests on Windows.

JProfiler

System property: test.jprofiler

This module allows you to profile UDF runs using JProfiler. For that it uploads the JProfiler archive to BucketFs and adds the agent to the UDF command.

Since JProfiler uses a forward TCP connection you can only profile one UDF instance at once. Make sure that you don't start multiple parallel instances.

Usage

  • Install JProfiler on your system
  • Download JProfiler for Linux without JRE as .tar.gz (Also choose the Linux version if you're on a different operating system!)
  • Now you've two options:
    • Store it as jprofiler.tar.gz in your home directory
    • Store it somewhere and pass -DjProfilerAgent=<path to the archive.tar.gz> to each test run
  • Run your tests with -Dtest.jprofiler=true
  • Find out the IPv4 address of your Exasol DB (for docker use docker inspect)
  • Start JProfiler GUI
  • Connect to <EXASOL_IP>:11002
    • The UDF execution will wait until you connect the profiler
    • Ensure that the port is reachable from your system (for AWS instances you can use an SSH tunnel from inside JProfiler)

UDF Logs

System property: test.udf-logs

This module redirects the STDOUT from UDFs to files on the test host.

You can find the logs in target/udf-logs/. For each incoming stream (UDF instance) this module creates one file and logs its name:

Created log file for UDF output: target/udf-logs/udf-log-2023-07-05T10:49:09.316547Z-576983159368731727.log

Known Issue: Failing Integration Tests on Windows

Please note that integration tests fail when running on Windows using a Docker image in a Linux virtual machine due to JaCoCo agent obtaining the Code Coverage in the UDF.

Steps to reproduce

Known workarounds

  • Either run integration tests from the Eclipse IDE
  • or remove .withJvmOptions(udfTestSetup.getJvmOptions()) from ExasolObjectConfiguration.builder()
  • or run tests with JVM option -Dtest.coverage="false"
  • or run integration tests inside the VM.

Additional Information