Added initial Replication support

Author: ewoutp

client.go

@@ -57,6 +57,9 @@ type Client interface {
 
 	// Server/cluster administration functions
 	ClientServerAdmin
+
+	// Replication functions
+	ClientReplication
 }
 
 // ClientConfig contains all settings needed to create a client.

client_replication.go

@@ -0,0 +1,29 @@
+//
+// DISCLAIMER
+//
+// Copyright 2018 ArangoDB GmbH, Cologne, Germany
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+// Copyright holder is ArangoDB GmbH, Cologne, Germany
+//
+// Author Ewout Prangsma
+//
+
+package driver
+
+// ClientReplication provides methods needed to access replication functionality from a client.
+type ClientReplication interface {
+	// Replication provides access to replication specific operations.
+	Replication() Replication
+}

client_replication_impl.go

@@ -0,0 +1,28 @@
+//
+// DISCLAIMER
+//
+// Copyright 2018 ArangoDB GmbH, Cologne, Germany
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+// Copyright holder is ArangoDB GmbH, Cologne, Germany
+//
+// Author Ewout Prangsma
+//
+
+package driver
+
+// Replication provides access to replication specific operations.
+func (c *client) Replication() Replication {
+	return c
+}

context.go

@@ -54,6 +54,7 @@ const (
 	keyEnforceReplicationFactor ContextKey = "arangodb-enforceReplicationFactor"
 	keyConfigured               ContextKey = "arangodb-configured"
 	keyFollowLeaderRedirect     ContextKey = "arangodb-followLeaderRedirect"
+	keyDBServerID               ContextKey = "arangodb-dbserverID"
 )
 
 // WithRevision is used to configure a context to make document
@@ -200,6 +201,11 @@ func WithFollowLeaderRedirect(parent context.Context, value bool) context.Contex
 	return context.WithValue(contextOrBackground(parent), keyFollowLeaderRedirect, value)
 }
 
+// WithDBServerID is used to configure a context that includes an ID of a specific DBServer.
+func WithDBServerID(parent context.Context, id string) context.Context {
+	return context.WithValue(contextOrBackground(parent), keyDBServerID, id)
+}
+
 type contextSettings struct {
 	Silent                   bool
 	WaitForSync              bool
@@ -214,6 +220,7 @@ type contextSettings struct {
 	EnforceReplicationFactor *bool
 	Configured               *bool
 	FollowLeaderRedirect     *bool
+	DBServerID               string
 }
 
 // applyContextSettings returns the settings configured in the context in the given request.
@@ -327,6 +334,13 @@ func applyContextSettings(ctx context.Context, req Request) contextSettings {
 			result.FollowLeaderRedirect = &followLeaderRedirect
 		}
 	}
+	// DBServerID
+	if v := ctx.Value(keyDBServerID); v != nil {
+		if id, ok := v.(string); ok {
+			req.SetQuery("DBserver", id)
+			result.DBServerID = id
+		}
+	}
 	return result
 }
 

replication.go

@@ -0,0 +1,35 @@
+//
+// DISCLAIMER
+//
+// Copyright 2018 ArangoDB GmbH, Cologne, Germany
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+// Copyright holder is ArangoDB GmbH, Cologne, Germany
+//
+// Author Ewout Prangsma
+//
+
+package driver
+
+import (
+	"context"
+)
+
+// Replication provides access to replication related operations.
+type Replication interface {
+	// Get the inventory of the server containing all collections (with entire details) of a database.
+	// When this function is called on a coordinator is a cluster, an ID of a DBServer must be provided
+	// using a context that is prepare with `WithDBServerID`.
+	DatabaseInventory(ctx context.Context, db Database) (DatabaseInventory, error)
+}

replication_impl.go

@@ -0,0 +1,49 @@
+//
+// DISCLAIMER
+//
+// Copyright 2018 ArangoDB GmbH, Cologne, Germany
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+// Copyright holder is ArangoDB GmbH, Cologne, Germany
+//
+// Author Ewout Prangsma
+//
+
+package driver
+
+import (
+	"context"
+	"path"
+)
+
+// Get the inventory of a server containing all collections (with entire details) of a database.
+func (c *client) DatabaseInventory(ctx context.Context, db Database) (DatabaseInventory, error) {
+	req, err := c.conn.NewRequest("GET", path.Join("_db", db.Name(), "_api/replication/inventory"))
+	if err != nil {
+		return DatabaseInventory{}, WithStack(err)
+	}
+	applyContextSettings(ctx, req)
+	resp, err := c.conn.Do(ctx, req)
+	if err != nil {
+		return DatabaseInventory{}, WithStack(err)
+	}
+	if err := resp.CheckStatus(200); err != nil {
+		return DatabaseInventory{}, WithStack(err)
+	}
+	var result DatabaseInventory
+	if err := resp.ParseBody("", &result); err != nil {
+		return DatabaseInventory{}, WithStack(err)
+	}
+	return result, nil
+}

test/replication_test.go

@@ -0,0 +1,58 @@
+//
+// DISCLAIMER
+//
+// Copyright 2018 ArangoDB GmbH, Cologne, Germany
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+// Copyright holder is ArangoDB GmbH, Cologne, Germany
+//
+// Author Ewout Prangsma
+//
+
+package test
+
+import (
+	"context"
+	"testing"
+)
+
+// TestReplicationDatabaseInventory tests the Replication.DatabaseInventory method.
+func TestReplicationDatabaseInventory(t *testing.T) {
+	ctx := context.Background()
+	c := createClientFromEnv(t, true)
+	rep := c.Replication()
+	db, err := c.Database(ctx, "_system")
+	if err != nil {
+		t.Fatalf("Failed to open _system database: %s", describe(err))
+	}
+	inv, err := rep.DatabaseInventory(ctx, db)
+	if err != nil {
+		t.Fatalf("DatabaseInventory failed: %s", describe(err))
+	}
+	if len(inv.Collections) == 0 {
+		t.Error("Expected multiple collections, got 0")
+	}
+	foundSystemCol := false
+	for _, col := range inv.Collections {
+		if col.Parameters.Name == "" {
+			t.Error("Expected non-empty name")
+		}
+		if col.Parameters.IsSystem {
+			foundSystemCol = true
+		}
+	}
+	if !foundSystemCol {
+		t.Error("Expected multiple system collections, found none")
+	}
+}