experiments/clixon
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

test docs

Browse source
This commit is contained in:
Olof hagsand 2019-02-19 13:32:03 +01:00
parent 4c0b412e9f
commit 7e4cce0000
4 changed files with 16 additions and 17 deletions
Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -25,8 +25,8 @@ support.
* [Changelog](CHANGELOG.md) * [Changelog](CHANGELOG.md)
* [Runtime](#runtime) * [Runtime](#runtime)
* [Clixon project page](http://www.clicon.org) * [Clixon project page](http://www.clicon.org)
* [Tests](test/README.md) * [Tests and CI](test/README.md)
* [Clixon containers](docker/README.md) * [Containers](docker/README.md)
* [Roadmap](ROADMAP.md) * [Roadmap](ROADMAP.md)
* [Reference manual](#reference) * [Reference manual](#reference)

2
doc/FAQ.md
View file

@ -259,7 +259,7 @@ For example, the clixon-system container can be used as follows:
* CLI: `sudo docker exec -it clixon-system clixon_cli` * CLI: `sudo docker exec -it clixon-system clixon_cli`
* Netconf: `sudo docker exec -it clixon-system clixon_netconf` * Netconf: `sudo docker exec -it clixon-system clixon_netconf`
* Restconf: `curl -G http://localhost/restconf` * 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. See [../docker](../docker) for more info.

12
docker/system/README.md
View file

@ -1,16 +1,8 @@
# Clixon example container # Clixon example test container
This directory show how to build a "monolithic" clixon docker This directory show how to build a "monolithic" clixon docker
container exporting port 80 and contains the example application with container exporting port 80 and contains the example application with
both restconf, netconf, cli and backend. both restconf, netconf, cli and backend. It also includes packages to be able to run the [Clixon tests](../../test).
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.
The directory contains the following files: The directory contains the following files:
cleanup.sh kill containers cleanup.sh kill containers

13
test/README.md
View file

@ -1,4 +1,4 @@
# Clixon tests # Clixon tests and CI
## Overview ## 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 need to follow some rules to work properly, please look at one or two
to get the idea. 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 ## 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 You need to start nginx for some of the text. There are instructions in
* If you run systemd: `sudo systemctl start nginx.service` * If you run systemd: `sudo systemctl start nginx.service`
* The [example](../example/README.md) has instructions * The [example](../example/README.md) has instructions
* See also the [clixon test container](../docker/system) where all test are encapsulated.
## Prefix variable ## Prefix variable