diff --git a/README.md b/README.md index 4289878e9..09ea1c616 100644 --- a/README.md +++ b/README.md @@ -10,8 +10,9 @@ Please see the [Release Notes](https://github.com/basho/riak-java-client/blob/de 1. [Installation](#installation) 2. [Documentation](#documentation) 3. [Contributing](#contributing) - * [`riak_pb` dependency](#riak_pb-dependency) - * [Security Tests](security-tests) + * [Integration Tests Setup](#integration-tests-setup) + * [Running Integration Tests](#running-integration-tests) + * [Security Tests](#security-tests) * [An honest disclaimer](#an-honest-disclaimer) 4. [Roadmap](#roadmap) 5. [License and Authors](#license-and-authors) @@ -39,7 +40,7 @@ This client is published to Maven Central and can be included in your project by com.basho.riak riak-client - 2.0.4 + 2.0.7 ... @@ -57,6 +58,58 @@ Also see [the Javadoc site](http://basho.github.io/riak-java-client/) for more i ## Contributing +#### Integration Tests Setup + +We've included Basho's [riak-client-tools](https://github.com/basho/riak-client-tools/) as a git submodule to help with Riak test setup and teardown. +You can find these tools in the `/tools` subdirectory. + +To configure your single riak instance, you may use the [riak-cluster-config](https://github.com/basho/riak-client-tools/blob/master/devrel/riak-cluster-config) script to setup the node with the appropriate bucket types. +You can use it by running `tools/devrel/riak-cluster-config $PATH_TO_RIAK_ADMIN $RIAK_HTTP_PORT false false` with the appropriate paths and values filled in. + +To configure a devrel for multiple node testing, please see the instructions located at [basho/riak-client-tools](https://github.com/basho/riak-client-tools/blob/master/devrel/README.md) on how to use the `devrel/setup-dev-cluster` command. + +#### Running Integration Tests + +To run the Riak KV integration test suite, execute: +``` +make RIAK_PORT=8087 integration-test +``` + +To run the Riak TimeSeries test suite, execute: +``` +make RIAK_PORT=8087 integration-test-timeseries +``` + +When running tests directly from Maven, you may also turn feature sets on and off with system properties: +``` +mvn -Pitest,default -Dcom.basho.riak.timeseries=true -Dcom.basho.riak.pbcport=$(RIAK_PORT) verify +``` + +The supported test flags are: + +System Property | Default Value | Note +--------------- | ------------- | ---- +com.basho.riak.buckettype | true | Riak KV 2.0 Bucket Type Tests +com.basho.riak.yokozuna | true | Riak KV 2.0 Solr/Yokozuna Search Tests +com.basho.riak.2i | true | Riak KV Secondary Index Tests +com.basho.riak.mr | true | Riak KV MapReduce Tests +com.basho.riak.crdt | true | Riak KV 2.0 Data Type Tests +com.basho.riak.lifecycle | true | Java Client Node/Cluster Lifecycle Tests +com.basho.riak.timeseries | false | Riak TS TimeSeries Tests +com.basho.riak.riakSearch | false | Riak KV 1.0 Legacy Search Tests +com.basho.riak.coveragePlan | false | Riak KV/TS Coverage Plan Tests
(need cluster to run these ) +com.basho.riak.security | false | Riak Security Tests +com.basho.riak.clientcert | false | Riak Security Tests with Certificates + +Some tests may require more than one feature to run, so please check the test to see which ones are required before running. + +Connection Options + +System Property | Default Value | Note +--- | --- | --- +com.basho.riak.host | `127.0.0.1` | The hostname to connect to for tests +com.basho.riak.pbcport | `8087` | The Protocol Buffers port to connect to for tests + #### Security tests To run the security-related integration tests, you will need to: diff --git a/RELNOTES.md b/RELNOTES.md index 6dae4eef1..6b65b42e3 100644 --- a/RELNOTES.md +++ b/RELNOTES.md @@ -1,6 +1,37 @@ Release Notes ============= +### 2.0.7 + +**Notes** + * This will be the last version of Riak Java Client that supports Java 7. + * Some of the changes are binary-incompatible with RJC 2.0.6, so you will need to recompile your project with this new version. + +Following issues / PRs addressed: + +* [Fixed - Disallow 0 as a timeout value for TimeSeries operations](https://github.com/basho/riak-java-client/pull/662) +* Fixed - In `RiakUserMetadata#containsKey()`, use the charset method parameter when encoding the key [[1]](https://github.com/basho/riak-java-client/pull/558), [[2]](https://github.com/basho/riak-java-client/pull/646) +* Fixed - Don't return success to update future after fetch future error [[1]](https://github.com/basho/riak-java-client/pull/633), [[2]](https://github.com/basho/riak-java-client/pull/636) +* [Fixed - Demoted "channel close" log messages to info level](https://github.com/basho/riak-java-client/pull/637) +* [Fixed - Made domain name more invalid for `UnknownHostException` test](https://github.com/basho/riak-java-client/pull/641) +* [Fixed - Separate Content-type and charset in `RiakObject`](https://github.com/basho/riak-java-client/pull/647) +* [Fixed - BinaryValue JSON encoding for MapReduce inputs](https://github.com/basho/riak-java-client/pull/655) +* [Fixed - Catch & handle `BlockingOperationException` in `RiakNode#execute`](https://github.com/basho/riak-java-client/pull/661) +* Added Batch Delete Command [[1]](https://github.com/basho/riak-java-client/pull/487), [[2]](https://github.com/basho/riak-java-client/pull/650) +* Added `equals()`, `hashCode()`, `toString()` to `RiakObject` and associated files [[1]](https://github.com/basho/riak-java-client/pull/557), [[2]](https://github.com/basho/riak-java-client/pull/648) +* Added `getLocation()` to `KvResponseBase` [[1]](https://github.com/basho/riak-java-client/pull/606), [[2]](https://github.com/basho/riak-java-client/pull/643) +* [Added creation of `RiakClient` from a collection of `HostAndPort` objects](https://github.com/basho/riak-java-client/pull/607) +* Added overload of `RiakClient#execute` that accepts a timeout [[1]](https://github.com/basho/riak-java-client/pull/610), [[2]](https://github.com/basho/riak-java-client/pull/642) +* [Added shortcut commands for $bucket and $key 2i indices](https://github.com/basho/riak-java-client/pull/652) +* [Added `isNotFound()` field to data type responses](https://github.com/basho/riak-java-client/pull/654) +* Added - Dataplatform / Riak Spark Connector changes merged back into main client [[1]](https://github.com/basho/riak-java-client/pull/621), [[2]](https://github.com/basho/riak-java-client/pull/626), [[3]](https://github.com/basho/riak-java-client/pull/644), [[4]](https://github.com/basho/riak-java-client/pull/659), [[5]](https://github.com/basho/riak-java-client/pull/665) +* [Updated plugins and dependencies](https://github.com/basho/riak-java-client/pull/631) +* [Updated TS objects and Commands for TS 1.4](https://github.com/basho/riak-java-client/pull/651) +* [Enhanced - Made Integration Tests Great Again](https://github.com/basho/riak-java-client/pull/657) +* [Removed Antlr dependency](https://github.com/basho/riak-java-client/pull/629) + +Special thanks to @bwittwer, @stela, @gerardstannard, @christopherfrieler, @guidomedina, @Tolsi, @hankipanky, @gfbett, @TimurFayruzov, @urzhumskov, @srgg, @aleksey-suprun, @jbrisbin, @christophermancini, and @lukebakken for all the PRs, reported issues, and reviews. + ### 2.0.6 Following issues / PRs addressed: * [Removed riak_pb external dependency](https://github.com/basho/riak-java-client/pull/615)