v3.1.7 changes

Author: adiralashiva8

README.md

@@ -11,7 +11,7 @@ Creates awesome HTML (dashboard view) report by parsing robotframework output.xm
 ---
  - __Sample Report__ [link](https://robotmetrics.netlify.com/)
 
- - Whats new in __v3.1.6__ [link](https://github.com/adiralashiva8/robotframework-metrics/releases/tag/v3.1.6)
+ - Whats new in __v3.1.7__ [link](https://github.com/adiralashiva8/robotframework-metrics/releases/tag/v3.1.7)
 
  - Source Code used to parse output.xml in metrics report [link](https://adiralashivaprasad.blogspot.com/2019/01/how-to-get-suite-test-and-keyword.html)
 
@@ -93,6 +93,28 @@ Specify Logo in Robotframework metrics:
    ```
    > By default `--ignorekeywords` is `False`
 
+---
+
+#### Exclude Logs in Metrics Report
+
+ - From `v3.1.7` users can exclude Logs tab in metrics report using `--ignorelogs` or `-l` command
+
+   ```
+   robotmetrics -l True
+   ```
+   > By default `--ignorelogs` is `False`
+
+---
+
+#### Include Full Suite Name in Metrics Report
+
+ - From `v3.1.7` users can include full suite name in metrics report using `--fullsuitename` or `-s` command
+
+   ```
+   robotmetrics -s True
+   ```
+   > By default `--fullsuitename` is `False`
+
 
 #### How to Ignore Library Keywords in Metrics Report
 

robotframework_metrics/robotmetrics.py

@@ -125,7 +125,7 @@ def generate_report(opts):
 
             .sidenav {
                 height: 100%;
-                width: 240px;
+                width: 220px;
                 position: fixed;
                 z-index: 1;
                 top: 0;
@@ -205,6 +205,11 @@ def generate_report(opts):
         hide_keyword = "hidden"
     else:
         hide_keyword = ""
+    
+    if opts.ignorelogs == "True":
+        hide_logs = "hidden"
+    else:
+        hide_logs = ""
 
     soup = BeautifulSoup(head_content, "html.parser")
     body = soup.new_tag('body')
@@ -217,9 +222,9 @@ def generate_report(opts):
         <a class="tablink" href="#" onclick="openPage('suiteMetrics', this, '#fc6666'); executeDataTable('#sm',5)"><i class="fa fa-th-large" style="color:CADETBLUE"></i> Suite Metrics</a>
         <a class="tablink" href="#" onclick="openPage('testMetrics', this, '#fc6666'); executeDataTable('#tm',3)"><i class="fa fa-list-alt" style="color:PALEVIOLETRED"></i> Test Metrics</a>
         <a %s class="tablink" href="#" onclick="openPage('keywordMetrics', this, '#fc6666'); executeDataTable('#km',3)"><i class="fa fa-table" style="color:STEELBLUE"></i> Keyword Metrics</a>
-        <a class="tablink" href="#" onclick="openPage('log', this, '#fc6666');"><i class="fa fa-wpforms" style="color:CHOCOLATE"></i> Logs</a>
+        <a %s class="tablink" href="#" onclick="openPage('log', this, '#fc6666');"><i class="fa fa-wpforms" style="color:CHOCOLATE"></i> Logs</a>
     </div>
-    """ % (logo, hide_keyword)
+    """ % (logo, hide_keyword, hide_logs)
 
     body.append(BeautifulSoup(icons_txt, 'html.parser'))
 
@@ -541,9 +546,9 @@ def generate_report(opts):
 
     # GET SUITE METRICS
     if group:
-        group.spawn(result.visit, SuiteResults(soup, suite_tbody, log_name))
+        group.spawn(result.visit, SuiteResults(soup, suite_tbody, log_name, opts.fullsuitename))
     else:
-        result.visit(SuiteResults(soup, suite_tbody, log_name))
+        result.visit(SuiteResults(soup, suite_tbody, log_name, opts.fullsuitename))
 
     test_icon_txt = """
     <div class="row">
@@ -600,14 +605,18 @@ def generate_report(opts):
     th.string = "Error Message"
     tr.insert(4, th)
 
+    th = soup.new_tag('th')
+    th.string = "Tags"
+    tr.insert(5, th)
+
     test_tbody = soup.new_tag('tbody')
     table.insert(11, test_tbody)
 
     # GET TEST METRICS
     if group:
-        group.spawn(result.visit, TestResults(soup, test_tbody, log_name))
+        group.spawn(result.visit, TestResults(soup, test_tbody, log_name, opts.fullsuitename))
     else:
-        result.visit(TestResults(soup, test_tbody, log_name))
+        result.visit(TestResults(soup, test_tbody, log_name, opts.fullsuitename))
 
     test_icon_txt = """
     <div class="row">
@@ -684,19 +693,22 @@ def generate_report(opts):
     # START OF LOGS
 
     # Logs div
-    log_div = soup.new_tag('div')
-    log_div["id"] = "log"
-    log_div["class"] = "tabcontent"
-    page_content_div.insert(200, log_div)
-
-    test_icon_txt = """
-        <p style="text-align:right">** <b>Report.html</b> and <b>Log.html</b> need to be in current folder in 
-        order to display here</p>
-      <div class="embed-responsive embed-responsive-4by3">
-        <iframe class="embed-responsive-item" src=%s></iframe>
-      </div>
-    """ % log_name
-    log_div.append(BeautifulSoup(test_icon_txt, 'html.parser'))
+    if opts.ignorelogs == "True":
+        pass
+    else:
+        log_div = soup.new_tag('div')
+        log_div["id"] = "log"
+        log_div["class"] = "tabcontent"
+        page_content_div.insert(200, log_div)
+
+        test_icon_txt = """
+            <p style="text-align:right">** <b>Report.html</b> and <b>Log.html</b> need to be in current folder in 
+            order to display here</p>
+        <div class="embed-responsive embed-responsive-4by3">
+            <iframe class="embed-responsive-item" src=%s></iframe>
+        </div>
+        """ % log_name
+        log_div.append(BeautifulSoup(test_icon_txt, 'html.parser'))
 
     # END OF LOGS
     script_text = """

robotframework_metrics/runner.py

@@ -80,6 +80,20 @@ def parse_options():
         help="Ignore keywords in metrics report"
     )
 
+    general.add_argument(
+        '-l', '--ignorelogs',
+        dest='ignorelogs',
+        default="False",
+        help="Ignore logs in metrics report"
+    )
+
+    general.add_argument(
+        '-s', '--fullsuitename',
+        dest='fullsuitename',
+        default="False",
+        help="Use full suite name in report"
+    )
+
     args = parser.parse_args()
     return args
 

robotframework_metrics/suite_results.py

@@ -3,10 +3,11 @@
 
 class SuiteResults(ResultVisitor):
 
-    def __init__(self, soup, tbody, log_name):
+    def __init__(self, soup, tbody, log_name, full_suite_name):
         self.soup = soup
         self.tbody = tbody
         self.log_name = log_name
+        self.full_suite_name = full_suite_name
 
     def start_suite(self, suite):
         suite_test_list = suite.tests
@@ -18,7 +19,10 @@ def start_suite(self, suite):
             self.tbody.insert(0, table_tr)
 
             table_td = self.soup.new_tag('td', style="word-wrap: break-word;max-width: 250px; white-space: normal;cursor: pointer; color:blue; text-align:left")
-            table_td.string = str(suite)
+            if self.full_suite_name == "True":
+                table_td.string = str(suite.longname)
+            else:
+                table_td.string = str(suite)
             table_td['onclick'] = "openInNewTab('%s%s%s','%s%s')" % (self.log_name, '#', suite.id, '#', suite.id)
             table_td['data-toggle'] = "tooltip"
             table_td['title'] = "Click to view '%s' logs" % suite

robotframework_metrics/test_results.py

@@ -3,17 +3,25 @@
 
 class TestResults(ResultVisitor):
 
-    def __init__(self, soup, tbody, logname):
+    def __init__(self, soup, tbody, logname, full_suite_name):
         self.soup = soup
         self.tbody = tbody
         self.log_name = logname
+        self.full_suite_name = full_suite_name
 
     def visit_test(self, test):
         table_tr = self.soup.new_tag('tr')
         self.tbody.insert(0, table_tr)
 
         table_td = self.soup.new_tag('td', style="word-wrap: break-word;max-width: 200px; white-space: normal; text-align:left")
-        table_td.string = str(test.parent)
+        if self.full_suite_name == "True":
+            try:
+                full_suite_name = test.longname.split("." + test.name)
+                table_td.string = str(full_suite_name[0])
+            except Exception as e:
+                table_td.string = str(test.parent)
+        else:
+            table_td.string = str(test.parent)
         table_tr.insert(0, table_td)
 
         table_td = self.soup.new_tag('td', style="word-wrap: break-word;max-width: 250px; white-space: normal;cursor: pointer; color:blue; text-align:left")
@@ -39,4 +47,8 @@ def visit_test(self, test):
 
         table_td = self.soup.new_tag('td', style="word-wrap: break-word;max-width: 250px; white-space: normal;text-align:left")
         table_td.string = test.message
-        table_tr.insert(4, table_td)
+        table_tr.insert(4, table_td)
+
+        table_td = self.soup.new_tag('td', style="word-wrap: break-word;max-width:100px; white-space: normal;text-align:left")
+        table_td.string = str(test.tags)
+        table_tr.insert(5, table_td)

robotframework_metrics/version.py

@@ -1 +1 @@
-__version__ = "3.1.6"
+__version__ = "3.1.7"