Add scaffolding for testing http endpoints

Author: FilipNikolovski

actions/auth.go

@@ -156,15 +156,6 @@ func PostSignup(c *gin.Context) {
 		}
 	}
 
-	uuid, err := uuid.NewRandom()
-	if err != nil {
-		logger.From(c).WithError(err).Error("Unable to generate random uuid.")
-		c.JSON(http.StatusForbidden, gin.H{
-			"message": "Unable to create an account.",
-		})
-		return
-	}
-
 	hashedPassword, err := bcrypt.GenerateFromPassword([]byte(body.Password), bcrypt.DefaultCost)
 	if err != nil {
 		logger.From(c).WithError(err).Error("Unable to generate hash from password.")
@@ -174,6 +165,8 @@ func PostSignup(c *gin.Context) {
 		return
 	}
 
+	uuid := uuid.New()
+
 	user := &entities.User{
 		Username: body.Email,
 		UUID:     uuid.String(),
@@ -574,12 +567,7 @@ func completeCallback(c *gin.Context, email, source, host string) {
 			return
 		}
 
-		uuid, err := uuid.NewRandom()
-		if err != nil {
-			logger.From(c).WithError(err).Error("Unable to generate random uuid.")
-			c.Redirect(http.StatusPermanentRedirect, host+"/login?message=register-failed")
-			return
-		}
+		uuid := uuid.New()
 
 		u = &entities.User{
 			UUID:     uuid.String(),

actions/setup_test.go

@@ -0,0 +1,94 @@
+package actions_test
+
+import (
+	"database/sql"
+	"net/http"
+	"os"
+	"strconv"
+	"testing"
+
+	"github.com/mailbadger/app/entities"
+	"github.com/mailbadger/app/entities/params"
+	"golang.org/x/crypto/bcrypt"
+
+	"github.com/gavv/httpexpect/v2"
+	"github.com/gin-contrib/sessions"
+	"github.com/gin-contrib/sessions/cookie"
+	"github.com/gin-gonic/gin"
+	"github.com/mailbadger/app/routes"
+	"github.com/mailbadger/app/routes/middleware"
+	"github.com/mailbadger/app/storage"
+)
+
+func init() {
+	gin.SetMode(gin.TestMode)
+}
+
+func setup(t *testing.T, s storage.Storage) *httpexpect.Expect {
+	err := os.Setenv("SESSION_AUTH_KEY", "foo")
+	if err != nil {
+		t.FailNow()
+	}
+	err = os.Setenv("SESSION_ENCRYPT_KEY", "secretexmplkeythatis32characters")
+	if err != nil {
+		t.FailNow()
+	}
+
+	cookiestore := cookie.NewStore(
+		[]byte(os.Getenv("SESSION_AUTH_KEY")),
+		[]byte(os.Getenv("SESSION_ENCRYPT_KEY")),
+	)
+	secureCookie, _ := strconv.ParseBool(os.Getenv("SECURE_COOKIE"))
+	cookiestore.Options(sessions.Options{
+		Secure:   secureCookie,
+		HttpOnly: true,
+	})
+
+	handler := gin.New()
+	handler.Use(sessions.Sessions("mbsess", cookiestore))
+	handler.Use(middleware.Storage(s))
+	handler.Use(middleware.SetUser())
+
+	routes.SetGuestRoutes(handler)
+	routes.SetAuthorizedRoutes(handler)
+
+	return httpexpect.WithConfig(httpexpect.Config{
+		Client: &http.Client{
+			Transport: httpexpect.NewBinder(handler),
+			Jar:       httpexpect.NewJar(),
+		},
+		Reporter: httpexpect.NewAssertReporter(t),
+		Printers: []httpexpect.Printer{
+			httpexpect.NewDebugPrinter(t, true),
+		},
+	})
+}
+
+func createAuthenticatedExpect(e *httpexpect.Expect, s storage.Storage) (*httpexpect.Expect, error) {
+	pass, err := bcrypt.GenerateFromPassword([]byte("hunter1"), bcrypt.DefaultCost)
+	if err != nil {
+		return nil, err
+	}
+
+	u := &entities.User{
+		Active:   true,
+		Username: "john",
+		Password: sql.NullString{
+			String: string(pass),
+			Valid:  true,
+		},
+	}
+	err = s.CreateUser(u)
+	if err != nil {
+		return nil, err
+	}
+
+	c := e.POST("/api/authenticate").WithForm(params.PostAuthenticate{
+		Username: "john",
+		Password: "hunter1",
+	}).Expect().Status(http.StatusOK).Cookie("mbsess")
+
+	return e.Builder(func(req *httpexpect.Request) {
+		req.WithCookie(c.Name().Raw(), c.Value().Raw())
+	}), nil
+}

actions/users_test.go

@@ -2,79 +2,30 @@ package actions_test
 
 import (
 	"net/http"
-	"os"
-	"strconv"
 	"testing"
 
-	"github.com/gin-contrib/sessions"
-	"github.com/gin-contrib/sessions/cookie"
-	"github.com/mailbadger/app/actions"
-	"github.com/mailbadger/app/routes/middleware"
-
-	"github.com/gavv/httpexpect/v2"
-	"github.com/gin-gonic/gin"
+	"github.com/mailbadger/app/storage"
 )
 
-func init() {
-	gin.SetMode(gin.TestMode)
-}
+func TestUser(t *testing.T) {
+	s := storage.New("sqlite3", ":memory:")
 
-func TestUnauthorizedUser(t *testing.T) {
-	err := os.Setenv("DATABASE_DRIVER", "sqlite3")
-	if err != nil {
-		t.FailNow()
-	}
-	err = os.Setenv("DATABASE_CONFIG", ":memory:")
-	if err != nil {
-		t.FailNow()
-	}
-	err = os.Setenv("SESSION_AUTH_KEY", "foo")
+	e := setup(t, s)
+	auth, err := createAuthenticatedExpect(e, s)
 	if err != nil {
+		t.Error(err)
 		t.FailNow()
 	}
-	err = os.Setenv("SESSION_AUTH_KEY", "secretexmplkeythatis32characters")
-	if err != nil {
-		t.FailNow()
-	}
-
-	store := cookie.NewStore(
-		[]byte(os.Getenv("SESSION_AUTH_KEY")),
-		[]byte(os.Getenv("SESSION_ENCRYPT_KEY")),
-	)
-	secureCookie, _ := strconv.ParseBool(os.Getenv("SECURE_COOKIE"))
-	store.Options(sessions.Options{
-		Secure:   secureCookie,
-		HttpOnly: true,
-	})
-
-	handler := gin.New()
-	handler.Use(sessions.Sessions("mbsess", store))
-	handler.Use(middleware.Storage())
-	handler.Use(middleware.SetUser())
-
-	authorized := handler.Group("/api")
-	authorized.Use(middleware.Authorized())
-	{
-		users := authorized.Group("/users")
-		{
-			users.GET("/me", actions.GetMe)
-			users.POST("/password", actions.ChangePassword)
-		}
-	}
-	e := httpexpect.WithConfig(httpexpect.Config{
-		Client: &http.Client{
-			Transport: httpexpect.NewBinder(handler),
-			Jar:       httpexpect.NewJar(),
-		},
-		Reporter: httpexpect.NewAssertReporter(t),
-		Printers: []httpexpect.Printer{
-			httpexpect.NewDebugPrinter(t, true),
-		},
-	})
 
 	e.GET("/api/users/me").
 		Expect().
 		Status(http.StatusUnauthorized).
 		JSON().Object().ValueEqual("message", "User not authorized")
 
+	auth.GET("/api/users/me").
+		Expect().
+		Status(http.StatusOK).
+		JSON().Object().
+		ValueEqual("username", "john").
+		ValueEqual("active", true)
 }

consumers/campaigner/main.go

@@ -124,12 +124,6 @@ func (h *MessageHandler) HandleMessage(m *nsq.Message) error {
 				dest = append(dest, d)
 			}
 
-			uuid, err := uuid.NewRandom()
-			if err != nil {
-				logrus.WithError(err).Error("Unable to generate random uuid.")
-				continue
-			}
-
 			defaultData, err := json.Marshal(msg.TemplateData)
 			if err != nil {
 				logrus.WithError(err).Error("Unable to marshal template data as JSON.")
@@ -158,6 +152,8 @@ func (h *MessageHandler) HandleMessage(m *nsq.Message) error {
 				input.ConfigurationSetName = aws.String(emails.ConfigurationSetName)
 			}
 
+			uuid := uuid.New()
+
 			bulkMsg := entities.BulkSendMessage{
 				UUID:       uuid.String(),
 				Input:      input,

dashboard/src/Templates/List.js

@@ -148,7 +148,7 @@ const List = () => {
   let table = null;
   if (state.isLoading) {
     table = <PlaceholderTable header={Header} numCols={4} numRows={5} />;
-  } else if (state.data.collection.length > 0) {
+  } else if (!state.isError && state.data.collection.length > 0) {
     table = (
       <TemplateTable
         isLoading={state.isLoading}
@@ -192,13 +192,13 @@ const List = () => {
         <Box animation="fadeIn">
           {table}
 
-          {!state.isLoading && state.data.collection.length === 0 ? (
+          {!state.isLoading && !state.isError && state.data.collection.length === 0 ? (
             <Box align="center" margin={{ top: "large" }}>
               <Heading level="2">Create your first template.</Heading>
             </Box>
           ) : null}
         </Box>
-        {!state.isLoading && state.data.collection.length > 0 ? (
+        {!state.isLoading && !state.isError && state.data.collection.length > 0 ? (
           <Box direction="row" alignSelf="end" margin={{ top: "medium" }}>
             <Box margin={{ right: "small" }}>
               <Button

go.sum

@@ -69,6 +69,7 @@ github.com/aws/aws-sdk-go v1.27.0 h1:0xphMHGMLBrPMfxR2AmVjZKcMEESEgWF8Kru94BNByk
 github.com/aws/aws-sdk-go v1.27.0/go.mod h1:KmX6BPdI08NWTb3/sm4ZGu5ShLoqVDhKgpiN924inxo=
 github.com/aws/aws-sdk-go v1.35.7 h1:FHMhVhyc/9jljgFAcGkQDYjpC9btM0B8VfkLBfctdNE=
 github.com/aws/aws-sdk-go v1.35.7/go.mod h1:tlPOdRjfxPBpNIwqDj61rmsnA85v9jc0Ps9+muhnW+k=
+github.com/aws/aws-sdk-go v1.35.9 h1:b1HiUpdkFLJyoOQ7zas36YHzjNHH0ivHx/G5lWBeg+U=
 github.com/aws/aws-sdk-go v1.35.9/go.mod h1:tlPOdRjfxPBpNIwqDj61rmsnA85v9jc0Ps9+muhnW+k=
 github.com/aws/aws-sdk-go-v2 v0.18.0/go.mod h1:JWVYvqSMppoMJC0x5wdwiImzgXTI9FuZwxzkQq9wy+g=
 github.com/beorn7/perks v0.0.0-20180321164747-3a771d992973/go.mod h1:Dwedo/Wpr24TaqPxmxbtue+5NUziq4I4S80YR8gNf3Q=

logger/logger.go

@@ -11,6 +11,10 @@ const key = "logger"
 
 // From returns a logger entry from the given context.
 func From(ctx context.Context) *logrus.Entry {
+	l := ctx.Value(key)
+	if l == nil {
+		return logrus.NewEntry(logrus.StandardLogger())
+	}
 	return ctx.Value(key).(*logrus.Entry)
 }
 

routes/middleware/requestid.go

@@ -2,11 +2,9 @@ package middleware
 
 import (
 	"context"
-	"net/http"
 
 	"github.com/gin-gonic/gin"
 	"github.com/google/uuid"
-	"github.com/sirupsen/logrus"
 )
 
 const reqIDKey = "reqid"
@@ -18,14 +16,7 @@ func RequestID() gin.HandlerFunc {
 		requestID := c.Request.Header.Get("X-Request-Id")
 
 		if requestID == "" {
-			uuid4, err := uuid.NewRandom()
-			if err != nil {
-				logrus.WithError(err).Error("RequestID: Unable to generate uuid")
-				c.AbortWithStatusJSON(http.StatusInternalServerError, gin.H{
-					"message": "We are unable to process the request at the moment. Please try again.",
-				})
-				return
-			}
+			uuid4 := uuid.New()
 			requestID = uuid4.String()
 		}
 

routes/middleware/storage.go

@@ -1,18 +1,12 @@
 package middleware
 
 import (
-	"os"
-
 	"github.com/gin-gonic/gin"
 	"github.com/mailbadger/app/storage"
 )
 
 // Storage is a middleware that inits the Storage and attaches it to the context.
-func Storage() gin.HandlerFunc {
-	driver := os.Getenv("DATABASE_DRIVER")
-	config := storage.MakeConfigFromEnv(driver)
-	s := storage.New(driver, config)
-
+func Storage(s storage.Storage) gin.HandlerFunc {
 	return func(c *gin.Context) {
 		storage.SetToContext(c, s)
 		c.Next()