gokit-service

README

About

go-kit service is a template for building microservice using golang with tranport http or grpc.

Structure Project

.
├── cmd
│   ├── grpc
│   ├── http
│   └── migrate
├── endpoint
├── entity
├── mock
├── pkg
│   ├── bcrypt
│   ├── env
│   ├── jwt
│   └── uuid
├── proto
├── repository
│   ├── postgres
│   └── redis
├── resource
│   ├── migration
│   ├── seeder
│   └── view
├── service
├── transport
│   ├── grpctrans
│   └── httptrans
└── validate

Directory	Description
cmd	...
endpoint	...
entity	...
mock	...
pkg	...
proto	...
repository	...
resource	...
service	...
transport	...
validate	...

Table of Content

• Guide
  • Pre-Development
  • Tech Stack
  • Commands
  • Example
• Rules
  • Package Name
  • Filename
  • Folder
• Style
  • Unnecessary Else
  • Use Raw String Literals to Avoid Escaping
• Patterns
  • Test Tables
  • -

Guide

Before starting to use this project, it is a good idea to read the guide below.

Pre-Development

• Go (Golang) is an programming language More Info
• Git version control of source code More Info
• GNU Make for running a command More Info
• Docker is an open platform for developing, shipping, and running applications. More Info
• Goose for create migration file and run migration to database More Info
• Mockery for generate mock from interface More Info

Tech Stack

• DATA-DOG/go-sqlmock github
• go-kit/kit github
• go-kit/log github
• go-playground/validator github
• go-redis/redis github
• go-redis/redismock github
• golang/protobuf github
• google/uuid github
• gorilla/mux github
• grpc-ecosystem/grpc-gateway github
• joho/godotenv github
• lib/pg github
• pressly/goose github
• stretchr/testify github
• x/crypto github
• google.golang.org/grpc github
• google.golang.org/protobuf github

Commands

# how to run application
make run

# how to run test
make test

# how to run test with covarage
make cover

# how to run migration
make migrate

# how to create migration file
make migration
# or
make migration filename=foo

# how to generate server.key and server.crt
make gentls

# how to generate generate from *.proto
make protoc

# how to generate mock from interface
make mock

Example

package main

import "fmt"

func main() {
    fmt.Println("Hello World")
}

Rules

Please use these rules to be consistent.

Package Name

• All lower-case. No capitals or underscores.
• Not plural. For example, net/url, not net/urls.
• Not common, util, shared, or lib. These are bad, uninformative names.

Filename

• Lower snake case. For example, file_name.go or filename.go
• No dash. For example, file-name.go ❌

Folder

• All lower-case. No capitals or underscores.
• Use dash. For example, resource
• Not plural. For example, view, not views.

Style

Please use these style to be consistent.

Unnecessary Else

// Bad
var a int
if b {
  a = 100
} else {
  a = 10
}

// Good
a := 10
if b {
  a = 100
}

Use Raw String Literals to Avoid Escaping

// Bad
wantError := "unknown name:\"test\""

// Good
wantError := `unknown error:"test"`

Patterns

Please use these patterns to be consistent.

Test Tables

Use table-driven tests with subtests to avoid duplicating code when the core test logic is repetitive.

// Bad
host, port, err := net.SplitHostPort("192.0.2.0:8000")
require.NoError(t, err)
assert.Equal(t, "192.0.2.0", host)
assert.Equal(t, "8000", port)

host, port, err = net.SplitHostPort("192.0.2.0:http")
require.NoError(t, err)
assert.Equal(t, "192.0.2.0", host)
assert.Equal(t, "http", port)

// Good
tests := []struct{
  give     string
  wantHost string
  wantPort string
}{
  {
    give:     "192.0.2.0:8000",
    wantHost: "192.0.2.0",
    wantPort: "8000",
  },
  {
    give:     "192.0.2.0:http",
    wantHost: "192.0.2.0",
    wantPort: "http",
  },
}

for _, tt := range tests {
  t.Run(tt.give, func(t *testing.T) {
    host, port, err := net.SplitHostPort(tt.give)
    require.NoError(t, err)
    assert.Equal(t, tt.wantHost, host)
    assert.Equal(t, tt.wantPort, port)
  })
}