Commit 3911b5dc authored by Valentin Reis's avatar Valentin Reis

[doc] Readme update.

parent 60cb38b4
Pipeline #4734 passed with stage
in 14 seconds
#### integration testing #### integration testing
This repository contains integration tests that validate the argo stack, Integration tests that validate the argo stack, leveraging the 'argopkgs' repo.
leveraging the 'argopkgs' repo
The intended usage is to override (some of) the source(s) with WIP The intended usage is to override (some of) the source(s) with WIP
version(s), as part of development or continuous integration. This version(s), as part of development or continuous integration.
gitlab CI snippets shows how to do this on a nix-enabled runner. Mind
that this setup tracks argotest master.
### Usage (tl;dr, I already have nix on my machine.) ### Usage (tl;dr, I already have nix on my machine.)
...@@ -24,10 +21,10 @@ nix-shell -E ' ...@@ -24,10 +21,10 @@ nix-shell -E '
### Usage (in three parts) ### Usage (in three parts)
- [*1*] Get Nix: `curl https://nixos.org/nix/install | sh` - [**1**] Get Nix: `curl https://nixos.org/nix/install | sh`
- [*2*] Use the ~test~ attribute of the argotest' nix attribute set to enter a - [**2**] Use the `test` attribute of the argotest' nix attribute set to enter a
test environment. For example, we can run default tests on the test environment. For example, we can run default tests on the
"argopkgs-pinned" version of argo components using: "argopkgs-pinned" version of argo components using:
```bash ```bash
...@@ -70,7 +67,7 @@ nix-shell -E '{ argotest ? (builtins.fetchGit { ...@@ -70,7 +67,7 @@ nix-shell -E '{ argotest ? (builtins.fetchGit {
}).test' --run 'argotk.hs helloworld' }).test' --run 'argotk.hs helloworld'
``` ```
- [3] The `test`environment contains the `argotk.hs` tool, which runs various - [**3**] The `test`environment contains the `argotk.hs` tool, which runs various
operations on the argo stack: operations on the argo stack:
Commands list: Commands list:
...@@ -120,7 +117,6 @@ There are a few things one has to be aware of using this workflow: ...@@ -120,7 +117,6 @@ There are a few things one has to be aware of using this workflow:
### Example CI setup ### Example CI setup
For example, we could setup the CI for the `containers` repo like:
``` {.yml} ``` {.yml}
integration.test: integration.test:
stage: test stage: test
...@@ -129,7 +125,7 @@ integration.test: ...@@ -129,7 +125,7 @@ integration.test:
url = https://xgitlab.cels.anl.gov/argo/argotest.git; url = https://xgitlab.cels.anl.gov/argo/argotest.git;
ref="master";}) ref="master";})
}: }:
(import argotest { containers-src = ./. ; }).test' (import argotest { containers-src = ./. ; }).test' \
--run 'argotk.hs helloworld' --run 'argotk.hs helloworld'
artifacts: artifacts:
paths: paths:
......
...@@ -4,9 +4,7 @@ This repository contains integration tests that validate the argo stack, ...@@ -4,9 +4,7 @@ This repository contains integration tests that validate the argo stack,
leveraging the 'argopkgs' repo leveraging the 'argopkgs' repo
The intended usage is to override (some of) the source(s) with WIP The intended usage is to override (some of) the source(s) with WIP
version(s), as part of development or continuous integration. This version(s), as part of development or continuous integration.
gitlab CI snippets shows how to do this on a nix-enabled runner. Mind
that this setup tracks argotest master.
### Usage (tl;dr, I already have nix on my machine.) ### Usage (tl;dr, I already have nix on my machine.)
...@@ -24,11 +22,11 @@ nix-shell -E ' ...@@ -24,11 +22,11 @@ nix-shell -E '
### Usage (in three parts) ### Usage (in three parts)
- \[*1*\] Get Nix: `curl https://nixos.org/nix/install | sh` - \[**1**\] Get Nix: `curl https://nixos.org/nix/install | sh`
- \[*2*\] Use the ~test~ attribute of the argotest' nix attribute set - \[**2**\] Use the `test` attribute of the argotest' nix attribute
to enter a test environment. For example, we can run default tests set to enter a test environment. For example, we can run default
on the "argopkgs-pinned" version of argo components using: tests on the "argopkgs-pinned" version of argo components using:
``` {.bash} ``` {.bash}
nix-shell -E ' nix-shell -E '
...@@ -70,7 +68,7 @@ nix-shell -E '{ argotest ? (builtins.fetchGit { ...@@ -70,7 +68,7 @@ nix-shell -E '{ argotest ? (builtins.fetchGit {
}).test' --run 'argotk.hs helloworld' }).test' --run 'argotk.hs helloworld'
``` ```
- \[3\] The `test`environment contains the `argotk.hs` tool, which - \[**3**\] The `test`environment contains the `argotk.hs` tool, which
runs various operations on the argo stack: runs various operations on the argo stack:
Commands list: Commands list:
......
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