skia-buildbot

README

Skia-Buildbot Repository

This repo contains infrastructure code for Skia.

Getting the Source Code

The main source code repository is a Git repository hosted at https://skia.googlesource.com/buildbot. Although it is possible to check out this repository directly with git clone or using gclient fetch, it is preferred to use go get so that the code is arranged correctly for Go. If this is your first time working on Go code, read about the GOPATH environment variable. Make sure that $GOPATH/bin comes before /usr/bin in your PATH. If you have GOPATH set, run:

$ go get -u -t go.skia.org/infra/...

This fetches the repository into your $GOPATH directory along with all the Go dependencies. Note: go.skia.org is a custom import path and will only work if used like the examples here.

Install Node.js (not as root) and add the bin dir to your path. Optionally run npm install npm -g, as suggested by the npm getting started doc.

Install other dependencies:

$ sudo apt-get install python-django
$ go get -u github.com/kisielk/errcheck \
  golang.org/x/tools/cmd/goimports \
  go.chromium.org/luci/client/cmd/isolate
$ npm install -g polylint bower

Build from GOPATH:

$ cd $GOPATH/src/go.skia.org/infra/
$ make all

Generated Code

Some code is generated using go generate with external binaries. First, install the version of protoc referenced in the asset creation script and ensure it is on your PATH before other versions of protoc.

Install the necessary go packages:

$ go get -u \
  github.com/golang/protobuf/protoc-gen-go \
  golang.org/x/tools/cmd/stringer \
  google.golang.org/grpc

To generate code run in this directory:

$ go generate ./...

Database Setup for Testing

Tests which use the database package's testutils require you to have a MySQL instance running with a database named "sk_testing" and users called "readwrite" and "test_root" with appropriate permissions for sk_testing. The 'setup_test_db' script in 'go/database' is included for convenience in setting up this test database and user.

Go tests require a local installation of MySQL. For a Debian based distro:

$ sudo apt-get install mysql-client mysql-server

Leave the root password blank.

Then, to set up local versions of the production databases:

$ cd $GOPATH/src/go.skia.org/infra/go/database
$ ./setup_test_db

Running unit tests

Install Cloud SDK.

The installed python-django version must be >= 1.7. Run the following to update:

$ sudo pip install Django --upgrade

Use this command to run the presubmit tests:

$ ./run_unittests --small