More granular reporting from BIMTester, and ability to run without packaging

src/ifcbimtester/bimtester.py

@@ -5,7 +5,6 @@
 
 from behave.__main__ import main as behave_main
 import behave.formatter.pretty # Needed for pyinstaller to package it
-import xml.etree.ElementTree as ET
 import ifcopenshell
 import pystache
 import os
@@ -16,16 +15,14 @@ import csv
 import re
 import shutil
 import webbrowser
+import datetime
 from pathlib import Path
 
-
 try:
     # PyInstaller creates a temp folder and stores path in _MEIPASS
     base_path = sys._MEIPASS
-    is_dist = True
 except Exception:
-    base_path = os.path.abspath(".")
+    base_path = os.path.dirname(os.path.realpath(__file__))
-    is_dist = False
 
 
 def get_resource_path(relative_path):
@@ -39,23 +36,28 @@ def run_tests(args):
     behave_args = [get_resource_path('features')]
     if args.advanced_arguments:
         behave_args.extend(args.advanced_arguments.split())
-    else:
+    elif not args.console:
-        behave_args.extend(['--junit', '--junit-directory', args.junit_directory])
+        behave_args.extend(['--format', 'json.pretty', '--outfile', 'report/report.json'])
     behave_main(behave_args)
     print('# All tests are finished.')
     return True
 
 
 def get_features(args):
-    has_features = False
+    current_path = os.path.abspath(".")
+    features_dir = get_resource_path('features')
+    for f in os.listdir(features_dir):
+        if f.endswith('.feature'):
+            os.remove(os.path.join(features_dir, f))
     if args.feature:
         shutil.copyfile(args.feature, os.path.join(
             get_resource_path('features'),
             os.path.basename(args.feature)))
         return True
-    if os.path.exists('features') and is_dist:
+    if os.path.exists('features'):
         shutil.copytree('features', get_resource_path('features'))
-        has_features = True
+        return True
+    has_features = False
     for f in os.listdir('.'):
         if not f.endswith('.feature'):
             continue
@@ -72,45 +74,52 @@ def generate_report(args):
     print('# Generating HTML reports now.')
     if not os.path.exists('report'):
         os.mkdir('report')
-    if not os.path.exists(args.junit_directory):
+    report_path = 'report/report.json'
-        os.mkdir(args.junit_directory)
+    if not os.path.exists(report_path):
-    for f in os.listdir(args.junit_directory):
+        return print('No report data was found.')
-        if not f.endswith('.xml'):
+    report = json.loads(open(report_path).read())
-            continue
+    for feature in report:
-        print(f'Processing {f} ...')
+        file_name = os.path.basename(feature['location']).split(':')[0]
-        root = ET.parse('{}{}'.format(args.junit_directory, f)).getroot()
         data = {
-            'report_name': root.get('name'),
+            'file_name': file_name,
-            'testcases': []
+            'time': datetime.datetime.now().strftime('%Y-%m-%d %H:%M:%S'),
+            'name': feature['name'],
+            'description': feature['description'],
+            'is_success': feature['status'] == 'passed',
+            'scenarios': []
             }
-        for testcase in root.findall('testcase'):
+        for scenario in feature['elements']:
             steps = []
-            system_out = testcase.findall('system-out')[0].text.splitlines()
+            total_duration = 0
-            for line in system_out:
+            for step in scenario['steps']:
-                if line.strip()[0:4] in ['Give', 'Then', 'When', 'And '] \
+                total_duration += step['result']['duration']
-                        or line.strip()[0:2] == '* ':
+                name = step['name']
-                    is_success = True if ' ... passed in ' in line else False
+                if 'arguments' in step['match']:
-                    name, time = line.strip().split(' ... ')
+                    for a in step['match']['arguments']:
-                    if name[0:2] == '* ':
+                        name = name.replace(a['value'], '<b>' + a['value'] + '</b>')
-                        name = name[2:]
+                steps.append({
-                    steps.append({
+                    'name': name,
-                        'name': name,
+                    'time': round(step['result']['duration'], 2),
-                        'time': time,
+                    'is_success': step['result']['status'] == 'passed',
-                        'is_success': is_success
+                    'error_message': None if step['result']['status'] == 'passed' else step['result']['error_message']
-                    })
+                })
             total_passes = len([s for s in steps if s['is_success'] == True])
             total_steps = len(steps)
             pass_rate = round((total_passes / total_steps) * 100)
-            data['testcases'].append({
+            data['scenarios'].append({
-                'name': testcase.get('name'),
+                'name': scenario['name'],
-                'is_success': testcase.get('status') == 'passed',
+                'is_success': scenario['status'] == 'passed',
-                'time': testcase.get('time'),
+                'time': round(total_duration, 2),
                 'steps': steps,
                 'total_passes': total_passes,
                 'total_steps': total_steps,
                 'pass_rate': pass_rate
                 })
-        with open('report/{}.html'.format(f[0:-4]), 'w') as out:
+        data['total_passes'] = sum([s['total_passes'] for s in data['scenarios']])
+        data['total_steps'] = sum([s['total_steps'] for s in data['scenarios']])
+        data['pass_rate'] = round((data['total_passes'] / data['total_steps']) * 100)
+
+        with open('report/{}.html'.format(file_name), 'w') as out:
             with open(get_resource_path('features/template.html')) as template:
                 out.write(pystache.render(template.read(), data))
 
@@ -172,11 +181,10 @@ parser.add_argument(
     action='store_true',
     help='Generate a HTML report')
 parser.add_argument(
-    '-j',
+    '-c',
-    '--junit-directory',
+    '--console',
-    type=str,
+    action='store_true',
-    help='Specify your own JUnit directory',
+    help='Show results in the console')
-    default='junit/')
 parser.add_argument(
     '-f',
     '--feature',
@@ -198,4 +206,3 @@ elif args.report:
 else:
     run_tests(args)
 print('# All tasks are complete :-)')
-sys.exit()

src/ifcbimtester/features/template.html

@@ -7,41 +7,63 @@
     <title>BlenderBIM</title>
     <link href="https://fonts.googleapis.com/css?family=Comfortaa|Inconsolata|Open+Sans&display=swap" rel="stylesheet">
     <style>
-        body { font-family: 'Arial', sans-serif; }
+        body { font-family: 'Arial', sans-serif; padding: 40px; }
         span.time { color: #999; font-style: italic; float: right; }
         span.step-time { float: right; color: #555; font-size: 0.8em; font-style: italic; }
         span.success { background-color: #97cc64; padding: 5px; border-radius: 5px; color: #FFF; font-weight: bold; }
         span.failure { background-color: #fb5a3e; padding: 5px; border-radius: 5px; color: #FFF; font-weight: bold; }
-        li { padding: 10px; }
+        p.failure { background-color: #fb5a3e; padding: 5px; border-radius: 5px; color: #fff; }
+        p.description { background-color: #eee; border-radius: 5px; padding: 20px; margin-left: auto; margin-right: auto; display: inline-block; font-weight: bold;}
+        li { padding: 10px; font-family: monospace; }
         li.success { background-color: #b6cca1; color: #333; }
         li.failure { background-color: #fbb4a8; color: #900; }
-        footer { color: #999; border-top: 1px solid #999; font-size: 0.8em; }
+        li p { margin-bottom: 0px; }
+        footer { color: #999; font-size: 0.8em; }
+        header { text-align: center; }
+        hr { margin: 20px; margin-left: 0px; margin-right: 0px;  border: none; border-top: 1px solid #ccc; }
     </style>
 </head>
 <body>
     <header>
-        <h1>IFC QA Report: {{report_name}}</h1>
+        <h1>{{name}}</h1>
+        <p><strong>{{time}} {{file_name}}</strong></p>
+        <hr>
+        <span class="{{#is_success}}success{{/is_success}}{{^is_success}}failure{{/is_success}}">{{#is_success}}Success{{/is_success}}{{^is_success}}Failure{{/is_success}}</span>
+        Tests passed: <strong>{{total_passes}} / {{total_steps}}</strong> ({{pass_rate}}%)
+        <br />
+        <p class="description">
+            {{#description}}
+            {{.}}<br />
+            {{/description}}
+        </p>
+        <hr>
     </header>
-    {{#testcases}}
+    {{#scenarios}}
     <section>
         <h2>{{name}}</h2>
         <p>
             <span class="{{#is_success}}success{{/is_success}}{{^is_success}}failure{{/is_success}}">{{#is_success}}Success{{/is_success}}{{^is_success}}Failure{{/is_success}}</span>
             Tests passed: <strong>{{total_passes}} / {{total_steps}}</strong> ({{pass_rate}}%)
             <span class="time">
-            Time taken: {{time}} seconds
+            Duration: {{time}}s
             </span>
         </p>
         <ol>
             {{#steps}}
             <li class="{{#is_success}}success{{/is_success}}{{^is_success}}failure{{/is_success}}">
-                {{name}}
+                {{{name}}}
-                <span class="step-time">{{time}}</span>
+                <span class="step-time">{{time}}s</span>
+                {{^is_success}}
+                <p class="failure">
+                    {{error_message}}
+                </p>
+                {{/is_success}}
             </li>
             {{/steps}}
         </ol>
     </section>
-    {{/testcases}}
+    {{/scenarios}}
+    <hr>
     <footer>
         <p>
             OpenBIM auditing is a feature of <a href="https://blenderbim.org/">BlenderBIM</a> and <a href="http://ifcopenshell.org/">IfcOpenShell</a>.