[TOOL-1955] Fix infinite loop (#717)

* added test to detect infinite loops * another loop test * added test * more tests, test fixes, new expand behaviour that mimics the way shell expands * simplified logic * require new plugin, version bump * dep update
bitrise-io · Apr 17, 2020 · dcef36f · jhass · Apr 20, 2020 · dcef36f
1 parent 6414764
commit dcef36f
Show file tree

Hide file tree

Showing 37 changed files with 211 additions and 41 deletions.
diff --git a/Gopkg.lock b/Gopkg.lock
diff --git a/_tests/integration/version_test.go b/_tests/integration/version_test.go
@@ -14,7 +14,7 @@ func Test_VersionOutput(t *testing.T) {
 	{
 		out, err := command.RunCommandAndReturnCombinedStdoutAndStderr(binPath(), "version")
 		require.NoError(t, err)
-		require.Equal(t, "1.41.0", out)
+		require.Equal(t, "1.41.1", out)
 	}
 
 	t.Log("Version --full")
@@ -23,7 +23,7 @@ func Test_VersionOutput(t *testing.T) {
 		require.NoError(t, err)
 
 		expectedOSVersion := fmt.Sprintf("%s (%s)", runtime.GOOS, runtime.GOARCH)
-		expectedVersionOut := fmt.Sprintf(`version: 1.41.0
+		expectedVersionOut := fmt.Sprintf(`version: 1.41.1
 format version: 10
 os: %s
 go: %s

diff --git a/bitrise/setup.go b/bitrise/setup.go
@@ -40,7 +40,7 @@ var PluginDependencyMap = map[string]PluginDependency{
 	},
 	"analytics": PluginDependency{
 		Source:     "https://github.com/bitrise-io/bitrise-plugins-analytics.git",
-		MinVersion: "0.12.0",
+		MinVersion: "0.12.1",
 	},
 }
 

diff --git a/cli/run_util.go b/cli/run_util.go
@@ -586,6 +586,26 @@ func expandStepInputs(
 ) map[string]string {
 	stepInputs := make(map[string]string)
 
+	var mappingFuncFactory func([]envmanModels.EnvironmentItemModel) func(string) string
+	mappingFuncFactory = func(environments []envmanModels.EnvironmentItemModel) func(key string) string {
+		return func(key string) string {
+			for inputName, inputValue := range stepInputs {
+				if inputName == key {
+					return os.Expand(inputValue, mappingFuncFactory(environments))
+				}
+			}
+
+			for index, environmentItem := range environments {
+				envValue := environmentItem[key]
+				if envValue != nil {
+					return os.Expand(envValue.(string), mappingFuncFactory(environments[:index]))
+				}
+			}
+
+			return os.Getenv(key)
+		}
+	}
+
 	// Retrieve all non-sensitive input values
 	for _, input := range inputs {
 		if err := input.FillMissingDefaults(); err != nil {
@@ -596,7 +616,7 @@ func expandStepInputs(
 		options, err := input.GetOptions()
 		if err == nil && *options.IsSensitive == false {
 			if inputName, inputValue, err := input.GetKeyValuePair(); err == nil {
-				stepInputs[inputName] = inputValue
+				stepInputs[inputName] = os.Expand(inputValue, mappingFuncFactory(environments))
 			} else {
 				log.Warnf("Failed to get input value for '%s', skipping input: %s", inputName, err)
 			}
@@ -605,28 +625,6 @@ func expandStepInputs(
 		}
 	}
 
-	var mappingFunc func(string) string
-	mappingFunc = func(key string) string {
-		for inputName, inputValue := range stepInputs {
-			if inputName == key {
-				return os.Expand(inputValue, mappingFunc)
-			}
-		}
-
-		for _, environmentItem := range environments {
-			envValue := environmentItem[key]
-			if envValue != nil {
-				return os.Expand(envValue.(string), mappingFunc)
-			}
-		}
-
-		return os.Getenv(key)
-	}
-
-	for inputName, inputValue := range stepInputs {
-		stepInputs[inputName] = os.Expand(inputValue, mappingFunc)
-	}
-
 	return stepInputs
 }
 

diff --git a/cli/run_util_test.go b/cli/run_util_test.go
@@ -805,9 +805,9 @@ func TestExpandStepInputsNeedExpansionWithinExpansion(t *testing.T) {
 	}
 
 	testEnvironment := []envmanModels.EnvironmentItemModel{
-		envmanModels.EnvironmentItemModel{"SIMULATOR_OS_VERSION": "$SIMULATOR_OS_MAJOR_VERSION.$SIMULATOR_OS_MINOR_VERSION", "opts": map[string]interface{}{"is_sensitive": false}},
 		envmanModels.EnvironmentItemModel{"SIMULATOR_OS_MAJOR_VERSION": "13", "opts": map[string]interface{}{"is_sensitive": false}},
 		envmanModels.EnvironmentItemModel{"SIMULATOR_OS_MINOR_VERSION": "3", "opts": map[string]interface{}{"is_sensitive": false}},
+		envmanModels.EnvironmentItemModel{"SIMULATOR_OS_VERSION": "$SIMULATOR_OS_MAJOR_VERSION.$SIMULATOR_OS_MINOR_VERSION", "opts": map[string]interface{}{"is_sensitive": false}},
 	}
 
 	// Act
@@ -838,3 +838,86 @@ func TestExpandStepInputsNeedCrossInputExpansion(t *testing.T) {
 	require.Empty(t, expandedInputs["secret_input"])
 	require.Equal(t, "iPhone 8 (13.3)", expandedInputs["simulator_device"])
 }
+
+func TestExpandSimpleLoopSkipped(t *testing.T) {
+	// Arrange
+	testInputs := []envmanModels.EnvironmentItemModel{
+		envmanModels.EnvironmentItemModel{"loop": "$loop", "opts": map[string]interface{}{"is_sensitive": false}},
+		envmanModels.EnvironmentItemModel{"env_loop": "$ENV_LOOP", "opts": map[string]interface{}{"is_sensitive": false}},
+	}
+
+	testEnvironment := []envmanModels.EnvironmentItemModel{
+		envmanModels.EnvironmentItemModel{"ENV_LOOP": "$ENV_LOOP", "opts": map[string]interface{}{"is_sensitive": false}},
+	}
+
+	// Act
+	expandedInputs := expandStepInputs(testInputs, testEnvironment)
+
+	// Assert
+	require.NotNil(t, expandedInputs)
+	require.Equal(t, "", expandedInputs["loop"])
+	require.Equal(t, "", expandedInputs["env_loop"])
+}
+
+func TestExpandLoopWithLengthOneSkipped(t *testing.T) {
+	// Arrange
+	testInputs := []envmanModels.EnvironmentItemModel{
+		envmanModels.EnvironmentItemModel{"loop": "Something: $loop", "opts": map[string]interface{}{"is_sensitive": false}},
+		envmanModels.EnvironmentItemModel{"env_loop": "$ENV_LOOP", "opts": map[string]interface{}{"is_sensitive": false}},
+	}
+
+	testEnvironment := []envmanModels.EnvironmentItemModel{
+		envmanModels.EnvironmentItemModel{"ENV_LOOP": "Env Something: $ENV_LOOP", "opts": map[string]interface{}{"is_sensitive": false}},
+	}
+
+	// Act
+	expandedInputs := expandStepInputs(testInputs, testEnvironment)
+
+	// Assert
+	require.NotNil(t, expandedInputs)
+	require.Equal(t, "Something: ", expandedInputs["loop"])
+	require.Equal(t, "Env Something: ", expandedInputs["env_loop"])
+}
+
+func TestExpandPrefixNotSkipped(t *testing.T) {
+	// Arrange
+	testInputs := []envmanModels.EnvironmentItemModel{
+		envmanModels.EnvironmentItemModel{"similar2": "anything", "opts": map[string]interface{}{"is_sensitive": false}},
+		envmanModels.EnvironmentItemModel{"similar": "$similar2", "opts": map[string]interface{}{"is_sensitive": false}},
+		envmanModels.EnvironmentItemModel{"env": "Something: $similar", "opts": map[string]interface{}{"is_sensitive": false}},
+	}
+
+	testEnvironment := []envmanModels.EnvironmentItemModel{}
+
+	// Act
+	expandedInputs := expandStepInputs(testInputs, testEnvironment)
+
+	// Assert
+	require.NotNil(t, expandedInputs)
+	require.Equal(t, "Something: anything", expandedInputs["env"])
+}
+
+func TestExpandMultiLengthLoopsSkipped(t *testing.T) {
+	// Arrange
+	testInputs := []envmanModels.EnvironmentItemModel{
+		envmanModels.EnvironmentItemModel{"a": "$b", "opts": map[string]interface{}{"is_sensitive": false}},
+		envmanModels.EnvironmentItemModel{"b": "$c", "opts": map[string]interface{}{"is_sensitive": false}},
+		envmanModels.EnvironmentItemModel{"c": "$a", "opts": map[string]interface{}{"is_sensitive": false}},
+		envmanModels.EnvironmentItemModel{"env": "$A", "opts": map[string]interface{}{"is_sensitive": false}},
+	}
+
+	testEnvironment := []envmanModels.EnvironmentItemModel{
+		envmanModels.EnvironmentItemModel{"B": "$A", "opts": map[string]interface{}{"is_sensitive": false}},
+		envmanModels.EnvironmentItemModel{"A": "$B", "opts": map[string]interface{}{"is_sensitive": false}},
+	}
+
+	// Act
+	expandedInputs := expandStepInputs(testInputs, testEnvironment)
+
+	// Assert
+	require.NotNil(t, expandedInputs)
+	require.Equal(t, "", expandedInputs["a"])
+	require.Equal(t, "", expandedInputs["b"])
+	require.Equal(t, "", expandedInputs["c"])
+	require.Equal(t, "", expandedInputs["env"])
+}
diff --git a/vendor/golang.org/x/crypto/ssh/terminal/terminal.go b/vendor/golang.org/x/crypto/ssh/terminal/terminal.go
diff --git a/vendor/golang.org/x/sys/unix/README.md b/vendor/golang.org/x/sys/unix/README.md
diff --git a/vendor/golang.org/x/sys/unix/mkerrors.sh b/vendor/golang.org/x/sys/unix/mkerrors.sh
diff --git a/vendor/golang.org/x/sys/unix/zerrors_linux.go b/vendor/golang.org/x/sys/unix/zerrors_linux.go
diff --git a/vendor/golang.org/x/sys/unix/zsysnum_linux_386.go b/vendor/golang.org/x/sys/unix/zsysnum_linux_386.go
diff --git a/vendor/golang.org/x/sys/unix/zsysnum_linux_amd64.go b/vendor/golang.org/x/sys/unix/zsysnum_linux_amd64.go