status-mobile/test/appium/support/github_report.py

import os
from support.base_test_report import BaseTestReport


class GithubHtmlReport(BaseTestReport):

    TEST_REPORT_DIR = "%s/../report" % os.path.dirname(os.path.abspath(__file__))

    def __init__(self, sauce_username, sauce_access_key):
        super(GithubHtmlReport, self).__init__(sauce_username, sauce_access_key)

    def build_html_report(self):
        tests = self.get_all_tests()
        passed_tests = self.get_passed_tests()
        failed_tests = self.get_failed_tests()

        if len(tests) > 0:
            title_html = "## %.0f%% of end-end tests have passed\n" % (len(passed_tests) / len(tests) * 100)
            summary_html = "```\n"
            summary_html += "Total executed tests: %d\n" % len(tests)
            summary_html += "Failed tests: %d\n" % len(failed_tests)
            summary_html += "Passed tests: %d\n" % len(passed_tests)
            summary_html += "```\n"
            failed_tests_html = str()
            passed_tests_html = str()
            if failed_tests:
                failed_tests_html = self.build_tests_table_html(failed_tests, failed_tests=True)
            if passed_tests:
                passed_tests_html = self.build_tests_table_html(passed_tests, failed_tests=False)
            return title_html + summary_html + failed_tests_html + passed_tests_html
        else:
            return None

    def build_tests_table_html(self, tests, failed_tests=False):
        tests_type = "Failed tests" if failed_tests else "Passed tests"
        html = "<h3>%s (%d)</h3>" % (tests_type, len(tests))
        html += "<details>"
        html += "<summary>Click to expand</summary>"
        html += "<br/>"
        html += "<table style=\"width: 100%\">"
        html += "<colgroup>"
        html += "<col span=\"1\" style=\"width: 20%;\">"
        html += "<col span=\"1\" style=\"width: 80%;\">"
        html += "</colgroup>"
        html += "<tbody>"
        html += "<tr>"
        html += "</tr>"
        for i, test in enumerate(tests):
            html += self.build_test_row_html(i, test)
        html += "</tbody>"
        html += "</table>"
        html += "</details>"
        return html

    def build_test_row_html(self, index, test):
        html = "<tr><td><b>%d. %s</b></td></tr>" % (index+1, test.name)
        html += "<tr><td>"
        test_steps_html = list()
        for step in test.steps:
            test_steps_html.append("<div>%s</div>" % step)
        if test.error:
            if test_steps_html:
                html += "<p>"
                html += "<blockquote>"
                # last 2 steps as summary
                html += "%s" % ''.join(test_steps_html[-2:])
                html += "</blockquote>"
                html += "</p>"
            html += "<code>%s</code>" % test.error
            html += "<br/><br/>"
        if test.jobs:
            html += self.build_device_sessions_html(test.jobs)
        html += "</td></tr>"
        return html

    def build_device_sessions_html(self, jobs):
        html = "<ins>Device sessions:</ins>"
        html += "<p><ul>"
        for i, job_id in enumerate(jobs):
            html += "<li><a href=\"%s\">Device %d</a></li>" % (self.get_sauce_job_url(job_id), i+1)
        html += "</ul></p>"
        return html