Skip to content

Commit

Permalink
#122: Improve "In a nutshell" section (#123)
Browse files Browse the repository at this point in the history
* #122: Improved documentation, updated dependencies and fixed broken build.
  • Loading branch information
redcatbear authored Nov 16, 2023
1 parent 474655c commit 1b584b6
Show file tree
Hide file tree
Showing 10 changed files with 147 additions and 74 deletions.
4 changes: 3 additions & 1 deletion .github/workflows/ci-build.yml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

23 changes: 19 additions & 4 deletions .github/workflows/dependencies_check.yml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions .project-keeper.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,6 @@ sources:
- maven_central
- integration_tests
linkReplacements:
- 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:
34 changes: 25 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,15 +24,31 @@ The main design goals are to make the code of the integration test compact and r
## In a Nutshell

```java
// Precondition: Get a JDBC connection and store it in variable "connection"
final DatabaseObjectFactory factory=new ExasolObjectFactory(connection);
final Schema schema factory.createSchema("ONLINESHOP");
final Table table=schema.createTable("ITEMS","PRODUCT_ID","DECIMAL(18,0)","NAME","VARCHAR(40)")
.insert("1","Cat food")
.insert("2","Toy mouse");
final User user=factory.createUser("KIMIKO")
.grant(CREATE_SESSION)
.grant(table,SELECT,UDPATE);
import com.exasol.dbbuilder.dialects.DatabaseObjectFactory;

class OnlineShopIT {
final static DatabaseObjectFactory factory;

@BeforeAll

static void beforeAll() {
// ... get a JDBC connection and store it in variable "connection"
factory = new ExasolObjectFactory(connection);
}

@Test
void testShopItemList() {
// Test preparation in the database:
final Schema schema = factory.createSchema("ONLINESHOP");
final Table table = schema.createTable("ITEMS", "PRODUCT_ID", "DECIMAL(18,0)", "NAME", "VARCHAR(40)")
.insert("1", "Cat food")
.insert("2", "Toy mouse");
final User user = factory.createUser("KIMIKO")
.grant(CREATE_SESSION)
.grant(table, SELECT, UDPATE);
// ... the actual test
}
}
```

For more details, please refer to the [user guide](doc/user_guide/user_guide.md).
Expand Down
59 changes: 25 additions & 34 deletions dependencies.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions doc/changes/changelog.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

37 changes: 37 additions & 0 deletions doc/changes/changes_3.5.2.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Test Database Builder for Java 3.5.2, released 2023-11-16

Code name: Improved "In a nutshell" section

## Summary

Improved the "in a nutshell" section to make it clearer that we are talking about tests here and what goes typically into `beforeAll()`. Updated dependencies and fixed build.

## Features

* #122: Improved the "in a nutshell" section.

## Dependency Updates

### Test Dependency Updates

* Updated `com.exasol:exasol-testcontainers:6.6.2` to `6.6.3`
* Updated `com.exasol:hamcrest-resultset-matcher:1.6.0` to `1.6.2`
* Updated `com.mysql:mysql-connector-j:8.1.0` to `8.2.0`
* Updated `com.oracle.database.jdbc:ojdbc11:23.2.0.0` to `23.3.0.23.09`
* Updated `nl.jqno.equalsverifier:equalsverifier:3.15.2` to `3.15.3`
* Added `org.junit.jupiter:junit-jupiter-api:5.10.1`
* Added `org.junit.jupiter:junit-jupiter-engine:5.10.1`
* Removed `org.junit.jupiter:junit-jupiter:5.9.3`
* Updated `org.mockito:mockito-junit-jupiter:5.5.0` to `5.7.0`

### Plugin Dependency Updates

* Updated `com.exasol:error-code-crawler-maven-plugin:1.3.0` to `1.3.1`
* Updated `com.exasol:project-keeper-maven-plugin:2.9.12` to `2.9.16`
* Updated `org.apache.maven.plugins:maven-enforcer-plugin:3.4.0` to `3.4.1`
* Updated `org.apache.maven.plugins:maven-failsafe-plugin:3.1.2` to `3.2.2`
* Updated `org.apache.maven.plugins:maven-javadoc-plugin:3.5.0` to `3.6.2`
* Updated `org.apache.maven.plugins:maven-surefire-plugin:3.1.2` to `3.2.2`
* Updated `org.codehaus.mojo:versions-maven-plugin:2.16.0` to `2.16.1`
* Updated `org.jacoco:jacoco-maven-plugin:0.8.10` to `0.8.11`
* Updated `org.sonarsource.scanner.maven:sonar-maven-plugin:3.9.1.2184` to `3.10.0.2594`
30 changes: 18 additions & 12 deletions pk_generated_parent.pom

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 1b584b6

Please sign in to comment.