Merge pull request #478 from xmidt-org/package-reorg

updated package structure to include internal package

main.go → caduceus.go

@@ -1,11 +1,10 @@
 // SPDX-FileCopyrightText: 2023 Comcast Cable Communications Management, LLC
 // SPDX-License-Identifier: Apache-2.0
-package main
+package caduceus
 
 import (
 	"fmt"
 	"os"
-	"runtime/debug"
 
 	"github.com/alecthomas/kong"
 	"github.com/goschtalt/goschtalt"
@@ -14,6 +13,10 @@ import (
 	_ "github.com/goschtalt/yaml-decoder"
 	_ "github.com/goschtalt/yaml-encoder"
 	"github.com/xmidt-org/arrange/arrangehttp"
+	"github.com/xmidt-org/caduceus/internal/handler"
+	"github.com/xmidt-org/caduceus/internal/metrics"
+	"github.com/xmidt-org/caduceus/internal/sink"
+
 	"github.com/xmidt-org/candlelight"
 	"github.com/xmidt-org/sallust"
 	"github.com/xmidt-org/touchstone"
@@ -47,7 +50,7 @@ type CLI struct {
 // Provides a named type so it's a bit easier to flow through & use in fx.
 type cliArgs []string
 
-func caduceus(arguments []string, run bool) error {
+func Caduceus(arguments []string, run bool) error {
 	var (
 		gscfg *goschtalt.Config
 
@@ -74,7 +77,7 @@ func caduceus(arguments []string, run bool) error {
 			goschtalt.UnmarshalFunc[sallust.Config]("logging"),
 			goschtalt.UnmarshalFunc[candlelight.Config]("tracing"),
 			goschtalt.UnmarshalFunc[touchstone.Config]("prometheus"),
-			goschtalt.UnmarshalFunc[SinkConfig]("sender"),
+			goschtalt.UnmarshalFunc[sink.Config]("sender"),
 			goschtalt.UnmarshalFunc[Service]("service"),
 			goschtalt.UnmarshalFunc[[]string]("authHeader"),
 			goschtalt.UnmarshalFunc[bool]("previousVersionSupport"),
@@ -135,11 +138,11 @@ func caduceus(arguments []string, run bool) error {
 		arrangehttp.ProvideServer("servers.primary"),
 		arrangehttp.ProvideServer("servers.alternate"),
 
-		ProvideHandler(),
-		ProvideWrapper(),
+		handler.Provide(),
+		sink.Provide(),
 		touchstone.Provide(),
 		touchhttp.Provide(),
-		ProvideMetrics(),
+		metrics.Provide(),
 		// ancla.ProvideMetrics(), //TODO: need to add back in once we fix the ancla/argus dependency issue
 
 	)
@@ -211,20 +214,3 @@ func provideCLIWithOpts(args cliArgs, testOpts bool) (*CLI, error) {
 
 	return &cli, nil
 }
-
-func main() {
-	defer func() {
-		if r := recover(); r != nil {
-			fmt.Println("stacktrace from panic: \n" + string(debug.Stack()))
-		}
-	}()
-
-	err := caduceus(os.Args[1:], true)
-
-	if err == nil {
-		return
-	}
-
-	fmt.Fprintln(os.Stderr, err)
-	os.Exit(-1)
-}

main_test.go → caduceus_test.go

@@ -1,7 +1,7 @@
 // SPDX-FileCopyrightText: 2023 Comcast Cable Communications Management, LLC
 // SPDX-License-Identifier: Apache-2.0
 
-package main
+package caduceus
 
 import (
 	"testing"
@@ -86,10 +86,10 @@ func Test_caduceus(t *testing.T) {
 
 			if tc.panic {
 				assert.Panics(func() {
-					_ = caduceus(tc.args, false)
+					_ = Caduceus(tc.args, false)
 				})
 			} else {
-				err := caduceus(tc.args, false)
+				err := Caduceus(tc.args, false)
 
 				assert.ErrorIs(err, tc.expectedErr)
 			}

cmd/main.go

@@ -0,0 +1,29 @@
+// SPDX-FileCopyrightText: 2023 Comcast Cable Communications Management, LLC
+// SPDX-License-Identifier: LicenseRef-COMCAST
+
+package main
+
+import (
+	"fmt"
+	"os"
+	"runtime/debug"
+
+	"github.com/xmidt-org/caduceus"
+)
+
+func main() {
+	defer func() {
+		if r := recover(); r != nil {
+			fmt.Println("stacktrace from panic: \n" + string(debug.Stack()))
+		}
+	}()
+
+	err := caduceus.Caduceus(os.Args[1:], true)
+
+	if err == nil {
+		return
+	}
+
+	fmt.Fprintln(os.Stderr, err)
+	os.Exit(-1)
+}

config.go

@@ -1,7 +1,7 @@
 // SPDX-FileCopyrightText: 2023 Comcast Cable Communications Management, LLC
 // SPDX-License-Identifier: Apache-2.0
 
-package main
+package caduceus
 
 import (
 	"fmt"
@@ -11,7 +11,10 @@ import (
 	"github.com/goschtalt/goschtalt"
 	"github.com/xmidt-org/arrange/arrangehttp"
 	"github.com/xmidt-org/arrange/arrangepprof"
+	"github.com/xmidt-org/bascule"
+	"github.com/xmidt-org/caduceus/internal/sink"
 	"github.com/xmidt-org/candlelight"
+	"github.com/xmidt-org/clortho"
 	"github.com/xmidt-org/sallust"
 	"github.com/xmidt-org/touchstone"
 	"gopkg.in/dealancer/validate.v2"
@@ -26,7 +29,7 @@ type Config struct {
 	Servers                Servers
 	ArgusClientTimeout     HttpClientTimeout
 	JWTValidator           JWTValidator
-	Sink                   SinkConfig
+	SinkConfig             sink.Config
 	Service                Service
 	AuthHeader             []string
 	Server                 string
@@ -114,6 +117,16 @@ type MetricsOption struct {
 	Subsystem string
 }
 
+// JWTValidator provides a convenient way to define jwt validator through config files
+type JWTValidator struct {
+	// Config is used to create the clortho Resolver & Refresher for JWT verification keys
+	Config clortho.Config `json:"config"`
+
+	// Leeway is used to set the amount of time buffer should be given to JWT
+	// time values, such as nbf
+	Leeway bascule.Leeway
+}
+
 // Collect and process the configuration files and env vars and
 // produce a configuration object.
 func provideConfig(cli *CLI) (*goschtalt.Config, error) {

client.go → internal/client/client.go

@@ -1,6 +1,6 @@
 // SPDX-FileCopyrightText: 2024 Comcast Cable Communications Management, LLC
 // SPDX-License-Identifier: Apache-2.0
-package main
+package client
 
 import "net/http"
 
@@ -10,7 +10,7 @@ type Client interface {
 	Do(*http.Request) (*http.Response, error)
 }
 
-func nopClient(next Client) Client {
+func NopClient(next Client) Client {
 	return next
 }
 

httpClient.go → internal/client/httpClient.go

@@ -1,7 +1,7 @@
 // SPDX-FileCopyrightText: 2023 Comcast Cable Communications Management, LLC
 // SPDX-License-Identifier: Apache-2.0
 
-package main
+package client
 
 import (
 	"errors"
@@ -10,6 +10,7 @@ import (
 	"time"
 
 	"github.com/prometheus/client_golang/prometheus"
+	"github.com/xmidt-org/caduceus/internal/metrics"
 )
 
 var (
@@ -22,7 +23,7 @@ type metricWrapper struct {
 	id           string
 }
 
-func newMetricWrapper(now func() time.Time, queryLatency prometheus.ObserverVec, id string) (*metricWrapper, error) {
+func NewMetricWrapper(now func() time.Time, queryLatency prometheus.ObserverVec, id string) (*metricWrapper, error) {
 	if now == nil {
 		now = time.Now
 	}
@@ -36,20 +37,20 @@ func newMetricWrapper(now func() time.Time, queryLatency prometheus.ObserverVec,
 	}, nil
 }
 
-func (m *metricWrapper) roundTripper(next Client) Client {
+func (m *metricWrapper) RoundTripper(next Client) Client {
 	return doerFunc(func(req *http.Request) (*http.Response, error) {
 		startTime := m.now()
 		resp, err := next.Do(req)
 		endTime := m.now()
-		code := networkError
+		code := metrics.NetworkError
 
 		if err == nil {
 			code = strconv.Itoa(resp.StatusCode)
 		}
 
 		// find time difference, add to metric
 		var latency = endTime.Sub(startTime)
-		m.queryLatency.With(prometheus.Labels{UrlLabel: m.id, CodeLabel: code}).Observe(latency.Seconds())
+		m.queryLatency.With(prometheus.Labels{metrics.UrlLabel: m.id, metrics.CodeLabel: code}).Observe(latency.Seconds())
 
 		return resp, err
 	})

httpClient_test.go → internal/client/httpClient_test.go

@@ -1,7 +1,7 @@
 // SPDX-FileCopyrightText: 2021 Comcast Cable Communications Management, LLC
 // SPDX-License-Identifier: Apache-2.0
 
-package main
+package client
 
 // import (
 // 	"errors"