fix: cache actions for PR jobs (#28)

Author: d2lam

store-cli.go

@@ -7,6 +7,7 @@ import (
 	"path/filepath"
 	"runtime/debug"
 	"strings"
+	"log"
 
 	"github.com/screwdriver-cd/store-cli/sdstore"
 	"github.com/urfave/cli"
@@ -39,10 +40,27 @@ func finalRecover() {
 	successExit()
 }
 
+// Skip cache action for PR jobs (event, pipeline scope)
+func skipCache(storeType, scope, action string) bool {
+	// if is not cache, or if job is not PR
+	if (storeType != "cache" || os.Getenv("SD_PULL_REQUEST") == "") {
+		return false
+	}
+
+	// For PR jobs,
+	// skip PR event cache to save time, since PR event only consists of 1 job
+	// skip pipeline scoped unless it's trying to get
+	if (scope == "event" || (scope == "pipeline" && action != "get")) {
+		log.Printf("Skipping %s %s-scoped cache for Pull Request", action, scope)
+		return true
+	}
+
+	return false
+}
+
 // makeURL creates the fully-qualified url for a given Store path
 func makeURL(storeType, scope, key string) (*url.URL, error) {
 	storeURL := os.Getenv("SD_STORE_URL")
-
 	var scopeEnv string
 	switch scope {
 	case "event":
@@ -82,6 +100,10 @@ func makeURL(storeType, scope, key string) (*url.URL, error) {
 }
 
 func get(storeType, scope, key string) error {
+	if skipCache(storeType, scope, "get") {
+		return nil
+	}
+
 	sdToken := os.Getenv("SD_TOKEN")
 	fullURL, err := makeURL(storeType, scope, key)
 
@@ -104,6 +126,9 @@ func get(storeType, scope, key string) error {
 }
 
 func set(storeType, scope, filePath string) error {
+	if skipCache(storeType, scope, "set") {
+		return nil
+	}
 	sdToken := os.Getenv("SD_TOKEN")
 	fullURL, err := makeURL(storeType, scope, filePath)
 
@@ -124,6 +149,10 @@ func set(storeType, scope, filePath string) error {
 }
 
 func remove(storeType, scope, key string) error {
+	if skipCache(storeType, scope, "remove") {
+		return nil
+	}
+
 	sdToken := os.Getenv("SD_TOKEN")
 	store := sdstore.NewStore(sdToken)
 

store-cli_test.go

@@ -15,6 +15,37 @@ func TestMain(m *testing.M) {
 	os.Exit(retCode)
 }
 
+func TestSkipCache(t *testing.T) {
+	// Success test cases
+	testCases := []struct {
+		storeType string
+		scope     string
+		action		string
+		prNum			string
+		expected	bool
+	}{
+		{"cache", "pipeline", "get", "", false},
+		{"cache", "pipeline", "get", "123", false},
+		{"cache", "pipeline", "set", "123", true},
+		{"cache", "pipeline", "remove", "123", true},
+		{"cache", "event", "get", "", false},
+		{"cache", "event", "get", "123", true},
+		{"cache", "event", "set", "123", true},
+		{"cache", "job", "get", "", false},
+		{"cache", "job", "set", "123", false},
+		{"artifact", "event", "get", "", false},
+		{"log", "build", "set", "123", false},
+	}
+
+	for _, tc := range testCases {
+		os.Setenv("SD_PULL_REQUEST", tc.prNum)
+		skip := skipCache(tc.storeType, tc.scope, tc.action)
+		if skip != tc.expected {
+			t.Fatalf("%s %s for scope %s, expected '%t' got '%t'", tc.action, tc.storeType, tc.scope, tc.expected, skip)
+		}
+	}
+}
+
 func TestMakeURL(t *testing.T) {
 	os.Setenv("SD_STORE_URL", "http://store.screwdriver.cd/v1/")
 	os.Setenv("SD_BUILD_ID", "10038")