Merge pull request #844 from traPtitech/logging

logging/context.go

@@ -0,0 +1,32 @@
+package logging
+
+import (
+	"context"
+	"errors"
+
+	"go.uber.org/zap"
+)
+
+type contextKey struct{}
+
+var ErrLoggerNotSet = errors.New("logger not set in context")
+
+func SetLogger(ctx context.Context, logger *zap.Logger) context.Context {
+	return context.WithValue(ctx, contextKey{}, logger)
+}
+
+func GetLoggerMaybe(ctx context.Context) (*zap.Logger, error) {
+	logger, ok := ctx.Value(contextKey{}).(*zap.Logger)
+	if !ok {
+		return nil, ErrLoggerNotSet
+	}
+	return logger, nil
+}
+
+func GetLogger(ctx context.Context) *zap.Logger {
+	logger, err := GetLoggerMaybe(ctx)
+	if err != nil {
+		panic(err)
+	}
+	return logger
+}

logging/load.go

@@ -0,0 +1,36 @@
+package logging
+
+import (
+	"errors"
+	"os"
+
+	"go.uber.org/zap"
+)
+
+type Mode string
+
+const (
+	Development Mode = "development"
+	Production  Mode = "production"
+)
+
+var ErrUnknownMode = errors.New("unknown mode")
+
+func Load(mode Mode) (*zap.Logger, error) {
+	switch mode {
+	case Development:
+		return zap.NewDevelopment()
+	case Production:
+		return zap.NewProduction()
+	default:
+		return nil, ErrUnknownMode
+	}
+}
+
+func ModeFromEnv(varName string) Mode {
+	// TODO: strconv.ParseBool を使う
+	if os.Getenv(varName) != "" {
+		return Development
+	}
+	return Production
+}

main.go

@@ -3,6 +3,7 @@ package main
 import (
 	"os"
 
+	"github.com/traPtitech/Jomon/logging"
 	"github.com/traPtitech/Jomon/model"
 	"github.com/traPtitech/Jomon/router"
 	"github.com/traPtitech/Jomon/storage"
@@ -41,28 +42,23 @@ func main() {
 	repo := model.NewEntRepository(client, strg)
 
 	// Setup server
-	var logger *zap.Logger
-	if os.Getenv("IS_DEBUG_MODE") != "" {
-		logger, err = zap.NewDevelopment()
-	} else {
-		logger, err = zap.NewProduction()
+	logMode := logging.ModeFromEnv("IS_DEBUG_MODE")
+	logger, err := logging.Load(logMode)
+	if err != nil {
+		panic(err)
 	}
 	defer func() {
 		if err := logger.Sync(); err != nil {
 			panic(err)
 		}
 	}()
-	if err != nil {
-		panic(err)
-	}
 	handlers := router.Handlers{
 		Repository:  repo,
 		Storage:     strg,
-		Logger:      logger,
 		SessionName: "session",
 	}
 
-	server := router.NewServer(handlers)
+	server := handlers.NewServer(logger)
 
 	port := os.Getenv("PORT")
 	if port == "" {

model/admin_impl_test.go

@@ -1,17 +1,17 @@
 package model
 
 import (
-	"context"
 	"testing"
 
 	"github.com/google/uuid"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
+	"github.com/traPtitech/Jomon/testutil"
 	"github.com/traPtitech/Jomon/testutil/random"
 )
 
 func TestEntRepository_GetAdmins(t *testing.T) {
-	ctx := context.Background()
+	ctx := testutil.NewContext(t)
 	client, storage, err := setup(t, ctx, "get_admins")
 	require.NoError(t, err)
 	repo := NewEntRepository(client, storage)
@@ -53,7 +53,7 @@ func TestEntRepository_GetAdmins(t *testing.T) {
 }
 
 func TestEntRepository_AddAdmins(t *testing.T) {
-	ctx := context.Background()
+	ctx := testutil.NewContext(t)
 	client, storage, err := setup(t, ctx, "add_admins")
 	require.NoError(t, err)
 	repo := NewEntRepository(client, storage)
@@ -77,7 +77,7 @@ func TestEntRepository_AddAdmins(t *testing.T) {
 }
 
 func TestEntRepository_DeleteAdmins(t *testing.T) {
-	ctx := context.Background()
+	ctx := testutil.NewContext(t)
 	client, storage, err := setup(t, ctx, "delete_admins")
 	require.NoError(t, err)
 	repo := NewEntRepository(client, storage)

model/comment_impl_test.go

@@ -1,7 +1,6 @@
 package model
 
 import (
-	"context"
 	"testing"
 	"time"
 
@@ -14,7 +13,7 @@ import (
 )
 
 func TestEntRepository_GetComments(t *testing.T) {
-	ctx := context.Background()
+	ctx := testutil.NewContext(t)
 	client, storage, err := setup(t, ctx, "get_comments")
 	require.NoError(t, err)
 	repo := NewEntRepository(client, storage)
@@ -83,7 +82,7 @@ func TestEntRepository_GetComments(t *testing.T) {
 }
 
 func TestEntRepository_CreateComment(t *testing.T) {
-	ctx := context.Background()
+	ctx := testutil.NewContext(t)
 	client, storage, err := setup(t, ctx, "create_comment")
 	require.NoError(t, err)
 	repo := NewEntRepository(client, storage)
@@ -159,7 +158,7 @@ func TestEntRepository_CreateComment(t *testing.T) {
 }
 
 func TestEntRepository_UpdateComment(t *testing.T) {
-	ctx := context.Background()
+	ctx := testutil.NewContext(t)
 	client, storage, err := setup(t, ctx, "update_comment")
 	require.NoError(t, err)
 	repo := NewEntRepository(client, storage)
@@ -285,7 +284,7 @@ func TestEntRepository_UpdateComment(t *testing.T) {
 }
 
 func TestEntRepository_DeleteComment(t *testing.T) {
-	ctx := context.Background()
+	ctx := testutil.NewContext(t)
 	client, storage, err := setup(t, ctx, "delete_comment")
 	require.NoError(t, err)
 	repo := NewEntRepository(client, storage)

model/file_impl_test.go

@@ -1,7 +1,6 @@
 package model
 
 import (
-	"context"
 	"testing"
 	"time"
 
@@ -14,14 +13,14 @@ import (
 )
 
 func TestEntRepository_CreateFile(t *testing.T) {
-	ctx := context.Background()
+	ctx := testutil.NewContext(t)
 	client, storage, err := setup(t, ctx, "create_file")
 	require.NoError(t, err)
 	repo := NewEntRepository(client, storage)
 
 	t.Run("Success", func(t *testing.T) {
 		t.Parallel()
-		ctx := context.Background()
+		ctx := testutil.NewContext(t)
 
 		var tags []*Tag
 		var targets []*RequestTarget
@@ -60,7 +59,7 @@ func TestEntRepository_CreateFile(t *testing.T) {
 
 	t.Run("UnknownRequest", func(t *testing.T) {
 		t.Parallel()
-		ctx := context.Background()
+		ctx := testutil.NewContext(t)
 
 		user, err := repo.CreateUser(
 			ctx,
@@ -82,7 +81,7 @@ func TestEntRepository_CreateFile(t *testing.T) {
 
 	t.Run("MissingName", func(t *testing.T) {
 		t.Parallel()
-		ctx := context.Background()
+		ctx := testutil.NewContext(t)
 
 		var tags []*Tag
 		var targets []*RequestTarget
@@ -109,14 +108,14 @@ func TestEntRepository_CreateFile(t *testing.T) {
 }
 
 func TestEntRepository_GetFile(t *testing.T) {
-	ctx := context.Background()
+	ctx := testutil.NewContext(t)
 	client, storage, err := setup(t, ctx, "get_file")
 	require.NoError(t, err)
 	repo := NewEntRepository(client, storage)
 
 	t.Run("Success", func(t *testing.T) {
 		t.Parallel()
-		ctx := context.Background()
+		ctx := testutil.NewContext(t)
 
 		var tags []*Tag
 		var targets []*RequestTarget
@@ -156,22 +155,22 @@ func TestEntRepository_GetFile(t *testing.T) {
 
 	t.Run("UnknownFile", func(t *testing.T) {
 		t.Parallel()
-		ctx := context.Background()
+		ctx := testutil.NewContext(t)
 
 		_, err = repo.GetFile(ctx, uuid.New())
 		assert.Error(t, err)
 	})
 }
 
 func TestEntRepository_DeleteFile(t *testing.T) {
-	ctx := context.Background()
+	ctx := testutil.NewContext(t)
 	client, storage, err := setup(t, ctx, "delete_file")
 	require.NoError(t, err)
 	repo := NewEntRepository(client, storage)
 
 	t.Run("Success", func(t *testing.T) {
 		t.Parallel()
-		ctx := context.Background()
+		ctx := testutil.NewContext(t)
 
 		var tags []*Tag
 		var targets []*RequestTarget
@@ -207,7 +206,7 @@ func TestEntRepository_DeleteFile(t *testing.T) {
 
 	t.Run("UnknownFile", func(t *testing.T) {
 		t.Parallel()
-		ctx := context.Background()
+		ctx := testutil.NewContext(t)
 
 		err = repo.DeleteFile(ctx, uuid.New())
 		assert.Error(t, err)