resource

package module
v0.16.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 12, 2019 License: MIT Imports: 22 Imported by: 4

README

Github PR resource

Build Status Go Report Card Docker Automated build

A Concourse resource for pull requests on Github. Written in Go and based on the Github V4 (GraphQL) API. Inspired by the original, with some important differences:

  • Github V4: check only requires 1 API call per 100th open pull request. (See #costs for more information).
  • Fetch/merge: get will always merge a specific commit from the Pull request into the latest base.
  • Metadata: get and put provides information about which commit (SHA) was used from both the PR and base.
  • Webhooks: Does not implement any caching thanks to GraphQL, which means it works well with webhooks.

Make sure to check out #migrating to learn more.

Source Configuration

Parameter Required Example Description
repository Yes itsdalmo/test-repository The repository to target.
access_token Yes A Github Access Token with repository access (required for setting status on commits). N.B. If you want github-pr-resource to work with a private repository. Set repo:full permissions on the access token you create on GitHub. If it is a public repository, repo:status is enough.
v3_endpoint No https://api.github.com Endpoint to use for the V3 Github API (Restful).
v4_endpoint No https://api.github.com/graphql Endpoint to use for the V4 Github API (Graphql).
paths No terraform/*/*.tf Only produce new versions if the PR includes changes to files that match one or more glob patterns or prefixes.
ignore_paths No .ci/ Inverse of the above. Pattern syntax is documented in filepath.Match, or a path prefix can be specified (e.g. .ci/ will match everything in the .ci directory).
disable_ci_skip No true Disable ability to skip builds with [ci skip] and [skip ci] in commit message or pull request title.
skip_ssl_verification No true Disable SSL/TLS certificate validation on git and API clients. Use with care!
disable_forks No true Disable triggering of the resource if the pull request's fork repository is different to the configured repository.
git_crypt_key No AEdJVENSWVBUS0VZAAAAA... Base64 encoded git-crypt key. Setting this will unlock / decrypt the repository with git-crypt. To get the key simply execute `git-crypt export-key -- -
base_branch No master Name of a branch. The pipeline will only trigger on pull requests against the specified branch.

Notes:

Behaviour

check

Produces new versions for all commits (after the last version) ordered by the committed date. A version is represented as follows:

  • pr: The pull request number.
  • commit: The commit SHA.
  • committed: Timestamp of when the commit was committed. Used to filter subsequent checks.

If several commits are pushed to a given PR at the same time, the last commit will be the new version.

Note on webhooks: This resource does not implement any caching, so it should work well with webhooks (should be subscribed to push and pull_request events). One thing to keep in mind however, is that pull requests that are opened from a fork and commits to said fork will not generate notifications over the webhook. So if you have a repository with little traffic and expect pull requests from forks, you'll need to discover those versions with check_every: 1m for instance. check in this resource is not a costly operation, so normally you should not have to worry about the rate limit.

get
Parameter Required Example Description
skip_download No true Use with get_params in a put step to do nothing on the implicit get.
integration_tool No rebase The integration tool to use, merge, rebase or checkout. Defaults to merge.
git_depth No 1 Shallow clone the repository using the --depth Git option

Clones the base (e.g. master branch) at the latest commit, and merges the pull request at the specified commit into master. This ensures that we are both testing and setting status on the exact commit that was requested in input. Because the base of the PR is not locked to a specific commit in versions emitted from check, a fresh get will always use the latest commit in master and report the SHA of said commit in the metadata. Both the requested version and the metadata emitted by get are available to your tasks as JSON:

  • .git/resource/version.json
  • .git/resource/metadata.json

The information in metadata.json is also available as individual files in the .git/resource directory, e.g. the base_sha is available as .git/resource/base_sha. For a complete list of available (individual) metadata files, please check the code here.

When specifying skip_download the pull request volume mounted to subsequent tasks will be empty, which is a problem when you set e.g. the pending status before running the actual tests. The workaround for this is to use an alias for the put (see https://github.com/telia-oss/github-pr-resource/issues/32 for more details).

git-crypt encrypted repositories will automatically be decrypted when the git_crypt_key is set in the source configuration.

put: update-status <-- Use an alias for the pull-request resource
resource: pull-request
params:
    path: pull-request
    status: pending
get_params: {skip_download: true}

Note that, should you retrigger a build in the hopes of testing the last commit to a PR against a newer version of the base, Concourse will reuse the volume (i.e. not trigger a new get) if it still exists, which can produce unexpected results (#5). As such, re-testing a PR against a newer version of the base is best done by pushing an empty commit to the PR.

put
Parameter Required Example Description
path Yes pull-request The name given to the resource in a GET step.
status No SUCCESS Set a status on a commit. One of SUCCESS, PENDING, FAILURE and ERROR.
base_context No concourse-ci Base context (prefix) used for the status context. Defaults to concourse-ci.
context No unit-test A context to use for the status, which is prefixed by base_context. Defaults to status.
comment No hello world! A comment to add to the pull request.
comment_file No my-output/comment.txt Path to file containing a comment to add to the pull request (e.g. output of terraform plan).
target_url No $ATC_DEFAULT_URL/builds/$BUILD_ID The target URL for the status, where users are sent when clicking details (defaults to the Concourse build page).
description No Concourse CI build failed The description status on the specified pull request.

Note that comment, comment_file and target_url will all expand environment variables, so in the examples above $ATC_DEFAULT_URL will be replaced by the public URL of the Concourse ATCs. See https://concourse-ci.org/implementing-resource-types.html#resource-metadata for more details about metadata that is available via environment variables.

Example

resource_types:
- name: pull-request
  type: docker-image
  source:
    repository: teliaoss/github-pr-resource

resources:
- name: pull-request
  type: pull-request
  check_every: 24h
  webhook_token: ((webhook-token))
  source:
    repository: itsdalmo/test-repository
    access_token: ((github-access-token))

jobs:
- name: test
  plan:
  - get: pull-request
    trigger: true
    version: every
  - put: pull-request
    params:
      path: pull-request
      status: pending
  - task: unit-test
    config:
      platform: linux
      image_resource:
        type: docker-image
        source: {repository: alpine/git, tag: "latest"}
      inputs:
        - name: pull-request
      run:
        path: /bin/sh
        args:
          - -xce
          - |
            cd pull-request
            git log --graph --all --color --pretty=format:"%x1b[31m%h%x09%x1b[32m%d%x1b[0m%x20%s" > log.txt
            cat log.txt
    on_failure:
      put: pull-request
      params:
        path: pull-request
        status: failure
  - put: pull-request
    params:
      path: pull-request
      status: success

Costs

The Github API(s) have a rate limit of 5000 requests per hour (per user). This resource will incur the following costs:

  • check: Minimum 1, max 1 per 100th open pull request.
  • in: Fixed cost of 1. Fetches the pull request at the given commit.
  • out: Minimum 1, max 3 (1 for each of status, comment and comment_file).

E.g., typical use for a repository with 125 open pull requests will incur the following costs for every commit:

  • check: 2 (paginate 125 PR's with 100 per page)
  • in: 1 (fetch the pull request at the given commit ref)
  • out: 1 (set status on the commit)

With a rate limit of 5000 per hour, it could handle 1250 commits between all of the 125 open pull requests in the span of that hour.

Migrating

If you are coming from jtarchie/github-pullrequest-resource, its important to know that this resource is inspired by but not a drop-in replacement for the original. Here are some important differences:

New parameters:
  • source:
    • v4_endpoint (see description above)
  • put:
    • comment (see description above)
Parameters that have been renamed:
  • source:
    • repo -> repository
    • ci_skip -> disable_ci_skip (the logic has been inverted and its true by default)
    • api_endpoint -> v3_endpoint
    • base -> base_branch
    • base_url -> target_url
  • get:
    • git.depth -> git_depth
  • put:
    • comment -> comment_file (because we added comment)
Parameters that are no longer needed:
  • src:
    • uri: We fetch the URI directly from the Github API instead.
    • private_key: We clone over HTTPS using the access token for authentication.
    • username: Same as above
    • password: Same as above
    • only_mergeable: We are opinionated and simply fail to get if it does not merge.
  • get:
    • fetch_merge: We are opinionated and always do a fetch_merge.
Parameters that did not make it:
  • src:
    • require_review_approval
    • authorship_restriction
    • label
    • git_config: You can now get the pr/author info from .git/resource/metadata.json instead
  • get:
    • git.* (with the exception of git_depth, see above)
  • put:
    • merge.*
    • label

Note that if you are migrating from the original resource on a Concourse version prior to v5.0.0, you might see an error failed to unmarshal request: json: unknown field "ref". The solution is to rename the resource so that the history is wiped. See #64 for details.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ContainsSkipCI 

func ContainsSkipCI(s string) bool

ContainsSkipCI returns true if a string contains [ci skip] or [skip ci].

func FilterIgnorePath 

func FilterIgnorePath(files []string, pattern string) ([]string, error)

FilterIgnorePath ...

func FilterPath 

func FilterPath(files []string, pattern string) ([]string, error)

FilterPath ...

func IsInsidePath added in v0.10.0 

func IsInsidePath(parent, child string) bool

IsInsidePath checks whether the child path is inside the parent path.

/foo/bar is inside /foo, but /foobar is not inside /foo. /foo is inside /foo, but /foo is not inside /foo/

Types

type CheckRequest 

type CheckRequest struct {
	Source  Source  `json:"source"`
	Version Version `json:"version"`
}

CheckRequest ...

type CheckResponse 

type CheckResponse []Version

CheckResponse ...

func Check 

func Check(request CheckRequest, manager Github) (CheckResponse, error)

Check (business logic)

func (CheckResponse) Len 

func (r CheckResponse) Len() int

func (CheckResponse) Less 

func (r CheckResponse) Less(i, j int) bool

func (CheckResponse) Swap 

func (r CheckResponse) Swap(i, j int)

type CommitObject 

type CommitObject struct {
	ID            string
	OID           string
	CommittedDate githubv4.DateTime
	Message       string
	Author        struct {
		User struct {
			Login string
		}
	}
}

CommitObject represents the GraphQL commit node. https://developer.github.com/v4/object/commit/

type GetParameters 

type GetParameters struct {
	SkipDownload    bool   `json:"skip_download"`
	IntegrationTool string `json:"integration_tool"`
	GitDepth        int    `json:"git_depth"`
}

GetParameters ...

type GetRequest 

type GetRequest struct {
	Source  Source        `json:"source"`
	Version Version       `json:"version"`
	Params  GetParameters `json:"params"`
}

GetRequest ...

type GetResponse 

type GetResponse struct {
	Version  Version  `json:"version"`
	Metadata Metadata `json:"metadata,omitempty"`
}

GetResponse ...

func Get 

func Get(request GetRequest, github Github, git Git, outputDir string) (*GetResponse, error)

Get (business logic)

type Git 

type Git interface {
	Init(string) error
	Pull(string, string, int) error
	RevParse(string) (string, error)
	Fetch(string, int, int) error
	Checkout(string, string) error
	Merge(string) error
	Rebase(string, string) error
	GitCryptUnlock(string) error
}

Git interface for testing purposes.

type GitClient 

type GitClient struct {
	AccessToken string
	Directory   string
	Output      io.Writer
}

GitClient ...

func NewGitClient 

func NewGitClient(source *Source, dir string, output io.Writer) (*GitClient, error)

NewGitClient ...

func (*GitClient) Checkout 

func (g *GitClient) Checkout(branch, sha string) error

CheckOut

func (*GitClient) Endpoint 

func (g *GitClient) Endpoint(uri string) (string, error)

Endpoint takes an uri and produces an endpoint with the login information baked in.

func (*GitClient) Fetch 

func (g *GitClient) Fetch(uri string, prNumber int, depth int) error

Fetch ...

func (*GitClient) GitCryptUnlock added in v0.12.0 

func (g *GitClient) GitCryptUnlock(base64key string) error

GitCryptUnlock unlocks the repository using git-crypt

func (*GitClient) Init 

func (g *GitClient) Init(branch string) error

Init ...

func (*GitClient) Merge 

func (g *GitClient) Merge(sha string) error

Merge ...

func (*GitClient) Pull 

func (g *GitClient) Pull(uri, branch string, depth int) error

Pull ...

func (*GitClient) Rebase added in v0.14.0 

func (g *GitClient) Rebase(baseRef string, headSha string) error

Rebase ...

func (*GitClient) RevParse 

func (g *GitClient) RevParse(branch string) (string, error)

RevParse retrieves the SHA of the given branch.

type Github 

type Github interface {
	ListOpenPullRequests() ([]*PullRequest, error)
	ListModifiedFiles(int) ([]string, error)
	PostComment(string, string) error
	GetPullRequest(string, string) (*PullRequest, error)
	UpdateCommitStatus(string, string, string, string, string, string) error
}

Github for testing purposes.

type GithubClient 

type GithubClient struct {
	V3         *github.Client
	V4         *githubv4.Client
	Repository string
	Owner      string
}

GithubClient for handling requests to the Github V3 and V4 APIs.

func NewGithubClient 

func NewGithubClient(s *Source) (*GithubClient, error)

NewGithubClient ...

func (*GithubClient) GetPullRequest added in v0.5.0 

func (m *GithubClient) GetPullRequest(prNumber, commitRef string) (*PullRequest, error)

GetPullRequest ...

func (*GithubClient) ListModifiedFiles 

func (m *GithubClient) ListModifiedFiles(prNumber int) ([]string, error)

ListModifiedFiles in a pull request (not supported by V4 API).

func (*GithubClient) ListOpenPullRequests 

func (m *GithubClient) ListOpenPullRequests() ([]*PullRequest, error)

ListOpenPullRequests gets the last commit on all open pull requests.

func (*GithubClient) PostComment 

func (m *GithubClient) PostComment(prNumber, comment string) error

PostComment to a pull request or issue.

func (*GithubClient) UpdateCommitStatus 

func (m *GithubClient) UpdateCommitStatus(commitRef, baseContext, statusContext, status, targetURL, description string) error

UpdateCommitStatus for a given commit (not supported by V4 API).

type Metadata 

type Metadata []*MetadataField

Metadata output from get/put steps.

func (*Metadata) Add 

func (m *Metadata) Add(name, value string)

Add a MetadataField to the Metadata.

type MetadataField 

type MetadataField struct {
	Name  string `json:"name"`
	Value string `json:"value"`
}

MetadataField ...

type PullRequest 

type PullRequest struct {
	PullRequestObject
	Tip CommitObject
}

PullRequest represents a pull request and includes the tip (commit).

type PullRequestObject 

type PullRequestObject struct {
	ID          string
	Number      int
	Title       string
	URL         string
	BaseRefName string
	HeadRefName string
	Repository  struct {
		URL string
	}
	IsCrossRepository bool
}

PullRequestObject represents the GraphQL commit node. https://developer.github.com/v4/object/pullrequest/

type PutParameters 

type PutParameters struct {
	Path        string `json:"path"`
	BaseContext string `json:"base_context"`
	Context     string `json:"context"`
	TargetURL   string `json:"target_url"`
	Description string `json:"description"`
	Status      string `json:"status"`
	CommentFile string `json:"comment_file"`
	Comment     string `json:"comment"`
}

PutParameters for the resource.

func (*PutParameters) Validate 

func (p *PutParameters) Validate() error

Validate the put parameters.

type PutRequest 

type PutRequest struct {
	Source Source        `json:"source"`
	Params PutParameters `json:"params"`
}

PutRequest ...

type PutResponse 

type PutResponse struct {
	Version  Version  `json:"version"`
	Metadata Metadata `json:"metadata,omitempty"`
}

PutResponse ...

func Put 

func Put(request PutRequest, manager Github, inputDir string) (*PutResponse, error)

Put (business logic)

type Source 

type Source struct {
	Repository          string   `json:"repository"`
	AccessToken         string   `json:"access_token"`
	V3Endpoint          string   `json:"v3_endpoint"`
	V4Endpoint          string   `json:"v4_endpoint"`
	Paths               []string `json:"paths"`
	IgnorePaths         []string `json:"ignore_paths"`
	DisableCISkip       bool     `json:"disable_ci_skip"`
	SkipSSLVerification bool     `json:"skip_ssl_verification"`
	DisableForks        bool     `json:"disable_forks"`
	GitCryptKey         string   `json:"git_crypt_key"`
	BaseBranch          string   `json:"base_branch"`
}

Source represents the configuration for the resource.

func (*Source) Validate 

func (s *Source) Validate() error

Validate the source configuration.

type Version 

type Version struct {
	PR            string    `json:"pr"`
	Commit        string    `json:"commit"`
	CommittedDate time.Time `json:"committed,omitempty"`
}

Version communicated with Concourse.

func NewVersion 

func NewVersion(p *PullRequest) Version

NewVersion constructs a new Version.

Source Files

View all Source files

Directories

Path Synopsis
cmd
check
in
out
Code generated by counterfeiter.
 Code generated by counterfeiter.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.