|
| 1 | +package client |
| 2 | + |
| 3 | +import ( |
| 4 | + "context" |
| 5 | + "net" |
| 6 | + "net/http" |
| 7 | + "os" |
| 8 | + "path/filepath" |
| 9 | + "testing" |
| 10 | + "time" |
| 11 | + |
| 12 | + "connectrpc.com/connect" |
| 13 | + "github.com/stretchr/testify/assert" |
| 14 | + "github.com/stretchr/testify/require" |
| 15 | + "google.golang.org/protobuf/proto" |
| 16 | + |
| 17 | + "github.com/docker/secrets-engine/x/api" |
| 18 | + resolverv1 "github.com/docker/secrets-engine/x/api/resolver/v1" |
| 19 | + "github.com/docker/secrets-engine/x/api/resolver/v1/resolverv1connect" |
| 20 | + "github.com/docker/secrets-engine/x/secrets" |
| 21 | + "github.com/docker/secrets-engine/x/testhelper" |
| 22 | +) |
| 23 | + |
| 24 | +var _ resolverv1connect.ListServiceHandler = &mockPluginsList{} |
| 25 | + |
| 26 | +type mockPluginsList struct { |
| 27 | + list []PluginInfo |
| 28 | +} |
| 29 | + |
| 30 | +func (m mockPluginsList) ListPlugins(context.Context, *connect.Request[resolverv1.ListPluginsRequest]) (*connect.Response[resolverv1.ListPluginsResponse], error) { |
| 31 | + var plugins []*resolverv1.Plugin |
| 32 | + for _, plugin := range m.list { |
| 33 | + var name string |
| 34 | + if plugin.Name != nil { |
| 35 | + name = plugin.Name.String() |
| 36 | + } |
| 37 | + var version string |
| 38 | + if plugin.Version != nil { |
| 39 | + version = plugin.Version.String() |
| 40 | + } |
| 41 | + var pattern string |
| 42 | + if plugin.Pattern != nil { |
| 43 | + pattern = plugin.Pattern.String() |
| 44 | + } |
| 45 | + plugins = append(plugins, resolverv1.Plugin_builder{ |
| 46 | + Name: proto.String(name), |
| 47 | + Version: proto.String(version), |
| 48 | + Pattern: proto.String(pattern), |
| 49 | + External: proto.Bool(plugin.External), |
| 50 | + }.Build()) |
| 51 | + } |
| 52 | + return connect.NewResponse(resolverv1.ListPluginsResponse_builder{ |
| 53 | + Plugins: plugins, |
| 54 | + }.Build()), nil |
| 55 | +} |
| 56 | + |
| 57 | +type handler struct { |
| 58 | + pattern string |
| 59 | + handler http.Handler |
| 60 | +} |
| 61 | + |
| 62 | +func muxServer(t *testing.T, socketPath string, handlers []handler) { |
| 63 | + t.Helper() |
| 64 | + _ = os.Remove(socketPath) |
| 65 | + require.NoError(t, os.MkdirAll(filepath.Dir(socketPath), 0o755)) |
| 66 | + listener, err := net.Listen("unix", socketPath) |
| 67 | + require.NoError(t, err) |
| 68 | + mux := http.NewServeMux() |
| 69 | + for _, h := range handlers { |
| 70 | + mux.Handle(h.pattern, h.handler) |
| 71 | + } |
| 72 | + |
| 73 | + server := &http.Server{Handler: mux} |
| 74 | + |
| 75 | + go func() { |
| 76 | + _ = server.Serve(listener) |
| 77 | + }() |
| 78 | + |
| 79 | + t.Cleanup(func() { |
| 80 | + shutdownCtx, cancel := context.WithTimeout(t.Context(), 5*time.Second) |
| 81 | + defer cancel() |
| 82 | + |
| 83 | + _ = server.Shutdown(shutdownCtx) |
| 84 | + _ = listener.Close() |
| 85 | + _ = os.RemoveAll(socketPath) |
| 86 | + }) |
| 87 | +} |
| 88 | + |
| 89 | +func wrapHandler(pattern string, h http.Handler) handler { |
| 90 | + return handler{pattern: pattern, handler: h} |
| 91 | +} |
| 92 | + |
| 93 | +func mockListPluginsEngine(t *testing.T, plugins []PluginInfo) string { |
| 94 | + t.Helper() |
| 95 | + socketPath := testhelper.RandomShortSocketName() |
| 96 | + muxServer(t, socketPath, []handler{wrapHandler(resolverv1connect.NewListServiceHandler(&mockPluginsList{list: plugins}))}) |
| 97 | + return socketPath |
| 98 | +} |
| 99 | + |
| 100 | +func Test_ListPlugins(t *testing.T) { |
| 101 | + t.Parallel() |
| 102 | + t.Run("external and internal plugins", func(t *testing.T) { |
| 103 | + plugins := []PluginInfo{ |
| 104 | + { |
| 105 | + Name: api.MustNewName("foo"), |
| 106 | + Version: api.MustNewVersion("v1"), |
| 107 | + Pattern: secrets.MustParsePattern("**"), |
| 108 | + }, |
| 109 | + { |
| 110 | + Name: api.MustNewName("bar"), |
| 111 | + Version: api.MustNewVersion("v1"), |
| 112 | + Pattern: secrets.MustParsePattern("**"), |
| 113 | + External: true, |
| 114 | + }, |
| 115 | + } |
| 116 | + socket := mockListPluginsEngine(t, plugins) |
| 117 | + client, err := New(WithSocketPath(socket)) |
| 118 | + require.NoError(t, err) |
| 119 | + result, err := client.ListPlugins(t.Context()) |
| 120 | + require.NoError(t, err) |
| 121 | + assert.Equal(t, plugins, result) |
| 122 | + }) |
| 123 | + t.Run("no plugins", func(t *testing.T) { |
| 124 | + var plugins []PluginInfo |
| 125 | + socket := mockListPluginsEngine(t, plugins) |
| 126 | + client, err := New(WithSocketPath(socket)) |
| 127 | + require.NoError(t, err) |
| 128 | + result, err := client.ListPlugins(t.Context()) |
| 129 | + require.NoError(t, err) |
| 130 | + assert.Empty(t, result) |
| 131 | + }) |
| 132 | + t.Run("mix of valid and invalid plugin info", func(t *testing.T) { |
| 133 | + plugins := []PluginInfo{ |
| 134 | + { |
| 135 | + Name: api.MustNewName("foo"), |
| 136 | + }, |
| 137 | + { |
| 138 | + Name: api.MustNewName("bar"), |
| 139 | + Version: api.MustNewVersion("v1"), |
| 140 | + Pattern: secrets.MustParsePattern("**"), |
| 141 | + }, |
| 142 | + } |
| 143 | + socket := mockListPluginsEngine(t, plugins) |
| 144 | + client, err := New(WithSocketPath(socket)) |
| 145 | + require.NoError(t, err) |
| 146 | + result, err := client.ListPlugins(t.Context()) |
| 147 | + require.NoError(t, err) |
| 148 | + assert.Equal(t, []PluginInfo{ |
| 149 | + { |
| 150 | + Name: api.MustNewName("bar"), |
| 151 | + Version: api.MustNewVersion("v1"), |
| 152 | + Pattern: secrets.MustParsePattern("**"), |
| 153 | + }, |
| 154 | + }, result) |
| 155 | + }) |
| 156 | +} |
0 commit comments