[ { "path": ".gitignore", "content": "\n# Created by https://www.gitignore.io/api/python\n# Edit at https://www.gitignore.io/?templates=python\n\n### Python ###\n# Byte-compiled / optimized / DLL files\n__pycache__/\n*.py[cod]\n*$py.class\n\n# C extensions\n*.so\n\n# Distribution / packaging\n.Python\nbuild/\ndevelop-eggs/\ndist/\ndownloads/\neggs/\n.eggs/\nlib/\nlib64/\nparts/\nsdist/\nvar/\nwheels/\nshare/python-wheels/\n*.egg-info/\n.installed.cfg\n*.egg\nMANIFEST\n\n# PyInstaller\n# Usually these files are written by a python script from a template\n# before PyInstaller builds the exe, so as to inject date/other infos into it.\n*.manifest\n*.spec\n\n# Installer logs\npip-log.txt\npip-delete-this-directory.txt\n\n# Unit test / coverage reports\nhtmlcov/\n.tox/\n.nox/\n.coverage\n.coverage.*\n.cache\nnosetests.xml\ncoverage.xml\n*.cover\n.hypothesis/\n.pytest_cache/\n\n# Translations\n*.mo\n*.pot\n\n# Django stuff:\n*.log\nlocal_settings.py\ndb.sqlite3\n\n# Flask stuff:\ninstance/\n.webassets-cache\n\n# Scrapy stuff:\n.scrapy\n\n# Sphinx documentation\ndocs/_build/\n\n# PyBuilder\ntarget/\n\n# Jupyter Notebook\n.ipynb_checkpoints\n\n# IPython\nprofile_default/\nipython_config.py\n\n# pyenv\n.python-version\n\n# celery beat schedule file\ncelerybeat-schedule\n\n# SageMath parsed files\n*.sage.py\n\n# Environments\n.env\n.venv\nenv/\nvenv/\nENV/\nenv.bak/\nvenv.bak/\n\n# Spyder project settings\n.spyderproject\n.spyproject\n\n# Rope project settings\n.ropeproject\n\n# mkdocs documentation\n/site\n\n# mypy\n.mypy_cache/\n.dmypy.json\ndmypy.json\n\n# Pyre type checker\n.pyre/\n\n### Python Patch ###\n.venv/\n\n# End of https://www.gitignore.io/api/python\n*.xml\nmetrics.html" }, { "path": "LICENSE", "content": "MIT License\n\nCopyright (c) 2019 Shiva Prasad Adirala\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE." }, { "path": "MANIFEST.in", "content": "recursive-include robotframework_metrics/templates *\ninclude MANIFEST.in" }, { "path": "README.md", "content": "
\n

Robot Framework Metrics

\n

\n Custom HTML report (dashboard view) by parsing robotframework output.xml file\n

\n\n\n

\n \n \"contributors\"\n \n \n \"last\n \n \n \"forks\"\n \n \n \"stars\"\n \n \n \"downloads\"\n \n \n \"open\n \n \n \"license\"\n \n

\n\n

\n View Demo\n ยท \n Documentation\n ยท \n Report Bug\n ยท \n Request Feature\n

\n
\n\n
\n\n\n# ๐Ÿ“” Table of Contents\n\n- [About the Project](#-about-the-project)\n * [Screenshots](#-screenshots)\n * [Tech Stack](#-tech-stack)\n * [Features](#-features)\n- [Getting Started](#-getting-started)\n * [Installation](#-installation)\n- [Usage](#usage)\n * [Continuous Integration (CI) Setup](#-cisetup)\n- [Contact](#-contact)\n- [Acknowledgements](#-acknowledgements)\n\n\n## ๐ŸŒŸ About the Project\n\n`Robot Framework Metrics` is a tool designed to generate comprehensive `HTML reports` from Robot Framework's `output.xml` files. These reports provide a __dashboard view__, offering detailed insights into your test executions, including __suite__ statistics, __test case__ results, and __keyword__ performance.\n\n\n### ๐Ÿ“ท Screenshots\n\n![Metrics Report](https://github.com/adiralashiva8/robotframework-metrics/blob/master/metrics.png)\n\n\n### ๐Ÿ› ๏ธ Tech Stack\n\n
\n \n
\n\n\n### ๐ŸŽฏ Features\n\n- *Custom HTML Report:* Create visually appealing and informative dashboard.\n- *Detailed Metrics:* Access suite, test case, keyword statistics, status, and elapsed time.\n- *Support for RF7:* Fully compatible with Robot Framework 7 (from v3.5.0 onwards).\n- *Command-Line Interface:* Easy-to-use CLI for report generation.\n\n\n\n## ๐Ÿงฐ Getting Started\n\n\n### โš™๏ธ Installation\n\nYou can install `robotframework-metrics` using one of the following methods:\n\n\n__Method 1__: Latest Development Version (**Recommended**) (for the latest features and RF7 support)\n```\npip install git+https://github.com/adiralashiva8/robotframework-metrics\n```\n\n__Method 2__: Using pip\n```\npip install robotframework-metrics==3.7.0\n```\n\n__Method 3__: From Source (clone the repository and install using setup.py)\n```\ngit clone https://github.com/adiralashiva8/robotframework-metrics.git\ncd robotframework-metrics\npython setup.py install\n```\n\n\n\n## ๐Ÿ‘€ Usage\n\nAfter executing your Robot Framework tests, you can generate a metrics report by running:\n\n__Default Configuration__: If `output.xml` is in the current directory\n```\nrobotmetrics\n```\n\n__Custom Path__: If `output.xml` is located in a different directory\n```\nrobotmetrics --inputpath ./Result/ --output output1.xml\n```\n\nFor more options:\n```\nrobotmetrics --help\n```\n\n### ๐Ÿงช Continuous Integration (CI) Setup\n\nTo automate report generation in CI/CD pipelines, add the following steps to your pipeline configuration:\n\n1. Run tests with Robot Framework\n2. Generate the metrics report\n ```\n robot test.robot &\n robotmetrics [:options]\n ```\n > & is used to execute multiple command's in .bat file\n\n\n## ๐Ÿค Contact\n\nFor any questions, suggestions, or feedback, please contact:\n\n- Email: `adiralashiva8@gmail.com` \n\n\n## ๐Ÿ’Ž Acknowledgements\n\nSpecial thanks to the following individuals for their guidance, contributions, and feedback:\n\n*Idea, Guidance and Support:*\n - Steve Fisher\n - Goutham Duduka\n\n*Contributors:*\n1. [Pekka Klarck](https://www.linkedin.com/in/pekkaklarck/) [Author of robotframework]\n2. [Ruud Prijs](https://www.linkedin.com/in/ruudprijs/)\n3. [Jesse Zacharias](https://www.linkedin.com/in/jesse-zacharias-7926ba50/)\n4. [Bassam Khouri](https://www.linkedin.com/in/bassamkhouri/)\n5. [Francesco Spegni](https://www.linkedin.com/in/francesco-spegni-34b39b61/)\n6. [Sreelesh Kunnath](https://www.linkedin.com/in/kunnathsree/)\n\n*Feedback:*\n1. [Mantri Sri](https://www.linkedin.com/in/mantri-sri-4a0196133/)\n2. [Prasad Ozarkar](https://www.linkedin.com/in/prasad-ozarkar-b4a61017/)\n3. [Suresh Parimi](https://www.linkedin.com/in/sparimi/)\n4. [Amit Lohar](https://github.com/amitlohar)\n5. [Robotframework community users](https://groups.google.com/forum/#!forum/robotframework-users)\n\n---\n\nโญ Star this repository if you find it useful! (it motivates)\n\n---\n" }, { "path": "robotframework_metrics/__init__.py", "content": "" }, { "path": "robotframework_metrics/dashboard_stats.py", "content": "import pandas as pd\nfrom datetime import datetime\nimport numpy as np\n\n\nclass Dashboard:\n\n def __init__(self):\n pass\n\n @classmethod\n def get_suite_statistics(self, suite_list):\n suite_data_frame = pd.DataFrame.from_records(suite_list)\n suite_stats = {\n \"Total\" : (suite_data_frame.Name).count(),\n \"Pass\" : (suite_data_frame.Status == 'PASS').sum(),\n \"Fail\" : (suite_data_frame.Status == 'FAIL').sum(),\n \"Skip\" : (suite_data_frame.Status == 'SKIP').sum(),\n \"Time\" : (suite_data_frame.Time).sum(),\n \"Min\" : (suite_data_frame.Time).min(),\n \"Max\" : (suite_data_frame.Time).max(),\n \"Avg\" : (suite_data_frame.Time).mean()\n }\n return suite_stats\n \n @classmethod\n def get_test_statistics(self, test_list):\n test_data_frame = pd.DataFrame.from_records(test_list)\n test_stats = {\n \"Total\" : (test_data_frame.Status).count(),\n \"Pass\" : (test_data_frame.Status == 'PASS').sum(),\n \"Fail\" : (test_data_frame.Status == 'FAIL').sum(),\n \"Skip\" : (test_data_frame.Status == 'SKIP').sum(),\n \"Time\" : (test_data_frame.Time).sum(),\n \"Min\" : (test_data_frame.Time).min(),\n \"Max\" : (test_data_frame.Time).max(),\n \"Avg\" : (test_data_frame.Time).mean()\n }\n return test_stats\n\n @classmethod\n def get_keyword_statistics(self, kw_list):\n kw_data_frame = pd.DataFrame.from_records(kw_list)\n if not kw_data_frame.empty:\n kw_stats = {\n \"Total\" : (kw_data_frame.Status).count(),\n \"Pass\" : (kw_data_frame.Status == 'PASS').sum(),\n \"Fail\" : (kw_data_frame.Status == 'FAIL').sum(),\n \"Skip\" : (kw_data_frame.Status == 'SKIP').sum()\n }\n else:\n kw_stats = {\n \"Total\" : 0,\n \"Pass\" : 0,\n \"Fail\" : 0,\n \"Skip\" : 0,\n }\n return kw_stats\n\n def suite_error_statistics(self, suite_list):\n suite_data_frame = pd.DataFrame.from_records(suite_list)\n required_data_frame = pd.DataFrame(suite_data_frame, columns = ['Name', 'Total', 'Fail'])\n required_data_frame['percent'] = (required_data_frame['Fail'] / required_data_frame['Total'])*100\n filtered_data_frame = required_data_frame[required_data_frame['Fail'] > 0]\n # print(required_data_frame)\n return filtered_data_frame.sort_values(by = ['Fail'], ascending = [False], ignore_index=True).head(10).reset_index(drop=True)\n\n def get_execution_info(self, test_list):\n data_frame = pd.DataFrame.from_records(test_list)\n data_frame['start_time'] = pd.to_datetime(data_frame['start_time'])\n data_frame['end_time'] = pd.to_datetime(data_frame['end_time'])\n initial_start_time = data_frame['start_time'].min()\n final_end_time = data_frame['end_time'].max()\n overall_execution_time = final_end_time - initial_start_time\n return [initial_start_time, final_end_time, overall_execution_time]\n\n def get_test_execution_trends(self, test_list):\n data_frame = pd.DataFrame.from_records(test_list)\n num_bins = 10\n min_time = round(data_frame['Time'].min()/60000, 2)\n max_time = round(data_frame['Time'].max()/60000, 2)\n if max_time == min_time:\n max_time += 0.1\n bins = np.linspace(min_time, max_time, num_bins + 1)\n labels = [f'{round(bins[i], 0)} - {round(bins[i+1], 0)} min' for i in range(len(bins)-1)]\n data_frame['time_group'] = pd.cut(round(data_frame['Time']/60000,2), bins=bins, labels=labels, include_lowest=True, ordered=False)\n result = data_frame.groupby('time_group').size().reset_index(name='test_case_count')\n return result\n" }, { "path": "robotframework_metrics/details.py", "content": "from robot.api import ExecutionResult, ResultVisitor\nfrom datetime import timedelta\nfrom robot.result.model import Keyword\n\n\nclass SuiteReportVisitor(ResultVisitor):\n def __init__(self, details_list):\n self.test_report = details_list\n\n def visit_suite(self, suite):\n\n self.tests = []\n self.keywords = []\n # Traverse each test in the suite\n for test in suite.tests:\n\n # Traverse each keyword in the test\n for keyword in test.body:\n if isinstance(keyword, Keyword):\n _current_keyword = {\n 'keyword_name': keyword.name,\n 'keyword_status': keyword.status,\n 'keyword_start_time': keyword.starttime,\n 'keyword_end_time': keyword.endtime,\n 'keyword_elapsed_time': str(timedelta(milliseconds=keyword.elapsedtime)),\n 'keyword_documentation': keyword.doc,\n 'keyword_message': keyword.message if keyword.message else \"\",\n }\n self.keywords.append(_current_keyword)\n\n _current_test = {\n 'test_name': test.name,\n 'test_id': test.id,\n 'start_time': test.starttime,\n 'end_time': test.endtime,\n 'elapsed_time': str(timedelta(milliseconds=test.elapsedtime)),\n 'status': test.status,\n 'tags': \", \".join(test.tags),\n 'documentation': test.doc,\n 'message': test.message if test.message else \"\",\n 'keywords': self.keywords\n }\n self.tests.append(_current_test)\n\n\n tests_info = {\n 'suite_name': suite.longname,\n 'suite_id': suite.id,\n 'start_time': suite.starttime,\n 'end_time': suite.endtime,\n 'elapsed_time': str(timedelta(milliseconds=suite.elapsedtime)),\n 'status': suite.status,\n 'pass_count': suite.statistics.passed,\n 'fail_count': suite.statistics.failed,\n 'skip_count': suite.statistics.skipped,\n 'total': suite.statistics.total,\n 'message': suite.message if suite.message else \"\",\n 'tests': self.tests\n }\n\n self.test_report.append(tests_info)\n\n # Recursively visit nested suites\n for child_suite in suite.suites:\n child_suite.visit(self)\n" }, { "path": "robotframework_metrics/keyword_results.py", "content": "from robot.api import ResultVisitor\n\n\nclass KeywordResults(ResultVisitor):\n\n def __init__(self, kw_list, ignore_library, ignore_type):\n self.kw_list = kw_list\n self.ignore_library = ignore_library\n self.ignore_type = ignore_type\n \n def start_keyword(self, kw):\n if (kw.libname not in self.ignore_library) and (kw.type not in self.ignore_type):\n kw_json = {\n \"Name\" : kw.name,\n \"Status\" : kw.status,\n \"Time\" : kw.elapsedtime\n }\n self.kw_list.append(kw_json)" }, { "path": "robotframework_metrics/keyword_times.py", "content": "import pandas as pd\n\nclass KeywordTimes():\n\n def get_keyword_times(self, kw_list):\n keywords_data_frame = pd.DataFrame.from_records(kw_list)\n if not keywords_data_frame.empty:\n kw_times = (keywords_data_frame.groupby(\"Name\").agg(times = (\"Time\", \"count\"), time_min = (\"Time\", \"min\"),\n time_max = (\"Time\", \"max\"), time_mean = (\"Time\", \"mean\"), fail_count=(\"Status\", lambda x: (x == \"FAIL\").sum())).reset_index())\n else:\n kw_times = keywords_data_frame\n return kw_times\n" }, { "path": "robotframework_metrics/robotmetrics.py", "content": "import os\nimport logging\nimport codecs\nfrom datetime import datetime\nfrom robot.api import ExecutionResult\nfrom jinja2 import Environment, FileSystemLoader, Template\nfrom .suite_results import SuiteResults\nfrom .test_results import TestResults\nfrom .keyword_results import KeywordResults\nfrom .keyword_times import KeywordTimes\nfrom .dashboard_stats import Dashboard\nfrom .details import SuiteReportVisitor\n\ntemplates_dir = os.path.join(os.path.dirname(os.path.abspath(__file__)), 'templates')\nfile_loader = FileSystemLoader(templates_dir)\nenv = Environment( loader = file_loader )\ntemplate = env.get_template('index.html')\n\nIGNORE_LIBRARIES = [\"SeleniumLibrary\", \"BuiltIn\",\n \"Collections\", \"DateTime\", \"Dialogs\", \"OperatingSystem\"\n \"Process\", \"Screenshot\", \"String\", \"Telnet\", \"XML\"]\n\nIGNORE_TYPES = ['FOR ITERATION', 'FOR', 'for', 'foritem']\n\nsuite_list, test_list, kw_list, kw_times, details_list = [], [], [], [], []\n\ndef generate_report(opts):\n logging.basicConfig(format='%(levelname)s:%(message)s', level=logging.INFO)\n\n # Ignores following library keywords in metrics report\n ignore_library = IGNORE_LIBRARIES\n if opts.ignore:\n ignore_library.extend(opts.ignore)\n\n # Ignores following type keywords in metrics report\n ignore_type = IGNORE_TYPES\n if opts.ignoretype:\n ignore_type.extend(opts.ignoretype)\n\n # Report to support file location as arguments\n path = os.path.abspath(os.path.expanduser(opts.path))\n\n # output.xml files\n output_names = []\n # support \"*.xml\" of output files\n if ( opts.output == \"*.xml\" ):\n for item in os.listdir(path):\n item = os.path.join(path, item)\n if os.path.isfile(item) and item.endswith('.xml'):\n output_names.append(item)\n else:\n for curr_name in opts.output.split(\",\"):\n curr_path = os.path.join(path, curr_name)\n output_names.append(curr_path)\n\n log_name = opts.log_name\n\n # copy the list of output_names onto the one of required_files; the latter may (in the future)\n # contain files that should not be processed as output_names\n required_files = list(output_names)\n missing_files = [filename for filename in required_files if not os.path.exists(filename)]\n if missing_files:\n # We have files missing.\n exit(\"output.xml file is missing: {}\".format(\", \".join(missing_files)))\n\n mt_time = datetime.now().strftime('%Y%m%d-%H%M%S')\n\n # Output result file location\n if opts.metrics_report_name:\n result_file_name = opts.metrics_report_name\n else:\n result_file_name = 'metrics-' + mt_time + '.html'\n result_file = os.path.join(path, result_file_name)\n\n logging.info(\" Converting .xml to .html file. This may take few minutes...\")\n # Read output.xml file\n result = ExecutionResult(*output_names)\n\n logging.info(\" 1 of 4: Capturing suite metrics\")\n result.visit(SuiteResults(suite_list))\n\n logging.info(\" 2 of 4: Capturing test metrics\")\n result.visit(TestResults(test_list))\n\n # if opts.showkeyword == \"True\":\n # logging.info(\" 3 of 4: Capturing keyword metrics\")\n # result.visit(KeywordResults(kw_list, IGNORE_LIBRARIES))\n # hide_keyword_menu = \"\"\n # else:\n # logging.info(\" 3 of 4: Ignoring keyword metrics\")\n # result.visit(KeywordResults([], IGNORE_LIBRARIES))\n # hide_keyword_menu = \"hide\"\n\n if opts.showkwtimes == \"True\":\n logging.info(\" 3 of 4: Capturing keyword times metrics\")\n result.visit(KeywordResults(kw_list, ignore_library, ignore_type))\n kw_times = KeywordTimes().get_keyword_times(kw_list)\n hide_kw_times_menu = \"\"\n else:\n kw_times = KeywordTimes().get_keyword_times([])\n hide_kw_times_menu = \"hide\"\n\n if opts.showtags == \"True\":\n hide_tags = \"\"\n else:\n hide_tags = \"hide\"\n\n if opts.showdocs == \"True\":\n hide_docs = \"\"\n else:\n hide_docs = \"hide\"\n\n logging.info(\" 4 of 4: Capturing details\")\n result.visit(SuiteReportVisitor(details_list))\n\n logging.info(\" Preparing data for dashboard\")\n dashboard_obj = Dashboard()\n suite_stats = dashboard_obj.get_suite_statistics(suite_list)\n test_stats = dashboard_obj.get_test_statistics(test_list)\n kw_stats = dashboard_obj.get_keyword_statistics(kw_list)\n suite_error_stats = dashboard_obj.suite_error_statistics(suite_list)\n execution_stats = dashboard_obj.get_execution_info(test_list)\n test_time_group = dashboard_obj.get_test_execution_trends(test_list)\n\n logging.info(\" Writing results to html file\")\n with codecs.open(result_file,'w','utf-8') as fh:\n fh.write(template.render(\n hide_tags = hide_tags,\n hide_docs = hide_docs,\n # hide_keyword_menu = hide_keyword_menu,\n hide_kw_times_menu = hide_kw_times_menu,\n suite_stats = suite_stats,\n log_name = log_name,\n test_stats = test_stats,\n kw_stats = kw_stats,\n suites = suite_list,\n tests = test_list,\n # keywords = kw_list,\n keyword_times = kw_times,\n # error_stats = error_stats,\n suite_error_stats = suite_error_stats,\n suites_list = details_list,\n execution_stats=execution_stats,\n test_time_group=test_time_group,\n ))\n logging.info(\" Results file created successfully and can be found at {}\".format(result_file))\n" }, { "path": "robotframework_metrics/runner.py", "content": "import os\nimport argparse\nfrom .robotmetrics import generate_report\nfrom .robotmetrics import IGNORE_LIBRARIES\nfrom .robotmetrics import IGNORE_TYPES\nfrom .version import __version__\n\n\ndef parse_options():\n parser = argparse.ArgumentParser(formatter_class=argparse.ArgumentDefaultsHelpFormatter)\n\n general = parser.add_argument_group(\"General\")\n parser.add_argument(\n '-v', '--version',\n action='store_true',\n dest='version',\n help='Display application version information'\n )\n\n general.add_argument(\n '--ignorelib',\n dest='ignore',\n default=IGNORE_LIBRARIES,\n nargs=\"+\",\n help=\"Ignore keywords of specified library in report\"\n )\n\n general.add_argument(\n '--ignoretype',\n dest='ignoretype',\n default=IGNORE_TYPES,\n nargs=\"+\",\n help=\"Ignore keywords of specified type in report\"\n )\n\n general.add_argument(\n '-I', '--inputpath',\n dest='path',\n default=os.path.curdir,\n help=\"Path of result files\"\n )\n\n general.add_argument(\n '-M', '--metrics-report-name',\n dest='metrics_report_name',\n help=\"Output name of the generate metrics report\"\n )\n\n general.add_argument(\n '-O', '--output',\n dest='output',\n default=\"output.xml\",\n help=\"Name of output.xml\"\n )\n\n # general.add_argument(\n # '-sk', '--showkeyword',\n # dest='showkeyword',\n # default=\"True\",\n # help=\"Display keywords in metrics report\"\n # )\n\n general.add_argument(\n '-skt', '--showkwtimes',\n dest='showkwtimes',\n default=\"True\",\n help=\"Display keyword times in metrics report\"\n )\n\n general.add_argument(\n '-t', '--showtags',\n dest='showtags',\n default=\"False\",\n help=\"Display test case tags in test metrics\"\n )\n\n general.add_argument(\n '-d', '--showdocs',\n dest='showdocs',\n default=\"False\",\n help=\"Display test case documentation in test metrics\"\n )\n\n general.add_argument(\n '-L', '--log',\n dest='log_name',\n default='log.html',\n help=\"Name of log.html\"\n )\n\n args = parser.parse_args()\n return args\n\n\ndef main():\n args = parse_options()\n\n if args.version:\n print(__version__)\n exit(0)\n\n generate_report(args)" }, { "path": "robotframework_metrics/suite_results.py", "content": "from robot.api import ResultVisitor\nfrom robot.utils.markuputils import html_format\n\n\nclass SuiteResults(ResultVisitor):\n\n def __init__(self, suite_list):\n self.suite_list = suite_list\n \n def start_suite(self, suite):\n if suite.tests:\n try:\n stats = suite.statistics.all\n except:\n stats = suite.statistics\n \n try:\n skipped = stats.skipped\n except:\n skipped = 0\n\n suite_json = {\n \"Name\" : suite.longname,\n \"Id\" : suite.id,\n \"Status\" : suite.status,\n \"Documentation\" : html_format(suite.doc),\n \"Total\" : stats.total,\n \"Pass\" : stats.passed,\n \"Fail\" : stats.failed,\n \"Skip\" : skipped,\n \"Time\" : suite.elapsedtime,\n }\n self.suite_list.append(suite_json)" }, { "path": "robotframework_metrics/templates/index.html", "content": "\n\n\n\n \n \n Robot Metrics\n \n \n \n \n \n\n\n\n\n
\n \n
\n\n \n
\n
Metrics
\n \n \n
Dashboard
\n \n \n \n
Suite
\n \n \n \n
Test
\n \n \n \n
KW Times
\n \n \n \n
Details
\n \n
\n\n \n
\n\n
\n

Dashboard

\n
\n
\n
\n Test Status:\n
\n
\n
\n
\n \n \n \n \n \n \n \n \n \n
{{test_stats['Total']}}{{test_stats['Pass']}}
TotalPass
\n \n \n \n \n \n \n \n \n \n
{{test_stats['Fail']}}{{test_stats['Skip']}}
FailSkip
\n
\n
\n
\n\n
\n
\n
\n Suite Status:\n
\n
\n
\n
\n
\n
\n\n
\n
\n Keyword Status:\n
\n
\n
\n
\n
\n
\n\n
\n
\n Execution Duration (m):\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
TypeMinMaxAvg
Suite{{(suite_stats['Min']/60000)|round(2)}}{{(suite_stats['Max']/60000)|round(2)}}{{(suite_stats['Avg']/60000)|round(2)}}
Test{{(test_stats['Min']/60000)|round(2)}}{{(test_stats['Max']/60000)|round(2)}}{{(test_stats['Avg']/60000)|round(2)}}
\n
\n
\n
\n Execution Info:\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
ActionTime
Start Time{{ execution_stats[0] }}
End Time{{ execution_stats[1] }}
Duration{{ execution_stats[2] }}
\n
\n
\n\n\n
\n\n
\n
\n
\n
\n
\n Top 10 Failed Suites:\n
\n
\n
\n
\n
\n
\n
\n Test Count By Elapsed Time:\n
\n
\n
\n
\n
\n
\n
\n
\n\n \n
\n

Suite Metrics

\n
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n {% for suite in suites %}\n \n \n {% if (suite['Status'] == \"PASS\") %}\n \n {% elif (suite['Status'] == \"FAIL\") %}\n \n {% else %}\n \n {% endif %}\n \n \n \n \n \n \n {% endfor %}\n \n
NameStatusTotalPassFailSkipTime (s)
\n {{ suite['Name'] }}{{ suite['Status'] }}{{ suite['Status'] }}{{ suite['Status'] }}{{ suite['Total'] }}{{ suite['Pass'] }}{{ suite['Fail'] }}{{ suite['Skip'] }}{{ (suite['Time']/1000)|round(2) }}
\n
\n\n \n
\n

Test Metrics

\n
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n {% for test in tests %}\n \n \n \n {% if (test['Status'] == \"PASS\") %}\n \n {% elif (test['Status'] == \"FAIL\") %}\n \n {% else %}\n \n {% endif %}\n \n \n \n \n {% endfor %}\n \n
Suite NameTest NameStatusTime (s)MessageTags
{{ test['Suite Name'] }}\n {{ test['Test Name'] }}{{ test['Status'] }}{{ test['Status'] }}{{ test['Status'] }}{{ (test['Time']/1000)|round(2) }}{{\n test['Message'] }}{{ test['Tags'] }}\n
\n
\n\n \n
\n

KW Times Metrics

\n
\n \n \n \n \n \n \n \n \n \n \n \n \n {% if not keyword_times.empty %}\n {% for key, value in keyword_times.iterrows() %}\n \n \n \n \n \n \n \n \n {% endfor %}\n {% endif %}\n \n
Keyword NameTimesFail CountMin Duration(s)Max Duration(s)Average Duration(s)
{{ value['Name'] }}{{ value['times'] }}{{ value['fail_count'] }}{{ (value['time_min']/1000)|round(2) }}{{ (value['time_max']/1000)|round(2) }}{{ (value['time_mean']/1000)|round(2) }}
\n
\n\n
\n

Details

\n
\n \n
\n\n \n
\n \n \n \n \n
\n\n
\n
\n
\n {% for suite in suites_list %}\n {% if suite['tests'] %}\n
\n
{{ suite[\"suite_name\"] }}
\n
\n {% endif %}\n {% endfor %}\n
\n
\n\n
\n
\n
\n {% for suite in suites_list %}\n {% if suite['tests'] %}\n
\n

{{ suite['suite_name'] }}

\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
TotalPassFailSkipDuration
{{ suite['total'] }}{{ suite['pass_count'] }}{{ suite['fail_count'] }}{{ suite['skip_count'] }}{{ suite['elapsed_time'] }}
\n
\n {% for test in suite['tests'] %}\n
\n
\n
{{ test[\"test_name\"] }}
\n
\n

Duration: {{ test['elapsed_time'] }}

\n

Tags: {{ test['tags'] }}

\n {% if test['status'] == \"FAIL\" %}\n

Message:

\n
\n

{{ test['message'] }}

\n
\n
\n

Failed Keywords:

\n
\n {% for keyword in test['keywords'] %}\n {% if keyword['keyword_status'] == \"FAIL\" %}\n

{{ keyword['keyword_name'] }}

\n {% endif %}\n {% endfor %}\n
\n
\n {% endif %}\n
\n
\n
\n {% endfor %}\n
\n {% endif %}\n {% endfor %}\n
\n
\n
\n
\n
\n\n\n\n\n \n \n \n \n \n \n \n \n \n\n\n\n\n \n\n \n \n \n \n \n \n \n \n \n\n\n\n\n" }, { "path": "robotframework_metrics/test_results.py", "content": "from robot.api import ResultVisitor\nfrom robot.utils.markuputils import html_format\n\n\nclass TestResults(ResultVisitor):\n\n def __init__(self, test_list):\n self.test_list = test_list\n \n def visit_test(self, test):\n suite_name = test.parent if test.parent else test.parent.name\n test_json = {\n \"Suite Name\" : suite_name,\n \"Test Name\" : test.name,\n \"Test Id\" : test.id,\n \"Status\" : test.status,\n \"Documentation\" : html_format(test.doc),\n \"Time\" : test.elapsedtime,\n # \"Message\" : html_format(test.message),\n \"Message\" : str(test.message).replace(\"*HTML*\",\"\"),\n \"Tags\" : test.tags,\n 'start_time': test.starttime,\n 'end_time': test.endtime,\n }\n self.test_list.append(test_json)\n" }, { "path": "robotframework_metrics/version.py", "content": "__version__ = \"3.6.0\"\n" }, { "path": "setup.py", "content": "from setuptools import setup, find_packages\n\nsetup(\n name='robotframework-metrics',\n version=\"3.6.0\",\n description='Custom report for robot framework',\n long_description='Custom html report generator using robot.result api',\n classifiers=[\n 'Framework :: Robot Framework',\n 'Programming Language :: Python',\n 'Topic :: Software Development :: Testing',\n ],\n keywords='robotframework report',\n author='Shiva Prasad Adirala',\n author_email='adiralashiva8@gmail.com',\n url='https://github.com/adiralashiva8/robotframework-metrics',\n license='MIT',\n \n packages=find_packages(),\n include_package_data= True,\n zip_safe=False,\n \n install_requires=[\n 'robotframework',\n 'jinja2',\n 'pandas',\n ],\n entry_points={\n 'console_scripts': [\n 'robotmetrics=robotframework_metrics.runner:main',\n ]\n },\n )\n" } ]