The build_solr_schema command can now write directly to a file. Also includes tests for the new overrides.

Author: toastdriven

haystack/management/commands/build_solr_schema.py

@@ -1,31 +1,55 @@
+from optparse import make_option
 import sys
-from django.core.management.base import NoArgsCommand
+from django.core.management.base import BaseCommand
 from django.template import loader, Context
-from haystack.constants import DEFAULT_OPERATOR
+from haystack.constants import ID, DJANGO_CT, DJANGO_ID, DEFAULT_OPERATOR
 
 
-class Command(NoArgsCommand):
+class Command(BaseCommand):
     help = "Generates a Solr schema that reflects the indexes."
+    base_options = (
+        make_option("-f", "--filename", action="store", type="string", dest="filename",
+                    help='If provided, directs output to a file instead of stdout.'),
+    )
+    option_list = BaseCommand.option_list + base_options
 
-    def handle_noargs(self, **options):
+    def handle(self, **options):
         """Generates a Solr schema that reflects the indexes."""
+        schema_xml = self.build_template()
+        
+        if options.get('filename'):
+            self.write_file(options.get('filename'), schema_xml)
+        else:
+            self.print_stdout(schema_xml)
+    
+    def build_context(self):
         # Cause the default site to load.
-        from django.conf import settings
         from haystack import backend, site
-        
         content_field_name, fields = backend.SearchBackend().build_schema(site.all_searchfields())
-        
-        t = loader.get_template('search_configuration/solr.xml')
-        c = Context({
+        return Context({
             'content_field_name': content_field_name,
             'fields': fields,
             'default_operator': DEFAULT_OPERATOR,
+            'ID': ID,
+            'DJANGO_CT': DJANGO_CT,
+            'DJANGO_ID': DJANGO_ID,
         })
-        schema_xml = t.render(c)
+    
+    def build_template(self):
+        t = loader.get_template('search_configuration/solr.xml')
+        c = self.build_context()
+        return t.render(c)
+    
+    def print_stdout(self, schema_xml):
         sys.stderr.write("\n")
         sys.stderr.write("\n")
         sys.stderr.write("\n")
         sys.stderr.write("Save the following output to 'schema.xml' and place it in your Solr configuration directory.\n")
         sys.stderr.write("--------------------------------------------------------------------------------------------\n")
         sys.stderr.write("\n")
         print schema_xml
+    
+    def write_file(self, filename, schema_xml):
+        schema_file = open(filename, 'w')
+        schema_file.write(schema_xml)
+        schema_file.close()

haystack/templates/search_configuration/solr.xml

@@ -64,9 +64,9 @@
 
   <fields>   
     <!-- general -->
-    <field name="id"      type="string"   indexed="true"  stored="true"  multiValued="false" required="true"/>
-    <field name="django_ct" type="string"   indexed="true"  stored="true"  multiValued="false" />
-    <field name="django_id" type="string"   indexed="true"  stored="true"  multiValued="false" />
+    <field name="{{ ID }}" type="string" indexed="true" stored="true" multiValued="false" required="true"/>
+    <field name="{{ DJANGO_CT }}" type="string" indexed="true" stored="true" multiValued="false" />
+    <field name="{{ DJANGO_ID }}" type="string" indexed="true" stored="true" multiValued="false" />
 
     <dynamicField name="*_i"  type="sint"    indexed="true"  stored="true"/>
     <dynamicField name="*_s"  type="string"  indexed="true"  stored="true"/>
@@ -83,7 +83,7 @@
   </fields>
 
   <!-- field to use to determine and enforce document uniqueness. -->
-  <uniqueKey>id</uniqueKey>
+  <uniqueKey>{{ ID }}</uniqueKey>
 
   <!-- field for the QueryParser to use when an explicit fieldname is absent -->
   <defaultSearchField>{{ content_field_name }}</defaultSearchField>

tests/overrides/__init__.py

@@ -0,0 +1 @@
+# Blank so I look like an app.

tests/overrides/models.py

@@ -0,0 +1 @@
+from overrides.tests.altered_internal_names import *

tests/overrides/tests/__init__.py

@@ -0,0 +1,66 @@
+from django.conf import settings
+from django.test import TestCase
+from haystack import site, indexes
+from haystack.backends.solr_backend import SearchBackend, SearchQuery
+from haystack.management.commands.build_solr_schema import Command
+from haystack.query import SQ
+from core.models import MockModel, AnotherMockModel
+
+
+class MockModelSearchIndex(indexes.SearchIndex):
+    text = indexes.CharField(model_attr='foo', document=True)
+    name = indexes.CharField(model_attr='author')
+    pub_date = indexes.DateField(model_attr='pub_date')
+
+
+class AlteredInternalNamesTestCase(TestCase):
+    def test_altered_names(self):
+        sq = SearchQuery(backend=SearchBackend())
+        
+        sq.add_filter(SQ(content='hello'))
+        sq.add_model(MockModel)
+        self.assertEqual(sq.build_query(), u'(hello) AND (my_django_ct:core.mockmodel)')
+        
+        sq.add_model(AnotherMockModel)
+        self.assertEqual(sq.build_query(), u'(hello) AND (my_django_ct:core.anothermockmodel OR my_django_ct:core.mockmodel)')
+    
+    def test_solr_schema(self):
+        site.register(MockModel, MockModelSearchIndex)
+        
+        command = Command()
+        self.assertEqual(command.build_context().dicts[0], {
+            'DJANGO_ID': 'my_django_id',
+            'content_field_name': 'text',
+            'fields': [
+                {
+                    'indexed': 'true',
+                    'type': 'text',
+                    'stored': 'true',
+                    'field_name': 'text',
+                    'multi_valued': 'false'
+                },
+                {
+                    'indexed': 'true',
+                    'type': 'date',
+                    'stored': 'true',
+                    'field_name': 'pub_date',
+                    'multi_valued': 'false'
+                },
+                {
+                    'indexed': 'true',
+                    'type': 'text',
+                    'stored': 'true',
+                    'field_name': 'name',
+                    'multi_valued': 'false'
+                }
+            ],
+            'DJANGO_CT': 'my_django_ct',
+            'default_operator': 'AND',
+            'ID': 'my_id'
+        })
+        
+        schema_xml = command.build_template()
+        self.assertTrue('<uniqueKey>my_id</uniqueKey>' in schema_xml)
+        self.assertTrue('<field name="my_id" type="string" indexed="true" stored="true" multiValued="false" required="true"/>' in schema_xml)
+        self.assertTrue('<field name="my_django_ct" type="string" indexed="true" stored="true" multiValued="false" />' in schema_xml)
+        self.assertTrue('<field name="my_django_id" type="string" indexed="true" stored="true" multiValued="false" />' in schema_xml)

tests/overrides/tests/altered_internal_names.py

@@ -0,0 +1,13 @@
+from settings import *
+
+INSTALLED_APPS += [
+    'overrides',
+]
+
+HAYSTACK_SEARCH_ENGINE = 'solr'
+HAYSTACK_SOLR_URL = 'http://localhost:9001/solr/test_default'
+HAYSTACK_INCLUDE_SPELLING = True
+
+HAYSTACK_ID_FIELD = 'my_id'
+HAYSTACK_DJANGO_CT_FIELD = 'my_django_ct'
+HAYSTACK_DJANGO_ID_FIELD = 'my_django_id'

tests/overrides_settings.py

@@ -18,4 +18,8 @@ django-admin.py test whoosh_tests --settings=whoosh_settings
 echo ""
 
 echo "** SITE REG **"
-django-admin.py test site_registration --settings=site_registration_settings
+django-admin.py test site_registration --settings=site_registration_settings
+
+echo "** OVERRIDES **"
+django-admin.py test overrides --settings=overrides_settings
+echo ""