Merge pull request #107 from zrochler/gitlab-job-hook-build-payload

Add handling for job hooks with build payloads

.golangci.yml

@@ -0,0 +1,16 @@
+run:
+  tests: false
+  skip-dirs:
+    - _examples
+
+linters:
+  enable:
+    - vet
+    - vetshadow
+    - golint
+    - megacheck
+    - ineffassign
+    - misspell
+    - errcheck
+    - goconst
+    - gofmt

.travis.yml

@@ -13,23 +13,16 @@ notifications:
     on_failure: always
 
 before_install:
-  - go get -u github.com/go-playground/overalls
   - go get -u github.com/mattn/goveralls
-  - go get -u golang.org/x/tools/cmd/cover
-  - mkdir -p $GOPATH/src/gopkg.in
-  - ln -s $GOPATH/src/github.com/$TRAVIS_REPO_SLUG $GOPATH/src/gopkg.in/webhooks.v2
-  - ln -s $GOPATH/src/github.com/$TRAVIS_REPO_SLUG $GOPATH/src/gopkg.in/webhooks.v3
-  - ln -s $GOPATH/src/github.com/$TRAVIS_REPO_SLUG $GOPATH/src/gopkg.in/webhooks.v4
-  - ln -s $GOPATH/src/github.com/$TRAVIS_REPO_SLUG $GOPATH/src/gopkg.in/webhooks.v5
-  - ln -s $GOPATH/src/github.com/$TRAVIS_REPO_SLUG $GOPATH/src/gopkg.in/webhooks.v6
 
 before_script:
-  - go get -t ./...
+  - go mod download
 
 script:
+  - make lint
   - make test
 
 after_success: |
   [ $TRAVIS_GO_VERSION = 1.15.6 ] &&
-  overalls -project="github.com/go-playground/webhooks" -covermode=count -ignore=.git,_examples,testdata -debug &&
-  goveralls -coverprofile=overalls.coverprofile -service travis-ci -repotoken $COVERALLS_TOKEN
+  go test ./... -covermode=count -coverprofile=coverage.out &&
+  goveralls -coverprofile=coverage.out -service travis-ci -repotoken $COVERALLS_TOKEN

Makefile

@@ -1,17 +1,17 @@
-GOCMD=go
+GOPATH=$(shell go env GOPATH)
 
 linters-install:
-	@gometalinter --version >/dev/null 2>&1 || { \
-		echo "installing linting tools..."; \
-		$(GOCMD) get github.com/alecthomas/gometalinter; \
-		gometalinter --install; \
+	@echo "+ $@"
+	@$(GOPATH)/bin/golangci-lint --version >/dev/null 2>&1 || { \
+  		echo "Install golangci-lint..."; \
+		curl -sfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(GOPATH)/bin; \
 	}
 
 lint: linters-install
-	@gofmt -l . >gofmt.test 2>&1 && if [ -s gofmt.test ]; then echo "Fix formatting using 'gofmt -s -w .' for:"; cat gofmt.test; exit 1; fi && rm gofmt.test
-	gometalinter --vendor --disable-all --enable=vet --enable=vetshadow --enable=golint --enable=megacheck --enable=ineffassign --enable=misspell --enable=errcheck --enable=goconst ./...
+	@echo "+ $@"
+	$(GOPATH)/bin/golangci-lint run ./...
 
 test:
-	$(GOCMD) test -cover -race ./...
+	GO111MODULE=on go test -cover -race ./...
 
-.PHONY: test lint linters-install
+.PHONY: test lint linters-install

README.md

@@ -4,7 +4,7 @@ Library webhooks
 [![Build Status](https://travis-ci.org/go-playground/webhooks.svg?branch=v6)](https://travis-ci.org/go-playground/webhooks)
 [![Coverage Status](https://coveralls.io/repos/go-playground/webhooks/badge.svg?branch=v6&service=github)](https://coveralls.io/github/go-playground/webhooks?branch=v6)
 [![Go Report Card](https://goreportcard.com/badge/go-playground/webhooks)](https://goreportcard.com/report/go-playground/webhooks)
-[![GoDoc](https://godoc.org/gopkg.in/go-playground/webhooks.v6?status.svg)](https://godoc.org/gopkg.in/go-playground/webhooks.v6)
+[![GoDoc](https://godoc.org/github.com/go-playground/webhooks/v6?status.svg)](https://godoc.org/github.com/go-playground/webhooks/v6)
 ![License](https://img.shields.io/dub/l/vibe-d.svg)
 
 Library webhooks allows for easy receiving and parsing of GitHub, Bitbucket and GitLab Webhook Events
@@ -24,17 +24,17 @@ Installation
 Use go get.
 
 ```shell
-go get -u gopkg.in/go-playground/webhooks.v6
+go get -u github.com/go-playground/webhooks/v6
 ```
 
 Then import the package into your own code.
 
-	import "gopkg.in/go-playground/webhooks.v6"
+	import "github.com/go-playground/webhooks/v6"
 
 Usage and Documentation
 ------
 
-Please see http://godoc.org/gopkg.in/go-playground/webhooks.v6 for detailed usage docs.
+Please see http://godoc.org/github.com/go-playground/webhooks/v6 for detailed usage docs.
 
 ##### Examples:
 ```go
@@ -45,7 +45,7 @@ import (
 
 	"net/http"
 
-	"gopkg.in/go-playground/webhooks.v6/github"
+	"github.com/go-playground/webhooks/v6/github"
 )
 
 const (

_examples/multiple-handlers/main.go

@@ -5,7 +5,7 @@ import (
 
 	"net/http"
 
-	"gopkg.in/go-playground/webhooks.v6/github"
+	"github.com/go-playground/webhooks/v6/github"
 )
 
 const (

_examples/single-handler/main.go

@@ -5,7 +5,7 @@ import (
 
 	"net/http"
 
-	"gopkg.in/go-playground/webhooks.v6/github"
+	"github.com/go-playground/webhooks/v6/github"
 )
 
 const (

bitbucket-server/payload.go

@@ -147,7 +147,7 @@ type PullRequestCommentAddedPayload struct {
 	Actor           User        `json:"actor"`
 	PullRequest     PullRequest `json:"pullRequest"`
 	Comment         Comment     `json:"comment"`
-	CommentParentId uint64      `json:"commentParentId,omitempty"`
+	CommentParentID uint64      `json:"commentParentId,omitempty"`
 }
 
 type PullRequestCommentEditedPayload struct {
@@ -156,7 +156,7 @@ type PullRequestCommentEditedPayload struct {
 	Actor           User        `json:"actor"`
 	PullRequest     PullRequest `json:"pullRequest"`
 	Comment         Comment     `json:"comment"`
-	CommentParentId string      `json:"commentParentId,omitempty"`
+	CommentParentID string      `json:"commentParentId,omitempty"`
 	PreviousComment string      `json:"previousComment"`
 }
 
@@ -166,7 +166,7 @@ type PullRequestCommentDeletedPayload struct {
 	Actor           User        `json:"actor"`
 	PullRequest     PullRequest `json:"pullRequest"`
 	Comment         Comment     `json:"comment"`
-	CommentParentId uint64      `json:"commentParentId,omitempty"`
+	CommentParentID uint64      `json:"commentParentId,omitempty"`
 }
 
 // -----------------------
@@ -186,7 +186,7 @@ type Repository struct {
 	ID            uint64                 `json:"id"`
 	Slug          string                 `json:"slug"`
 	Name          string                 `json:"name"`
-	ScmId         string                 `json:"scmId"`
+	ScmID         string                 `json:"scmId"`
 	State         string                 `json:"state"`
 	StatusMessage string                 `json:"statusMessage"`
 	Forkable      bool                   `json:"forkable"`
@@ -229,7 +229,7 @@ type PullRequest struct {
 
 type RepositoryChange struct {
 	Reference   RepositoryReference `json:"ref"`
-	ReferenceId string              `json:"refId"`
+	ReferenceID string              `json:"refId"`
 	FromHash    string              `json:"fromHash"`
 	ToHash      string              `json:"toHash"`
 	Type        string              `json:"type"`
@@ -237,7 +237,7 @@ type RepositoryChange struct {
 
 type RepositoryReference struct {
 	ID           string     `json:"id"`
-	DisplayId    string     `json:"displayId"`
+	DisplayID    string     `json:"displayId"`
 	Type         string     `json:"type,omitempty"`
 	LatestCommit string     `json:"latestCommit,omitempty"`
 	Repository   Repository `json:"repository,omitempty"`

bitbucket/payload.go

@@ -350,7 +350,7 @@ type Owner struct {
 	Type        string `json:"type"`
 	NickName    string `json:"nickname"`
 	DisplayName string `json:"display_name"`
-	AccountId   string `json:"account_id"`
+	AccountID   string `json:"account_id"`
 	UUID        string `json:"uuid"`
 	Links       struct {
 		Self struct {

docker/docker.go

@@ -1,6 +1,6 @@
 package docker
 
-// this package recieves the Docker Hub Automated Build webhook
+// this package receives the Docker Hub Automated Build webhook
 // https://docs.docker.com/docker-hub/webhooks/
 // NOT the Docker Trusted Registry webhook
 // https://docs.docker.com/ee/dtr/user/create-and-manage-webhooks/
@@ -58,7 +58,6 @@ type BuildPayload struct {
 
 // Webhook instance contains all methods needed to process events
 type Webhook struct {
-	secret string
 }
 
 // New creates and returns a WebHook instance

github/payload.go

@@ -13,7 +13,7 @@ type CheckRunPayload struct {
 		Status      string    `json:"status"`
 		Conclusion  string    `json:"conclusion"`
 		URL         string    `json:"url"`
-		HtmlURL     string    `json:"html_url"`
+		HTMLURL     string    `json:"html_url"`
 		StarterAt   time.Time `json:"started_at"`
 		CompletedAt time.Time `json:"completed_at"`
 		Output      struct {
@@ -59,7 +59,7 @@ type CheckRunPayload struct {
 				Name        string `json:"name"`
 				Description string `json:"description"`
 				ExternalURL string `json:"external_url"`
-				HtmlURL     string `json:"html_url"`
+				HTMLURL     string `json:"html_url"`
 				CreatedAt   string `json:"created_at"`
 				UpdatedAt   string `json:"updated_at"`
 			} `json:"app"`
@@ -92,7 +92,7 @@ type CheckRunPayload struct {
 			Name        string `json:"name"`
 			Description string `json:"description"`
 			ExternalURL string `json:"external_url"`
-			HtmlURL     string `json:"html_url"`
+			HTMLURL     string `json:"html_url"`
 			CreatedAt   string `json:"created_at"`
 			UpdatedAt   string `json:"updated_at"`
 		} `json:"app"`
@@ -249,7 +249,7 @@ type CheckSuitePayload struct {
 			Name        string `json:"name"`
 			Description string `json:"description"`
 			ExternalURL string `json:"external_url"`
-			HtmlURL     string `json:"html_url"`
+			HTMLURL     string `json:"html_url"`
 			CreatedAt   string `json:"created_at"`
 			UpdatedAt   string `json:"updated_at"`
 		} `json:"app"`

gitlab/gitlab.go

@@ -38,6 +38,7 @@ const (
 	objectPush         string = "push"
 	objectTag          string = "tag_push"
 	objectMergeRequest string = "merge_request"
+	objectBuild        string = "build"
 )
 
 // Option is a configuration option for the webhook
@@ -173,9 +174,15 @@ func eventParsing(gitLabEvent Event, events []Event, payload []byte) (interface{
 		err := json.Unmarshal([]byte(payload), &pl)
 		return pl, err
 	case JobEvents:
-		var p1 JobEventPayload
-		err := json.Unmarshal([]byte(payload), &p1)
-		return p1, err
+		var pl JobEventPayload
+		err := json.Unmarshal([]byte(payload), &pl)
+		if err != nil {
+			return nil, err
+		}
+		if pl.ObjectKind == objectBuild {
+			return eventParsing(BuildEvents, events, payload)
+		}
+		return pl, nil
 
 	case SystemHookEvents:
 		var pl SystemHookPayload

gitlab/gitlab_test.go

@@ -231,15 +231,67 @@ func TestWebhooks(t *testing.T) {
 				"X-Gitlab-Event": []string{"Build Hook"},
 			},
 		},
+	}
+
+	for _, tt := range tests {
+		tc := tt
+		client := &http.Client{}
+		t.Run(tt.name, func(t *testing.T) {
+			t.Parallel()
+			payload, err := os.Open(tc.filename)
+			assert.NoError(err)
+			defer func() {
+				_ = payload.Close()
+			}()
+
+			var parseError error
+			var results interface{}
+			server := newServer(func(w http.ResponseWriter, r *http.Request) {
+				results, parseError = hook.Parse(r, tc.event)
+			})
+			defer server.Close()
+			req, err := http.NewRequest(http.MethodPost, server.URL+path, payload)
+			assert.NoError(err)
+			req.Header = tc.headers
+			req.Header.Set("Content-Type", "application/json")
+			req.Header.Set("X-Gitlab-Token", "sampleToken!")
+
+			resp, err := client.Do(req)
+			assert.NoError(err)
+			assert.Equal(http.StatusOK, resp.StatusCode)
+			assert.NoError(parseError)
+			assert.Equal(reflect.TypeOf(tc.typ), reflect.TypeOf(results))
+		})
+	}
+}
+
+func TestJobHooks(t *testing.T) {
+	assert := require.New(t)
+	tests := []struct {
+		name     string
+		events   []Event
+		typ      interface{}
+		filename string
+		headers  http.Header
+	}{
 		{
 			name:     "JobEvent",
-			event:    JobEvents,
+			events:   []Event{JobEvents},
 			typ:      JobEventPayload{},
 			filename: "../testdata/gitlab/job-event.json",
 			headers: http.Header{
 				"X-Gitlab-Event": []string{"Job Hook"},
 			},
 		},
+		{
+			name:     "JobEvent",
+			events:   []Event{JobEvents, BuildEvents},
+			typ:      BuildEventPayload{},
+			filename: "../testdata/gitlab/build-event.json",
+			headers: http.Header{
+				"X-Gitlab-Event": []string{"Job Hook"},
+			},
+		},
 	}
 
 	for _, tt := range tests {
@@ -256,7 +308,7 @@ func TestWebhooks(t *testing.T) {
 			var parseError error
 			var results interface{}
 			server := newServer(func(w http.ResponseWriter, r *http.Request) {
-				results, parseError = hook.Parse(r, tc.event)
+				results, parseError = hook.Parse(r, tc.events...)
 			})
 			defer server.Close()
 			req, err := http.NewRequest(http.MethodPost, server.URL+path, payload)

gitlab/payload.go

@@ -143,7 +143,7 @@ type BuildEventPayload struct {
 	BuildStatus       string      `json:"build_status"`
 	BuildStartedAt    customTime  `json:"build_started_at"`
 	BuildFinishedAt   customTime  `json:"build_finished_at"`
-	BuildDuration     int64       `json:"build_duration"`
+	BuildDuration     float64     `json:"build_duration"`
 	BuildAllowFailure bool        `json:"build_allow_failure"`
 	ProjectID         int64       `json:"project_id"`
 	ProjectName       string      `json:"project_name"`
@@ -165,7 +165,7 @@ type JobEventPayload struct {
 	BuildStatus        string      `json:"build_status"`
 	BuildStartedAt     customTime  `json:"build_started_at"`
 	BuildFinishedAt    customTime  `json:"build_finished_at"`
-	BuildDuration      int64       `json:"build_duration"`
+	BuildDuration      float64     `json:"build_duration"`
 	BuildAllowFailure  bool        `json:"build_allow_failure"`
 	BuildFailureReason string      `json:"build_failure_reason"`
 	PipelineID         int64       `json:"pipeline_id"`
@@ -257,10 +257,10 @@ type BuildCommit struct {
 	ID          int64      `json:"id"`
 	SHA         string     `json:"sha"`
 	Message     string     `json:"message"`
-	AuthorName  string     `json:"auuthor_name"`
+	AuthorName  string     `json:"author_name"`
 	AuthorEmail string     `json:"author_email"`
 	Status      string     `json:"status"`
-	Duration    int64      `json:"duration"`
+	Duration    float64    `json:"duration"`
 	StartedAt   customTime `json:"started_at"`
 	FinishedAt  customTime `json:"finished_at"`
 }
@@ -363,11 +363,11 @@ type ObjectAttributes struct {
 	Stages           []string   `json:"stages"`
 	Duration         int64      `json:"duration"`
 	Note             string     `json:"note"`
-	NotebookType     string     `json:"noteable_type"`
+	NotebookType     string     `json:"noteable_type"` // nolint:misspell
 	At               customTime `json:"attachment"`
 	LineCode         string     `json:"line_code"`
 	CommitID         string     `json:"commit_id"`
-	NoteableID       int64      `json:"noteable_id"`
+	NoteableID       int64      `json:"noteable_id"` // nolint: misspell
 	System           bool       `json:"system"`
 	WorkInProgress   bool       `json:"work_in_progress"`
 	StDiffs          []StDiff   `json:"st_diffs"`

go.mod

@@ -0,0 +1,8 @@
+module github.com/go-playground/webhooks/v6
+
+go 1.15
+
+require (
+	github.com/gogits/go-gogs-client v0.0.0-20200905025246-8bb8a50cb355
+	github.com/stretchr/testify v1.6.1
+)

go.sum

@@ -0,0 +1,13 @@
+github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8=
+github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/gogits/go-gogs-client v0.0.0-20200905025246-8bb8a50cb355 h1:HTVNOdTWO/gHYeFnr/HwpYwY6tgMcYd+Rgf1XrHnORY=
+github.com/gogits/go-gogs-client v0.0.0-20200905025246-8bb8a50cb355/go.mod h1:cY2AIrMgHm6oOHmR7jY+9TtjzSjQ3iG7tURJG3Y6XH0=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
+github.com/stretchr/testify v1.6.1 h1:hDPOHmpOpP40lSULcqw7IrRb/u7w6RpDC9399XyoNd0=
+github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=