story(bedrock): refactor to only contain base package and middleware …

…package (#339)
z5labs · Dec 15, 2024 · fb43aeb · fb43aeb
1 parent f985fdb
commit fb43aeb
Show file tree

Hide file tree

Showing 89 changed files with 77 additions and 6,783 deletions.
diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml
@@ -30,7 +30,7 @@ jobs:
 
         - uses: actions/setup-go@3041bf56c941b39c61721a86cd11f3bb1338122a # v5
           with:
-            go-version: '1.22'
+            go-version: '1.23'
 
         - name: Lint Go Code
           uses: golangci/golangci-lint-action@971e284b6050e8a5849b72094c50ab08da042db8 # v6
@@ -43,13 +43,4 @@ jobs:
           run: go build ./...
 
         - name: Test
-          run: go test -race -cover ./...
-
-        - name: Build example container images
-          uses: goreleaser/goreleaser-action@9ed2f89a662bf1735a48bc8557fd212fa902bebf # v6
-          with:
-            distribution: goreleaser
-            version: latest
-            args: release --clean --snapshot
-          env:
-            GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          run: go test -race -cover ./...
diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
@@ -19,7 +19,7 @@ jobs:
 
         - uses: actions/setup-go@3041bf56c941b39c61721a86cd11f3bb1338122a # v5
           with:
-            go-version: '1.22'
+            go-version: '1.23'
 
         - name: Lint Go Code
           uses: golangci/golangci-lint-action@971e284b6050e8a5849b72094c50ab08da042db8 # v6
@@ -33,19 +33,3 @@ jobs:
 
         - name: Test
           run: go test -race -cover ./...
-
-        - name: Login to GitHub Container Registry
-          uses: docker/login-action@9780b0c442fbb1117ed29e0efdff1e18412f7567 # v3
-          with:
-            registry: ghcr.io
-            username: ${{ github.actor }}
-            password: ${{ secrets.GITHUB_TOKEN }}
-
-        - name: Build example container images
-          uses: goreleaser/goreleaser-action@9ed2f89a662bf1735a48bc8557fd212fa902bebf # v6
-          with:
-            distribution: goreleaser
-            version: latest
-            args: release --clean
-          env:
-            GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 [![Mentioned in Awesome Go](https://awesome.re/mentioned-badge.svg)](https://github.com/avelino/awesome-go)
 [![Go Reference](https://pkg.go.dev/badge/github.com/z5labs/bedrock.svg)](https://pkg.go.dev/github.com/z5labs/bedrock)
 [![Go Report Card](https://goreportcard.com/badge/github.com/z5labs/bedrock)](https://goreportcard.com/report/github.com/z5labs/bedrock)
-![Coverage](https://img.shields.io/badge/Coverage-94.2%25-brightgreen)
+![Coverage](https://img.shields.io/badge/Coverage-98.6%25-brightgreen)
 [![build](https://github.com/z5labs/bedrock/actions/workflows/build.yaml/badge.svg)](https://github.com/z5labs/bedrock/actions/workflows/build.yaml)
 
 **bedrock provides a minimal, modular and composable foundation for

diff --git a/pkg/app/app.go → app/app.go b/pkg/app/app.go → app/app.go
diff --git a/pkg/app/app_example_test.go → app/app_example_test.go b/pkg/app/app_example_test.go → app/app_example_test.go
diff --git a/pkg/app/app_test.go → app/app_test.go b/pkg/app/app_test.go → app/app_test.go
diff --git a/pkg/app/otel.go → app/otel.go b/pkg/app/otel.go → app/otel.go
diff --git a/pkg/app/otel_example_test.go → app/otel_example_test.go b/pkg/app/otel_example_test.go → app/otel_example_test.go
diff --git a/pkg/app/otel_test.go → app/otel_test.go b/pkg/app/otel_test.go → app/otel_test.go
diff --git a/pkg/appbuilder/appbuilder.go → appbuilder/appbuilder.go b/pkg/appbuilder/appbuilder.go → appbuilder/appbuilder.go
diff --git a/pkg/appbuilder/appbuilder_example_test.go → appbuilder/appbuilder_example_test.go b/pkg/appbuilder/appbuilder_example_test.go → appbuilder/appbuilder_example_test.go
diff --git a/pkg/appbuilder/appbuilder_test.go → appbuilder/appbuilder_test.go b/pkg/appbuilder/appbuilder_test.go → appbuilder/appbuilder_test.go
diff --git a/pkg/appbuilder/doc.go → appbuilder/doc.go b/pkg/appbuilder/doc.go → appbuilder/doc.go
diff --git a/pkg/appbuilder/otel.go → appbuilder/otel.go b/pkg/appbuilder/otel.go → appbuilder/otel.go
diff --git a/pkg/appbuilder/otel_test.go → appbuilder/otel_test.go b/pkg/appbuilder/otel_test.go → appbuilder/otel_test.go
diff --git a/bedrock.go b/bedrock.go
@@ -10,7 +10,7 @@ import (
 	"errors"
 	"fmt"
 
-	"github.com/z5labs/bedrock/pkg/config"
+	"github.com/z5labs/bedrock/config"
 )
 
 // App represents the entry point for user specific code.

diff --git a/bedrock_example_test.go b/bedrock_example_test.go
@@ -10,7 +10,7 @@ import (
 	"fmt"
 	"strings"
 
-	"github.com/z5labs/bedrock/pkg/config"
+	"github.com/z5labs/bedrock/config"
 )
 
 type appFunc func(context.Context) error

diff --git a/bedrock_test.go b/bedrock_test.go
@@ -12,7 +12,7 @@ import (
 	"strings"
 	"testing"
 
-	"github.com/z5labs/bedrock/pkg/config"
+	"github.com/z5labs/bedrock/config"
 
 	"github.com/stretchr/testify/assert"
 )

diff --git a/pkg/config/config.go → config/config.go b/pkg/config/config.go → config/config.go
@@ -13,7 +13,7 @@ import (
 	"reflect"
 	"time"
 
-	"github.com/z5labs/bedrock/pkg/config/key"
+	"github.com/z5labs/bedrock/config/key"
 
 	"github.com/go-viper/mapstructure/v2"
 )
@@ -31,7 +31,7 @@ type Source interface {
 
 // Manager
 type Manager struct {
-	store Map
+	store Store
 }
 
 // Read
@@ -41,10 +41,6 @@ func Read(srcs ...Source) (*Manager, error) {
 		return &Manager{store: make(Map)}, nil
 	}
 
-	if m, ok := srcs[0].(*Manager); len(srcs) == 1 && ok {
-		return m, nil
-	}
-
 	store := make(Map)
 	for _, src := range srcs {
 		err := src.Apply(store)
@@ -58,11 +54,6 @@ func Read(srcs ...Source) (*Manager, error) {
 	return m, nil
 }
 
-// Apply implements the [Source] interface.
-func (m *Manager) Apply(store Store) error {
-	return m.store.Apply(store)
-}
-
 // Unmarshal
 func (m *Manager) Unmarshal(v any) error {
 	dec, err := mapstructure.NewDecoder(&mapstructure.DecoderConfig{

diff --git a/pkg/config/config_example_test.go → config/config_example_test.go b/pkg/config/config_example_test.go → config/config_example_test.go
diff --git a/pkg/config/config_test.go → config/config_test.go b/pkg/config/config_test.go → config/config_test.go
@@ -73,23 +73,6 @@ func TestRead(t *testing.T) {
 			}
 		})
 	})
-
-	t.Run("will be idempotent", func(t *testing.T) {
-		t.Run("if a single Manager is used as the source", func(t *testing.T) {
-			m, err := Read(FromYaml(strings.NewReader("hello: world")))
-			if !assert.Nil(t, err) {
-				return
-			}
-
-			m2, err := Read(m)
-			if !assert.Nil(t, err) {
-				return
-			}
-			if !assert.Equal(t, m, m2) {
-				return
-			}
-		})
-	})
 }
 
 type Custom struct {

diff --git a/pkg/config/env.go → config/env.go b/pkg/config/env.go → config/env.go
diff --git a/pkg/config/file.go → config/file.go b/pkg/config/file.go → config/file.go
diff --git a/pkg/config/file_test.go → config/file_test.go b/pkg/config/file_test.go → config/file_test.go
diff --git a/pkg/config/json.go → config/json.go b/pkg/config/json.go → config/json.go
@@ -11,7 +11,7 @@ import (
 	"fmt"
 	"io"
 
-	"github.com/z5labs/bedrock/pkg/internal/ioutil"
+	"github.com/z5labs/bedrock/internal/ioutil"
 )
 
 // Json represents a Source where its underlying format is JSON.
@@ -42,7 +42,7 @@ func (e InvalidJsonError) Unwrap() error {
 
 // Apply implements the Source interface.
 func (src Json) Apply(store Store) error {
-	b, err := ioutil.ReadAllAndClose(src.r)
+	b, err := ioutil.ReadAllAndTryClose(src.r)
 	if err != nil && !errors.Is(err, ioutil.CloseError{}) {
 		// We can ignore ioutil.CloseError because we've successfully
 		// read the file contents and closing is just a nice clean up

diff --git a/pkg/config/json_test.go → config/json_test.go b/pkg/config/json_test.go → config/json_test.go
@@ -10,7 +10,7 @@ import (
 	"strings"
 	"testing"
 
-	"github.com/z5labs/bedrock/pkg/config/key"
+	"github.com/z5labs/bedrock/config/key"
 
 	"github.com/stretchr/testify/assert"
 )

diff --git a/pkg/config/key/key.go → config/key/key.go b/pkg/config/key/key.go → config/key/key.go
diff --git a/pkg/config/map.go → config/map.go b/pkg/config/map.go → config/map.go
@@ -8,7 +8,7 @@ package config
 import (
 	"fmt"
 
-	"github.com/z5labs/bedrock/pkg/config/key"
+	"github.com/z5labs/bedrock/config/key"
 )
 
 // Map is an ordinary map[string]any but implements the [Store] and [Source] interfaces.

diff --git a/pkg/config/map_test.go → config/map_test.go b/pkg/config/map_test.go → config/map_test.go
@@ -11,7 +11,7 @@ import (
 	"strings"
 	"testing"
 
-	"github.com/z5labs/bedrock/pkg/config/key"
+	"github.com/z5labs/bedrock/config/key"
 
 	"github.com/stretchr/testify/assert"
 )

diff --git a/pkg/config/testdata/config.yaml → config/testdata/config.yaml b/pkg/config/testdata/config.yaml → config/testdata/config.yaml
diff --git a/pkg/config/text_template.go → config/text_template.go b/pkg/config/text_template.go → config/text_template.go
@@ -14,7 +14,7 @@ import (
 	"sync"
 	"text/template"
 
-	"github.com/z5labs/bedrock/pkg/internal/ioutil"
+	"github.com/z5labs/bedrock/internal/ioutil"
 )
 
 // RenderTextTemplateOption represents options for configuring the TextTemplateRenderer.
@@ -98,7 +98,7 @@ func (ttr *TextTemplateRenderer) Read(b []byte) (int, error) {
 	var err error
 	ttr.renderOnce.Do(func() {
 		var sb strings.Builder
-		_, err = ioutil.CopyAndClose(&sb, ttr.r)
+		_, err = ioutil.CopyAndTryClose(&sb, ttr.r)
 		if err != nil && !errors.Is(err, ioutil.CloseError{}) {
 			// We can ignore ioutil.CloseError because we've successfully
 			// read the file contents and closing is just a nice clean up

diff --git a/pkg/config/text_template_test.go → config/text_template_test.go b/pkg/config/text_template_test.go → config/text_template_test.go
diff --git a/pkg/config/yaml.go → config/yaml.go b/pkg/config/yaml.go → config/yaml.go
@@ -10,7 +10,7 @@ import (
 	"fmt"
 	"io"
 
-	"github.com/z5labs/bedrock/pkg/internal/ioutil"
+	"github.com/z5labs/bedrock/internal/ioutil"
 
 	"gopkg.in/yaml.v3"
 )
@@ -43,7 +43,7 @@ func (e InvalidYamlError) Unwrap() error {
 
 // Apply implements the Source interface.
 func (src Yaml) Apply(store Store) error {
-	b, err := ioutil.ReadAllAndClose(src.r)
+	b, err := ioutil.ReadAllAndTryClose(src.r)
 	if err != nil && !errors.Is(err, ioutil.CloseError{}) {
 		// We can ignore ioutil.CloseError because we've successfully
 		// read the file contents and closing is just a nice clean up

diff --git a/pkg/config/yaml_test.go → config/yaml_test.go b/pkg/config/yaml_test.go → config/yaml_test.go
@@ -10,7 +10,7 @@ import (
 	"strings"
 	"testing"
 
-	"github.com/z5labs/bedrock/pkg/config/key"
+	"github.com/z5labs/bedrock/config/key"
 
 	"github.com/stretchr/testify/assert"
 )

diff --git a/example/custom_framework/README.md b/example/custom_framework/README.md
diff --git a/example/custom_framework/echo/Containerfile b/example/custom_framework/echo/Containerfile
diff --git a/example/custom_framework/echo/app/app.go b/example/custom_framework/echo/app/app.go
diff --git a/example/custom_framework/echo/config.yaml b/example/custom_framework/echo/config.yaml
diff --git a/example/custom_framework/echo/endpoint/echo.go b/example/custom_framework/echo/endpoint/echo.go