Merge pull request #124 from gatherhealth/master

Fix optparse fallback logic in Django 1.8+

configurations/importer.py

@@ -37,9 +37,10 @@ def create_parser(self, prog_name, subcommand):
                 if isinstance(parser, OptionParser):
                     # in case the option_list is set the create_parser
                     # will actually return a OptionParser for backward
-                    # compatibility. It uses BaseCommand.use_argparse
-                    # to decide that, which checks for the option_list list
-                    base.BaseCommand.option_list += configuration_options
+                    # compatibility. In that case we should tack our
+                    # options on to the end of the parser on the way out.
+                    for option in configuration_options:
+                        parser.add_option(option)
                 else:
                     # probably argparse, let's not import argparse though
                     parser.add_argument(CONFIGURATION_ARGUMENT,

tests/management/commands/old_optparse_command.py

@@ -0,0 +1,16 @@
+from optparse import make_option
+from django.core.management.base import BaseCommand
+
+
+class Command(BaseCommand):
+
+    # Used by a specific test to see how unupgraded
+    # management commands play with configurations.
+    # See the test code for more details.
+
+    option_list = BaseCommand.option_list + (
+        make_option('--arg1', action='store_true'),
+    )
+
+    def handle(self, *args, **options):
+        pass

tests/test_main.py

@@ -2,10 +2,16 @@
 import subprocess
 import sys
 
+from django import VERSION as DJANGO_VERSION
 from django.conf import global_settings
 from django.test import TestCase
 from django.core.exceptions import ImproperlyConfigured
 
+if sys.version_info >= (2, 7):
+    from unittest import skipIf
+else:
+    from django.utils.unittest import skipIf
+
 from mock import patch
 
 from configurations.importer import ConfigurationImporter
@@ -108,3 +114,20 @@ def test_configuration_argument_in_cli(self):
         proc = subprocess.Popen(['django-cadmin', 'runserver', '--help'],
                                 stdout=subprocess.PIPE)
         self.assertIn('--configuration', proc.communicate()[0].decode('utf-8'))
+
+    @skipIf(DJANGO_VERSION >= (1, 10), 'only applies to Django < 1.10')
+    def test_deprecated_option_list_command(self):
+        """
+        Verify that the configuration option is correctly added to any
+        management commands which are still relying on option_list to
+        add their own custom arguments
+
+        Specific test for a pattern which was deprecated in Django 1.8
+        and which will become completely unsupported in Django 1.10.
+        https://docs.djangoproject.com/en/1.8/howto/custom-management-commands/#custom-commands-options
+        """
+        proc = subprocess.Popen(['django-cadmin', 'old_optparse_command', '--help'],
+                                stdout=subprocess.PIPE)
+        output = proc.communicate()[0].decode('utf-8')
+        self.assertIn('--configuration', output)
+        self.assertIn('--arg1', output)