Make it possible to disable auto-sync (#4923)

* hack at turning auto into a bool

* Use MarshalJSON to DTRT

* make generate-schemas

* small cleanup

* fix additional auto:{} references

* Update docs on disabling auto-sync

Author: briandealwis

docs/content/en/docs/pipeline-stages/filesync.md

@@ -98,20 +98,15 @@ Changes to other file types trigger an image rebuild.
 
 ##### Disable Auto Sync for Buildpacks
 
-To disable auto sync, simply provide a manual sync rule.  It does
-not matter if the sync rule does not match any actual files.
-For example:
+To disable auto sync, set `sync.auto = false`:
 
 ```
 artifacts:
 - image: xxx
   buildpacks:
     builder: gcr.io/buildpacks/builder:v1
-  # disable buildpacks auto-sync
   sync: 
-    manual: 
-    - src: .
-      dest: .
+    auto: false   # disable buildpacks auto-sync
 ```
 
 ##### How it works
@@ -125,7 +120,7 @@ have to output the sync rules based on their exploration of the source and the b
 Those sync rules will then be used by Skaffold without the user having to configure them manually.
 
 Another thing the Buildpacks have to do is support the `GOOGLE_DEVMODE` environment variable. Skaffold will
-set it to `1` when running `skaffold dev` with sync configured to `auto: {}`. The Buildpacks can then use that
+set it to `1` when running `skaffold dev` with sync configured to `auto: true`. The Buildpacks can then use that
 signal to change the way the application is built so that it reloads the changes or rebuilds the app on each change.
 
 #### Jib

docs/content/en/schemas/v2beta9.json

@@ -385,10 +385,6 @@
       "description": "describes a specific build dependency for an artifact.",
       "x-intellij-html-description": "describes a specific build dependency for an artifact."
     },
-    "Auto": {
-      "description": "cannot be customized.",
-      "x-intellij-html-description": "cannot be customized."
-    },
     "BazelArtifact": {
       "required": [
         "target"
@@ -2534,7 +2530,7 @@
     "Sync": {
       "properties": {
         "auto": {
-          "$ref": "#/definitions/Auto",
+          "type": "boolean",
           "description": "delegates discovery of sync rules to the build system. Only available for jib and buildpacks.",
           "x-intellij-html-description": "delegates discovery of sync rules to the build system. Only available for jib and buildpacks."
         },

integration/examples/jib-sync/README.md

@@ -58,7 +58,7 @@ build:
     context: .
     jib: {}
     sync: 
-      auto: {}
+      auto: true
 ```
 
 This example is designed around the functionality available in [Spring Boot Developer Tools](https://docs.spring.io/spring-boot/docs/current/reference/html/using-spring-boot.html#using-boot-devtools) for developing against running applications.
@@ -76,7 +76,7 @@ build:
     jib: 
       fromImage: gcr.io/distroless/java:debug
     sync: 
-      auto: {}
+      auto: true
 ```
 
 
@@ -121,7 +121,7 @@ build:
       args: 
       - -Psync
     sync: 
-      auto: {}
+      auto: true
 ```
 
 You can also take advantage of [skaffold profiles](https://skaffold.dev/docs/environment/profiles/) to control when to activate sync on your project.
@@ -141,7 +141,7 @@ profiles:
     # we want to activate sync on our skaffold artifact
     path: /build/artifacts/0/sync
     value:
-      - auto: {}
+      - auto: true
   - op: add
     # we activate the sync profile in our java builds
     path: /build/artifacts/0/jib/args

integration/examples/jib-sync/skaffold-gradle.yaml

@@ -9,7 +9,7 @@ build:
       - -Psync
       fromImage: gcr.io/distroless/java:debug
     sync:
-      auto: {}
+      auto: true
 
 portForward:
 - resourceType: pod

integration/examples/jib-sync/skaffold-maven.yaml

@@ -10,7 +10,7 @@ build:
       - -Psync
       fromImage: gcr.io/distroless/java:debug
     sync:
-      auto: {}
+      auto: true
 
 portForward:
 - resourceType: pod

pkg/skaffold/build/buildpacks/build_test.go

@@ -27,6 +27,7 @@ import (
 	"github.com/GoogleContainerTools/skaffold/pkg/skaffold/config"
 	"github.com/GoogleContainerTools/skaffold/pkg/skaffold/docker"
 	"github.com/GoogleContainerTools/skaffold/pkg/skaffold/schema/latest"
+	"github.com/GoogleContainerTools/skaffold/pkg/skaffold/util"
 	"github.com/GoogleContainerTools/skaffold/testutil"
 )
 
@@ -185,7 +186,7 @@ value = "VALUE2"
 		},
 		{
 			description: "dev mode",
-			artifact:    withSync(&latest.Sync{Auto: &latest.Auto{}}, buildpacksArtifact("another/builder", "another/run")),
+			artifact:    withSync(&latest.Sync{Auto: util.BoolPtr(true)}, buildpacksArtifact("another/builder", "another/run")),
 			tag:         "img:tag",
 			api:         &testutil.FakeAPIClient{},
 			mode:        config.RunModes.Dev,

pkg/skaffold/build/buildpacks/env.go

@@ -46,7 +46,7 @@ func env(a *latest.Artifact, mode config.RunMode, projectDescriptor project.Desc
 		return nil, fmt.Errorf("unable to evaluate env variables: %w", err)
 	}
 
-	if mode == config.RunModes.Dev && a.Sync != nil && a.Sync.Auto != nil {
+	if mode == config.RunModes.Dev && a.Sync != nil && a.Sync.Auto != nil && *a.Sync.Auto {
 		envVars = append(envVars, "GOOGLE_DEVMODE=1")
 	}
 

pkg/skaffold/schema/defaults/defaults.go

@@ -27,6 +27,7 @@ import (
 	"github.com/GoogleContainerTools/skaffold/pkg/skaffold/constants"
 	kubectx "github.com/GoogleContainerTools/skaffold/pkg/skaffold/kubernetes/context"
 	"github.com/GoogleContainerTools/skaffold/pkg/skaffold/schema/latest"
+	"github.com/GoogleContainerTools/skaffold/pkg/skaffold/util"
 )
 
 const (
@@ -235,13 +236,13 @@ func setDefaultSync(a *latest.Artifact) {
 		if len(a.Sync.Manual) == 0 && len(a.Sync.Infer) == 0 && a.Sync.Auto == nil {
 			switch {
 			case a.JibArtifact != nil || a.BuildpackArtifact != nil:
-				a.Sync.Auto = &latest.Auto{}
+				a.Sync.Auto = util.BoolPtr(true)
 			default:
 				a.Sync.Infer = []string{"**/*"}
 			}
 		}
 	} else if a.BuildpackArtifact != nil {
-		a.Sync = &latest.Sync{Auto: &latest.Auto{}}
+		a.Sync = &latest.Sync{Auto: util.BoolPtr(true)}
 	}
 }
 

pkg/skaffold/schema/defaults/defaults_test.go

@@ -26,6 +26,7 @@ import (
 	"github.com/GoogleContainerTools/skaffold/pkg/skaffold/constants"
 	kubectx "github.com/GoogleContainerTools/skaffold/pkg/skaffold/kubernetes/context"
 	"github.com/GoogleContainerTools/skaffold/pkg/skaffold/schema/latest"
+	"github.com/GoogleContainerTools/skaffold/pkg/skaffold/util"
 	"github.com/GoogleContainerTools/skaffold/testutil"
 )
 
@@ -76,6 +77,13 @@ func TestSetDefaults(t *testing.T) {
 							BuildpackArtifact: &latest.BuildpackArtifact{},
 						},
 					},
+					{
+						ImageName: "seventh",
+						ArtifactType: latest.ArtifactType{
+							BuildpackArtifact: &latest.BuildpackArtifact{},
+						},
+						Sync: &latest.Sync{Auto: util.BoolPtr(false)},
+					},
 				},
 			},
 		},
@@ -103,16 +111,22 @@ func TestSetDefaults(t *testing.T) {
 	testutil.CheckDeepEqual(t, []string{"."}, cfg.Build.Artifacts[3].BuildpackArtifact.Dependencies.Paths)
 	testutil.CheckDeepEqual(t, []string(nil), cfg.Build.Artifacts[3].BuildpackArtifact.Dependencies.Ignore)
 	testutil.CheckDeepEqual(t, "project.toml", cfg.Build.Artifacts[3].BuildpackArtifact.ProjectDescriptor)
-	testutil.CheckDeepEqual(t, &latest.Auto{}, cfg.Build.Artifacts[3].Sync.Auto)
+	testutil.CheckDeepEqual(t, util.BoolPtr(true), cfg.Build.Artifacts[3].Sync.Auto)
 
 	testutil.CheckDeepEqual(t, "fifth", cfg.Build.Artifacts[4].ImageName)
-	testutil.CheckDeepEqual(t, &latest.Auto{}, cfg.Build.Artifacts[4].Sync.Auto)
+	testutil.CheckDeepEqual(t, util.BoolPtr(true), cfg.Build.Artifacts[4].Sync.Auto)
 
 	testutil.CheckDeepEqual(t, "sixth", cfg.Build.Artifacts[5].ImageName)
 	testutil.CheckDeepEqual(t, []string{"."}, cfg.Build.Artifacts[5].BuildpackArtifact.Dependencies.Paths)
 	testutil.CheckDeepEqual(t, []string(nil), cfg.Build.Artifacts[5].BuildpackArtifact.Dependencies.Ignore)
 	testutil.CheckDeepEqual(t, "project.toml", cfg.Build.Artifacts[5].BuildpackArtifact.ProjectDescriptor)
-	testutil.CheckDeepEqual(t, &latest.Auto{}, cfg.Build.Artifacts[5].Sync.Auto)
+	testutil.CheckDeepEqual(t, util.BoolPtr(true), cfg.Build.Artifacts[5].Sync.Auto)
+
+	testutil.CheckDeepEqual(t, "seventh", cfg.Build.Artifacts[6].ImageName)
+	testutil.CheckDeepEqual(t, []string{"."}, cfg.Build.Artifacts[6].BuildpackArtifact.Dependencies.Paths)
+	testutil.CheckDeepEqual(t, []string(nil), cfg.Build.Artifacts[6].BuildpackArtifact.Dependencies.Ignore)
+	testutil.CheckDeepEqual(t, "project.toml", cfg.Build.Artifacts[6].BuildpackArtifact.ProjectDescriptor)
+	testutil.CheckDeepEqual(t, util.BoolPtr(false), cfg.Build.Artifacts[6].Sync.Auto)
 }
 
 func TestSetDefaultsOnCluster(t *testing.T) {

pkg/skaffold/schema/latest/config.go

@@ -786,7 +786,7 @@ type Sync struct {
 
 	// Auto delegates discovery of sync rules to the build system.
 	// Only available for jib and buildpacks.
-	Auto *Auto `yaml:"auto,omitempty" yamltags:"oneOf=sync"`
+	Auto *bool `yaml:"auto,omitempty" yamltags:"oneOf=sync"`
 }
 
 // SyncRule specifies which local files to sync to remote folders.
@@ -806,9 +806,6 @@ type SyncRule struct {
 	Strip string `yaml:"strip,omitempty"`
 }
 
-// Auto cannot be customized.
-type Auto struct{}
-
 // Profile is used to override any `build`, `test` or `deploy` configuration.
 type Profile struct {
 	// Name is a unique profile name.

pkg/skaffold/schema/v2beta8/upgrade.go

@@ -24,6 +24,10 @@ import (
 
 // Upgrade upgrades a configuration to the next version.
 // Config changes from v2beta8 to v2beta9
+// 1. No additions:
+// 2. No removals
+// 3. Updates:
+//    - sync.auto becomes boolean
 func (c *SkaffoldConfig) Upgrade() (util.VersionedConfig, error) {
 	var newConfig next.SkaffoldConfig
 	pkgutil.CloneThroughJSON(c, &newConfig)
@@ -36,3 +40,11 @@ func (c *SkaffoldConfig) Upgrade() (util.VersionedConfig, error) {
 func upgradeOnePipeline(_, _ interface{}) error {
 	return nil
 }
+
+func (a *Auto) MarshalJSON() ([]byte, error) {
+	// The presence of an Auto{} means auto-sync is enabled.
+	if a != nil {
+		return []byte(`true`), nil
+	}
+	return nil, nil
+}

pkg/skaffold/schema/v2beta8/upgrade_test.go

@@ -46,6 +46,8 @@ build:
   - image: gcr.io/k8s-skaffold/buildpacks
     buildpacks:
       builder: gcr.io/buildpacks/builder:v1
+    sync:
+      auto: {}
   googleCloudBuild:
     projectId: test-project
 test:
@@ -115,6 +117,8 @@ build:
   - image: gcr.io/k8s-skaffold/buildpacks
     buildpacks:
       builder: gcr.io/buildpacks/builder:v1
+    sync:
+      auto: true
   googleCloudBuild:
     projectId: test-project
 test:

pkg/skaffold/sync/sync_test.go

@@ -650,7 +650,7 @@ func TestNewSyncItem(t *testing.T) {
 				},
 				ImageName: "test",
 				Sync: &latest.Sync{
-					Auto: &latest.Auto{},
+					Auto: util.BoolPtr(true),
 				},
 				Workspace: ".",
 			},
@@ -690,7 +690,7 @@ func TestNewSyncItem(t *testing.T) {
 				},
 				ImageName: "test",
 				Sync: &latest.Sync{
-					Auto: &latest.Auto{},
+					Auto: util.BoolPtr(true),
 				},
 				Workspace: ".",
 			},
@@ -724,7 +724,7 @@ func TestNewSyncItem(t *testing.T) {
 				ImageName: "test",
 				Workspace: ".",
 				Sync: &latest.Sync{
-					Auto: &latest.Auto{},
+					Auto: util.BoolPtr(true),
 				},
 				ArtifactType: latest.ArtifactType{
 					JibArtifact: &latest.JibArtifact{},
@@ -1073,18 +1073,18 @@ func TestInit(t *testing.T) {
 		},
 		{
 			description: "sync on, auto on, non-jib",
-			artifact:    &latest.Artifact{Sync: &latest.Sync{Auto: &latest.Auto{}}},
+			artifact:    &latest.Artifact{Sync: &latest.Sync{Auto: util.BoolPtr(true)}},
 			shouldInit:  false,
 		},
 		{
 			description: "sync on, auto on, jib",
-			artifact:    &latest.Artifact{ArtifactType: latest.ArtifactType{JibArtifact: &latest.JibArtifact{}}, Sync: &latest.Sync{Auto: &latest.Auto{}}},
+			artifact:    &latest.Artifact{ArtifactType: latest.ArtifactType{JibArtifact: &latest.JibArtifact{}}, Sync: &latest.Sync{Auto: util.BoolPtr(true)}},
 			shouldInit:  true,
 			initErrors:  false,
 		},
 		{
 			description: "sync on, auto on, jib, init fails",
-			artifact:    &latest.Artifact{ArtifactType: latest.ArtifactType{JibArtifact: &latest.JibArtifact{}}, Sync: &latest.Sync{Auto: &latest.Auto{}}},
+			artifact:    &latest.Artifact{ArtifactType: latest.ArtifactType{JibArtifact: &latest.JibArtifact{}}, Sync: &latest.Sync{Auto: util.BoolPtr(true)}},
 			shouldInit:  true,
 			initErrors:  true,
 		},