Skip to content

Latest commit

 

History

History
206 lines (146 loc) · 7.09 KB

TravisClient.md

File metadata and controls

206 lines (146 loc) · 7.09 KB
Raw

Travis Client

The Travis Client allows Travis CI jobs to be managed from the command-line. It can be used to:

  • Automatically triggering re-runs of interoperability tests without having to either submit a GitHub pull request on the repository holding the Travis CI configuration file, or going via Travis CI's web interface.
  • Create encrypted values for environment variables within .travis.yml scripts.

The instructions have been written with reference to the 64-bit Ubuntu 14.04.2 operating system.

Other operating systems, or versions of these, may differ in how packages are installed, the versions of these packages available from package managers etc. Consult the relevant documentation for your operating system and the products concerned.

Some dependencies require you to have sudo access to install and configure software (or a local system administrator can do this for you).

Install RVM and Ruby 2.2

Travis Client runs under Ruby. We will use Ruby Version Manager to install Ruby.

$ gpg --keyserver hkp://keys.gnupg.net --recv-keys D39DC0E3
$ \curl -sSL https://get.rvm.io | bash -s stable --ruby

You may be prompted for a sudo password:

Updating system ubuntu password required for 'apt-get --quiet --yes update':

so that dependencies can be installed:

Installing required packages: gawk, libyaml-dev, sqlite3, autoconf, libgdbm-dev, libncurses5-dev, automake, libtool, bison............

Set up RVM environment:

$ source ~/.rvm/scripts/rvm

Install Ruby:

$ rvm list known
$ rvm install 2.2
$ rvm use 2.2
$ rvm --default use 2.2
$ ruby -v
ruby 2.2.1p85 (2015-02-26 revision 49769) [x86_64-linux]

Install Travis Client gem

$ gem install travis
$ travis version
travis version
Shell completion not installed. Would you like to install it now? |y| y
1.8.0

Log in to Travis CI

Use your GitHub username and password to log in to Travis CI:

$ travis login
We need your GitHub login to identify you.
This information will not be sent to Travis CI, only to api.github.com.
The password will not be displayed.

Try running with --github-token or --auto if you don't want to enter your password anyway.

Username: USERNAME
Password for USERNAME: PASSWORD
Successfully logged in as USERNAME!

Travis CI identification

Travis Client commands can be run within a Git repository and the client will try and determine the user/project name and repository name to use when interacting with Travis CI. Alternatively, you can provide the user/project name and repository name explicitly in the form USER_OR_PROJECT_NAME/REPOSITORY_NAME e.g.

prov-suite/interop-test-harness
prov-suite/provpy-interop-job
user/provtoolsuite-provpy-interop-job

View build history

$ travis history -r prov-suite/interop-test-harness
#5 passed:       master Merged in changes from user
#4 passed:       master Merge pull request #1 from user/master
#3 passed:       master (PR #1) Added standalone usage information
#2 passed:       master Runs unit tests correctly
#1 passed:       master user -> prov-suite and removed provtoolsuite- prefix to reflect forking of repository into prov-suite

$ travis history -r prov-suite/provpy-interop-job
#2 passed:       master Merged in changes from user
#1 passed:       master user -> prov-suite and removed provtoolsuite- prefix to reflect forking of repository into prov-suite

Restart builds

Restart the most recent build for a repository:

$ travis restart -r prov-suite/provpy-interop-job
build #2 has been restarted

Restart a specific build for a repository:

$ travis restart -r prov-suite/provpy-interop-job 2
build #2 has been restarted

Restart a job within a specific for a repository (e.g. rerun job 2, the Python 3.4 version, of the build):

$ travis restart -r prov-suite/provpy-interop-job 2.2.
build #2 has been restarted

Logout from travis

$ travis logout
Successfully logged out!

Create a GitHub token

Instead of having to interactively log in, you can create a GitHub token. This then allows interactions with Travis CI via Travis Client to be scripted and run without human interaction (e.g. as part of an overnight CRON job):

  • Log in to https://github.com
  • Visit https://github.com/settings/profile
  • Click Personal access tokens
  • Click Generate new token
  • Enter Password
  • Click Confirm password
  • Token description: TravisCI command-line tool
  • Click Generate token
  • Copy token and save it somewhere save

Log into Travis CI using token

$ travis login --github-token TOKEN
Successfully logged in as user!

Sample script

travis/travis-restart.sh contains a simple example of a script to automatically trigger a rerun of a Travis CI build of the prov-suite/interop-test-harness build. To use this script:

  • Edit it and replace GITHUB_TOKEN with your GitHub token
  • Run:
./travis-restart.sh
  • You should see output like:
Successfully logged in as user!
#5 passed:       master Merged in changes from user
#4 passed:       master Merge pull request #1 from user/master
#3 passed:       master (PR #1) Added standalone usage information
#2 passed:       master Runs unit tests correctly
#1 passed:       master user -> prov-suite and removed provtoolsuite- prefix to reflect forking of repository into prov-suite
build #5 has been restarted
Successfully logged out!

Add an encrypted variable

Travis Client can create encrypted variables for use in .travis.yml files. These can be useful where a build needs sensitive information (e.g. keys or passwords) that you do not want to expose.

For example:

$ travis encrypt PROVSTORE_API_KEY=user:12345qwert
Please add the following to your .travis.yml file:

  secure: "pp943Ps+J+Cv+d7X5APhPH6eNyvCGFkXwVZM6bWIANzTjjg2P8LV0pBF86w+G7vFQ2Y8X7DE2DzrvVtSKs14gsAQpuK9i5pHLtTh5iCyRHrNBgNVqYMfuaTVNWa3T6VYjv99LshCwmAjQBqHk9cHjHKFjXHlRYdK2TXBaXnn9pMC6qhMsZ4vcXLHhSKRFKN8aguh8uhqL8nsaejOdJpFTtfCPwtQ0OSBeUu6tfdA+bALu/x4yWkzJ7wcBnLRTXI/alB6BRORAIifX0tPQ36Lv9p5Cs9u9nNLW/vVVaBqjcT/9T3MTKFAFpTQCN5v9P0ZGJGKz9Py50gA21ZGB1t9ivQ5kILXi1Ap0lxtX3SGLDrGXKovLy4m7L1dnxk3oAG8bcPDtc8ZCBToWLumJcKG2nWCuYl8Ki4S5ezN2ehbabfDlozaIJeozFjVsIpVbjxtpZ8OASflyyAmuZbk/+o/ZaP/Ym+n2CMgLrgNIY6S8uK6iOdvE44RRg4/VgK8pxhiaTqDY8+y9QFhdL4FuRE8LDQLBi0Rnm2h3Y+PSe4NZdPzGY0FDowazIv2k9EyekAkCzOK++Z2Fzz/9uK4e0UGfMuvkDuXG9ECExykm4nsUxJyJsTSQAY1azT/izFHuGXXdBkLfNhoVbR7JjNmH9hcI1ryQM7STpMGHiihDbCZ6yo="

Pro Tip: You can add it automatically by running with --add.

To update .travis.yml so the value is available as an environment variable, run:

$ travis encrypt PROVSTORE_API_KEY=user:12345qwert --add env.global`

The Travis user documentation comments that:

Encryption and decryption keys are tied to the repository. If you fork a project and add it to Travis CI, it will have different keys to the original.

Alternatively, you can use the Travis web interface and define variables in repository settings.