Cleans 'all files also on disk' migration

tracim/migration/versions/913efdf409e5_all_files_also_on_disk.py

@@ -14,17 +14,12 @@ from depot.fields.upload import UploadedFile
 from depot.io.utils import FileIntent
 from depot.manager import DepotManager
 import sqlalchemy as sa
-# from sqlalchemy.ext.declarative import declarative_base
-# from sqlalchemy.orm import sessionmaker
 
 # revision identifiers, used by Alembic.
 revision = '913efdf409e5'
 down_revision = '69fb10c3d6f0'
 
 
-# Session = sessionmaker()
-# DeclarativeBase = declarative_base()
-
 revision_helper = sa.Table(
     'content_revisions',
     sa.MetaData(),
@@ -38,100 +33,32 @@ revision_helper = sa.Table(
 )
 
 
-# class RevisionForMigration(DeclarativeBase):
-#     """Revision of Content for this migration."""
-
-#     __tablename__ = 'content_revisions'
-
-#     revision_id = Column(Integer, primary_key=True)
-
-#     label = Column(Unicode(1024), unique=False, nullable=False)
-#     description = Column(Text(), unique=False, nullable=False, default='')
-#     file_extension = Column(
-#         Unicode(255),
-#         unique=False,
-#         nullable=False,
-#         server_default='',
-#     )
-#     file_mimetype = Column(Unicode(255),  unique=False, nullable=False, default='')
-#     file_content = deferred(Column(LargeBinary(), unique=False, nullable=True))
-#     depot_file = Column(UploadedFileField, unique=False, nullable=True)
-#     properties = Column('properties', Text(), unique=False, nullable=False, default='')
-#     type = Column(Unicode(32), unique=False, nullable=False)
-#     status = Column(Unicode(32), unique=False, nullable=False, default=ContentStatus.OPEN)
-#     created = Column(DateTime, unique=False, nullable=False, default=datetime.utcnow)
-#     updated = Column(DateTime, unique=False, nullable=False, default=datetime.utcnow)
-#     is_deleted = Column(Boolean, unique=False, nullable=False, default=False)
-#     is_archived = Column(Boolean, unique=False, nullable=False, default=False)
-#     is_temporary = Column(Boolean, unique=False, nullable=False, default=False)
-#     revision_type = Column(Unicode(32), unique=False, nullable=False, default='')
-
-#     def file_name(self) -> str:
-#         return '{0}{1}'.format(
-#             self.revision.label,
-#             self.revision.file_extension,
-#         )
-
-
-# def fill_depot_file_fields()
-#     """fills depot file fields when they are null."""
-#     connection = op.get_bind()
-#     session = Session(bind=connection)
-
-#     all_files_wo_depot = session.query(RevisionForMigration) \
-#         .filter_by(type='file', depot_file=None) \
-#         .all()
-#     for one_file_wo_depot in all_files_wo_depot:
-#         # with tempfile.TemporaryFile() as tmp_file:
-#         #     tmp_file.write(one_file_wo_depot.content)
-#         #     one_file_wo_depot.depot_file = tmp_file
-#         one_file_wo_depot.depot_file = (
-#             one_file_wo_depot.content,
-#             one_file_wo_depot.file_name(),
-#             one_file_wo_depot.file_mimetype,
-#         )
-#     session.commit()
-
-
-def upgrade():
-    """Sets depot file for file typed revisions."""
-    import pudb; pu.db
-
-    # INFO - A.P - 2017-07-21 - put all files also on disk
-    # Until now, files are both in database and, for the newly created
-    # ones, on disk. In order to simplify the migration, this procedure
-    # will:
-    # - delete the few files on disk,
-    # - create all files on disk from database.
-
-    connection = op.get_bind()
+def delete_files_on_disk(connection: sa.engine.Connection):
+    """Deletes files from disk and their references in database."""
     delete_query = revision_helper.update() \
         .where(revision_helper.c.type == 'file') \
         .where(revision_helper.c.depot_file.isnot(None)) \
         .values(depot_file=None)
-    delete_result = connection.execute(delete_query)
+    connection.execute(delete_query)
     shutil.rmtree('depot/', ignore_errors=True)
 
-    # Creates files depot used in this migration:
-    # - 'default': depot used until now,
+
+def upgrade():
+    """
+    Sets all depot files for file typed revisions.
+
+    Until now, files are both in database and, for the newly created
+    ones, on disk. In order to simplify the migration, this procedure
+    will:
+    - delete the few files on disk,
+    - create all files on disk from database.
+    """
+    # Creates files depot used in this migration
     DepotManager.configure(
         'tracim', {'depot.storage_path': 'depot/'},
     )
-    # depot = DepotManager.get('default')
-
-    # create_query = revision_helper.update() \
-    #     .where(revision_helper.c.type == 'file') \
-    #     .values(depot_file=
-    #         UploadedFile(
-    #             FileIntent(
-    #                 file_content,
-    #                 '{0}{1}'.format(label, file_extension),
-    #                 file_mimetype,
-    #             )
-    #         )
-    #     )
-    # create_result = connection.execute(create_query)
-
+    connection = op.get_bind()
+    delete_files_on_disk(connection=connection)
     select_query = revision_helper.select() \
         .where(revision_helper.c.type == 'file') \
         .where(revision_helper.c.depot_file.is_(None))
@@ -146,21 +73,15 @@ def upgrade():
             one_file_filename,
             one_file.file_mimetype,
         )
-        depot_file_field = UploadedFile(depot_file_intent, 'default')
-        one_file_update = revision_helper.update() \
-            .where(revision_helper.c.type == 'file') \
+        depot_file_field = UploadedFile(depot_file_intent, 'tracim')
+        update_query = revision_helper.update() \
             .where(revision_helper.c.revision_id == one_file.revision_id) \
             .values(depot_file=depot_file_field) \
             .return_defaults()
-        create_result = connection.execute(one_file_update)
+        connection.execute(update_query)
 
 
 def downgrade():
     """Resets depot file for file typed revisions."""
     connection = op.get_bind()
-    file_revision_query = revision_helper.update() \
-        .where(revision_helper.c.type == 'file') \
-        .where(revision_helper.c.depot_file.isnot(None)) \
-        .values(depot_file=None)
-    result = connection.execute(file_revision_query)
-    shutil.rmtree('depot/', ignore_errors=True)
+    delete_files_on_disk(connection=connection)