Refactor common code for podman/cluster

Author: feloy

pkg/dev/common/run.go

@@ -0,0 +1,53 @@
+package common
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/redhat-developer/odo/pkg/component"
+	"github.com/redhat-developer/odo/pkg/configAutomount"
+	"github.com/redhat-developer/odo/pkg/devfile/image"
+	"github.com/redhat-developer/odo/pkg/exec"
+	"github.com/redhat-developer/odo/pkg/libdevfile"
+	odocontext "github.com/redhat-developer/odo/pkg/odo/context"
+	"github.com/redhat-developer/odo/pkg/platform"
+	"github.com/redhat-developer/odo/pkg/testingutil/filesystem"
+)
+
+func Run(
+	ctx context.Context,
+	commandName string,
+	platformClient platform.Client,
+	execClient exec.Client,
+	configAutomountClient configAutomount.Client,
+	filesystem filesystem.Filesystem,
+) error {
+	var (
+		componentName = odocontext.GetComponentName(ctx)
+		devfileObj    = odocontext.GetEffectiveDevfileObj(ctx)
+		devfilePath   = odocontext.GetDevfilePath(ctx)
+	)
+
+	pod, err := platformClient.GetPodUsingComponentName(componentName)
+	if err != nil {
+		return fmt.Errorf("unable to get pod for component %s: %w", componentName, err)
+	}
+
+	handler := component.NewRunHandler(
+		ctx,
+		platformClient,
+		execClient,
+		configAutomountClient,
+		pod.Name,
+		false,
+		component.GetContainersNames(pod),
+		"Executing command in container",
+
+		filesystem,
+		image.SelectBackend(ctx),
+		*devfileObj,
+		devfilePath,
+	)
+
+	return libdevfile.ExecuteCommandByName(ctx, *devfileObj, commandName, handler, false)
+}

pkg/dev/kubedev/run.go

@@ -2,47 +2,22 @@ package kubedev
 
 import (
 	"context"
-	"fmt"
 
-	"github.com/redhat-developer/odo/pkg/component"
-	"github.com/redhat-developer/odo/pkg/devfile/image"
-	"github.com/redhat-developer/odo/pkg/libdevfile"
-	odocontext "github.com/redhat-developer/odo/pkg/odo/context"
+	"github.com/redhat-developer/odo/pkg/dev/common"
 	"k8s.io/klog"
 )
 
 func (o *DevClient) Run(
 	ctx context.Context,
 	commandName string,
 ) error {
-	var (
-		componentName = odocontext.GetComponentName(ctx)
-		devfileObj    = odocontext.GetEffectiveDevfileObj(ctx)
-		devfilePath   = odocontext.GetDevfilePath(ctx)
-	)
-
 	klog.V(4).Infof("running command %q on cluster", commandName)
-
-	pod, err := o.kubernetesClient.GetPodUsingComponentName(componentName)
-	if err != nil {
-		return fmt.Errorf("unable to get pod for component %s: %w", componentName, err)
-	}
-
-	handler := component.NewRunHandler(
+	return common.Run(
 		ctx,
+		commandName,
 		o.kubernetesClient,
 		o.execClient,
 		o.configAutomountClient,
-		pod.Name,
-		false,
-		component.GetContainersNames(pod),
-		"Executing command in container",
-
 		o.filesystem,
-		image.SelectBackend(ctx),
-		*devfileObj,
-		devfilePath,
 	)
-
-	return libdevfile.ExecuteCommandByName(ctx, *devfileObj, commandName, handler, false)
 }

pkg/dev/podmandev/run.go

@@ -2,47 +2,22 @@ package podmandev
 
 import (
 	"context"
-	"fmt"
 
-	"github.com/redhat-developer/odo/pkg/component"
-	"github.com/redhat-developer/odo/pkg/devfile/image"
-	"github.com/redhat-developer/odo/pkg/libdevfile"
-	odocontext "github.com/redhat-developer/odo/pkg/odo/context"
+	"github.com/redhat-developer/odo/pkg/dev/common"
 	"k8s.io/klog"
 )
 
 func (o *DevClient) Run(
 	ctx context.Context,
 	commandName string,
 ) error {
-	var (
-		componentName = odocontext.GetComponentName(ctx)
-		devfileObj    = odocontext.GetEffectiveDevfileObj(ctx)
-		devfilePath   = odocontext.GetDevfilePath(ctx)
-	)
-
 	klog.V(4).Infof("running command %q on cluster", commandName)
-
-	pod, err := o.podmanClient.GetPodUsingComponentName(componentName)
-	if err != nil {
-		return fmt.Errorf("unable to get pod for component %s: %w", componentName, err)
-	}
-
-	handler := component.NewRunHandler(
+	return common.Run(
 		ctx,
+		commandName,
 		o.podmanClient,
 		o.execClient,
 		nil, // TODO(feloy) set when running on new container is supported on podman
-		pod.Name,
-		false,
-		component.GetContainersNames(pod),
-		"Executing command in container",
-
 		o.fs,
-		image.SelectBackend(ctx),
-		*devfileObj,
-		devfilePath,
 	)
-
-	return libdevfile.ExecuteCommandByName(ctx, *devfileObj, commandName, handler, false)
 }

pkg/exec/exec_test.go

@@ -44,6 +44,10 @@ func (o fakePlatform) GetRunningPodFromSelector(selector string) (*corev1.Pod, e
 	panic("not implemented yet")
 }
 
+func (o fakePlatform) GetPodUsingComponentName(componentName string) (*corev1.Pod, error) {
+	panic("not implemented yet")
+}
+
 func TestExecuteCommand(t *testing.T) {
 	for _, tt := range []struct {
 		name               string

pkg/platform/interface.go

@@ -31,4 +31,6 @@ type Client interface {
 	// GetRunningPodFromSelector returns any pod matching the given label selector.
 	// If multiple pods are found, implementations might have different behavior, by either returning an error or returning any element.
 	GetRunningPodFromSelector(selector string) (*corev1.Pod, error)
+
+	GetPodUsingComponentName(componentName string) (*corev1.Pod, error)
 }

pkg/platform/mock.go

@@ -38,7 +38,5 @@ type Client interface {
 
 	ListAllComponents() ([]api.ComponentAbstract, error)
 
-	GetPodUsingComponentName(componentName string) (*corev1.Pod, error)
-
 	Version(ctx context.Context) (SystemVersionReport, error)
 }