Nikola Knezevic
f03e7ef800
This plugin is a counterpart to GithubPulls plugin. Instead of fetching pull requests, it will fetch all references (branches and tags) that start with a particular prefix. The plugin is a copy of GithubPulls plugin with appropriate changes to call the right API and parse the config matching the need.
125 lines
4.4 KiB
Perl
125 lines
4.4 KiB
Perl
package Hydra::Plugin::GithubRefs;
|
|
|
|
use strict;
|
|
use parent 'Hydra::Plugin';
|
|
use HTTP::Request;
|
|
use LWP::UserAgent;
|
|
use JSON;
|
|
use Hydra::Helper::CatalystUtils;
|
|
use File::Temp;
|
|
use POSIX qw(strftime);
|
|
|
|
=head1 NAME
|
|
|
|
GithubRefs - Hydra plugin for retrieving the list of references (branches or
|
|
tags) from GitHub following a certain naming scheme
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
This plugin reads the list of branches or tags using GitHub's REST API. The name
|
|
of the reference must follow a particular prefix. This list is stored in the
|
|
nix-store and used as an input to declarative jobsets.
|
|
|
|
=head1 CONFIGURATION
|
|
|
|
The plugin doesn't require any dedicated configuration block, but it has to
|
|
consult C<github_authorization> entry for obtaining the API token. In addition,
|
|
if C<github_endpoint> entry is present in the configuration, it will be used
|
|
instead of the default C<https://api.github.com>. This entry is useful when
|
|
dealing with GitHub Enterprise.
|
|
|
|
The declarative project C<spec.json> file must contains an input such as
|
|
|
|
"pulls": {
|
|
"type": "github_refs",
|
|
"value": "[owner] [repo] heads|tags - [prefix]",
|
|
"emailresponsible": false
|
|
}
|
|
|
|
In the above snippet, C<[owner]> is the repository owner and C<[repo]> is the
|
|
repository name. Also note a literal C<->, which is placed there for the future
|
|
use.
|
|
|
|
C<heads|tags> denotes that one of these two is allowed, that is, the third
|
|
position should hold either the C<heads> or the C<tags> keyword. In case of the former, the plugin
|
|
will fetch all branches, while in case of the latter, it will fetch the tags.
|
|
|
|
C<prefix> denotes the prefix the reference name must start with, in order to be
|
|
included.
|
|
|
|
For example, C<"value": "nixos hydra heads - release/"> refers to
|
|
L<https://github.com/nixos/hydra> repository, and will fetch all branches that
|
|
begin with C<release/>.
|
|
|
|
=head1 USE
|
|
|
|
The result is stored in the nix-store as a JSON I<map>, where the key is the
|
|
name of the reference, while the value is the complete GitHub response. Thus,
|
|
any of the values listed in
|
|
L<https://developer.github.com/v3/git/refs/#list-matching-references> can be
|
|
used to build the git input value in C<jobsets.nix>.
|
|
|
|
=cut
|
|
|
|
sub supportedInputTypes {
|
|
my ($self, $inputTypes) = @_;
|
|
$inputTypes->{'github_refs'} = 'Open GitHub Refs';
|
|
}
|
|
|
|
sub _iterate {
|
|
my ($url, $auth, $refs, $ua) = @_;
|
|
my $req = HTTP::Request->new('GET', $url);
|
|
$req->header('Accept' => 'application/vnd.github.v3+json');
|
|
$req->header('Authorization' => $auth) if defined $auth;
|
|
my $res = $ua->request($req);
|
|
my $content = $res->decoded_content;
|
|
die "Error pulling from the github refs API: $content\n"
|
|
unless $res->is_success;
|
|
my $refs_list = decode_json $content;
|
|
# TODO Stream out the json instead
|
|
foreach my $ref (@$refs_list) {
|
|
my $ref_name = $ref->{ref};
|
|
$ref_name =~ s,^refs/(?:heads|tags)/,,o;
|
|
$refs->{$ref_name} = $ref;
|
|
}
|
|
# TODO Make Link header parsing more robust!!!
|
|
my @links = split ',', $res->header("Link");
|
|
my $next = "";
|
|
foreach my $link (@links) {
|
|
my ($url, $rel) = split ";", $link;
|
|
if (trim($rel) eq 'rel="next"') {
|
|
$next = substr trim($url), 1, -1;
|
|
last;
|
|
}
|
|
}
|
|
_iterate($next, $auth, $refs, $ua) unless $next eq "";
|
|
}
|
|
|
|
sub fetchInput {
|
|
my ($self, $type, $name, $value, $project, $jobset) = @_;
|
|
return undef if $type ne "github_refs";
|
|
|
|
my ($owner, $repo, $type, $fut, $prefix) = split ' ', $value;
|
|
die "type field is neither 'heads' nor 'tags', but '$type'"
|
|
unless $type eq 'heads' or $type eq 'tags';
|
|
|
|
my $auth = $self->{config}->{github_authorization}->{$owner};
|
|
my $githubEndpoint = $self->{config}->{github_endpoint} // "https://api.github.com";
|
|
my %refs;
|
|
my $ua = LWP::UserAgent->new();
|
|
_iterate("$githubEndpoint/repos/$owner/$repo/git/matching-refs/$type/$prefix?per_page=100", $auth, \%refs, $ua);
|
|
my $tempdir = File::Temp->newdir("github-refs" . "XXXXX", TMPDIR => 1);
|
|
my $filename = "$tempdir/github-refs.json";
|
|
open(my $fh, ">", $filename) or die "Cannot open $filename for writing: $!";
|
|
print $fh encode_json \%refs;
|
|
close $fh;
|
|
system("jq -S . < $filename > $tempdir/github-refs-sorted.json");
|
|
my $storePath = trim(qx{nix-store --add "$tempdir/github-refs-sorted.json"}
|
|
or die "cannot copy path $filename to the Nix store.\n");
|
|
chomp $storePath;
|
|
my $timestamp = time;
|
|
return { storePath => $storePath, revision => strftime "%Y%m%d%H%M%S", gmtime($timestamp) };
|
|
}
|
|
|
|
1;
|