ecolutis-junit-viewer
v4.11.3
Published
A simple and quick tool to view junit results
Downloads
350
Readme
Junit Viewer
Junit Viewer is a very simple yet powerful way of viewing your xunit results
Features
Reads a file or folder (and all sub folders) of XML results Hence you don't need to run this on separate files
Has it's own API Now you can embed it in your own test runners in order to save the results in a quick and nice viewer
Single Page Results You don't need to have a whole folder of files in order to view your results (trke all other junit viewers)
Shows HTML output This tool will show HTML in your test messages, meaning it is a great test snapshot tool to show images
Using Express to start a server Means you can just hit refresh and you have your latest tests instead of re-running Junit Viewer
Search It comes with a search box so you can search your suites and tests and test messages but also properties, it uses matching similar to Sublime e.g 'HW' would match against 'HelloWorld' (so would 'hw') and you can also search using regex e.g. 'h(.*)' would match against 'HelloWorld' or you can use a glob search e.g. '*world' would match against 'hello world'
Skeleton It uses Skeleton so it is pretty, responsive and quick
Quick It uses mustache and has no jquery as such it is quicker than any other junit test viewer
Independent It is independent of any testing tool, so it can work with anything which can produce junit results
Contracted View It provides a contracted default view for all suits at startup
Install It
npm install junit-viewer -gRun It
If you just want to log to the terminal
junit-viewer --results=file_or_folder_locationBy default it will just set the results folder to the current directory so you could just run
junit-viewerIf you want to save it to a file
junit-viewer --results=file_or_folder_location --save=file_location.htmlIf you want to start a server
junit-viewer --results=file_or_folder_location --port=port_numberBy default it is minified but if you don't want it minified
junit-viewer --results=file_or_folder_location --minify=falseBy default it displays expanded view of suits
junit-viewer --results=file_or_folder_location --contractedUsing the API
npm install --save-dev junit-viewervar jv = require('junit-viewer')
var parsedData = jv.parse('fileOrFolderLocation')
// var parsedData = jv.parseXML('xml data')
var renderedData = jv.render(parsedData)
var parsedAndRenderedData = jv.junit_viewer('fileOrFolderLocation')Code Documentation
Using Junit Viewer's very own unit tests (using a single file result)
Demos
Using Junit Viewer's very own unit tests (using a folder of results)
Running in Browser
You can also run junit_viewer in the browser. To make this work, you need to bundle the junit_viewer API using a suitable tool.
In this example, I am using browserify but webpack etc. should work just fine as well.
Create a file for setting up the bundle:
bundle_setup.js
var viewer = require('./junit_viewer');
window.JUnitViewer = viewer;Install some dependancies:
npm install -g browserify
npm install brfs --saveMake the bundle:
browserify bundle_setup.js -o junit-viewer-bundle.js -t brfsNow you can use the bundle in HTML. In this example, I am putting the rendered output into an iframe. Replace with the content of the xml for the test output:
index.html
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<title>JUnit test results</title>
<script src="junit-viewer-bundle.js"></script>
<style>
* {
box-sizing: border-box;
margin: 0;
}
html,
body,
#results {
width: 100%;
height: 100%;
}
</style>
</head>
<body>
<iframe id="results"></iframe>
<script>
try {
var xmlResults = "<!--XMLString-->";
var parsedResults = JUnitViewer.parseXML(xmlResults);
var renderedData = JUnitViewer.render(parsedResults);
document.getElementById('results').contentWindow.document.write(renderedData);
} catch (e) {
alert('Error: ' + e.toString() + ' - ' + e.stack);
}
</script>
</body>
</html>Contributions
If you wish to contribute then you can either create an issue or fork it and create a PR
When developing all you need to do is
npm iAnd to run the tests
npm testThe testing strategy is an integration test and not a conventional unit test