Skip to content
This repository was archived by the owner on Sep 28, 2022. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions doc/3/controllers/collection/exists/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
code: true
type: page
title: exists
description: Checks if a collection exists
---

# exists

Checks if a collection exists.

---

## Arguments

```java
public CompletableFuture<Boolean> exists(
final String index,
final String collection)
throws NotConnectedException, InternalException

```

---

| Arguments | Type | Description |
| ------------------ | -------------------------------------------- | --------------------------------- |
| `index` | <pre>String</pre> | Index |
| `collection` | <pre>String</pre> | Collection |

---

## Return

Returns a boolean.

## Usage

<<< ./snippets/exists.java
4 changes: 4 additions & 0 deletions doc/3/controllers/collection/exists/snippets/exists.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Boolean result = kuzzle
.getCollectionController()
.exists("nyc-open-data", "yellow-taxi")
.get();
10 changes: 10 additions & 0 deletions doc/3/controllers/collection/exists/snippets/exists.test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
name: collection#exists
description: Check if collection exists
hooks:
before: |
curl -XDELETE kuzzle:7512/nyc-open-data
curl -XPOST kuzzle:7512/nyc-open-data/_create
curl -XPUT kuzzle:7512/nyc-open-data/yellow-taxi
after:
template: print-result
expected: "true"
8 changes: 8 additions & 0 deletions doc/3/controllers/collection/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
code: true
type: branch
title: Collection
description: Collection Controller
---

# Collection Controller
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
package io.kuzzle.sdk.API.Controllers;

import io.kuzzle.sdk.CoreClasses.Maps.KuzzleMap;
import io.kuzzle.sdk.Exceptions.InternalException;
import io.kuzzle.sdk.Exceptions.NotConnectedException;
import io.kuzzle.sdk.Kuzzle;

import java.util.concurrent.CompletableFuture;

public class CollectionController extends BaseController {

public CollectionController(final Kuzzle kuzzle) {
super(kuzzle);
}

/**
* Tells if a collection exists in a given index.
*
* @param index
* @param collection
* @return a CompletableFuture
* @throws NotConnectedException
* @throws InternalException
*/
public CompletableFuture<Boolean> exists(
final String index,
final String collection) throws NotConnectedException, InternalException {

final KuzzleMap query = new KuzzleMap();
query
.put("index", index)
.put("collection", collection)
.put("controller", "collection")
.put("action", "exists");

return kuzzle
.query(query)
.thenApplyAsync(
(response) -> (Boolean) response.result);
}
}
8 changes: 8 additions & 0 deletions src/main/java/io/kuzzle/sdk/Kuzzle.java
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package io.kuzzle.sdk;

import io.kuzzle.sdk.API.Controllers.AuthController;
import io.kuzzle.sdk.API.Controllers.CollectionController;
import io.kuzzle.sdk.API.Controllers.DocumentController;
import io.kuzzle.sdk.API.Controllers.IndexController;
import io.kuzzle.sdk.API.Controllers.RealtimeController;
Expand Down Expand Up @@ -80,6 +81,13 @@ public AuthController getAuthController() {
return new AuthController(this);
}

/**
* @return The CollectionController
*/
public CollectionController getCollectionController() {
return new CollectionController(this);
}

/**
* @return The DocumentController
*/
Expand Down
52 changes: 52 additions & 0 deletions src/test/java/io/kuzzle/test/API/Controllers/CollectionTest.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
package io.kuzzle.test.API.Controllers;

import io.kuzzle.sdk.CoreClasses.Maps.KuzzleMap;
import io.kuzzle.sdk.Exceptions.InternalException;
import io.kuzzle.sdk.Exceptions.NotConnectedException;
import io.kuzzle.sdk.Kuzzle;
import io.kuzzle.sdk.Protocol.AbstractProtocol;
import io.kuzzle.sdk.Protocol.ProtocolState;
import io.kuzzle.sdk.Protocol.WebSocket;
import org.junit.Test;
import org.mockito.ArgumentCaptor;
import org.mockito.Mockito;
import org.mockito.stubbing.Answer;

import static org.junit.Assert.assertEquals;
import static org.mockito.Mockito.spy;

public class CollectionTest {

private AbstractProtocol networkProtocol = Mockito.mock(WebSocket.class);

@Test
public void existsCollectionTest() throws NotConnectedException, InternalException {

Kuzzle kuzzleMock = spy(new Kuzzle(networkProtocol));
String index = "nyc-open-data";
String collection = "yellow-taxi";


ArgumentCaptor<KuzzleMap> arg = ArgumentCaptor.forClass(KuzzleMap.class);

kuzzleMock.getCollectionController().exists(index, collection);
Mockito.verify(kuzzleMock, Mockito.times(1)).query(arg.capture());

assertEquals((arg.getValue()).getString("controller"), "collection");
assertEquals((arg.getValue()).getString("action"), "exists");
assertEquals((arg.getValue()).getString("index"), "nyc-open-data");
assertEquals((arg.getValue()).getString("collection"), "yellow-taxi");
}

@Test(expected = NotConnectedException.class)
public void existsCollectionShouldThrowWhenNotConnected() throws NotConnectedException, InternalException {
AbstractProtocol fakeNetworkProtocol = Mockito.mock(WebSocket.class);
Mockito.when(fakeNetworkProtocol.getState()).thenAnswer((Answer<ProtocolState>) invocation -> ProtocolState.CLOSE);

Kuzzle kuzzleMock = spy(new Kuzzle(fakeNetworkProtocol));
String index = "nyc-open-data";
String collection = "yellow-taxi";

kuzzleMock.getCollectionController().exists(index, collection);
}
}