Merge branch 'master' into impl-gitlab-release

Author: xNok

README.md

@@ -1,13 +1,13 @@
 Library webhooks
 ================
-<img align="right" src="https://raw.githubusercontent.com/go-playground/webhooks/v6/logo.png">![Project status](https://img.shields.io/badge/version-6.1.0-green.svg)
+<img align="right" src="https://raw.githubusercontent.com/go-playground/webhooks/v6/logo.png">![Project status](https://img.shields.io/badge/version-6.3.0-green.svg)
 [![Test](https://github.com/go-playground/webhooks/workflows/Test/badge.svg?branch=master)](https://github.com/go-playground/webhooks/actions)
 [![Coverage Status](https://coveralls.io/repos/go-playground/webhooks/badge.svg?branch=master&service=github)](https://coveralls.io/github/go-playground/webhooks?branch=master)
 [![Go Report Card](https://goreportcard.com/badge/go-playground/webhooks)](https://goreportcard.com/report/go-playground/webhooks)
 [![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, GitLab, Docker Hub and Gogs Webhook Events
+Library webhooks allows for easy receiving and parsing of GitHub, Bitbucket, GitLab, Docker Hub, Gogs and Azure DevOps Webhook Events
 
 Features:
 

azuredevops/azuredevops.go

@@ -0,0 +1,80 @@
+package azuredevops
+
+// this package receives Azure DevOps Server webhooks
+// https://docs.microsoft.com/en-us/azure/devops/service-hooks/services/webhooks?view=azure-devops-2020
+
+import (
+	"encoding/json"
+	"errors"
+	"fmt"
+	"io"
+	"net/http"
+)
+
+// parse errors
+var (
+	ErrInvalidHTTPMethod = errors.New("invalid HTTP Method")
+	ErrParsingPayload    = errors.New("error parsing payload")
+)
+
+// Event defines an Azure DevOps server hook event type
+type Event string
+
+// Azure DevOps Server hook types
+const (
+	BuildCompleteEventType         Event = "build.complete"
+	GitPullRequestCreatedEventType Event = "git.pullrequest.created"
+	GitPullRequestUpdatedEventType Event = "git.pullrequest.updated"
+	GitPullRequestMergedEventType  Event = "git.pullrequest.merged"
+	GitPushEventType               Event = "git.push"
+)
+
+// Webhook instance contains all methods needed to process events
+type Webhook struct {
+}
+
+// New creates and returns a WebHook instance
+func New() (*Webhook, error) {
+	hook := new(Webhook)
+	return hook, nil
+}
+
+// Parse verifies and parses the events specified and returns the payload object or an error
+func (hook Webhook) Parse(r *http.Request, events ...Event) (interface{}, error) {
+	defer func() {
+		_, _ = io.Copy(io.Discard, r.Body)
+		_ = r.Body.Close()
+	}()
+
+	if r.Method != http.MethodPost {
+		return nil, ErrInvalidHTTPMethod
+	}
+
+	payload, err := io.ReadAll(r.Body)
+	if err != nil || len(payload) == 0 {
+		return nil, ErrParsingPayload
+	}
+
+	var pl BasicEvent
+	err = json.Unmarshal([]byte(payload), &pl)
+	if err != nil {
+		return nil, ErrParsingPayload
+	}
+
+	switch pl.EventType {
+	case GitPushEventType:
+		var fpl GitPushEvent
+		err = json.Unmarshal([]byte(payload), &fpl)
+		return fpl, err
+	case GitPullRequestCreatedEventType, GitPullRequestMergedEventType, GitPullRequestUpdatedEventType:
+		var fpl GitPullRequestEvent
+		err = json.Unmarshal([]byte(payload), &fpl)
+		return fpl, err
+	case BuildCompleteEventType:
+		var fpl BuildCompleteEvent
+		err = json.Unmarshal([]byte(payload), &fpl)
+		return fpl, err
+	default:
+		return nil, fmt.Errorf("unknown event %s", pl.EventType)
+	}
+}

azuredevops/azuredevops_test.go

@@ -0,0 +1,119 @@
+package azuredevops
+
+import (
+	"log"
+	"net/http"
+	"net/http/httptest"
+	"os"
+	"testing"
+
+	"reflect"
+
+	"github.com/stretchr/testify/require"
+)
+
+// NOTES:
+// - Run "go test" to run tests
+// - Run "gocov test | gocov report" to report on test converage by file
+// - Run "gocov test | gocov annotate -" to report on all code and functions, those ,marked with "MISS" were never called
+//
+// or
+//
+// -- may be a good idea to change to output path to somewherelike /tmp
+// go test -coverprofile cover.out && go tool cover -html=cover.out -o cover.html
+//
+
+const (
+	virtualDir = "/webhooks"
+)
+
+var hook *Webhook
+
+func TestMain(m *testing.M) {
+
+	// setup
+	var err error
+	hook, err = New()
+	if err != nil {
+		log.Fatal(err)
+	}
+	os.Exit(m.Run())
+	// teardown
+}
+
+func newServer(handler http.HandlerFunc) *httptest.Server {
+	mux := http.NewServeMux()
+	mux.HandleFunc(virtualDir, handler)
+	return httptest.NewServer(mux)
+}
+
+func TestWebhooks(t *testing.T) {
+	assert := require.New(t)
+	tests := []struct {
+		name     string
+		event    Event
+		typ      interface{}
+		filename string
+		headers  http.Header
+	}{
+		{
+			name:     "build.complete",
+			event:    BuildCompleteEventType,
+			typ:      BuildCompleteEvent{},
+			filename: "../testdata/azuredevops/build.complete.json",
+		},
+		{
+			name:     "git.pullrequest.created",
+			event:    GitPullRequestCreatedEventType,
+			typ:      GitPullRequestEvent{},
+			filename: "../testdata/azuredevops/git.pullrequest.created.json",
+		},
+		{
+			name:     "git.pullrequest.merged",
+			event:    GitPullRequestMergedEventType,
+			typ:      GitPullRequestEvent{},
+			filename: "../testdata/azuredevops/git.pullrequest.merged.json",
+		},
+		{
+			name:     "git.pullrequest.updated",
+			event:    GitPullRequestUpdatedEventType,
+			typ:      GitPullRequestEvent{},
+			filename: "../testdata/azuredevops/git.pullrequest.updated.json",
+		},
+		{
+			name:     "git.push",
+			event:    GitPushEventType,
+			typ:      GitPushEvent{},
+			filename: "../testdata/azuredevops/git.push.json",
+		},
+	}
+
+	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+virtualDir, payload)
+			assert.NoError(err)
+			req.Header.Set("Content-Type", "application/json")
+
+			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))
+		})
+	}
+}