[zookeeper] branch branch-3.5 updated: ZOOKEEPER-4232: InvalidSnapshotTest corrupts its own test data

[ar...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

arshad pushed a commit to branch branch-3.5
in repository https://gitbox.apache.org/repos/asf/zookeeper.git


The following commit(s) were added to refs/heads/branch-3.5 by this push:
     new 082537d  ZOOKEEPER-4232: InvalidSnapshotTest corrupts its own test data
082537d is described below

commit 082537d4685c60419314cce7997d9b137d2d7f46
Author: Damien Diederen <dd...@crosstwine.com>
AuthorDate: Tue Mar 9 22:43:15 2021 +0530

    ZOOKEEPER-4232: InvalidSnapshotTest corrupts its own test data
    
    `InvalidSnapshotTest.testSnapshot` starts an instance of
    `ZooKeeperServer` on the version-controlled `resources/data/invalidsnap`
    directory, which, as a side-effect, \"fixes\" the following
    snapshot—which was broken on purpose (see ZOOKEEPER-367):
    
    `zookeeper-server/src/test/resources/data/invalidsnap/version-2/snapshot.83f`
    
    This status quo creates a number of problems:
    
    1.  It makes the test ineffective after the first run;
    2.  The file shows as modified in version control tools, which can be
        annoying;
    3.  The \"fixed\" snapshot can end up being committed by mistake,
        invalidating the test.
    
    (\#3 is not theoretical; that \"fixed\" snapshot frequently shows up in
    pull requests, and was recently merged into `master`.)
    
    Author: Damien Diederen <dd...@crosstwine.com>
    
    Reviewers: Mohammad Arshad <ar...@apache.org>
    
    Closes #1629 from ztzg/ZOOKEEPER-4232-invalid-snapshot-is-invalid-x-3.5 and squashes the following commits:
    
    528640504 [Damien Diederen] ZOOKEEPER-4232: Ensure that ZOOKEEPER-367 test data fails to parse
    680c57ad2 [Damien Diederen] ZOOKEEPER-4232: Run InvalidSnapshotTest on a copy of test data
---
 .../apache/zookeeper/test/InvalidSnapshotTest.java | 30 +++++++++++++++++++---
 1 file changed, 27 insertions(+), 3 deletions(-)

diff --git a/zookeeper-server/src/test/java/org/apache/zookeeper/test/InvalidSnapshotTest.java b/zookeeper-server/src/test/java/org/apache/zookeeper/test/InvalidSnapshotTest.java
index 7de4c17..7fe69f0 100644
--- a/zookeeper-server/src/test/java/org/apache/zookeeper/test/InvalidSnapshotTest.java
+++ b/zookeeper-server/src/test/java/org/apache/zookeeper/test/InvalidSnapshotTest.java
@@ -21,7 +21,8 @@ package org.apache.zookeeper.test;
 import static org.apache.zookeeper.test.ClientBase.CONNECTION_TIMEOUT;
 
 import java.io.File;
-
+import java.io.IOException;
+import org.apache.commons.io.FileUtils;
 import org.apache.zookeeper.PortAssignment;
 import org.apache.zookeeper.ZKTestCase;
 import org.apache.zookeeper.ZooKeeper;
@@ -75,14 +76,37 @@ public class InvalidSnapshotTest extends ZKTestCase{
         String[] args = {snapfile.getCanonicalFile().toString()};
         SnapshotFormatter.main(args);
     }
-    
+
+    /**
+     * Verify the SnapshotFormatter fails as expected on corrupted snapshot.
+     */
+    @Test
+    public void testSnapshotFormatterWithInvalidSnap() throws Exception {
+        File snapDir = new File(testData, "invalidsnap");
+        // Broken snapshot introduced by ZOOKEEPER-367, and used to
+        // demonstrate recovery in testSnapshot below.
+        File snapfile = new File(new File(snapDir, "version-2"), "snapshot.83f");
+        String[] args = {snapfile.getCanonicalFile().toString()};
+        try {
+            SnapshotFormatter.main(args);
+            Assert.fail("Snapshot '" + snapfile + "' unexpectedly parsed without error.");
+        } catch (IOException e) {
+            Assert.assertTrue(e.getMessage().contains("Unreasonable length = 977468229"));
+        }
+    }
+
     /**
      * test the snapshot
      * @throws Exception an exception could be expected
      */
     @Test
     public void testSnapshot() throws Exception {
-        File snapDir = new File(testData, "invalidsnap");
+        File origSnapDir = new File(testData, "invalidsnap");
+
+        // This test otherwise updates the resources directory.
+        File snapDir = ClientBase.createTmpDir();
+        FileUtils.copyDirectory(origSnapDir, snapDir);
+
         ZooKeeperServer zks = new ZooKeeperServer(snapDir, snapDir, 3000);
         SyncRequestProcessor.setSnapCount(1000);
         final int PORT = Integer.parseInt(HOSTPORT.split(":")[1]);