Skip to content

Latest commit

 

History

History
191 lines (123 loc) · 7.31 KB

CONTRIBUTING.md

File metadata and controls

191 lines (123 loc) · 7.31 KB
Raw

Contributing to Google Cloud Ruby Client

  1. Sign one of the contributor license agreements below.
  2. Fork the repo, develop and test your code changes.
  3. Send a pull request.

Contributor License Agreements

Before we can accept your pull requests you'll need to sign a Contributor License Agreement (CLA):

  • If you are an individual writing original source code and you own the intellectual property, then you'll need to sign an individual CLA.
  • If you work for a company that wants to allow you to contribute your work, then you'll need to sign a corporate CLA.

You can sign these electronically (just scroll to the bottom). After that, we'll be able to accept your pull requests.

Setup

In order to use the google-cloud-ruby console and run the project's tests, there is a small amount of setup:

  1. Install Ruby. google-cloud-ruby requires Ruby 2.4+. You may choose to manage your Ruby and gem installations with RVM, rbenv, or chruby.

  2. Install Bundler.

    $ gem install bundler

  3. Install the top-level project dependencies.

    $ bundle install

  4. Install the dependencies for each package.

    $ bundle exec rake bundleupdate

Console

In order to run code interactively, you can automatically load google-cloud-ruby and its dependencies in IRB with:

$ bundle exec rake console

Tests

Tests are very important part of google-cloud-ruby. All contributions should include tests that ensure the contributed code behaves as expected.

To run the unit tests, documentation tests, and code style checks together for a package:

$ cd <package-name>
$ bundle exec rake ci

To run the command above, plus all acceptance tests, use rake ci:acceptance or its handy alias, rake ci:a.

Unit Tests

The project uses the minitest library, including specs, mocks and minitest-autotest.

To run the unit tests for a package:

$ cd <package-name>
$ bundle exec rake test

Documentation Tests

The project tests the code examples in the each gem's YARD-based documentation.

The example testing functions in a way that is very similar to unit testing, and in fact the library providing it, yard-doctest, is based on the project's unit test library, minitest.

To run the documentation tests for a package:

$ cd <package-name>
$ bundle exec rake doctest

If you add, remove or modify documentation examples when working on a pull request, you may need to update the setup for the tests. The stubs and mocks required to run the tests are located in support/doctest_helper.rb for each package. Please note that much of the setup is matched by the title of the @example tag. If you alter an example's title, you may encounter breaking tests.

Acceptance Tests

The google-cloud-ruby acceptance tests interact with the live service API (or APIs) for each package, including:

  • BigQuery
  • Cloud Datastore
  • Cloud DNS
  • Cloud Pub/Sub
  • Cloud Storage

Follow the instructions in the Authentication guide for enabling APIs. Some of the APIs may not yet be generally available, making it difficult for some contributors to successfully run the entire acceptance test suite. However, please ensure that you do successfully run acceptance tests for any code areas covered by your pull request.

To run the acceptance tests, first create and configure a project in the Google Developers Console, as described in the Authentication guide. Be sure to download the JSON KEY file. Make note of the PROJECT_ID and the KEYFILE location on your system.

Datastore acceptance tests

To run the Datastore acceptance tests, you must first create indexes used in the tests.

Datastore indexes

Install the gcloud command-line tool and use it to create the indexes used in the datastore acceptance tests. From the project's root directory:

# Install the app component
$ gcloud components update app

# Set the default project in your env
$ gcloud config set project PROJECT_ID

# Authenticate the gcloud tool with your account
$ gcloud auth login

# Create the indexes
$ gcloud datastore create-indexes acceptance/data/index.yaml

# Create the indexes for datastore samples
$ gcloud datastore create-indexes google-cloud-datastore/samples/index.yaml

DNS Acceptance Tests

To run the DNS acceptance tests you must give your service account permissions to a domain name in Webmaster Central and set the GCLOUD_TEST_DNS_DOMAIN environment variable to the fully qualified domain name. (e.g. "example.com.")

Running the acceptance tests

To run the acceptance tests for a package:

$ cd <package-name>
$ bundle exec rake acceptance[PROJECT_ID,KEYFILE_PATH]

Or, if you prefer you can store the values in the GCLOUD_TEST_PROJECT and GCLOUD_TEST_KEYFILE environment variables:

$ cd <package-name>
$ export GCLOUD_TEST_PROJECT=my-project-id
$ export GCLOUD_TEST_KEYFILE=/path/to/keyfile.json
$ bundle exec rake acceptance

If you want to use different values for Datastore vs. Storage acceptance tests, for example, you can use the DATASTORE_TEST_ and STORAGE_TEST_ environment variables:

$ cd <package-name>
$ export DATASTORE_TEST_PROJECT=my-project-id
$ export DATASTORE_TEST_KEYFILE=/path/to/keyfile.json
$ export STORAGE_TEST_PROJECT=my-other-project-id
$ export STORAGE_TEST_KEYFILE=/path/to/other/keyfile.json
$ bundle exec rake acceptance

Integration Tests

The google-cloud-ruby integration tests are end-to-end tests that validate library functionality on real Google Cloud Platform hosting environments. The integration process deploys several Rack-based applications to Google Cloud Platform one by one, then validates google-cloud-ruby code by making requests to these test applications.

See the integration/README.md for instructions on how to setup for the integration tests and other details.

To run the integration tests:

$ bundle exec rake integration

Coding Style

Please follow the established coding style in the library. The style is is largely based on The Ruby Style Guide with a few exceptions based on seattle-style:

  • Avoid parenthesis when possible, including in method definitions.
  • Always use double quotes strings. (Option B)

You can check your code against these rules by running Rubocop like so:

$ cd <package-name>
$ bundle exec rake rubocop

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. See Code of Conduct for more information.