Document manual UI testing best practices#5357
Conversation
StephDriver
left a comment
StephDriver
left a comment
There was a problem hiding this comment.
this looks like a good starting point - and I'm suspecting it is a starting point for this PR (no issue to tell me what the aim is here).
I have added a handful of direct comments. Overall, good - sure, let's start here.
If you are looking to add more now, I think the it might be worth mentioning the build_assets and how to set the domain as those are the two I use most often when UI testing. So easy to forget to build the assets - and so wonder why your change didn't work or to end up with every attempt to reach a page redirecting to example.org if the domain isn't set - especially if you open in a different port to normal to say compare the UI on master alongside your branch.
| ## Testing on a phone or other device at home | ||
|
|
||
| When you are on secure local network, you can run the Janeway local server in such a way that you can test it on other devices. | ||
|
|
There was a problem hiding this comment.
I think this section might need subsections for different OS or something very clear that these are linux instructions. For example, when working on macOS, I can use the machine name http://keeper-of-keys.local as a substitute for "localhost" instead of having to find the IP or set a domain alias. e.g. http://keeper-of-keys.local:8000/olh/article/id/10801/?theme=clean I still have to use the additional argument on running the server, as here, but the rest no.
There was a problem hiding this comment.
see also devops - screen-reader testing which is basic notes on how I set up on mac for screenreader testing on iphone. Key point there was that you need to turn off the debug tool bar or it interferes with any (and all) a11y tests as it's not very accessible and covers other content.
|
|
||
| When you are on secure local network, you can run the Janeway local server in such a way that you can test it on other devices. | ||
|
|
||
| 1. Run your development server with an additional argument to specify an IP of four zeroes, and the same port as normal: `python src/manage.py 0.0.0.0:8000`. |
There was a problem hiding this comment.
python src/manage.py 0.0.0.0:8000 -> python src/manage.py runserver 0.0.0.0:8000
| Caveats: | ||
|
|
||
| - This only works when `DEBUG` is turned on. | ||
| - The Hourglass press theme (used by the Open Library of Humanities) does not support this feature. |
There was a problem hiding this comment.
This also affects the new A11y mode - currently we cannot use the?theme= when testing anything with a11y mode as it interferes with how that swaps. I'm not sure if this is a temporary until clarity is merged here.
| You can use Firefox container tabs to switch quickly between roles. | ||
|
|
||
| ## Testing on a phone or other device at home | ||
|
|
There was a problem hiding this comment.
Maybe a line about how janeway has different wide and narrow screen layouts so testing needs to cover different widths of window. But somehow distinguish this from implying narrow = test on mobile.
4 participants
No description provided.