refact(controller): Validate listener configuration in New
With this change, the Controller is now aware of its own listeners in a more codified and structured way. The reasoning behind these changes are as follows: 1. Currently, we're iterating over these listeners in multiple spots along this initialization flow to check each listeners' purpose. By doing this once when we create a Controller and essentially storing the result, we can clean up the downstream code to use those results. 2. Initial effort to centralize Controller validation. At the moment, we are doing a lot of validation all over the `cmd` and `config` packages. From a conceptual perspective, Controller-related validation should be performed in the function that is responsible for constructing the Controller object itself. This enables any developer to look in a single place for all the constraints that we place on creating a Controller.
This commit is contained in:
1 parent
b6ee5dc9cc
commit
8d48a8515c
3 files changed
+211
-26
No files matched your search
@@ -4,8 +4,10 @@ import (
|
||||
"context"
|
||||
"testing"
|
||||
|
||||
"github.com/hashicorp/boundary/internal/cmd/base"
|
||||
"github.com/hashicorp/boundary/internal/db"
|
||||
"github.com/hashicorp/boundary/internal/kms"
|
||||
"github.com/hashicorp/go-secure-stdlib/listenerutil"
|
||||
"github.com/stretchr/testify/require"
|
||||
)
|
||||
|
||||
@@ -32,3 +34,153 @@ func TestController_New(t *testing.T) {
|
||||
require.NoError(err)
|
||||
})
|
||||
}
|
||||
|
||||
func TestControllerNewListenerConfig(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
listeners []*base.ServerListener
|
||||
assertions func(t *testing.T, c *Controller)
|
||||
expErr bool
|
||||
expErrMsg string
|
||||
}{
|
||||
{
|
||||
name: "valid listener configuration",
|
||||
listeners: []*base.ServerListener{
|
||||
{
|
||||
Config: &listenerutil.ListenerConfig{
|
||||
Purpose: []string{"api"},
|
||||
},
|
||||
},
|
||||
{
|
||||
Config: &listenerutil.ListenerConfig{
|
||||
Purpose: []string{"api"},
|
||||
},
|
||||
},
|
||||
{
|
||||
Config: &listenerutil.ListenerConfig{
|
||||
Purpose: []string{"cluster"},
|
||||
},
|
||||
},
|
||||
},
|
||||
assertions: func(t *testing.T, c *Controller) {
|
||||
require.Len(t, c.apiListeners, 2)
|
||||
require.NotNil(t, c.clusterListener)
|
||||
},
|
||||
},
|
||||
{
|
||||
name: "listeners are required",
|
||||
listeners: []*base.ServerListener{},
|
||||
expErr: true,
|
||||
expErrMsg: "no api listeners found",
|
||||
},
|
||||
{
|
||||
name: "listeners are required - not nil",
|
||||
listeners: []*base.ServerListener{nil, nil},
|
||||
expErr: true,
|
||||
expErrMsg: "no api listeners found",
|
||||
},
|
||||
{
|
||||
name: "listeners are required - with config",
|
||||
listeners: []*base.ServerListener{{}, {}},
|
||||
expErr: true,
|
||||
expErrMsg: "no api listeners found",
|
||||
},
|
||||
{
|
||||
name: "listeners are required - with purposes",
|
||||
listeners: []*base.ServerListener{
|
||||
{
|
||||
Config: &listenerutil.ListenerConfig{Purpose: nil},
|
||||
},
|
||||
{
|
||||
Config: &listenerutil.ListenerConfig{Purpose: nil},
|
||||
},
|
||||
},
|
||||
expErr: true,
|
||||
expErrMsg: "no api listeners found",
|
||||
},
|
||||
{
|
||||
name: "both api and cluster listeners are required",
|
||||
listeners: []*base.ServerListener{
|
||||
{
|
||||
Config: &listenerutil.ListenerConfig{
|
||||
Purpose: []string{"api"},
|
||||
},
|
||||
},
|
||||
},
|
||||
expErr: true,
|
||||
expErrMsg: "exactly one cluster listener is required",
|
||||
},
|
||||
{
|
||||
name: "both api and cluster listeners are required 2",
|
||||
listeners: []*base.ServerListener{
|
||||
{
|
||||
Config: &listenerutil.ListenerConfig{
|
||||
Purpose: []string{"cluster"},
|
||||
},
|
||||
},
|
||||
},
|
||||
expErr: true,
|
||||
expErrMsg: "no api listeners found",
|
||||
},
|
||||
{
|
||||
name: "only one cluster listener is allowed",
|
||||
listeners: []*base.ServerListener{
|
||||
{
|
||||
Config: &listenerutil.ListenerConfig{
|
||||
Purpose: []string{"api"},
|
||||
},
|
||||
},
|
||||
{
|
||||
Config: &listenerutil.ListenerConfig{
|
||||
Purpose: []string{"cluster"},
|
||||
},
|
||||
},
|
||||
{
|
||||
Config: &listenerutil.ListenerConfig{
|
||||
Purpose: []string{"cluster"},
|
||||
},
|
||||
},
|
||||
},
|
||||
expErr: true,
|
||||
expErrMsg: "exactly one cluster listener is required",
|
||||
},
|
||||
{
|
||||
name: "only one purpose is allowed per listener",
|
||||
listeners: []*base.ServerListener{
|
||||
{
|
||||
Config: &listenerutil.ListenerConfig{
|
||||
Purpose: []string{"api", "cluster"},
|
||||
},
|
||||
},
|
||||
},
|
||||
expErr: true,
|
||||
expErrMsg: `found listener with multiple purposes "api,cluster"`,
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
ctx, cancel := context.WithCancel(context.Background())
|
||||
|
||||
tc := &TestController{
|
||||
t: t,
|
||||
ctx: ctx,
|
||||
cancel: cancel,
|
||||
opts: nil,
|
||||
}
|
||||
conf := TestControllerConfig(t, ctx, tc, nil)
|
||||
conf.Listeners = tt.listeners
|
||||
|
||||
c, err := New(ctx, conf)
|
||||
if tt.expErr {
|
||||
require.EqualError(t, err, tt.expErrMsg)
|
||||
require.Nil(t, c)
|
||||
return
|
||||
}
|
||||
|
||||
require.NoError(t, err)
|
||||
require.NotNil(t, c)
|
||||
tt.assertions(t, c)
|
||||
})
|
||||
}
|
||||
}
|
||||
Reference in new issue
Block a user