Merge pull request #49 from bmf-san/feature/improve-test-coverage

Improve test coverage

.github/workflows/lint.yml

@@ -7,7 +7,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        go-version: [ '1.22.3' ]
+        go-version: [ '1.22.4' ]
     steps:
       - uses: actions/checkout@v4
         with:

.github/workflows/release-dry-run.yml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        go-version: [ '1.22.3' ]
+        go-version: [ '1.22.4' ]
     steps:
       - name: Checkout
         uses: actions/checkout@v4

.github/workflows/release.yml

@@ -13,7 +13,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        go-version: [ '1.22.3' ]
+        go-version: [ '1.22.4' ]
     steps:
       - name: Checkout
         uses: actions/checkout@v4

.github/workflows/test.yml

@@ -7,7 +7,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        go-version: [ '1.22.3' ]
+        go-version: [ '1.22.4' ]
     steps:
       - uses: actions/checkout@v4
         with:
@@ -21,3 +21,13 @@ jobs:
           go-version: ${{ matrix.go-version }}
       - name: Run test
         run: make test
+      - name: Run coverage
+        run: make test-cover OUT=coverage.out
+      - name: Upload coverage to Codecov
+        uses: codecov/[email protected]
+        with:
+          fail_ci_if_error: true
+          file: ./coverage.out
+          token: ${{ secrets.CODECOV_TOKEN }}
+          verbose: true
+

_examples/backend1/Dockerfile

@@ -1,4 +1,4 @@
-FROM golang:1.22.3-alpine
+FROM golang:1.22.4-alpine
 
 WORKDIR /app
 

_examples/backend1/go.mod

@@ -1,3 +1,3 @@
 module github.com/bmf-san/gondola/_examples/backend
 
-go 1.22.3
+go 1.22.4

_examples/backend2/Dockerfile

@@ -1,4 +1,4 @@
-FROM golang:1.22.3-alpine
+FROM golang:1.22.4-alpine
 
 WORKDIR /app
 

_examples/backend2/go.mod

@@ -1,3 +1,3 @@
 module github.com/bmf-san/gondola/_examples/backend
 
-go 1.22.3
+go 1.22.4

_examples/proxy/Dockerfile

@@ -1,4 +1,4 @@
-FROM golang:1.22.3-alpine
+FROM golang:1.22.4-alpine
 
 WORKDIR /app
 

_examples/proxy/config.yaml

@@ -12,4 +12,4 @@ upstreams:
     target: http://backend1:8081 # backend1　is the name of the container
   - host_name: backend2.local
     target: http://backend2:8082 # backend2　is the name of the container
-log_level: 0 # Debug:-4 Info:0 Warn:4 Error:8
+log_level: 0 # Debug:-4 Info:0 Warn:4 Error:8

config_test.go

@@ -1,9 +1,12 @@
 package gondola
 
 import (
+	"bytes"
+	"errors"
 	"reflect"
 	"strings"
 	"testing"
+	"testing/iotest"
 )
 
 func TestIsEnableTLS(t *testing.T) {
@@ -106,3 +109,22 @@ log_level: -4
 		}
 	}
 }
+
+func TestLoadReadAllError(t *testing.T) {
+	reader := iotest.ErrReader(errors.New("error"))
+	var c Config
+	_, err := c.Load(reader)
+	if err == nil {
+		t.Fatalf("Expected error, got nil")
+	}
+}
+
+func TestLoadUnmarshalError(t *testing.T) {
+	data := ":\n"
+	reader := bytes.NewBufferString(data)
+	var c Config
+	_, err := c.Load(reader)
+	if err == nil {
+		t.Fatalf("Expected error, got nil")
+	}
+}

error.go

@@ -0,0 +1,42 @@
+package gondola
+
+import (
+	"fmt"
+	"net/http"
+)
+
+// Gondola is a proxy server.
+type Gondola struct {
+	config *Config
+	server *http.Server
+}
+
+// ConfigLoadError is an error that occurs when loading the configuration.
+type ConfigLoadError struct {
+	Err error
+}
+
+// Error implements the error interface.
+func (e *ConfigLoadError) Error() string {
+	return fmt.Sprintf("error loading config: %v", e.Err)
+}
+
+// Unwrap implements the errors.Wrapper interface.
+func (e *ConfigLoadError) Unwrap() error {
+	return e.Err
+}
+
+// ProxyServerError is an error that occurs when creating the server.
+type ProxyServerError struct {
+	Err error
+}
+
+// Error implements the error interface.
+func (e *ProxyServerError) Error() string {
+	return fmt.Sprintf("error creating server: %v", e.Err)
+}
+
+// Unwrap implements the errors.Wrapper interface.
+func (e *ProxyServerError) Unwrap() error {
+	return e.Err
+}

errors_test.go

@@ -0,0 +1,23 @@
+package gondola
+
+import "testing"
+
+func TestConfigLoadError(t *testing.T) {
+	err := &ConfigLoadError{}
+	if err.Error() != "error loading config: <nil>" {
+		t.Errorf("Expected error loading config: <nil>, got %v", err.Error())
+	}
+	if err.Unwrap() != nil {
+		t.Errorf("Expected nil, got %v", err.Unwrap())
+	}
+}
+
+func TestProxyServerError(t *testing.T) {
+	err := &ProxyServerError{}
+	if err.Error() != "error creating server: <nil>" {
+		t.Errorf("Expected error creating server: <nil>, got %v", err.Error())
+	}
+	if err.Unwrap() != nil {
+		t.Errorf("Expected nil, got %v", err.Unwrap())
+	}
+}

go.mod

@@ -1,6 +1,6 @@
 module github.com/bmf-san/gondola
 
-go 1.22.3
+go 1.22.4
 
 require (
 	github.com/google/uuid v1.6.0

gondola.go

@@ -0,0 +1,75 @@
+package gondola
+
+import (
+	"context"
+	"fmt"
+	"io"
+	"log/slog"
+	"net/http"
+	"os"
+	"os/signal"
+	"syscall"
+	"time"
+)
+
+// NewGondola returns a new Gondola.
+func NewGondola(r io.Reader) (*Gondola, error) {
+	cfg := &Config{}
+	c, err := cfg.Load(r)
+	if err != nil {
+		return nil, &ConfigLoadError{Err: err}
+	}
+
+	s, err := newServer(c)
+	if err != nil {
+		return nil, &ProxyServerError{Err: err}
+	}
+
+	return &Gondola{
+		config: c,
+		server: s,
+	}, nil
+}
+
+// TODO: Need to dynamically load a configuration file. For now, we will limit the implementation to just loading the file at startup.
+// Run starts the proxy server.
+func (g *Gondola) Run() error {
+	logger := NewLogger(g.config.LogLevel)
+	slog.SetDefault(logger.Logger)
+
+	// TODO: do health check for upstreams.
+
+	ch := make(chan error, 1)
+	go func() {
+		if g.config.Proxy.IsEnableTLS() {
+			slog.Info(fmt.Sprintf("Running server on port %s with TLS...", g.config.Proxy.Port))
+			if err := g.server.ListenAndServeTLS(g.config.Proxy.TLSCertPath, g.config.Proxy.TLSKeyPath); err != http.ErrServerClosed {
+				ch <- err
+			}
+		} else {
+			slog.Info("Running server on port " + g.config.Proxy.Port + "...")
+			if err := g.server.ListenAndServe(); err != http.ErrServerClosed {
+				ch <- err
+			}
+		}
+	}()
+	e := <-ch
+	if e != nil {
+		return e
+	}
+
+	q := make(chan os.Signal, 1)
+	signal.Notify(q, syscall.SIGINT, syscall.SIGTERM, syscall.SIGHUP)
+	defer signal.Stop(q)
+	<-q
+
+	ctx, cancel := context.WithTimeout(context.Background(), time.Duration(g.config.Proxy.ShutdownTimeout)*time.Millisecond)
+	defer cancel()
+	if err := g.server.Shutdown(ctx); err != nil {
+		slog.Error(fmt.Sprintf("Shutdown failed: %v", err))
+		return err
+	}
+
+	slog.Info("Server stopped gracefully")
+	return nil
+}