These Spinnaker integration tests depend on the [Cloud Integration Testing] (https://github.com/google/citest) python package. You'll need to run the setup script to install the dependencies into your environment, then can run the tests at will.

To write new tests refer to existing tests and see the citest README.md gifor the time being, and ask questions on the [Spinnaker #dev slack channel] (https://spinnakerteam.slack.com/messages/dev/).

This part of the repository is divided into the following parts:

These tests are written in Python. Instead of installing the dependencies into system folders consider using something like [virtualenv] (https://virtualenv.pypa.io/en/stable/). This is optional, but a suggestion.

# Install the python package manager if you dont already have it
sudo apt-get install python-pip

# Instal FFI package needed by pyopenssl
sudo apt-get install libffi-dev libssl-dev python-dev

# Install virtualenv tools  and setup a Virtual Environment.
pip install virtualenv

# Create an environment to use.
MYENV=my-virtualenv   # to clarify documentation
virtualenv $MYENV     # create a new environment directory

# Use the environment for a session (in the current shell).
source $MYENV/bin/activate  # use $MYENV in the current shell
...
deactivate            # leave the virtualenv when you are done

If you are using Virtual Env, then all the remaining instructions would be performed within the virtual environment, entered by source $MYENV/bin/activate within the shell you run the commands in.

These are not yet automated. Depending on the platforms involved either by hosting Spinnaker or being the platform the test is running against, you may need additional tools.

Below mentioned environment variables are needed in order for OpenStack client to work.

citest is not yet published to a pip repository so you need to clone the citest repository and install it from there.

# From another directoy, such as the sibling directory to this repository.
git clone https://github.com/google/citest.git
cd citest
pip install -r requirements.txt

Then come back here and install the requirements for these tests. Run pip install -r requirements.txt.

Normally these tests do not require any particular type of deployment. The tests themselves can be run from anywhere provided they can gain access to the microservices and backend services they need to talk to.

You can run the tests against any standard deployment. The tests will typically inspect your configuration and adapt themselves if possible while providing command-line flags for remaining parameters or overrides for what it may find.

Some tests require unique parameters, or may require certain features enabled in order to test them, but even so do not typically dictate any particular values beyond the feature being properly enabled in standard ways.

2016-09-22 The documentation is sparse at this time. Currently only the bake_and_deploy test requires special configuration, which is basically a Jenkins job that it can trigger. Even there, the triggering information is passed to the test via command-line arguments. Instructions for this can be found in the test itself: [bake_and_deploy_test.py] (https://github.com/google/citest/blob/master/spinnaker/spinnaker_system/bake_and_deploy_test.py)

If your deployment is firewalled in a way that the machine you are running from cannot normally access the service endpoints then you will need to tunnel in or use one of the other suggestions recommended for users to gain access to the Spinnaker UI. While these tests do not use the UI, the networking techniques are the same.

If Spinnaker is deployed on the Google Cloud Platform, the tests will tunnel into them if you use the --gce_[project|zone|instance] parameters. Otherwise, if you use --native_hostname then you must tunnel in (or provide some other means).

If spinnaker tunnels on your behalf, it will need your ssh passphrase. Since the tests are meant to be automated, these can be implicit by running something like ssh-agent in the shell you are running the tests from, or you can create a file containing the passphrase and pass the path on the command-line using --ssh_passphrase_file. If using the file, be sure to protect it using chmod 200.

The following parameters can be passed on the command-line using a flag --<parameter_name>=<parameter_value>.

When spinnaker is on GCE you can use the native_hostname flag, or these custom flags which will locate the instance for you. If using the flags below, citest will automatically attempt to tunnel into the instance if it is not already reachable.

These parameters are typically obtained from the deployed Spinnaker where possible, and if not have default values so do not need to be specified.

Typical tests assume that the platform running Spinnaker is independent of the platform providing the resources that Spinnaker is managing. Therefore, a typical invocation has three sets of commandline parameters. One set specifies "spinnaker" things, another specifies "managed resource" things, and lastly, additional "observer" things.

PYTHONPATH=.:spinnaker \
python spinnaker/tests/<fixture name>.py \
<Talking to Spinnaker Parameters> \
<Managing Resource Parameters> \
<Observer Parameters>

    --gce_project=$PROJECT \
    --gce_zone=$ZONE \
    --gce_instance=$INSTANCE \
    --gce_ssh_passphrase_file=<path to optional passphrase file>

    --native_hostname=$HOST

    --native_hostname=$HOST

    --gce_credentials_path=<path to downloaded JSON credentials>

    --aws_profile=$PROFILE

    None (when on GCE)

    --os_cloud=$OS_CLOUD

    --azure_storage_account_key=Key to access the storage account used by Spinnaker
    --azure_storage_account_name=Name of the Azure storage account used by Spinnaker

Assuming you are in the repository root directory and testing against GCE where:

PROJECT_ID=ewiseblatt-spinnaker-test
INSTANCE=ewiseblatt-20150805
ZONE=us-central1-c

then:

PYTHONPATH=.:spinnaker python \
  spinnaker/spinnaker_system/google_kato_test.py \
  --gce_project=$PROJECT_ID \
  --gce_instance=$INSTANCE \
  --gce_zone=$ZONE \
  --gce_ssh_passphrase_file=$HOME/.ssh/google_compute_engine.passphrase

If you were testing against some "native" host:

PYTHONPATH=.:spinnaker python \
  spinnaker/spinnaker_system/google_kato_test.py \
  --native_host=$HOSTNAME \
  --managed_gce_project=$PROJECT_ID \
  --test_gce_zone=$ZONE

Note that google_kato_test.py is written to specifically test managing GCE instances regardless of where Spinnaker is running from. So you can run it against an AWS deployment, but will still be observing changes on GCE.

An example testing managing AWS instances, with Spinnaker running on a "native" host where:

HOSTNAME=localhost  # IP address where spinnaker is running.
PROFILE=test        # user creates profile for aws cli tool outside citest.
ZONE=us-east-1a     # an AWS zone.

then:

PYTHONPATH=.:spinnaker python \
  spinnaker/spinnaker_system/aws_kato_test.py \
  --native_host=$HOSTNAME \
  --aws_profile=$PROFILE \
  --test_aws_zone=$ZONE

Note that aws_kato_test.py is written to specifically test managing AWS instances regardless of where Spinnaker is running from. So you can run it against a GCE deployment, but will still be observing changes on AWS.