Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Fixed #22299 -- Cleanup wizard temp files when possible.

Thanks to @erikr for the review.
  • Loading branch information...
commit fa8b4735287c92b03d23823de8a4e1168d1951d9 1 parent b66e853
@charettes charettes authored
View
23 django/contrib/formtools/tests/wizard/storage.py
@@ -1,10 +1,17 @@
from datetime import datetime
from importlib import import_module
+import os
+import tempfile
from django.http import HttpRequest
from django.conf import settings
-
from django.contrib.auth.models import User
+from django.core.files.storage import FileSystemStorage
+from django.core.files.uploadedfile import SimpleUploadedFile
+
+
+temp_storage_location = tempfile.mkdtemp(dir=os.environ.get('DJANGO_TEST_TEMP_DIR'))
+temp_storage = FileSystemStorage(location=temp_storage_location)
def get_request():
@@ -85,3 +92,17 @@ def test_extra_context_key_persistence(self):
storage.extra_data['test'] = True
self.assertTrue('test' in storage.extra_data)
+
+ def test_reset_deletes_tmp_files(self):
+ request = get_request()
+ storage = self.get_storage()('wizard1', request, temp_storage)
+
+ step = 'start'
+ file_ = SimpleUploadedFile('file.txt', b'content')
+ storage.set_step_files(step, {'file': file_})
+
+ tmp_name = storage.get_step_files(step)['file'].name
+ self.assertTrue(storage.file_storage.exists(tmp_name))
+
+ storage.reset()
+ self.assertFalse(storage.file_storage.exists(tmp_name))
View
5 django/contrib/formtools/wizard/storage/base.py
@@ -26,6 +26,11 @@ def init_data(self):
}
def reset(self):
+ # Delete temporary files before breaking reference to them.
+ wizard_files = self.data[self.step_files_key]
+ for step_files in six.itervalues(wizard_files):
+ for step_file in six.itervalues(step_files):
+ self.file_storage.delete(step_file['tmp_name'])
self.init_data()
def _get_current_step(self):
View
6 docs/ref/contrib/formtools/form-wizard.txt
@@ -629,9 +629,9 @@ storage class <builtin-fs-storage>`)::
.. warning::
- Please remember to take care of removing old files as the
- :class:`WizardView` won't remove any files, whether the wizard gets
- finished correctly or not.
+ Please remember to take care of removing old temporary files, as the
+ :class:`WizardView` will only remove these files if the wizard finishes
+ correctly.
Conditionally view/skip specific steps
======================================
Please sign in to comment.
Something went wrong with that request. Please try again.