docker: add default blocks for driver plugin config schema

hashicorp · Nov 20, 2018 · fab76c6 · fab76c6
1 parent 249dbff
commit fab76c6
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 13 deletions.
diff --git a/drivers/docker/config.go b/drivers/docker/config.go
@@ -151,16 +151,24 @@ var (
 	//	}
 	configSpec = hclspec.NewObject(map[string]*hclspec.Spec{
 		"endpoint": hclspec.NewAttr("endpoint", "string", false),
+
+		// docker daemon auth option for image registry
 		"auth": hclspec.NewBlock("auth", false, hclspec.NewObject(map[string]*hclspec.Spec{
 			"config": hclspec.NewAttr("config", "string", false),
 			"helper": hclspec.NewAttr("helper", "string", false),
 		})),
+
+		// client tls options
 		"tls": hclspec.NewBlock("tls", false, hclspec.NewObject(map[string]*hclspec.Spec{
 			"cert": hclspec.NewAttr("cert", "string", false),
 			"key":  hclspec.NewAttr("key", "string", false),
 			"ca":   hclspec.NewAttr("ca", "string", false),
 		})),
-		"gc": hclspec.NewBlock("gc", false, hclspec.NewObject(map[string]*hclspec.Spec{
+
+		// garbage collection options
+		// default needed for both if the gc {...} block is not set and
+		// if the default fields are missing
+		"gc": hclspec.NewDefault(hclspec.NewBlock("gc", false, hclspec.NewObject(map[string]*hclspec.Spec{
 			"image": hclspec.NewDefault(
 				hclspec.NewAttr("image", "bool", false),
 				hclspec.NewLiteral("true"),
@@ -170,14 +178,21 @@ var (
 				hclspec.NewAttr("container", "bool", false),
 				hclspec.NewLiteral("true"),
 			),
-		})),
-		"volumes": hclspec.NewBlock("volumes", false, hclspec.NewObject(map[string]*hclspec.Spec{
+		})), hclspec.NewLiteral(`{
+			image = true
+			container = true
+		}`)),
+
+		// docker volume options
+		// defaulted needed for both if the volumes {...} block is not set and
+		// if the default fields are missing
+		"volumes": hclspec.NewDefault(hclspec.NewBlock("volumes", false, hclspec.NewObject(map[string]*hclspec.Spec{
 			"enabled": hclspec.NewDefault(
 				hclspec.NewAttr("enabled", "bool", false),
 				hclspec.NewLiteral("true"),
 			),
 			"selinuxlabel": hclspec.NewAttr("selinuxlabel", "string", false),
-		})),
+		})), hclspec.NewLiteral("{ enabled = true }")),
 		"allow_privileged": hclspec.NewAttr("allow_privileged", "bool", false),
 		"allow_caps": hclspec.NewDefault(
 			hclspec.NewAttr("allow_caps", "list(string)", false),

diff --git a/drivers/docker/driver_test.go b/drivers/docker/driver_test.go
@@ -139,7 +139,9 @@ func dockerDriverHarness(t *testing.T, cfg map[string]interface{}) *drivers.Driv
 	harness := drivers.NewDriverHarness(t, NewDockerDriver(logger))
 	if cfg == nil {
 		cfg = map[string]interface{}{
-			"image_gc_delay": "1s",
+			"gc": map[string]interface{}{
+				"image_delay": "1s",
+			},
 		}
 	}
 	plugLoader, err := loader.NewPluginLoader(&loader.PluginLoaderConfig{
@@ -1546,8 +1548,12 @@ func TestDockerDriver_VolumesDisabled(t *testing.T) {
 	}
 
 	cfg := map[string]interface{}{
-		"volumes_enabled": false,
-		"image_gc":        false,
+		"volumes": map[string]interface{}{
+			"enabled": false,
+		},
+		"gc": map[string]interface{}{
+			"image": false,
+		},
 	}
 
 	{
@@ -1710,9 +1716,6 @@ func TestDockerDriver_Mounts(t *testing.T) {
 
 // TestDockerDriver_Cleanup ensures Cleanup removes only downloaded images.
 func TestDockerDriver_Cleanup(t *testing.T) {
-	if !tu.IsTravis() {
-		t.Parallel()
-	}
 	if !testutil.DockerIsConnected(t) {
 		t.Skip("Docker not connected")
 	}

diff --git a/drivers/docker/driver_unix_test.go b/drivers/docker/driver_unix_test.go
@@ -57,7 +57,7 @@ done
 	handle, ok := driver.Impl().(*Driver).tasks.Get(task.ID)
 	require.True(t, ok)
 
-	waitForExist(t, newTestDockerClient(t), handle.container.ID)
+	waitForExist(t, newTestDockerClient(t), handle.containerID)
 	require.NoError(t, handle.Kill(time.Duration(tu.TestMultiplier()*5)*time.Second, os.Interrupt))
 
 	waitCh, err := driver.WaitTask(context.Background(), task.ID)

diff --git a/drivers/shared/eventer/eventer_test.go b/drivers/shared/eventer/eventer_test.go
@@ -15,7 +15,8 @@ func TestEventer(t *testing.T) {
 	t.Parallel()
 	require := require.New(t)
 
-	ctx, _ := context.WithCancel(context.Background())
+	ctx, cancel := context.WithCancel(context.Background())
+	defer cancel()
 	e := NewEventer(ctx, testlog.HCLogger(t))
 
 	events := []*drivers.TaskEvent{
@@ -33,7 +34,8 @@ func TestEventer(t *testing.T) {
 		},
 	}
 
-	ctx1, _ := context.WithCancel(context.Background())
+	ctx1, cancel1 := context.WithCancel(context.Background())
+	defer cancel1()
 	consumer1, err := e.TaskEvents(ctx1)
 	require.NoError(err)
 	ctx2 := (context.Background())