req_spec_demo - metrumresearchgroup/pkgr GitHub Wiki
The purpose of this document is to define the requirements for pkgr and document which tests have been created to ensure that individual requirements are met.
179: Pkgr will attempt to minimize duplicate work, such as redownloading, re-compiling, or re-installing packages that have been used in previous actions
Product risk: medium
- Pkgr caches downloaded packages and stores them in a temp folder for faster future installations.
- Tests:
- cache-local, cache-system
- Tests:
- Pkgr maintains a cache of Package Databases (pkgdb) in a temp folder. Pkgdbs contain the information in the PACKAGES file for all repos listed in a pkgr.yml file. When pkgdbs are available in the cache, pkgr will not have to re-parse the PACKAGES file for those repos.
- Tests:
- cache-system
- Tests:
- Users should be able to specify where the cache is created. If users do not specify, the cache should use System temp folders.
- Tests:
- cache-local, cache-system
- Tests:
Test Tag | Test Location | File | Link Test | Link Result |
---|---|---|---|---|
cache-local | pkgr/integration_tests/simple-suggests | guide.md | Test | Results |
cache-system | pkgr/integration_tests/simple | guide.md | Test | Results |
If a test-tag appears in multiple tests, then that test-tag will have multiple entries in the table above, with each entry having it's own test-location. For example, if the "cache-local" tag was also found in the "repo-local" integration test, then the table would look like this:
Test Tag | Test Location | File | Link Test | Link Result |
---|---|---|---|---|
cache-local | pkgr/integration_tests/simple-suggests | guide.md | Test | Results |
cache-local | pkgr/integration_tests/repo-local | guide.md | Test | Results |
cache-system | pkgr/integration_tests/simple | guide.md | Test | Results |
- How to fit automated tests into this table.
- Possibly just need to point to automated test using
Test Location
andFile
, then instead of linking to aguide.yml
, we just give the name of the automated test inLink Test
and point to the overall automated test-results inLink Result
- Possibly just need to point to automated test using