Refactor Metadata EnvVars and UnboundEnvVars on metadataTest (#314)

Author: bananaappletw

README.md

@@ -212,9 +212,9 @@ of these checks are optional.
 
 #### Supported Fields:
 
-- Env (`[]EnvVar`): A list of environment variable key/value pairs that should be set
+- EnvVars (`[]EnvVar`): A list of environment variable key/value pairs that should be set
 in the container. isRegex (*optional*) interpretes the value as regex.
-- UnboundEnv (`[]EnvVar`): A list of environment variable keys that should **NOT** be set
+- UnboundEnvVars (`[]EnvVar`): A list of environment variable keys that should **NOT** be set
 in the container.
 - Labels (`[]Label`): A list of image labels key/value pairs that should be set on the
 container. isRegex (*optional*) interpretes the value as regex.

pkg/types/v2/metadata.go

@@ -23,8 +23,8 @@ import (
 )
 
 type MetadataTest struct {
-	Env              []types.EnvVar `yaml:"env"`
-	UnboundEnv       []types.EnvVar `yaml:"unboundEnv"`
+	EnvVars          []types.EnvVar `yaml:"envVars"`
+	UnboundEnvVars   []types.EnvVar `yaml:"unboundEnvVars"`
 	ExposedPorts     []string       `yaml:"exposedPorts"`
 	UnexposedPorts   []string       `yaml:"unexposedPorts"`
 	Entrypoint       *[]string      `yaml:"entrypoint"`
@@ -37,8 +37,8 @@ type MetadataTest struct {
 }
 
 func (mt MetadataTest) IsEmpty() bool {
-	return len(mt.Env) == 0 &&
-		len(mt.UnboundEnv) == 0 &&
+	return len(mt.EnvVars) == 0 &&
+		len(mt.UnboundEnvVars) == 0 &&
 		len(mt.ExposedPorts) == 0 &&
 		len(mt.UnexposedPorts) == 0 &&
 		mt.Entrypoint == nil &&
@@ -58,7 +58,7 @@ func (mt MetadataTest) Validate(channel chan interface{}) bool {
 	res := &types.TestResult{
 		Name: mt.LogName(),
 	}
-	for _, envVar := range mt.Env {
+	for _, envVar := range mt.EnvVars {
 		if envVar.Key == "" {
 			res.Error("Environment variable key cannot be empty")
 		}
@@ -98,7 +98,7 @@ func (mt MetadataTest) Run(driver drivers.Driver) *types.TestResult {
 		return result
 	}
 
-	for _, pair := range mt.Env {
+	for _, pair := range mt.EnvVars {
 		if val, ok := imageConfig.Env[pair.Key]; ok {
 			var match bool
 			if pair.IsRegex {
@@ -116,7 +116,7 @@ func (mt MetadataTest) Run(driver drivers.Driver) *types.TestResult {
 		}
 	}
 
-	for _, pair := range mt.UnboundEnv {
+	for _, pair := range mt.UnboundEnvVars {
 		if _, ok := imageConfig.Env[pair.Key]; ok {
 			result.Errorf("env variable %s should not be present in image metadata", pair.Key)
 			result.Fail()

tests/amd64/ubuntu_20_04_metadata_test.yaml

@@ -1,6 +1,6 @@
 schemaVersion: '2.0.0' # Make sure to test the latest schema version
 metadataTest:
-  env:
+  envVars:
   - key: 'SOME_KEY'
     value: 'SOME_VAL'
   - key: 'EMPTY_VAR'
@@ -10,7 +10,7 @@ metadataTest:
   - key: 'REGEX_VAR'
     value: '[a-z]+-2\.1\.*'
     isRegex: true
-  unboundEnv:
+  unboundEnvVars:
   - key: 'BAR_FOO'
   labels:
   - key: 'localnet.localdomain.commit_hash'

tests/arm64/ubuntu_20_04_metadata_test.yaml

@@ -1,6 +1,6 @@
 schemaVersion: '2.0.0' # Make sure to test the latest schema version
 metadataTest:
-  env:
+  envVars:
   - key: 'SOME_KEY'
     value: 'SOME_VAL'
   - key: 'EMPTY_VAR'
@@ -10,7 +10,7 @@ metadataTest:
   - key: 'REGEX_VAR'
     value: '[a-z]+-2\.1\.*'
     isRegex: true
-  unboundEnv:
+  unboundEnvVars:
   - key: 'BAR_FOO'
   labels:
   - key: 'localnet.localdomain.commit_hash'

tests/ppc64le/ubuntu_20_04_metadata_test.yaml

@@ -1,6 +1,6 @@
 schemaVersion: '2.0.0' # Make sure to test the latest schema version
 metadataTest:
-  env:
+  envVars:
   - key: 'SOME_KEY'
     value: 'SOME_VAL'
   - key: 'EMPTY_VAR'
@@ -10,7 +10,7 @@ metadataTest:
   - key: 'REGEX_VAR'
     value: '[a-z]+-2\.1\.*'
     isRegex: true
-  unboundEnv:
+  unboundEnvVars:
   - key: 'BAR_FOO'
   labels:
   - key: 'localnet.localdomain.commit_hash'

tests/s390x/ubuntu_20_04_metadata_test.yaml

@@ -1,6 +1,6 @@
 schemaVersion: '2.0.0' # Make sure to test the latest schema version
 metadataTest:
-  env:
+  envVars:
   - key: 'SOME_KEY'
     value: 'SOME_VAL'
   - key: 'EMPTY_VAR'
@@ -10,7 +10,7 @@ metadataTest:
   - key: 'REGEX_VAR'
     value: '[a-z]+-2\.1\.*'
     isRegex: true
-  unboundEnv:
+  unboundEnvVars:
   - key: 'BAR_FOO'
   labels:
   - key: 'localnet.localdomain.commit_hash'