Merge pull request #4 from hansenmc/code-coverage

code coverage

Author: dmcassel

src/main/ml-modules/root/test/css/coverage.css

@@ -0,0 +1,91 @@
+/**
+* Copyright 2012-2018 MarkLogic Corporation
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*
+* The use of the Apache License does not indicate that this project is
+* affiliated with the Apache Software Foundation.
+*
+* Code adapted from xray
+* https://github.com/robwhitby/xray/tree/v2.1
+*
+* Modifications copyright (c) 2018 MarkLogic Corporation
+**/
+
+ol.coverage-source li {
+    font-family: monospace;
+    margin-left: 30px;
+    color: #999;
+}
+ol.coverage-source li pre {
+    display: inline;
+    padding: 0 2px;
+    color: #000;
+}
+ol.coverage-source li.wanted pre { background-color: #f66; }
+ol.coverage-source li.covered pre { background-color: #6f6; }
+
+summary, ul li, ul pre { margin: 0; padding: 5px 10px; font-weight: normal; }
+summary {
+    display: block; /* for non webkit */
+    border-top-left-radius: 10px;
+    border-top-right-radius: 10px;
+    background-color: #ddd;
+    font-weight: bold;
+}
+
+section.coverage details {
+    margin-bottom: 2em;
+}
+section.coverage details > table {
+    border-top-left-radius: 0px;
+    border-top-right-radius: 0px;
+    border-bottom-left-radius: 10px;
+    border-bottom-right-radius: 10px;
+}
+section.coverage details > table thead th:first-child {
+    border-top-left-radius: 0px;
+}
+section.coverage details > table thead th:last-child {
+    border-top-right-radius: 0px;
+}
+section.coverage details > table tfoot th {
+    border-radius: 0px;
+}
+section.coverage details > table tfoot th:first-child  {
+    border-bottom-left-radius: 10px;
+}
+section.coverage details > table tfoot th:last-child {
+    border-bottom-right-radius: 10px;
+}
+
+.bar-chart {
+    width: 100%;
+    height: 1em;
+}
+span.bar {
+    display: inline-block;
+    height: 50%;
+    box-sizing: border-box;
+    float: left;
+    font-weight: bold;
+    font-family: arial, sans-serif;
+}
+
+.missed {
+    background: #f66;
+}
+
+.covered {
+    background: #6f6;
+}

src/main/ml-modules/root/test/default.xqy

@@ -15,7 +15,9 @@ limitations under the License.
 :)
 xquery version "1.0-ml";
 
-import module namespace helper="http://marklogic.com/roxy/test-helper" at "/test/test-helper.xqy", "/test/test-controller.xqy";
+import module namespace helper="http://marklogic.com/roxy/test-helper"
+	at "/test/test-helper.xqy", "/test/test-controller.xqy";
+import module namespace coverage="http://marklogic.com/roxy/test-coverage" at "/test/test-coverage.xqy";
 
 declare namespace t="http://marklogic.com/roxy/test";
 
@@ -27,9 +29,10 @@ declare function local:run() {
 	let $run-suite-teardown as xs:boolean := xdmp:get-request-field("runsuiteteardown", "") eq "true"
 	let $run-teardown as xs:boolean := xdmp:get-request-field("runteardown", "") eq "true"
 	let $format as xs:string := xdmp:get-request-field("format", "xml")
+	let $calculate-coverage as xs:boolean := xdmp:get-request-field("calculatecoverage", "") eq "true"
 	return
 		if ($suite) then
-			let $result := helper:run-suite($suite, $tests, $run-suite-teardown, $run-teardown)
+			let $result := helper:run-suite($suite, $tests, $run-suite-teardown, $run-teardown, $calculate-coverage)
 			return
 				if ($format eq "junit") then
 					helper:format-junit($result)
@@ -43,6 +46,32 @@ declare function local:list()
 	helper:list()
 };
 
+(:~
+ : Generate the code coverage report
+ :)
+declare function local:coverage-report()
+{
+  let $test-results := xdmp:get-request-body("xml")
+	let $format := xdmp:get-request-field("format", "html")
+	let $params := map:new(( map:entry("test-dir", xdmp:get-request-field("/test/suites/")) ))
+	let $coverage-summary := coverage:summary($test-results/*)
+	return
+		xdmp:xslt-invoke("/test/xslt/coverage/report/" || $format || ".xsl", $coverage-summary)
+};
+
+(:~
+ : Generate view of module coverage
+ :)
+declare function local:coverage-module()
+{
+	let $module as xs:string := xdmp:get-request-field("module")
+	let $format as xs:string := xdmp:get-request-field("format", "html")
+	let $wanted as xs:integer* := for $line in xs:NMTOKENS(xdmp:get-request-field("wanted")) return xs:integer($line)
+	let $covered as xs:integer* := for $line in xs:NMTOKENS(xdmp:get-request-field("covered")) return xs:integer($line)
+	return
+		coverage:module-view($module, $format, $wanted, $covered)
+};
+
 (:~
  : Provides the UI for the test framework to allow selection and running of tests
  :)
@@ -86,7 +115,6 @@ declare function local:main() {
 							<th>Failed</th>
 						</tr>
 					</thead>
-
 					<tbody>
 						{
 							for $suite at $index in helper:list()/t:suite
@@ -101,7 +129,6 @@ declare function local:main() {
 												<img class="tests-toggle-minus" src="img/arrow-down.gif"/>
 												{fn:data($suite/@path)} <span class="spinner"><img src="img/spinner.gif"/><b>Running...</b></span>
 											</div>
-
 										</td>
 										<td>{fn:count($suite/t:tests/t:test)}</td>
 										<td class="tests-run">-</td>
@@ -130,11 +157,13 @@ declare function local:main() {
 											</div>
 										</td>
 									</tr>
-
 								)
 						}
 					</tbody>
 				</table>
+
+				<div id="coverage-report"></div>
+
 				<table cellspacing="0" cellpadding="0" >
 					<thead>
 						<tr>
@@ -148,6 +177,9 @@ declare function local:main() {
 						<tr>
 							<td><label for="runteardown">Run Teardown after each test</label><input id="runteardown" type="checkbox" checked="checked"/></td>
 						</tr>
+						<tr>
+							<td><label for="calculatecoverage">Calculate Coverage</label><input id="calculatecoverage" type="checkbox" /></td>
+						</tr>
 					</tbody>
 				</table>
 				<input class="runtests button" type="submit" value="Run Tests" title="(ctrl-enter) works too!"/>

src/main/ml-modules/root/test/js/tests.js

@@ -1,19 +1,38 @@
 /**
-* Copyright 2012-2015 MarkLogic Corporation
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-*    http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-**/
+ * Copyright 2012-2018 MarkLogic Corporation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ *  The use of the Apache License does not indicate that this project is
+ * affiliated with the Apache Software Foundation.
+ *
+ * Code adapted from xray
+ * https://github.com/robwhitby/xray/tree/v2.1
+ *
+ * Modifications copyright (c) 2018 MarkLogic Corporation
+ **/
 var queue = [];
+var coverage = $.parseXML("<test:tests xmlns:test='http://marklogic.com/roxy/test'/>");
+
+function resetCoverage() {
+  'use strict';
+
+  var tests = coverage.documentElement;
+  while (tests.firstChild) {
+    tests.removeChild(tests.firstChild);
+  }
+  $('#coverage-report').empty();
+}
 
 function disableParent(item, parentClass) {
   'use strict';
@@ -25,7 +44,6 @@ function disableParent(item, parentClass) {
   else {
     li.addClass('disabled');
   }
-
 }
 
 function runNextTest() {
@@ -89,9 +107,36 @@ function runNextTest() {
       time: ''
     });
 
+    coverageReport(coverage);
   }
 }
 
+function coverageReport() {
+    'use strict';
+    var $coverageReport = $('#coverage-report');
+    var calculateCoverage = $('#calculatecoverage').prop('checked');
+    if (calculateCoverage) {
+        $.ajax({
+            url: 'default.xqy?func=coverage-report&format=html',
+            type: "POST",
+            cache: false,
+            data: (new XMLSerializer()).serializeToString(coverage),
+            contentType: "text/xml",
+            processData: false,
+            dataType: 'html',
+            success: function (data) {
+                $coverageReport.empty();
+                $coverageReport.append(data);
+            },
+            error: function (data) {
+                resetCoverage();
+            }
+        });
+    } else {
+        $coverageReport.empty();
+    }
+}
+
 function renderError(error) {
   'use strict';
 
@@ -229,6 +274,8 @@ function suiteSuccess(parent, xml) {
   var spinner = parent.find('span.spinner');
   spinner.hide();
 
+  coverage.documentElement.appendChild(xml.documentElement);
+
   runNextTest();
 }
 
@@ -256,6 +303,7 @@ function runSuite(suite) {
 
   var suiteTearDown = $('#runsuiteteardown').prop('checked');
   var tearDown = $('#runteardown').prop('checked');
+  var calculateCoverage = $('#calculatecoverage').prop('checked');
   var spinner = parent.find('span.spinner');
   spinner.show();
 
@@ -267,7 +315,8 @@ function runSuite(suite) {
       suite: suite,
       tests: tests.join(','),
       runsuiteteardown: suiteTearDown,
-      runteardown: tearDown
+      runteardown: tearDown,
+      calculatecoverage: calculateCoverage
     },
     dataType: 'xml',
     success: function(data) {
@@ -289,13 +338,12 @@ function run() {
   $('td.failed').text('-');
   $('td.passed').text('-');
   $('div.failure').remove();
-
+  resetCoverage();
   queue = [];
   $('input.cb:checked').each(function(){
     queue.push(this.value);
   });
 
-
   if (queue.length > 0) {
     $('#failed-count').text('Running...');
     $('.runtests').hide();
@@ -309,12 +357,12 @@ function cancel() {
   'use strict';
 
   queue.length = 0;
+  resetCoverage();
   $('#failed-count').text('Stopping tests...');
   $('.canceltests').hide();
 }
 
 $(document).ready(function(){
-
   'use strict';
 
   $.extend($.gritter.options, {