PB-1520: Handle some edge cases and add tests for create superuser command

Author: msom

app/support/management/commands/manage_superuser.py

@@ -19,21 +19,27 @@ class Handler(CommandHandler):
 
     def run(self) -> None:
         User = get_user_model()  # pylint: disable=invalid-name
-        username = env.str('DJANGO_SUPERUSER_USERNAME')
-        email = env.str('DJANGO_SUPERUSER_EMAIL')
-        password = env.str('DJANGO_SUPERUSER_PASSWORD')
+        username = env.str('DJANGO_SUPERUSER_USERNAME', default='').strip()
+        email = env.str('DJANGO_SUPERUSER_EMAIL', default='').strip()
+        password = env.str('DJANGO_SUPERUSER_PASSWORD', default='').strip()
+
+        if not username or not email or not password:
+            self.print_error('Environment variables not set or empty')
+            return
 
         try:
             admin = User.objects.get(username=username)
             operation = 'Updated'
         except User.DoesNotExist:
-            admin = User.objects.create(
-                username=username, email=email, is_staff=True, is_superuser=True
-            )
+            admin = User.objects.create(username=username)
             operation = 'Created'
 
         admin.set_password(password)
+        admin.email = email
+        admin.is_staff = True
+        admin.is_superuser = True
         admin.save()
+
         self.print_success('%s the superuser %s', operation, username)
 
 

app/tests/support/test_superuser_command.py

@@ -0,0 +1,73 @@
+from io import StringIO
+from unittest.mock import patch
+
+from django.contrib.auth import get_user_model
+from django.core.management import call_command
+
+
+@patch.dict(
+    'os.environ',
+    {
+        'DJANGO_SUPERUSER_USERNAME': 'admin',
+        'DJANGO_SUPERUSER_EMAIL': '[email protected]',
+        'DJANGO_SUPERUSER_PASSWORD': 'very-secure'
+    }
+)
+def test_command_creates(db):
+    out = StringIO()
+    call_command('manage_superuser', verbosity=2, stdout=out)
+    assert 'Created the superuser admin' in out.getvalue()
+
+    user = get_user_model().objects.filter(username='admin').first()
+    assert user
+    assert user.email == '[email protected]'
+    assert user.check_password('very-secure')
+    assert user.is_staff
+    assert user.is_superuser
+
+
+@patch.dict(
+    'os.environ',
+    {
+        'DJANGO_SUPERUSER_USERNAME': 'admin',
+        'DJANGO_SUPERUSER_EMAIL': '[email protected]',
+        'DJANGO_SUPERUSER_PASSWORD': 'very-secure'
+    }
+)
+def test_command_updates(db):
+    user = get_user_model().objects.create(
+        username='admin', email='[email protected]', is_staff=False, is_superuser=False
+    )
+    user.set_password('not-secure')
+
+    out = StringIO()
+    call_command('manage_superuser', verbosity=2, stdout=out)
+    assert 'Updated the superuser admin' in out.getvalue()
+
+    user = get_user_model().objects.filter(username='admin').first()
+    assert user
+    assert user.email == '[email protected]'
+    assert user.check_password('very-secure')
+    assert user.is_staff
+    assert user.is_superuser
+
+
+def test_fails_if_undefined(db):
+    out = StringIO()
+    call_command('manage_superuser', stderr=out)
+    assert 'Environment variables not set or empty' in out.getvalue()
+    assert get_user_model().objects.count() == 0
+
+
+@patch.dict(
+    'os.environ', {
+        'DJANGO_SUPERUSER_USERNAME': '',
+        'DJANGO_SUPERUSER_EMAIL': '',
+        'DJANGO_SUPERUSER_PASSWORD': ''
+    }
+)
+def test_fails_if_empty(db):
+    out = StringIO()
+    call_command('manage_superuser', stderr=out)
+    assert 'Environment variables not set or empty' in out.getvalue()
+    assert get_user_model().objects.count() == 0