Test document

Outlines a rough set of tests and therefore an intended scope of "support".

README.md

@@ -108,10 +108,11 @@ It supports any
 
 ### Developing
 
-* [Development](docs/90-development.md)
-* [Localisation](docs/91-localisation.md)
-* [References](docs/92-references.md)
-* [QNAP](docs/93-qnap.md)
+* [Development](docs/50-development.md)
+* [Localisation](docs/51-localisation.md)
+* [Testing](docs/60-testing.md)
+* [References](docs/90-references.md)
+* [QNAP](docs/91-qnap.md)
 
 ## Running scanservjs
 

_config.yml

@@ -27,8 +27,9 @@ description: |-
 
   <h3>Developing</h3>
   <ol>
-    <li><a href="/scanservjs/docs/90-development.html">Development</a></li>
-    <li><a href="/scanservjs/docs/91-localisation.html">Localisation</a></li>
-    <li><a href="/scanservjs/docs/92-references.html">References</a></li>
-    <li><a href="/scanservjs/docs/93-qnap.html">QNAP</a></li>
+    <li><a href="/scanservjs/docs/50-development.html">Development</a></li>
+    <li><a href="/scanservjs/docs/51-localisation.html">Localisation</a></li>
+    <li><a href="/scanservjs/docs/60-testing.html">Testing</a></li>
+    <li><a href="/scanservjs/docs/90-references.html">References</a></li>
+    <li><a href="/scanservjs/docs/91-qnap.html">QNAP</a></li>
   </ol>

docs/91-localisation.md → docs/51-localisation.md

@@ -13,7 +13,7 @@ ready for localisation) and localisation (l10n, implementing specific locales).
 * Copy an existing locale, name it according to the iso 639 and sub region; see
   [w3c](https://www.w3.org/International/articles/language-tags/)
 * Update the translations
-* If possible, test it works (see [development](./90-development.md))
+* If possible, test it works (see [development](./50-development.md))
 * Raise a PR or attach it to a new issue or #154
 * Add the locale name to the fallback locale
   [en](../app-ui/src/locales/en.json) under the "locales" key.
@@ -31,6 +31,6 @@ Either an existing translation could be improved or is missing altogether.
 
 ## Finding missing translations
 
-* Configure [development](./90-development.md)
+* Configure [development](./50-development.md)
 * Run `npm run util:missing-translations`
 * This will output JSON with all the missing keys

docs/60-testing.md

@@ -0,0 +1,74 @@
+# Testing
+
+## Summary
+
+Where possible there are automated unit tests. These are built into the build
+pipeline and can be run independently with `npm run test`.
+
+However, this app needs to run in all combinations of the following:
+
+### Architectures:
+
+* AMD64
+* ARM
+
+### Operating systems:
+
+* Debian 10 Buster
+* Debian 11 Bullseye
+* Debian 12 Bookworm
+* Arch
+
+### Node versions
+
+* 10+
+
+### Browsers
+
+* Not Internet Explorer
+
+### Mode
+
+* Container
+* Native
+  * Installing DEB over legacy
+  * Upgrading DEB
+
+Where possible, the app has been designed to minimise the differences with all
+permuations.
+
+* Docker builds a deb file and installs that
+* Docker uses Debian 12 and Node 18
+* There are no known architecture differences
+
+Nonetheless there is a lot to cover.
+
+## Test plan
+
+Depending on the scope of change any of the following may be required. For a
+major release, all tests should be run. For a minor one, the scope can be
+reduced.
+
+### Application testing
+
+* Find scanners
+* Test config overrides
+* Preview
+* Filters
+* Any changed pipelines
+* Scan
+* Settings
+* About and system info
+
+### Docker
+
+* Build the image
+* Run the container
+* Verify find scanners and system info
+
+### DEB
+
+* Verify install, remove
+* Verify install, update
+* Verify purge
+* Run on Buster, Bullseye, Bookworm, RaspberryPi OS