Creating a branch for the equinox work.

git-svn-id: http://svn.us.apache.org/repos/asf/tuscany@694816 13f79535-47bb-0310-9956-ffa450edef68

2 files changed, 641 insertions, 0 deletions

diff --git a/branches/sca-equinox/modules/host-webapp-junit/src/main/java/org/apache/tuscany/sca/host/webapp/junit/JUnitServletFilter.java b/branches/sca-equinox/modules/host-webapp-junit/src/main/java/org/apache/tuscany/sca/host/webapp/junit/JUnitServletFilter.java
new file mode 100644
index 0000000000..b2d3d0abf1
--- /dev/null
+++ b/branches/sca-equinox/modules/host-webapp-junit/src/main/java/org/apache/tuscany/sca/host/webapp/junit/JUnitServletFilter.java
@@ -0,0 +1,355 @@
+/*
+ * 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.tuscany.sca.host.webapp.junit;
+
+import java.io.EOFException;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.PrintStream;
+import java.lang.reflect.Field;
+import java.lang.reflect.Modifier;
+import java.net.URL;
+import java.net.URLClassLoader;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Set;
+import java.util.jar.JarEntry;
+import java.util.jar.JarInputStream;
+import java.util.logging.Logger;
+import java.util.regex.Pattern;
+
+import javax.servlet.Filter;
+import javax.servlet.FilterChain;
+import javax.servlet.FilterConfig;
+import javax.servlet.ServletContext;
+import javax.servlet.ServletException;
+import javax.servlet.ServletRequest;
+import javax.servlet.ServletResponse;
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+
+import junit.framework.AssertionFailedError;
+
+import org.junit.runner.JUnitCore;
+import org.junit.runner.Request;
+import org.junit.runner.Result;
+import org.junit.runner.notification.Failure;
+
+/**
+ * @version $Rev$ $Date$
+ */
+public class JUnitServletFilter implements Filter {
+    private static final Logger logger = Logger.getLogger(JUnitServletFilter.class.getName());
+
+    private static final String JUNIT_TESTS_PATTERN = "junit.tests.pattern";
+    private static final String JUNIT_TESTS_PATH = "junit.tests.path";
+    private static final String JUNIT_ENABLED = "junit.enabled";
+    private static final String TESTCASE_PATTERN = ".*TestCase";
+    private static final String TESTS_JAR = "/WEB-INF/test-lib/junit-tests.jar";
+
+    private FilterConfig config;
+    private boolean junitEnabled = true;
+    private Set<String> allTestCases;
+    private ClassLoader testClassLoader;
+
+    private Set<String> findTestCases(String testJarPath) throws IOException {
+        Pattern pattern = getTestCasePattern();
+        if (testJarPath.endsWith(".jar")) {
+            return findTestCasesInJar(testJarPath, pattern);
+        } else {
+            return findTestCasesInDir(testJarPath, pattern);
+        }
+    }
+
+    /**
+     * Search test cases in a JAR
+     * @param testJarPath
+     * @param pattern
+     * @return
+     * @throws IOException
+     */
+    private Set<String> findTestCasesInJar(String testJarPath, Pattern pattern) throws IOException {
+        InputStream in = config.getServletContext().getResourceAsStream(testJarPath);
+        Set<String> tests = new HashSet<String>();
+        if (in != null) {
+            JarInputStream jar = new JarInputStream(in);
+            try {
+                JarEntry entry = null;
+
+                while ((entry = jar.getNextJarEntry()) != null) {
+                    String name = entry.getName();
+
+                    if (name.endsWith(".class")) {
+                        String className = name.substring(0, name.length() - 6).replace('/', '.');
+                        if (pattern.matcher(className).matches()) {
+                            tests.add(className);
+                        }
+                    }
+                }
+            } catch (EOFException e) {
+            } finally {
+                if (jar != null) {
+                    try {
+                        jar.close();
+                    } catch (IOException e) {
+                    }
+                }
+            }
+
+        }
+        return tests;
+    }
+
+    private Pattern getTestCasePattern() {
+        String filter = config.getInitParameter(JUNIT_TESTS_PATTERN);
+        if (filter == null) {
+            filter = TESTCASE_PATTERN;
+        }
+        Pattern pattern = Pattern.compile(filter);
+        return pattern;
+    }
+
+    public void destroy() {
+    }
+
+    private void init() throws IOException {
+        testClassLoader = Thread.currentThread().getContextClassLoader();
+        allTestCases = new HashSet<String>();
+        String testsPath = config.getInitParameter(JUNIT_TESTS_PATH);
+        if (testsPath == null) {
+            testsPath = TESTS_JAR;
+        }
+        URL url = config.getServletContext().getResource(testsPath);
+        if (url != null) {
+            allTestCases = findTestCases(testsPath);
+            if (!(testsPath.startsWith("/WEB-INF/lib/") || testsPath.startsWith("/WEB-INF/classes/"))) {
+                // Create a new ClassLoader to load the test jar
+                testClassLoader = new URLClassLoader(new URL[] {url}, testClassLoader);
+            }
+        }
+    }
+
+    /**
+     * Search test cases in a directory
+     * @param classesPath
+     * @param pattern
+     * @return
+     */
+    private Set<String> findTestCasesInDir(String classesPath, Pattern pattern) {
+        ServletContext context = config.getServletContext();
+        Set<String> tests = new HashSet<String>();
+        String dir = classesPath;
+        findResources(context, pattern, tests, classesPath, dir);
+        return tests;
+    }
+
+    @SuppressWarnings("unchecked")
+    private void findResources(ServletContext context, Pattern pattern, Set<String> tests, String root, String dir) {
+        Set<String> paths = context.getResourcePaths(dir);
+        if (paths != null) {
+            for (String name : paths) {
+                if (name.endsWith("/")) {
+                    findResources(context, pattern, tests, root, name);
+                }
+                if (name.endsWith(".class")) {
+                    String className = name.substring(root.length(), name.length() - 6).replace('/', '.');
+                    if (pattern.matcher(className).matches()) {
+                        tests.add(className);
+                    }
+                }
+            }
+        }
+    }
+
+    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException,
+        ServletException {
+
+        if (!junitEnabled) {
+            chain.doFilter(request, response);
+            return;
+        }
+
+        HttpServletRequest req = (HttpServletRequest)request;
+        HttpServletResponse resp = (HttpServletResponse)response;
+
+        if (!req.getRequestURI().equals(req.getContextPath() + "/junit")) {
+            // Intercept the /junit call
+            chain.doFilter(request, response);
+            return;
+        }
+
+        String query = req.getQueryString();
+        PrintStream ps = new PrintStream(response.getOutputStream());
+
+        Set<String> testCases = null;
+        // ClassLoader cl = Thread.currentThread().getContextClassLoader();
+        String op = req.getParameter("op");
+        if (query == null || op == null || "list".equalsIgnoreCase(op)) {
+            response.setContentType("text/html");
+            resp.setStatus(HttpServletResponse.SC_OK);
+            ps.println("<html><body>");
+            ps.println("<h2>Available Test Cases</h2><p>");
+            ps.println("<form method=\"get\" action=\"junit\">");
+            ps.println("<table border=\"1\">");
+            for (String s : this.allTestCases) {
+                ps.print("<tr><td>");
+                ps.print("<input type=\"checkbox\" name=\"test\" value=\"" + s
+                    + "\"/><a href=\"junit?op=runSelected&test="
+                    + s
+                    + "\">"
+                    + s
+                    + "</a>");
+                ps.println("</td></tr>");
+            }
+            ps.println("</table>");
+            ps.println("<p><input type=\"submit\" name=\"op\" value=\"RunSelected\"/>");
+            ps.println("<input type=\"submit\" name=\"op\" value=\"RunAll\"/>");
+            ps.println("</form></body></html>");
+            resp.flushBuffer();
+            return;
+        } else {
+            if ("runAll".equalsIgnoreCase(op)) {
+                testCases = this.allTestCases;
+            } else {
+                String[] tests = req.getParameterValues("test");
+                if (tests == null) {
+                    tests = new String[0];
+                }
+                testCases = new HashSet<String>(Arrays.asList(tests));
+            }
+        }
+
+        response.setContentType("application/xml");
+        ps.println("<?xml version=\"1.0\" encoding=\"" + "UTF-8" + "\"?>");
+
+        ServletContext context = config.getServletContext();
+        Object domain = context.getAttribute("org.apache.tuscany.sca.SCADomain");
+        URL contribution = context.getResource("/META-INF/sca-contribution.xml");
+
+        long duration = 0L;
+        int errors = 0;
+        int failures = 0;
+        int runs = 0;
+        List<Class<?>> testClasses = new ArrayList<Class<?>>();
+        List<Result> results = new ArrayList<Result>();
+        for (String testClass : testCases) {
+            Class<?> test = null;
+            try {
+                test = Class.forName(testClass, false, testClassLoader);
+                if (domain != null && contribution != null) {
+                    // Inject the SCADomain
+                    inject(test, domain);
+                }
+                testClasses.add(test);
+            } catch (ClassNotFoundException e) {
+                String st = XMLFormatter.exceptionToString(e);
+                st = XMLFormatter.escape(st);
+                ps.println(st);
+                // ps.close();
+                throw new ServletException(e);
+            }
+
+            JUnitCore core = new JUnitCore();
+            Result result = core.run(Request.aClass(test));
+            results.add(result);
+
+            duration += result.getRunTime();
+            runs += result.getRunCount();
+
+            for (Failure f : result.getFailures()) {
+                if (f.getException() instanceof AssertionFailedError) {
+                    failures++;
+                } else {
+                    errors++;
+                }
+            }
+        }
+
+        ps.println("<" + XMLFormatter.TESTSUITE
+            + " "
+            + XMLFormatter.ATTR_TESTS
+            + "=\""
+            + runs
+            + "\" "
+            + XMLFormatter.ATTR_FAILURES
+            + "=\""
+            + failures
+            + "\" "
+            + XMLFormatter.ATTR_ERRORS
+            + "=\""
+            + errors
+            + "\" "
+            + XMLFormatter.ATTR_TIME
+            + "=\""
+            + XMLFormatter.getDurationAsString(duration)
+            + "\">");
+        for (int i = 0; i < testClasses.size(); i++) {
+            ps.println(XMLFormatter.toXML(results.get(i), testClasses.get(i)));
+        }
+        ps.println("</" + XMLFormatter.TESTSUITE + ">");
+
+        resp.addIntHeader("junit.errors", errors);
+        resp.addIntHeader("junit.failures", failures);
+        resp.addIntHeader("junit.runs", runs);
+        resp.setStatus(HttpServletResponse.SC_OK);
+        resp.flushBuffer();
+        
+        ps.close();    
+    }
+
+    private boolean inject(Class<?> cls, Object target) {
+        for (Field f : cls.getDeclaredFields()) {
+            if (Modifier.isStatic(f.getModifiers()) && f.getType().isInstance(target)) {
+                f.setAccessible(true);
+                try {
+                    f.set(null, target);
+                    return true;
+                } catch (IllegalArgumentException e) {
+                    return false;
+                } catch (IllegalAccessException e) {
+                    return false;
+                }
+            }
+        }
+        return false;
+    }
+
+    public void init(FilterConfig config) throws ServletException {
+        this.config = config;
+        // Check if the /junit path should be allowed
+        String param = config.getInitParameter(JUNIT_ENABLED);
+        if (param != null && param.trim().equals("false")) {
+            junitEnabled = false;
+            return;
+        }
+        try {
+            init();
+        } catch (IOException e) {
+            throw new ServletException(e);
+        }
+    }
+
+    public boolean isJunitEnabled() {
+        return junitEnabled;
+    }
+
+}
diff --git a/branches/sca-equinox/modules/host-webapp-junit/src/main/java/org/apache/tuscany/sca/host/webapp/junit/XMLFormatter.java b/branches/sca-equinox/modules/host-webapp-junit/src/main/java/org/apache/tuscany/sca/host/webapp/junit/XMLFormatter.java
new file mode 100644
index 0000000000..72ec478cd6
--- /dev/null
+++ b/branches/sca-equinox/modules/host-webapp-junit/src/main/java/org/apache/tuscany/sca/host/webapp/junit/XMLFormatter.java
@@ -0,0 +1,286 @@
+/* 
+ * ========================================================================
+ * 
+ * Copyright 2001-2005 The Apache Software Foundation.
+ *
+ * Licensed 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.tuscany.sca.host.webapp.junit;
+
+import java.io.BufferedReader;
+import java.io.IOException;
+import java.io.PrintWriter;
+import java.io.StringReader;
+import java.io.StringWriter;
+import java.text.NumberFormat;
+import java.util.Locale;
+
+import junit.framework.AssertionFailedError;
+
+import org.junit.runner.Result;
+import org.junit.runner.notification.Failure;
+
+/**
+ * Format the test results in XML.
+ *
+ * @version $Id: XMLFormatter.java 239169 2005-05-05 09:21:54Z vmassol $
+ */
+public class XMLFormatter {
+    /**
+     * Errors attribute for TestSuite elements
+     */
+    public static final String ATTR_ERRORS = "errors";
+
+    /**
+     * Failures attribute for TestSuite elements
+     */
+    public static final String ATTR_FAILURES = "failures";
+
+    /**
+     * Message attribute for failure elements (message of the exception)
+     */
+    public static final String ATTR_MESSAGE = "message";
+
+    /**
+     * Name attribute for property, TestCase and TestSuite elements
+     */
+    public static final String ATTR_NAME = "name";
+
+    /**
+     * Tests attribute for TestSuite elements (number of tests executed)
+     */
+    public static final String ATTR_TESTS = "tests";
+
+    /**
+     * Time attribute for TestCase and TestSuite elements
+     */
+    public static final String ATTR_TIME = "time";
+
+    /**
+     * Type attribute for failure and error elements
+     */
+    public static final String ATTR_TYPE = "type";
+
+    /**
+     * Default stack filter patterns.
+     */
+    private static final String[] DEFAULT_STACK_FILTER_PATTERNS =
+        new String[] {"junit.framework.TestCase", "junit.framework.TestResult", "junit.framework.TestSuite",
+                      "junit.framework.Assert.", // don't filter AssertionFailure
+                      "java.lang.reflect.Method.invoke("};
+
+    /**
+     * The number format used to convert durations into strings. Don't use the
+     * default locale for that, because the resulting string needs to use 
+     * dotted decimal notation for an XSLT transformation to work correctly.
+     */
+    private static NumberFormat durationFormat = NumberFormat.getInstance(Locale.US);
+
+    /**
+     * The error element (for a test case)
+     */
+    public static final String ERROR = "error";
+
+    /**
+     * The failure element (for a test case)
+     */
+    public static final String FAILURE = "failure";
+
+    /**
+     * A single TestCase element
+     */
+    public static final String TESTCASE = "testcase";
+
+    /**
+     * A single test suite results.
+     */
+    public static final String TESTSUITE = "testsuite";
+
+    /**
+     * Escapes reserved XML characters.
+     *
+     * @param theString the string to escape
+     * @return the escaped string
+     */
+    public static String escape(String theString) {
+        String newString;
+
+        // It is important to replace the "&" first as the other replacements
+        // also introduces "&" chars ...
+        newString = theString.replace("&", "&amp;");
+
+        newString = newString.replace("<", "&lt;");
+        newString = newString.replace(">", "&gt;");
+        newString = newString.replace("\"", "&quot;");
+
+        return newString;
+    }
+
+    /**
+     * Returns the stack trace of an exception as String.
+     * 
+     * @param theThrowable the exception from which to extract the stack trace
+     *        as a String
+     * @return the exception stack trace as a String
+     */
+    public static String exceptionToString(Throwable theThrowable) {
+        return exceptionToString(theThrowable, null);
+    }
+
+    /**
+     * Returns the stack trace of an exception as String, optionally filtering
+     * out line from the stack trace
+     * 
+     * @param theThrowable the exception from which to extract the stack trace
+     *        as a String
+     * @param theFilterPatterns Array containing a list of patterns to filter 
+     *        out from the stack trace
+     * @return the exception stack trace as a String
+     */
+    public static String exceptionToString(Throwable theThrowable, String[] theFilterPatterns) {
+        StringWriter sw = new StringWriter();
+        PrintWriter pw = new PrintWriter(sw);
+
+        theThrowable.printStackTrace(pw);
+        String stackTrace = sw.toString();
+        return filterStackTrace(stackTrace, theFilterPatterns);
+    }
+
+    /**
+     * 
+     * 
+     * @param theLine The line to check
+     * @param theFilterPatterns The patterns to filter out
+     * @return boolean Whether the specified line should be filtered from the
+     *         stack trace
+     */
+    public static boolean filterLine(String theLine, String[] theFilterPatterns) {
+        for (int i = 0; i < theFilterPatterns.length; i++) {
+            if (theLine.indexOf(theFilterPatterns[i]) > 0) {
+                return true;
+            }
+        }
+        return false;
+    }
+
+    /**
+     * 
+     * 
+     * @param theStackTrace The original, unfiltered stack trace
+     * @param theFilterPatterns The patterns to filter out
+     * @return The filtered stack trace
+     */
+    static String filterStackTrace(String theStackTrace, String[] theFilterPatterns) {
+        if ((theFilterPatterns == null) || (theFilterPatterns.length == 0) || (theStackTrace == null)) {
+            return theStackTrace;
+        }
+
+        StringWriter stringWriter = new StringWriter();
+        PrintWriter printWriter = new PrintWriter(stringWriter);
+        StringReader stringReader = new StringReader(theStackTrace);
+        BufferedReader bufferedReader = new BufferedReader(stringReader);
+
+        String line;
+        try {
+            while ((line = bufferedReader.readLine()) != null) {
+                if (!filterLine(line, theFilterPatterns)) {
+                    printWriter.println(line);
+                }
+            }
+        } catch (IOException e) {
+            return theStackTrace;
+        }
+        return stringWriter.toString();
+    }
+
+    /**
+     * Convert a duration expressed as a long into a string.
+     *
+     * @param theDuration the duration to convert to string
+     * @return the total duration as a string
+     */
+    public static String getDurationAsString(long theDuration) {
+        return durationFormat.format((double)theDuration / 1000);
+    }
+
+    public static String toXML(Failure failure) {
+        StringBuffer xml = new StringBuffer();
+        Throwable ex = failure.getException();
+        String tag = (ex instanceof AssertionFailedError) ? FAILURE : ERROR;
+        xml.append("<" + tag
+            + " "
+            + ATTR_MESSAGE
+            + "=\""
+            + escape(ex.getMessage())
+            + "\" "
+            + ATTR_TYPE
+            + "=\""
+            + ex.getClass().getName()
+            + "\">");
+        xml.append(escape(exceptionToString(ex, DEFAULT_STACK_FILTER_PATTERNS)));
+        xml.append("</" + tag + ">");
+
+        return xml.toString();
+    }
+
+    /**
+     * Formats the test result as an XML string.
+     *
+     * @param result the test result object
+     * @return the XML string representation of the test results
+     */
+    public static String toXML(Result result, Class<?> cls) {
+        int failures = 0, errors = 0;
+        for (Failure f : result.getFailures()) {
+            if (f.getException() instanceof AssertionFailedError) {
+                failures++;
+            } else {
+                errors++;
+            }
+        }
+        StringBuffer xml = new StringBuffer();
+
+        xml.append("<" + TESTCASE
+            + " "
+            + ATTR_NAME
+            + "=\""
+            + cls.getName()
+            + "\" "
+            + ATTR_TESTS
+            + "=\""
+            + result.getRunCount()
+            + "\" "
+            + ATTR_FAILURES
+            + "=\""
+            + failures
+            + "\" "
+            + ATTR_ERRORS
+            + "=\""
+            + errors
+            + "\" "
+            + ATTR_TIME
+            + "=\""
+            + getDurationAsString(result.getRunTime())
+            + "\">");
+
+        for (Failure f : result.getFailures()) {
+            xml.append(toXML(f));
+        }
+
+        xml.append("</" + TESTCASE + ">");
+
+        return xml.toString();
+    }
+}