Skip to content

Commit

Permalink
Additional documentation of system tests - global variables, method d…
Browse files Browse the repository at this point in the history
…escriptions.

In particular, try to give more context to various subdirectory names.

Remove additional outdated python2/3 text from test/README.md, and add an example
for how to run an individual system test.

No-op.
  • Loading branch information
johnpaulalex committed Jan 11, 2023
1 parent 45b7c01 commit 3223f49
Show file tree
Hide file tree
Showing 2 changed files with 315 additions and 298 deletions.
22 changes: 6 additions & 16 deletions test/README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,5 @@
# Testing for checkout_externals

NOTE: Python2 is the supported runtime environment. Python3 compatibility is
in progress, complicated by the different proposed input methods
(yaml, xml, cfg/ini, json) and their different handling of strings
(unicode vs byte) in python2. Full python3 compatibility will be
possible once the number of possible input formats has been narrowed.

## Setup development environment

Development environments should be setup for python2 and python3:

```SH
cd checkout_externals/test
make python=python2 env
make python=python3 env
```

## Unit tests

```SH
Expand All @@ -30,6 +14,12 @@ Development environments should be setup for python2 and python3:
make stest
```

Example to run a single test:
```SH
cd checkout_externals
python -m unittest test.test_sys_checkout.TestSysCheckout.test_container_simple_required
```

## Static analysis

checkout_externals is difficult to test thoroughly because it relies
Expand Down
Loading

0 comments on commit 3223f49

Please sign in to comment.