Import page: fix wizard form (#7702)

The initial data is set at the class level,
this means it doesn't survive for the next form.
I'm using the same method the wizard uses to store information per
session.

This doesn't mean the data is always set as default after saving,
it means the default values are going to be set when the user
is in the advanced form.

So, due to that I have moved the default_branch field to the
basic form, this way the form will always have the default branch.

Author: stsewd

readthedocs/projects/forms.py

@@ -85,7 +85,7 @@ class ProjectBasicsForm(ProjectForm):
 
     class Meta:
         model = Project
-        fields = ('name', 'repo', 'repo_type')
+        fields = ('name', 'repo', 'repo_type', 'default_branch')
 
     remote_repository = forms.CharField(
         widget=forms.HiddenInput(),
@@ -166,7 +166,6 @@ class Meta:
         fields = (
             'description',
             'documentation_type',
-            'default_branch',
             'language',
             'programming_language',
             'tags',

readthedocs/projects/views/private.py

@@ -245,14 +245,40 @@ class ImportWizardView(
         SessionWizardView,
 ):
 
-    """Project import wizard."""
+    """
+    Project import wizard.
+
+    The get and post methods are overridden in order to save the initial_dict data
+    per session (since it's per class).
+    """
 
     form_list = [
         ('basics', ProjectBasicsForm),
         ('extra', ProjectExtraForm),
     ]
     condition_dict = {'extra': lambda self: self.is_advanced()}
 
+    initial_dict_key = 'initial-data'
+
+    def get(self, *args, **kwargs):
+        # The method from the parent should run first,
+        # as the storage is initialized there.
+        response = super().get(*args, **kwargs)
+        self._set_initial_dict()
+        return response
+
+    def _set_initial_dict(self):
+        """Set or restore the initial_dict from the session."""
+        if self.initial_dict:
+            self.storage.data[self.initial_dict_key] = self.initial_dict
+        else:
+            self.initial_dict = self.storage.data.get(self.initial_dict_key, {})
+
+    def post(self, *args, **kwargs):
+        self._set_initial_dict()
+        # The storage is reset after everything is done.
+        return super().post(*args, **kwargs)
+
     def get_form_kwargs(self, step=None):
         """Get args to pass into form instantiation."""
         kwargs = {}
@@ -417,7 +443,7 @@ def get(self, request, *args, **kwargs):
     def post(self, request, *args, **kwargs):
         initial_data = {}
         initial_data['basics'] = {}
-        for key in ['name', 'repo', 'repo_type', 'remote_repository']:
+        for key in ['name', 'repo', 'repo_type', 'remote_repository', 'default_branch']:
             initial_data['basics'][key] = request.POST.get(key)
         initial_data['extra'] = {}
         for key in ['description', 'project_url']:

readthedocs/rtd_tests/tests/test_project_views.py

@@ -111,6 +111,7 @@ def test_form_import_from_remote_repo(self):
             'repo': 'https://github.com/fail/sauce',
             'repo_type': 'git',
             'remote_repository': '1234',
+            'default_branch': 'main',
         }
         resp = self.client.post(
             '/dashboard/import/',
@@ -177,6 +178,41 @@ def setUp(self):
             'tags': 'foo, bar, baz',
         }
 
+    def test_initial_params(self):
+        extra_initial = {
+            'description': 'An amazing project',
+            'project_url': "https://foo.bar",
+        }
+        basic_initial = {
+            'name': 'foobar',
+            'repo': 'https://github.com/foo/bar',
+            'repo_type': 'git',
+            'default_branch': 'main',
+            'remote_repository': '',
+        }
+        initial = dict(**extra_initial, **basic_initial)
+        self.client.force_login(self.user)
+
+        # User selects a remote repo to import.
+        resp = self.client.post(reverse('projects_import'), initial)
+
+        # The correct initial data for the basic form is set.
+        form = resp.context_data['form']
+        self.assertEqual(form.initial, basic_initial)
+
+        # User selects advanced.
+        basic_initial['advanced'] = True
+        step_data = {
+            f'basics-{k}': v
+            for k, v in basic_initial.items()
+        }
+        step_data[f'{self.wizard_class_slug}-current_step'] = 'basics'
+        resp = self.client.post(self.url, step_data)
+
+        # The correct initial data for the advanced form is set.
+        form = resp.context_data['form']
+        self.assertEqual(form.initial, extra_initial)
+
     def test_form_pass(self):
         """Test all forms pass validation."""
         resp = self.post_step('basics')