Skip to content

Commit

Permalink
Address PR feedback.
Browse files Browse the repository at this point in the history
Signed-off-by: Yury-Fridlyand <[email protected]>
  • Loading branch information
Yury-Fridlyand committed Sep 21, 2023
1 parent 45ed933 commit f03cc36
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 12 deletions.
14 changes: 11 additions & 3 deletions java/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Summary - Java Wrapper

This module contains a Java-client wrapper that connects to the `Babushka`-rust-client. The rust client connects to
redis, while this wrapper provides Java-language binding. The objective of this wrapper is to provide a thin-wrapper
This module contains a Java-client wrapper that connects to the `Babushka`-rust-client. The rust client connects to
redis, while this wrapper provides Java-language binding. The objective of this wrapper is to provide a thin-wrapper
language api to enhance performance and limit cpu cycles at scale.

## Organization
Expand All @@ -16,9 +16,17 @@ The Java client (javabushka) contains the following parts:

You can assemble the Java clients benchmarks by compiling using `./gradlew build`.

## Code style

Code style is enforced by spotless with Google Java Format. The build fails if code formatted incorrectly, but you can auto-format code with `./gradlew spotlessApply`.
Run this command before every commit to keep code in the same style.
These IDE plugins can auto-format code on file save or by single click:
* [For Intellij IDEA](https://plugins.jetbrains.com/plugin/18321-spotless-gradle)
* [For VS Code](https://marketplace.visualstudio.com/items?itemName=richardwillis.vscode-spotless-gradle)

## Benchmarks

You can run benchmarks using `./gradlew run`. You can set arguments using the args flag like:
You can run benchmarks using `./gradlew run`. You can set arguments using the args flag like:

```shell
./gradlew run --args="--clients lettuce"
Expand Down
6 changes: 2 additions & 4 deletions java/jabushka/build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,11 @@ plugins {

repositories {
mavenCentral()
mavenLocal()
}

subprojects {
repositories {
mavenCentral()
mavenLocal()
}
// minimal java compatibility level
plugins.withId('java') {
Expand All @@ -28,7 +26,7 @@ subprojects {
events "started", "skipped", "passed", "failed"
showStandardStreams true
}
// Temporary suspend jacoco
// TODO: add jacoco with code coverage
// finalizedBy jacocoTestReport, jacocoTestCoverageVerification
}
}
Expand Down Expand Up @@ -81,7 +79,7 @@ jacocoTestCoverageVerification {
}))
}
}
// Temporary suspend jacoco
// TODO: add jacoco with code coverage
// check.dependsOn jacocoTestCoverageVerification
// End of JaCoCo section

Expand Down
6 changes: 1 addition & 5 deletions java/jabushka/settings.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,4 @@ rootProject.name = 'babushka'

include 'jabushka'
include 'integTest'

// Run benchmarking by adding `-Pbenchmark` switch to gradlew command line
if (hasProperty('benchmark')) {
include 'benchmarks'
}
include 'benchmarks'

0 comments on commit f03cc36

Please sign in to comment.