Scenarioo Release Notes

Version 4.0.1

Bugfixes

• #751 - Sharing Step Screenshot Sharing screenshot images through direct links with other applications works again, also the share this page dialog shows the correct link again.

Version 4.0.0

Feature "Diff Viewer Plus"

Improvements to the Diff Viewer for Visual Regression Testing:

• #692 - Create Comparison Manually through the Web Frontend: user can create a comparison through a modal dialog.
• #603 - Improved Comparison View to understand the comparison of two screenshots and the possible comparison view options better. Highlighting of changes is now available in both screenshots.
• #605 - Comparison REST API to trigger Comparisons from Automated CI Test Pipelines to more easily integrate Diff Viewer comparisons for visual regression testing into your automated test pipeline.
• #650 - Manage Comparisons View: To see all calculated comparisons, their error logs and have the ability to trigger a comparison for recalculation if needed.
• #673 - Comparison Configurations with Regexp for base branches to compare: allow to define comparisons against another build to be calculated on multiple branches selected by regexp (e.g. for all feature branches).
• #596 - Configure Highlight Color for Changes in DiffViewer Comparison Screenshots: new config property diffImageColorRgbaHex to customize the highlight color.
• #604 - Background Calculation of Comparisons: to not block builds from being imported while a comparison is computed.
• #597 - Store diff information directly inside build: the comparisons are now stored inside the build directory, such that the comparisons get automatically cleaned up when deleting a build. Breaking change, see Migration Guide.
• #602 - Removed Dependency to GraphicsMagick: GraphicsMagick needs not to be installed anymore to use the DiffViewer feature.
• #618 - New Diff Viewer Internal Diff Screen Format The comparisons need less disk space because only a difference image per screenshot is stored. Needs reimport of builds to see comparisons again, see Migration Guide.
• #577 - Avoid Null Pointer Exceptions: do not log null pointer exceptions when there is just no step to compare to.

Feature "Configuration"

• The data directory can not be configured through the config UI anymore (for security reasons)
• The data directory can now be configured through an environment variable or in the context.xml file of the web server (or just by directory mapping on the docker container, similar to before).
• The configuration file of Scenarioo is now stored in the data directory. Make sure you move your old config.xml file to the data directory.
• See Migration Guide for more detailed explanations.

Features "Small Improvements & Fixes"

Further small improvements and bug fixes:

• #601 - Branch Selection Order: new configuration property branchSelectionListOrder to configure order of branches in the branch selection list.
• #630 - Hide Screen Annotation Button if there are no Annotations: bugfix to hide the button if there are no annotations to display.
• #628 - Improve logging format (log4j.properties) to be less verbose.
• #651 - Generic Request Logging for all REST calls to the backend.

Breaking Changes and Backwards Compatibility

• Changed configuration of data directory location: you need to setup your data location and the configuration file as explained in the Migration Guide. This can not be configured through the frontend anymore.

• Internal format of comparisons between builds (DiffViewer feature) has changed: after an update to the new version you will see no calculated comparisons on old builds anymore and need to reimport those builds for which you want to calculate and see comparisons again. See step 3 in Migration Guide.

• Full Text Search needs Elasticsearch Version 5: we upgraded the full text search feature to use Elasticsearch 5.6.9. If you want to use that feature your have to configure a compatible Elasticsearch server and a cluster name as described in Full Text Search Setup Guide

• Some undocumented REST endpoints for the frontend have slightly changed: in case you used these services you have to adjust the usage:

  • /builds/reimportBuild/{branchName}/{buildName} is now /builds/:branchName/:buildName/import

Apart from that there are no breaking changes.

The Java Writer Library in use is still version 2.1 which is still compatible with Java 6 and upwards. Also the internal format version is not increased (still 2.1) so that your existing documentation data does not even have to be reimported after the upgrade and will continue to work with the new version (except for the comparisons).

Fixed Issues

All issues fixed in this release: List of Fixed Issues.

Known Issues

Please visit our List of Known Issues on GitHub.

Feedback and Support

Don't hesitate to open new issues if you find a bug or problem, or have feedback or questions: https://github.com/scenarioo/scenarioo/issues/new?labels=feedback

Version 3.0.0 and Earlier

See https://github.com/scenarioo/scenarioo/releases