test/tools/Suite.java

5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster/**
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster *
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * Copyright (c) 2006 Sun Microsystems Inc. All Rights Reserved
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster *
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * The contents of this file are subject to the terms
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * of the Common Development and Distribution License
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * (the License). You may not use this file except in
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * compliance with the License.
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster *
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * You can obtain a copy of the License at
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * https://opensso.dev.java.net/public/CDDLv1.0.html or
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * opensso/legal/CDDLv1.0.txt
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * See the License for the specific language governing
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * permission and limitations under the License.
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster *
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * When distributing Covered Code, include this CDDL
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * Header Notice in each file and include the License file
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * at opensso/legal/CDDLv1.0.txt.
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * If applicable, add the following below the CDDL Header,
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * with the fields enclosed by brackets [] replaced by
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * your own identifying information:
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * "Portions Copyrighted [year] [name of copyright owner]"
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster *
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * $Id: Suite.java,v 1.2 2008/06/25 05:53:06 qcheng Exp $
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster *
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster */
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Fosterpackage com.sun.identity.shared.test.tools;
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Fosterimport java.io.File;
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Fosterimport java.io.IOException;
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Fosterimport java.text.MessageFormat;
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Fosterimport java.util.ArrayList;
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Fosterimport java.util.Iterator;
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Fosterimport java.util.List;
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Fosterimport java.util.Set;
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Fosterimport java.util.TreeSet;
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Fosterimport javax.xml.parsers.ParserConfigurationException;
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Fosterimport org.xml.sax.SAXException;
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster/**
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * This class is the suite object in the report generating tool setup.
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * It is responsible for capturing the attributes of a suite and then
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster * generate HTML markup accordingly.
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster */
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Fosterpublic class Suite {
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster    private String name;
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster    private List<Test> tests = new ArrayList<Test>();
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster    /**
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster     * Creates an instance of <code>Suite</code>.
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster     *
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster     * @throws ParserConfigurationException if the <code>testNG</code>
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster     *         report XML is not well formed.
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster     * @throws SAXException if the <code>testNG</code> report XML is not
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster     *         well formed.
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster     * @throws IOException if the <code>testNG</code> report XML is not
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster     *         accessible.
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster     */
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster    public Suite(File f)
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster        throws ParserConfigurationException, SAXException, IOException {
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster        name = f.getName();
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster        getXMLFiles(f);
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster    }
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster    /**
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster     * Returns a list of <code>Test</code> object in this suite.
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster     *
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster     * @return list of <code>Test</code> object in this suite.
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster     */
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster    public List<Test> getTests() {
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster        return tests;
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster    }
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster    /**
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster     * Returns a list of passed <code>Test</code> object in this suite.
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster     *
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster     * @return list of passed <code>Test</code> object in this suite.
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster     */
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster    public boolean passed() {
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster        boolean passed = true;
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster        for (Iterator i = tests.iterator(); i.hasNext() && passed; ) {
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster            Test t = (Test)i.next();
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster            passed = t.passed();
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster        }
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster        return passed;
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster    }
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster    /**
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster     * Creates HTML report.
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster     *
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster     * @param templateDir Template directory.
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster     * @param outputDir Output directory where reports are to be created
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster     *        under.
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster     * @throws IOException if report cannot be created.
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster     */
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster    public void createHTMLReports(String templateDir, String outputDir)
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster        throws IOException
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster    {
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster        String templateHTML = ReportGenerator.getFileContent(
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster            templateDir + "/suite.html");
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster        String dirName = outputDir + "/" + name;
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster        File dir = new File(dirName);
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster        dir.mkdir();
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster        StringBuffer buff = new StringBuffer();
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster        for (Test t : tests) {
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster            buff.append(t.toHTML());
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster        }
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster        templateHTML = templateHTML.replaceAll("@Test@", buff.toString());
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster        templateHTML = templateHTML.replaceAll("@SuiteName@", name);
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster        ReportGenerator.writeToFile(templateHTML, dirName + "/index.html");
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster    }
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster    private int getNumberOfPasses() {
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster        int result = 0;
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster        for (Test t : tests) {
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster            result += t.getPassedTestCases().size();
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster        }
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster        return result;
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster    }
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster    private int getNumberOfFailed() {
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster        int result = 0;
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster        for (Test t : tests) {
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster            result += t.getFailedTestCases().size();
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster        }
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster        return result;
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster    }
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster    private int getNumberOfSkipped() {
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster        int result = 0;
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster        for (Test t : tests) {
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster            result += t.getSkippedTestCases().size();
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster        }
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster        return result;
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster    }
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster    /**
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster     * Returns HTML markup for this object.
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster     *
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster     * @return HTML markup for this object.
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster     */
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster    public String toHTML() {
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster        StringBuffer buff = new StringBuffer();
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster        boolean passed = passed();
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster        String titleTag = (passed) ? "tblMainPassedSuite" :"tblMainFailedSuite";
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster        String countTag = (passed) ? "tblMainPassed" : "tblMainFailed";
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster        String urlName = name + "/index.html";
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster        Object[] args = {urlName, name};
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster        String hrefName = MessageFormat.format(HTMLConstants.HREF, args);
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster        Object[] params = {titleTag, hrefName};
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster        buff.append("<tr>");
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster        buff.append(MessageFormat.format(HTMLConstants.TBL_ENTRY, params));
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster        params[0] = countTag;
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster        params[1] = Integer.toString(getNumberOfPasses());
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster        buff.append(MessageFormat.format(HTMLConstants.TBL_ENTRY, params));
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster        params[1] = Integer.toString(getNumberOfFailed());
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster        buff.append(MessageFormat.format(HTMLConstants.TBL_ENTRY, params));
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster        params[1] = Integer.toString(getNumberOfSkipped());
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster        buff.append(MessageFormat.format(HTMLConstants.TBL_ENTRY, params));
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster        buff.append("</tr>");
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster        return buff.toString();
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster    }
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster    private void getXMLFiles(File suite)
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster        throws ParserConfigurationException, SAXException, IOException {
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster        Set<File> xmlFiles = new TreeSet<File>(new FileNameComparator());
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster        File[] files = suite.listFiles();
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster        for (int i = 0; i < files.length; i++) {
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster            File f = files[i];
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster            String name = f.getName();
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster            if (name.endsWith(".xml") && !name.equals("testng-failed.xml")) {
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster                xmlFiles.add(f);
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster            }
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster        }
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster        for (File f : xmlFiles) {
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster            tests.add(new Test(f));
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster        }
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster    }
5c099afa7c9361afc2f4477fec0e3018588d7840Allan Foster}