/*
* 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.core;
import java.io.IOException;
import java.io.InputStream;
import java.nio.charset.CharacterCodingException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.jar.JarEntry;
import java.util.jar.JarOutputStream;
import junit.framework.Assert;
import org.apache.lucene.analysis.TokenStream;
import org.apache.lucene.analysis.core.KeywordTokenizerFactory;
import org.apache.lucene.analysis.ngram.NGramFilterFactory;
import org.apache.lucene.analysis.util.ResourceLoaderAware;
import org.apache.lucene.analysis.util.TokenFilterFactory;
import org.apache.solr.SolrTestCaseJ4;
import org.apache.solr.common.SolrException;
import org.apache.solr.handler.admin.LukeRequestHandler;
import org.apache.solr.handler.component.FacetComponent;
import org.apache.solr.response.JSONResponseWriter;
import org.apache.solr.util.plugin.SolrCoreAware;
import static org.apache.solr.core.SolrResourceLoader.assertAwareCompatibility;
import static org.hamcrest.core.Is.is;
public class ResourceLoaderTest extends SolrTestCaseJ4 {
public void testInstanceDir() throws Exception {
try (SolrResourceLoader loader = new SolrResourceLoader()) {
assertThat(loader.getInstancePath(), is(Paths.get("solr").toAbsolutePath()));
}
}
public void testEscapeInstanceDir() throws Exception {
Path temp = createTempDir("testEscapeInstanceDir");
Files.write(temp.resolve("dummy.txt"), new byte[]{});
Path instanceDir = temp.resolve("instance");
Files.createDirectories(instanceDir.resolve("conf"));
try (SolrResourceLoader loader = new SolrResourceLoader(instanceDir)) {
loader.openResource("../../dummy.txt").close();
fail();
} catch (IOException ioe) {
assertTrue(ioe.getMessage().contains("is outside resource loader dir"));
}
}
public void testAwareCompatibility() throws Exception {
Class<?> clazz = ResourceLoaderAware.class;
// Check ResourceLoaderAware valid objects
assertAwareCompatibility(clazz, new NGramFilterFactory(new HashMap<>()));
assertAwareCompatibility(clazz, new KeywordTokenizerFactory(new HashMap<>()));
// Make sure it throws an error for invalid objects
Object[] invalid = new Object[] {
// new NGramTokenFilter( null ),
"hello", new Float( 12.3f ),
new LukeRequestHandler(),
new JSONResponseWriter()
};
for( Object obj : invalid ) {
try {
assertAwareCompatibility(clazz, obj);
Assert.fail( "Should be invalid class: "+obj + " FOR " + clazz );
}
catch( SolrException ex ) { } // OK
}
clazz = SolrCoreAware.class;
// Check ResourceLoaderAware valid objects
assertAwareCompatibility(clazz, new LukeRequestHandler());
assertAwareCompatibility(clazz, new FacetComponent());
assertAwareCompatibility(clazz, new JSONResponseWriter());
// Make sure it throws an error for invalid objects
invalid = new Object[] {
new NGramFilterFactory(new HashMap<>()),
"hello", new Float( 12.3f ),
new KeywordTokenizerFactory(new HashMap<>())
};
for( Object obj : invalid ) {
try {
assertAwareCompatibility(clazz, obj);
Assert.fail( "Should be invalid class: "+obj + " FOR " + clazz );
}
catch( SolrException ex ) { } // OK
}
}
public void testBOMMarkers() throws Exception {
final String fileWithBom = "stopwithbom.txt";
SolrResourceLoader loader = new SolrResourceLoader(TEST_PATH().resolve("collection1"));
// preliminary sanity check
InputStream bomStream = loader.openResource(fileWithBom);
try {
final byte[] bomExpected = new byte[] { -17, -69, -65 };
final byte[] firstBytes = new byte[3];
assertEquals("Should have been able to read 3 bytes from bomStream",
3, bomStream.read(firstBytes));
assertTrue("This test only works if " + fileWithBom +
" contains a BOM -- it appears someone removed it.",
Arrays.equals(bomExpected, firstBytes));
} finally {
try { bomStream.close(); } catch (Exception e) { /* IGNORE */ }
}
// now make sure getLines skips the BOM...
List<String> lines = loader.getLines(fileWithBom);
assertEquals(1, lines.size());
assertEquals("BOMsAreEvil", lines.get(0));
loader.close();
}
public void testWrongEncoding() throws Exception {
String wrongEncoding = "stopwordsWrongEncoding.txt";
SolrResourceLoader loader = new SolrResourceLoader(TEST_PATH().resolve("collection1"));
// ensure we get our exception
try {
loader.getLines(wrongEncoding);
fail();
} catch (SolrException expected) {
assertTrue(expected.getCause() instanceof CharacterCodingException);
}
loader.close();
}
public void testClassLoaderLibs() throws Exception {
Path tmpRoot = createTempDir("testClassLoaderLibs");
Path lib = tmpRoot.resolve("lib");
Files.createDirectories(lib);
try (JarOutputStream os = new JarOutputStream(Files.newOutputStream(lib.resolve("jar1.jar")))) {
os.putNextEntry(new JarEntry("aLibFile"));
os.closeEntry();
}
Path otherLib = tmpRoot.resolve("otherLib");
Files.createDirectories(otherLib);
try (JarOutputStream os = new JarOutputStream(Files.newOutputStream(otherLib.resolve("jar2.jar")))) {
os.putNextEntry(new JarEntry("explicitFile"));
os.closeEntry();
}
try (JarOutputStream os = new JarOutputStream(Files.newOutputStream(otherLib.resolve("jar3.jar")))) {
os.putNextEntry(new JarEntry("otherFile"));
os.closeEntry();
}
SolrResourceLoader loader = new SolrResourceLoader(tmpRoot);
// ./lib is accessible by default
assertNotNull(loader.getClassLoader().getResource("aLibFile"));
// add inidividual jars from other paths
loader.addToClassLoader(otherLib.resolve("jar2.jar").toUri().toURL());
assertNotNull(loader.getClassLoader().getResource("explicitFile"));
assertNull(loader.getClassLoader().getResource("otherFile"));
// add all jars from another path
loader.addToClassLoader(SolrResourceLoader.getURLs(otherLib));
assertNotNull(loader.getClassLoader().getResource("otherFile"));
loader.close();
}
@Deprecated
public static final class DeprecatedTokenFilterFactory extends TokenFilterFactory {
public DeprecatedTokenFilterFactory(Map<String,String> args) {
super(args);
}
@Override
public TokenStream create(TokenStream input) {
return null;
}
}
@SuppressWarnings("deprecation")
public void testLoadDeprecatedFactory() throws Exception {
SolrResourceLoader loader = new SolrResourceLoader(Paths.get("solr/collection1"));
// ensure we get our exception
loader.newInstance(DeprecatedTokenFilterFactory.class.getName(), TokenFilterFactory.class, null,
new Class[] { Map.class }, new Object[] { new HashMap<String,String>() });
// TODO: How to check that a warning was printed to log file?
loader.close();
}
}