From 7e4cce00008af3009be7e251fdc22c0a8623c1a8 Mon Sep 17 00:00:00 2001 From: Olof hagsand Date: Tue, 19 Feb 2019 13:32:03 +0100 Subject: [PATCH] test docs --- README.md | 4 ++-- doc/FAQ.md | 2 +- docker/system/README.md | 14 +++----------- test/README.md | 13 ++++++++++--- 4 files changed, 16 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 1b2fc6f8..f921f98e 100644 --- a/README.md +++ b/README.md @@ -25,8 +25,8 @@ support. * [Changelog](CHANGELOG.md) * [Runtime](#runtime) * [Clixon project page](http://www.clicon.org) - * [Tests](test/README.md) - * [Clixon containers](docker/README.md) + * [Tests and CI](test/README.md) + * [Containers](docker/README.md) * [Roadmap](ROADMAP.md) * [Reference manual](#reference) diff --git a/doc/FAQ.md b/doc/FAQ.md index e1673808..b25a4862 100644 --- a/doc/FAQ.md +++ b/doc/FAQ.md @@ -259,7 +259,7 @@ For example, the clixon-system container can be used as follows: * CLI: `sudo docker exec -it clixon-system clixon_cli` * Netconf: `sudo docker exec -it clixon-system clixon_netconf` * Restconf: `curl -G http://localhost/restconf` -* Run tests: `sudo docker exec -it clixon-system bash -c 'cd /clixon/clixon/test; exec ./all.sh'` +* Run tests: `sudo docker exec -it clixon-system bash -c 'cd /clixon/clixon/test; ./all.sh'` See [../docker](../docker) for more info. diff --git a/docker/system/README.md b/docker/system/README.md index 7e67f791..73378264 100644 --- a/docker/system/README.md +++ b/docker/system/README.md @@ -1,16 +1,8 @@ -# Clixon example container +# Clixon example test container This directory show how to build a "monolithic" clixon docker container exporting port 80 and contains the example application with -both restconf, netconf, cli and backend. - -Note that the container is built from scratch instead of using the -base image. And it differs from the base image in that it builds the -code from the local git locally (regardless of status and branch) -wheras the base image pulls from remote github master branch. - -Note that it could use the base image, and may in the future, see -comments in the Dockerfile. +both restconf, netconf, cli and backend. It also includes packages to be able to run the [Clixon tests](../../test). The directory contains the following files: cleanup.sh kill containers @@ -52,7 +44,7 @@ As restconf using curl on exposed port 80: ``` Or run tests: ``` - $ sudo docker exec -it clixon-system bash -c 'cd /usr/local/bin/test&& ./all.sh' + $ sudo docker exec -it clixon-system bash -c 'cd /usr/local/bin/test && ./all.sh' ``` To check status and then kill it: diff --git a/test/README.md b/test/README.md index bb46052d..1d147dd2 100644 --- a/test/README.md +++ b/test/README.md @@ -1,4 +1,4 @@ -# Clixon tests +# Clixon tests and CI ## Overview @@ -7,7 +7,15 @@ automatically run as part of the all.sh, sum.sh tests etc. The scripts need to follow some rules to work properly, please look at one or two to get the idea. -See also the [site.sh](#site.sh) for example for skipping tests or setting some site-specific variables. +See also the [site.sh](#site-sh) for example for skipping tests or setting some site-specific variables. + +## Continuous Integration + +CI is done via [Travis CI](https://travis-ci.org/clicon/clixon). + +In the CI process, the system is built and configured and then the +[clixon test container](../docker/system) is built and the tests in +this directory is executed. ## Getting started @@ -21,7 +29,6 @@ You need to build and install the clixon utility programs before running the tes You need to start nginx for some of the text. There are instructions in * If you run systemd: `sudo systemctl start nginx.service` * The [example](../example/README.md) has instructions -* See also the [clixon test container](../docker/system) where all test are encapsulated. ## Prefix variable