Add lesson03 / video02

Author: joanlopez

03-02-repository-test/cmd/api/bootstrap/boostrap.go

@@ -0,0 +1,34 @@
+package bootstrap
+
+import (
+	"database/sql"
+	"fmt"
+
+	"github.com/CodelyTV/go-hexagonal_http_api-course/03-02-repository-test/internal/platform/server"
+	"github.com/CodelyTV/go-hexagonal_http_api-course/03-02-repository-test/internal/platform/storage/mysql"
+	_ "github.com/go-sql-driver/mysql"
+)
+
+const (
+	host = "localhost"
+	port = 8080
+
+	dbUser = "codely"
+	dbPass = "codely"
+	dbHost = "localhost"
+	dbPort = "3306"
+	dbName = "codely"
+)
+
+func Run() error {
+	mysqlURI := fmt.Sprintf("%s:%s@tcp(%s:%s)/%s", dbUser, dbPass, dbHost, dbPort, dbName)
+	db, err := sql.Open("mysql", mysqlURI)
+	if err != nil {
+		return err
+	}
+
+	courseRepository := mysql.NewCourseRepository(db)
+
+	srv := server.New(host, port, courseRepository)
+	return srv.Run()
+}

03-02-repository-test/cmd/api/main.go

@@ -0,0 +1,13 @@
+package main
+
+import (
+	"log"
+
+	"github.com/CodelyTV/go-hexagonal_http_api-course/03-02-repository-test/cmd/api/bootstrap"
+)
+
+func main() {
+	if err := bootstrap.Run(); err != nil {
+		log.Fatal(err)
+	}
+}

03-02-repository-test/internal/course.go

@@ -0,0 +1,131 @@
+package mooc
+
+import (
+	"context"
+	"errors"
+	"fmt"
+
+	"github.com/google/uuid"
+)
+
+var ErrInvalidCourseID = errors.New("invalid Course ID")
+
+// CourseID represents the course unique identifier.
+type CourseID struct {
+	value string
+}
+
+// NewCourseID instantiate the VO for CourseID
+func NewCourseID(value string) (CourseID, error) {
+	v, err := uuid.Parse(value)
+	if err != nil {
+		return CourseID{}, fmt.Errorf("%w: %s", ErrInvalidCourseID, value)
+	}
+
+	return CourseID{
+		value: v.String(),
+	}, nil
+}
+
+// String type converts the CourseID into string.
+func (id CourseID) String() string {
+	return id.value
+}
+
+var ErrEmptyCourseName = errors.New("the field Course Name can not be empty")
+
+// CourseName represents the course name.
+type CourseName struct {
+	value string
+}
+
+// NewCourseName instantiate VO for CourseName
+func NewCourseName(value string) (CourseName, error) {
+	if value == "" {
+		return CourseName{}, ErrEmptyCourseName
+	}
+
+	return CourseName{
+		value: value,
+	}, nil
+}
+
+// String type converts the CourseName into string.
+func (name CourseName) String() string {
+	return name.value
+}
+
+var ErrEmptyDuration = errors.New("the field Duration can not be empty")
+
+// CourseDuration represents the course duration.
+type CourseDuration struct {
+	value string
+}
+
+func NewCourseDuration(value string) (CourseDuration, error) {
+	if value == "" {
+		return CourseDuration{}, ErrEmptyDuration
+	}
+
+	return CourseDuration{
+		value: value,
+	}, nil
+}
+
+// String type converts the CourseDuration into string.
+func (duration CourseDuration) String() string {
+	return duration.value
+}
+
+// CourseRepository defines the expected behaviour from a course storage.
+type CourseRepository interface {
+	Save(ctx context.Context, course Course) error
+}
+
+//go:generate mockery --case=snake --outpkg=storagemocks --output=platform/storage/storagemocks --name=CourseRepository
+
+// Course is the data structure that represents a course.
+type Course struct {
+	id       CourseID
+	name     CourseName
+	duration CourseDuration
+}
+
+// NewCourse creates a new course.
+func NewCourse(id, name, duration string) (Course, error) {
+	idVO, err := NewCourseID(id)
+	if err != nil {
+		return Course{}, err
+	}
+
+	nameVO, err := NewCourseName(name)
+	if err != nil {
+		return Course{}, err
+	}
+
+	durationVO, err := NewCourseDuration(duration)
+	if err != nil {
+		return Course{}, err
+	}
+
+	return Course{
+		id:       idVO,
+		name:     nameVO,
+		duration: durationVO,
+	}, nil
+}
+
+// ID returns the course unique identifier.
+func (c Course) ID() CourseID {
+	return c.id
+}
+
+// Name returns the course name.
+func (c Course) Name() CourseName {
+	return c.name
+}
+
+// Duration returns the course duration.
+func (c Course) Duration() CourseDuration {
+	return c.duration
+}

03-02-repository-test/internal/platform/server/handler/courses/create.go

@@ -0,0 +1,38 @@
+package courses
+
+import (
+	"net/http"
+
+	mooc "github.com/CodelyTV/go-hexagonal_http_api-course/03-02-repository-test/internal"
+	"github.com/gin-gonic/gin"
+)
+
+type createRequest struct {
+	ID       string `json:"id" binding:"required"`
+	Name     string `json:"name" binding:"required"`
+	Duration string `json:"duration" binding:"required"`
+}
+
+// CreateHandler returns an HTTP handler for courses creation.
+func CreateHandler(courseRepository mooc.CourseRepository) gin.HandlerFunc {
+	return func(ctx *gin.Context) {
+		var req createRequest
+		if err := ctx.BindJSON(&req); err != nil {
+			ctx.JSON(http.StatusBadRequest, err.Error())
+			return
+		}
+
+		course, err := mooc.NewCourse(req.ID, req.Name, req.Duration)
+		if err != nil {
+			ctx.JSON(http.StatusBadRequest, err.Error())
+			return
+		}
+
+		if err := courseRepository.Save(ctx, course); err != nil {
+			ctx.JSON(http.StatusInternalServerError, err.Error())
+			return
+		}
+
+		ctx.Status(http.StatusCreated)
+	}
+}

03-02-repository-test/internal/platform/server/handler/courses/create_test.go

@@ -0,0 +1,67 @@
+package courses
+
+import (
+	"bytes"
+	"encoding/json"
+	"net/http"
+	"net/http/httptest"
+	"testing"
+
+	"github.com/CodelyTV/go-hexagonal_http_api-course/03-02-repository-test/internal/platform/storage/storagemocks"
+	"github.com/gin-gonic/gin"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/mock"
+	"github.com/stretchr/testify/require"
+)
+
+func TestHandler_Create(t *testing.T) {
+	courseRepository := new(storagemocks.CourseRepository)
+	courseRepository.On("Save", mock.Anything, mock.AnythingOfType("mooc.Course")).Return(nil)
+
+	gin.SetMode(gin.TestMode)
+	r := gin.New()
+	r.POST("/courses", CreateHandler(courseRepository))
+
+	t.Run("given an invalid request it returns 400", func(t *testing.T) {
+		createCourseReq := createRequest{
+			Name:     "Demo Course",
+			Duration: "10 months",
+		}
+
+		b, err := json.Marshal(createCourseReq)
+		require.NoError(t, err)
+
+		req, err := http.NewRequest(http.MethodPost, "/courses", bytes.NewBuffer(b))
+		require.NoError(t, err)
+
+		rec := httptest.NewRecorder()
+		r.ServeHTTP(rec, req)
+
+		res := rec.Result()
+		defer res.Body.Close()
+
+		assert.Equal(t, http.StatusBadRequest, res.StatusCode)
+	})
+
+	t.Run("given a valid request it returns 201", func(t *testing.T) {
+		createCourseReq := createRequest{
+			ID:       "8a1c5cdc-ba57-445a-994d-aa412d23723f",
+			Name:     "Demo Course",
+			Duration: "10 months",
+		}
+
+		b, err := json.Marshal(createCourseReq)
+		require.NoError(t, err)
+
+		req, err := http.NewRequest(http.MethodPost, "/courses", bytes.NewBuffer(b))
+		require.NoError(t, err)
+
+		rec := httptest.NewRecorder()
+		r.ServeHTTP(rec, req)
+
+		res := rec.Result()
+		defer res.Body.Close()
+
+		assert.Equal(t, http.StatusCreated, res.StatusCode)
+	})
+}

03-02-repository-test/internal/platform/server/handler/health/check.go

@@ -0,0 +1,14 @@
+package health
+
+import (
+	"net/http"
+
+	"github.com/gin-gonic/gin"
+)
+
+// CheckHandler returns an HTTP handler to perform health checks.
+func CheckHandler() gin.HandlerFunc {
+	return func(ctx *gin.Context) {
+		ctx.String(http.StatusOK, "everything is ok!")
+	}
+}

03-02-repository-test/internal/platform/server/handler/health/check_test.go

@@ -0,0 +1,30 @@
+package health
+
+import (
+	"net/http"
+	"net/http/httptest"
+	"testing"
+
+	"github.com/gin-gonic/gin"
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func TestHandler_Check(t *testing.T) {
+	gin.SetMode(gin.TestMode)
+	r := gin.New()
+	r.GET("/health", CheckHandler())
+
+	t.Run("it returns 200", func(t *testing.T) {
+		req, err := http.NewRequest(http.MethodGet, "/health", nil)
+		require.NoError(t, err)
+
+		rec := httptest.NewRecorder()
+		r.ServeHTTP(rec, req)
+
+		res := rec.Result()
+		defer res.Body.Close()
+
+		assert.Equal(t, http.StatusOK, res.StatusCode)
+	})
+}

03-02-repository-test/internal/platform/server/server.go

@@ -0,0 +1,41 @@
+package server
+
+import (
+	"fmt"
+	"log"
+
+	mooc "github.com/CodelyTV/go-hexagonal_http_api-course/03-02-repository-test/internal"
+	"github.com/CodelyTV/go-hexagonal_http_api-course/03-02-repository-test/internal/platform/server/handler/courses"
+	"github.com/CodelyTV/go-hexagonal_http_api-course/03-02-repository-test/internal/platform/server/handler/health"
+	"github.com/gin-gonic/gin"
+)
+
+type Server struct {
+	httpAddr string
+	engine   *gin.Engine
+
+	// deps
+	courseRepository mooc.CourseRepository
+}
+
+func New(host string, port uint, courseRepository mooc.CourseRepository) Server {
+	srv := Server{
+		engine:   gin.New(),
+		httpAddr: fmt.Sprintf("%s:%d", host, port),
+
+		courseRepository: courseRepository,
+	}
+
+	srv.registerRoutes()
+	return srv
+}
+
+func (s *Server) Run() error {
+	log.Println("Server running on", s.httpAddr)
+	return s.engine.Run(s.httpAddr)
+}
+
+func (s *Server) registerRoutes() {
+	s.engine.GET("/health", health.CheckHandler())
+	s.engine.POST("/courses", courses.CreateHandler(s.courseRepository))
+}

03-02-repository-test/internal/platform/storage/mysql/course.go

@@ -0,0 +1,11 @@
+package mysql
+
+const (
+	sqlCourseTable = "courses"
+)
+
+type sqlCourse struct {
+	ID       string `db:"id"`
+	Name     string `db:"name"`
+	Duration string `db:"duration"`
+}