Skip to content

Latest commit

 

History

History
120 lines (79 loc) · 5.64 KB

BASICS.md

File metadata and controls

120 lines (79 loc) · 5.64 KB
Raw

Documentation index

A basic example

Substitute these with your credentials:

GITHUB_USER="GRANDE_USER"
GITUB_PWD_OR_TOKEN="MYPASSWORD"

echo "machine api.github.com login $GITHUB_USER password $GITUB_PWD_OR_TOKEN > /~.netrc"
sudo chmod 0600 ~/.netrc
echo "#! /bin/bash" > /tmp/tests.sh
chmod +x /tmp/tests.sh
gitarro.rb -r openSUSE/gitarro -c "ruby-test" -t /tmp/tests.sh

Current syntax

Usage: gitarro.rb [options]

Mandatory options:
    -r, --repo 'REPO'                GitHub repository to look for PRs. For example: openSUSE/gitarro.
    -c, --context 'CONTEXT'          Context to set on comment (test name). For example: python-test.
    -t, --test 'TEST.SH'             Command, or full path to script/binary to be used to run the test.

Optional options:
    -f, --file '.py'                 pr_file type to filter/trigger the test against: .py, .rb
    -d, --description 'DESCRIPTION'  Test decription
    -C, --check                      Check if there is any PR requiring a test, but do not run it.
    -F, --force_test                 Force to run a test, even if is not marked to be re-triggered.
    -u, --url 'TARGET_URL'           Specify the URL to append to add to the GitHub review. Usually you                                   will use an URL to the Jenkins build log.
    -P  --PR 'NUMBER'                Specify the PR number instead of checking all of them. This will                                     force gitarro to run the against a specific PR number,even if it is                                  not needed (useful for using Jenkins with GitHub webhooks).
        --https                      If present, use https instead of ssh for git operations
        --changed_since 'SECONDS'    If present, will only check PRs with a change in the last X seconds

    -g, --git_dir 'GIT_LOCAL_DIR'    Specify a location where gitarro will clone the GitHub project. If the dir does not exists, gitarro will create one. For example: /tmp/

Help:
    -h, --help                       help

Example: gitarro.rb -r openSUSE/gitarro -c 'python-test' -d 'someCoolTest' -t /tmp/test.sh -f '.py'

Basic concepts : part 1

gitarro runs a validation script, binary or command (-t or --test) against PRs of the GitHub repository you specify (-r or --repo).

gitarro.rb -r openSUSE/gitarro -c "ruby-test" -t /tmp/tests.sh --https

Gitarro use shallow clone by default with a temporary git repo.

When you run this command, you will run the script tests.sh against the 1st PR open on the GitHub Repository openSUSE/gitarro.

When you run it for the 2nd time, it will run on the 2nd PR if open, otherwise if you have only 1 PR open, it will not reschedule any test. The -c option, is the context(mandatory), which is the name of tests. If you change the context name, it will reschedule the test for the PR.

Having 10 different contexts, mean that you have 10 different type of tests on PR. ( like python-pylint, python-acceptance, ruby-rspec etc..)

Basic concepts : part 2

There are two basic ways of using it:

  • It can run against the first untested PR or the first PR with a comment to force a test, or against the PR you specify.

    In this case you will need to run gitarro as many times as opened PRs requiring tests.
    It works this way so if you are using Jenkins pulling the repository, you can have one job build for each gitarro execution. It is also possible instruct gitarro to scan only the Pull Requests changed during the last X seconds (--changed_since). From GitHub API perspective, and gitarro's perspective a change is either a new commit or a new comment at the PR.

  • If you are using webhooks, then you just need to specify the ID of the Pull Requests that started the hook (--P or --PR)

It is also possible to tell gitarro to ignore PRs unless specific files are changed (by path or by extension with -f or --file), and specify a URL to added to the Pull Requests with the link to the log with the test output, for example to a Jenkins log (-u o --url).

Devel Installation

Use bundler to download all Ruby dependencies:

bundler install

For the stable use gem install gitarro

Configuration

The only configuration required is to have a valid /~.netrc file and a user that read access credentials to the repository with the Pull Requests to be tested.

You can use your GitHub username and password (unless you have 2FA enabled), but it is strongly recommended that you use a GitHub Personal Token

Configure the /~.netrc with the following format (you can add a new line if the file already exists):

machine api.github.com login <GITHUB_USER> password <GITHUB_PASSWORD/GITHUB_PERSONAL TOKEN>

Tests

Typically you will have a shell script making all the work for you, including possible parameters (but again, it is possible to use any other scripting language, binaries or commands).

Example

#!/bin/bash -e
rubocop *.rb

Would check Ruby source files for code that does not follow the ruby style guide. It will return 0 if everything is fine, or any other number if there are errors. With this return code gitarro is able to know if the test needs to be marked as failed

Please take note that if you are using a script and decide to run it without calling the interpreter, it should be configured as executable.

Syntax

Run the following command to get help

gitarro.rb -h

Documentation index