reporting

Enhancements

• Logs were unavailable after the elasticsearch container restart (#2206)
• Made "admin/changeit" the default reporting user (#2193)
• Implemented the backup/restore for persistant content (#2192)
• Moved all hard-coded variables from docker-compose.yml (#2191)
• Simplified the "setup" process for reporting (#2190)
• Adjusted ZafiraListener to be displayed before the suite/class/method real-time items (#1707)
• Created a new TestRun monitor view (#966)
• [Reporting Agent] Allowed to override test run names via properties

Fixes

• Unable to start zebrunner-proxy without minio (#2205)
• SELENIUM integration was red in Reporting Service after configuration (#2204)
• 1.7: unable to register repository vs new instance due to the "User with id 2 doesn’t exist" (#2180)
• 1.8 single tenant: runtime test statuses were not displayed

Housekeeping activities

• Moved s3 compatible mino service into an independent repository (#2186)

Migration steps (1.8 -> 1.9)

• As long as DATABASE_STATE_MANAGEMENT_ENABLED is enabled (set to true), reporting-service container will handle the execution of required patch sets automatically.

Enhancements

• Views: made a CI job link optional for all embedded views (#2184)
• Improved UI/UX for modal windows

Fixes

• Dashboards sent by email had a wrong naming convention (#2172)

Migration steps (1.7 -> 1.8)

• As long as DATABASE_STATE_MANAGEMENT_ENABLED is enabled (set to true), reporting-service container will handle the execution of required patch sets automatically.

Enhancements

• Authentication and user identity APIs are redesigned and moved to separate microservice
• Multi-selected test results now have the same color as the hover state

Fixes

• 1.3+: bad request was detected while opening notification service integration with Slack
• Test owner name was displayed with a capital letter
• Fixed incorrect data for the saved configuration in the mobile version
• Wrong number of users was displayed on pages
• Zebrunner TestNG agent did not work with clean Zebrunner installation

Migration steps (1.6 -> 1.7)

• As long as DATABASE_STATE_MANAGEMENT_ENABLED is enabled (set to true), reporting-service container will handle the execution of required patch sets automatically.

Enhancements

• User fields were removed from views and widgets
• Mail configuration now has to be provided as part of the initial Zebrunner configuration via environment variables
• Logic related to mail notifications moved to brand new Mail microservice
• Zebrunner no longer uses local file system and relies on S3 compatible storage. By default Zebrunner distribution comes bunled with MinIO storage service, however it can be disabled and used with S3 compatible storage of your choice (e.g. AWS S3, GCP CloudStorage, etc)
• Email HTML templates are now loaded from external storage and not managed by services meaning that those can be altered without requiring service build from sources

Fixes

• Test logs were not displayed for In-progress tests after switching between the test case execution history
• 1.3+: integrations could not be activated if any execution provider was unavailable
• Fixed duplicated logs
• Live video test artifacts are now ignored for already finished tests
• Only one of the tests with similar names was shown on the Results page (#2118)
• Widgets: The list of values was frozen on the page after selecting a value from the drop-down (#2159)
• UI refactoring: test logs controller and ElasticSearch service refactored

Dependency Upgrades

• Spring Boot updated to 2.3.1.RELEASE

Migration steps (1.5 -> 1.6)

• Regenerate system views executing database/sql/db-views.sql
• Apply widget templates patch executing database/alter/management/018_pg-alter-23-06-2020.txt
• As long as DATABASE_STATE_MANAGEMENT_ENABLED is enabled (set to true), reporting-service container will handle the execution of required patch sets automatically.

Enhancements

• Added functionality for the test search
• Modified users and invitations tables
• Adjusted the ticket submitting template (#2124)

Fixes

• Fixed Rerun failed tests function (#2131)
• Fixed mobile test view shift
• Test case execution history status is now updated after executing a test

Dependency Upgrades

• N/A

Migration steps (1.4 -> 1.5)

• As long as DATABASE_STATE_MANAGEMENT_ENABLED is enabled (set to true), reporting-service container will handle the execution of required patch sets automatically.
• Deprecation notice: zafira-ws context path (deprecated in v1.2) won't be available anymore.

Enhancements

• Test view now comes with historical trend allowing to get better idea of test case stability
• Deleted all icons in a contextual menu for Dashboards, Test runs, Tests, Users, User groups and Invitations

Fixes

• Unified a hover for mark as passed/failed buttons
• UI: collapse VNC session button was almost invisible under Zendesk Help
• Added a clickable zone outside the text for test run results
• Removed unneeded buttons for local test runs from the right menu
• "No video available" do not appear for in-progress tests anymore
• Modified batch actions for test run results

Dependency Upgrades

• Upgrade to Spring Boot 2.3.0.RELEASE
• Base docker image switched to AdoptOpenJdk 11

Migration steps (1.3 -> 1.4)

• As long as DATABASE_STATE_MANAGEMENT_ENABLED is enabled (set to true), reporting-service container will handle the execution of required patch sets automatically.
• Deprecation notice: zafira-ws context path is deprecated since 1.1 in favor of reporting-service. For now, it will be automatically redirected according to the latest changes. Please be aware that support for this path will be dropped in 1.5 release.
• Reporting Service container serves content under root path by default

Enhancements

• Launchers now support app upload functionality
• Optimized email reports for desktop and mobile versions
• Optimized web layout for Zendesk Help button
• Zebrunner engine: bumped up to the latest Chrome and Firefox

Fixes

• Log messages were displayed twice and more
• Drop-down lists had different select states in the launcher
• Long name overlapped with the text "Name" in the launcher
• Title and numbers were cut off in the emails

Migration steps (1.2 -> 1.3)

• As long as DATABASE_STATE_MANAGEMENT_ENABLED is enabled (set to true), reporting-service container will handle the execution of required patch sets automatically.
• Deprecation notice: zafira-ws context path is deprecated since 1.1 in favor of reporting-service. For now, it will be automatically redirected according to the latest changes. Please be aware that support for this path will be dropped in 1.5 release.

Enhancements

• Included information on a test run locale/language into existing/custom templates (#2109)
• Developed UI/UX for managing integrations and system settings
• Test launcher: add repo now sorts repositories alphabetically
• Added an icon for BrowserStack mobile web tests
• Users now see a message from scanner if the repository scan is not working
• Confluence guide on single host dev setup was created
• Integration with Microsoft Teams and currently allows notifications to be sent to one channel

Fixes

• Text was shifted on the delete test run button (#2115)
• Select all tests did not work for grouped tests (#2114)
• Test log is not clickable now. A user is able to copy it (#2113)
• Fixed the password validation process (#2093)
• Jenkins link was active in Slack channel/HTML file (#2069)
• Fixed the Users list problem with log emails
• When storage provider is disabled, Zafira client did not register a screenshot as an artifact
• 4.1.90 regression: links to the Jenkins jobs were lost
• Known issues were not linked to the tests with the same stack trace
• Test run search did not work with the 'locale' parameter

Migration steps (1.1 -> 1.2)

• It is recommended to restart Redis container after deployment of new Zebrunner version in order to evict cache (or flush it using Redis CLI from inside the container)
• As long as DATABASE_STATE_MANAGEMENT_ENABLED is enabled (set to true), reporting-service container will handle the execution of required patch sets automatically.
• Deprecation notice: zafira-ws context path is deprecated since 1.1 in favor of reporting-service. For now, it will be automatically redirected according to the latest changes. Please be aware that support for this path will be dropped in 1.5 release.

Enhancements

• Single host deployment with Docker Compose now only requires 2 ports to be opened in order for Zebrunner to become fully functional
• Bulk operations are available for Tests: now multiple Tests can be selected and marked as failed/passed
• On Test info page are added filter by log level and ability to mark test as failed/passed
• Launchers can be marked as 'favorite' and then displayed at the top of the launchers list
• Filtered test runs can now be multi-selected
• Locale is displayed on Test runs and available as a filtering criteria
• Artifacts now can be attached to Test runs as well as to Tests
• Added an icon for Electron browsers
• Added a transient effect when switching from Test runs to Test sessions

Fixes

• App version was absent in a TestRail run name (#2099)
• Profile photo disappeared after reloading a page (#2072)
• It is possible to modify an already applied filter on a test run
• Added the possibility to "Mark as reviewed" failed/aborted test runs without a comment
• Fixed regression after which hidden boards were not available for regular users

Dependency updates

• Spring Boot was updated to 2.2.6 (#2006)
• Gradle was updated to 6.3 (#2005)

Migration steps (1.0 -> 1.1)

• It is recommended to restart Redis container after deployment of new Zebrunner version in order to evict cache (or flush it using Redis CLI from inside the container)
• As long as DATABASE_STATE_MANAGEMENT_ENABLED is enabled (set to true), reporting-service container will handle the execution of required patch sets automatically.
• Deprecation notice: zafira-ws context path is deprecated since 1.1 in favor of reporting-service. For now it will be automatically redirected according to the latest changes. Please be aware that support for this path will be dropped in 1.5 release.

Enhancements

• A unique icon for mobile web automation tests was added (#2047)
• From now, on the very first login users can select one of the two screen modes: Integration via agent or Selenium Hub. If a user goes away without making a selection, integration via agent (Test runs view) is enabled by default
• Application error pages were modified and unified (e.g. handling of non-existing app routes)

Fixes

• Text was shifted on the first login in Safari (#2095)
• Blockers icon was not displayed near the test run name after linking a blocker issue (#2062)
• A list of dashboards was not updated after a relogin (#2050)
• "Create test run controller" had duplicated "project" and "Project" headers
• Screenshots exported to the ZIP format from Visuals were absent
• Test info page was updated, it now provides a valid browser name
• A user-friendly alert message is now displayed when trying to create a widget with the same name
• Stored filters are not scrollable now in vertical for mobile

Migration steps (4.1.90 -> 1.0)

• As long as DATABASE_STATE_MANAGEMENT_ENABLED is enabled (set to true), reporting-service container will handle the execution of required patch sets automatically.

Enhancements

• It is now possible to see Reporting Service version without logging out (#2011)
• It is now possible to enable/disable Reporting Service debug conditionally
• User is now able to re-generate an access key for Zebrunner Hub
• User context is now invalidated after a user logout
• Application login page brute-force protection was implemented
• Pattern validation for first/last name was added
• Only images can now be uploaded for user profile and company picture
• SQL injection protection on dashboards was implemented
• Test run email/export template was refactored
• Duplicated values in TestRun and TestConfig were removed
• UI/UX for saving cron launchers was developed
• UI/UX for viewing a cron launcher along with a webhook URL was developed
• UI/UX for cron modification was developed

Fixes

• "Link issue" option is now present for all failed bugs (#2070)
• "Mark as reviewed" button was shifted when a window had a scroll bar (#2068)
• Issue with different designs for search on Test runs and Test sessions pages was fixed (#2048)
• There were 2 tutorials tooltips in the bottom of the page (#2044)
• User is now unable to enter a negative number in the "thread_count" field (#2036)
• Chart tooltip was changed on the Billing page
• Test session logs view was modified
• New mobile browser detection logic in Reporting Service was added
• Platform was not displayed on the Test logs page
• Play icon was not highlighted when the Test results page was opened

Migration steps (4.1.89 -> 4.1.90)

• As long as DATABASE_STATE_MANAGEMENT_ENABLED is enabled (set to true), reporting-service container will handle the execution of required patch sets automatically.

Enhancements

• Widget templates redesigned (v. 1.1)
• Added PASS RATE (CALENDAR) widget
  
• Widget template now has the default sizing
• API endpoint for switching default tests/sessions view preference has been created
• UI for switching between tests/sessions view has been developed
• Routing now takes into account tests/sessions view preference

Fixes

• Reports were not sent to emails (#2033)
• Get all launchers (or get launcher by Id) received a response without launcher presets (#2030)
• Impossible to configure Jenkins in Zafira started from scratch was fixed (#2019)
• When retrieving test work items with a non-existent testId, status code 404 was not returned (#2000)
• When deleting a test with a non-existent testId, status code 404 was not returned (#1998)
• Endpoints with ID's placeholder in Swagger UI did not work (launcher-controller, test-run-controller, test-controller) (#1994)
• Duplicated emailList in build was removed (#1990)
• If test was invoked in local and stopped in between, it still showed in progress on Zafira test runs (#1980)
• Invalid Jira URL in all widgets was fixed
• UI was adjusted for handling correct platform values
• Spring MVC warning "PageNotFound" was fixed
• Repository name now allows entering only: characters [a-zA-Z], digits [0-9], underscore, dash and dot (_, -, .)
• 4.1.64 client: it is now impossible to generate a test run with an invalid project
• Landing UI now displays a validation error message on company creation
• User (Admin) is not able to see added hidden dashboards in Zafira by default
• Execution and utilization trend metrics were detalized: Execution trend (amount of tests), Utilization trend (duration in sec)
• Correct platform/browser version values are now passed to backend

Migration steps (4.1.86 -> 4.1.89)

• As long as DATABASE_STATE_MANAGEMENT_ENABLED is enabled (set to true), Zafira container will handle the execution of required patch sets automatically.
• Deploy manually the latest widget templates and recreate views running one-by-one using pgAdmin vs Zafira database
  • alter/management/014_pg-alter-17-02-2020.txt
  • alter/management/015_pg-alter-18-02-2020.txt
  • alter/management/016_pg-alter-21-02-2020.txt
  • alter/management/017_pg-alter-26-02-2020.txt
  • database/sql/db-views.sql

Enhancements

• Enabled integrations are now displayed first in the integration groups (#1973)
• Test sessions UI has been created

Fixes

• Group was created even if Zafira API returned a 500 error response (#2016)
• Incorrect response for Get group by Id (Users) was fixed (#2015)
• Test with an invalid link in artifacts was not displayed in a test run (#1993)
• Launcher window displayed wrong information after switching between repositories (#1991)
• Zafira API returned a 500 error response when attempting to create a test case (#1988)
• Repositories were not loaded in Test Launcher (#1977)
• Fab button didn't disappear while scrolling on mobile (#1976)
• Checkboxes disappeared from the test runs tab after selecting on mobile (#1972)
• The wrong number of recipients was displayed when sending the email (#1967)
• Launcher with preset can now be deleted (#1963)
• Link to Jenkins is clickable on mobile (#1962)

Housekeeping activities

• Gradle has been upgraded to 6.1 (#2006)
• Spring Boot has been upgraded to 2.2.4 (#2005)

Migration steps (4.1.82 -> 4.1.86)

• As long as DATABASE_STATE_MANAGEMENT_ENABLED is enabled (set to true), Zafira container will handle the execution of required patch sets automatically.

Enhancements

• Integrations: LambdaTest, MCloud, BrowserStack, SauceLabs and Aerokube are now supported as test environment providers.
• Reports: if the video player is disabled, it will no longer appear in the report (#1943).
• Test runs / tests: users are not able to "Mark as failed" a failed test (#1828).
• Users are not able to rerun only failures in a passed test run (#1827).
• Projects: it is now possible to delete a project (#1814).
• Now launchers support per-tenant custom providers configuration
• Launchers are capable to merge capabilities from template and provide predefined set of arguments
• Launcher providers configuration now supports textfield type - this is actual for mobile app path configuration
• Widget templates updated:
  • A new "MILESTONE DETAILS" widget template created which combines pie and line charts together (can be grouped by periods or parent job builds);
  • A new "TESTS FAILURES BY SUITE" widget template created which summarizes negative statistics for each suite test;
  • "Pass Rate %" - users are able to switch between absolute numbers and percents clicking on any bar;
  • Minor improvements in positioning and sizing for MacBook displays.

Fixes

• API docs: "Swagger UI runtime" issues are fixed (#1953).
• API: When attempting to retrieve a launcher by non-existing id, the proper API error is now returned (#1941).
• Repo scan: "When a non-existing branch specified, repo scan fails by timeout" is fixed (#1936).
• Widgets: "Widget placements are displayed incorrectly after editing widgets in the dashboard" is fixed (#1861).
• Widgets: "Not all platforms are displayed in the dropdown list while editing a widget" is fixed (#1856).
• Test runs / tests: "Date filter is not reset after clearing the Date field" is fixed (#1860).
• Test runs / tests: "Date filter disappears/is shifted" is fixed (#1859).
• Test runs / tests: "Issues can be cloned" is fixed (#1858).
• Test runs / tests: "Tests status filter button tooltip remains on the screen" is fixed (#1849).
• Test runs / tests: "Linked issues" issue is fixed.
• Test runs / tests: "Test run names are incorrect" is fixed (#1847).
• Test runs / tests: "Allow to mark tests as failed in skipped, aborted statuses" is fixed (#1934).
• Test runs / tests: "Disappearing actions after editing personal data" is fixed (#1911).
• Tech debt: "Zafira runtime logs claiming about Spring Data Redis repository configuration" is fixed (#1874).
• Tech debt: DB management data: all hardcoded id values have been removed (#1844).
• Tech debt: "Users without certain privileges can browse through pages that require administrative privileges" is fixed (#1783).
• Mobile: "Date filter isn't applied after changing on mobile" is fixed (#1865).

Housekeeping activities

• Gradle has been updated to 6.0.1 (#1885).
• Spring Boot has been updated to 2.2.2.RELEASE (#1933).
• Autovacuum for Zafira tables enabled.

Migration steps (4.1.79 -> 4.1.82)

• As long as DATABASE_STATE_MANAGEMENT_ENABLED is enabled (set to true), Zafira container will handle the execution of required patch sets automatically.

Enhancements

• Integrations: SMTP connectivity test flow was improved - it will now take less time do determine if integration is available or not
• Refactoring: Core Zafira services (TestService, TestRunService were refactored)
• Refactoring: Zafira web-layer was refactored

Fixes

• Work item detection by jira id issue was fixed (#1837)
• Incorrect behavior of "Blocker" checkbox in assign issue window (#1833)
• User profile UI warnings for first name and last name fixed (#1832)
• When test run is shared via email it was possible to add multiple duplicated emails (#1821)
• Invalid port entered for email integration was leading to broken integrations page (#1829)
• Known issues detection after new run was not working properly (#1807)
• State of found test runs was not correct after one of multiple filters was removed (#1815)
• Authentication exception handling was improved on Zafira back-end side

Noticeable tools/libraries updated

• Gradle has been updated to 6.0
• Spring Boot has been updated to 2.2.1.RELEASE
• MyBatis has been updated to 3.5.3

Migration steps (4.1.76 -> 4.1.79)

• As long as DATABASE_STATE_MANAGEMENT_ENABLED is enabled (set to true) Zafira container will handle execution of required patch sets automatically.

Enhancements

• Automatic database state management is now supported and powered by Liquibase, i.e. no need to manually patch the database starting from this release!
  Note: For 4.1.69, all alter scripts should be applied manually from alter till/to:
  • 126_pg-alter-05-08-2019.txt
  • 004_pg-alter-30-06-2019.txt
    Note: the next release notes should contain steps on how to enable it.
• User invitation flow is slightly improved: when inviting a group of users, emails will be resolved once you're done typing those and click Space (Gmail-style)
• 'X' button is now gone from the filter when it is selected. A single-click (de-select) now resets the filter.
• Tooltips were added to Zafira menu (left sidebar) in order to improve UX
• Source code migrated to Java 11. JDK 11 is required to compile and build Zafira from sources.
• Lombok is used for POJOs to get rid of boilerplate code. Annotation processing should be enabled in your IDE, so it won't complain about the method references it can't resolve.
• Zafira now uses the latest Spring Boot version, greatly simplifying configuration and deployment. The application is now packaged into an executable JAR file and uses the embedded web-server.
• Zafira dependencies cleaned up reducing application footprint size, some 3rd party libraries removed and codebase switched to goodies brought as a part of features available out of the box in Java 9-11.
• Startup optimization tweaks resulted in faster startup time which is now reduced by roughly 40%.

Fixes

• Minor runtime errors were fixed

[MIGRATION STEPS FROM 4.0.67 TO 4.1.69]

Make sure you have applied manually all alter scripts till

• 126_pg-alter-05-08-2019.txt
• 004_pg-alter-30-06-2019.txt

Enhancements

• Integrations where heavily reworked and adjusted
  • Integrations are now organized into groups (forming a tree) vs plain list (flat structure)
  • Some groups (e.g. CI / Automation Servers) at the moment of writing support multiple integrations of the same type/kind - e.g. you can add multiple Jenkins instance; label them accordingly and execute test runs against specific Jenkins instance
  • All related operations (e.g. rerun) now keep context of specific integration they were executed against and all sequential actions will benefit from that knowledge
  • Multiple integrations of the same type can be renamed to better describe their purpose
• It is now possible to select number of items per page to be displayed at test results view.
• State of selected view mode, filter, sort options and page number is saved on navigation between test details and back.
• Grouping view mode with two displaying options was unfolded to the flat structure: view by class and view by package.
• It is now possible to download all test run artifacts at once as a single .zip archive. Artifacts will be distributed between folders in unpacked archive according to the test they belong to.
• Selenium and JIRA integration adapters were refactored and switched to Unirest HTTP client.
• Zafira exceptions now supply an internal error code allowing to better indicate what caused an API issue.

Fixes

• Integrations synchronization issues between multiple Zafira replicas fixed
• Test results page load time has been improved
• Once you go to test details in back - scrolling will take you back to the exact same spot in the list
• Build time for zafira-ui Docker image has been reduced

Noticeable tools/libraries updated

• Gradle has been updated to 5.6.3
• Spring Boot has been updated to 2.2.0.RELEASE

Migration steps (4.1.73 -> 4.1.76)

• Database state management should be enabled in order to automatically execute alter script against Zafira database. Make sure to pass DATABASE_STATE_MANAGEMENT_ENABLED=true to Zafira container.

Enhancements

• README updated with new deployment instructions
• Redis secured with a password
• GitHub token encryption added
• Image gallery performance (load time) improved
• Zafira exceptions re-organized, their total number reduced. More on this in future releases.
• Gradle has been updated to 5.6.2
• Spring Boot has been updated to 2.1.8.RELEASE

Fixes

• Video streaming issue fixed
• Tooltips removed from the main menu
• An issue with Zafira startup when database state management is enabled is fixed: the changelog file now declares an empty array of changesets, thus solving Liquibase complaints about an empty changelog file
• A use case when Jira issue cannot be found by its id is fixed: the flow is considered normal application behavior, logging was leveled to debug to make sure there is no longer a stack trace error by default
• A bunch of minor application runtime issues was fixed

[MIGRATION STEPS FROM 4.0.69 TO 4.1.73]

• You'll need to remove GitHub repo and manually add it again so that the token is encrypted; otherwise, Zafira will try to decrypt the existing token value, which will result in an error
• Redis needs to be re-deployed with password authentication - see an example of redis.conf here and mount it to /usr/local/etc/redis/redis.conf. You'll also need to pass theREDIS_PASSWORD env property to Zafira, so the application can connect to secured Redis
  Note: Redis container version should be updated to 5.0.5, the command should be overridden to apply the security config file

  redis:
    image: redis:5.0.5
    volumes:
     - ./config/redis.conf:/etc/redis/redis.conf
    command: ["redis-server", "/etc/redis/redis.conf"]
    ports:
     - 6379:6379
    restart: always

Enhancements

• Test run search filters can now be private
• Zafira invitation link is available for copying without sending an email - share directly with users to be invited through your favorite instant messenger
• Now you can store assets, such as the company/user logo in the local file system without enabling S3 integration if Zafira is deployed on the same host
• The irrelevant information is no longer included in the exported test run report, so it will be easier for you to navigate through it
• Emailable reports got slightly adjusted and corrected

Fixes

• Chinese was incorrectly displayed in Jenkins #1670
• Reset test run comments during the rerun #1685
• Unable to abort test run if CI is not configured #1667
• Unable to send dashboards/widgets from Zafira #1692

[MIGRATION STEPS FROM 4.0.65+ TO 4.0.67]

Execute SQL alters

• 125_pg-alter-24-07-2019.txt
• 126_pg-alter-05-08-2019.txt

Enhancements

• Spring configuration was fully migrated to Java.
• Zafira-client module was moved to a separate repository.
• Zafira has been migrated from Maven to Gradle build tool.
• Test runs started from launcher are now immediately displayed in UI.
• Enterprise GitHub repositories are supported for adding in launchers mode.
• New HTML test runs report has been introduced.

Fixes

• Unable to abort test run if CI is not configured #1667
• Chinese was incorrectly displayed in Jenkins #1670
• Unable to send dashboards/widgets from Zafira #1692
• Known issue is not displayed in test results #841

[MIGRATION STEPS FROM 4.0.62+ TO 4.0.65]

Execute SQL alters

• 124_pg-alter-26-07-2019.txt