processor plugin desc (#2088)

* describe connector plugins command

* move displayConfig to utils, needed by processor-plugin

* describe processor plugin

* address reviews

Author: maha-hajja

Diff for: cmd/conduit/root/processorplugins/describe.go

@@ -0,0 +1,109 @@
+// Copyright © 2025 Meroxa, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package processorplugins
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/conduitio/conduit/cmd/conduit/api"
+	"github.com/conduitio/conduit/cmd/conduit/cecdysis"
+	"github.com/conduitio/conduit/cmd/conduit/internal"
+	"github.com/conduitio/conduit/pkg/foundation/cerrors"
+	apiv1 "github.com/conduitio/conduit/proto/api/v1"
+	"github.com/conduitio/ecdysis"
+)
+
+var (
+	_ cecdysis.CommandWithExecuteWithClient = (*DescribeCommand)(nil)
+	_ ecdysis.CommandWithAliases            = (*DescribeCommand)(nil)
+	_ ecdysis.CommandWithDocs               = (*DescribeCommand)(nil)
+	_ ecdysis.CommandWithArgs               = (*DescribeCommand)(nil)
+)
+
+type DescribeArgs struct {
+	processorPlugin string
+}
+
+type DescribeCommand struct {
+	args DescribeArgs
+}
+
+func (c *DescribeCommand) Usage() string { return "describe" }
+
+func (c *DescribeCommand) Docs() ecdysis.Docs {
+	return ecdysis.Docs{
+		Short: "Describe an existing processor plugin.",
+		Long: `This command requires Conduit to be already running since it will show a processor plugins that 
+could be added to your pipelines.`,
+		Example: "conduit processor-plugin describe builtin:[email protected]\n" +
+			"conduit processor-plugin desc standalone:[email protected]",
+	}
+}
+
+func (c *DescribeCommand) Aliases() []string { return []string{"desc"} }
+
+func (c *DescribeCommand) Args(args []string) error {
+	if len(args) == 0 {
+		return cerrors.Errorf("requires a processor plugin name")
+	}
+
+	if len(args) > 1 {
+		return cerrors.Errorf("too many arguments")
+	}
+
+	c.args.processorPlugin = args[0]
+	return nil
+}
+
+func (c *DescribeCommand) ExecuteWithClient(ctx context.Context, client *api.Client) error {
+	resp, err := client.ProcessorServiceClient.ListProcessorPlugins(ctx, &apiv1.ListProcessorPluginsRequest{
+		Name: c.args.processorPlugin,
+	})
+	if err != nil {
+		return fmt.Errorf("failed to get processor plugin: %w", err)
+	}
+
+	if len(resp.Plugins) == 0 {
+		return nil
+	}
+
+	displayConnectorPluginsDescription(resp.Plugins[0])
+
+	return nil
+}
+
+func displayConnectorPluginsDescription(p *apiv1.ProcessorPluginSpecifications) {
+	if !internal.IsEmpty(p.Name) {
+		fmt.Printf("Name: %s\n", p.Name)
+	}
+	if !internal.IsEmpty(p.Summary) {
+		fmt.Printf("Summary: %s\n", p.Summary)
+	}
+	if !internal.IsEmpty(p.Description) {
+		fmt.Printf("Description: %s\n", p.Description)
+	}
+	if !internal.IsEmpty(p.Author) {
+		fmt.Printf("Author: %s\n", p.Author)
+	}
+	if !internal.IsEmpty(p.Version) {
+		fmt.Printf("Version: %s\n", p.Version)
+	}
+
+	if len(p.Parameters) > 0 {
+		fmt.Println("\nParameters:")
+		internal.DisplayConfigParams(p.Parameters)
+	}
+}

Diff for: cmd/conduit/root/processorplugins/describe_test.go

@@ -0,0 +1,56 @@
+// Copyright © 2025 Meroxa, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package processorplugins
+
+import (
+	"testing"
+
+	"github.com/matryer/is"
+)
+
+func TestDescribeExecutionNoArgs(t *testing.T) {
+	is := is.New(t)
+
+	c := DescribeCommand{}
+	err := c.Args([]string{})
+
+	expected := "requires a processor plugin name"
+
+	is.True(err != nil)
+	is.Equal(err.Error(), expected)
+}
+
+func TestDescribeExecutionMultipleArgs(t *testing.T) {
+	is := is.New(t)
+
+	c := DescribeCommand{}
+	err := c.Args([]string{"foo", "bar"})
+
+	expected := "too many arguments"
+
+	is.True(err != nil)
+	is.Equal(err.Error(), expected)
+}
+
+func TestDescribeExecutionCorrectArgs(t *testing.T) {
+	is := is.New(t)
+	processorPluginID := "processor-plugin-id"
+
+	c := DescribeCommand{}
+	err := c.Args([]string{processorPluginID})
+
+	is.NoErr(err)
+	is.Equal(c.args.processorPlugin, processorPluginID)
+}

Diff for: cmd/conduit/root/processorplugins/processor_plugins.go

@@ -31,6 +31,7 @@ func (c *ProcessorPluginsCommand) Aliases() []string { return []string{"processo
 func (c *ProcessorPluginsCommand) SubCommands() []ecdysis.Command {
 	return []ecdysis.Command{
 		&ListCommand{},
+		&DescribeCommand{},
 	}
 }