Use the Gorilla Mux router for better routing of mocked GitHub APIs.

chrisgavin · chrisgavin · commit dba6c26997a6 · 2020-08-24T09:59:05.000+01:00
diff --git a/go.mod b/go.mod
@@ -5,6 +5,7 @@ go 1.14
 require (
 	github.com/go-git/go-git/v5 v5.1.0
 	github.com/google/go-github/v32 v32.1.0
+	github.com/gorilla/mux v1.8.0
 	github.com/mitchellh/ioprogress v0.0.0-20180201004757-6a23b12fa88e
 	github.com/pkg/errors v0.8.1
 	github.com/spf13/cobra v1.0.0
diff --git a/go.sum b/go.sum
diff --git a/internal/pull/pull_test.go b/internal/pull/pull_test.go
@@ -124,18 +124,16 @@ func TestPullReleases(t *testing.T) {
 	githubTestServer, githubURL := test.GetTestHTTPServer(t)
 	githubTestServer.HandleFunc("/api/v3/repos/github/codeql-action/releases/tags/some-codeql-version-on-main", func(response http.ResponseWriter, request *http.Request) {
 		test.ServeHTTPResponseFromFile(t, http.StatusOK, "./pull_test/api/release-some-codeql-version-on-main.json", response)
-	})
+	}).Methods("GET")
 	githubTestServer.HandleFunc("/api/v3/repos/github/codeql-action/releases/assets/1", func(response http.ResponseWriter, request *http.Request) {
-		require.Equal(t, "application/octet-stream", request.Header.Get("accept"))
 		test.ServeHTTPResponseFromFile(t, http.StatusOK, "./pull_test/api/asset-some-codeql-version-on-main.bin", response)
-	})
+	}).Methods("GET").Headers("accept", "application/octet-stream")
 	githubTestServer.HandleFunc("/api/v3/repos/github/codeql-action/releases/tags/some-codeql-version-on-v1-and-v2", func(response http.ResponseWriter, request *http.Request) {
 		test.ServeHTTPResponseFromFile(t, http.StatusOK, "./pull_test/api/release-some-codeql-version-on-v1-and-v2.json", response)
-	})
+	}).Methods("GET")
 	githubTestServer.HandleFunc("/api/v3/repos/github/codeql-action/releases/assets/2", func(response http.ResponseWriter, request *http.Request) {
-		require.Equal(t, "application/octet-stream", request.Header.Get("accept"))
 		test.ServeHTTPResponseFromFile(t, http.StatusOK, "./pull_test/api/asset-some-codeql-version-on-v1-and-v2.bin", response)
-	})
+	}).Methods("GET").Headers("accept", "application/octet-stream")
 	pullService := getTestPullService(t, temporaryDirectory, initialActionRepository, githubURL)
 	err := pullService.pullGit(true)
 	require.NoError(t, err)
@@ -151,14 +149,13 @@ func TestPullReleases(t *testing.T) {
 	githubTestServer, githubURL = test.GetTestHTTPServer(t)
 	githubTestServer.HandleFunc("/api/v3/repos/github/codeql-action/releases/tags/some-codeql-version-on-main", func(response http.ResponseWriter, request *http.Request) {
 		test.ServeHTTPResponseFromFile(t, http.StatusOK, "./pull_test/api/release-some-codeql-version-on-main.json", response)
-	})
+	}).Methods("GET")
 	githubTestServer.HandleFunc("/api/v3/repos/github/codeql-action/releases/tags/some-codeql-version-on-v1-and-v2", func(response http.ResponseWriter, request *http.Request) {
 		test.ServeHTTPResponseFromFile(t, http.StatusOK, "./pull_test/api/release-some-codeql-version-on-v1-and-v2.json", response)
-	})
+	}).Methods("GET")
 	githubTestServer.HandleFunc("/api/v3/repos/github/codeql-action/releases/assets/2", func(response http.ResponseWriter, request *http.Request) {
-		require.Equal(t, "application/octet-stream", request.Header.Get("accept"))
 		test.ServeHTTPResponseFromFile(t, http.StatusOK, "./pull_test/api/asset-some-codeql-version-on-v1-and-v2.bin", response)
-	})
+	}).Methods("GET").Headers("accept", "application/octet-stream")
 	pullService = getTestPullService(t, temporaryDirectory, initialActionRepository, githubURL)
 	err = pullService.pullReleases()
 	require.NoError(t, err)
diff --git a/test/test.go b/test/test.go
@@ -7,6 +7,7 @@ import (
 	"os"
 	"testing"
 
+	"github.com/gorilla/mux"
 	"github.com/stretchr/testify/require"
 )
 
@@ -19,8 +20,8 @@ func CreateTemporaryDirectory(t *testing.T) string {
 	return directory
 }
 
-func GetTestHTTPServer(t *testing.T) (*http.ServeMux, string) {
-	mux := http.NewServeMux()
+func GetTestHTTPServer(t *testing.T) (*mux.Router, string) {
+	mux := mux.NewRouter()
 	mux.HandleFunc("/", func(response http.ResponseWriter, request *http.Request) {
 		require.Failf(t, "Unexpected HTTP request: %s %s", request.Method, request.URL.Path)
 	})
