site configuration management (#20919)

site config management cmd

openedx/core/djangoapps/site_configuration/management/commands/create_site_configuration.py

@@ -0,0 +1,46 @@
+"""
+Run by ansible to setup a single site configuration in sandbox environments
+"""
+import json
+import logging
+
+from django.contrib.sites.models import Site
+from django.core.management.base import BaseCommand
+from openedx.core.djangoapps.site_configuration.models import SiteConfiguration
+
+LOG = logging.getLogger(__name__)
+
+
+class Command(BaseCommand):
+    """
+    Command to create a configuration for a single site.  If the site does not
+    already exist one will be created.
+
+    Example:
+    ./manage.py lms create_configuration uox.sandbox.edx.org
+      --configuration="{'COURSE_CATALOG_API_URL':'https://discovery-uox.sandbox.edx.org/api/v1'}"
+    """
+    def add_arguments(self, parser):
+        parser.add_argument('domain')
+        parser.add_argument(
+            '--configuration',
+            type=json.loads,
+            help="Enter JSON site configuration",
+            required=False,
+            default=''
+        )
+
+    def handle(self, *args, **options):
+        domain = options['domain']
+        configuration = options['configuration']
+        site, created = Site.objects.get_or_create(
+            domain=domain,
+            name=domain,
+        )
+        if created:
+            LOG.info(u"Site does not exist. Created new site '{site_name}'".format(site_name=domain))
+        else:
+            LOG.info(u"Found existing site for '{site_name}'".format(site_name=domain))
+
+        LOG.info(u"Creating '{site_name}' SiteConfiguration".format(site_name=domain))
+        SiteConfiguration.objects.create(site=site, values=configuration, enabled=True)

openedx/core/djangoapps/site_configuration/management/commands/tests/test_create_site_configuration.py

@@ -0,0 +1,52 @@
+"""
+Test create_site_configuration management command
+"""
+import json
+
+from django.contrib.sites.models import Site
+from django.core.management import call_command
+from django.test import TestCase
+from openedx.core.djangoapps.site_configuration.models import SiteConfiguration
+
+
+class TestCreateSiteConfiguration(TestCase):
+    """ Test create_site_configuration command """
+    def setUp(self):
+        super(TestCreateSiteConfiguration, self).setUp()
+        self.site_domain = 'example.com'
+        self.input_configuration = {
+            'FEATURE_FLAG': True,
+            'SERVICE_URL': 'https://foo.bar'
+        }
+
+    def _validate_site_configuration(self, site):
+        site_configuration = SiteConfiguration.objects.get(site_id=site.id)
+        self.assertDictEqual(site_configuration.values, self.input_configuration)
+
+    def test_create_site_and_config(self):
+        call_command(
+            'create_site_configuration',
+            self.site_domain,
+            '--configuration', json.dumps(self.input_configuration),
+        )
+
+        site = Site.objects.get(domain__contains=self.site_domain)
+        self.assertEquals(site.name, self.site_domain)
+        self.assertEquals(site.domain, self.site_domain)
+
+        self._validate_site_configuration(site)
+
+    def test_create_for_existing_site(self):
+        site, created = Site.objects.get_or_create(  # pylint: disable=unused-variable
+            name=self.site_domain,
+            domain=self.site_domain,
+        )
+
+        call_command(
+            'create_site_configuration',
+            self.site_domain,
+            '--configuration', json.dumps(self.input_configuration),
+        )
+
+        self.assertEqual(len(Site.objects.filter(domain__contains=self.site_domain)), 1)
+        self._validate_site_configuration(site)