Skip to content

Commit 65fcf67

Browse files
committed
Add QA scope
Document what is currently covered and what is not. Signed-off-by: Fon E. Noel NFEBE <[email protected]>
1 parent 5c48488 commit 65fcf67

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,24 @@ protocol.
1010
For more context, see [this
1111
discussion](https://chat.opentechstrategies.com/#narrow/stream/73-Permanent/topic/QA/near/155527).
1212

13+
## Testing scope
14+
15+
The scope of testing here verifies the possibility of correctly uploading and downloading
16+
a finite set of file types in a particular size range to [Permanent.org](Permanent.org) using [rclone](https://rclone.org/)
17+
which talks to permanent using the [SFTP service](https://github.com/PermanentOrg/sftp-service)
18+
19+
### What file types and scenarios are covered?
20+
21+
- Text and png images with obscure names generated via [generate-tree.py](generate-tree.py)
22+
- Images in `.jpg` and `.png` format downloaded from [APOD](https://apod.nasa.gov/apod) via [apod-downloader.py](apod-downloader.py)
23+
- Compressed files in `.zip` and `.tar`
24+
- Videos in `.mp4`, `.webm`, `.gifs` and `.3gp` common in mobile devices.
25+
- Executable files in `.exe`, `.run`, `.sh`, `.dep` and extension-less bin executables.
26+
27+
### What file types and scenarios are left out?
28+
29+
Anything not included in the section above describing what is currently covered is by implication excluded from these tests.
30+
1331
## Usage
1432

1533
You would have to install the python requirements used in this repo.

0 commit comments

Comments
 (0)