/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License (the "License").
* You may not use this file except in compliance with the License.
*
* See LICENSE.txt included in this distribution for the specific
* language governing permissions and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file and include the License file at LICENSE.txt.
* If applicable, add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your own identifying
* information: Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*/
/*
* Copyright (c) 2008, 2011, Oracle and/or its affiliates. All rights reserved.
*/
package org.opensolaris.opengrok.configuration;
import java.io.File;
import java.io.IOException;
import java.io.StringReader;
import java.io.StringWriter;
import java.net.InetSocketAddress;
import java.net.SocketAddress;
import java.util.ArrayList;
import java.util.List;
import org.junit.After;
import org.junit.AfterClass;
import static org.junit.Assert.*;
import org.junit.Before;
import org.junit.BeforeClass;
import org.junit.Test;
import org.opensolaris.opengrok.analysis.plain.PlainXref;
import org.opensolaris.opengrok.history.RepositoryInfo;
/**
* Test the RuntimeEnvironment class
*
* @author Trond Norbye
*/
public class RuntimeEnvironmentTest {
private static File originalConfig;
public RuntimeEnvironmentTest() {
}
@BeforeClass
public static void setUpClass() throws Exception {
// preserve the original
originalConfig = File.createTempFile("config", ".xml");
RuntimeEnvironment.getInstance().writeConfiguration(originalConfig);
}
@AfterClass
public static void tearDownClass() throws Exception {
// restore the configuration
RuntimeEnvironment.getInstance().readConfiguration(originalConfig);
RuntimeEnvironment.getInstance().register();
originalConfig.delete();
}
@Before
public void setUp() throws IOException {
// Create a default configuration
Configuration config = new Configuration();
RuntimeEnvironment.getInstance().setConfiguration(config);
}
@After
public void tearDown() throws IOException {
}
@Test
public void testDataRoot() throws IOException {
RuntimeEnvironment instance = RuntimeEnvironment.getInstance();
assertNull(instance.getDataRootFile());
assertNull(instance.getDataRootPath());
File f = File.createTempFile("dataroot", null);
String path = f.getCanonicalPath();
assertTrue(f.delete());
assertFalse(f.exists());
instance.setDataRoot(path);
// setDataRoot() used to create path if it didn't exist, but that
// logic has been moved. Verify that it is so.
assertFalse(f.exists());
assertTrue(f.mkdirs());
assertEquals(path, instance.getDataRootPath());
assertEquals(path, instance.getDataRootFile().getCanonicalPath());
}
@Test
public void testSourceRoot() throws IOException {
RuntimeEnvironment instance = RuntimeEnvironment.getInstance();
assertNull(instance.getSourceRootFile());
assertNull(instance.getSourceRootPath());
File f = File.createTempFile("sourceroot", null);
String path = f.getCanonicalPath();
assertTrue(f.delete());
instance.setSourceRoot(path);
assertEquals(path, instance.getSourceRootPath());
assertEquals(path, instance.getSourceRootFile().getCanonicalPath());
}
@Test
public void testProjects() throws IOException {
RuntimeEnvironment instance = RuntimeEnvironment.getInstance();
assertFalse(instance.hasProjects());
assertNotNull(instance.getProjects());
assertEquals(0, instance.getProjects().size());
assertNull(instance.getDefaultProject());
File file = new File("/opengrok_automatic_test/foo/bar");
instance.setSourceRoot("/opengrok_automatic_test/foo");
Project p = new Project();
p.setPath("/bar");
assertEquals("/bar", p.getId());
instance.getProjects().add(p);
assertEquals(p, Project.getProject(file));
instance.setProjects(null);
assertNull(instance.getProjects());
}
@Test
public void testRegister() throws InterruptedException, IOException {
RuntimeEnvironment instance = RuntimeEnvironment.getInstance();
String path = "/tmp/dataroot";
instance.setDataRoot(path);
instance.register();
Thread t = new Thread(new Runnable() {
public void run() {
Configuration c = new Configuration();
RuntimeEnvironment.getInstance().setConfiguration(c);
}
});
t.start();
t.join();
assertEquals(new File(path).getCanonicalFile().getAbsolutePath(), instance.getDataRootPath());
}
@Test
public void testUrlPrefix() {
RuntimeEnvironment instance = RuntimeEnvironment.getInstance();
assertEquals("/source/s?", instance.getUrlPrefix());
String prefix = "/opengrok/s?";
instance.setUrlPrefix(prefix);
assertEquals(prefix, instance.getUrlPrefix());
}
@Test
public void testCtags() {
RuntimeEnvironment instance = RuntimeEnvironment.getInstance();
assertEquals("ctags", instance.getCtags());
String path = "/usr/bin/ctags";
instance.setCtags(path);
assertEquals(path, instance.getCtags());
}
@Test
public void testHistoryReaderTimeLimit() {
RuntimeEnvironment instance = RuntimeEnvironment.getInstance();
assertEquals(30, instance.getHistoryReaderTimeLimit());
instance.setHistoryReaderTimeLimit(50);
assertEquals(50, instance.getHistoryReaderTimeLimit());
}
@Test
public void testUseHistoryCache() {
RuntimeEnvironment instance = RuntimeEnvironment.getInstance();
assertEquals(true, instance.useHistoryCache());
instance.setUseHistoryCache(false);
assertEquals(false, instance.useHistoryCache());
}
@Test
public void testStoreHistoryCacheInDB() {
RuntimeEnvironment env = RuntimeEnvironment.getInstance();
assertFalse(env.storeHistoryCacheInDB());
env.setStoreHistoryCacheInDB(true);
assertTrue(env.storeHistoryCacheInDB());
}
@Test
public void testGenerateHtml() {
RuntimeEnvironment instance = RuntimeEnvironment.getInstance();
assertTrue(instance.isGenerateHtml());
instance.setGenerateHtml(false);
assertFalse(instance.isGenerateHtml());
}
@Test
public void testCompressXref() {
RuntimeEnvironment instance = RuntimeEnvironment.getInstance();
assertTrue(instance.isCompressXref());
instance.setCompressXref(false);
assertFalse(instance.isCompressXref());
}
@Test
public void testQuickContextScan() {
RuntimeEnvironment instance = RuntimeEnvironment.getInstance();
assertTrue(instance.isQuickContextScan());
instance.setQuickContextScan(false);
assertFalse(instance.isQuickContextScan());
}
@Test
public void testRepositories() {
RuntimeEnvironment instance = RuntimeEnvironment.getInstance();
assertNotNull(instance.getRepositories());
instance.setRepositories(null);
assertNull(instance.getRepositories());
List<RepositoryInfo> reps = new ArrayList<RepositoryInfo>();
instance.setRepositories(reps);
assertSame(reps, instance.getRepositories());
}
@Test
public void testRamBufferSize() {
RuntimeEnvironment instance = RuntimeEnvironment.getInstance();
assertEquals(16, instance.getRamBufferSize(), 0); //default is 16
instance.setRamBufferSize(256);
assertEquals(256, instance.getRamBufferSize(), 0);
}
@Test
public void testVerbose() {
RuntimeEnvironment instance = RuntimeEnvironment.getInstance();
assertFalse(instance.isVerbose());
instance.setVerbose(true);
assertTrue(instance.isVerbose());
}
@Test
public void testAllowLeadingWildcard() {
RuntimeEnvironment instance = RuntimeEnvironment.getInstance();
assertFalse(instance.isAllowLeadingWildcard());
instance.setAllowLeadingWildcard(true);
assertTrue(instance.isAllowLeadingWildcard());
}
@Test
public void testIgnoredNames() {
RuntimeEnvironment instance = RuntimeEnvironment.getInstance();
assertNotNull(instance.getIgnoredNames());
instance.setIgnoredNames(null);
assertNull(instance.getIgnoredNames());
}
@Test
public void testUserPage() {
RuntimeEnvironment instance = RuntimeEnvironment.getInstance();
String page = "http://www.myserver.org/viewProfile.jspa?username=";
assertEquals(page, instance.getUserPage());
instance.setUserPage(page.substring(5));
assertEquals(page.substring(5), instance.getUserPage());
}
@Test
public void testBugPage() {
RuntimeEnvironment instance = RuntimeEnvironment.getInstance();
String page = "http://bugs.myserver.org/bugdatabase/view_bug.do?bug_id=";
assertEquals(page, instance.getBugPage());
instance.setBugPage(page.substring(5));
assertEquals(page.substring(5), instance.getBugPage());
}
@Test
public void testBugPattern() {
RuntimeEnvironment instance = RuntimeEnvironment.getInstance();
String page = "\\b([12456789][0-9]{6})\\b";
assertEquals(page, instance.getBugPattern());
instance.setBugPattern(page.substring(5));
assertEquals(page.substring(5), instance.getBugPattern());
}
@Test
public void testReviewPage() {
RuntimeEnvironment instance = RuntimeEnvironment.getInstance();
String page = "http://arc.myserver.org/caselog/PSARC/";
assertEquals(page, instance.getReviewPage());
instance.setReviewPage(page.substring(5));
assertEquals(page.substring(5), instance.getReviewPage());
}
@Test
public void testReviewPattern() {
RuntimeEnvironment instance = RuntimeEnvironment.getInstance();
String page = "\\b(\\d{4}/\\d{3})\\b";
assertEquals(page, instance.getReviewPattern());
instance.setReviewPattern(page.substring(5));
assertEquals(page.substring(5), instance.getReviewPattern());
}
@Test
public void testWebappLAF() {
RuntimeEnvironment instance = RuntimeEnvironment.getInstance();
assertEquals("default", instance.getWebappLAF());
instance.setWebappLAF("foo");
assertEquals("foo", instance.getWebappLAF());
}
@Test
public void testRemoteScmSupported() {
RuntimeEnvironment instance = RuntimeEnvironment.getInstance();
assertEquals(Configuration.RemoteSCM.OFF, instance.getRemoteScmSupported());
instance.setRemoteScmSupported(Configuration.RemoteSCM.ON);
assertEquals(Configuration.RemoteSCM.ON, instance.getRemoteScmSupported());
instance.setRemoteScmSupported(Configuration.RemoteSCM.DIRBASED);
assertEquals(Configuration.RemoteSCM.DIRBASED, instance.getRemoteScmSupported());
instance.setRemoteScmSupported(Configuration.RemoteSCM.UIONLY);
assertEquals(Configuration.RemoteSCM.UIONLY, instance.getRemoteScmSupported());
}
@Test
public void testOptimizeDatabase() {
RuntimeEnvironment instance = RuntimeEnvironment.getInstance();
assertTrue(instance.isOptimizeDatabase());
instance.setOptimizeDatabase(false);
assertFalse(instance.isOptimizeDatabase());
}
@Test
public void testUsingLuceneLocking() {
RuntimeEnvironment instance = RuntimeEnvironment.getInstance();
assertFalse(instance.isUsingLuceneLocking());
instance.setUsingLuceneLocking(true);
assertTrue(instance.isUsingLuceneLocking());
}
@Test
public void testIndexVersionedFilesOnly() {
RuntimeEnvironment instance = RuntimeEnvironment.getInstance();
assertFalse(instance.isIndexVersionedFilesOnly());
instance.setIndexVersionedFilesOnly(true);
assertTrue(instance.isIndexVersionedFilesOnly());
}
@Test
public void testConfigListenerThread() throws IOException {
RuntimeEnvironment instance = RuntimeEnvironment.getInstance();
SocketAddress addr = new InetSocketAddress(0);
assertTrue(instance.startConfigurationListenerThread(addr));
try {
Thread.sleep(1000);
} catch (InterruptedException exp) {
// do nothing
}
instance.writeConfiguration();
instance.stopConfigurationListenerThread();
}
@Test
public void testXMLencdec() throws IOException {
Configuration c = new Configuration();
String m = c.getXMLRepresentationAsString();
Configuration o = Configuration.makeXMLStringAsConfiguration(m);
assertNotNull(o);
m = m.replace('a', 'm');
try {
o = Configuration.makeXMLStringAsConfiguration(m);
fail("makeXmlStringsAsConfiguration should throw exception");
} catch (Throwable t) {
}
}
@Test
public void testBug3095() throws IOException {
RuntimeEnvironment instance = RuntimeEnvironment.getInstance();
File file = new File("foobar");
assertTrue(file.createNewFile());
assertFalse(file.isAbsolute());
instance.setDataRoot(file.getName());
File f = instance.getDataRootFile();
assertNotNull(f);
assertEquals("foobar", f.getName());
assertTrue(f.isAbsolute());
assertTrue(file.delete());
}
@Test
public void testBug3154() throws IOException {
RuntimeEnvironment instance = RuntimeEnvironment.getInstance();
File file = File.createTempFile("dataroot", null);
assertTrue(file.delete());
assertFalse(file.exists());
instance.setDataRoot(file.getAbsolutePath());
// The point of this test was to verify that setDataRoot() created
// the directory, but that logic has been moved as of bug 16986, so
// expect that the file does not exist.
assertFalse(file.exists());
}
@Test
public void testObfuscateEMail() throws IOException {
RuntimeEnvironment env = RuntimeEnvironment.getInstance();
// By default, don't obfuscate.
assertObfuscated(false, env);
env.setObfuscatingEMailAddresses(true);
assertObfuscated(true, env);
env.setObfuscatingEMailAddresses(false);
assertObfuscated(false, env);
}
private void assertObfuscated(boolean expected, RuntimeEnvironment env)
throws IOException {
assertEquals(expected, env.isObfuscatingEMailAddresses());
String address = "discuss@opengrok.java.net";
PlainXref xref = new PlainXref(new StringReader(address));
StringWriter out = new StringWriter();
xref.write(out);
String expectedAddress = expected ?
address.replace("@", " (at) ") : address;
String expectedOutput =
"<a class=\"l\" name=\"1\" href=\"#1\">1</a>"
+ expectedAddress;
assertEquals(expectedOutput, out.toString());
}
@Test
public void isChattyStatusPage() {
RuntimeEnvironment env = RuntimeEnvironment.getInstance();
// By default, status page should not be chatty.
assertFalse(env.isChattyStatusPage());
env.setChattyStatusPage(true);
assertTrue(env.isChattyStatusPage());
env.setChattyStatusPage(false);
assertFalse(env.isChattyStatusPage());
}
}