/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can obtain
* a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
* or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
* Sun designates this particular file as subject to the "Classpath" exception
* as provided by Sun in the GPL Version 2 section of the License file that
* accompanied this code. If applicable, add the following below the License
* Header, with the fields enclosed by brackets [] replaced by your own
* identifying information: "Portions Copyrighted [year]
* [name of copyright owner]"
*
* Contributor(s):
*
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.enterprise.tools.verifier.tests.web;
import com.sun.enterprise.tools.verifier.tests.VerifierTest;
import com.sun.enterprise.tools.verifier.tests.*;
import com.sun.enterprise.tools.verifier.Verifier;
import com.sun.enterprise.tools.verifier.Result;
import com.sun.enterprise.deployment.Descriptor;
import com.sun.enterprise.deployment.WebBundleDescriptor;
import com.sun.enterprise.deployment.util.ModuleDescriptor;
import com.sun.enterprise.tools.verifier.Context;
import com.sun.enterprise.util.io.FileUtils;
import java.io.*;
/**
* Common code and helper methods and properties for all tests
* in the web-app space (jsp and servlets).
*
* @author Jerome Dochez
* @version 1.0
*/
abstract public class WebTest extends VerifierTest implements VerifierCheck, WebCheck {
// variables ensuring that result details are added only once
private boolean addedError = false;
private boolean addedGood = false;
private boolean addedNa = false;
private boolean addedWarning = false;
final String separator= System.getProperty("file.separator");
Context context = null;
/**
* <p>
* run an individual test against the deployment descriptor for the
* archive the verifier is performing compliance tests against.
* </p>
*
* @param descriptor deployment descriptor for the archive
* @return result object containing the result of the individual test
* performed
*/
public Result check(Descriptor descriptor) {
return check((WebBundleDescriptor) descriptor);
}
/**
* <p>
* all connector tests should implement this method. it run an individual
* test against the resource adapter deployment descriptor.
* </p>
*
* @param descriptor deployment descriptor for the archive file
* @return result object containing the result of the individual test
* performed
*/
public abstract Result check(WebBundleDescriptor descriptor);
/**
* load the war file
*
* @param descriptor the Enumeration
*
* @return <code>Result</code> the results for this assertion
*/
public Result loadWarFile(WebBundleDescriptor descriptor) {
Result result = getInitializedResult();
ComponentNameConstructor compName = getVerifierContext().getComponentNameConstructor();
context = getVerifierContext();
try {
// TODO : check whether this method is required?
WebTestsUtil webTestsUtil = WebTestsUtil.getUtil(context.getClassLoader());
// File f = Verifier.getArchiveFile(descriptor.getModuleDescriptor().
// getArchiveUri());
// if (f != null) {
// webTestsUtil.extractJarFile(f);
// }
// else {
// // dont bother about extracting JarFile
// }
//Sheetal: 09/30/02
//dont need to call Verifier's appendCLWithWebInfContents() since J2EEClassLoader takes care of it
//webTestsUtil.appendCLWithWebInfContents();
} catch (Throwable e) {
// e.printStackTrace();
Verifier.debug(e);
result.addErrorDetails(smh.getLocalString
("tests.componentNameConstructor",
"For [ {0} ]",
new Object[] {compName.toString()}));
result.addErrorDetails(smh.getLocalString
("com.sun.enterprise.tools.verifier.tests.web.WebTest" + ".Exception",
"Error: Unexpected exception occurred [ {0} ]",
new Object[] {e.toString()}));
}
return result;
}
/**
* <p>
* load a class from the web bundle archive file
* </p>
*
* @param result to put error if necessary
* @param className the class to load
* @return the loaded class or null is cannot be loaded from the archive
*/
public Class loadClass(Result result, String className) {
try {
WebTestsUtil webTestsUtil = WebTestsUtil.getUtil(context.getClassLoader());
//webTestsUtil.appendCLWithWebInfContents();
return webTestsUtil.loadClass(className);
} catch (Throwable e) {
// @see preVerify Method of Verifier.java
try {
ClassLoader cl = getVerifierContext().getAlternateClassLoader();
if (cl == null) {
throw e;
}
Class c = cl.loadClass(className);
return c;
}catch(Throwable ex) {
/*
result.addErrorDetails(smh.getLocalString
("com.sun.enterprise.tools.verifier.tests.web.WebTest.Exception",
"Error: Unexpected exception occurred [ {0} ]",
new Object[] {ex.toString()}));
*/
}
}
return null;
}
/**
* Method for recursively deleting all temporary directories
*/
protected void deleteDirectory(String oneDir) {
File[] listOfFiles;
File cleanDir;
cleanDir = new File(oneDir);
if (!cleanDir.exists()) {// Nothing to do. Return;
return;
}
listOfFiles = cleanDir.listFiles();
if(listOfFiles != null) {
for(int countFiles = 0; countFiles < listOfFiles.length; countFiles++) {
if (listOfFiles[countFiles].isFile()) {
listOfFiles[countFiles].delete();
} else { // It is a directory
String nextCleanDir = cleanDir + separator + listOfFiles[countFiles].getName();
File newCleanDir = new File(nextCleanDir);
deleteDirectory(newCleanDir.getAbsolutePath());
}
}// End for loop
} // End if statement
cleanDir.delete();
}
protected String getAbstractArchiveUri(WebBundleDescriptor desc) {
String archBase = getVerifierContext().getAbstractArchive().
getArchiveUri();
final ModuleDescriptor moduleDescriptor = desc.getModuleDescriptor();
if (moduleDescriptor.isStandalone()) {
return archBase; // it must be a stand-alone module; no such physical dir exists
} else {
return archBase + File.separator +
FileUtils.makeFriendlyFileName(moduleDescriptor.getArchiveUri());
}
}
}
|
