Merge pull request #7914 from jfrazelle/7802-backwards-compat-state

fixes #7802, when api version 1.11 is `json.Marshal`ing the container st...

daemon/container.go

@@ -50,7 +50,7 @@ type StreamConfig struct {
 }
 
 type Container struct {
-	*State
+	*State `json:"State"` // Needed for remote api version <= 1.11
 	root   string         // Path to the "home" of the container, including metadata.
 	basefs string         // Path to the graphdriver mountpoint
 

integration-cli/docker_api_inspect_test.go

@@ -0,0 +1,54 @@
+package main
+
+import (
+	"encoding/json"
+	"fmt"
+	"os/exec"
+	"testing"
+)
+
+func TestInspectContainerResponse(t *testing.T) {
+	runCmd := exec.Command(dockerBinary, "run", "-d", "busybox", "true")
+	out, _, err := runCommandWithOutput(runCmd)
+	errorOut(err, t, fmt.Sprintf("failed to create a container: %v %v", out, err))
+
+	cleanedContainerID := stripTrailingCharacters(out)
+
+	// test on json marshal version
+	// and latest version
+	testVersions := []string{"v1.11", "latest"}
+
+	for _, testVersion := range testVersions {
+		endpoint := "/containers/" + cleanedContainerID + "/json"
+		if testVersion != "latest" {
+			endpoint = "/" + testVersion + endpoint
+		}
+		body, err := sockRequest("GET", endpoint)
+		if err != nil {
+			t.Fatal("sockRequest failed for %s version: %v", testVersion, err)
+		}
+
+		var inspect_json map[string]interface{}
+		if err = json.Unmarshal(body, &inspect_json); err != nil {
+			t.Fatalf("unable to unmarshal body for %s version: %v", testVersion, err)
+		}
+
+		keys := []string{"State", "Created", "Path", "Args", "Config", "Image", "NetworkSettings", "ResolvConfPath", "HostnamePath", "HostsPath", "Name", "Driver", "ExecDriver", "MountLabel", "ProcessLabel", "Volumes", "VolumesRW"}
+
+		if testVersion == "v1.11" {
+			keys = append(keys, "ID")
+		} else {
+			keys = append(keys, "Id")
+		}
+
+		for _, key := range keys {
+			if _, ok := inspect_json[key]; !ok {
+				t.Fatalf("%s does not exist in reponse for %s version", key, testVersion)
+			}
+		}
+	}
+
+	deleteAllContainers()
+
+	logDone("container json - check keys in container json response")
+}

integration-cli/docker_utils.go

@@ -231,6 +231,35 @@ func (d *Daemon) Cmd(name string, arg ...string) (string, error) {
 	return string(b), err
 }
 
+func sockRequest(method, endpoint string) ([]byte, error) {
+	// FIX: the path to sock should not be hardcoded
+	sock := filepath.Join("/", "var", "run", "docker.sock")
+	c, err := net.DialTimeout("unix", sock, time.Duration(10*time.Second))
+	if err != nil {
+		return nil, fmt.Errorf("could not dial docker sock at %s: %v", sock, err)
+	}
+
+	client := httputil.NewClientConn(c, nil)
+	defer client.Close()
+
+	req, err := http.NewRequest(method, endpoint, nil)
+	req.Header.Set("Content-Type", "application/json")
+	if err != nil {
+		return nil, fmt.Errorf("could not create new request: %v", err)
+	}
+
+	resp, err := client.Do(req)
+	if err != nil {
+		return nil, fmt.Errorf("could not perform request: %v", err)
+	}
+	defer resp.Body.Close()
+	if resp.StatusCode != http.StatusOK {
+		return nil, fmt.Errorf("received status != 200 OK: %s", resp.Status)
+	}
+
+	return ioutil.ReadAll(resp.Body)
+}
+
 func deleteContainer(container string) error {
 	container = strings.Replace(container, "\n", " ", -1)
 	container = strings.Trim(container, " ")