From 9aa10cc4cd390330e30a6973f94e6d0f9c505fe7 Mon Sep 17 00:00:00 2001
From: Mahmood Ali <mahmood@hashicorp.com>
Date: Tue, 12 May 2020 11:03:08 -0400
Subject: [PATCH] use allow_runtimes for consistency

Other allow lists use allow_ prefix (e.g. allow_caps, allow_privileged).
---
 drivers/docker/config.go      | 14 +++++++-------
 drivers/docker/config_test.go |  6 +++---
 drivers/docker/driver.go      |  2 +-
 drivers/docker/driver_test.go |  8 ++++----
 4 files changed, 15 insertions(+), 15 deletions(-)

diff --git a/drivers/docker/config.go b/drivers/docker/config.go
index ed0d83e11..a8c6b0981 100644
--- a/drivers/docker/config.go
+++ b/drivers/docker/config.go
@@ -252,8 +252,8 @@ var (
 			hclspec.NewLiteral(`"nvidia"`),
 		),
 		// list of docker runtimes allowed to be used
-		"allowed_runtimes": hclspec.NewDefault(
-			hclspec.NewAttr("allowed_runtimes", "list(string)", false),
+		"allow_runtimes": hclspec.NewDefault(
+			hclspec.NewAttr("allow_runtimes", "list(string)", false),
 			hclspec.NewLiteral(`["runc", "nvidia"]`),
 		),
 		// image to use when creating a network namespace parent container
@@ -579,8 +579,8 @@ type DriverConfig struct {
 	PullActivityTimeout         string        `codec:"pull_activity_timeout"`
 	pullActivityTimeoutDuration time.Duration `codec:"-"`
 
-	AllowedRuntimesList []string            `codec:"allowed_runtimes"`
-	allowedRuntimes     map[string]struct{} `codec:"-"`
+	AllowRuntimesList []string            `codec:"allow_runtimes"`
+	allowRuntimes     map[string]struct{} `codec:"-"`
 }
 
 type AuthConfig struct {
@@ -666,9 +666,9 @@ func (d *Driver) SetConfig(c *base.Config) error {
 		d.config.pullActivityTimeoutDuration = dur
 	}
 
-	d.config.allowedRuntimes = make(map[string]struct{}, len(d.config.AllowedRuntimesList))
-	for _, r := range d.config.AllowedRuntimesList {
-		d.config.allowedRuntimes[r] = struct{}{}
+	d.config.allowRuntimes = make(map[string]struct{}, len(d.config.AllowRuntimesList))
+	for _, r := range d.config.AllowRuntimesList {
+		d.config.allowRuntimes[r] = struct{}{}
 	}
 
 	if c.AgentConfig != nil {
diff --git a/drivers/docker/config_test.go b/drivers/docker/config_test.go
index 34260c796..e1438fa9a 100644
--- a/drivers/docker/config_test.go
+++ b/drivers/docker/config_test.go
@@ -554,7 +554,7 @@ func TestConfig_DriverConfig_PullActivityTimeout(t *testing.T) {
 	}
 }
 
-func TestConfig_DriverConfig_AllowedRuntimes(t *testing.T) {
+func TestConfig_DriverConfig_AllowRuntimes(t *testing.T) {
 	cases := []struct {
 		name     string
 		config   string
@@ -567,7 +567,7 @@ func TestConfig_DriverConfig_AllowedRuntimes(t *testing.T) {
 		},
 		{
 			name:     "custom",
-			config:   `{ allowed_runtimes = ["runc", "firecracker"]}`,
+			config:   `{ allow_runtimes = ["runc", "firecracker"]}`,
 			expected: map[string]struct{}{"runc": struct{}{}, "firecracker": struct{}{}},
 		},
 	}
@@ -579,7 +579,7 @@ func TestConfig_DriverConfig_AllowedRuntimes(t *testing.T) {
 
 			dh := dockerDriverHarness(t, tc)
 			d := dh.Impl().(*Driver)
-			require.Equal(t, c.expected, d.config.allowedRuntimes)
+			require.Equal(t, c.expected, d.config.allowRuntimes)
 		})
 	}
 
diff --git a/drivers/docker/driver.go b/drivers/docker/driver.go
index 6ce1d323b..c6818eedb 100644
--- a/drivers/docker/driver.go
+++ b/drivers/docker/driver.go
@@ -749,7 +749,7 @@ func (d *Driver) createContainerConfig(task *drivers.TaskConfig, driverConfig *T
 		}
 		containerRuntime = d.config.GPURuntimeName
 	}
-	if _, ok := d.config.allowedRuntimes[containerRuntime]; !ok && containerRuntime != "" {
+	if _, ok := d.config.allowRuntimes[containerRuntime]; !ok && containerRuntime != "" {
 		return c, fmt.Errorf("requested runtime %q is not allowed", containerRuntime)
 	}
 
diff --git a/drivers/docker/driver_test.go b/drivers/docker/driver_test.go
index c5920a633..5ccd44057 100644
--- a/drivers/docker/driver_test.go
+++ b/drivers/docker/driver_test.go
@@ -1101,18 +1101,18 @@ func TestDockerDriver_CreateContainerConfig_RuntimeConflict(t *testing.T) {
 	require.Contains(t, err.Error(), "conflicting runtime requests")
 }
 
-func TestDockerDriver_CreateContainerConfig_ChecksAllowedRuntimes(t *testing.T) {
+func TestDockerDriver_CreateContainerConfig_ChecksAllowRuntimes(t *testing.T) {
 	t.Parallel()
 
 	dh := dockerDriverHarness(t, nil)
 	driver := dh.Impl().(*Driver)
 	driver.gpuRuntime = true
-	driver.config.allowedRuntimes = map[string]struct{}{
+	driver.config.allowRuntimes = map[string]struct{}{
 		"runc":   struct{}{},
 		"custom": struct{}{},
 	}
 
-	allowedRuntime := []string{
+	allowRuntime := []string{
 		"", // default always works
 		"runc",
 		"custom",
@@ -1122,7 +1122,7 @@ func TestDockerDriver_CreateContainerConfig_ChecksAllowedRuntimes(t *testing.T)
 	defer freeport.Return(ports)
 	require.NoError(t, task.EncodeConcreteDriverConfig(cfg))
 
-	for _, runtime := range allowedRuntime {
+	for _, runtime := range allowRuntime {
 		t.Run(runtime, func(t *testing.T) {
 			cfg.Runtime = runtime
 			c, err := driver.createContainerConfig(task, cfg, "org/repo:0.1")