Initial commit

Author: TristanSpeakEasy

.github/workflows/lint.yml

@@ -0,0 +1,24 @@
+name: lint
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+env:
+  GOPRIVATE: "github.com/speakeasy-api"
+jobs:
+  golangci:
+    name: lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/setup-go@v3
+        with:
+          go-version: 1.18
+
+      - uses: actions/checkout@v3
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v3
+        with:
+          # Optional: version of golangci-lint to use in form of v1.2 or v1.2.3 or `latest` to use the latest version
+          version: latest

.github/workflows/tests.yml

@@ -0,0 +1,31 @@
+name: Tests
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+env:
+  GOPRIVATE: "github.com/speakeasy-api"
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: true
+      matrix:
+        go-version: [1.18.x]
+
+    name: Tests - Go ${{ matrix.go-version }}
+
+    steps:
+      - name: Checkout the code
+        uses: actions/checkout@v2
+
+      - name: Install Go
+        uses: actions/setup-go@v2
+        with:
+          go-version: ${{ matrix.go-version }}
+
+      - name: Run the tests
+        run: go test ./...

.gitignore

@@ -0,0 +1,44 @@
+linters:
+  enable-all: true
+  disable:
+    - lll
+    - varnamelen
+    - exhaustivestruct
+    - exhaustruct
+    - godox
+    - nlreturn
+    - wsl
+    - wrapcheck
+    - gochecknoglobals
+    - paralleltest
+    - dupl
+    - containedctx
+    # Deprecated
+    - golint
+    - maligned
+    - interfacer
+    - scopelint
+issues:
+  exclude:
+    - "returns unexported type"
+    - "unlambda"
+    - "should rewrite http.NewRequestWithContext"
+  exclude-rules:
+    # Exclude some linters from running on tests files.
+    - path: _test\.go
+      linters:
+        - scopelint
+        - goerr113
+        - funlen
+        - gocognit
+        - cyclop
+    - path: _exports_test\.go
+      linters:
+        - testpackage
+  include:
+    - EXC0012
+    - EXC0013
+    - EXC0014
+    - EXC0015
+run:
+  go: "1.14"

.golangci.yaml

@@ -0,0 +1,29 @@
+# syntax=docker/dockerfile:1
+
+# Build the application
+
+FROM golang:1.18-alpine AS build
+
+WORKDIR /app
+
+COPY ./ ./
+
+RUN go mod download
+
+RUN ls -lrt
+
+RUN go build -o ./server ./cmd/server/main.go 
+
+# Build the server image
+
+FROM alpine:latest
+
+RUN apk --no-cache add ca-certificates
+
+WORKDIR /root/
+
+COPY --from=0 /app/server ./
+COPY --from=0 /app/config/config-docker.yaml ./config/config.yaml
+COPY --from=0 /app/migrations/ ./migrations/
+
+CMD ["./server"]

Dockerfile

@@ -0,0 +1,33 @@
+# speakeasy-example-rest-service-go
+
+## Getting Started
+
+### Prerequisites
+
+* Go 1.18 (though should be backwards compatible with earlier versions)
+
+### Running locally
+
+1. From root of the repo
+2. Run `go mod download` to install dependencies
+3. Run `docker-compose up -d postgres` to run the postgres dependency
+4. Run `go run cmd/server/main.go` will start the server on port 8080
+
+### Running via docker
+
+1. From root of the repo
+2. Run `docker-compose up` will start the dependencies and server on port 8080
+
+### Postman
+
+I have provided Postman collections for testing out the REST endpoints exposed by the service.
+There is a `Bootstrap Users` collection that can be run using the `Run collection` tool in Postman that will create 100 users to test the search endpoint with.
+
+The collections will need an environment setup with `scheme`, `port` and `host` variables setup with values of `http`, `8080` and `localhost` respectively.
+
+### Run tests
+
+The service contains a collection of unit and integration tests for testing the various layers of the service. Some of the integration tests use docker to spin up dependencies on demand (ie a postgres db) so just be aware that docker is needed to run the tests.
+
+1. From root of the repo
+2. Run `go test ./...`

README.md

@@ -0,0 +1,86 @@
+package main
+
+import (
+	"context"
+
+	"github.com/cenkalti/backoff/v4"
+	"github.com/speakeasy-api/speakeasy-example-rest-service-go/internal/config"
+	"github.com/speakeasy-api/speakeasy-example-rest-service-go/internal/core/app"
+	"github.com/speakeasy-api/speakeasy-example-rest-service-go/internal/core/drivers/psql"
+	"github.com/speakeasy-api/speakeasy-example-rest-service-go/internal/core/listeners/http"
+	"github.com/speakeasy-api/speakeasy-example-rest-service-go/internal/core/logging"
+	"github.com/speakeasy-api/speakeasy-example-rest-service-go/internal/events"
+	httptransport "github.com/speakeasy-api/speakeasy-example-rest-service-go/internal/transport/http"
+	"github.com/speakeasy-api/speakeasy-example-rest-service-go/internal/users"
+	"github.com/speakeasy-api/speakeasy-example-rest-service-go/internal/users/store"
+
+	"go.uber.org/zap"
+)
+
+func main() {
+	app.Start(appStart)
+}
+
+func appStart(ctx context.Context, a *app.App) ([]app.Listener, error) {
+	// Load configuration from config/config.yaml which contains details such as DB connection params
+	cfg, err := config.Load()
+	if err != nil {
+		return nil, err
+	}
+
+	// Connect to the postgres DB
+	db, err := initDatabase(ctx, cfg, a)
+	if err != nil {
+		return nil, err
+	}
+
+	// Run our migrations which will update the DB or create it if it doesn't exist
+	if err := db.MigratePostgres(ctx, "file://migrations"); err != nil {
+		return nil, err
+	}
+	a.OnShutdown(func() {
+		// Temp for development so database is cleared on shutdown
+		if err := db.RevertMigrations(ctx, "file://migrations"); err != nil {
+			logging.From(ctx).Error("failed to revert migrations", zap.Error(err))
+		}
+	})
+
+	// Instantiate and connect all our classes
+	us := store.New(db.GetDB())
+	e := events.New()
+	u := users.New(us, e)
+
+	httpServer := httptransport.New(u, db.GetDB())
+
+	// Create a HTTP server
+	h, err := http.New(httpServer, cfg.HTTP)
+	if err != nil {
+		return nil, err
+	}
+
+	// Start listening for HTTP requests
+	return []app.Listener{
+		h,
+	}, nil
+}
+
+func initDatabase(ctx context.Context, cfg *config.Config, a *app.App) (*psql.Driver, error) {
+	db := psql.New(cfg.PSQL)
+
+	err := backoff.Retry(func() error {
+		return db.Connect(ctx)
+	}, backoff.NewExponentialBackOff())
+	if err != nil {
+		return nil, err
+	}
+
+	a.OnShutdown(func() {
+		// Shutdown connection when server terminated
+		logging.From(ctx).Info("shutting down db connection")
+		if err := db.Close(ctx); err != nil {
+			logging.From(ctx).Error("failed to close db connection", zap.Error(err))
+		}
+	})
+
+	return db, nil
+}

cmd/server/main.go

@@ -0,0 +1,8 @@
+http:
+  port: "8080"
+psql:
+  username: guest
+  password: guest
+  host: postgres
+  port: 5432
+  database: speakeasy

config/config-docker.yaml

@@ -0,0 +1,8 @@
+http:
+  port: "8080"
+psql:
+  username: guest
+  password: guest
+  host: localhost
+  port: 5432
+  database: speakeasy

config/config.yaml

@@ -0,0 +1,17 @@
+version: "3.9"
+services:
+  app:
+    build: .
+    ports:
+      - "8080:8080"
+    depends_on:
+      - postgres
+  postgres:
+    image: postgres:alpine
+    restart: always
+    environment:
+      POSTGRES_USER: guest
+      POSTGRES_PASSWORD: guest
+      POSTGRES_DB: speakeasy
+    ports:
+      - "5432:5432"