Skip to content

Commit

Permalink
Merge pull request #583 from DingGGu/feature/support-ghcr
Browse files Browse the repository at this point in the history 
Support Github Container Registry
  • Loading branch information
@rusenask
rusenask committed Feb 26, 2021
2 parents 3959617 + 7a05390 commit 9d6f128
Show file tree
Hide file tree
Showing 2 changed files with 252 additions and 232 deletions.
346 changes: 117 additions & 229 deletions pkg/http/github_webhook_trigger.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,12 @@ package http
import (
"encoding/json"
"fmt"
"github.com/keel-hq/keel/types"
"github.com/prometheus/client_golang/prometheus"
"net/http"
"strings"
"time"

"github.com/keel-hq/keel/types"

"github.com/prometheus/client_golang/prometheus"

log "github.com/sirupsen/logrus"
)

Expand All @@ -26,249 +24,139 @@ func init() {
prometheus.MustRegister(newGithubWebhooksCounter)
}

type githubWebhook struct {
type githubRegistryPackageWebhook struct {
Action string `json:"action"`
RegistryPackage struct {
CreatedAt string `json:"created_at"`
HTMLURL string `json:"html_url"`
ID int `json:"id"`
Name string `json:"name"`
Owner struct {
AvatarURL string `json:"avatar_url"`
EventsURL string `json:"events_url"`
FollowersURL string `json:"followers_url"`
FollowingURL string `json:"following_url"`
GistsURL string `json:"gists_url"`
GravatarID string `json:"gravatar_id"`
HTMLURL string `json:"html_url"`
ID int `json:"id"`
Login string `json:"login"`
NodeID string `json:"node_id"`
OrganizationsURL string `json:"organizations_url"`
ReceivedEventsURL string `json:"received_events_url"`
ReposURL string `json:"repos_url"`
SiteAdmin bool `json:"site_admin"`
StarredURL string `json:"starred_url"`
SubscriptionsURL string `json:"subscriptions_url"`
Type string `json:"type"`
URL string `json:"url"`
} `json:"owner"`
Name string `json:"name"`
PackageType string `json:"package_type"`
PackageVersion struct {
Author struct {
AvatarURL string `json:"avatar_url"`
EventsURL string `json:"events_url"`
FollowersURL string `json:"followers_url"`
FollowingURL string `json:"following_url"`
GistsURL string `json:"gists_url"`
GravatarID string `json:"gravatar_id"`
HTMLURL string `json:"html_url"`
ID int `json:"id"`
Login string `json:"login"`
NodeID string `json:"node_id"`
OrganizationsURL string `json:"organizations_url"`
ReceivedEventsURL string `json:"received_events_url"`
ReposURL string `json:"repos_url"`
SiteAdmin bool `json:"site_admin"`
StarredURL string `json:"starred_url"`
SubscriptionsURL string `json:"subscriptions_url"`
Type string `json:"type"`
URL string `json:"url"`
} `json:"author"`
Body string `json:"body"`
BodyHTML string `json:"body_html"`
CreatedAt string `json:"created_at"`
HTMLURL string `json:"html_url"`
ID int `json:"id"`
InstallationCommand string `json:"installation_command"`
Manifest string `json:"manifest"`
Metadata []interface{} `json:"metadata"`
PackageFiles []struct {
ContentType string `json:"content_type"`
CreatedAt string `json:"created_at"`
DownloadURL string `json:"download_url"`
ID int `json:"id"`
Md5 interface{} `json:"md5"`
Name string `json:"name"`
Sha1 interface{} `json:"sha1"`
Sha256 string `json:"sha256"`
Size int `json:"size"`
State string `json:"state"`
UpdatedAt string `json:"updated_at"`
} `json:"package_files"`
Summary string `json:"summary"`
TargetCommitish string `json:"target_commitish"`
TargetOid string `json:"target_oid"`
UpdatedAt string `json:"updated_at"`
Version string `json:"version"`
Version string `json:"version"`
} `json:"package_version"`
Registry struct {
AboutURL string `json:"about_url"`
Name string `json:"name"`
Type string `json:"type"`
URL string `json:"url"`
Vendor string `json:"vendor"`
} `json:"registry"`
UpdatedAt string `json:"updated_at"`
} `json:"registry_package"`
Repository struct {
ArchiveURL string `json:"archive_url"`
Archived bool `json:"archived"`
AssigneesURL string `json:"assignees_url"`
BlobsURL string `json:"blobs_url"`
BranchesURL string `json:"branches_url"`
CloneURL string `json:"clone_url"`
CollaboratorsURL string `json:"collaborators_url"`
CommentsURL string `json:"comments_url"`
CommitsURL string `json:"commits_url"`
CompareURL string `json:"compare_url"`
ContentsURL string `json:"contents_url"`
ContributorsURL string `json:"contributors_url"`
CreatedAt string `json:"created_at"`
DefaultBranch string `json:"default_branch"`
DeploymentsURL string `json:"deployments_url"`
Description string `json:"description"`
Disabled bool `json:"disabled"`
DownloadsURL string `json:"downloads_url"`
EventsURL string `json:"events_url"`
Fork bool `json:"fork"`
Forks int `json:"forks"`
ForksCount int `json:"forks_count"`
ForksURL string `json:"forks_url"`
FullName string `json:"full_name"`
GitCommitsURL string `json:"git_commits_url"`
GitRefsURL string `json:"git_refs_url"`
GitTagsURL string `json:"git_tags_url"`
GitURL string `json:"git_url"`
HasDownloads bool `json:"has_downloads"`
HasIssues bool `json:"has_issues"`
HasPages bool `json:"has_pages"`
HasProjects bool `json:"has_projects"`
HasWiki bool `json:"has_wiki"`
Homepage string `json:"homepage"`
HooksURL string `json:"hooks_url"`
HTMLURL string `json:"html_url"`
ID int `json:"id"`
IssueCommentURL string `json:"issue_comment_url"`
IssueEventsURL string `json:"issue_events_url"`
IssuesURL string `json:"issues_url"`
KeysURL string `json:"keys_url"`
LabelsURL string `json:"labels_url"`
Language string `json:"language"`
LanguagesURL string `json:"languages_url"`
License interface{} `json:"license"`
MergesURL string `json:"merges_url"`
MilestonesURL string `json:"milestones_url"`
MirrorURL interface{} `json:"mirror_url"`
Name string `json:"name"`
NodeID string `json:"node_id"`
NotificationsURL string `json:"notifications_url"`
OpenIssues int `json:"open_issues"`
OpenIssuesCount int `json:"open_issues_count"`
Owner struct {
AvatarURL string `json:"avatar_url"`
EventsURL string `json:"events_url"`
FollowersURL string `json:"followers_url"`
FollowingURL string `json:"following_url"`
GistsURL string `json:"gists_url"`
GravatarID string `json:"gravatar_id"`
HTMLURL string `json:"html_url"`
ID int `json:"id"`
Login string `json:"login"`
NodeID string `json:"node_id"`
OrganizationsURL string `json:"organizations_url"`
ReceivedEventsURL string `json:"received_events_url"`
ReposURL string `json:"repos_url"`
SiteAdmin bool `json:"site_admin"`
StarredURL string `json:"starred_url"`
SubscriptionsURL string `json:"subscriptions_url"`
Type string `json:"type"`
URL string `json:"url"`
} `json:"owner"`
Private bool `json:"private"`
PullsURL string `json:"pulls_url"`
PushedAt string `json:"pushed_at"`
ReleasesURL string `json:"releases_url"`
Size int `json:"size"`
SSHURL string `json:"ssh_url"`
StargazersCount int `json:"stargazers_count"`
StargazersURL string `json:"stargazers_url"`
StatusesURL string `json:"statuses_url"`
SubscribersURL string `json:"subscribers_url"`
SubscriptionURL string `json:"subscription_url"`
SvnURL string `json:"svn_url"`
TagsURL string `json:"tags_url"`
TeamsURL string `json:"teams_url"`
TreesURL string `json:"trees_url"`
UpdatedAt string `json:"updated_at"`
URL string `json:"url"`
Watchers int `json:"watchers"`
WatchersCount int `json:"watchers_count"`
FullName string `json:"full_name"`
} `json:"repository"`
Sender struct {
AvatarURL string `json:"avatar_url"`
EventsURL string `json:"events_url"`
FollowersURL string `json:"followers_url"`
FollowingURL string `json:"following_url"`
GistsURL string `json:"gists_url"`
GravatarID string `json:"gravatar_id"`
HTMLURL string `json:"html_url"`
ID int `json:"id"`
Login string `json:"login"`
NodeID string `json:"node_id"`
OrganizationsURL string `json:"organizations_url"`
ReceivedEventsURL string `json:"received_events_url"`
ReposURL string `json:"repos_url"`
SiteAdmin bool `json:"site_admin"`
StarredURL string `json:"starred_url"`
SubscriptionsURL string `json:"subscriptions_url"`
Type string `json:"type"`
URL string `json:"url"`
} `json:"sender"`
}

type githubPackageV2Webhook struct {
Action string `json:"action"`
Package struct {
Id int `json:"id"`
Name string `json:"name"`
Namespace string `json:"namespace"`
Ecosystem string `json:"ecosystem"`
PackageVersion struct {
Name string `json:"name"`
ContainerMetadata struct {
Tag struct {
Name string `json:"name"`
Digest string `json:"digest"`
} `json:"tag"`
} `json:"container_metadata"`
} `json:"package_version"`
} `json:"package"`
}

// githubHandler - used to react to github webhooks
func (s *TriggerServer) githubHandler(resp http.ResponseWriter, req *http.Request) {
gw := githubWebhook{}
if err := json.NewDecoder(req.Body).Decode(&gw); err != nil {
log.WithFields(log.Fields{
"error": err,
}).Error("trigger.githubHandler: failed to decode request")
resp.WriteHeader(http.StatusBadRequest)
return
}

if gw.RegistryPackage.PackageType != "docker" {
resp.WriteHeader(http.StatusBadRequest)
fmt.Fprintf(resp, "registry package type was not docker")
}

if gw.Repository.FullName == "" { // github package name
resp.WriteHeader(http.StatusBadRequest)
fmt.Fprintf(resp, "repository full name cannot be empty")
return
}

if gw.RegistryPackage.Name == "" { // github package name
resp.WriteHeader(http.StatusBadRequest)
fmt.Fprintf(resp, "repository package name cannot be empty")
return
}

if gw.RegistryPackage.PackageVersion.Version == "" { // tag
resp.WriteHeader(http.StatusBadRequest)
fmt.Fprintf(resp, "repository tag cannot be empty")
return
// GitHub provides different webhook events for each registry.
// Github Package uses 'registry_package'
// Github Container Registry uses 'package_v2'
// events can be classified as 'X-GitHub-Event' in Request Header.
hookEvent := req.Header.Get("X-GitHub-Event")

var imageName, imageTag string

switch hookEvent {
case "package_v2":
payload := new(githubPackageV2Webhook)
if err := json.NewDecoder(req.Body).Decode(payload); err != nil {
log.WithFields(log.Fields{
"error": err,
}).Error("trigger.githubHandler: failed to decode request")
resp.WriteHeader(http.StatusBadRequest)
return
}

if payload.Package.Ecosystem != "CONTAINER" {
resp.WriteHeader(http.StatusBadRequest)
fmt.Fprintf(resp, "registry package type was not container")
}

if payload.Package.Name == "" { // github package name
resp.WriteHeader(http.StatusBadRequest)
fmt.Fprintf(resp, "repository name cannot be empty")
return
}

if payload.Package.Namespace == "" { // github package org
resp.WriteHeader(http.StatusBadRequest)
fmt.Fprintf(resp, "repository namespace cannot be empty")
return
}

if payload.Package.PackageVersion.ContainerMetadata.Tag.Name == "" { // tag
resp.WriteHeader(http.StatusBadRequest)
fmt.Fprintf(resp, "repository tag cannot be empty")
return
}

imageName = strings.Join(
[]string{"ghcr.io", payload.Package.Namespace, payload.Package.Name},
"/",
)
imageTag = payload.Package.PackageVersion.ContainerMetadata.Tag.Name

break

case "registry_package":
payload := new(githubRegistryPackageWebhook)
if err := json.NewDecoder(req.Body).Decode(payload); err != nil {
log.WithFields(log.Fields{
"error": err,
}).Error("trigger.githubHandler: failed to decode request")
resp.WriteHeader(http.StatusBadRequest)
return
}

if payload.RegistryPackage.PackageType != "docker" {
resp.WriteHeader(http.StatusBadRequest)
fmt.Fprintf(resp, "registry package type was not docker")
}

if payload.Repository.FullName == "" { // github package name
resp.WriteHeader(http.StatusBadRequest)
fmt.Fprintf(resp, "repository full name cannot be empty")
return
}

if payload.RegistryPackage.Name == "" { // github package name
resp.WriteHeader(http.StatusBadRequest)
fmt.Fprintf(resp, "repository package name cannot be empty")
return
}

if payload.RegistryPackage.PackageVersion.Version == "" { // tag
resp.WriteHeader(http.StatusBadRequest)
fmt.Fprintf(resp, "repository tag cannot be empty")
return
}

imageName = strings.Join(
[]string{"docker.pkg.github.com", payload.Repository.FullName, payload.RegistryPackage.Name},
"/",
)
imageTag = payload.RegistryPackage.PackageVersion.Version

break
}

event := types.Event{}
event.CreatedAt = time.Now()
event.TriggerName = "github"
event.Repository.Name = strings.Join(
[]string{"docker.pkg.github.com", gw.Repository.FullName, gw.RegistryPackage.Name},
"/",
)
event.Repository.Tag = gw.RegistryPackage.PackageVersion.Version
event.Repository.Name = imageName
event.Repository.Tag = imageTag

s.trigger(event)

Expand Down
Loading

0 comments on commit 9d6f128

Please sign in to comment.