All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog and this project adheres to Semantic Versioning.
- Updated the handlebar-helpers module. 🏆 Credit to @scotty6435 🏆.
- Updated the Newman version used for the tests and upgraded the node version in the GH Action files.
- Fixed a ux issue which did not wrap long values in the headers sections and it added an unecessary scrollbar. 🏆 Credit to @w4dd325 🏆
- Fixed an issue with the theme switcher. 🏆 Credit to @IceBjerg 🏆
- Changed the way that
datatables
creates the instance of the test information table on each iteration
- Fixed the version of
cli-progress
htmlextra was using as this had the corrupted version ofcolor.js
.
- Updated the package dependencies
- Turned off the progress bar by default and included an optional
displayProgressBar
flag
- Fixed the version of
color.js
to version 1.40.0
- Fixed an issue with collaspe behavior on the failed tab. 🏆 Credit to @praveendvd 🏆
- Fixed an issue with form-data show disabled keys in the reports. 🏆 Credit to @praveendvd 🏆
- Fixed an issue with requests and folders not showing on the report. 🏆 Credit to @praveendvd 🏆
- Added the
skipFolders
andskipRequests
flags. 🏆 Credit to @praveendvd 🏆
- Fixed an issue with the way certain information was rendered in a markdown table on the descriptions. 🏆 Credit to @praveendvd 🏆
- Removed the unneeded files from the final package. 🏆 Credit to @b-pagis 🏆
- Updated the dependencies and increased the node version in the GH workflow to 14
- Added additional
omitRequestBodies
andomitResponseBodies
flags. 🏆 Credit to @dersvenhesse 🏆
- Updated repo and docker readme file
- Updated dependencies
- Fixed issue that was causing the iteration tab numbers to wrap for 1000+ iteration runs
- Added some basic repo contribution steps to the readme file for local development
- Styling issue when the
noSyntaxHighlighting
flag was used. 🏆 Credit to @stickpin 🏆
- Added extra checks into the
isNotIn
helper to account fornull
key values. 🏆 Credit to @manoelagonzaga 🏆 - Typo fixed in the Global Varaible option for the template. 🏆 Credit to @sweetnoods 🏆
- Updated dependencies
- Fixed issue that was preventing htmlextra from being used as a library
- Updated dependencies
- Updated the
highlight.js
version for node_modules and CDN links in templates
- Fixed issue with the rendering of the CLI progress output
- Fixed issue with the rendering of the CLI version output
- Added a progress bar (The default progress bar will show if that reporter is used)
- Added an a helper output from the CLI to display the reporters options and version
- Added a bit more feedback when Newman is running with the reporter
- Added a new
hideRequestBody
flag to allow you hide a specific request body from the final report
- Changed the
hideResponse
flag tohideResponseBody
to make it more descriptive
- Fixed an issue that occurs when a
request name / header name
is not used when skipping certain elements from the report
- Added a tests to cover the above scenario
- Added the Folder level descriptions
- Included the names of the Folders used with the
folder
Newman flag in the Summary
- Added a new logo to the project - Expertly created by Bruce Hughes (The Legend)
- Added a
showGlobalData
flag to allow user to see all the global varaibles used in the Newman run. These could be from within a file or on the CLI - Added a
skipGlobalVars
flag to allow you hide specific global variables from the final report. This would work when theshowGlobalData
is set
- Optional
--reporter-htmlextra-timezone
flag to specify the timezone in the report timestamp
- Made the timestamp in the report timezone aware with
moment-timezone
- Updated the README
- Reformatted parts of the README
- Included the
Expand All/Collapse All
actions on the Failed and Skipped tabs
- Removed the Dark Theme flag as the default report now gives you the ability to pick either theme with the flag
- Added a
showMarkdownLinks
flag which allows you render Markdown links from the test names andpm.expect()
statements, in the final report
- Added a
showEnvironmentData
flag to allow user to see all the environment varaibles used in the Newman run. These could be from within a file or on the CLI - Added a
skipEnvironmentVars
flag to allow you hide specific environment variables from the final report. This would work when theshowEnvironmentData
is set
- Updated the default templates to use the new environment flags
- Updated the tests to cover the environment flag features
- The Collection markdown description was using the wrong HTML tags and rendering incorrectly
- Added a toggle on the report to switch between showing all the iteration or just showing the iterations that failed 🏆 Credit to @praveendvd 🏆
- Improved the button actions for showing/hiding folders and requests 🏆 Credit to @praveendvd 🏆
- Added Integration tests for the valid and invalid filenames 🏆 Credit to @praveendvd 🏆
- Fixed an issue that caused the report to not be created if the filename had invalid characters 🏆 Credit to @praveendvd 🏆
- Fixed a styling issue that caused the report to flicker when refreshed
- Added a new
hideResponse
flag to allow you hide a specific response body from the final report
- Single folder collections will now show all the folders in multiple iteration runs. 🏆 Credit to @praveendvd 🏆
- The
browserTitle
andtitle
flags will now take dynamic values when run in a loop with multiple collections
- Tidied up the old
console.log()
code that was previously used to capture the statements
- The
console.logs
are now part of the main request view and not a seperate section
- Second go at fixing issue where the
skipHeaders
list was case-sensitive and not removing certain headers - Added more tests for the
skipHeaders
andomitHeaders
flags
- Reverted change to the
skipHeaders
helper - Added tests for the
skipHeaders
andomitHeaders
flags
- Added to new handlebar helpers to calculate the
totalFolders
andtotalFailedFolders
in the templates - Fallback default report name is used if a collection name is not supplied when creating collections with the SDK
- Fixed issue where the
skipHeaders
list was case-sensitive and not removing certain headers
- Project npm modules
- Fix for the folder results indicator
- Dark/Light theme switcher included for the default templates
- All darkTheme functionality remains in place but will be removed in later versions
- Updated the sample reports that are accessed from the README
- Numbers wrapping in the summary boxes under certain conditions
- Spacing on the Iteration tabs when only a single row is shown
- Pass/Fail iteration tab colours
- Filter for Iterations
- Selected Iteration label
- Style changes to the Iteration tabs
- Includes additional buttons for expanding/collapsing all the requests
- Fixed the sizing on the main summary panels if the number are greater than 9999
- Iteration tab is now more visible when the iteration is selected
- Closed some unclosed
<div>
tags in the default templates 🏆 Credit to @bassie1995 🏆
- Added the
omitHeaders
flag to hide all headers from the requests and responses
- Fixed an issue with the
Back To Top
button that caused a flood of errors in the console
- Includes a
Back To Top
button for all the different tabs - Fixed some inconsistency in the style of the different tabs
- Supports displaying a GraphQL Request Body and any GraphQL Variables
- Added an option to hide certain headers from requests and responses by name 🏆 Credit to @bassie1995 🏆
- Added an option to skip outputting headers and bodies in all requests and responses 🏆 Credit to @bassie1995 🏆
- Added a button to give users the ability to copy the
request body
to the clipboard
- Added support to format XML responses 🏆 Credit to @ldz-w 🏆
- Updated the node package dependencies
- Fixed a bug that prevented the Expand/Collapse buttons from working on multiple iterations
- Bumping the version to manually publish a new NPM version
- Added support for
urlencoded
request bodies - Added new tests to cover this request body type
- Added a visual clue to the
request
bar to show the number ofskipped
tests
- Fixed the incorrectly formatted JSON on the response body
- Syntax error in the templates causing iterations on Safari to fail 🏆 Credit to @sam-viz 🏆
- Added support for
formdata
request bodies 🏆 Credit to @Prachi481992 🏆 - Added new tests to cover this request body type
- Incorrect spelling on the template
- Updated the jQuery links inside the templates
- Added a new
titleSize
cli option to change the size of the main heading which becomes truncated when using thetitle
flag
- Added buttons to expand / collapse all the folders in the
Total Requests
tab - Added a visual indicator on the folder bar to show if any of the requests have failed tests in them
- Added a helper to change the browser title element from the CLI
- The
Failed Tests
tab now also includes the folder path of the failed test.
- A optional flag has been added to display the
console.log()
statements in the report
- Updated the
README
with links to an interactive set of reports
- Updated the dependencies
- Changed the styling on all the templates if the request doesn't have tests
- Added the
Request Headers
table to all the templates
- Added the
retrieve
property to the DataTables object
- Changed the flag name from
paging
totestPaging
- Added a
paging
flag to allow the pagination of the tests in the request view
- Added a search and filter feature to the test result tables
- Fixed Issue with the template
- Added a
dark
theme when showing only the test fails
- Extra information about the test failures in the request view
- A
--reporter-htmlextra-showOnlyFails
option to tell the reporter to display only the requests with failed tests
- Prevented the
Response Header
name wrapping the text on the table view.
- If no export file name and location are included, the report name will include the collection name
- Changed the style on the
Response Headers
to a table view.
- Displayed the number of the requests within each of the folders
- A new CLI option that allows the user to give the report a new main title
- The
Skipped
panel on the dashboard will beAmber
if any tests are skipped
- The Iteration panel on the dashboard will be
red
if any tests failed during the run
- The folder sections in the request tab are now collapsible
- A new
--reporter-htmlextra-darkTheme
cli flag to tell the reporter to use the dark theme dashboard - A new
darkTheme
property option if used with a script
- A new dark theme dashboard template
- A new package will be deployed from Travis if all the tests pass
- Updated the default template to allow each failure card to be collapsible
- Exposed the
Response Headers
on the report for each request
- Updated the default template to allow each request card to be collapsible
- Included some tooltips for the Summary page tabs to make it clearer that these are clickable buttons
- I've attempted to expose the
console.log
statements from theTests
andPre-Requests
. - Created some tests to cover the addition of the console logs.
- Updated the default template to include a
Console Logs
tab
- The
Assertions Passed
label of the Summary view was quite confusing
- Added the
iteration
property to the aggregationparent
object in theindex.js
file to separate the requests easier
- Updated the dashboard template to separate each iteration into tabs
- Updated the out of date modules
- Copy and Paste feature was not working as expected, if fixed that. :)
- Styling changes to the dashboard template.
- Made the dashboard template the default one for the reporter
- Alternative template added to the
./templates
dir.
- The dashboard template request headers were not turning red if a test failed.
- The templates now display the request body, if the request has one.
- Added images of the new dashboard style report to the
README.md
file
- Added a new dashboard style report template
- Added the ability to display the folder level descriptions on the report
- Updated the default template to show the folder level descriptions
- Markdown is now rendered on the HTML page
- Travis CI badge to the
README
file
- Node v6 build removed from Travis file - No
npm ci
support for that version
- Created a
.travis.yml
file and committed thepackage-lock.json
file to the repo
- Added integration tests for the CLI runner
- All the Skipped Tests during the collection run are now part of the individual requests (This has a dependency on Newman Version 4.2.3 or higher)
- Added some integration and repository level tests
- Updated the default template to show the skipped tests in the single request summary
- Updated the default template to fix a pass percentage calculation error
- Exposed the skipped tests - Currently, this are still showing as
passed
in the main aggregations though :(
- Updated the default template
- Included the
moment-helpers
module to give more flexibly about what date format you can choose
- Updated the default template
- Missed a single comma in the
./lib/index.js
file which caused the package to fail :(
- Updated the
package.json
file to include more details
- Initial Release