<!--

Copyright 2017 Lars Wirzenius

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

-->

---
title: Ick2 integration tests
author: Lars Wirzenius
version: work in progress
...


# Introduction

This is a set of integration tests for [Ick2][], a continuous integration
system. Written for execution by [yarn][].

[Ick2]: http://ick.liw.fi/
[yarn]: https://liw.fi/cmdtest/

## Running this test suite

This test suite tests an Ick2 controller, and can either run in a
local or remote mode. In local mode, each test scenario starts and
stops a local instance, and runs tests against that. In remote mode,
an existing, running controller instance is assumed, and tests are run
against that.

The `./check` script runs the tests. By default it runs in local mode.
Local mode can be specified explicitly with the `local` parameter:

    EXAMPLE running the test suite in local mode
    ./check
    ./check local
    ./check local -v --tempdir tmp --snapshot

`./check` can be given extra arguments, which it will pass on to
`yarn`.

To run the tests in remote mode, give the controller URL:

    EXAMPLE running the test suite in local mode
    ./check https://ick-controller --env ICK_PRIVATE_KEY=~/tmp/ick.key
    ./check https://ick-controller --env ICK_PRIVATE_KEY=~/tmp/ick.key \
        -v --tempdir tmp --snapshot

The URL **must** be an `https` URL. Additionally, the environment
variable `ICK_PRIVATE_KEY` must be given a path to the *private* key
for signing tokens, so that a new token can be generated.