Remove graph with all collections (#582)

Author: jwierzbo

CHANGELOG.md

@@ -4,6 +4,7 @@
 - Switch to Go 1.20.11
 - Switch to Go 1.21.5
 - Disable AF mode in tests (not supported since 3.12)
+- Remove graph with all collections
 
 ## [1.6.1](https://github.com/arangodb/go-driver/tree/v1.6.1) (2023-10-31)
 - Add support for getting license

graph.go

@@ -1,7 +1,7 @@
 //
 // DISCLAIMER
 //
-// Copyright 2017 ArangoDB GmbH, Cologne, Germany
+// Copyright 2017-2024 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.
@@ -17,8 +17,6 @@
 //
 // Copyright holder is ArangoDB GmbH, Cologne, Germany
 //
-// Author Ewout Prangsma
-//
 
 package driver
 
@@ -33,6 +31,9 @@ type Graph interface {
 	// If the graph does not exist, a NotFoundError is returned.
 	Remove(ctx context.Context) error
 
+	// RemoveWithOpts removes the entire graph with options.
+	RemoveWithOpts(ctx context.Context, opts *RemoveGraphOptions) error
+
 	// IsSmart returns true of smart is smart. In case of Community Edition it is always false
 	IsSmart() bool
 
@@ -69,7 +70,7 @@ type Graph interface {
 	// NumberOfShards returns the number of shards for the graph.
 	NumberOfShards() int
 
-	// OrphanCollections returns the orphan collcetions of the graph.
+	// OrphanCollections returns the orphan collections of the graph.
 	OrphanCollections() []string
 
 	// ReplicationFactor returns the current replication factor.
@@ -78,3 +79,7 @@ type Graph interface {
 	// WriteConcern returns the write concern setting of the graph.
 	WriteConcern() int
 }
+
+type RemoveGraphOptions struct {
+	DropCollections bool `json:"dropCollections,omitempty"`
+}

graph_impl.go

@@ -1,7 +1,7 @@
 //
 // DISCLAIMER
 //
-// Copyright 2023 ArangoDB GmbH, Cologne, Germany
+// Copyright 2023-2024 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.
@@ -136,3 +136,26 @@ func (g *graph) Remove(ctx context.Context) error {
 	}
 	return nil
 }
+
+func (g *graph) RemoveWithOpts(ctx context.Context, opts *RemoveGraphOptions) error {
+	req, err := g.conn.NewRequest("DELETE", g.relPath())
+	if err != nil {
+		return WithStack(err)
+	}
+
+	if opts != nil {
+		if opts.DropCollections {
+			req.SetQuery("dropCollections", "true")
+		}
+	}
+
+	applyContextSettings(ctx, req)
+	resp, err := g.conn.Do(ctx, req)
+	if err != nil {
+		return WithStack(err)
+	}
+	if err := resp.CheckStatus(201, 202); err != nil {
+		return WithStack(err)
+	}
+	return nil
+}

test/graph_test.go

@@ -1,7 +1,7 @@
 //
 // DISCLAIMER
 //
-// Copyright 2017-2023 ArangoDB GmbH, Cologne, Germany
+// Copyright 2017-2024 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.
@@ -24,6 +24,8 @@ import (
 	"context"
 	"testing"
 
+	"github.com/stretchr/testify/require"
+
 	driver "github.com/arangodb/go-driver"
 )
 
@@ -189,3 +191,37 @@ func TestRemoveGraph(t *testing.T) {
 		t.Errorf("GraphExists('%s') return true, expected false", name)
 	}
 }
+
+// TestRemoveGraphWithOpts creates a graph with collection and then removes it.
+func TestRemoveGraphWithOpts(t *testing.T) {
+	ctx := context.Background()
+	c := createClient(t, nil)
+	db := ensureDatabase(ctx, c, "graph_test_remove", nil, t)
+	name := "test_remove_graph_opts"
+	colName := "remove_graph_col"
+
+	g, err := db.CreateGraphV2(ctx, name, nil)
+	require.NoError(t, err)
+
+	found, err := db.GraphExists(ctx, name)
+	require.NoError(t, err)
+	require.True(t, found)
+
+	// Now create a vertex collection
+	vc, err := g.CreateVertexCollection(nil, colName)
+	require.NoError(t, err)
+	require.Equal(t, colName, vc.Name())
+
+	// Now remove the graph with collections
+	err = g.RemoveWithOpts(ctx, &driver.RemoveGraphOptions{DropCollections: true})
+	require.NoError(t, err)
+
+	// Collection must not exist in a database
+	colExist, err := db.CollectionExists(ctx, name)
+	require.NoError(t, err)
+	require.False(t, colExist)
+
+	found, err = db.GraphExists(ctx, name)
+	require.NoError(t, err)
+	require.False(t, found)
+}

test/vertex_collection_test.go

@@ -1,7 +1,7 @@
 //
 // DISCLAIMER
 //
-// Copyright 2017-2023 ArangoDB GmbH, Cologne, Germany
+// Copyright 2017-2024 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.
@@ -24,6 +24,8 @@ import (
 	"context"
 	"testing"
 
+	"github.com/stretchr/testify/require"
+
 	driver "github.com/arangodb/go-driver"
 )
 
@@ -144,7 +146,8 @@ func TestCreateSatelliteVertexCollection(t *testing.T) {
 	}
 
 	// revert
-	g.Remove(ctx)
+	err = g.Remove(ctx)
+	require.NoError(t, err)
 }
 
 // TestRemoveVertexCollection creates a graph and then adds an vertex collection in it and then removes the vertex collection.