couchbaselabs/couchbase-capi-server

OBSOLETE, NO LONGER MAINTAINED. An abstract Java HTTP server for pretending to be a Couchbase Server node.

Couchbase CAPI Server

This project implements an HTTP server capable of responding to Couchbase and CAPI requests.

Couchbase Requests supported:

• /pools (GET)
• /pools/default (GET)
• /pools/default/buckets (GET)
• /pools/default/buckets/{bucket} (GET)

CAPI Requests supported:

• /{database} (HEAD, GET)
• /{database}/{docid} (GET)
• /{database}/_ensure_full_commit (POST)
• /{database}/_revs_diff (POST)
• /{database}/_bulk_docs (POST)

This project does not come with an actual implementation of the behaviors behind these actions. Instead two interfaces are exposed:

• CouchbaseBehavior
• CAPIBehavior

Users of this library will provide their own implemenations of these interfaces to deliver the desired behavior.

Building

This project is built using Maven.

mvn install 

Using

• Implement your own CouchbaseBehavior

    public class MyCustomCouchbaseBehavior implements CouchbaseBehavior { ... }

• Implement your own CAPIBehavior

    public class MyCustomCAPIBehavior implements CAPIBehavior { ... }

• Create instances of #1 and #2

    CouchbaseBehavior couchbaseBehavior = new MyCustomCouchbaseBehavior();
    CAPIBehavior capiBehavior = new MyCustomCAPIBehavior();

• Start a CAPIServer

    CAPIServer capiServer = new CAPIServer(capiBehavior, couchbaseBehavior);
    capiServer.start();

By default this will start a server bound to 0.0.0.0 on an ephemeral port. If you'd like to bind to a different interface or a particular port, there are alternate constructors available.

couchbase-capi-server's Issues

Add to Central Maven Repository?

This project is great! Is there any possibility we can add this to the Maven central repository? I noticed if you want to build the Couchbase Transport Plugin for Elastic Search (https://github.com/couchbaselabs/elasticsearch-transport-couchbase), you have to build this to your local repository first.

Version tags

I noticed there are some interface changes between version 1.2.0 and 1.3.0, and specific version of this project are required for compatibility with specific Elastic Search Couchbase Plugin versions (and specific Couchbase versions). It would be very helpful to have tags on each release. Currently, if someone wants to build, for example, version 1.2.0, they have to find the version-related comment and checkout based on commit b6d9c9e, then build.

new CVE jetty-servlet

org.eclipse.jetty::jetty-servlet::9.3.13.v20161014

Should be updated to a version >= 9.3.20.v20170531.

CVE is CVE-2017-9735

mapping of parent/child relationship from couchbase to elasticsearch

if there is a parent/child mapping in Elasticsearch how should be the elasticsearch-transport-couchbase-1.3.0 configured so that parent information is collected from couchbase documents.
Example..
want to store paragraphs of a document in couchbase and index it in ElasticSearch and maintain document name in parent field.

one thing we tried is try to set parent manually
"builder.setParent("1");" in ElasticSearchCouchbaseBehavior.java file in storeUUID function
but it fails.

Please let us know if this is possible or some configuration needs to be done

Build fails

Checked out the latest code at that time.

---

[INFO] Building couchbase-capi-server 1.6.2
[INFO] ------------------------------------------------------------------------
[INFO]
[INFO] --- maven-resources-plugin:2.6:resources (default-resources) @ couchbase-capi-server ---
[WARNING] Using platform encoding (ANSI_X3.4-1968 actually) to copy filtered resources, i.e. build is platform dependent!
[INFO] skip non existing resourceDirectory /opt/couchbase-capi-server/src/main/resources
[INFO]
[INFO] --- maven-compiler-plugin:2.3.2:compile (default-compile) @ couchbase-capi-server ---
[INFO] Nothing to compile - all classes are up to date
[INFO]
[INFO] --- maven-resources-plugin:2.6:testResources (default-testResources) @ couchbase-capi-server ---
[WARNING] Using platform encoding (ANSI_X3.4-1968 actually) to copy filtered resources, i.e. build is platform dependent!
[INFO] skip non existing resourceDirectory /opt/couchbase-capi-server/src/test/resources
[INFO]
[INFO] --- maven-compiler-plugin:2.3.2:testCompile (default-testCompile) @ couchbase-capi-server ---
[WARNING] File encoding has not been set, using platform encoding ANSI_X3.4-1968, i.e. build is platform dependent!
[INFO] Compiling 3 source files to /opt/couchbase-capi-server/target/test-classes
[INFO] -------------------------------------------------------------
[ERROR] COMPILATION ERROR :
[INFO] -------------------------------------------------------------
[ERROR] /opt/couchbase-capi-server/src/test/java/com/couchbase/capi/CouchbaseBehaviorTestImpl.java:[21,7] error: CouchbaseBehaviorTestImpl is not abstract and does not override abstract method getNodesServingPool(String) in CouchbaseBehavior
[ERROR] /opt/couchbase-capi-server/src/test/java/com/couchbase/capi/CouchbaseBehaviorTestImpl.java:[57,24] error: getNodesServingPool(String) in CouchbaseBehaviorTestImpl cannot implement getNodesServingPool(String) in CouchbaseBehavior
[INFO] 2 errors
[INFO] -------------------------------------------------------------
[INFO] ------------------------------------------------------------------------
[INFO] BUILD FAILURE
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 1.043 s
[INFO] Finished at: 2017-04-12T05:30:42+00:00
[INFO] Final Memory: 15M/329M
[INFO] ------------------------------------------------------------------------
[ERROR] Failed to execute goal org.apache.maven.plugins:maven-compiler-plugin:2.3.2:testCompile (default-testCompile) on project couchbase-capi-server: Compilation failure: Compilation failure:
[ERROR] /opt/couchbase-capi-server/src/test/java/com/couchbase/capi/CouchbaseBehaviorTestImpl.java:[21,7] error: CouchbaseBehaviorTestImpl is not abstract and does not override abstract method getNodesServingPool(String) in CouchbaseBehavior
[ERROR] /opt/couchbase-capi-server/src/test/java/com/couchbase/capi/CouchbaseBehaviorTestImpl.java:[57,24] error: getNodesServingPool(String) in CouchbaseBehaviorTestImpl cannot implement getNodesServingPool(String) in CouchbaseBehavior
[ERROR] -> [Help 1]
[ERROR]
[ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch.
[ERROR] Re-run Maven using the -X switch to enable full debug logging.
[ERROR]
[ERROR] For more information about the errors and possible solutions, please read the following articles:
[ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/MojoFailureException

Update Jackson-mapper-asl to jackson-databind

The version of Jackson-mapper-asl is EOL. The project has moved to https://github.com/FasterXML/jackson-databind and they are on version 2.8.5. Locally, I was able to get couchbase-capi-server to build by making changes to the include statements to use the new namespace.

POM.xml source/target define Java 7, Jetty upgrade requires Java 8+

In d762348 the jetty version defined requires Java 8 as per http://www.eclipse.org/jetty/download.html

Using Jetty 9.2.17.v20160517 may be more suitable given that the POM.xml still has the source/target versions of Java defined as 1.7.

Antiquated Jetty Version

I was wondering if CAPI could be released with a newer version of Jetty. The version used in this repo is 8.1.0.v20120127, meaning it was released by the Jetty folks in 2012. I was getting buffer overflows from Jetty while using the CB-ElasticConnector.

I made a local build a few months ago with the then-newest release of Jetty. There were some minor code changes required in the project code.

I will fork and PR this repo with the necessary changes.

Documentation on the CAPIBehaviour and CouchbaseBehaviour interface.

Right now it is quite hard to know what to implement when you are implementing the two interfaces.

A documentation on these would be great.