ryan_harg/testcontainers-infinispan
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README

Browse source
This commit is contained in:
Reinhard Prechtl 2018-01-21 18:46:54 +01:00
parent 26bfc28746
commit 12f1d7d8b5
1 changed files with 36 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

45
README.md
View file

@ -8,18 +8,34 @@ for the Infinispan cache server. It provides an API that is aimed to help you co
At the moment this is a rudimentary implementation and by no means complete. It only supports the [Hotrod protocol](http://infinispan.org/docs/stable/user_guide/user_guide.html#hot_rod_protocol) At the moment this is a rudimentary implementation and by no means complete. It only supports the [Hotrod protocol](http://infinispan.org/docs/stable/user_guide/user_guide.html#hot_rod_protocol)
to connect to the Infinispan server, for example. to connect to the Infinispan server, for example.
Further information can be found in these blog posts:
- [12-19-2017: Running an Infinispan Server using Testcontainers](https://blog.codecentric.de/en/2017/12/running-infinispan-server-using-testcontainers)
- [01-21-2018: Running a clustered Infinispan Server using Testcontainers](https://reinhard.codes/2018/01/21/running-an-infinispan-node-in-clustered-mode-using-testcontainers/)
Feel free to suggest changes! Feel free to suggest changes!
# Usage # Usage
## Instantiation of the Infinispan container It's possible to run Infinispan in standalone or in clustered mode. See the integration tests contained in this repository
for detailed examples.
Here's simple example how you can use the `InfinispanContainer`. ## Instantiation of the Infinispan containers
Here's a simple example how you can use the `StandaloneInfinispanContainer`.
``` ```
@ClassRule @ClassRule
public static InfinispanContainer infinispan = new InfinispanContainer(); public static InfinispanContainer infinispan = new StandaloneInfinispanContainer();
``` ```
If you want to run Infinispan as a one-node clustered instance, you can do it like this:
```
@ClassRule
public static InfinispanContainer infinispan = new ClusteredInfinispanContainer();
```
## Cache creation ## Cache creation
You can create simple local caches that need to be available for your tests. If you run an up-to-date Infinispan container (>9.1.0) then caches can be created You can create simple local caches that need to be available for your tests. If you run an up-to-date Infinispan container (>9.1.0) then caches can be created
@ -27,22 +43,33 @@ using the API of the `RemoteCacheManager` provided by the Infinispan client libr
They will automatically be created once the container has started. They will automatically be created once the container has started.
``` ```
new InfinispanContainer(‚) new StandaloneInfinispanContainer(‚)
.withProtocolVersion(ProtocolVersion.PROTOCOL_VERSION_26) .withCaches("testCache")
.withCaches("testCache"); .withProtocolVersion(ProtocolVersion.PROTOCOL_VERSION_26);
``` ```
The `ClusteredInfinispanContainer` supports the same method.
If you run an Infinispan server version prior to `9.1.0`, you can link a configuration file that contains the necessary caches into the container: If you run an Infinispan server version prior to `9.1.0`, you can link a configuration file that contains the necessary caches into the container:
``` ```
new InfinispanContainer("jboss/infinispan-server:9.0.3.Final") new StandaloneInfinispanContainer("jboss/infinispan-server:9.0.3.Final")
.withProtocolVersion(ProtocolVersion.PROTOCOL_VERSION_26) .withStandaloneConfiguration("infinispan-standalone.xml")
.withStandaloneConfiguration("infinispan-standalone.xml") .withProtocolVersion(ProtocolVersion.PROTOCOL_VERSION_26)
```
There's an equivalent for the `ClusteredInfinispanContainer`:
```
new ClusteredInfinispanContainer("jboss/infinispan-server:9.0.3.Final")
.withClusteredConfiguration("infinispan-standalone.xml")
.withProtocolVersion(ProtocolVersion.PROTOCOL_VERSION_26)
``` ```
## CacheManager retrieval ## CacheManager retrieval
If you want, you can retrieve a `RemoteCacheManager` from the container: If you want, you can retrieve a `RemoteCacheManager` from the container:
``` ```
infinispan.getCacheManager() infinispan.getCacheManager()
``` ```