Merge pull request #1 from friendsofgo/http_tests

Add testing for handlers

Author: aperezg

pkg/server/api.go

@@ -14,16 +14,20 @@ type api struct {
 	repository gopher.GopherRepository
 }
 
+// Server representation of gopher server
 type Server interface {
 	Router() http.Handler
+	FetchGophers(w http.ResponseWriter, r *http.Request)
+	FetchGopher(w http.ResponseWriter, r *http.Request)
 }
 
+// New initialize the server
 func New(repo gopher.GopherRepository) Server {
 	a := &api{repository: repo}
 
 	r := mux.NewRouter()
-	r.HandleFunc("/gophers", a.fetchGophers).Methods(http.MethodGet)
-	r.HandleFunc("/gophers/{ID:[a-zA-Z0-9_]+}", a.fetchGopher).Methods(http.MethodGet)
+	r.HandleFunc("/gophers", a.FetchGophers).Methods(http.MethodGet)
+	r.HandleFunc("/gophers/{ID:[a-zA-Z0-9_]+}", a.FetchGopher).Methods(http.MethodGet)
 
 	a.router = r
 	return a
@@ -33,14 +37,16 @@ func (a *api) Router() http.Handler {
 	return a.router
 }
 
-func (a *api) fetchGophers(w http.ResponseWriter, r *http.Request) {
+// FetchGophers return a list of all gophers
+func (a *api) FetchGophers(w http.ResponseWriter, r *http.Request) {
 	gophers, _ := a.repository.FetchGophers()
 
 	w.Header().Set("Content-Type", "application/json")
 	json.NewEncoder(w).Encode(gophers)
 }
 
-func (a *api) fetchGopher(w http.ResponseWriter, r *http.Request) {
+// FetchGopher return a gopher by ID
+func (a *api) FetchGopher(w http.ResponseWriter, r *http.Request) {
 	vars := mux.Vars(r)
 	gopher, err := a.repository.FetchGopherByID(vars["ID"])
 	w.Header().Set("Content-Type", "application/json")

pkg/server/api_test.go

@@ -0,0 +1,112 @@
+package server
+
+import (
+	"encoding/json"
+	"fmt"
+	"io/ioutil"
+	"net/http"
+	"net/http/httptest"
+	"testing"
+
+	sample "github.com/friendsofgo/gopher-api/cmd/sample-data"
+	gopher "github.com/friendsofgo/gopher-api/pkg"
+	"github.com/friendsofgo/gopher-api/pkg/storage/inmem"
+)
+
+func TestFetchGophers(t *testing.T) {
+	req, err := http.NewRequest("GET", "/gophers", nil)
+	if err != nil {
+		t.Fatalf("could not created request: %v", err)
+	}
+
+	repo := inmem.NewGopherRepository(sample.Gophers)
+	s := New(repo)
+
+	rec := httptest.NewRecorder()
+
+	s.FetchGophers(rec, req)
+
+	res := rec.Result()
+	defer res.Body.Close()
+	if res.StatusCode != http.StatusOK {
+		t.Errorf("expected %d, got: %d", http.StatusOK, res.StatusCode)
+	}
+	b, err := ioutil.ReadAll(res.Body)
+	if err != nil {
+		t.Fatalf("could not read response: %v", err)
+	}
+
+	var got []*gopher.Gopher
+	err = json.Unmarshal(b, &got)
+	if err != nil {
+		t.Fatalf("could not unmarshall response %v", err)
+	}
+
+	expected := len(sample.Gophers)
+
+	if len(got) != expected {
+		t.Errorf("expected %d gophers, got: %d gopher", sample.Gophers, got)
+	}
+}
+
+func TestFetchGopher(t *testing.T) {
+
+	testData := []struct {
+		name   string
+		g      *gopher.Gopher
+		status int
+		err    string
+	}{
+		{name: "gopher found", g: gopherSample(), status: http.StatusOK},
+		{name: "gopher not found", g: &gopher.Gopher{ID: "123"}, status: http.StatusNotFound, err: "Gopher Not found"},
+	}
+
+	for _, tt := range testData {
+		t.Run(tt.name, func(t *testing.T) {
+			uri := fmt.Sprintf("/gophers/%s", tt.g.ID)
+			req, err := http.NewRequest("GET", uri, nil)
+			if err != nil {
+				t.Fatalf("could not created request: %v", err)
+			}
+
+			repo := inmem.NewGopherRepository(sample.Gophers)
+			s := New(repo)
+
+			rec := httptest.NewRecorder()
+			s.Router().ServeHTTP(rec, req)
+
+			res := rec.Result()
+
+			defer res.Body.Close()
+			if tt.status != res.StatusCode {
+				t.Errorf("expected %d, got: %d", tt.status, res.StatusCode)
+			}
+			b, err := ioutil.ReadAll(res.Body)
+			if err != nil {
+				t.Fatalf("could not read response: %v", err)
+			}
+
+			if tt.err == "" {
+				var got *gopher.Gopher
+				err = json.Unmarshal(b, &got)
+				if err != nil {
+					t.Fatalf("could not unmarshall response %v", err)
+				}
+
+				if *got != *tt.g {
+					t.Fatalf("expected %v, got: %v", tt.g, got)
+				}
+			}
+		})
+	}
+
+}
+
+func gopherSample() *gopher.Gopher {
+	return &gopher.Gopher{
+		ID:    "01D3XZ3ZHCP3KG9VT4FGAD8KDR",
+		Name:  "Jenny",
+		Age:   18,
+		Image: "https://storage.googleapis.com/gopherizeme.appspot.com/gophers/0ceb2c10fc0c30575c18ff1defa1ffd41501bc62.png",
+	}
+}