Skip to content

Commit 0827ed9

Browse files
jakobbraunjakobbraun
authored
feature/26: Added support for exasol-test-setup-abstraction (#27)
* feature/26: Added support for exasol-test-setup-abstraction
1 parent 142db97 commit 0827ed9

20 files changed

+224
-167
lines changed

‎.github/workflows/ci-build.yml

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: CI Build
2+
3+
on:
4+
- push
5+
6+
jobs:
7+
build:
8+
runs-on: ubuntu-latest
9+
steps:
10+
- name: Checkout the repository
11+
uses: actions/checkout@v2
12+
with:
13+
fetch-depth: 0
14+
- name: Set up JDK 11
15+
uses: actions/setup-java@v1
16+
with:
17+
java-version: 11
18+
- name: Cache local Maven repository
19+
uses: actions/cache@v2
20+
with:
21+
path: ~/.m2/repository
22+
key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
23+
restore-keys: |
24+
${{ runner.os }}-maven-
25+
- name: Run tests and build with Maven
26+
run: mvn -B clean verify sonar:sonar --file pom.xml -Dsonar.organization=exasol -Dsonar.host.url=https://sonarcloud.io -Dsonar.login=$SONAR_TOKEN
27+
env:
28+
GITHUB_OAUTH: ${{ secrets.GITHUB_TOKEN }}
29+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
30+
SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

‎.github/workflows/release_droid_prepare_original_checksum.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ jobs:
99
steps:
1010
- name: Checkout the repository
1111
uses: actions/checkout@v2
12+
with:
13+
fetch-depth: 0
1214
- name: Set up JDK 11
1315
uses: actions/setup-java@v1
1416
with:

‎.github/workflows/release_droid_print_quick_checksum.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ jobs:
99
steps:
1010
- name: Checkout the repository
1111
uses: actions/checkout@v2
12+
with:
13+
fetch-depth: 0
1214
- name: Set up JDK 11
1315
uses: actions/setup-java@v1
1416
with:

‎.github/workflows/release_droid_release_on_maven_central.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ jobs:
99
steps:
1010
- name: Checkout the repository
1111
uses: actions/checkout@v2
12+
with:
13+
fetch-depth: 0
1214
- name: Set up Maven Central Repository
1315
uses: actions/setup-java@v1
1416
with:

‎.github/workflows/release_droid_upload_github_release_assets.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ jobs:
1313
steps:
1414
- name: Checkout the repository
1515
uses: actions/checkout@v2
16+
with:
17+
fetch-depth: 0
1618
- name: Set up JDK 11
1719
uses: actions/setup-java@v1
1820
with:

‎.travis.yml

Lines changed: 0 additions & 16 deletions
This file was deleted.

‎NOTICE

Lines changed: 0 additions & 47 deletions
This file was deleted.

‎NOTICE.template

Lines changed: 0 additions & 2 deletions
This file was deleted.

‎README.md

Lines changed: 23 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,41 @@
11
# UDF Debugging Tools for Java
22

3-
[![Build Status](https://travis-ci.com/exasol/udf-debugging-java.svg?branch=main)](https://travis-ci.com/exasol/udf-debugging-java)
4-
[![Maven Central](https://img.shields.io/maven-central/v/com.exasol/udf-debugging-java)](https://search.maven.org/artifact/com.exasol/udf-debugging-java)
3+
[![Build Status](https://github.com/exasol/udf-debugging-java/actions/workflows/ci-build.yml/badge.svg)](https://github.com/exasol/udf-debugging-java/actions/workflows/ci-build.yml)
4+
[![Maven Central](https://img.shields.io/maven-central/v/com.exasol/udf-debugging-java)](https://search.maven.org/artifact/com.exasol/udf-debugging-java)
5+
6+
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=com.exasol%3Audf-debugging-java&metric=alert_status)](https://sonarcloud.io/dashboard?id=com.exasol%3Audf-debugging-java)
7+
8+
[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=com.exasol%3Audf-debugging-java&metric=security_rating)](https://sonarcloud.io/dashboard?id=com.exasol%3Audf-debugging-java)
9+
[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=com.exasol%3Audf-debugging-java&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=com.exasol%3Audf-debugging-java)
10+
[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=com.exasol%3Audf-debugging-java&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=com.exasol%3Audf-debugging-java)
11+
[![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=com.exasol%3Audf-debugging-java&metric=sqale_index)](https://sonarcloud.io/dashboard?id=com.exasol%3Audf-debugging-java)
12+
13+
[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=com.exasol%3Audf-debugging-java&metric=code_smells)](https://sonarcloud.io/dashboard?id=com.exasol%3Audf-debugging-java)
14+
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=com.exasol%3Audf-debugging-java&metric=coverage)](https://sonarcloud.io/dashboard?id=com.exasol%3Audf-debugging-java)
15+
[![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=com.exasol%3Audf-debugging-java&metric=duplicated_lines_density)](https://sonarcloud.io/dashboard?id=com.exasol%3Audf-debugging-java)
16+
[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=com.exasol%3Audf-debugging-java&metric=ncloc)](https://sonarcloud.io/dashboard?id=com.exasol%3Audf-debugging-java)
517

618
This repository contains tools for debugging UDFs.
719

820
## Installation
921

10-
Install as maven dependency.
11-
You can get the dependency declaration by clicking the maven badge above.
22+
Install as maven dependency. You can get the dependency declaration by clicking the maven badge above.
1223

1324
## Typical Usage
1425

1526
Typically, you use this package together with [test-db-builder-java](https://github.com/exasol/test-db-builder-java) and [exasol-testcontainers](https://github.com/exasol/exasol-testcontainers) as follows:
1627

1728
```java
1829

19-
private static final ExasolContainer<? extends ExasolContainer<?>> EXASOL = new ExasolContainer<>();
20-
final UdfTestSetup udfTestSetup = new UdfTestSetup(getTestHostIp(), EXASOL.getDefaultBucket());
21-
final ExasolObjectFactory testDbBuilder = new ExasolObjectFactory(EXASOL.createConnection(),
22-
ExasolObjectConfiguration.builder().withJvmOptions(udfTestSetup.getJvmOptions()).build());
30+
private static final ExasolContainer<?extends ExasolContainer<?>> EXASOL=new ExasolContainer<>();
31+
final UdfTestSetup udfTestSetup=new UdfTestSetup(getTestHostIp(),EXASOL.getDefaultBucket());
32+
final ExasolObjectFactory testDbBuilder=new ExasolObjectFactory(EXASOL.createConnection(),
33+
ExasolObjectConfiguration.builder().withJvmOptions(udfTestSetup.getJvmOptions()).build());
2334
```
2435

2536
## Modules
2637

27-
This package contains multiple modules that you can enable on runtime by setting the corresponding system property to `true`.
28-
Typically, you do so by appending `-D<PROPERTY_NAME>="true"` to your JVM call.
29-
38+
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.
3039

3140
### Debugging
3241

@@ -40,10 +49,10 @@ System property: `test.coverage`
4049

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

43-
This module requires additional maven configuration. Use the [project-keeper's](https://github.com/exasol/project-keeper-maven-plugin) `udf_coverage` module to verify it.
44-
52+
This module requires additional maven configuration. Use the [project-keeper's](https://github.com/exasol/project-keeper-maven-plugin) `udf_coverage` module to verify it.
4553

4654
## Additional Information
4755

4856
* [Changelog](doc/changes/changelog.md)
49-
* [Dependencies](NOTICE)
57+
* [Dependencies](dependencies.md)
58+

‎dependencies.md

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
<!-- @formatter:off -->
2+
# Dependencies
3+
4+
## Compile Dependencies
5+
6+
| Dependency | License |
7+
| --------------------------------------- | -------------------------------------------------------- |
8+
| [JSR 374 (JSON Processing) API][0] | [Dual license consisting of the CDDL v1.1 and GPL v2][1] |
9+
| [error-reporting-java][2] | [MIT][3] |
10+
| [JaCoCo :: Core][4] | [Eclipse Public License 2.0][5] |
11+
| [BucketFS Java][6] | [MIT][3] |
12+
| [exasol-test-setup-abstraction-java][8] | [MIT][3] |
13+
| [Test Database Builder for Java][10] | [MIT][3] |
14+
| [SLF4J API Module][12] | [MIT License][13] |
15+
16+
## Test Dependencies
17+
18+
| Dependency | License |
19+
| ----------------------------------------------- | --------------------------------- |
20+
| [JaCoCo :: Agent][4] | [Eclipse Public License 2.0][5] |
21+
| [JUnit Jupiter Engine][16] | [Eclipse Public License v2.0][17] |
22+
| [JUnit Jupiter Params][16] | [Eclipse Public License v2.0][17] |
23+
| [mockito-core][20] | [The MIT License][21] |
24+
| [Hamcrest All][22] | [New BSD License][23] |
25+
| [Test containers for Exasol on Docker][24] | [MIT][3] |
26+
| [Testcontainers :: JUnit Jupiter Extension][26] | [MIT][27] |
27+
28+
## Plugin Dependencies
29+
30+
| Dependency | License |
31+
| ------------------------------------------------------- | ---------------------------------------------- |
32+
| [Maven Surefire Plugin][28] | [Apache License, Version 2.0][29] |
33+
| [Maven Failsafe Plugin][30] | [Apache License, Version 2.0][29] |
34+
| [JaCoCo :: Maven Plugin][4] | [Eclipse Public License 2.0][5] |
35+
| [Apache Maven Compiler Plugin][34] | [Apache License, Version 2.0][29] |
36+
| [Maven Dependency Plugin][36] | [The Apache Software License, Version 2.0][37] |
37+
| [Versions Maven Plugin][38] | [Apache License, Version 2.0][29] |
38+
| [Apache Maven Source Plugin][40] | [Apache License, Version 2.0][29] |
39+
| [Apache Maven Javadoc Plugin][42] | [Apache License, Version 2.0][29] |
40+
| [Apache Maven GPG Plugin][44] | [Apache License, Version 2.0][37] |
41+
| [org.sonatype.ossindex.maven:ossindex-maven-plugin][46] | [ASL2][37] |
42+
| [Apache Maven Enforcer Plugin][48] | [Apache License, Version 2.0][29] |
43+
| [Project keeper maven plugin][50] | [MIT][3] |
44+
| [Maven Deploy Plugin][52] | [The Apache Software License, Version 2.0][37] |
45+
| [Nexus Staging Maven Plugin][54] | [Eclipse Public License][55] |
46+
| [error-code-crawler-maven-plugin][56] | [MIT][3] |
47+
| [Reproducible Build Maven Plugin][58] | [Apache 2.0][37] |
48+
| [Maven Clean Plugin][60] | [The Apache Software License, Version 2.0][37] |
49+
| [Maven Resources Plugin][62] | [The Apache Software License, Version 2.0][37] |
50+
| [Maven JAR Plugin][64] | [The Apache Software License, Version 2.0][37] |
51+
| [Maven Install Plugin][66] | [The Apache Software License, Version 2.0][37] |
52+
| [Maven Site Plugin 3][68] | [The Apache Software License, Version 2.0][37] |
53+
54+
[4]: https://www.eclemma.org/jacoco/index.html
55+
[50]: https://github.com/exasol/project-keeper-maven-plugin
56+
[6]: https://github.com/exasol/bucketfs-java
57+
[2]: https://github.com/exasol/error-reporting-java
58+
[0]: https://javaee.github.io/jsonp
59+
[37]: http://www.apache.org/licenses/LICENSE-2.0.txt
60+
[28]: https://maven.apache.org/surefire/maven-surefire-plugin/
61+
[54]: http://www.sonatype.com/public-parent/nexus-maven-plugins/nexus-staging/nexus-staging-maven-plugin/
62+
[60]: http://maven.apache.org/plugins/maven-clean-plugin/
63+
[3]: https://opensource.org/licenses/MIT
64+
[20]: https://github.com/mockito/mockito
65+
[30]: https://maven.apache.org/surefire/maven-failsafe-plugin/
66+
[36]: http://maven.apache.org/plugins/maven-dependency-plugin/
67+
[38]: http://www.mojohaus.org/versions-maven-plugin/
68+
[34]: https://maven.apache.org/plugins/maven-compiler-plugin/
69+
[1]: https://oss.oracle.com/licenses/CDDL+GPL-1.1
70+
[27]: http://opensource.org/licenses/MIT
71+
[44]: http://maven.apache.org/plugins/maven-gpg-plugin/
72+
[5]: https://www.eclipse.org/legal/epl-2.0/
73+
[55]: http://www.eclipse.org/legal/epl-v10.html
74+
[24]: https://github.com/exasol/exasol-testcontainers
75+
[22]: https://github.com/hamcrest/JavaHamcrest/hamcrest-all
76+
[58]: http://zlika.github.io/reproducible-build-maven-plugin
77+
[64]: http://maven.apache.org/plugins/maven-jar-plugin/
78+
[13]: http://www.opensource.org/licenses/mit-license.php
79+
[29]: https://www.apache.org/licenses/LICENSE-2.0.txt
80+
[48]: https://maven.apache.org/enforcer/maven-enforcer-plugin/
81+
[21]: https://github.com/mockito/mockito/blob/release/3.x/LICENSE
82+
[17]: https://www.eclipse.org/legal/epl-v20.html
83+
[23]: http://www.opensource.org/licenses/bsd-license.php
84+
[66]: http://maven.apache.org/plugins/maven-install-plugin/
85+
[16]: https://junit.org/junit5/
86+
[46]: https://sonatype.github.io/ossindex-maven/maven-plugin/
87+
[26]: https://testcontainers.org
88+
[40]: https://maven.apache.org/plugins/maven-source-plugin/
89+
[12]: http://www.slf4j.org
90+
[52]: http://maven.apache.org/plugins/maven-deploy-plugin/
91+
[68]: http://maven.apache.org/plugins/maven-site-plugin/
92+
[62]: http://maven.apache.org/plugins/maven-resources-plugin/
93+
[42]: https://maven.apache.org/plugins/maven-javadoc-plugin/
94+
[56]: https://github.com/exasol/error-code-crawler-maven-plugin
95+
[8]: https://github.com/exasol/exasol-test-setup-abstraction-java
96+
[10]: https://github.com/exasol/test-db-builder

0 commit comments

Comments
 (0)