Skip to content

Commit

Permalink
refactor connector list test
Browse files Browse the repository at this point in the history
  • Loading branch information
@raulb
raulb committed Jan 29, 2025
1 parent 309d7a2 commit 7d6c466
Show file tree
Hide file tree
Showing 13 changed files with 135 additions and 156 deletions.
2 changes: 1 addition & 1 deletion cmd/conduit/internal/output/print_utils.go → cmd/conduit/internal/display/utils.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.

package output
package display

import (
"fmt"
Expand Down
2 changes: 1 addition & 1 deletion ...nduit/internal/output/print_utils_test.go → cmd/conduit/internal/display/utils_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.

package output
package display

import (
"testing"
Expand Down
2 changes: 1 addition & 1 deletion cmd/conduit/internal/testutils/mock_helpers.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ func MockGetDLQ(mockService *mock.MockPipelineService, pipelineID, plugin string
}, nil).Times(1)
}

func MockListPipelines(mockService *mock.MockPipelineService, pipelines []*apiv1.Pipeline) {
func MockGetListPipelines(mockService *mock.MockPipelineService, pipelines []*apiv1.Pipeline) {
mockService.EXPECT().ListPipelines(gomock.Any(), gomock.Any()).Return(&apiv1.ListPipelinesResponse{
Pipelines: pipelines,
}, nil).Times(1)
Expand Down
16 changes: 8 additions & 8 deletions cmd/conduit/root/connectorplugins/describe.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import (
"context"
"fmt"

"github.com/conduitio/conduit/cmd/conduit/internal/output"
"github.com/conduitio/conduit/cmd/conduit/internal/display"

"github.com/conduitio/conduit/cmd/conduit/api"
"github.com/conduitio/conduit/cmd/conduit/cecdysis"
Expand Down Expand Up @@ -87,27 +87,27 @@ func (c *DescribeCommand) ExecuteWithClient(ctx context.Context, client *api.Cli
}

func displayConnectorPluginsDescription(c *apiv1.ConnectorPluginSpecifications) {
if !output.IsEmpty(c.Name) {
if !display.IsEmpty(c.Name) {
fmt.Printf("Name: %s\n", c.Name)
}
if !output.IsEmpty(c.Summary) {
if !display.IsEmpty(c.Summary) {
fmt.Printf("Summary: %s\n", c.Summary)
}
if !output.IsEmpty(c.Description) {
if !display.IsEmpty(c.Description) {
fmt.Printf("Description: %s\n", c.Description)
}
if !output.IsEmpty(c.Author) {
if !display.IsEmpty(c.Author) {
fmt.Printf("Author: %s\n", c.Author)
}
if !output.IsEmpty(c.Version) {
if !display.IsEmpty(c.Version) {
fmt.Printf("Version: %s\n", c.Version)
}
if len(c.SourceParams) > 0 {
fmt.Printf("\nSource Parameters:\n")
output.DisplayConfigParams(c.SourceParams)
display.DisplayConfigParams(c.SourceParams)
}
if len(c.DestinationParams) > 0 {
fmt.Printf("\nDestination Parameters:\n")
output.DisplayConfigParams(c.DestinationParams)
display.DisplayConfigParams(c.DestinationParams)
}
}
12 changes: 6 additions & 6 deletions cmd/conduit/root/connectors/describe.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import (
"context"
"fmt"

"github.com/conduitio/conduit/cmd/conduit/internal/output"
"github.com/conduitio/conduit/cmd/conduit/internal/display"

"github.com/conduitio/conduit/cmd/conduit/api"
"github.com/conduitio/conduit/cmd/conduit/cecdysis"
Expand Down Expand Up @@ -107,13 +107,13 @@ func displayConnector(out ecdysis.Output, connector *apiv1.Connector, processors

out.Stdout(fmt.Sprintf("ID: %s\n", connector.Id))

out.Stdout(fmt.Sprintf("Type: %s\n", output.ConnectorTypeToString(connector.Type)))
out.Stdout(fmt.Sprintf("Type: %s\n", display.ConnectorTypeToString(connector.Type)))
out.Stdout(fmt.Sprintf("Plugin: %s\n", connector.Plugin))
out.Stdout(fmt.Sprintf("Pipeline ID: %s\n", connector.PipelineId))

output.DisplayConnectorConfig(out, connector.Config, 0)
out.Stdout(fmt.Sprintf("Created At: %s\n", output.PrintTime(connector.CreatedAt)))
out.Stdout(fmt.Sprintf("Updated At: %s\n", output.PrintTime(connector.UpdatedAt)))
display.DisplayConnectorConfig(out, connector.Config, 0)
out.Stdout(fmt.Sprintf("Created At: %s\n", display.PrintTime(connector.CreatedAt)))
out.Stdout(fmt.Sprintf("Updated At: %s\n", display.PrintTime(connector.UpdatedAt)))

output.DisplayProcessors(out, processors, 0)
display.DisplayProcessors(out, processors, 0)
}
8 changes: 4 additions & 4 deletions cmd/conduit/root/connectors/list.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ import (
"github.com/alexeyco/simpletable"
"github.com/conduitio/conduit/cmd/conduit/api"
"github.com/conduitio/conduit/cmd/conduit/cecdysis"
"github.com/conduitio/conduit/cmd/conduit/internal/output"
"github.com/conduitio/conduit/cmd/conduit/internal/display"
apiv1 "github.com/conduitio/conduit/proto/api/v1"
"github.com/conduitio/ecdysis"
)
Expand Down Expand Up @@ -104,10 +104,10 @@ func getConnectorsTable(connectors []*apiv1.Connector) string {
r := []*simpletable.Cell{
{Align: simpletable.AlignLeft, Text: c.Id},
{Align: simpletable.AlignLeft, Text: c.Plugin},
{Align: simpletable.AlignLeft, Text: output.ConnectorTypeToString(c.Type)},
{Align: simpletable.AlignLeft, Text: display.ConnectorTypeToString(c.Type)},
{Align: simpletable.AlignLeft, Text: c.PipelineId},
{Align: simpletable.AlignLeft, Text: output.PrintTime(c.CreatedAt)},
{Align: simpletable.AlignLeft, Text: output.PrintTime(c.UpdatedAt)},
{Align: simpletable.AlignLeft, Text: display.PrintTime(c.CreatedAt)},
{Align: simpletable.AlignLeft, Text: display.PrintTime(c.UpdatedAt)},
}
table.Body.Cells = append(table.Body.Cells, r)
}
Expand Down
177 changes: 78 additions & 99 deletions cmd/conduit/root/connectors/list_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import (

"github.com/conduitio/conduit/cmd/conduit/api"
"github.com/conduitio/conduit/cmd/conduit/api/mock"
"github.com/conduitio/conduit/cmd/conduit/internal/display"
"github.com/conduitio/conduit/cmd/conduit/internal/testutils"
apiv1 "github.com/conduitio/conduit/proto/api/v1"
"github.com/conduitio/ecdysis"
Expand Down Expand Up @@ -63,122 +64,100 @@ func TestConnectorsListCommandFlags(t *testing.T) {
}
}

func TestListCommandExecuteWithClient_WithConnectorsAndNoFlags(t *testing.T) {
is := is.New(t)

buf := new(bytes.Buffer)
out := &ecdysis.DefaultOutput{}
out.Output(buf, nil)

ctx := context.Background()
ctrl := gomock.NewController(t)
defer ctrl.Finish()

mockService := mock.NewMockConnectorService(ctrl)

testutils.MockGetListConnectors(mockService, "", []*apiv1.Connector{
func TestListCommandExecuteWithClient(t *testing.T) {
tests := []struct {
name string
flags ListFlags
connectors []*apiv1.Connector
}{
{
Id: "conn1",
Type: apiv1.Connector_TYPE_SOURCE,
Plugin: "plugin1",
ProcessorIds: []string{"proc3"},
PipelineId: "pipeline1",
CreatedAt: testutils.GetDateTime(),
UpdatedAt: testutils.GetDateTime(),
name: "WithConnectorsAndNoFlags",
flags: ListFlags{},
connectors: []*apiv1.Connector{
{
Id: "conn1",
Type: apiv1.Connector_TYPE_SOURCE,
Plugin: "plugin1",
ProcessorIds: []string{"proc3"},
PipelineId: "pipeline1",
CreatedAt: testutils.GetDateTime(),
UpdatedAt: testutils.GetDateTime(),
},
{
Id: "conn2",
Type: apiv1.Connector_TYPE_DESTINATION,
Plugin: "plugin2",
PipelineId: "pipeline2",
CreatedAt: testutils.GetDateTime(),
UpdatedAt: testutils.GetDateTime(),
},
},
},
{
Id: "conn2",
Type: apiv1.Connector_TYPE_DESTINATION,
Plugin: "plugin2",
PipelineId: "pipeline2",
CreatedAt: testutils.GetDateTime(),
UpdatedAt: testutils.GetDateTime(),
name: "WithConnectorsAndFlags",
flags: ListFlags{PipelineID: "pipeline1"},
connectors: []*apiv1.Connector{
{
Id: "conn1",
Type: apiv1.Connector_TYPE_SOURCE,
Plugin: "plugin1",
ProcessorIds: []string{"proc3"},
PipelineId: "pipeline1",
CreatedAt: testutils.GetDateTime(),
UpdatedAt: testutils.GetDateTime(),
},
},
},
})

client := &api.Client{
ConnectorServiceClient: mockService,
}

cmd := &ListCommand{}
cmd.Output(out)

err := cmd.ExecuteWithClient(ctx, client)
is.NoErr(err)

output := buf.String()
is.True(len(output) > 0)

is.True(strings.Contains(output, "ID"))
is.True(strings.Contains(output, "PLUGIN"))
is.True(strings.Contains(output, "TYPE"))
is.True(strings.Contains(output, "PIPELINE_ID"))
is.True(strings.Contains(output, "CREATED"))
is.True(strings.Contains(output, "LAST_UPDATED"))

is.True(strings.Contains(output, "conn1"))
is.True(strings.Contains(output, "plugin1"))
is.True(strings.Contains(output, "pipeline1"))
is.True(strings.Contains(output, "conn2"))
is.True(strings.Contains(output, "plugin2"))
is.True(strings.Contains(output, "destination"))
is.True(strings.Contains(output, "pipeline2"))

is.True(strings.Contains(output, "1970-01-01T00:00:00Z"))
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
is := is.New(t)

func TestListCommandExecuteWithClient_WithConnectorsAndFlags(t *testing.T) {
is := is.New(t)

buf := new(bytes.Buffer)
out := &ecdysis.DefaultOutput{}
out.Output(buf, nil)
buf := new(bytes.Buffer)
out := &ecdysis.DefaultOutput{}
out.Output(buf, nil)

ctx := context.Background()
ctrl := gomock.NewController(t)
defer ctrl.Finish()
ctx := context.Background()
ctrl := gomock.NewController(t)
defer ctrl.Finish()

mockService := mock.NewMockConnectorService(ctrl)
mockService := mock.NewMockConnectorService(ctrl)

client := &api.Client{
ConnectorServiceClient: mockService,
}
testutils.MockGetListConnectors(mockService, tt.flags.PipelineID, tt.connectors)

cmd := &ListCommand{
flags: ListFlags{PipelineID: "pipeline1"},
}
cmd.Output(out)
client := &api.Client{
ConnectorServiceClient: mockService,
}

testutils.MockGetListConnectors(mockService, cmd.flags.PipelineID, []*apiv1.Connector{
{
Id: "conn1",
Type: apiv1.Connector_TYPE_SOURCE,
Plugin: "plugin1",
ProcessorIds: []string{"proc3"},
PipelineId: "pipeline1",
CreatedAt: testutils.GetDateTime(),
UpdatedAt: testutils.GetDateTime(),
},
})
cmd := &ListCommand{
flags: tt.flags,
}
cmd.Output(out)

err := cmd.ExecuteWithClient(ctx, client)
is.NoErr(err)
err := cmd.ExecuteWithClient(ctx, client)
is.NoErr(err)

output := buf.String()
is.True(len(output) > 0)
output := buf.String()
is.True(len(output) > 0)

is.True(strings.Contains(output, "ID"))
is.True(strings.Contains(output, "PLUGIN"))
is.True(strings.Contains(output, "TYPE"))
is.True(strings.Contains(output, "PIPELINE_ID"))
is.True(strings.Contains(output, "CREATED"))
is.True(strings.Contains(output, "LAST_UPDATED"))
is.True(strings.Contains(output, "ID"))
is.True(strings.Contains(output, "PLUGIN"))
is.True(strings.Contains(output, "TYPE"))
is.True(strings.Contains(output, "PIPELINE_ID"))
is.True(strings.Contains(output, "CREATED"))
is.True(strings.Contains(output, "LAST_UPDATED"))

is.True(strings.Contains(output, "conn1"))
is.True(strings.Contains(output, "plugin1"))
is.True(strings.Contains(output, "pipeline1"))
for _, connector := range tt.connectors {
is.True(strings.Contains(output, connector.Id))
is.True(strings.Contains(output, connector.Plugin))
is.True(strings.Contains(output, connector.PipelineId))
is.True(strings.Contains(output, display.ConnectorTypeToString(connector.Type)))
}

is.True(strings.Contains(output, "1970-01-01T00:00:00Z"))
is.True(strings.Contains(output, "1970-01-01T00:00:00Z"))
})
}
}

func TestListCommandExecuteWithClient_EmptyResponse(t *testing.T) {
Expand Down
26 changes: 13 additions & 13 deletions cmd/conduit/root/pipelines/describe.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import (
"context"
"fmt"

"github.com/conduitio/conduit/cmd/conduit/internal/output"
"github.com/conduitio/conduit/cmd/conduit/internal/display"

"github.com/conduitio/conduit/cmd/conduit/api"
"github.com/conduitio/conduit/cmd/conduit/cecdysis"
Expand Down Expand Up @@ -156,7 +156,7 @@ func displayPipeline(out ecdysis.Output, pipeline *apiv1.Pipeline, pipelineProce

// State
if pipeline.State != nil {
out.Stdout(fmt.Sprintf("Status: %s\n", output.PrintStatusFromProtoString(pipeline.State.Status.String())))
out.Stdout(fmt.Sprintf("Status: %s\n", display.PrintStatusFromProtoString(pipeline.State.Status.String())))
if pipeline.State.Error != "" {
out.Stdout(fmt.Sprintf("Error: %s\n", pipeline.State.Error))
}
Expand All @@ -174,7 +174,7 @@ func displayPipeline(out ecdysis.Output, pipeline *apiv1.Pipeline, pipelineProce
out.Stdout("Sources:\n")
displayConnectorsAndProcessors(out, connectors, connectorProcessors, apiv1.Connector_TYPE_SOURCE)

output.DisplayProcessors(out, pipelineProcessors, 0)
display.DisplayProcessors(out, pipelineProcessors, 0)

out.Stdout("Destinations:\n")
displayConnectorsAndProcessors(out, connectors, connectorProcessors, apiv1.Connector_TYPE_DESTINATION)
Expand All @@ -183,32 +183,32 @@ func displayPipeline(out ecdysis.Output, pipeline *apiv1.Pipeline, pipelineProce

// Timestamps
if pipeline.CreatedAt != nil {
out.Stdout(fmt.Sprintf("Created At: %s\n", output.PrintTime(pipeline.CreatedAt)))
out.Stdout(fmt.Sprintf("Created At: %s\n", display.PrintTime(pipeline.CreatedAt)))
}
if pipeline.UpdatedAt != nil {
out.Stdout(fmt.Sprintf("Updated At: %s\n", output.PrintTime(pipeline.UpdatedAt)))
out.Stdout(fmt.Sprintf("Updated At: %s\n", display.PrintTime(pipeline.UpdatedAt)))
}

return nil
}

func displayDLQ(out ecdysis.Output, dlq *apiv1.Pipeline_DLQ) {
out.Stdout("Dead-letter queue:\n")
out.Stdout(fmt.Sprintf("%sPlugin: %s\n", output.Indentation(1), dlq.Plugin))
out.Stdout(fmt.Sprintf("%sPlugin: %s\n", display.Indentation(1), dlq.Plugin))
}

func displayConnectorsAndProcessors(out ecdysis.Output, connectors []*apiv1.Connector, connectorProcessors map[string][]*apiv1.Processor, connType apiv1.Connector_Type) {
for _, conn := range connectors {
if conn.Type == connType {
out.Stdout(fmt.Sprintf("%s- ID: %s\n", output.Indentation(1), conn.Id))
out.Stdout(fmt.Sprintf("%sPlugin: %s\n", output.Indentation(2), conn.Plugin))
out.Stdout(fmt.Sprintf("%sPipeline ID: %s\n", output.Indentation(2), conn.PipelineId))
output.DisplayConnectorConfig(out, conn.Config, 2)
out.Stdout(fmt.Sprintf("%s- ID: %s\n", display.Indentation(1), conn.Id))
out.Stdout(fmt.Sprintf("%sPlugin: %s\n", display.Indentation(2), conn.Plugin))
out.Stdout(fmt.Sprintf("%sPipeline ID: %s\n", display.Indentation(2), conn.PipelineId))
display.DisplayConnectorConfig(out, conn.Config, 2)
if processors, ok := connectorProcessors[conn.Id]; ok {
output.DisplayProcessors(out, processors, 2)
display.DisplayProcessors(out, processors, 2)
}
out.Stdout(fmt.Sprintf("%sCreated At: %s\n", output.Indentation(2), output.PrintTime(conn.CreatedAt)))
out.Stdout(fmt.Sprintf("%sUpdated At: %s\n", output.Indentation(2), output.PrintTime(conn.UpdatedAt)))
out.Stdout(fmt.Sprintf("%sCreated At: %s\n", display.Indentation(2), display.PrintTime(conn.CreatedAt)))
out.Stdout(fmt.Sprintf("%sUpdated At: %s\n", display.Indentation(2), display.PrintTime(conn.UpdatedAt)))
}
}
}
Loading

0 comments on commit 7d6c466

Please sign in to comment.