Commit a2b60e73 authored by Valentin Reis's avatar Valentin Reis
Browse files

Readme update.

parent 712b1eda
Pipeline #4859 passed with stage
in 11 seconds
...@@ -15,7 +15,7 @@ nix-shell -E ' ...@@ -15,7 +15,7 @@ nix-shell -E '
#nrm-src = /path/to/nrm #nrm-src = /path/to/nrm
#libnrm-src = /path/to/nrm #libnrm-src = /path/to/nrm
#containers-src = /path/to/nrm #containers-src = /path/to/nrm
}).test' --run "argotk.hs helloworld" }).test' --run "argotk.hs TestHello"
``` ```
### Usage (in three parts) ### Usage (in three parts)
...@@ -63,7 +63,7 @@ nix-shell -E '{ argotest ? (builtins.fetchGit { ...@@ -63,7 +63,7 @@ nix-shell -E '{ argotest ? (builtins.fetchGit {
ref="fancy-branch-name"; ref="fancy-branch-name";
rev="commit-revisions-string"; rev="commit-revisions-string";
}; };
}).test' --run 'argotk.hs helloworld' }).test' --run 'argotk.hs TestHello'
``` ```
- [**3**] The `test`environment contains the `argotk.hs` tool, which runs various - [**3**] The `test`environment contains the `argotk.hs` tool, which runs various
...@@ -82,11 +82,11 @@ root/argotk/argotk.hs --help ...@@ -82,11 +82,11 @@ root/argotk/argotk.hs --help
Detailed help: Detailed help:
```{.bash} ```{.bash}
argotk.hs helloworld --help argotk.hs TestHello --help
``` ```
Output: Output:
```{.txt pipe="sh"} ```{.txt pipe="sh"}
root/argotk/argotk.hs helloworld --help root/argotk/argotk.hs TestHello --help
``` ```
#### Misc #### Misc
...@@ -98,7 +98,7 @@ nix-shell -E ' ...@@ -98,7 +98,7 @@ nix-shell -E '
(import( builtins.fetchGit { (import( builtins.fetchGit {
url = https://xgitlab.cels.anl.gov/argo/argotest.git; url = https://xgitlab.cels.anl.gov/argo/argotest.git;
ref="master"; ref="master";
}) {}).test' --run "argotk.hs helloworld" }) {}).test' --run "argotk.hs TestHello"
``` ```
#### WARNINGS #### WARNINGS
...@@ -123,7 +123,7 @@ integration.test: ...@@ -123,7 +123,7 @@ integration.test:
ref="master";}) ref="master";})
}: }:
(import argotest { containers-src = ./. ; }).test' \ (import argotest { containers-src = ./. ; }).test' \
--run 'argotk.hs helloworld' --run 'argotk.hs TestHello'
artifacts: artifacts:
paths: paths:
- argotest/_output/cmd_err.log - argotest/_output/cmd_err.log
......
...@@ -16,7 +16,7 @@ nix-shell -E ' ...@@ -16,7 +16,7 @@ nix-shell -E '
#nrm-src = /path/to/nrm #nrm-src = /path/to/nrm
#libnrm-src = /path/to/nrm #libnrm-src = /path/to/nrm
#containers-src = /path/to/nrm #containers-src = /path/to/nrm
}).test' --run "argotk.hs helloworld" }).test' --run "argotk.hs TestHello"
``` ```
### Usage (in three parts) ### Usage (in three parts)
...@@ -64,7 +64,7 @@ nix-shell -E '{ argotest ? (builtins.fetchGit { ...@@ -64,7 +64,7 @@ nix-shell -E '{ argotest ? (builtins.fetchGit {
ref="fancy-branch-name"; ref="fancy-branch-name";
rev="commit-revisions-string"; rev="commit-revisions-string";
}; };
}).test' --run 'argotk.hs helloworld' }).test' --run 'argotk.hs TestHello'
``` ```
- \[**3**\] The `test`environment contains the `argotk.hs` tool, which - \[**3**\] The `test`environment contains the `argotk.hs` tool, which
...@@ -93,25 +93,29 @@ Available commands: ...@@ -93,25 +93,29 @@ Available commands:
daemon-only Set up and launch the daemon in synchronous mode, daemon-only Set up and launch the daemon in synchronous mode,
with properly cleaned sockets, logfiles. with properly cleaned sockets, logfiles.
full-stack Setup stack and run a command in a container. full-stack Setup stack and run a command in a container.
helloworld Test 1: Setup stack and check that a hello world app TestHello test1: Setup stack and check that a hello world app
sends message back to cmd. sends message back to cmd.
perfwrapper Test 2: Setup stack and check that argo-perf-wrapper TestListen test2: Setup stack and check that argo-perf-wrapper
sends at least one progress message to the daemon. sends at least one message to the daemon.
listen Test 3: Setup stack and check that argo-perf-wrapper TestPerfwrapper test3: Setup stack and check that argo-perf-wrapper
sends at least one progress message to cmd listen sends at least one *performance* message to cmd
listen through the daemon.
TestPower test4: Setup stack and check that argo-perf-wrapper
sends at least one *power* message to cmd listen
through the daemon. through the daemon.
tests Run all tests
``` ```
Detailed help: Detailed help:
``` {.bash} ``` {.bash}
argotk.hs helloworld --help argotk.hs TestHello --help
``` ```
Output: Output:
``` {.txt} ``` {.txt}
Usage: argotk.hs helloworld [--application APP] Usage: argotk.hs TestHello [--application APP]
[--container_name ARGO_CONTAINER_UUID] [--container_name ARGO_CONTAINER_UUID]
[--output_dir DIR] [--manifest_directory DIR] [--output_dir DIR] [--manifest_directory DIR]
[--manifest_name FILENAME] [--cmd_run_out FILENAME] [--manifest_name FILENAME] [--cmd_run_out FILENAME]
...@@ -124,8 +128,7 @@ Usage: argotk.hs helloworld [--application APP] ...@@ -124,8 +128,7 @@ Usage: argotk.hs helloworld [--application APP]
[--message_cmd_run_stderr STRING] [--message_cmd_run_stderr STRING]
[--message_cmd_listen_stdout STRING] [--message_cmd_listen_stdout STRING]
[--message_cmd_listen_stderr STRING] [--message_cmd_listen_stderr STRING]
Test 1: Setup stack and check that a hello world app sends message back to test1: Setup stack and check that a hello world app sends message back to cmd.
cmd.
Available options: Available options:
--application APP Target application executable name. PATH is --application APP Target application executable name. PATH is
...@@ -167,12 +170,14 @@ Available options: ...@@ -167,12 +170,14 @@ Available options:
The appearance of this character string in the cmd The appearance of this character string in the cmd
run stdout will be monitored during execution. When run stdout will be monitored during execution. When
observed, the stack will be killed and a return code observed, the stack will be killed and a return code
of 0 will be returned. (default: "Hello-Moto") of 0 will be
returned. (default: "someComplicatedMessage")
--message_cmd_run_stderr STRING --message_cmd_run_stderr STRING
The appearance of this character string in the cmd The appearance of this character string in the cmd
run stdout will be monitored during execution. When run stdout will be monitored during execution. When
observed, the stack will be killed and a return code observed, the stack will be killed and a return code
of 0 will be returned. (default: "Hello-Moto") of 0 will be
returned. (default: "someComplicatedMessage")
--message_cmd_listen_stdout STRING --message_cmd_listen_stdout STRING
The appearance of this character string in the cmd The appearance of this character string in the cmd
listen stdout will be monitored during execution. listen stdout will be monitored during execution.
...@@ -195,7 +200,7 @@ nix-shell -E ' ...@@ -195,7 +200,7 @@ nix-shell -E '
(import( builtins.fetchGit { (import( builtins.fetchGit {
url = https://xgitlab.cels.anl.gov/argo/argotest.git; url = https://xgitlab.cels.anl.gov/argo/argotest.git;
ref="master"; ref="master";
}) {}).test' --run "argotk.hs helloworld" }) {}).test' --run "argotk.hs TestHello"
``` ```
#### WARNINGS #### WARNINGS
...@@ -221,7 +226,7 @@ integration.test: ...@@ -221,7 +226,7 @@ integration.test:
ref="master";}) ref="master";})
}: }:
(import argotest { containers-src = ./. ; }).test' \ (import argotest { containers-src = ./. ; }).test' \
--run 'argotk.hs helloworld' --run 'argotk.hs TestHello'
artifacts: artifacts:
paths: paths:
- argotest/_output/cmd_err.log - argotest/_output/cmd_err.log
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment