[#1587] Verify the envvars

backend/appcfg/stork/cli.go

@@ -130,6 +130,11 @@ func (p *CLIParser) bootstrap() (*HookDirectorySettings, GroupedHookCLIFlags, er
 	}
 	p.substitutePlaceholdersInGroup(group)
 
+	err = p.verifyEnvironmentFile(envFileSettings)
+	if err != nil {
+		return nil, nil, err
+	}
+
 	return hookDirectorySettings, allHookCLIFlags, nil
 }
 
@@ -256,6 +261,41 @@ func (p *CLIParser) loadEnvironmentFile(envFileSettings *environmentFileSettings
 	return nil
 }
 
+// Verifies if all environment variables in the environment file are known.
+// Returns an error if any of the environment variables is unknown.
+func (p *CLIParser) verifyEnvironmentFile(envFileSettings *environmentFileSettings) error {
+	if !envFileSettings.UseEnvFile {
+		// Nothing to do.
+		return nil
+	}
+
+	// Load the environment file content.
+	entries, err := storkutil.LoadEnvironmentFile(envFileSettings.EnvFile)
+	if err != nil {
+		err = errors.WithMessagef(err, "invalid environment file: '%s'", envFileSettings.EnvFile)
+		return err
+	}
+
+	// Collect all known environment variables.
+	knownEnvironmentVariables := make(map[string]bool)
+	for _, group := range p.parser.Groups() {
+		for _, option := range group.Options() {
+			knownEnvironmentVariables[option.EnvKeyWithNamespace()] = true
+		}
+	}
+
+	// Check if all environment variables are known.
+	var errs []error
+	for _, entry := range entries {
+		if _, exist := knownEnvironmentVariables[entry.GetKey()]; !exist {
+			err = errors.Errorf("unknown environment variable: '%s'", entry.GetKey())
+			errs = append(errs, err)
+		}
+	}
+
+	return storkutil.CombineErrors("the environment file contains unknown environment variables", errs)
+}
+
 // Extracts the CLI flags from the hooks.
 func (p *CLIParser) collectHookCLIFlags(hookDirectorySettings *HookDirectorySettings) (map[string]hooks.HookSettings, error) {
 	allCLIFlags := map[string]hooks.HookSettings{}

backend/util/envfile.go

@@ -10,9 +10,16 @@ import (
 )
 
 // Stores key-value of the environment variable.
-type keyValuePair struct {
-	key   string
-	value string
+type KeyValuePair [2]string
+
+// Returns the key of the key-value pair.
+func (p KeyValuePair) GetKey() string {
+	return p[0]
+}
+
+// Returns the value of the key-value pair.
+func (p KeyValuePair) GetValue() string {
+	return p[1]
 }
 
 // Defines an interface that accepts the environment variables.
@@ -37,20 +44,20 @@ func (s *processEnvironmentVariableSetter) Set(key, value string) error {
 
 // Loads all entries from the environment file into one or multiple setters.
 func LoadEnvironmentFileToSetter(path string, setters ...EnvironmentVariableSetter) error {
-	data, err := loadEnvironmentFile(path)
+	data, err := LoadEnvironmentFile(path)
 	if err != nil {
 		return err
 	}
 
 	for _, pair := range data {
 		for _, setter := range setters {
-			err = setter.Set(pair.key, pair.value)
+			err = setter.Set(pair.GetKey(), pair.GetValue())
 			if err != nil {
 				err = errors.WithMessagef(
 					err,
 					"cannot set '%s=%s' environment variable",
-					pair.key,
-					pair.value,
+					pair.GetKey(),
+					pair.GetValue(),
 				)
 				return err
 			}
@@ -61,7 +68,7 @@ func LoadEnvironmentFileToSetter(path string, setters ...EnvironmentVariableSett
 }
 
 // Loads all entries from the environment file.
-func loadEnvironmentFile(path string) ([]*keyValuePair, error) {
+func LoadEnvironmentFile(path string) ([]KeyValuePair, error) {
 	file, err := os.Open(path)
 	if err != nil {
 		return nil, errors.Wrapf(err, "cannot open the '%s' environment file", path)
@@ -71,9 +78,8 @@ func loadEnvironmentFile(path string) ([]*keyValuePair, error) {
 }
 
 // Loads all entries from a given reader.
-func loadEnvironmentEntries(reader io.Reader) ([]*keyValuePair, error) {
-	data := []*keyValuePair{}
-	dataIndex := map[string]*keyValuePair{}
+func loadEnvironmentEntries(reader io.Reader) ([]KeyValuePair, error) {
+	dataIndex := map[string]string{}
 	scanner := bufio.NewScanner(reader)
 
 	lineIdx := 0
@@ -88,15 +94,20 @@ func loadEnvironmentEntries(reader io.Reader) ([]*keyValuePair, error) {
 			continue
 		}
 
-		if pair, ok := dataIndex[key]; ok {
-			pair.value = value
+		if _, ok := dataIndex[key]; ok {
+			// Duplicate key. Use the latest value.
+			dataIndex[key] = value
 		} else {
-			pair := &keyValuePair{key, value}
-			data = append(data, pair)
-			dataIndex[key] = pair
+			// New key.
+			dataIndex[key] = value
 		}
 	}
 
+	var data []KeyValuePair
+	for key, value := range dataIndex {
+		data = append(data, [2]string{key, value})
+	}
+
 	return data, nil
 }
 

backend/util/envfile_test.go

@@ -16,7 +16,7 @@ func TestLoadMissingEnvironmentFile(t *testing.T) {
 	// Arrange & Act
 	sb := testutil.NewSandbox()
 	defer sb.Close()
-	data, err := loadEnvironmentFile(path.Join(sb.BasePath, "not-exists.env"))
+	data, err := LoadEnvironmentFile(path.Join(sb.BasePath, "not-exists.env"))
 
 	// Assert
 	require.Error(t, err)
@@ -34,8 +34,8 @@ func TestLoadSingleLineEnvironmentContent(t *testing.T) {
 	// Assert
 	require.NoError(t, err)
 	require.Len(t, data, 1)
-	require.EqualValues(t, "TEST_STORK_KEY", data[0].key)
-	require.EqualValues(t, "VALUE", data[0].value)
+	require.EqualValues(t, "TEST_STORK_KEY", data[0].GetKey())
+	require.EqualValues(t, "VALUE", data[0].GetValue())
 }
 
 // Test that the multi-line environment file content is loaded properly.
@@ -51,12 +51,12 @@ func TestLoadMultiLineEnvironmentContent(t *testing.T) {
 	// Assert
 	require.NoError(t, err)
 	require.Len(t, data, 3)
-	require.EqualValues(t, "TEST_STORK_KEY1", data[0].key)
-	require.EqualValues(t, "VALUE1", data[0].value)
-	require.EqualValues(t, "TEST_STORK_KEY2", data[1].key)
-	require.EqualValues(t, "VALUE2", data[1].value)
-	require.EqualValues(t, "TEST_STORK_KEY3", data[2].key)
-	require.EqualValues(t, "VALUE3", data[2].value)
+	require.EqualValues(t, "TEST_STORK_KEY1", data[0].GetKey())
+	require.EqualValues(t, "VALUE1", data[0].GetValue())
+	require.EqualValues(t, "TEST_STORK_KEY2", data[1].GetKey())
+	require.EqualValues(t, "VALUE2", data[1].GetValue())
+	require.EqualValues(t, "TEST_STORK_KEY3", data[2].GetKey())
+	require.EqualValues(t, "VALUE3", data[2].GetValue())
 }
 
 // Test that the duplicates in the content are overwritten properly.
@@ -72,8 +72,8 @@ func TestLoadEnvironmentContentWithDuplicates(t *testing.T) {
 	// Assert
 	require.NoError(t, err)
 	require.Len(t, data, 1)
-	require.EqualValues(t, "TEST_STORK_KEY1", data[0].key)
-	require.EqualValues(t, "VALUE3", data[0].value)
+	require.EqualValues(t, "TEST_STORK_KEY1", data[0].GetKey())
+	require.EqualValues(t, "VALUE3", data[0].GetValue())
 }
 
 // Test that the empty value in the environment file content is loaded properly.
@@ -87,8 +87,8 @@ func TestLoadEnvironmentContentWithEmptyValue(t *testing.T) {
 	// Assert
 	require.Len(t, data, 1)
 	require.NoError(t, err)
-	require.EqualValues(t, "TEST_STORK_KEY", data[0].key)
-	require.EqualValues(t, "", data[0].value)
+	require.EqualValues(t, "TEST_STORK_KEY", data[0].GetKey())
+	require.EqualValues(t, "", data[0].GetValue())
 }
 
 // Test that the missing value separator in the environment file content
@@ -146,8 +146,8 @@ func TestLoadEnvironmentContentWithComments(t *testing.T) {
 	// Assert
 	require.NoError(t, err)
 	require.Len(t, data, 1)
-	require.EqualValues(t, "TEST_STORK_KEY2", data[0].key)
-	require.EqualValues(t, "VALUE2", data[0].value)
+	require.EqualValues(t, "TEST_STORK_KEY2", data[0].GetKey())
+	require.EqualValues(t, "VALUE2", data[0].GetValue())
 }
 
 // Test that the empty lines are skipped.
@@ -162,10 +162,10 @@ func TestLoadEnvironmentContentWithEmptyLine(t *testing.T) {
 
 	// Assert
 	require.NoError(t, err)
-	require.EqualValues(t, "TEST_STORK_KEY1", data[0].key)
-	require.EqualValues(t, "VALUE1", data[0].value)
-	require.EqualValues(t, "TEST_STORK_KEY2", data[1].key)
-	require.EqualValues(t, "VALUE2", data[1].value)
+	require.EqualValues(t, "TEST_STORK_KEY1", data[0].GetKey())
+	require.EqualValues(t, "VALUE1", data[0].GetValue())
+	require.EqualValues(t, "TEST_STORK_KEY2", data[1].GetKey())
+	require.EqualValues(t, "VALUE2", data[1].GetValue())
 	require.Len(t, data, 2)
 }
 
@@ -182,8 +182,8 @@ func TestLoadEnvironmentContentWithTrailingCharacters(t *testing.T) {
 	// Assert
 	require.NoError(t, err)
 	require.Len(t, data, 1)
-	require.EqualValues(t, "TEST_STORK_KEY2", data[0].key)
-	require.EqualValues(t, "VALUE2", data[0].value)
+	require.EqualValues(t, "TEST_STORK_KEY2", data[0].GetKey())
+	require.EqualValues(t, "VALUE2", data[0].GetValue())
 }
 
 type setterMock struct {