Deprecate AllowInconsistent (#537)

Author: jwierzbo

.travis.yml

@@ -1,11 +1,10 @@
-sudo: required
+# Ubuntu 20.04 (Focal Fossa)
+dist: focal
 
-addons:
-  apt:
-    packages:
-      - docker-ce
+sudo: required
 
 before_install:
+  - docker version
   - |
     mkdir -p $HOME/resources
     for i in {0..3}
@@ -27,9 +26,12 @@ before_install:
       travis_terminate 1
     fi
 
+services:
+  - docker
+
 language: go
 go:
-  - 1.20.6
+  - 1.20.7
 
 env:
   jobs:
@@ -43,8 +45,8 @@ env:
     - TEST_SUITE=run-v2-tests-cluster
     - TEST_SUITE=run-v2-tests-resilientsingle
   global:
-    - ARANGODB=gcr.io/gcr-for-testing/arangodb/enterprise-preview:3.11.1
-    - GOIMAGE=gcr.io/gcr-for-testing/golang:1.20.5
+    - ARANGODB=gcr.io/gcr-for-testing/arangodb/enterprise-preview:3.11.2
+    - GOIMAGE=gcr.io/gcr-for-testing/golang:1.20.7
     - ALPINE_IMAGE=gcr.io/gcr-for-testing/alpine:3.17
     - STARTER=arangodb/arangodb-starter:latest
     - TEST_DISALLOW_UNKNOWN_FIELDS=false

CHANGELOG.md

@@ -18,6 +18,7 @@
 - [V2] Rename CreateCollectionOptions to CreateCollectionProperties
 - [V2] Add support for missing query options (create documents, remove collection, remove view)
 - [V2] Adjust CursorStats and JournalSize types
+- [V1] Deprecate `AllowInconsistent` in HotBackup
 
 ## [1.6.0](https://github.com/arangodb/go-driver/tree/v1.6.0) (2023-05-30)
 - Add ErrArangoDatabaseNotFound and IsExternalStorageError helper to v2

Makefile

@@ -6,7 +6,7 @@ SCRIPTDIR := $(shell pwd)
 CURR=$(shell dirname $(realpath $(lastword $(MAKEFILE_LIST))))
 ROOTDIR:=$(CURR)
 
-GOVERSION ?= 1.20.6
+GOVERSION ?= 1.20.7
 GOIMAGE ?= golang:$(GOVERSION)
 GOV2IMAGE ?= $(GOIMAGE)
 ALPINE_IMAGE ?= alpine:3.17

VERSION

@@ -1,7 +1,7 @@
 //
 // DISCLAIMER
 //
-// Copyright 2017 ArangoDB GmbH, Cologne, Germany
+// Copyright 2017-2023 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 Lars Maier
-//
 
 package driver
 
@@ -60,9 +58,12 @@ type BackupListOptions struct {
 
 // BackupCreateOptions provides options for Create
 type BackupCreateOptions struct {
-	Label             string        `json:"label,omitempty"`
-	AllowInconsistent bool          `json:"allowInconsistent,omitempty"`
-	Timeout           time.Duration `json:"timeout,omitempty"`
+	Label string `json:"label,omitempty"`
+
+	Timeout time.Duration `json:"timeout,omitempty"`
+
+	// @deprecated - since 3.10.10 it exists only for backwards compatibility
+	AllowInconsistent bool `json:"allowInconsistent,omitempty"`
 }
 
 // BackupTransferStatus represents all possible states a transfer job can be in

client_admin_backup.go

@@ -174,51 +174,6 @@ func TestBackupCreateWithLabel(t *testing.T) {
 	}
 }
 
-func TestBackupCreateWithAllowInconsistent(t *testing.T) {
-	c := createClient(t, nil)
-	skipIfNoBackup(c, t)
-
-	EnsureVersion(t, context.Background(), c).Enterprise().NotCluster().
-		CheckVersion(BelowPatchRelease("3.7.2")).
-		CheckVersion(BelowPatchRelease("3.6.6"))
-
-	var wg sync.WaitGroup
-	defer func() {
-		wg.Wait()
-	}()
-	b := c.Backup()
-	dbname := "backup_db_test"
-	colname := "backup_query_target"
-
-	// First create a long running transaction
-	db := ensureDatabase(nil, c, dbname, nil, t)
-	ensureCollection(nil, db, colname, nil, t)
-
-	wg.Add(1)
-	go func() {
-		defer wg.Done()
-		if _, err := db.Query(nil, fmt.Sprintf("FOR i IN 1..15 INSERT {s:SLEEP(1)} INTO %s", colname), nil); err != nil {
-			t.Fatalf("Failed to run query: %s", describe(err))
-		}
-	}()
-
-	time.Sleep(time.Second)
-
-	_, _, err := b.Create(nil, &driver.BackupCreateOptions{AllowInconsistent: false, Timeout: 3 * time.Second})
-	if err == nil {
-		t.Fatalf("Creating backup should fail but did not!")
-	}
-
-	_, resp, err := b.Create(nil, &driver.BackupCreateOptions{AllowInconsistent: true, Timeout: 3 * time.Second})
-	if err != nil {
-		t.Fatalf("Failed to create backup: %s", describe(err))
-	}
-
-	if !resp.PotentiallyInconsistent {
-		t.Error("Expected PotentiallyInconsistent to be set to true, but it is not")
-	}
-}
-
 func TestBackupListWithID(t *testing.T) {
 	c := createClient(t, nil)
 	skipIfNoBackup(c, t)

test/backup_test.go

@@ -28,7 +28,9 @@ import (
 	"github.com/stretchr/testify/require"
 )
 
-const defaultTestTimeout = 1 * time.Minute
+// defaultTestTimeout is the default timeout for context use in tests
+// less than 2 minutes is causing problems on CI
+const defaultTestTimeout = 2 * time.Minute
 
 type Timeout func() error