Merge lp:~aaron-whitehouse/duplicity/add-additional-verify-tests-for-corrupted-archives into lp:~duplicity-team/duplicity/0.7-series

[Aaron Whitehouse]

Add tests to test_verify.py to test that verify fails if the archive file is corrupted. Changed file objects to use the with keyword to ensure that the file is properly closed.
Small edit to find statement in verify_test.sh to make it work as expected (enclose string in quotes).

[lp:~aaron-whitehouse/duplicity/add-additional-verify-tests-for-corrupted-archives]

1040. By Aaron Whitehouse <email address hidden> on 2014-12-27

Add comments to the verify_test.sh script matching up the tests in there to the tests implemented in test_verify.py. All the tests in the shell script have now been implemented, so the shell script should perhaps be deleted.

=== modified file 'testing/functional/test_verify.py'
--- testing/functional/test_verify.py	2014-12-19 14:17:15 +0000
+++ testing/functional/test_verify.py	2014-12-27 17:43:18 +0000
@@ -37,12 +37,12 @@
 
     def test_verify_changed_source_file(self):
         """Test verify (without --compare-data) gives no error if a source file is changed"""
-        # TODO fix code to make this test pass (Bug #1354880)
+        # This test was made to pass in fixing Bug #1354880
         self.backup("full", "testfiles/various_file_types", options=[])
 
         # Edit source file
-        f = open('testfiles/various_file_types/executable', 'w')
-        f.write('This changes a source file.')
+        with open('testfiles/various_file_types/executable', 'r+') as f:
+            f.write('This changes a source file.')
 
         # Test verify for the file
         self.verify('testfiles/various_file_types/executable', file_to_verify='executable', options=[])
@@ -61,8 +61,8 @@
         self.backup("full", "testfiles/various_file_types", options=[])
 
         # Edit source file
-        f = open('testfiles/various_file_types/executable', 'w')
-        f.write('This changes a source file.')
+        with open('testfiles/various_file_types/executable', 'r+') as f:
+            f.write('This changes a source file.')
 
         # Set the atime and mtime for the file back to what it was prior to the edit
         os.utime('testfiles/various_file_types/executable', (file_info.st_atime, file_info.st_mtime))
@@ -83,8 +83,8 @@
         self.backup("full", "testfiles/various_file_types", options=[])
 
         # Edit source file
-        f = open('testfiles/various_file_types/executable', 'w')
-        f.write('This changes a source file.')
+        with open('testfiles/various_file_types/executable', 'r+') as f:
+            f.write('This changes a source file.')
 
         # Test verify for edited file fails with --compare-data
         try:
@@ -107,8 +107,8 @@
 
         self.backup("full", "testfiles/various_file_types", options=[])
         # Edit source file
-        f = open('testfiles/various_file_types/executable', 'w')
-        f.write('This changes a source file.')
+        with open('testfiles/various_file_types/executable', 'r+') as f:
+            f.write('This changes a source file.')
 
         # Set the atime and mtime for the file back to what it was prior to the edit
         os.utime('testfiles/various_file_types/executable', (file_info.st_atime, file_info.st_mtime))
@@ -122,5 +122,43 @@
         else:
             self.fail('Expected CmdError not thrown')
 
+
+    def test_verify_corrupt_archive(self):
+        """Test verify (without --compare-data) gives an error if the archive is corrupted"""
+        self.backup("full", "testfiles/various_file_types", options=[])
+        output_files = os.listdir("testfiles/output")
+        archives = [elem for elem in output_files if "vol" in elem]
+        for archive in archives:
+            # Edit source file
+            with open("testfiles/output/" + archive, 'r+') as f:
+                f.write('This writes text into each archive file to corrupt it.')
+        # Test verify for the file
+        try:
+            self.verify('testfiles/various_file_types/executable', file_to_verify='executable', options=[])
+        except CmdError as e:
+            # Should return a 21 error code for "hash mismatch"
+            self.assertEqual(e.exit_status, 21, str(e))
+        else:
+            self.fail('Expected Hash Mismatch Error not thrown')
+
+    def test_verify_corrupt_archive_compare_data(self):
+        """Test verify with --compare-data gives an error if the archive is corrupted"""
+        self.backup("full", "testfiles/various_file_types", options=[])
+        output_files = os.listdir("testfiles/output")
+        archives = [elem for elem in output_files if "vol" in elem]
+        for archive in archives:
+            # Edit source file
+            with open("testfiles/output/" + archive, 'r+') as f:
+                f.write('This writes text into each archive file to corrupt it.')
+        # Test verify for the file
+        try:
+            self.verify('testfiles/various_file_types/executable', file_to_verify='executable',
+                        options=["--compare-data"])
+        except CmdError as e:
+            # Should return a 21 error code for "hash mismatch"
+            self.assertEqual(e.exit_status, 21, str(e))
+        else:
+            self.fail('Expected Hash Mismatch Error not thrown')
+
 if __name__ == "__main__":
     unittest.main()

=== modified file 'testing/verify_test.sh'
--- testing/verify_test.sh	2014-12-12 15:29:23 +0000
+++ testing/verify_test.sh	2014-12-27 17:43:18 +0000
@@ -2,6 +2,8 @@
 # Script to show the current behaviour of duplicity's verify action
 # (c) 2014 Aaron Whitehouse <[e-mail]>
 # GPLv2 or any later version
+# These tests have all now been implemented in the test suite (functional/test_verify.py)
+# Perhaps this file should now be removed.
 export PASSPHRASE=test
 
 TESTDIR=/tmp/duplicity_test
@@ -22,12 +24,14 @@
 echo "This is a test" > $SOURCEDIR/test.txt
 $DUPLICITY_CMD $SOURCEDIR file://$TARGETDIR
 echo "-----------"
-echo "Normal verify before we've done anything. This should pass and does" 
+echo "Normal verify before we've done anything. This should pass and does"
 echo "on 0.6.23."
+# Implemented in the test suite as functional/test_verify.py test_verify
 $DUPLICITY_CMD verify file://$TARGETDIR $SOURCEDIR 
 echo "-----------"
 echo "Change the source file after sleeping for a second."
 # Sleep for a second, as otherwise the mtime can be the same even if it was edited after backup.
+# Implemented in the test suite as functional/test_verify.py test_verify_changed_source_file
 sleep 1
 echo "This is changing the test file." > $SOURCEDIR/test.txt
 echo "-----------"
@@ -38,6 +42,7 @@
 echo "check against the filesystem, this should fail and does on 0.6.23."
 echo "Note that this should flag a difference in the Data as well, but does not"
 echo "on 0.6.23, whereas it does so in the Second Test."
+# Implemented in the test suite as functional/test_verify.py test_verify_compare_data_changed_source_file
 $DUPLICITY_CMD verify --compare-data file://$TARGETDIR $SOURCEDIR
 
 rm -r $TESTDIR
@@ -57,7 +62,8 @@
 $DUPLICITY_CMD $SOURCEDIR file://$TARGETDIR
 echo "-----------"
 echo "Normal verify before we've done anything. This should pass and does on 0.6.23."
-$DUPLICITY_CMD verify file://$TARGETDIR $SOURCEDIR 
+# Implemented in the test suite as functional/test_verify.py test_verify
+$DUPLICITY_CMD verify file://$TARGETDIR $SOURCEDIR
 echo "-----------"
 echo "Change the source file after sleeping for a second, but change the mtime to match the original."
 # Sleep for a second, as otherwise the mtime can be the same even if it was edited after backup.
@@ -69,11 +75,13 @@
 touch --reference=$SOURCEDIR/test.txt $SOURCEDIR
 echo "-----------"
 echo "Verify again. This should pass and does on 0.6.23 (though only because it is 'tricked' by the mtime)."
+# Implemented in the test suite as functional/test_verify.py test_verify test_verify_changed_source_file_adjust_mtime
 $DUPLICITY_CMD verify file://$TARGETDIR $SOURCEDIR
 echo "-----------"
 echo "Verify again, but with --compare-data. As --compare-data is designed to" 
 echo "check against the filesystem, this should fail and currently does."
 echo "Note that, unlike the First Test, on 0.6.23 this flags a difference in the Data."
+# Implemented in the test suite as functional/test_verify.py test_verify_compare_data_changed_source_file_adjust_mtime
 $DUPLICITY_CMD verify --compare-data file://$TARGETDIR $SOURCEDIR
 
 rm -r $TESTDIR
@@ -92,16 +100,19 @@
 $DUPLICITY_CMD $SOURCEDIR file://$TARGETDIR
 echo "-----------"
 echo "Normal verify before we've done anything. This should pass and does on 0.6.23."
-$DUPLICITY_CMD verify file://$TARGETDIR $SOURCEDIR 
+# Implemented in the test suite as functional/test_verify.py test_verify
+$DUPLICITY_CMD verify file://$TARGETDIR $SOURCEDIR
 echo "-----------"
 echo "Corrupt the archive."
-find $TARGETDIR -name duplicity-full*.vol* -exec dd if=/dev/urandom of='{}' bs=1024 seek=$((RANDOM%10+1)) count=1 conv=notrunc \; 
+find $TARGETDIR -name 'duplicity-full*.vol*' -exec dd if=/dev/urandom of='{}' bs=1024 seek=$((RANDOM%10+1)) count=1 conv=notrunc \; 
 echo "-----------"
 echo "Verify again. This should fail, as verify should check the integrity of the archive in either mode, and it does on 0.6.23."
+# Implemented in the test suite as functional/test_verify.py test_verify_corrupt_archive
 $DUPLICITY_CMD verify file://$TARGETDIR $SOURCEDIR
 echo "-----------"
 echo "Verify again, but with --compare-data. This should also fail, as verify should check the integrity of the archive"
 echo "in either mode, and it does on 0.6.23."
+# Implemented in the test suite as functional/test_verify.py test_verify_corrupt_archive_compare_data
 $DUPLICITY_CMD verify --compare-data file://$TARGETDIR $SOURCEDIR
 
 rm -r $TESTDIR