Merge pull request #44 from infinityworks/chore/tests

Adds blackbox behavioural test to validate metrics endpoint.

Author: Rucknar

.gitignore

@@ -0,0 +1 @@
+.sequence

Makefile

@@ -1,3 +1,5 @@
+.PHONY: install test build
+
 install:
 	@go mod download
 

README.md

@@ -60,5 +60,14 @@ github-exporter:
 Metrics will be made available on port 9171 by default
 An example of these metrics can be found in the `METRICS.md` markdown file in the root of this repository
 
+## Tests
+
+There is a set of blackbox behavioural tests which validate metrics endpoint in the `test` directory. 
+Run as follows
+
+```bash
+make test
+```
+
 ## Metadata
 [![](https://images.microbadger.com/badges/image/infinityworks/github-exporter.svg)](http://microbadger.com/images/infinityworks/github-exporter "Get your own image badge on microbadger.com") [![](https://images.microbadger.com/badges/version/infinityworks/github-exporter.svg)](http://microbadger.com/images/infinityworks/github-exporter "Get your own version badge on microbadger.com")

go.mod

@@ -5,9 +5,8 @@ go 1.12
 require (
 	github.com/fatih/structs v1.1.0
 	github.com/infinityworks/go-common v0.0.0-20170820165359-7f20a140fd37
-	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
-	github.com/modern-go/reflect2 v1.0.1 // indirect
 	github.com/prometheus/client_golang v0.9.2
 	github.com/sirupsen/logrus v1.4.2
+	github.com/steinfletcher/apitest v1.3.8
 	github.com/tomnomnom/linkheader v0.0.0-20180905144013-02ca5825eb80
 )

go.sum

@@ -1,17 +1,19 @@
 github.com/beorn7/perks v0.0.0-20180321164747-3a771d992973 h1:xJ4a3vCFaGF/jqvzLMYoU8P317H5OQ+Via4RmuPwCS0=
 github.com/beorn7/perks v0.0.0-20180321164747-3a771d992973/go.mod h1:Dwedo/Wpr24TaqPxmxbtue+5NUziq4I4S80YR8gNf3Q=
+github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/fatih/structs v1.1.0 h1:Q7juDM0QtcnhCpeyLGQKyg4TOIghuNXrkL32pHAUMxo=
 github.com/fatih/structs v1.1.0/go.mod h1:9NiDSp5zOcgEDl+j00MP/WkGVPOlPRLejGD8Ga6PJ7M=
 github.com/golang/protobuf v1.2.0 h1:P3YflyNX/ehuJFLhxviNdFxQPkGK5cDcApsge1SqnvM=
 github.com/golang/protobuf v1.2.0/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U=
 github.com/infinityworks/go-common v0.0.0-20170820165359-7f20a140fd37 h1:Lm6kyC3JBiJQvJrus66He0E4viqDc/m5BdiFNSkIFfU=
 github.com/infinityworks/go-common v0.0.0-20170820165359-7f20a140fd37/go.mod h1:+OaHNKQvQ9oOCr+DgkF95PkiDx20fLHpzMp8SmRPQTg=
+github.com/konsorten/go-windows-terminal-sequences v1.0.1 h1:mweAR1A6xJ3oS2pRaGiHgQ4OO8tzTaLawm8vnODuwDk=
 github.com/konsorten/go-windows-terminal-sequences v1.0.1/go.mod h1:T0+1ngSBFLxvqU3pZ+m/2kptfBszLMUkC4ZK/EgS/cQ=
 github.com/matttproud/golang_protobuf_extensions v1.0.1 h1:4hp9jkHxhMHkqkrB3Ix0jegS5sx/RkqARlsWZ6pIwiU=
 github.com/matttproud/golang_protobuf_extensions v1.0.1/go.mod h1:D8He9yQNgCq6Z5Ld7szi9bcBfOoFv/3dc6xSMkL2PC0=
-github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q=
-github.com/modern-go/reflect2 v1.0.1/go.mod h1:bx2lNnkwVCuqBIxFjflWJWanXIb3RllmbCylyMrvgv0=
+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/prometheus/client_golang v0.9.2 h1:awm861/B8OKDd2I/6o1dy3ra4BamzKhYOiGItCeZ740=
 github.com/prometheus/client_golang v0.9.2/go.mod h1:OsXs2jCmiKlQ1lTBmv21f2mNfw4xf/QclQDMrYNZzcM=
@@ -23,11 +25,18 @@ github.com/prometheus/procfs v0.0.0-20181204211112-1dc9a6cbc91a h1:9a8MnZMP0X2nL
 github.com/prometheus/procfs v0.0.0-20181204211112-1dc9a6cbc91a/go.mod h1:c3At6R/oaqEKCNdg8wHV1ftS6bRYblBhIjjI8uT2IGk=
 github.com/sirupsen/logrus v1.4.2 h1:SPIRibHv4MatM3XXNO2BJeFLZwZ2LvZgfQ5+UNI2im4=
 github.com/sirupsen/logrus v1.4.2/go.mod h1:tLMulIdttU9McNUspp0xgXVQah82FyeX6MwdIuYE2rE=
+github.com/steinfletcher/apitest v1.3.8 h1:Q5CrFWbXSo9ocx9pb0IgPw38FKPKfkfEF+3+V35n4M8=
+github.com/steinfletcher/apitest v1.3.8/go.mod h1:LOVbGzWvWCiiVE4PZByfhRnA5L00l5uZQEx403xQ4K8=
+github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/objx v0.1.1/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
+github.com/stretchr/testify v1.2.2 h1:bSDNvY7ZPG5RlJ8otE/7V6gMiyenm9RtJ7IUVIAoJ1w=
 github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
+github.com/stretchr/testify v1.3.0 h1:TivCn/peBQ7UY8ooIcPgZFpTNSz0Q2U6UrFlUfqbe0Q=
+github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
 github.com/tomnomnom/linkheader v0.0.0-20180905144013-02ca5825eb80 h1:nrZ3ySNYwJbSpD6ce9duiP+QkD3JuLCcWkdaehUS/3Y=
 github.com/tomnomnom/linkheader v0.0.0-20180905144013-02ca5825eb80/go.mod h1:iFyPdL66DjUD96XmzVL3ZntbzcflLnznH0fr99w5VqE=
 golang.org/x/net v0.0.0-20181201002055-351d144fa1fc/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
+golang.org/x/sync v0.0.0-20181108010431-42b317875d0f h1:Bl/8QSvNqXvPGPGXa2z5xUTmV7VDcZyvRZ+QQXkXTZQ=
 golang.org/x/sync v0.0.0-20181108010431-42b317875d0f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
 golang.org/x/sys v0.0.0-20190422165155-953cdadca894 h1:Cz4ceDQGXuKRnVBDTS23GTn/pU5OE2C0WrNTOYK1Uuc=
 golang.org/x/sys v0.0.0-20190422165155-953cdadca894/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=

http/server.go

@@ -0,0 +1,41 @@
+package http
+
+import (
+	"github.com/infinityworks/github-exporter/exporter"
+	"github.com/prometheus/client_golang/prometheus"
+	"github.com/prometheus/client_golang/prometheus/promhttp"
+	"log"
+	"net/http"
+)
+
+type Server struct {
+	Handler  http.Handler
+	exporter exporter.Exporter
+}
+
+func NewServer(exporter exporter.Exporter) *Server {
+	r := http.NewServeMux()
+
+	// Register Metrics from each of the endpoints
+	// This invokes the Collect method through the prometheus client libraries.
+	prometheus.MustRegister(&exporter)
+
+	r.Handle(exporter.MetricsPath(), promhttp.Handler())
+	r.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
+		_, _ = w.Write([]byte(`<html>
+		                <head><title>Github Exporter</title></head>
+		                <body>
+		                   <h1>GitHub Prometheus Metrics Exporter</h1>
+						   <p>For more information, visit <a href=https://github.com/infinityworks/github-exporter>GitHub</a></p>
+		                   <p><a href='` + exporter.MetricsPath() + `'>Metrics</a></p>
+		                   </body>
+		                </html>
+		              `))
+	})
+
+	return &Server{Handler: r, exporter: exporter}
+}
+
+func (s *Server) Start() {
+	log.Fatal(http.ListenAndServe(":"+s.exporter.ListenPort(), s.Handler))
+}

main.go

@@ -1,14 +1,12 @@
 package main
 
 import (
-	"net/http"
-
 	"github.com/fatih/structs"
 	conf "github.com/infinityworks/github-exporter/config"
 	"github.com/infinityworks/github-exporter/exporter"
+	"github.com/infinityworks/github-exporter/http"
 	"github.com/infinityworks/go-common/logger"
 	"github.com/prometheus/client_golang/prometheus"
-	"github.com/prometheus/client_golang/prometheus/promhttp"
 	"github.com/sirupsen/logrus"
 )
 
@@ -25,30 +23,12 @@ func init() {
 }
 
 func main() {
-
 	log.WithFields(structs.Map(applicationCfg)).Info("Starting Exporter")
 
-	exporter := exporter.Exporter{
+	exp := exporter.Exporter{
 		APIMetrics: mets,
 		Config:     applicationCfg,
 	}
 
-	// Register Metrics from each of the endpoints
-	// This invokes the Collect method through the prometheus client libraries.
-	prometheus.MustRegister(&exporter)
-
-	// Setup HTTP handler
-	http.Handle(applicationCfg.MetricsPath(), promhttp.Handler())
-	http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
-		w.Write([]byte(`<html>
-		                <head><title>Github Exporter</title></head>
-		                <body>
-		                   <h1>GitHub Prometheus Metrics Exporter</h1>
-						   <p>For more information, visit <a href=https://github.com/infinityworks/github-exporter>GitHub</a></p>
-		                   <p><a href='` + applicationCfg.MetricsPath() + `'>Metrics</a></p>
-		                   </body>
-		                </html>
-		              `))
-	})
-	log.Fatal(http.ListenAndServe(":"+applicationCfg.ListenPort(), nil))
+	http.NewServer(exp).Start()
 }

test/github_exporter_test.go

@@ -0,0 +1,128 @@
+package test
+
+import (
+	"fmt"
+	"github.com/infinityworks/github-exporter/config"
+	"github.com/infinityworks/github-exporter/exporter"
+	web "github.com/infinityworks/github-exporter/http"
+	"github.com/prometheus/client_golang/prometheus"
+	"github.com/steinfletcher/apitest"
+	"io/ioutil"
+	"net/http"
+	"os"
+	"strings"
+	"testing"
+)
+
+func TestHomepage(t *testing.T) {
+	test, collector := apiTest(withConfig("a/b"))
+	defer prometheus.Unregister(&collector)
+
+	test.Get("/").
+		Expect(t).
+		Assert(bodyContains("GitHub Prometheus Metrics Exporter")).
+		Status(http.StatusOK).
+		End()
+}
+
+func TestGithubExporter(t *testing.T) {
+	test, collector := apiTest(withConfig("myOrg/myRepo"))
+	defer prometheus.Unregister(&collector)
+
+	test.Mocks(
+		githubRepos(),
+		githubRateLimit(),
+		githubReleases(),
+	).
+		Get("/metrics").
+		Expect(t).
+		Assert(bodyContains(`github_rate_limit 60`)).
+		Assert(bodyContains(`github_rate_remaining 60`)).
+		Assert(bodyContains(`github_rate_reset 1.566853865e+09`)).
+		Assert(bodyContains(`github_repo_forks{archived="false",fork="false",language="Go",license="mit",private="false",repo="myRepo",user="myOrg"} 10`)).
+		Assert(bodyContains(`github_repo_open_issues{archived="false",fork="false",language="Go",license="mit",private="false",repo="myRepo",user="myOrg"} 2`)).
+		Assert(bodyContains(`github_repo_size_kb{archived="false",fork="false",language="Go",license="mit",private="false",repo="myRepo",user="myOrg"} 946`)).
+		Assert(bodyContains(`github_repo_stars{archived="false",fork="false",language="Go",license="mit",private="false",repo="myRepo",user="myOrg"} 120`)).
+		Assert(bodyContains(`github_repo_watchers{archived="false",fork="false",language="Go",license="mit",private="false",repo="myRepo",user="myOrg"} 5`)).
+		Assert(bodyContains(`github_repo_release_downloads{created_at="2019-02-28T08:25:53Z",name="myRepo_1.3.0_checksums.txt",release="1.3.0",repo="myRepo",user="myOrg"} 7292`)).
+		Assert(bodyContains(`github_repo_release_downloads{created_at="2019-02-28T08:25:53Z",name="myRepo_1.3.0_windows_amd64.tar.gz",release="1.3.0",repo="myRepo",user="myOrg"} 21`)).
+		Assert(bodyContains(`github_repo_release_downloads{created_at="2019-05-02T15:22:16Z",name="myRepo_2.0.0_checksums.txt",release="2.0.0",repo="myRepo",user="myOrg"} 14564`)).
+		Assert(bodyContains(`github_repo_release_downloads{created_at="2019-05-02T15:22:16Z",name="myRepo_2.0.0_windows_amd64.tar.gz",release="2.0.0",repo="myRepo",user="myOrg"} 55`)).
+		Status(http.StatusOK).
+		End()
+}
+
+func apiTest(conf config.Config) (*apitest.APITest, exporter.Exporter) {
+	exp := exporter.Exporter{
+		APIMetrics: exporter.AddMetrics(),
+		Config:     conf,
+	}
+	server := web.NewServer(exp)
+
+	return apitest.New().
+		Report(apitest.SequenceDiagram()).
+		Handler(server.Handler), exp
+}
+
+func withConfig(repos string) config.Config {
+	_ = os.Setenv("REPOS", repos)
+	_ = os.Setenv("GITHUB_TOKEN", "12345")
+	return config.Init()
+}
+
+func githubRepos() *apitest.Mock {
+	return apitest.NewMock().
+		Get("https://api.github.com/repos/myOrg/myRepo").
+		Header("Authorization", "token 12345").
+		Query("per_page", "100").
+		RespondWith().
+		Times(2).
+		Body(readFile("testdata/my_repo_response.json")).
+		Status(200).
+		End()
+}
+
+func githubRateLimit() *apitest.Mock {
+	return apitest.NewMock().
+		Get("https://api.github.com/rate_limit").
+		Header("Authorization", "token 12345").
+		RespondWith().
+		Header("X-RateLimit-Limit", "60").
+		Header("X-RateLimit-Remaining", "60").
+		Header("X-RateLimit-Reset", "1566853865").
+		Status(http.StatusOK).
+		End()
+}
+
+func githubReleases() *apitest.Mock {
+	return apitest.NewMock().
+		Get("https://api.github.com/repos/myOrg/myRepo/releases").
+		Header("Authorization", "token 12345").
+		RespondWith().
+		Times(2).
+		Body(readFile("testdata/releases_response.json")).
+		Status(http.StatusOK).
+		End()
+}
+
+func readFile(path string) string {
+	bytes, err := ioutil.ReadFile(path)
+	if err != nil {
+		panic(err)
+	}
+	return string(bytes)
+}
+
+func bodyContains(substr string) func(*http.Response, *http.Request) error {
+	return func(res *http.Response, req *http.Request) error {
+		bytes, err := ioutil.ReadAll(res.Body)
+		if err != nil {
+			panic(err)
+		}
+		response := string(bytes)
+		if !strings.Contains(response, substr) {
+			return fmt.Errorf("response did not contain substring '%s'", substr)
+		}
+		return nil
+	}
+}

test/testdata/my_repo_response.json

@@ -0,0 +1,102 @@
+{
+  "id": 163222413,
+  "node_id": "MDEwOlJlcG9zaXRvcnkxNjMyMjI0MTM=",
+  "name": "myRepo",
+  "full_name": "myOrg/myRepo",
+  "private": false,
+  "owner": {
+    "login": "myOrg",
+    "id": 1219157,
+    "node_id": "MDQ6VXNlcjEyMTkxNTc=",
+    "avatar_url": "https://avatars1.githubusercontent.com/u/1219157?v=4",
+    "gravatar_id": "",
+    "url": "https://api.github.com/users/myOrg",
+    "html_url": "https://github.com/myOrg",
+    "followers_url": "https://api.github.com/users/myOrg/followers",
+    "following_url": "https://api.github.com/users/myOrg/following{/other_user}",
+    "gists_url": "https://api.github.com/users/myOrg/gists{/gist_id}",
+    "starred_url": "https://api.github.com/users/myOrg/starred{/owner}{/repo}",
+    "subscriptions_url": "https://api.github.com/users/myOrg/subscriptions",
+    "organizations_url": "https://api.github.com/users/myOrg/orgs",
+    "repos_url": "https://api.github.com/users/myOrg/repos",
+    "events_url": "https://api.github.com/users/myOrg/events{/privacy}",
+    "received_events_url": "https://api.github.com/users/myOrg/received_events",
+    "type": "User",
+    "site_admin": false
+  },
+  "html_url": "https://github.com/myOrg/myRepo",
+  "description": "A simple and extensible behavioural testing library written in golang. You can use api test to simplify REST API, HTTP handler and e2e tests.",
+  "fork": false,
+  "url": "https://api.github.com/repos/myOrg/myRepo",
+  "forks_url": "https://api.github.com/repos/myOrg/myRepo/forks",
+  "keys_url": "https://api.github.com/repos/myOrg/myRepo/keys{/key_id}",
+  "collaborators_url": "https://api.github.com/repos/myOrg/myRepo/collaborators{/collaborator}",
+  "teams_url": "https://api.github.com/repos/myOrg/myRepo/teams",
+  "hooks_url": "https://api.github.com/repos/myOrg/myRepo/hooks",
+  "issue_events_url": "https://api.github.com/repos/myOrg/myRepo/issues/events{/number}",
+  "events_url": "https://api.github.com/repos/myOrg/myRepo/events",
+  "assignees_url": "https://api.github.com/repos/myOrg/myRepo/assignees{/user}",
+  "branches_url": "https://api.github.com/repos/myOrg/myRepo/branches{/branch}",
+  "tags_url": "https://api.github.com/repos/myOrg/myRepo/tags",
+  "blobs_url": "https://api.github.com/repos/myOrg/myRepo/git/blobs{/sha}",
+  "git_tags_url": "https://api.github.com/repos/myOrg/myRepo/git/tags{/sha}",
+  "git_refs_url": "https://api.github.com/repos/myOrg/myRepo/git/refs{/sha}",
+  "trees_url": "https://api.github.com/repos/myOrg/myRepo/git/trees{/sha}",
+  "statuses_url": "https://api.github.com/repos/myOrg/myRepo/statuses/{sha}",
+  "languages_url": "https://api.github.com/repos/myOrg/myRepo/languages",
+  "stargazers_url": "https://api.github.com/repos/myOrg/myRepo/stargazers",
+  "contributors_url": "https://api.github.com/repos/myOrg/myRepo/contributors",
+  "subscribers_url": "https://api.github.com/repos/myOrg/myRepo/subscribers",
+  "subscription_url": "https://api.github.com/repos/myOrg/myRepo/subscription",
+  "commits_url": "https://api.github.com/repos/myOrg/myRepo/commits{/sha}",
+  "git_commits_url": "https://api.github.com/repos/myOrg/myRepo/git/commits{/sha}",
+  "comments_url": "https://api.github.com/repos/myOrg/myRepo/comments{/number}",
+  "issue_comment_url": "https://api.github.com/repos/myOrg/myRepo/issues/comments{/number}",
+  "contents_url": "https://api.github.com/repos/myOrg/myRepo/contents/{+path}",
+  "compare_url": "https://api.github.com/repos/myOrg/myRepo/compare/{base}...{head}",
+  "merges_url": "https://api.github.com/repos/myOrg/myRepo/merges",
+  "archive_url": "https://api.github.com/repos/myOrg/myRepo/{archive_format}{/ref}",
+  "downloads_url": "https://api.github.com/repos/myOrg/myRepo/downloads",
+  "issues_url": "https://api.github.com/repos/myOrg/myRepo/issues{/number}",
+  "pulls_url": "https://api.github.com/repos/myOrg/myRepo/pulls{/number}",
+  "milestones_url": "https://api.github.com/repos/myOrg/myRepo/milestones{/number}",
+  "notifications_url": "https://api.github.com/repos/myOrg/myRepo/notifications{?since,all,participating}",
+  "labels_url": "https://api.github.com/repos/myOrg/myRepo/labels{/name}",
+  "releases_url": "https://api.github.com/repos/myOrg/myRepo/releases{/id}",
+  "deployments_url": "https://api.github.com/repos/myOrg/myRepo/deployments",
+  "created_at": "2018-12-26T22:27:19Z",
+  "updated_at": "2019-08-22T20:25:14Z",
+  "pushed_at": "2019-08-22T20:25:16Z",
+  "git_url": "git://github.com/myOrg/myRepo.git",
+  "ssh_url": "[email protected]:myOrg/myRepo.git",
+  "clone_url": "https://github.com/myOrg/myRepo.git",
+  "svn_url": "https://github.com/myOrg/myRepo",
+  "homepage": "https://myRepo.dev",
+  "size": 946,
+  "stargazers_count": 120,
+  "watchers_count": 120,
+  "language": "Go",
+  "has_issues": true,
+  "has_projects": true,
+  "has_downloads": true,
+  "has_wiki": false,
+  "has_pages": false,
+  "forks_count": 10,
+  "mirror_url": null,
+  "archived": false,
+  "disabled": false,
+  "open_issues_count": 2,
+  "license": {
+    "key": "mit",
+    "name": "MIT License",
+    "spdx_id": "MIT",
+    "url": "https://api.github.com/licenses/mit",
+    "node_id": "MDc6TGljZW5zZTEz"
+  },
+  "forks": 10,
+  "open_issues": 2,
+  "watchers": 120,
+  "default_branch": "master",
+  "network_count": 10,
+  "subscribers_count": 5
+}