solr/core/src/test/org/apache/solr/handler/admin/LukeRequestHandlerTest.java - lucene-solr - Git at Google

 /*
  * Licensed to the Apache Software Foundation (ASF) under one or more
  * contributor license agreements.  See the NOTICE file distributed with
  * this work for additional information regarding copyright ownership.
  * The ASF licenses this file to You under the Apache License, Version 2.0
  * (the "License"); you may not use this file except in compliance with
  * the License.  You may obtain a copy of the License at
  *
  *     http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
 package org.apache.solr.handler.admin;

 import java.util.Arrays;
 import java.util.EnumSet;

 import javax.xml.xpath.XPathConstants;

 import org.apache.solr.common.luke.FieldFlag;
 import org.apache.solr.request.SolrQueryRequest;
 import org.apache.solr.schema.CustomAnalyzerStrField; // jdoc
 import org.apache.solr.schema.IndexSchema;
 import org.apache.solr.SolrTestCaseJ4;
 import org.apache.solr.util.TestHarness;
 import org.junit.Assert;
 import org.junit.Before;
 import org.junit.BeforeClass;
 import org.junit.Test;

 /**
  * :TODO: currently only tests some of the utilities in the LukeRequestHandler
  */
 public class LukeRequestHandlerTest extends SolrTestCaseJ4 {

   @BeforeClass
   public static void beforeClass() throws Exception {
     System.setProperty("enable.update.log", "false"); // schema12 doesn't support _version_
     initCore("solrconfig.xml", "schema12.xml");
   }

   @Before
   public void before() {
     assertU(adoc("id","SOLR1000", "name","Apache Solr",
         "solr_s", "10",
         "solr_sI", "10",
         "solr_sS", "10",
         "solr_t", "10",
         "solr_tt", "10",
         "solr_b", "true",
         "solr_i", "10",
         "solr_l", "10",
         "solr_f", "10",
         "solr_d", "10",
         "solr_ti", "10",
         "solr_tl", "10",
         "solr_tf", "10",
         "solr_td", "10",
         "solr_dt", "2000-01-01T01:01:01Z",
         "solr_tdt", "2000-01-01T01:01:01Z"
     ));
     assertU(commit());

   }

   @Test
   public void testHistogramBucket() {
     assertHistoBucket(0, 1);
     assertHistoBucket(1, 2);
     assertHistoBucket(2, 3);
     assertHistoBucket(2, 4);
     assertHistoBucket(3, 5);
     assertHistoBucket(3, 6);
     assertHistoBucket(3, 7);
     assertHistoBucket(3, 8);
     assertHistoBucket(4, 9);

     final int MAX_VALID = ((Integer.MAX_VALUE/2)+1)/2;

     assertHistoBucket(29,   MAX_VALID-1 );
     assertHistoBucket(29,   MAX_VALID   );
     assertHistoBucket(30, MAX_VALID+1 );

   }

   private void assertHistoBucket(int slot, int in) {
     assertEquals("histobucket: " + in, slot, 32 - Integer.numberOfLeadingZeros(Math.max(0, in - 1)));
   }

   @Test
   public void testLuke() {


     // test that Luke can handle all of the field types
     assertQ(req("qt","/admin/luke", "id","SOLR1000"));

     final int numFlags = EnumSet.allOf(FieldFlag.class).size();

     assertQ("Not all flags ("+numFlags+") mentioned in info->key",
         req("qt","/admin/luke"),
         numFlags+"=count(//lst[@name='info']/lst[@name='key']/str)");

     // code should be the same for all fields, but just in case do several
     for (String f : Arrays.asList("solr_t","solr_s","solr_ti",
         "solr_td","solr_dt","solr_b",
         "solr_sS","solr_sI")) {

       final String xp = getFieldXPathPrefix(f);
       assertQ("Not as many schema flags as expected ("+numFlags+") for " + f,
           req("qt","/admin/luke", "fl", f),
           numFlags+"=string-length("+xp+"[@name='schema'])");

     }

     // diff loop for checking 'index' flags,
     // only valid for fields that are indexed & stored
     for (String f : Arrays.asList("solr_t","solr_s","solr_ti",
         "solr_td","solr_dt","solr_b")) {
       if (h.getCore().getLatestSchema().getField(f).getType().isPointField()) continue;
       final String xp = getFieldXPathPrefix(f);
       assertQ("Not as many index flags as expected ("+numFlags+") for " + f,
           req("qt","/admin/luke", "fl", f),
           numFlags+"=string-length("+xp+"[@name='index'])");

       final String hxp = getFieldXPathHistogram(f);
       assertQ("Historgram field should be present for field "+f,
           req("qt", "/admin/luke", "fl", f),
           hxp+"[@name='histogram']");
     }
   }

   private static String getFieldXPathHistogram(String field) {
     return "//lst[@name='fields']/lst[@name='"+field+"']/lst";
   }
   private static String getFieldXPathPrefix(String field) {
     return "//lst[@name='fields']/lst[@name='"+field+"']/str";
   }
   private static String field(String field) {
     return "//lst[@name='fields']/lst[@name='"+field+"']/";
   }
   private static String dynfield(String field) {
     return "//lst[@name='dynamicFields']/lst[@name='"+field+"']/";
   }

   @Test
   public void testIndexHeapUsageBytes() throws Exception {
     try (SolrQueryRequest req = req("qt", "/admin/luke")) {
       String response = h.query(req);
       String xpath = "//long[@name='indexHeapUsageBytes']";
       Double num = (Double) TestHarness.evaluateXPath(response, xpath, XPathConstants.NUMBER);
       //with docs in the index, indexHeapUsageBytes should be greater than 0
       Assert.assertTrue("indexHeapUsageBytes should be > 0, but was " + num.intValue(), num.intValue() > 0);
     }
   }

   @Test
   public void testFlParam() {
     SolrQueryRequest req = req("qt", "/admin/luke", "fl", "solr_t solr_s", "show", "all");
     try {
       // First, determine that the two fields ARE there
       String response = h.query(req);
       assertNull(TestHarness.validateXPath(response,
           getFieldXPathPrefix("solr_t") + "[@name='index']",
           getFieldXPathPrefix("solr_s") + "[@name='index']"
       ));

       // Now test that the other fields are NOT there
       for (String f : Arrays.asList("solr_ti",
           "solr_td", "solr_dt", "solr_b")) {

         assertNotNull(TestHarness.validateXPath(response,
             getFieldXPathPrefix(f) + "[@name='index']"));

       }
       // Insure * works
       req = req("qt", "/admin/luke", "fl", "*");
       response = h.query(req);
       for (String f : Arrays.asList("solr_t", "solr_s", "solr_ti",
           "solr_td", "solr_dt", "solr_b")) {
         if (h.getCore().getLatestSchema().getField(f).getType().isPointField()) continue;
         assertNull(TestHarness.validateXPath(response,
             getFieldXPathPrefix(f) + "[@name='index']"));
       }
     } catch (Exception e) {
       fail("Caught unexpected exception " + e.getMessage());
     }
   }

   public void testNumTerms() throws Exception {
     final String f = "name";
     for (String n : new String[] {"2", "3", "100", "99999"}) {
       assertQ(req("qt", "/admin/luke", "fl", f, "numTerms", n),
               field(f) + "lst[@name='topTerms']/int[@name='Apache']",
               field(f) + "lst[@name='topTerms']/int[@name='Solr']",
               "count("+field(f)+"lst[@name='topTerms']/int)=2");
     }

     assertQ(req("qt", "/admin/luke", "fl", f, "numTerms", "1"),
             // no garuntee which one we find
             "count("+field(f)+"lst[@name='topTerms']/int)=1");

     assertQ(req("qt", "/admin/luke", "fl", f, "numTerms", "0"),
             "count("+field(f)+"lst[@name='topTerms']/int)=0");

     // field with no terms shouldn't error
     for (String n : new String[] {"0", "1", "2", "100", "99999"}) {
       assertQ(req("qt", "/admin/luke", "fl", "bogus_s", "numTerms", n),
               "count("+field(f)+"lst[@name='topTerms']/int)=0");
     }
   }

   /** @see CustomAnalyzerStrField */
   public void testNullFactories() throws Exception {
     deleteCore();
     initCore("solrconfig.xml", "schema-null-charfilters-analyzer.xml");

     try {
       assertQ(req("qt", "/admin/luke", "show", "schema")
               , "//lst[@name='custom_tc_string']/lst[@name='indexAnalyzer']"
               , "//lst[@name='custom_tc_string']/lst[@name='queryAnalyzer']"
               , "0=count(//lst[@name='custom_tc_string']/lst[@name='indexAnalyzer']/lst[@name='filters'])"
               , "0=count(//lst[@name='custom_tc_string']/lst[@name='queryAnalyzer']/lst[@name='filters'])"
               , "0=count(//lst[@name='custom_tc_string']/lst[@name='indexAnalyzer']/lst[@name='charFilters'])"
               , "0=count(//lst[@name='custom_tc_string']/lst[@name='queryAnalyzer']/lst[@name='charFilters'])"
               );
     } finally {
       // Put back the configuration expected by the rest of the tests in this suite
       deleteCore();
       initCore("solrconfig.xml", "schema12.xml");
     }
   }

   public void testCopyFieldLists() throws Exception {
     SolrQueryRequest req = req("qt", "/admin/luke", "show", "schema");

     String xml = h.query(req);
     String r = TestHarness.validateXPath
       (xml,
        field("text") + "/arr[@name='copySources']/str[.='title']",
        field("text") + "/arr[@name='copySources']/str[.='subject']",
        field("title") + "/arr[@name='copyDests']/str[.='text']",
        field("title") + "/arr[@name='copyDests']/str[.='title_stemmed']",
        dynfield("bar_copydest_*") + "/arr[@name='copySources']/str[.='foo_copysource_*']",
        dynfield("foo_copysource_*") + "/arr[@name='copyDests']/str[.='bar_copydest_*']");
     assertEquals(xml, null, r);
   }

   public void testCatchAllCopyField() throws Exception {
     deleteCore();
     initCore("solrconfig.xml", "schema-copyfield-test.xml");

     IndexSchema schema = h.getCore().getLatestSchema();

     assertNull("'*' should not be (or match) a dynamic field", schema.getDynamicPattern("*"));

     boolean foundCatchAllCopyField = false;
     for (IndexSchema.DynamicCopy dcf : schema.getDynamicCopyFields()) {
       foundCatchAllCopyField = dcf.getRegex().equals("*") && dcf.getDestFieldName().equals("catchall_t");
       if (foundCatchAllCopyField) {
         break;
       }
     }
     assertTrue("<copyField source=\"*\" dest=\"catchall_t\"/> is missing from the schema", foundCatchAllCopyField);

     SolrQueryRequest req = req("qt", "/admin/luke", "show", "schema", "indent", "on");
     String xml = h.query(req);
     String result = TestHarness.validateXPath(xml, field("bday") + "/arr[@name='copyDests']/str[.='catchall_t']");
     assertNull(xml, result);

     // Put back the configuration expected by the rest of the tests in this suite
     deleteCore();
     initCore("solrconfig.xml", "schema12.xml");
   }
 }
	/*
	* Licensed to the Apache Software Foundation (ASF) under one or more
	* contributor license agreements. See the NOTICE file distributed with
	* this work for additional information regarding copyright ownership.
	* The ASF licenses this file to You under the Apache License, Version 2.0
	* (the "License"); you may not use this file except in compliance with
	* the License. You may obtain a copy of the License at
	*
	* http://www.apache.org/licenses/LICENSE-2.0
	*
	* Unless required by applicable law or agreed to in writing, software
	* distributed under the License is distributed on an "AS IS" BASIS,
	* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	* See the License for the specific language governing permissions and
	* limitations under the License.
	*/
	package org.apache.solr.handler.admin;

	import java.util.Arrays;
	import java.util.EnumSet;

	import javax.xml.xpath.XPathConstants;

	import org.apache.solr.common.luke.FieldFlag;
	import org.apache.solr.request.SolrQueryRequest;
	import org.apache.solr.schema.CustomAnalyzerStrField; // jdoc
	import org.apache.solr.schema.IndexSchema;
	import org.apache.solr.SolrTestCaseJ4;
	import org.apache.solr.util.TestHarness;
	import org.junit.Assert;
	import org.junit.Before;
	import org.junit.BeforeClass;
	import org.junit.Test;

	/**
	* :TODO: currently only tests some of the utilities in the LukeRequestHandler
	*/
	public class LukeRequestHandlerTest extends SolrTestCaseJ4 {

	@BeforeClass
	public static void beforeClass() throws Exception {
	System.setProperty("enable.update.log", "false"); // schema12 doesn't support _version_
	initCore("solrconfig.xml", "schema12.xml");
	}

	@Before
	public void before() {
	assertU(adoc("id","SOLR1000", "name","Apache Solr",
	"solr_s", "10",
	"solr_sI", "10",
	"solr_sS", "10",
	"solr_t", "10",
	"solr_tt", "10",
	"solr_b", "true",
	"solr_i", "10",
	"solr_l", "10",
	"solr_f", "10",
	"solr_d", "10",
	"solr_ti", "10",
	"solr_tl", "10",
	"solr_tf", "10",
	"solr_td", "10",
	"solr_dt", "2000-01-01T01:01:01Z",
	"solr_tdt", "2000-01-01T01:01:01Z"
	));
	assertU(commit());

	}

	@Test
	public void testHistogramBucket() {
	assertHistoBucket(0, 1);
	assertHistoBucket(1, 2);
	assertHistoBucket(2, 3);
	assertHistoBucket(2, 4);
	assertHistoBucket(3, 5);
	assertHistoBucket(3, 6);
	assertHistoBucket(3, 7);
	assertHistoBucket(3, 8);
	assertHistoBucket(4, 9);

	final int MAX_VALID = ((Integer.MAX_VALUE/2)+1)/2;

	assertHistoBucket(29, MAX_VALID-1 );
	assertHistoBucket(29, MAX_VALID );
	assertHistoBucket(30, MAX_VALID+1 );

	}

	private void assertHistoBucket(int slot, int in) {
	assertEquals("histobucket: " + in, slot, 32 - Integer.numberOfLeadingZeros(Math.max(0, in - 1)));
	}

	@Test
	public void testLuke() {


	// test that Luke can handle all of the field types
	assertQ(req("qt","/admin/luke", "id","SOLR1000"));

	final int numFlags = EnumSet.allOf(FieldFlag.class).size();

	assertQ("Not all flags ("+numFlags+") mentioned in info->key",
	req("qt","/admin/luke"),
	numFlags+"=count(//lst[@name='info']/lst[@name='key']/str)");

	// code should be the same for all fields, but just in case do several
	for (String f : Arrays.asList("solr_t","solr_s","solr_ti",
	"solr_td","solr_dt","solr_b",
	"solr_sS","solr_sI")) {

	final String xp = getFieldXPathPrefix(f);
	assertQ("Not as many schema flags as expected ("+numFlags+") for " + f,
	req("qt","/admin/luke", "fl", f),
	numFlags+"=string-length("+xp+"[@name='schema'])");

	}

	// diff loop for checking 'index' flags,
	// only valid for fields that are indexed & stored
	for (String f : Arrays.asList("solr_t","solr_s","solr_ti",
	"solr_td","solr_dt","solr_b")) {
	if (h.getCore().getLatestSchema().getField(f).getType().isPointField()) continue;
	final String xp = getFieldXPathPrefix(f);
	assertQ("Not as many index flags as expected ("+numFlags+") for " + f,
	req("qt","/admin/luke", "fl", f),
	numFlags+"=string-length("+xp+"[@name='index'])");

	final String hxp = getFieldXPathHistogram(f);
	assertQ("Historgram field should be present for field "+f,
	req("qt", "/admin/luke", "fl", f),
	hxp+"[@name='histogram']");
	}
	}

	private static String getFieldXPathHistogram(String field) {
	return "//lst[@name='fields']/lst[@name='"+field+"']/lst";
	}
	private static String getFieldXPathPrefix(String field) {
	return "//lst[@name='fields']/lst[@name='"+field+"']/str";
	}
	private static String field(String field) {
	return "//lst[@name='fields']/lst[@name='"+field+"']/";
	}
	private static String dynfield(String field) {
	return "//lst[@name='dynamicFields']/lst[@name='"+field+"']/";
	}

	@Test
	public void testIndexHeapUsageBytes() throws Exception {
	try (SolrQueryRequest req = req("qt", "/admin/luke")) {
	String response = h.query(req);
	String xpath = "//long[@name='indexHeapUsageBytes']";
	Double num = (Double) TestHarness.evaluateXPath(response, xpath, XPathConstants.NUMBER);
	//with docs in the index, indexHeapUsageBytes should be greater than 0
	Assert.assertTrue("indexHeapUsageBytes should be > 0, but was " + num.intValue(), num.intValue() > 0);
	}
	}

	@Test
	public void testFlParam() {
	SolrQueryRequest req = req("qt", "/admin/luke", "fl", "solr_t solr_s", "show", "all");
	try {
	// First, determine that the two fields ARE there
	String response = h.query(req);
	assertNull(TestHarness.validateXPath(response,
	getFieldXPathPrefix("solr_t") + "[@name='index']",
	getFieldXPathPrefix("solr_s") + "[@name='index']"
	));

	// Now test that the other fields are NOT there
	for (String f : Arrays.asList("solr_ti",
	"solr_td", "solr_dt", "solr_b")) {

	assertNotNull(TestHarness.validateXPath(response,
	getFieldXPathPrefix(f) + "[@name='index']"));

	}
	// Insure * works
	req = req("qt", "/admin/luke", "fl", "*");
	response = h.query(req);
	for (String f : Arrays.asList("solr_t", "solr_s", "solr_ti",
	"solr_td", "solr_dt", "solr_b")) {
	if (h.getCore().getLatestSchema().getField(f).getType().isPointField()) continue;
	assertNull(TestHarness.validateXPath(response,
	getFieldXPathPrefix(f) + "[@name='index']"));
	}
	} catch (Exception e) {
	fail("Caught unexpected exception " + e.getMessage());
	}
	}

	public void testNumTerms() throws Exception {
	final String f = "name";
	for (String n : new String[] {"2", "3", "100", "99999"}) {
	assertQ(req("qt", "/admin/luke", "fl", f, "numTerms", n),
	field(f) + "lst[@name='topTerms']/int[@name='Apache']",
	field(f) + "lst[@name='topTerms']/int[@name='Solr']",
	"count("+field(f)+"lst[@name='topTerms']/int)=2");
	}

	assertQ(req("qt", "/admin/luke", "fl", f, "numTerms", "1"),
	// no garuntee which one we find
	"count("+field(f)+"lst[@name='topTerms']/int)=1");

	assertQ(req("qt", "/admin/luke", "fl", f, "numTerms", "0"),
	"count("+field(f)+"lst[@name='topTerms']/int)=0");

	// field with no terms shouldn't error
	for (String n : new String[] {"0", "1", "2", "100", "99999"}) {
	assertQ(req("qt", "/admin/luke", "fl", "bogus_s", "numTerms", n),
	"count("+field(f)+"lst[@name='topTerms']/int)=0");
	}
	}

	/** @see CustomAnalyzerStrField */
	public void testNullFactories() throws Exception {
	deleteCore();
	initCore("solrconfig.xml", "schema-null-charfilters-analyzer.xml");

	try {
	assertQ(req("qt", "/admin/luke", "show", "schema")
	, "//lst[@name='custom_tc_string']/lst[@name='indexAnalyzer']"
	, "//lst[@name='custom_tc_string']/lst[@name='queryAnalyzer']"
	, "0=count(//lst[@name='custom_tc_string']/lst[@name='indexAnalyzer']/lst[@name='filters'])"
	, "0=count(//lst[@name='custom_tc_string']/lst[@name='queryAnalyzer']/lst[@name='filters'])"
	, "0=count(//lst[@name='custom_tc_string']/lst[@name='indexAnalyzer']/lst[@name='charFilters'])"
	, "0=count(//lst[@name='custom_tc_string']/lst[@name='queryAnalyzer']/lst[@name='charFilters'])"
	);
	} finally {
	// Put back the configuration expected by the rest of the tests in this suite
	deleteCore();
	initCore("solrconfig.xml", "schema12.xml");
	}
	}

	public void testCopyFieldLists() throws Exception {
	SolrQueryRequest req = req("qt", "/admin/luke", "show", "schema");

	String xml = h.query(req);
	String r = TestHarness.validateXPath
	(xml,
	field("text") + "/arr[@name='copySources']/str[.='title']",
	field("text") + "/arr[@name='copySources']/str[.='subject']",
	field("title") + "/arr[@name='copyDests']/str[.='text']",
	field("title") + "/arr[@name='copyDests']/str[.='title_stemmed']",
	dynfield("bar_copydest_") + "/arr[@name='copySources']/str[.='foo_copysource_']",
	dynfield("foo_copysource_") + "/arr[@name='copyDests']/str[.='bar_copydest_']");
	assertEquals(xml, null, r);
	}

	public void testCatchAllCopyField() throws Exception {
	deleteCore();
	initCore("solrconfig.xml", "schema-copyfield-test.xml");

	IndexSchema schema = h.getCore().getLatestSchema();

	assertNull("'' should not be (or match) a dynamic field", schema.getDynamicPattern(""));

	boolean foundCatchAllCopyField = false;
	for (IndexSchema.DynamicCopy dcf : schema.getDynamicCopyFields()) {
	foundCatchAllCopyField = dcf.getRegex().equals("*") && dcf.getDestFieldName().equals("catchall_t");
	if (foundCatchAllCopyField) {
	break;
	}
	}
	assertTrue("<copyField source=\"*\" dest=\"catchall_t\"/> is missing from the schema", foundCatchAllCopyField);

	SolrQueryRequest req = req("qt", "/admin/luke", "show", "schema", "indent", "on");
	String xml = h.query(req);
	String result = TestHarness.validateXPath(xml, field("bday") + "/arr[@name='copyDests']/str[.='catchall_t']");
	assertNull(xml, result);

	// Put back the configuration expected by the rest of the tests in this suite
	deleteCore();
	initCore("solrconfig.xml", "schema12.xml");
	}
	}