Feat(sync): skip sync on non-running pods

Fix issue #2360

The goal of this PR is to avoid trying to sync files in a pod which is
not in a running state. It should avoid errors when working on a single
artifact which is deployed in different pods. For example : one running
a webserver and another running a work or a job. This is typically
something that could happend when a microservice is able to run both web
server and a job which make some sort of batch treatments on the database.

pkg/skaffold/sync/sync.go

@@ -169,6 +169,12 @@ func Perform(ctx context.Context, image string, files syncMap, cmdFn func(contex
 		}
 
 		for _, p := range pods.Items {
+
+			if p.Status.Phase != v1.PodRunning {
+				logrus.Infof("Skipping sync with pod %s because it's not running", p.Name)
+				continue
+			}
+
 			for _, c := range p.Spec.Containers {
 				if c.Image != image {
 					continue

pkg/skaffold/sync/sync_test.go

@@ -511,11 +511,32 @@ var pod = &v1.Pod{
 	},
 }
 
+var nonRunningPod = &v1.Pod{
+	ObjectMeta: meta_v1.ObjectMeta{
+		Name: "podname",
+		Labels: map[string]string{
+			"app.kubernetes.io/managed-by": "skaffold-dirty",
+		},
+	},
+	Status: v1.PodStatus{
+		Phase: v1.PodPending,
+	},
+	Spec: v1.PodSpec{
+		Containers: []v1.Container{
+			{
+				Name:  "container_name",
+				Image: "gcr.io/k8s-skaffold:123",
+			},
+		},
+	},
+}
+
 func TestPerform(t *testing.T) {
 	var tests = []struct {
 		description string
 		image       string
 		files       syncMap
+		pod         *v1.Pod
 		cmdFn       func(context.Context, v1.Pod, v1.Container, map[string][]string) []*exec.Cmd
 		cmdErr      error
 		clientErr   error
@@ -526,13 +547,15 @@ func TestPerform(t *testing.T) {
 			description: "no error",
 			image:       "gcr.io/k8s-skaffold:123",
 			files:       syncMap{"test.go": {"/test.go"}},
+			pod:         pod,
 			cmdFn:       fakeCmd,
 			expected:    []string{"copy test.go /test.go"},
 		},
 		{
 			description: "cmd error",
 			image:       "gcr.io/k8s-skaffold:123",
 			files:       syncMap{"test.go": {"/test.go"}},
+			pod:         pod,
 			cmdFn:       fakeCmd,
 			cmdErr:      fmt.Errorf(""),
 			shouldErr:   true,
@@ -541,6 +564,7 @@ func TestPerform(t *testing.T) {
 			description: "client error",
 			image:       "gcr.io/k8s-skaffold:123",
 			files:       syncMap{"test.go": {"/test.go"}},
+			pod:         pod,
 			cmdFn:       fakeCmd,
 			clientErr:   fmt.Errorf(""),
 			shouldErr:   true,
@@ -549,6 +573,15 @@ func TestPerform(t *testing.T) {
 			description: "no copy",
 			image:       "gcr.io/different-pod:123",
 			files:       syncMap{"test.go": {"/test.go"}},
+			pod:         pod,
+			cmdFn:       fakeCmd,
+			shouldErr:   true,
+		},
+		{
+			description: "Skip sync when pod is not running",
+			image:       "gcr.io/k8s-skaffold:123",
+			files:       syncMap{"test.go": {"/test.go"}},
+			pod:         nonRunningPod,
 			cmdFn:       fakeCmd,
 			shouldErr:   true,
 		},
@@ -559,7 +592,7 @@ func TestPerform(t *testing.T) {
 
 			t.Override(&util.DefaultExecCommand, cmdRecord)
 			t.Override(&pkgkubernetes.Client, func() (kubernetes.Interface, error) {
-				return fake.NewSimpleClientset(pod), test.clientErr
+				return fake.NewSimpleClientset(test.pod), test.clientErr
 			})
 
 			err := Perform(context.Background(), test.image, test.files, test.cmdFn, []string{""})