As described before, testing is the process of ensuring that new code is working correctly before it gets added to the master code. If the new code isn't thoroughly tested, it's likely that little or large errors will get into the software and cause malfunctions and problems for users. The testers’ job is to prevent any bugs or errors from getting through.
Things you’ll need before you can test:
- A Github account and permission to access the Open Food Foundation repository (http://github.com/openfoodfoundation/openfoodnetwork).
- Install the Zenhub extension so you can view the pipe board in Github.
- Super Admin login details for the Staging Servers that you’ll be testing on.
- Permission to access the Global Google Drive, specifically the testing notes folder
- Advanced testers will need access to Semaphore so they can stage their own PRs without the assistance of a developer.
- You may wish to install the Loom plugin which lets you capture video screenshots. This is helpful in reporting any bugs/issues you see.
Get familiar with OFN For any new tester, a helpful first step to testing is to become familiar with the OFN software. This makes it much easier to spot things which are not quite right when you start testing. A good way to get familiarised is to setup a producer shop and a hub shop, using the instructions in the user guide, and also try using the advanced features. A tester who is familiar with all the functionalities of OFN will find testing much easier.
When developers finish creating a PR they'll put their new code into a staging server. This is a website that looks just like your local OFN website (what we call the Production Server), but it's full of fake data that you can play around with, without any repercussions. The staging server is where you do testing. To assist in your testing, it's good to have some enterprises setup on the staging server, so you can test the software while doing usual tasks that enterprises commonly do on the site.
OFN currently has 3 staging servers. You can generally only test one PR at a time on a Staging server, so we have a couple.
When a developer asks you to test something, they'll follow the following process:
- They will stage their new code on a Staging server (which one will depend on which one is available)
- They’ll move the PR into the Test Ready column in Zenhub
- They’ll put a comment on the PR saying which staging server the PR is staged on
- They’ll put a label on the PR showing which server the PR is staged on
- They’ll send you the link to the PR.
- They’ll assign you to the PR (or if the PR was available for anyone to test, when you claim the PR, assign yourself)
If you test regularly you can also ask to be added to the project on Semaphore in order to stage PRs yourself. This saves you waiting for a dev to do it for you and means you can do more than one in a day (without needing to wait for timezone delays with devs).
When the developer sends you a PR to test, you should see that the PR contains a description of 'what to test'. In this section developers should have detailed:
- A description of the desired new behaviour (you can also find it in the connected issue which also describes the desired change). This description will usually relate to a certain part of the website, or a certain flow of behaviour.
- A description of what the 'acceptability criteria' are (also in the connected issue)
- A description of any areas of the site that may have been inadvertently impacted by their work, and should therefore also be tested.
It's a tester's job to make sure that anything which should be changed/fixed is, and anything that shouldn't be changed isn't. It's also your task to spot any bugs or glitches that might be there.
Once you have this information, you can start experimenting with the software to check that it's behaving as intended and to check that all unrelated features are behaving as normal. Below are some tips to think about as you’re testing.
A good way to be methodical in testing is to break down the overall functionality into a checklist of smaller items to test. Spending the time thinking through all the little test cases gives you more confidence that you’ve checked all the right places and scenarios. There’s 3 ways to break down the testing, by place and by user type and by device. Note: When it comes to writing up your test notes (covered later in this doc) a checklist of small test items makes it easy to write clear and thorough test notes.
New features will often impact on multiple places, such as in the shopfront, admin interface, orders listing, reports and in the order confirmation emails. Think about how the changes to the code could have impacts 'downstream' and make a list of all the places you want to test. The developers should list all the places that could be impacted, but as a tester you might also think of somewhere else. As you get more familiar with the software it becomes easier to think of the different places that a change could flow on to.
What to test: The ‘About Us’ text field now includes bold, italics and underline formatting.
Places that might be impacted:
- Check that in the About Us area of Enterprise Settings you can see the new bold, underline and italics formatting options
- Check that if I write About Us text using bold/italics/underline that the formatting carries through to a) the profile b) the shop.
- Check that the formatting options are also available in the /register wizard, for someone who is writing their About Us text there.
- Check that pre-existing About Us text on profiles and shops looks the same and hasn’t been impacted
Some features only apply to certain users on the OFN, and others will impact all users. Think about whether the feature you're testing should impact on some or all users and test for all users. The user types are below: • Producer, selling None, profile only • Producer, selling Own • Producer, selling Any • Hub, selling None, profile only • Hub, selling Any • Customer • Super Admin users
For example: What to test: Super Admin users can now ‘toggle’ the subscription feature on and off in Enterprise Settings
Users to test:
- Check that as a Super Admin user you can see the subscription toggle in Enterprise Settings
- Check that as a regular user with access to Enterprise Settings you cannot see the subscription toggle. Check this for both an Enterprise who has subscriptions toggled on and off.
If the PR you are testing involves front end User Interface (what end customer sees on their screen) you should test on a mobile device and desktop to check if it looks ok. The code is supposed to be "responsive" so the visual website is supposed to adapt to the screen size of a mobile in a nice way.
For example: What to test: Category filters in shops should be condensed into a (+ 5 more) button if the shop has more than 3 categories.
- Test that the filters are displaying in a condensed format on desktop
- Test that the filters are displaying in a condensed format on a mobile
If you’re not totally sure how the system behaved before the PR, you can have a look at any of the production sites. If the PR is intended to fix a bug, you should see that the bug is still present on the production sites, but it should be fixed on Staging. If the PR is intended to add a new feature, you should see that on Production the feature isn’t present. By comparing the staging and production sites you can see what effect the PR is having.
Does the new code interact accurately with other features, like private shopfronts, multiple order cycles, inventory, E2Es and customer tags? Sometimes bugs can hide in unusual layers of features/settings, so try to test some complex shop setups.
If there's something about the new code that you find unpleasant (visually, the wording of text, navigation) or confusing, make a note. The scope of the PR might mean that the improvement can't be incorporated, but it's good to record it anyway.
Not sure how an existing feature is supposed to operate? There should be a description of how a feature is intended to work in the User Guide. If it's something more detailed, and it's not described in the user guide, the best way to get familiar with how OFN works is to play around. Sometimes no one else will know how a feature behaves in a certain scenario, so the only way to find out is to test different scenarios and see how the system behaves. That's the good thing about the staging servers - you can play around without impacting anything.
Sometimes browsers behave differently when reading the same code. As we don't have an extended dev team we can't test on all browsers type and versions, so as a minimum we recommend to regularly change browsers when you do testing. Switch between Chrome or Firefox for instance.
Depending on the staging server the PR were deployed on, the language you test in may vary. If it's not English, and translations are involved in the PR, you might see "translations missing" while testing. This is normal and you should ignore it as we can't translate new strings before the PR is merged. We recommend as much as possible to test in an English environment.
Sometimes you'll need to test some Instance settings, which are controlled by Super Admin logins. When you login as a Super Admin you can see all the settings for the instance- things that users can't see. There's a guide which describes the Super Admin Configuration settings here - https://ofn-user-guide.gitbook.io/ofn-super-admin-guide/
Before you report that you’ve found a bug in the PR, ask first whether the bug occurring on production? If it’s not occurring on production, the bug was likely caused by the PR. In this case you should just describe the bug in your testing notes. If the bug is occurring on production it wasn’t caused by this PR. In this case you should check whether the bug is already captured by an issue in github. If it’s not, create a new issue. When you go to create a new issue you’ll see there’s a template to fill in which is quite straightforward.
When creating an issue to report a bug, be sure to follow our bug severity system. This is necessary to perform a triage and adjust the time frame in which are addressed, allocating the necessary resources.
When testing you'll often find that you need more user accounts than you have email addresses. In this case you can user this little trick. OFN will see these two email addresses as different users, but all emails will go to the same inbox. [email protected] and [email protected] . By adding +testing or +demo or +sunshine etc after your normal email you can create more accounts (there's no limit). This lets you create additional user accounts in OFN without needing lots of inboxes. Warning: it will only work with google accounts.