source: vbox/trunk/src/VBox/ValidationKit/testmanager/webui/wuireport.py@ 61271

# -*- coding: utf-8 -*-
# $Id: wuireport.py 61271 2016-05-29 02:45:57Z vboxsync $

"""
Test Manager WUI - Reports.
"""

__copyright__ = \
"""
Copyright (C) 2012-2015 Oracle Corporation

This file is part of VirtualBox Open Source Edition (OSE), as
available from http://www.virtualbox.org. This file is free software;
you can redistribute it and/or modify it under the terms of the GNU
General Public License (GPL) as published by the Free Software
Foundation, in version 2 as it comes in the "COPYING" file of the
VirtualBox OSE distribution. VirtualBox OSE is distributed in the
hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.

The contents of this file may alternatively be used under the terms
of the Common Development and Distribution License Version 1.0
(CDDL) only, as it comes in the "COPYING.CDDL" file of the
VirtualBox OSE distribution, in which case the provisions of the
CDDL are applicable instead of those of the GPL.

You may elect to license modified versions of this file under the
terms and conditions of either the GPL or the CDDL or both.
"""
__version__ = "$Revision: 61271 $"


# Validation Kit imports.
from common                             import webutils;
from testmanager.webui.wuicontentbase   import WuiContentBase, WuiSvnLinkWithTooltip;
from testmanager.webui.wuihlpgraph      import WuiHlpGraphDataTable, WuiHlpBarGraph;
from testmanager.core.report            import ReportModelBase;


class WuiReportBase(WuiContentBase):
    """
    Base class for the reports.
    """

    def __init__(self, oModel, dParams, fSubReport = False, fnDPrint = None, oDisp = None):
        WuiContentBase.__init__(self, fnDPrint = fnDPrint, oDisp = oDisp);
        self._oModel        = oModel;
        self._dParams       = dParams;
        self._fSubReport    = fSubReport;
        self._sTitle        = None;

    def generateNavigator(self, sWhere):
        """
        Generates the navigator (manipulate _dParams).
        Returns HTML.
        """
        assert sWhere == 'top' or sWhere == 'bottom';

        return '';

    def generateReportBody(self):
        """
        This is overridden by the child class to generate the report.
        Returns HTML.
        """
        return '<h3>Must override generateReportBody!</h3>';

    def show(self):
        """
        Generate the report.
        Returns (sTitle, HTML).
        """

        sTitle  = self._sTitle if self._sTitle is not None else type(self).__name__;
        sReport = self.generateReportBody();
        if not self._fSubReport:
            sReport = self.generateNavigator('top') + sReport + self.generateNavigator('bottom');
            sTitle = self._oModel.sSubject + ' - ' + sTitle; ## @todo add subject to title in a proper way!

        return (sTitle, sReport);


class WuiReportSuccessRate(WuiReportBase):
    """
    Generates a report displaying the success rate over time.
    """

    def generateReportBody(self):
        self._sTitle = 'Success rate';

        adPeriods = self._oModel.getSuccessRates();

        sReport = '';

        oTable = WuiHlpGraphDataTable('Period', [ 'Succeeded', 'Skipped', 'Failed' ]);

        #for i in range(len(adPeriods) - 1, -1, -1):
        for i, dStatuses in enumerate(adPeriods):
            cSuccess  = dStatuses[ReportModelBase.ksTestStatus_Success] + dStatuses[ReportModelBase.ksTestStatus_Skipped];
            cTotal    = cSuccess + dStatuses[ReportModelBase.ksTestStatus_Failure];
            sPeriod   = self._oModel.getPeriodDesc(i);
            if cTotal > 0:
                iPctSuccess = dStatuses[ReportModelBase.ksTestStatus_Success] * 100 / cTotal;
                iPctSkipped = dStatuses[ReportModelBase.ksTestStatus_Skipped] * 100 / cTotal;
                iPctFailure = dStatuses[ReportModelBase.ksTestStatus_Failure] * 100 / cTotal;
                oTable.addRow(sPeriod, [ iPctSuccess, iPctSkipped, iPctFailure ],
                              [ '%s%% (%d)' % (iPctSuccess, dStatuses[ReportModelBase.ksTestStatus_Success]),
                                '%s%% (%d)' % (iPctSkipped, dStatuses[ReportModelBase.ksTestStatus_Skipped]),
                                '%s%% (%d)' % (iPctFailure, dStatuses[ReportModelBase.ksTestStatus_Failure]), ]);
            else:
                oTable.addRow(sPeriod, [ 0, 0, 0 ], [ '0%', '0%', '0%' ]);

        cTotalNow  = adPeriods[0][ReportModelBase.ksTestStatus_Success];
        cTotalNow += adPeriods[0][ReportModelBase.ksTestStatus_Skipped];
        cSuccessNow = cTotalNow;
        cTotalNow += adPeriods[0][ReportModelBase.ksTestStatus_Failure];
        sReport += '<p>Current success rate: ';
        if cTotalNow > 0:
            sReport += '%s%% (thereof %s%% skipped)</p>\n' \
                     % ( cSuccessNow * 100 / cTotalNow, adPeriods[0][ReportModelBase.ksTestStatus_Skipped] * 100 / cTotalNow);
        else:
            sReport += 'N/A</p>\n'

        oGraph = WuiHlpBarGraph('success-rate', oTable, self._oDisp);
        oGraph.setRangeMax(100);
        sReport += oGraph.renderGraph();

        return sReport;


class WuiReportFailuresBase(WuiReportBase):
    """
    Common parent of WuiReportFailureReasons and WuiReportTestCaseFailures.
    """

    def _formatEdgeOccurenceSubject(self, oTransient):
        """
        Worker for _formatEdgeOccurence that child classes overrides to format
        their type of subject data in the best possible way.
        """
        _ = oTransient;
        assert False;
        return '';

    def _formatEdgeOccurence(self, oTransient):
        """
        Helper for formatting the transients.
        oTransient is of type ReportFailureReasonTransient or ReportTestCaseFailureTransient.
        """
        sHtml = u'<li>';
        if oTransient.fEnter:   sHtml += 'Since ';
        else:                   sHtml += 'Until ';
        sHtml += WuiSvnLinkWithTooltip(oTransient.iRevision, oTransient.sRepository, fBracketed = 'False').toHtml();
        sHtml += u', %s: ' % (self.formatTsShort(oTransient.tsDone),);
        sHtml += self._formatEdgeOccurenceSubject(oTransient);
        sHtml += u'</li>\n';
        return sHtml;

    def _generateTransitionList(self, oSet):
        """
        Generates the enter and leave lists.
        """
        sHtml  = u'<h4>Movements:</h4>\n' \
                 u'<ul>\n';
        if len(oSet.aoEnterInfo) == 0 and len(oSet.aoLeaveInfo) == 0:
            sHtml += u'<li>No changes</li>\n';
        else:
            for oTransient in oSet.aoEnterInfo:
                sHtml += self._formatEdgeOccurence(oTransient);
            for oTransient in oSet.aoLeaveInfo:
                sHtml += self._formatEdgeOccurence(oTransient);
        sHtml += u'</ul>\n';

        return sHtml;



class WuiReportFailureReasons(WuiReportFailuresBase):
    """
    Generates a report displaying the failure reasons over time.
    """

    def _formatEdgeOccurenceSubject(self, oTransient):
        return u'%s / %s' % ( webutils.escapeElem(oTransient.oReason.oCategory.sShort),
                              webutils.escapeElem(oTransient.oReason.sShort),);


    def generateReportBody(self):
        self._sTitle = 'Failure reasons';

        #
        # Get the data and generate transition list.
        #
        oSet = self._oModel.getFailureReasons();
        sHtml = self._generateTransitionList(oSet);

        #
        # Check if most of the stuff is without any assign reason, if so, skip
        # that part of the graph so it doesn't offset the interesting bits.
        #
        fIncludeWithoutReason = True;
        for oPeriod in reversed(oSet.aoPeriods):
            if oPeriod.cWithoutReason > oSet.cMaxHits * 4:
                fIncludeWithoutReason = False;
                sHtml += '<p>Warning: Many failures without assigned reason!</p>\n';
                break;

        #
        # Generate the graph.
        #
        aidSorted = sorted(oSet.dSubjects, key = lambda idReason: oSet.dcHitsPerId[idReason], reverse = True);

        asNames = [];
        for idReason in aidSorted:
            oReason = oSet.dSubjects[idReason];
            asNames.append('%s / %s' % (oReason.oCategory.sShort, oReason.sShort,) )
        if fIncludeWithoutReason:
            asNames.append('No reason');

        oTable = WuiHlpGraphDataTable('Period', asNames);

        cMax = oSet.cMaxHits;
        for _, oPeriod in enumerate(reversed(oSet.aoPeriods)):
            aiValues = [];

            for idReason in aidSorted:
                oRow = oPeriod.dRowsById.get(idReason, None);
                iValue = oRow.cHits if oRow is not None else 0;
                aiValues.append(iValue);

            if fIncludeWithoutReason:
                aiValues.append(oPeriod.cWithoutReason);
                if oPeriod.cWithoutReason > cMax:
                    cMax = oPeriod.cWithoutReason;

            oTable.addRow(oPeriod.sDesc, aiValues);

        oGraph = WuiHlpBarGraph('failure-reason', oTable, self._oDisp);
        oGraph.setRangeMax(max(cMax + 1, 3));
        sHtml += oGraph.renderGraph();

        #
        # Table form necessary?
        #
        #sHtml += u'<p>TODO: Show graph content in table form.</p>';

        return sHtml;


class WuiReportTestCaseFailures(WuiReportFailuresBase):
    """
    Generates a report displaying the failure reasons over time.
    """

    def _formatEdgeOccurenceSubject(self, oTransient):
        return u'%s (#%u)' % ( webutils.escapeElem(oTransient.oTestCase.sName), oTransient.oTestCase.idTestCase,);


    def generateReportBody(self):
        self._sTitle = 'Test Case Failures';

        #
        # Get the data and generate transition list.
        #
        oSet = self._oModel.getTestCaseFailures();
        sHtml = self._generateTransitionList(oSet);

        #
        # Generate the graph.
        #
        aidSorted = sorted(oSet.dSubjects,
                           key = lambda idKey: oSet.dcHitsPerId[idKey] * 10000 / oSet.dcTotalPerId[idKey],
                           reverse = True);

        asNames = [];
        for idKey in aidSorted:
            oSubject = oSet.dSubjects[idKey];
            asNames.append(oSubject.sName);

        oTable = WuiHlpGraphDataTable('Period', asNames);

        uPctMax = 10;
        for _, oPeriod in enumerate(reversed(oSet.aoPeriods)):
            aiValues = [];
            asValues = [];

            for idKey in aidSorted:
                oRow = oPeriod.dRowsById.get(idKey, None);
                if oRow is not None:
                    uPct = oRow.cHits * 100 / oRow.cTotal;
                    uPctMax = max(uPctMax, uPct);
                    aiValues.append(uPct);
                    asValues.append('%u%% (%u/%u)' % (uPct, oRow.cHits, oRow.cTotal));
                else:
                    aiValues.append(0);
                    asValues.append('0');

            oTable.addRow(oPeriod.sDesc, aiValues, asValues);

        if True: # pylint: disable=W0125
            aiValues = [];
            asValues = [];
            for idKey in aidSorted:
                uPct = oSet.dcHitsPerId[idKey] * 100 / oSet.dcTotalPerId[idKey];
                uPctMax = max(uPctMax, uPct);
                aiValues.append(uPct);
                asValues.append('%u%% (%u/%u)' % (uPct, oSet.dcHitsPerId[idKey], oSet.dcTotalPerId[idKey]));
            oTable.addRow('Totals', aiValues, asValues);

        oGraph = WuiHlpBarGraph('testcase-failures', oTable, self._oDisp);
        oGraph.setRangeMax(uPct + 2);
        sHtml += oGraph.renderGraph();

        return sHtml;


class WuiReportSummary(WuiReportBase):
    """
    Summary report.
    """

    def generateReportBody(self):
        self._sTitle = 'Summary';
        sHtml = '<p>This will display several reports and listings useful to get an overview of %s (id=%s).</p>' \
             % (self._oModel.sSubject, self._oModel.aidSubjects,);

        oSuccessRate      = WuiReportSuccessRate(     self._oModel, self._dParams, fSubReport = True,
                                                      fnDPrint = self._fnDPrint, oDisp = self._oDisp);
        oTestCaseFailures = WuiReportTestCaseFailures(self._oModel, self._dParams, fSubReport = True,
                                                      fnDPrint = self._fnDPrint, oDisp = self._oDisp);
        oFailureReasons   = WuiReportFailureReasons(  self._oModel, self._dParams, fSubReport = True,
                                                      fnDPrint = self._fnDPrint, oDisp = self._oDisp);
        for oReport in [oSuccessRate, oTestCaseFailures, oFailureReasons, ]:
            (sTitle, sContent) = oReport.show();
            sHtml += '<br>'; # drop this layout hack
            sHtml += '<div>';
            sHtml += '<h3>%s</h3>\n' % (webutils.escapeElem(sTitle),);
            sHtml += sContent;
            sHtml += '</div>';

        return sHtml;