/*
Derby - Class
org.apache.derbyTesting.functionTests.tests.derbynet.SysinfoTest
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.derbyTesting.functionTests.tests.derbynet;
import java.io.File;
import java.net.URL;
import java.security.AccessController;
import java.util.Properties;
import junit.framework.Test;
import junit.framework.TestSuite;
import org.apache.derbyTesting.junit.BaseJDBCTestCase;
import org.apache.derbyTesting.junit.Derby;
import org.apache.derbyTesting.junit.JDBC;
import org.apache.derbyTesting.junit.NetworkServerTestSetup;
import org.apache.derbyTesting.junit.SecurityManagerSetup;
import org.apache.derbyTesting.junit.SupportFilesSetup;
import org.apache.derbyTesting.junit.SystemPropertyTestSetup;
import org.apache.derbyTesting.junit.TestConfiguration;
/**
This tests the sysinfo command
*/
public class SysinfoTest extends BaseJDBCTestCase {
private static String TARGET_POLICY_FILE_NAME="sysinfo.policy";
private String [] OUTPUT;
/**
* Set to true before adding a test to the suite to add some extra properties.
*/
private static boolean useProperties = false;
/**
* Default constructor
* @param name
*/
public SysinfoTest(String name) {
super(name);
/**
* Output from sysinfo without the extra properties.
*/
String [] OUTPUT1 = {
"--------- Derby Network Server Information --------" ,
"derby.drda.maxThreads=0" ,
"derby.drda.sslMode=off" ,
"derby.drda.keepAlive=true" ,
"derby.drda.minThreads=0" ,
"derby.drda.portNumber="+TestConfiguration.getCurrent().getPort(),
"derby.drda.logConnections=false" ,
"derby.drda.timeSlice=0" ,
"derby.drda.startNetworkServer=false" ,
"derby.drda.traceAll=false" ,
"--------- Derby Information --------" ,
"------------------------------------------------------" ,
"----------------- Locale Information -----------------" ,
"------------------------------------------------------"};
/**
* Output by sysinfo with the extra properties.
*/
String [] OUTPUT2 = {
"--------- Derby Network Server Information --------" ,
"derby.drda.securityMechanism=USER_ONLY_SECURITY" ,
"derby.drda.maxThreads=0" ,
"derby.drda.sslMode=off" ,
"derby.drda.keepAlive=true" ,
"derby.drda.minThreads=0" ,
"derby.drda.portNumber="+TestConfiguration.getCurrent().getPort() ,
"derby.drda.logConnections=false" ,
"derby.drda.timeSlice=0" ,
"derby.drda.startNetworkServer=false" ,
"derby.drda.traceAll=false" ,
"--------- Derby Information --------" ,
"------------------------------------------------------" ,
"----------------- Locale Information -----------------" ,
"------------------------------------------------------"};
if (useProperties)
OUTPUT = OUTPUT2;
else
OUTPUT = OUTPUT1;
}
/**
* Creates a suite with two testcases, with and without some extra
* system properties.
*
* @return an empty suite if derbynet.jar is not available, and
* if the JVM only supports JSR169, otherwise, return a suite with
* 6 tests, 3 with properties set, 3 without.
*/
public static Test suite() {
TestSuite suite = new TestSuite("SysinfoTest");
// we need to be able to run the server
if (!Derby.hasServer()) return suite;
// don't run with JSR169 for this is a network server test
if (JDBC.vmSupportsJSR169()) return suite;
useProperties = false;
// a call to sysinfo will eventually attempt to load resource
// org.apache.derby.info.DBMS.properties.
// If we're using classes, we don't have read permission for the dir.
// So, figure out the path & pass the property on so the reference
// in the policy file can be resolved.
// Note: can't use $derbyTesting.codeclasses as on windows it has
// the slashes adjusted.
if (!TestConfiguration.loadingFromJars()) {
Properties propstmp = new Properties();
propstmp.put("sysinfotest.classesdir", findClassDir());
suite.addTest(new SystemPropertyTestSetup(decorateTest(), propstmp));
}
else
suite.addTest(decorateTest());
useProperties = true;
Properties props = new Properties();
if (!TestConfiguration.loadingFromJars())
props.put("sysinfotest.classesdir", findClassDir());
props.put("derby.infolog.append","true");
props.put("derby.locks.waitTimeout","120");
props.put("derby.language.logStatementText","true");
//#drda property ,test for it in sysinfo output
props.put("derby.drda.securityMechanism","USER_ONLY_SECURITY");
suite.addTest(new SystemPropertyTestSetup(decorateTest(), props));
return suite;
}
private String makePolicyName() {
try {
String userDir = getSystemProperty( "user.dir" );
String fileName = userDir + File.separator +
SupportFilesSetup.EXTINOUT + File.separator + TARGET_POLICY_FILE_NAME;
File file = new File( fileName );
String urlString = file.toURL().toExternalForm();
return urlString;
}
catch (Exception e) {
fail("Unexpected exception caught by " +
"makeServerPolicyName(): " + e );
return null;
}
}
/**
* Decorate a test with SecurityManagerSetup, clientServersuite, and
* SupportFilesSetup.
*
* @return the decorated test
*/
private static Test decorateTest() {
String policyName = new SysinfoTest("test").makePolicyName();
Test test = TestConfiguration.clientServerSuite(SysinfoTest.class);
// Install a security manager using the initial policy file.
test = TestConfiguration.singleUseDatabaseDecorator(
new SecurityManagerSetup(test, policyName));
// Copy over the policy file we want to use.
String POLICY_FILE_NAME=
"functionTests/tests/derbynet/SysinfoTest.policy";
test = new SupportFilesSetup
(
test,
null,
new String[] { POLICY_FILE_NAME },
null,
new String[] { TARGET_POLICY_FILE_NAME}
);
return test;
}
/**
* Test sysinfo
*
* @throws Exception
*/
public void testSysinfo() throws Exception {
String[] SysInfoCmd =
new String[] {"org.apache.derby.drda.NetworkServerControl", "sysinfo",
"-p", String.valueOf(TestConfiguration.getCurrent().getPort())};
Process p = execJavaCmd(SysInfoCmd);
String s = readProcessOutput(p);
s = sed(s);
print("testSysinfo", s);
assertMatchingStringExists(s);
}
/**
* Test sysinfo by calling NetworkServerControl.getSysinfo()
*
* @throws Exception
*/
public void testSysinfoMethod() throws Exception {
String s = NetworkServerTestSetup.
getNetworkServerControl(TestConfiguration.getCurrent().getPort()).getSysinfo();
s = sed(s);
print("testSysinfoMethod", s);
assertMatchingStringExists(s);
}
/**
* Test sysinfo w/ foreign (non-English) locale.
*
* @throws Exception
*/
public void testSysinfoLocale() throws Exception {
String[] SysInfoLocaleCmd =
new String[] {"-Duser.language=de", "-Duser.country=DE",
"org.apache.derby.drda.NetworkServerControl", "sysinfo",
"-p", String.valueOf(TestConfiguration.getCurrent().getPort())};
Process p = execJavaCmd(SysInfoLocaleCmd);
String s = readProcessOutput(p);
//System.out.println("before sed");
//System.out.println(s);
s = sed(s);
//System.out.println("after sed");
//System.out.println(s);
print("testSysinfoLocale", s);
assertMatchingStringExists(s);
}
/**
* Removes lines containing a number of preset words from the given string.
* Also trims the string to make it easier to compare.
*
* @param s the string to remove lines from
* @return the string with the lines removed
*/
private String sed(String s) {
/**
* Lines containing these strings will be deleted from the output before
* asserting that output is correct.
* ibm jvm prints extra line for java.fullversion
*/
String[] sed = {"Version", "version", "Java", "OS",
"J9VM", "JIT", "GC",
"[0-9*]\\.[0-9*]\\.[0-9*]","JRE - JDBC","derby.drda.traceDirectory",
"Unable to access Protection Domain","listing properties",
"Current Locale", //Remove these because locale info is
"Found support for locale:" //not printed when running from jars..
};
for (int i = 0; i < sed.length; i++) {
// first, replace \r\n with \n, that's needed if we're on
// windows
s = s.replaceAll("\r\n", "\n");
s = s.replaceAll("(?m)^.*" + sed[i] + ".*\n", "");
}
s = s.trim();
return s;
}
/**
* Prints strings to System.out to make it easier to update the tests
* when the output changes if derby.tests.debug is true.
*
* @param name just a label to identify the string
* @param s the string to be printed
*/
private void print(String name,String s) {
println("\n\n>>>" + name + ">>>");
println(s);
println("<<<" + name + "<<<\n\n");
}
public void tearDown() throws Exception {
super.tearDown();
TARGET_POLICY_FILE_NAME = null;
OUTPUT = null;
}
private static String findClassDir() {
URL url = null;
try {
final Class cl = Class.forName("org.apache.derbyTesting." +
"functionTests.tests.derbynet.SysinfoTest");
url = (URL)
AccessController.doPrivileged(new java.security.PrivilegedAction() {
public Object run() {
return cl.getProtectionDomain().getCodeSource().getLocation();
}
});
} catch (ClassNotFoundException e) {
// need catch to silence compiler, but as we're referring to *this*
// class, it ok to ignore this.
}
return url.getPath();
}
private void assertMatchingStringExists(String actualOutput) {
String delimiter = "\n";
String [] actualOutputArray = actualOutput.split(delimiter);
int lineCount = actualOutputArray.length;
assertEquals(OUTPUT.length, lineCount);
for (int i=0 ; i<lineCount ; i++)
{
String fullExpOutput="";
for (int j=0 ; j < OUTPUT.length; j++) {
fullExpOutput=fullExpOutput + OUTPUT[j] + "\n";
}
String ns = actualOutputArray[i];
assertTrue("Output string: " + ns +
"\ndoesn't match any of the expected strings: \n" +
fullExpOutput,
searchMatchingString(ns));
}
}
private boolean searchMatchingString(String substring){
for (int i=0; i<OUTPUT.length;i++)
{
if (!substring.equals(OUTPUT[i]))
continue;
else return true;
}
return false;
}
}