Add management command to change Kiwi TCMS domain

Closes #971

docs/source/admin.rst

@@ -14,20 +14,6 @@ user to add, edit and delete records in the database.
 
 |The Administration screen|
 
-.. _configure-kiwi-base-url:
-
-Configure Kiwi's base URL
--------------------------
-
-The first step you need to do is configure the base URL of your Kiwi TCMS
-installation. This is used to construct links to test plans, test cases, etc.
-The default value is ``127.0.0.1:8000`` which is suitable if you are running
-in devel mode. To update the setting go to
-``https://<your_domain_or_ip>/admin/sites/site/1/``!
-Update **Domain name** to the fully qualified domain name or IP address,
-including port if necessary and click the Save button!
-
-|Base URL configuration|
 
 .. _configure-bug-trackers:
 
@@ -398,7 +384,6 @@ For this purpose the following fields are available:
       within a certain wight group Kiwi TCMS will crash!
 
 
-.. |Base URL configuration| image:: ./_static/Configure_base_url.png
 .. |The Administration screen| image:: ./_static/Admin_Home.png
 .. |The Auth screen| image:: ./_static/Auth_Home.png
 .. |The Admin menu 1| image:: ./_static/Click_Auth.png

docs/source/configuration.rst

@@ -10,7 +10,7 @@ to update some of them for your particular production environment.
 
     After adjusting settings for your environment you have to configure
     Kiwi TCMS via its web interface! As a minimum you have to
-    :ref:`configure-kiwi-base-url` and :ref:`configure-bug-trackers`!
+    :ref:`configure-kiwi-domain` and :ref:`configure-bug-trackers`!
 
 .. note::
 

docs/source/installing_docker.rst

@@ -79,6 +79,28 @@ You need to create the database schema by executing::
         docker exec -it kiwi_web /Kiwi/manage.py createsuperuser
 
 
+.. _configure-kiwi-domain:
+
+Configuration of Kiwi TCMS domain
+---------------------------------
+
+The first step you need to do is to configure the domain of your Kiwi TCMS
+installation. This is used to construct links to test plans, test cases, etc.
+The default value is ``127.0.0.1:8000`` which is suitable if you are running
+in devel mode. The easiest and automation-friendly way to set the domain is
+to use the command line tool::
+
+    docker exec -it kiwi_web /Kiwi/manage.py set_domain public.tenant.kiwitcms.org
+
+
+To update the setting using web interface go to
+``https://<your_domain_or_ip>/admin/sites/site/1/``!
+Update **Domain name** to the fully qualified domain name or IP address,
+including port if necessary and click the Save button!
+
+|Domain configuration|
+
+
 Upgrading
 ---------
 
@@ -340,3 +362,6 @@ the default 500 error page.
 
 When reporting issues please copy the relevant traceback as plain text into
 your reports!
+
+
+.. |Domain configuration| image:: ./_static/Configure_domain.png

docs/source/modules/tcms.core.management.commands.domain.rst

@@ -0,0 +1,7 @@
+tcms.core.management.commands.domain module
+===========================================
+
+.. automodule:: tcms.core.management.commands.domain
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/modules/tcms.core.management.commands.rst

@@ -0,0 +1,15 @@
+tcms.core.management.commands package
+=====================================
+
+.. automodule:: tcms.core.management.commands
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   tcms.core.management.commands.set_domain

docs/source/modules/tcms.core.management.commands.set_domain.rst

@@ -0,0 +1,7 @@
+tcms.core.management.commands.set\_domain module
+================================================
+
+.. automodule:: tcms.core.management.commands.set_domain
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/modules/tcms.core.management.rst

@@ -0,0 +1,15 @@
+tcms.core.management package
+============================
+
+.. automodule:: tcms.core.management
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   tcms.core.management.commands

docs/source/modules/tcms.core.rst

@@ -15,6 +15,7 @@ Subpackages
    tcms.core.contrib
    tcms.core.forms
    tcms.core.helpers
+   tcms.core.management
    tcms.core.models
    tcms.core.templatetags
    tcms.core.utils

tcms/core/management/commands/set_domain.py

@@ -0,0 +1,25 @@
+from django.conf import settings
+from django.contrib.sites.models import Site
+from django.core.management.base import BaseCommand
+
+
+class Command(BaseCommand):
+    help = ("Sets the domain of Kiwi TCMS instance. "
+            "If no arguments given returns current domain."
+            )
+
+    def add_arguments(self, parser):
+        parser.add_argument(
+            'domain', nargs='?', default=None,
+            help='The domain of Kiwi TCMS instance',
+        )
+
+    def handle(self, *args, **kwargs):
+        site = Site.objects.get(id=settings.SITE_ID)
+        if not kwargs['domain']:
+            self.stdout.write('%s' % (site.domain))
+            return
+        site.domain = kwargs['domain']
+        site.name = "Kiwi TCMS"
+        site.save()
+        self.stdout.write('Domain updated successfully.')

tcms/core/tests/test_set_domain.py

@@ -0,0 +1,27 @@
+from io import StringIO
+
+from django.conf import settings
+from django.contrib.sites.models import Site
+from django.core.management import call_command
+from django.test import TestCase
+
+
+class TestSetDomainCommand(TestCase):
+    """Test manage.py set_domain command"""
+
+    def test_without_params_returns_domain(self):
+        """Test command without params returns current domain"""
+        out = StringIO()
+        call_command('set_domain', stdout=out)
+        self.assertEqual(
+            '127.0.0.1:8000\n',
+            out.getvalue())
+
+    def test_set_domain(self):
+        """Test if command sets the domain correctly"""
+        out = StringIO()
+        newdomain = "kiwi.test.bogus:1234"
+        call_command('set_domain', newdomain, stdout=out)
+        site = Site.objects.get(id=settings.SITE_ID)
+        self.assertEqual(newdomain, site.domain)
+        self.assertEqual('Kiwi TCMS', site.name)