• Home
• com.github.basavaraj1985
• DolphinNG
• 1.3.0
• source code
• SmartReporter.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.javasbar.framework.testng.reporters.SmartReporter Maven / Gradle / Ivy

package com.javasbar.framework.testng.reporters;

import com.javasbar.framework.lib.common.Bug;
import com.javasbar.framework.lib.common.IOUtil;
import com.javasbar.framework.lib.common.JIRAClient;
import com.javasbar.framework.lib.common.StringUtil;
import com.sun.org.apache.xpath.internal.operations.Bool;
import org.apache.commons.lang.StringUtils;
import org.apache.http.client.ClientProtocolException;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.apache.velocity.Template;
import org.apache.velocity.VelocityContext;
import org.apache.velocity.app.VelocityEngine;
import org.testng.*;
import org.testng.xml.XmlSuite;

import java.io.*;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.*;

/**
 * @author Basavaraj M
 */
public class SmartReporter implements IReporter
{
    private static final Logger LOG = LogManager.getLogger(SmartReporter.class);

    private static final String SMART_REPORT_TEMPLATE_FILE = "smart.report.template";
    /**
     * Number of words in fail reason to be considered for bug search/creation; default is 10.
     */
    public static final String BUG_WORD_COUNT = "bug.word.count";
    public static String LOG_LINK = "logLink";
    public static String BUG_LINK_KEY = "buglink"; // buglink=true for enabling jira linking
    public static String BUG_LINK_CONFIG = "buglink.config"; // buglink.config=config/jirclient.properties

    private static String INTL_KEY = "intl";
    private static String fileName = "briefSummary.properties";
    private static String persistedHistory = "history.csv";
    private static String prepend = "";
    private static String intl = "";
    private static String PREV_STATIC_REPORT_KEY = "prev";
    private static File previous = null;

    private String logLinkFile;
    private Boolean buglink;
    private String buglinkConfig;
    private JIRAClient jira;

    public SmartReporter()
    {
        super();
        LOG.info("DolphinNG: SmartReporter() constructor");
        System.out.println("~~~~~~~> DolphinNG: SmartReporter() constructor, your test suite is super powered! <~~~~~~~~~");
        String prevReport = System.getProperty(PREV_STATIC_REPORT_KEY, null);
        logLinkFile = System.getProperty(LOG_LINK);
        buglink = Boolean.parseBoolean(System.getProperty("buglink", "false"));
        buglinkConfig = System.getProperty("buglink.config", "");
        if (prevReport != null)
        {
            File prevReportFile = new File(prevReport);
            if (prevReportFile.exists())
            {
                LOG.info("SUCCESS: Threshold failures considered!");
                previous = prevReportFile;
            } else
            {
                System.err.println("ERROR: Could not locate file : " + prevReportFile.getAbsolutePath());
            }
        }

        if (logLinkFile != null)
        {
            LOG.info("SUCCESS : Log deep linking to smart report    considered!");
            try
            {
                URL url = new URL(logLinkFile);
                url.openConnection();
                LOG.info("SUCCESS : Log link verified to be valid!");
            } catch (MalformedURLException e)
            {
                e.printStackTrace();
            } catch (IOException e)
            {
                e.printStackTrace();
            }
        }

        if (buglink)
        {
            LOG.info("DolphinNG: Jira bug linking enabled!");
            jira = new JIRAClient(buglinkConfig);
        }
    }

    public void generateReport(List xmlSuites, List suites,
                               String testNGoutputDirectory)
    {
        String outputDirectory = "./Reports/MetaData/";
        String report = outputDirectory + "/" + fileName;
        String finalReport = outputDirectory + "/../report.html";
        File dir = new File(outputDirectory);
        if (!dir.exists())
        {
            dir.mkdirs();
        }
        StringBuffer buf = new StringBuffer();
        buf.append("#Smart reporting ....").append("\n");
        buf.append("#outputDir=").append(outputDirectory).append("\n");

        intl = System.getProperty(INTL_KEY);
        buf.append("#What did I get from System.getProperty(\"intl\") : " + intl);
        if (intl != null && intl.trim().length() > 1)
        {
            fileName = intl + "_" + fileName;
            prepend = intl + "_";
        } else
        {
            buf.append("#No intl could be retrieved for intl key 'intl' from  env").append("\n");
        }
        buf.append("##intl = " + intl).append("\n");
        deriveAndCompute(suites, buf, outputDirectory);
        buf.append("#Writing file to: " + outputDirectory + "/" + fileName);
        writeToFile(report, buf.toString());

        VelocityEngine ve = new VelocityEngine();
        try
        {
            Properties resourceLoadingConfigProps = new Properties();
            resourceLoadingConfigProps.load(Thread.currentThread().getContextClassLoader()
                    .getResourceAsStream("velocity.properties"));
            String reportTemplateUserConfigd = System.getProperty(SMART_REPORT_TEMPLATE_FILE);
            String resourceName = null;
            String templateValue = null;
            if (reportTemplateUserConfigd != null && reportTemplateUserConfigd.trim().length() > 0)
            {
                String resourcePath = reportTemplateUserConfigd.substring(0, reportTemplateUserConfigd.lastIndexOf("/"));
                resourceName = reportTemplateUserConfigd.substring(reportTemplateUserConfigd.lastIndexOf("/") + 1,
                        reportTemplateUserConfigd.length());
                resourceLoadingConfigProps.put("file.resource.loader.path", resourcePath);
                templateValue = resourceName;
            } else
            {
                templateValue = "report.vm";
            }

            ve.init(resourceLoadingConfigProps);
            LOG.info("Using template : " + templateValue);
            Template template = ve.getTemplate(templateValue);
            LOG.info("DolphinNG: using template - " + template.getName());
            VelocityContext context = new VelocityContext();
            Properties reportedProps = new Properties();
            reportedProps.load(new FileInputStream(report));
            Iterator