Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shaal/umami-backstop
https://github.com/shaal/umami-backstop
Last synced: 13 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/shaal/umami-backstop
- Owner: shaal
- Created: 2019-04-08T15:10:19.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-12-15T14:42:05.000Z (11 months ago)
- Last Synced: 2024-05-22T21:26:31.131Z (6 months ago)
- Language: JavaScript
- Size: 191 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
A comprehensive suite of [BackstopJS](https://github.com/garris/BackstopJS) scenarios to automate visual regression testing on CiviCRM
:warning: Please note that currently the suite works only on Drupal-based CiviCRM sites. Wordpress and/or Joomla sites are not supported yet
# Requirements
A CiviCRM site with sample data (check the "Load sample data" option when running the installer)
### Technical
* [Node.js](https://nodejs.org/en/) v8.9.0
* [Drush](https://www.drush.org/) installed globally
### Data
* At least one Price Set added with at least one price set (/civicrm/admin/price/), with at least one price field (/civicrm/admin/price/field)
* At least one Batch Data Entry Set with type 'Contribution' (/civicrm/batch/add?reset=1&action=add)
* On Contact search page (/civicrm/contact/search) , the first result should have a valid email address field
### Extensions
* The [uk.co.vedaconsulting.mosaico](https://github.com/veda-consulting/uk.co.vedaconsulting.mosaico) extension should not be enabled on the site. In case it is, either momentarily disable it or remove the *mailings_menu.json* scenarios group
* Enable `CiviCase` component (admin/setting/component?reset=1) which is the part of core vanilla civicrm. The test suite contains screens for civicase component
### Drupal
* [Clean URLs](https://www.drupal.org/docs/7/configuring-clean-urls/enable-clean-urls) enabled
* The user name for admin should be `admin`
# How to use it
1. Create a `backstop_data/site-config.json` file with the following content.
```json
{
"url": "your_local_url",
"root": "absolute_path_to_site"
}
```
2. Create the reference screenshots
```shell
npx gulp backstopjs:reference
```
3. Create the test screenshots and compare
```shell
npx gulp backstopjs:test
```
## Testing a single group
In case you want to run backstop only for the scenarios of a specific group (ie. `administer-menu.json`), pass the `--group` argument to the gulp task (without the `.json` extension)
```shell
npx gulp backstopjs:test --group administer-menu
```
## Parallel capturing
BackstopJS supports taking multiple screenshot at once. Change the value of `asyncCaptureLimit` in _backstop.tpl.json_ to decide how many screenshots you want to take in parallel
***Note**:Please be aware that BackstopJS performance is heavily dependent on the specs of the machine it runs on, so make sure to choose a value that the tool can handle on your machine (otherwise you will encounter random timeout errors)*
## Cookies
This backstop test suite relies on session cookies to be present in the `backstop_data/cookies/admin.json`file. The file is automatically generated by the `gulp` task by using the [`drush uli`](https://drushcommands.com/drush-7x/user/user-login/) command.
If you want to skip the cookie creation phase (in case the cookies are already present in the folder and are not expired yet), pass a `--skipCookies` argument to the task
```shell
npx gulp backstopjs:reference --skipCookies
```
# Covered pages
## Search menu
- [x] Find Contacts
- [x] Advanced search
- [x] Standard search results
- [x] Advanced search results
- [x] Full-text Search
- [x] Full-text Search results
- [x] Search Builder
- [x] Find Contributions
- [x] Find Mailings
- [x] Find Membership
- [x] Find Participants
- [x] Find Participants results
- [x] Find Pledges
- [x] Find Activities
- [x] Custom Searches
## Contacts menu
- [x] New Individual
- [x] New Household
- [x] New Organization
- [x] Contact Reports
- [x] New Activity
- [x] New Email
- [x] Import Contacts
- [ ] Import Activities
- [x] New Group
- [x] Manage Groups
- [x] New Tag
- [x] Manage Tags (Categories)
- [x] Find and Merge Duplicate Contacts
## Contributions menu
- [x] Dashboard
- [x] New Contribution
- [x] Find Contribution
- [x] Contribution Reports
- [x] Import Contributions
- [x] Pledges - Dashboard
- [x] Pledges - New Pledges
- [x] Pledges - Find Pledges
- [x] Pledges - Pledges Reports
- [x] Pledges - New Pledge Report
- [x] Batch Data Entry
- [x] New Batch Data Entry
- [x] Accouting Batch - New Batch
- [x] Accouting Batch - Open Batches
- [x] Accouting Batch - Closed Batches
- [x] Accouting Batch - Exported Batches
- [x] New Contribution Page
- [x] Manage Contribution Pages
- [x] Personal Campaign Pages
- [x] Premiums (Thank-you Gifts)
- [x] New Price Set
- [x] Manage Price Set
- [x] Close Accounting Period
## Events menu
- [x] Dashboard
- [x] Register Event Participant
- [x] Find Participants
- [x] Event Reports
- [x] Import Participants
- [x] New Event
- [x] Manage Events
## Mailings menu
- [x] New Mailings
- [x] Draft and Unscheduled Mailings
- [x] Scheduled and Sent Mailings
- [x] Archived Mailings
- [x] Mailing Reports
- [x] Headers, Footers, and Automated Messages
- [x] Headers, Footers, and Automated Messages - Add Mailing Component
- [x] Message Templates
- [x] From Email Addresses
- [ ] New SMS
- [x] Find Mass SMS
- [x] New A/B Test
- [x] Manage A/B Tests
## Memberships menu
- [x] Dashboard
- [x] New Membership
- [x] Find Memberships
- [x] Membership Reports
- [x] Batch Data Entry
- [x] Import Memberships
## Administer menu
### Administration Console
- [x] System Status
- [x] Configuration Checklist
### Customize Data and Screens
- [x] Custom Fields
- [x] New Custom Field
- [x] Profiles
- [x] Name and Address - CiviCRM Profile Fields
- [x] Tags
- [x] Activity Types
- [x] Relationship Types
- [x] Contact Types
- [x] Dropdown Options
- [x] Gender Options
- [x] Individual contact prefixes Options
- [x] Individual contact suffixes Options
- [x] Instant Messenger (IM) screen-names Options
- [x] Location Types (Home, Work...)
- [x] Mobile Phone Providers Options
- [x] Phone Type Options
- [x] Website Type Options
- [x] Display Preferences
- [x] Search Preferences
- [x] Date Preferences
- [x] Navigation Preferences
- [x] World Replacements
- [x] Manage Custom Searches
### Communications
- [x] Organization Address and Contact Info
- [x] Message Templates
- [x] New Message Template
- [x] Schedule Reminders
- [x] Preferred Communication Methods
- [x] Label Formats
- [x] Print Page (PDF) Formats
- [x] Communication Style Options
- [x] Email Greeting Type Options
- [x] Postal Greeting Type Options
- [x] Addressee Type Options
### Localization
- [x] Settings
- [x] Addresses
- [x] Date
- [x] Languages Options
### Users and Permissions
- [x] Access Control
- [x] Synchronize Users to Contacts
### System Settings
- [x] Enable Components
- [x] Connections
- [x] Extensions
- [x] Cleanup Caches and Update Paths
- [x] Debugging and Error Handling
- [x] Upload Directories
- [x] Import/Export Mappings
- [x] Mapping and Geocoding Providers
- [x] Misc
- [x] Option Groups
- [x] Payment Processor
- [x] Resource URLs
- [x] Safe File Extension Options
- [x] Scheduled Jobs
- [x] SMS Provider
### CiviReport
- [x] All Reports
- [x] Create New Report from Template
- [x] Manage Templates
- [x] Register Report
### CiviMember
- [x] Membership Types
- [x] Membership Status Rules
- [x] Component Settings
### CiviCampaign
- [ ] Survey Types
- [ ] Campaign Types
- [ ] Campaign Status
- [ ] Engagement Index
- [ ] CiviCampaign Component Settings
### CiviContribute
- [x] Financial Types
- [x] Financial Accounts
- [x] Payment Methods Options
- [x] Accepted Credit Cards Options
- [x] Soft Credit Types Options
- [x] Payment Processor
- [x] Payment Processor
### CiviEvent
- [x] Event Templates
- [x] Event Type Options
- [x] Participant Status
- [x] Participant Role Options
- [x] Participant Listing Options
- [x] Event Name Badge Layouts
- [x] New Event Name Badge Layout
- [x] CiviEvent Component Settings
### CiviMail
- [x] Mail Accounts
- [x] CiviMail Settings
- [x] CiviMail Component Settings