Add route-based ignore configuration

In some case, it would be useful to configure ignored routes.

Author: satotake

lib/config.go

@@ -140,12 +140,19 @@ func (cfg *Config) shouldIgnoreLocal(key string) bool {
 }
 
 func (cfg *Config) shouldIgnoreRemote(key string) bool {
-	if cfg.Ignore == "" {
-		return false
-	}
 
 	sub := key[len(cfg.BucketPath):]
 	sub = strings.TrimPrefix(sub, "/")
 
+	for _, r := range cfg.conf.Routes {
+		if r.Ignore && r.routerRE.MatchString(sub) {
+			return true
+		}
+	}
+
+	if cfg.Ignore == "" {
+		return false
+	}
+
 	return cfg.IgnoreRE.MatchString(sub)
 }

lib/deployer.go

@@ -289,6 +289,10 @@ func (d *Deployer) walk(ctx context.Context, basePath string, files chan<- *osFi
 			return err
 		}
 
+		if f.route != nil && f.route.Ignore {
+			return nil
+		}
+
 		select {
 		case <-ctx.Done():
 			return ctx.Err()

lib/deployer_test.go

@@ -136,6 +136,44 @@ func TestDeployWitIgnorePattern(t *testing.T) {
 	c.Assert(prevTag, qt.Equals, mainCss.ETag())
 }
 
+func TestDeployWitRoutesIgnore(t *testing.T) {
+	c := qt.New(t)
+	root := "my/path"
+
+	store, m := newTestStore(0, root)
+	source := testSourcePath()
+	configFile := filepath.Join(source, ".hidden/.s3deploy.ignore.yml")
+
+	cfg := &Config{
+		BucketName: "example.com",
+		RegionName: "eu-west-1",
+		ConfigFile: configFile,
+		BucketPath: root,
+		MaxDelete:  300,
+		Silent:     false,
+		SourcePath: source,
+		baseStore:  store,
+	}
+
+	// same as TestDeployWitIgnorePattern
+
+	prevCss := m["my/path/main.css"]
+	prevTag := prevCss.ETag()
+
+	stats, err := Deploy(cfg)
+	c.Assert(err, qt.IsNil)
+	c.Assert(stats.Summary(), qt.Equals, "Deleted 0 of 0, uploaded 2, skipped 1 (67% changed)")
+	assertKeys(t, m,
+		"my/path/.s3deploy.yml",
+		"my/path/index.html",
+		"my/path/ab.txt",
+		"my/path/deleteme.txt", // ignored: stale
+		"my/path/main.css",     // ignored: not updated
+	)
+	mainCss := m["my/path/main.css"]
+	c.Assert(prevTag, qt.Equals, mainCss.ETag())
+}
+
 func TestDeploySourceNotFound(t *testing.T) {
 	c := qt.New(t)
 	store, _ := newTestStore(0, "")

lib/files.go

@@ -239,6 +239,7 @@ type route struct {
 	Route   string            `yaml:"route"`
 	Headers map[string]string `yaml:"headers"`
 	Gzip    bool              `yaml:"gzip"`
+	Ignore  bool              `yaml:"ignore"`
 
 	routerRE *regexp.Regexp // compiled version of Route
 }

lib/testdata/.hidden/.s3deploy.ignore.yml

@@ -0,0 +1,14 @@
+routes:
+    - route: "^main\\.css|deleteme\\.txt$"
+      ignore: true
+    - route: "^.+\\.(js|css|svg|ttf)$"
+      #  cache static assets for 20 years
+      headers:
+         Cache-Control: "max-age=630720000, no-transform, public"
+      gzip: true
+    - route: "^.+\\.(png|jpg)$"
+      headers:
+         Cache-Control: "max-age=630720000, no-transform, public"
+      gzip: true
+    - route: "^.+\\.(html|xml|json)$"
+      gzip: true