From 87beb8336fe6b2b2f866f614cad472fa55d91d4a Mon Sep 17 00:00:00 2001
From: Jingyi Hu <jingyih@google.com>
Date: Wed, 3 Oct 2018 15:15:29 -0700
Subject: [PATCH] clientv3: add test for snapshot status

Add unit test to check if we can correctly identify a corrupted snapshot
backup file.
---
 .../snapshot/testdata/corrupted_backup.db     | Bin 0 -> 53248 bytes
 clientv3/snapshot/v3_snapshot_test.go         |  26 ++++++++++++++++++
 2 files changed, 26 insertions(+)
 create mode 100644 clientv3/snapshot/testdata/corrupted_backup.db

diff --git a/clientv3/snapshot/testdata/corrupted_backup.db b/clientv3/snapshot/testdata/corrupted_backup.db
new file mode 100644
index 0000000000000000000000000000000000000000..d4ab10ef79eae18d5554e61d14e2c440011fe8ce
GIT binary patch
literal 53248
zcmeI&&r1|x7{Kv$wM?@zBIpt=16@LNX5MjkX0HW#h#)~B!erc?#ijiryQ^8@pU|a4
z1tHX_TTl=l%ReCK?5$ID5V{GSdfuIP$XsnDge1SOzWdJe{+Rcj&#c1iyQx&1`b@dG
zF|?W1$HQ?&``EPUqSqWBGv%NuFMoOS>eR*M=O&~;009ILKmY**5I_I{1Q0*~fkPzF
zW7hJw&;KWr@y|Xy?VDbCaELCAr67O+0tg_000IagfB*srAb@}oNcQ*Bsdy(}e;)8s
zvfkg%NY?Rt$@=qwYbM^5azJv%#K)!6_V|*-{nB>TwBMFke{bNHiB~1we*Sl+|2HY+
zH}yn1pOG?S`oEP}&p#nKtb~oKl)I+nV#3AN{H`6OGTojcZq?s$7?ONKvK})TEtQ+)
zdM$2E^|b5im8fYdI*RQRPBo)O*N%nCVzU)BI!<INb}sI;)N3g-Y+7cJ<*89MYTt|Y
z{H$f?S<cEC%-1>eJn32es?%U^sa_vWUr1+quJq1@jY<?YqqwQ_HM!PmRGs_dmFim^
zCtC_V@qH7&HgU4@jNEPAu4CVIoRU+tOIfd^+-&g3Di^JMpmOfG@||3uTzA|LeA^kZ
z7NV#zHF=|H<?mSYt=2+*Y|L?Uqqh7wdB;`0ZOx2WwXhmld8=G2HA2T4u?m%PRBP=y
z&Q-a<npp{)xq>RFz%R|Ig5zc5WjOY@?I`7Cy}<TdKj-HHyURM<-PYmmV;yE8rJ^UN
z$OWZhIBrLtZx-UaUf}q-td|WO*HOO2T^6EtTZrnu5E<7NG53465moC;QPJGWj^fwb
zqZM{Enu?uoOnvY5-(I0!YnJ8jqSl%%*NV}y>8}5$kPtus0R#|0009ILK;Ym6l83cn
zc`()~iIei+X5vf;Ab<b@2q1s}0tg_000Iag@UH~)zPe6n^W?Ah-}Sbw-oMXC*70@8
z+vB?uC;RhVH?*a%q^_IBzjfR1USm9nR|F71009ILKmY**5I_I{1Q6&V@M569XKiij
z^QVcM8(R<aAJ>1BXV<@ee>}LAKR0t;t#%nsGXe-8fB*srAb<b@2q1s}0tg_000Iag
zfB*srAb<b@2q1s}0tg_000IagfB*srAb<b@2q1s}0tg_000IagfB*srAb<b@2q1s}
z0tg_000IagfB*srAb<b@2q1s}0tg_000IagfB*srAb<b@2q1s}0tg_000IagfB*sr
zAb<b@2q1s}0!Kn%$Xw-cD&0QnHE~jZBoMer1Q0*~0R#|0009ILKmY**{&Rt!zYWzP

literal 0
HcmV?d00001

diff --git a/clientv3/snapshot/v3_snapshot_test.go b/clientv3/snapshot/v3_snapshot_test.go
index cd63cdfb0..8d2ee9d6a 100644
--- a/clientv3/snapshot/v3_snapshot_test.go
+++ b/clientv3/snapshot/v3_snapshot_test.go
@@ -21,6 +21,7 @@ import (
 	"net/url"
 	"os"
 	"path/filepath"
+	"strings"
 	"testing"
 	"time"
 
@@ -161,6 +162,31 @@ func TestSnapshotFilePermissions(t *testing.T) {
 	}
 }
 
+// TestCorruptedBackupFileCheck tests if we can correctly identify a corrupted backup file.
+func TestCorruptedBackupFileCheck(t *testing.T) {
+	dbPath := "testdata/corrupted_backup.db"
+	if _, err := os.Stat(dbPath); err != nil {
+		t.Fatalf("test file [%s] does not exist: %v", dbPath, err)
+	}
+
+	sp := NewV3(zap.NewExample())
+	_, err := sp.Status(dbPath)
+	expectedErrKeywords := "snapshot file integrity check failed"
+	/* example error message:
+	snapshot file integrity check failed. 2 errors found.
+	page 3: already freed
+	page 4: unreachable unfreed
+	*/
+	if err == nil {
+		t.Error("expected error due to corrupted snapshot file, got no error")
+	}
+	if !strings.Contains(err.Error(), expectedErrKeywords) {
+		t.Errorf("expected error message to contain the following keywords:\n%s\n"+
+			"actual error message:\n%s",
+			expectedErrKeywords, err.Error())
+	}
+}
+
 type kv struct {
 	k, v string
 }