json: Add backward compatibility with VfkitMagic

The previous commits added a VfkitMagic property which for now defaults
to true for backwards compatibility with older gvproxy versions.
However, this default was not used when unmarshalling a json vm
configuration made with an older vfkit version. This could cause
unexpected issues with networking.

This commit sets VfkitMagic to true by default when unmarshalling json.

Signed-off-by: Christophe Fergeau <[email protected]>

Author: cfergeau

pkg/config/json.go

@@ -110,6 +110,9 @@ func unmarshalIgnition(rawMsg json.RawMessage) (Ignition, error) {
 func unmarshalVirtioNet(rawMsg json.RawMessage) (*VirtioNet, error) {
 	var dev virtioNetForMarshalling
 
+	// defaults to true for backwards compatibility with vfkit versions which did not have this field
+	dev.VfkitMagic = true
+
 	err := json.Unmarshal(rawMsg, &dev)
 	if err != nil {
 		return nil, err
@@ -121,6 +124,10 @@ func unmarshalVirtioNet(rawMsg json.RawMessage) (*VirtioNet, error) {
 		}
 		dev.VirtioNet.MacAddress = macAddr
 	}
+	// vfkitMagic is only useful in combination with unixSocketPath
+	if dev.UnixSocketPath == "" {
+		dev.VfkitMagic = false
+	}
 	return &dev.VirtioNet, nil
 }
 

pkg/config/json_test.go

@@ -330,6 +330,44 @@ type jsonStabilityTest struct {
 	expectedJSON  string
 }
 
+func testVirtioNetVfkitMagicJson(t *testing.T, vfkitMagic bool) {
+	jsonTemplate := `{"vcpus":3,"memoryBytes":4194304000,"bootloader":{"kind":"linuxBootloader","vmlinuzPath":"/vmlinuz","initrdPath":"/initrd","kernelCmdLine":"console=hvc0"},"devices":[{"kind":"virtionet","nat":false,"unixSocketPath":"/some/path/to/socket","macAddress":"00:11:22:33:44:55"%s}]}`
+	var jsonStr string
+	var unmarshalledVM VirtualMachine
+
+	if vfkitMagic {
+		jsonStr = fmt.Sprintf(jsonTemplate, ``)
+	} else {
+		jsonStr = fmt.Sprintf(jsonTemplate, `,"vfkitMagic":false`)
+	}
+	err := json.Unmarshal([]byte(jsonStr), &unmarshalledVM)
+	require.NoError(t, err)
+	netDevs := unmarshalledVM.VirtioNetDevices()
+	require.Len(t, netDevs, 1)
+	require.Equal(t, netDevs[0].VfkitMagic, vfkitMagic)
+
+	vm := newLinuxVM(t)
+	dev, err := VirtioNetNew("00:11:22:33:44:55")
+	require.NoError(t, err)
+	dev.SetUnixSocketPath("/some/path/to/socket")
+	if !vfkitMagic {
+		dev.VfkitMagic = false
+	}
+	err = vm.AddDevice(dev)
+	require.NoError(t, err)
+	require.Equal(t, dev.VfkitMagic, vfkitMagic)
+
+	require.Equal(t, *vm, unmarshalledVM)
+}
+
+func TestVirtioNetBackwardsCompat(t *testing.T) {
+	/* Check that the vfkitMagic default is true when deserializing json */
+	t.Run("VfkitMagicJsonDefault", func(t *testing.T) { testVirtioNetVfkitMagicJson(t, true) })
+
+	/* Check that the vfkitMagic default can be overridden */
+	t.Run("VfkitMagicJsonDefaultOverride", func(t *testing.T) { testVirtioNetVfkitMagicJson(t, false) })
+}
+
 func TestJSON(t *testing.T) {
 	t.Run("json", func(t *testing.T) {
 		for name := range jsonTests {