Drop support of creating zip backup.

ideascube/conf/base.py

@@ -338,6 +338,6 @@
 
 
 SESSION_COOKIE_AGE = 60 * 60  # Members must be logged out after one hour
-BACKUP_FORMAT = 'zip'  # One of 'zip', 'tar', 'bztar', 'gztar'
+BACKUP_FORMAT = 'gztar'  # One of 'tar', 'bztar', 'gztar'
 CATALOG_CACHE_BASE_DIR = '/var/cache/ideascube/catalog'
 TAGGIT_CASE_INSENSITIVE = True

ideascube/serveradmin/backup.py

@@ -11,9 +11,8 @@
 from ideascube import __version__
 
 
-def make_name(format=None):
+def make_name(format):
     """Return backup formatted file name."""
-    format = format or Backup.FORMAT
     basename = '-'.join([
         settings.IDEASCUBE_ID,
         __version__,
@@ -25,6 +24,7 @@ def make_name(format=None):
 class Backup(object):
 
     FORMAT = settings.BACKUP_FORMAT
+    SUPPORTED_FORMATS_AT_CREATION = ('bztar', 'gztar', 'tar')
     SUPPORTED_FORMATS = ('zip', 'bztar', 'gztar', 'tar')
     SUPPORTED_EXTENSIONS = ('.zip', '.tar.bz2', '.tar.gz', '.tar')
     FORMAT_TO_EXTENSION = dict(zip(SUPPORTED_FORMATS, SUPPORTED_EXTENSIONS))
@@ -75,6 +75,9 @@ def format(self):
 
     def save(self):
         """Make a backup of the server data."""
+        if self.format == 'zip':
+            raise ValueError(_("Zip is no more supported to create backup"))
+
         return shutil.make_archive(
             base_name=os.path.join(Backup.ROOT, self.basename),  # W/o ext.
             format=self.format,
@@ -113,6 +116,11 @@ def delete(self):
 
     @classmethod
     def create(cls, format=None):
+        format = format or Backup.FORMAT
+        if format not in Backup.SUPPORTED_FORMATS_AT_CREATION:
+            raise ValueError(
+                _("Format {} is not supported at creation").format(format)
+            )
         name = make_name(format)
         backup = Backup(name)
         backup.save()
@@ -136,15 +144,25 @@ def list(cls):
     @classmethod
     def load(cls, file_):
         name = os.path.basename(file_.name)
-        if name.endswith('.zip'):
-            if not zipfile.is_zipfile(file_):
-                raise ValueError(_("Not a zip file"))
-        elif not tarfile.is_tarfile(file_.name):
-            raise ValueError(_("Not a tar file"))
-        file_.seek(0)  # Reset cursor.
         backup = Backup(name)
         with open(backup.path, mode='wb') as f:
-            f.write(file_.read())
+           try:
+               for chunk in file_.chunks():
+                   f.write(chunk)
+           except AttributeError:
+               # file_ as no chunks,
+               # read without them.
+               while True:
+                   content = file_.read(4096)
+                   if not content:
+                       break
+                   f.write(content)
+        if not ((name.endswith('.zip') and zipfile.is_zipfile(backup.path))
+             or tarfile.is_tarfile(backup.path)
+               ):
+            os.unlink(backup.path)
+            raise ValueError(_("Not a {} file").format(
+                                 'zip' if name.endswith('.zip') else 'tar'))
         return backup
 
     @classmethod

ideascube/serveradmin/management/commands/backup.py

@@ -21,27 +21,30 @@ def add_arguments(self, parser):
                             '"add", "delete" or "restore" action.')
         parser.add_argument('--format', default=None,
                             help='Backup file format. Possible values: {}'
-                                 'Default: {}'.format(Backup.SUPPORTED_FORMATS,
+                                 'Default: {}'.format(Backup.SUPPORTED_FORMATS_AT_CREATION,
                                                       Backup.FORMAT))
 
     def handle(self, *args, **options):
         format = options['format']
-        if format and format not in Backup.SUPPORTED_FORMATS:
+        action = options['action']
+        supported_formats = (Backup.SUPPORTED_FORMATS_AT_CREATION
+                                if action == 'create'
+                                else Backup.SUPPORTED_FORMATS )
+        if format and format not in supported_formats:
             self.stderr.write('Unsupported format: {}'.format(format))
             sys.exit(1)
-        action = options['action']
         reference = options['reference']
         interactive = options.get('interactive')
         if action == 'list':
             self.stdout.write('* Available backups:')
             for backup in Backup.list():
                 self.stdout.write(str(backup))
         elif action == 'create':
-            backup = Backup.create(format=options['format'])
+            backup = Backup.create(format=format)
             self.stdout.write('Succesfully created backup {}'.format(backup))
         elif action == 'add':
             if not reference:
-                self.stderr.write('Missing path to zip backup to add.')
+                self.stderr.write('Missing path to archive backup to add.')
                 sys.exit(1)
             if not os.path.exists(reference):
                 self.stderr.write('File not found {}'.format(reference))

ideascube/serveradmin/tests/conftest.py

@@ -9,4 +9,4 @@
 def backup(monkeypatch):
     monkeypatch.setattr('ideascube.serveradmin.backup.Backup.ROOT', DATA_ROOT)
     # ZIP file should be shipped by git in serveradmin/tests/data
-    return Backup('musasa-0.1.0-201501241620.zip')
+    return Backup('musasa-0.1.0-201501241620.tar.gz')

ideascube/serveradmin/tests/test_backup.py

@@ -1,6 +1,5 @@
 import os
 import tarfile
-import zipfile
 
 import pytest
 
@@ -19,7 +18,7 @@ def test_backup_init_should_raise_with_malformatted_string():
 
 
 def test_underscore_as_separator_should_still_be_supported():
-    Backup('edoardo-0.0.0-201501231405.zip')
+    Backup('edoardo-0.0.0-201501231405.tar.gz')
 
 
 @pytest.mark.parametrize('input,expected', [
@@ -36,9 +35,9 @@ def test_list(monkeypatch, settings):
     monkeypatch.setattr('ideascube.serveradmin.backup.Backup.ROOT',
                         BACKUPS_ROOT)
     settings.DATETIME_FORMAT = 'Y'
-    filename = 'edoardo-0.0.0-201501231405.zip'
+    filename = 'edoardo-0.0.0-201501231405.tar'
     good = os.path.join(BACKUPS_ROOT, filename)
-    bad = os.path.join(BACKUPS_ROOT, 'donotlistme.zip')
+    bad = os.path.join(BACKUPS_ROOT, 'donotlistme.tar')
     try:
         os.makedirs(BACKUPS_ROOT)
     except OSError:
@@ -53,35 +52,6 @@ def test_list(monkeypatch, settings):
     os.rmdir(BACKUPS_ROOT)
 
 
-def test_create_zipfile(monkeypatch, settings):
-    settings.BACKUPED_ROOT = BACKUPED_ROOT
-    try:
-        os.makedirs(BACKUPED_ROOT)
-    except OSError:
-        pass
-    filename = 'edoardo-0.0.0-201501231405.zip'
-    filepath = os.path.join(BACKUPS_ROOT, filename)
-    try:
-        # Make sure it doesn't exist before running backup.
-        os.remove(filepath)
-    except OSError:
-        pass
-    monkeypatch.setattr('ideascube.serveradmin.backup.Backup.FORMAT', 'zip')
-    monkeypatch.setattr('ideascube.serveradmin.backup.Backup.ROOT',
-                        BACKUPS_ROOT)
-    monkeypatch.setattr('ideascube.serveradmin.backup.make_name',
-                        lambda f: filename)
-    proof_file = os.path.join(settings.BACKUPED_ROOT, 'backup.me')
-    open(proof_file, mode='w')
-    Backup.create()
-    assert os.path.exists(filepath)
-    assert zipfile.is_zipfile(filepath)
-    archive = zipfile.ZipFile(filepath)
-    assert 'backup.me' in archive.namelist()
-    os.remove(filepath)
-    os.remove(proof_file)
-
-
 @pytest.mark.parametrize('format,extension', [
     ('tar', '.tar'),
     ('bztar', '.tar.bz2'),
@@ -117,6 +87,15 @@ def test_create_tarfile(monkeypatch, settings, format, extension):
     os.remove(proof_file)
 
 
+def test_create_zipfile_must_fail(monkeypatch, tmpdir):
+    monkeypatch.setattr('ideascube.serveradmin.backup.Backup.ROOT', str(tmpdir))
+    monkeypatch.setattr('ideascube.serveradmin.backup.Backup.FORMAT', 'zip')
+    assert len(list(Backup.list())) == 0
+    with pytest.raises(ValueError) as excinfo:
+        Backup.create()
+    assert len(list(Backup.list())) == 0
+
+
 @pytest.mark.parametrize('extension', [
     ('.zip'),
     ('.tar'),
@@ -154,10 +133,16 @@ def test_load(monkeypatch, extension):
     os.remove(backup_path)
 
 
-def test_delete(monkeypatch):
+@pytest.mark.parametrize('extension', [
+    ('.zip'),
+    ('.tar'),
+    ('.tar.gz'),
+    ('.tar.bz2'),
+])
+def test_delete(monkeypatch, extension):
     monkeypatch.setattr('ideascube.serveradmin.backup.Backup.ROOT',
                         BACKUPS_ROOT)
-    backup_name = 'musasa-0.1.0-201501241620.zip'
+    backup_name = 'musasa-0.1.0-201501241620' + extension
     backup_path = os.path.join(BACKUPS_ROOT, backup_name)
     assert not os.path.exists(backup_path)
     with open(os.path.join(DATA_ROOT, backup_name), mode='rb') as f:
@@ -170,13 +155,13 @@ def test_delete(monkeypatch):
 def test_delete_should_not_fail_if_file_is_missing(monkeypatch):
     monkeypatch.setattr('ideascube.serveradmin.backup.Backup.ROOT',
                         BACKUPS_ROOT)
-    backup = Backup('doesnotexist-0.1.0-201501241620.zip')
+    backup = Backup('doesnotexist-0.1.0-201501241620.tar')
     backup.delete()
 
 
 def test_load_should_raise_if_file_is_not_a_zip():
     with pytest.raises(ValueError) as excinfo:
-        Backup.load(ContentFile('xxx', name='musasa_0.1.0_201501241620.zip'))
+        Backup.load(ContentFile(b'xxx', name='musasa_0.1.0_201501241620.zip'))
         assert 'Not a zip file' in str(excinfo.value)
 
 
@@ -191,5 +176,5 @@ def test_load_should_raise_if_file_is_not_a_tar():
 
 def test_exists(monkeypatch, settings):
     monkeypatch.setattr('ideascube.serveradmin.backup.Backup.ROOT', DATA_ROOT)
-    assert Backup.exists('musasa-0.1.0-201501241620.zip')
-    assert not Backup.exists('doesnotexist.zip')
+    assert Backup.exists('musasa-0.1.0-201501241620.tar')
+    assert not Backup.exists('doesnotexist.tar')

ideascube/serveradmin/tests/test_views.py

@@ -1,7 +1,7 @@
 from io import BytesIO
 import os
 import shutil
-import zipfile
+import tarfile
 
 import pytest
 from webtest.forms import Checkbox, Upload
@@ -231,20 +231,20 @@ def test_backup_should_list_available_backups(staffapp, backup):
     form = staffapp.get(reverse('server:backup')).forms['backup']
     radio_options = form.get('backup').options
     assert len(radio_options) == 4
-    assert radio_options[3][0] == backup.name
+    assert radio_options[2][0] == backup.name
 
 
 def test_backup_button_should_save_a_new_backup(staffapp, monkeypatch,
                                                 settings):
-    monkeypatch.setattr('ideascube.serveradmin.backup.Backup.FORMAT', 'zip')
+    monkeypatch.setattr('ideascube.serveradmin.backup.Backup.FORMAT', 'gztar')
     settings.BACKUPED_ROOT = BACKUPED_ROOT
     try:
         os.makedirs(BACKUPED_ROOT)
     except OSError:
         pass
     if os.path.exists(BACKUPS_ROOT):
         shutil.rmtree(BACKUPS_ROOT)
-    filename = 'edoardo-0.0.0-201501231405.zip'
+    filename = 'edoardo-0.0.0-201501231405.tar.gz'
     filepath = os.path.join(BACKUPS_ROOT, filename)
     try:
         # Make sure it doesn't exist before running backup.
@@ -260,9 +260,9 @@ def test_backup_button_should_save_a_new_backup(staffapp, monkeypatch,
     form = staffapp.get(reverse('server:backup')).forms['backup']
     form.submit('do_create')
     assert os.path.exists(filepath)
-    assert zipfile.is_zipfile(filepath)
-    archive = zipfile.ZipFile(filepath)
-    assert 'backup.me' in archive.namelist()
+    assert tarfile.is_tarfile(filepath)
+    archive = tarfile.open(filepath)
+    assert './backup.me' in archive.getnames()
     os.remove(filepath)
     os.remove(proof_file)
 
@@ -282,19 +282,22 @@ def test_restore_button_should_restore(staffapp, monkeypatch, settings,
     os.remove(dbpath)
 
 
-def test_download_button_should_download_zip_file(staffapp, backup):
+def test_download_button_should_download_tar_file(staffapp, backup, tmpdir):
     form = staffapp.get(reverse('server:backup')).forms['backup']
     form['backup'] = backup.name
     resp = form.submit('do_download')
     assert backup.name in resp['Content-Disposition']
-    assert zipfile.is_zipfile(ContentFile(resp.content))
+    archive_name = os.path.join(str(tmpdir), 'backup.tar')
+    with open(archive_name, mode="wb") as f:
+        f.write(resp.content)
+    assert tarfile.is_tarfile(archive_name)
 
 
 def test_delete_button_should_remove_file(staffapp, backup):
     assert len(os.listdir(DATA_ROOT)) == 4
     with open(backup.path, mode='rb') as f:
         other = Backup.load(ContentFile(f.read(),
-                            name='kavumu-0.1.0-201401241620.zip'))
+                            name='kavumu-0.1.0-201401241620.tar.gz'))
     assert len(os.listdir(DATA_ROOT)) == 5
     form = staffapp.get(reverse('server:backup')).forms['backup']
     form['backup'] = other.name
@@ -308,7 +311,7 @@ def test_upload_button_create_new_backup_with_uploaded_file(staffapp,
                         BACKUPS_ROOT)
     if os.path.exists(BACKUPS_ROOT):
         shutil.rmtree(BACKUPS_ROOT)
-    backup_name = 'musasa-0.1.0-201501241620.zip'
+    backup_name = 'musasa-0.1.0-201501241620.tar.gz'
     backup_path = os.path.join(BACKUPS_ROOT, backup_name)
     assert not os.path.exists(backup_path)
     with open(os.path.join(DATA_ROOT, backup_name), mode='rb') as f:
@@ -319,11 +322,11 @@ def test_upload_button_create_new_backup_with_uploaded_file(staffapp,
         os.remove(backup_path)
 
 
-def test_upload_button_do_not_create_backup_with_non_zip_file(staffapp,
+def test_upload_button_do_not_create_backup_with_non_tar_file(staffapp,
                                                               monkeypatch):
     monkeypatch.setattr('ideascube.serveradmin.backup.Backup.ROOT',
                         BACKUPS_ROOT)
-    backup_name = 'musasa-0.1.0-201501241620.zip'
+    backup_name = 'musasa-0.1.0-201501241620.tar'
     backup_path = os.path.join(BACKUPS_ROOT, backup_name)
     assert not os.path.exists(backup_path)
     form = staffapp.get(reverse('server:backup')).forms['backup']
@@ -337,12 +340,12 @@ def test_upload_button_do_not_create_backup_with_bad_file_name(staffapp,
                                                                monkeypatch):
     monkeypatch.setattr('ideascube.serveradmin.backup.Backup.ROOT',
                         BACKUPS_ROOT)
-    backup_name = 'musasa-0.1.0-201501241620.zip'
+    backup_name = 'musasa-0.1.0-201501241620.tar'
     backup_path = os.path.join(BACKUPS_ROOT, backup_name)
     assert not os.path.exists(backup_path)
     with open(os.path.join(DATA_ROOT, backup_name), mode='rb') as f:
         form = staffapp.get(reverse('server:backup')).forms['backup']
-        form['upload'] = Upload('badname.zip', f.read())
+        form['upload'] = Upload('badname.tar', f.read())
         resp = form.submit('do_upload')
         assert resp.status_code == 200
         assert not os.path.exists(backup_path)