Add FFJSON encoding/decoding for our container structs

Signed-off-by: Matthew Heon <matthew.heon@gmail.com>

Closes: #323
Approved by: mheon

libpod/container.go

@@ -88,6 +88,7 @@ func (ns LinuxNS) String() string {
 }
 
 // Container is a single OCI container
+// ffjson: skip
 type Container struct {
 	config *ContainerConfig
 

libpod/pod.go

@@ -10,6 +10,7 @@ import (
 )
 
 // Pod represents a group of containers that may share namespaces
+// ffjson: skip
 type Pod struct {
 	config *PodConfig
 

libpod/pod_ffjson.go

@@ -0,0 +1,392 @@
+// Code generated by ffjson <https://github.com/pquerna/ffjson>. DO NOT EDIT.
+// source: libpod/pod.go
+
+package libpod
+
+import (
+	"bytes"
+	"fmt"
+	fflib "github.com/pquerna/ffjson/fflib/v1"
+)
+
+// MarshalJSON marshal bytes to json - template
+func (j *PodConfig) MarshalJSON() ([]byte, error) {
+	var buf fflib.Buffer
+	if j == nil {
+		buf.WriteString("null")
+		return buf.Bytes(), nil
+	}
+	err := j.MarshalJSONBuf(&buf)
+	if err != nil {
+		return nil, err
+	}
+	return buf.Bytes(), nil
+}
+
+// MarshalJSONBuf marshal buff to json - template
+func (j *PodConfig) MarshalJSONBuf(buf fflib.EncodingBuffer) error {
+	if j == nil {
+		buf.WriteString("null")
+		return nil
+	}
+	var err error
+	var obj []byte
+	_ = obj
+	_ = err
+	buf.WriteString(`{"id":`)
+	fflib.WriteJsonString(buf, string(j.ID))
+	buf.WriteString(`,"name":`)
+	fflib.WriteJsonString(buf, string(j.Name))
+	if j.Labels == nil {
+		buf.WriteString(`,"Labels":null`)
+	} else {
+		buf.WriteString(`,"Labels":{ `)
+		for key, value := range j.Labels {
+			fflib.WriteJsonString(buf, key)
+			buf.WriteString(`:`)
+			fflib.WriteJsonString(buf, string(value))
+			buf.WriteByte(',')
+		}
+		buf.Rewind(1)
+		buf.WriteByte('}')
+	}
+	buf.WriteByte('}')
+	return nil
+}
+
+const (
+	ffjtPodConfigbase = iota
+	ffjtPodConfignosuchkey
+
+	ffjtPodConfigID
+
+	ffjtPodConfigName
+
+	ffjtPodConfigLabels
+)
+
+var ffjKeyPodConfigID = []byte("id")
+
+var ffjKeyPodConfigName = []byte("name")
+
+var ffjKeyPodConfigLabels = []byte("Labels")
+
+// UnmarshalJSON umarshall json - template of ffjson
+func (j *PodConfig) UnmarshalJSON(input []byte) error {
+	fs := fflib.NewFFLexer(input)
+	return j.UnmarshalJSONFFLexer(fs, fflib.FFParse_map_start)
+}
+
+// UnmarshalJSONFFLexer fast json unmarshall - template ffjson
+func (j *PodConfig) UnmarshalJSONFFLexer(fs *fflib.FFLexer, state fflib.FFParseState) error {
+	var err error
+	currentKey := ffjtPodConfigbase
+	_ = currentKey
+	tok := fflib.FFTok_init
+	wantedTok := fflib.FFTok_init
+
+mainparse:
+	for {
+		tok = fs.Scan()
+		//	println(fmt.Sprintf("debug: tok: %v  state: %v", tok, state))
+		if tok == fflib.FFTok_error {
+			goto tokerror
+		}
+
+		switch state {
+
+		case fflib.FFParse_map_start:
+			if tok != fflib.FFTok_left_bracket {
+				wantedTok = fflib.FFTok_left_bracket
+				goto wrongtokenerror
+			}
+			state = fflib.FFParse_want_key
+			continue
+
+		case fflib.FFParse_after_value:
+			if tok == fflib.FFTok_comma {
+				state = fflib.FFParse_want_key
+			} else if tok == fflib.FFTok_right_bracket {
+				goto done
+			} else {
+				wantedTok = fflib.FFTok_comma
+				goto wrongtokenerror
+			}
+
+		case fflib.FFParse_want_key:
+			// json {} ended. goto exit. woo.
+			if tok == fflib.FFTok_right_bracket {
+				goto done
+			}
+			if tok != fflib.FFTok_string {
+				wantedTok = fflib.FFTok_string
+				goto wrongtokenerror
+			}
+
+			kn := fs.Output.Bytes()
+			if len(kn) <= 0 {
+				// "" case. hrm.
+				currentKey = ffjtPodConfignosuchkey
+				state = fflib.FFParse_want_colon
+				goto mainparse
+			} else {
+				switch kn[0] {
+
+				case 'L':
+
+					if bytes.Equal(ffjKeyPodConfigLabels, kn) {
+						currentKey = ffjtPodConfigLabels
+						state = fflib.FFParse_want_colon
+						goto mainparse
+					}
+
+				case 'i':
+
+					if bytes.Equal(ffjKeyPodConfigID, kn) {
+						currentKey = ffjtPodConfigID
+						state = fflib.FFParse_want_colon
+						goto mainparse
+					}
+
+				case 'n':
+
+					if bytes.Equal(ffjKeyPodConfigName, kn) {
+						currentKey = ffjtPodConfigName
+						state = fflib.FFParse_want_colon
+						goto mainparse
+					}
+
+				}
+
+				if fflib.EqualFoldRight(ffjKeyPodConfigLabels, kn) {
+					currentKey = ffjtPodConfigLabels
+					state = fflib.FFParse_want_colon
+					goto mainparse
+				}
+
+				if fflib.SimpleLetterEqualFold(ffjKeyPodConfigName, kn) {
+					currentKey = ffjtPodConfigName
+					state = fflib.FFParse_want_colon
+					goto mainparse
+				}
+
+				if fflib.SimpleLetterEqualFold(ffjKeyPodConfigID, kn) {
+					currentKey = ffjtPodConfigID
+					state = fflib.FFParse_want_colon
+					goto mainparse
+				}
+
+				currentKey = ffjtPodConfignosuchkey
+				state = fflib.FFParse_want_colon
+				goto mainparse
+			}
+
+		case fflib.FFParse_want_colon:
+			if tok != fflib.FFTok_colon {
+				wantedTok = fflib.FFTok_colon
+				goto wrongtokenerror
+			}
+			state = fflib.FFParse_want_value
+			continue
+		case fflib.FFParse_want_value:
+
+			if tok == fflib.FFTok_left_brace || tok == fflib.FFTok_left_bracket || tok == fflib.FFTok_integer || tok == fflib.FFTok_double || tok == fflib.FFTok_string || tok == fflib.FFTok_bool || tok == fflib.FFTok_null {
+				switch currentKey {
+
+				case ffjtPodConfigID:
+					goto handle_ID
+
+				case ffjtPodConfigName:
+					goto handle_Name
+
+				case ffjtPodConfigLabels:
+					goto handle_Labels
+
+				case ffjtPodConfignosuchkey:
+					err = fs.SkipField(tok)
+					if err != nil {
+						return fs.WrapErr(err)
+					}
+					state = fflib.FFParse_after_value
+					goto mainparse
+				}
+			} else {
+				goto wantedvalue
+			}
+		}
+	}
+
+handle_ID:
+
+	/* handler: j.ID type=string kind=string quoted=false*/
+
+	{
+
+		{
+			if tok != fflib.FFTok_string && tok != fflib.FFTok_null {
+				return fs.WrapErr(fmt.Errorf("cannot unmarshal %s into Go value for string", tok))
+			}
+		}
+
+		if tok == fflib.FFTok_null {
+
+		} else {
+
+			outBuf := fs.Output.Bytes()
+
+			j.ID = string(string(outBuf))
+
+		}
+	}
+
+	state = fflib.FFParse_after_value
+	goto mainparse
+
+handle_Name:
+
+	/* handler: j.Name type=string kind=string quoted=false*/
+
+	{
+
+		{
+			if tok != fflib.FFTok_string && tok != fflib.FFTok_null {
+				return fs.WrapErr(fmt.Errorf("cannot unmarshal %s into Go value for string", tok))
+			}
+		}
+
+		if tok == fflib.FFTok_null {
+
+		} else {
+
+			outBuf := fs.Output.Bytes()
+
+			j.Name = string(string(outBuf))
+
+		}
+	}
+
+	state = fflib.FFParse_after_value
+	goto mainparse
+
+handle_Labels:
+
+	/* handler: j.Labels type=map[string]string kind=map quoted=false*/
+
+	{
+
+		{
+			if tok != fflib.FFTok_left_bracket && tok != fflib.FFTok_null {
+				return fs.WrapErr(fmt.Errorf("cannot unmarshal %s into Go value for ", tok))
+			}
+		}
+
+		if tok == fflib.FFTok_null {
+			j.Labels = nil
+		} else {
+
+			j.Labels = make(map[string]string, 0)
+
+			wantVal := true
+
+			for {
+
+				var k string
+
+				var tmpJLabels string
+
+				tok = fs.Scan()
+				if tok == fflib.FFTok_error {
+					goto tokerror
+				}
+				if tok == fflib.FFTok_right_bracket {
+					break
+				}
+
+				if tok == fflib.FFTok_comma {
+					if wantVal == true {
+						// TODO(pquerna): this isn't an ideal error message, this handles
+						// things like [,,,] as an array value.
+						return fs.WrapErr(fmt.Errorf("wanted value token, but got token: %v", tok))
+					}
+					continue
+				} else {
+					wantVal = true
+				}
+
+				/* handler: k type=string kind=string quoted=false*/
+
+				{
+
+					{
+						if tok != fflib.FFTok_string && tok != fflib.FFTok_null {
+							return fs.WrapErr(fmt.Errorf("cannot unmarshal %s into Go value for string", tok))
+						}
+					}
+
+					if tok == fflib.FFTok_null {
+
+					} else {
+
+						outBuf := fs.Output.Bytes()
+
+						k = string(string(outBuf))
+
+					}
+				}
+
+				// Expect ':' after key
+				tok = fs.Scan()
+				if tok != fflib.FFTok_colon {
+					return fs.WrapErr(fmt.Errorf("wanted colon token, but got token: %v", tok))
+				}
+
+				tok = fs.Scan()
+				/* handler: tmpJLabels type=string kind=string quoted=false*/
+
+				{
+
+					{
+						if tok != fflib.FFTok_string && tok != fflib.FFTok_null {
+							return fs.WrapErr(fmt.Errorf("cannot unmarshal %s into Go value for string", tok))
+						}
+					}
+
+					if tok == fflib.FFTok_null {
+
+					} else {
+
+						outBuf := fs.Output.Bytes()
+
+						tmpJLabels = string(string(outBuf))
+
+					}
+				}
+
+				j.Labels[k] = tmpJLabels
+
+				wantVal = false
+			}
+
+		}
+	}
+
+	state = fflib.FFParse_after_value
+	goto mainparse
+
+wantedvalue:
+	return fs.WrapErr(fmt.Errorf("wanted value token, but got token: %v", tok))
+wrongtokenerror:
+	return fs.WrapErr(fmt.Errorf("ffjson: wanted token: %v, but got token: %v output=%s", wantedTok, tok, fs.Output.String()))
+tokerror:
+	if fs.BigError != nil {
+		return fs.WrapErr(fs.BigError)
+	}
+	err = fs.Error.ToError()
+	if err != nil {
+		return fs.WrapErr(err)
+	}
+	panic("ffjson-generated: unreachable, please report bug.")
+done:
+
+	return nil
+}

libpod/state_test.go

@@ -161,11 +161,7 @@ func TestAddAndGetContainer(t *testing.T) {
 		retrievedCtr, err := state.Container(testCtr.ID())
 		assert.NoError(t, err)
 
-		// Use assert.EqualValues if the test fails to pretty print diff
+		testContainersEqual(t, testCtr, retrievedCtr)
-		// between actual and expected
-		if !testContainersEqual(testCtr, retrievedCtr) {
-			assert.EqualValues(t, testCtr, retrievedCtr)
-		}
 	})
 }
 
@@ -185,11 +181,7 @@ func TestAddAndGetContainerFromMultiple(t *testing.T) {
 		retrievedCtr, err := state.Container(testCtr1.ID())
 		assert.NoError(t, err)
 
-		// Use assert.EqualValues if the test fails to pretty print diff
+		testContainersEqual(t, testCtr1, retrievedCtr)
-		// between actual and expected
-		if !testContainersEqual(testCtr1, retrievedCtr) {
-			assert.EqualValues(t, testCtr1, retrievedCtr)
-		}
 	})
 }
 
@@ -350,11 +342,7 @@ func TestLookupContainerByFullID(t *testing.T) {
 		retrievedCtr, err := state.LookupContainer(testCtr.ID())
 		assert.NoError(t, err)
 
-		// Use assert.EqualValues if the test fails to pretty print diff
+		testContainersEqual(t, testCtr, retrievedCtr)
-		// between actual and expected
-		if !testContainersEqual(testCtr, retrievedCtr) {
-			assert.EqualValues(t, testCtr, retrievedCtr)
-		}
 	})
 }
 
@@ -369,11 +357,7 @@ func TestLookupContainerByUniquePartialID(t *testing.T) {
 		retrievedCtr, err := state.LookupContainer(testCtr.ID()[0:8])
 		assert.NoError(t, err)
 
-		// Use assert.EqualValues if the test fails to pretty print diff
+		testContainersEqual(t, testCtr, retrievedCtr)
-		// between actual and expected
-		if !testContainersEqual(testCtr, retrievedCtr) {
-			assert.EqualValues(t, testCtr, retrievedCtr)
-		}
 	})
 }
 
@@ -406,11 +390,7 @@ func TestLookupContainerByName(t *testing.T) {
 		retrievedCtr, err := state.LookupContainer(testCtr.Name())
 		assert.NoError(t, err)
 
-		// Use assert.EqualValues if the test fails to pretty print diff
+		testContainersEqual(t, testCtr, retrievedCtr)
-		// between actual and expected
-		if !testContainersEqual(testCtr, retrievedCtr) {
-			assert.EqualValues(t, testCtr, retrievedCtr)
-		}
 	})
 }
 
@@ -504,11 +484,7 @@ func TestSaveAndUpdateContainer(t *testing.T) {
 		err = state.UpdateContainer(testCtr)
 		assert.NoError(t, err)
 
-		// Use assert.EqualValues if the test fails to pretty print diff
+		testContainersEqual(t, testCtr, retrievedCtr)
-		// between actual and expected
-		if !testContainersEqual(testCtr, retrievedCtr) {
-			assert.EqualValues(t, testCtr, retrievedCtr)
-		}
 	})
 }
 
@@ -600,11 +576,7 @@ func TestGetAllContainersWithOneContainer(t *testing.T) {
 		assert.NoError(t, err)
 		assert.Equal(t, 1, len(ctrs))
 
-		// Use assert.EqualValues if the test fails to pretty print diff
+		testContainersEqual(t, testCtr, ctrs[0])
-		// between actual and expected
-		if !testContainersEqual(testCtr, ctrs[0]) {
-			assert.EqualValues(t, testCtr, ctrs[0])
-		}
 	})
 }
 
@@ -1600,11 +1572,7 @@ func TestPodContainersOneContainer(t *testing.T) {
 		assert.NoError(t, err)
 		assert.Equal(t, 1, len(ctrs))
 
-		// Use assert.EqualValues if the test fails to pretty print diff
+		testContainersEqual(t, testCtr, ctrs[0])
-		// between actual and expected
-		if !testContainersEqual(testCtr, ctrs[0]) {
-			assert.EqualValues(t, testCtr, ctrs[0])
-		}
 	})
 }
 
@@ -1908,14 +1876,8 @@ func TestAddContainerToPodSucceeds(t *testing.T) {
 		assert.NoError(t, err)
 		assert.Equal(t, 1, len(allCtrs))
 
-		// Use assert.EqualValues if the test fails to pretty print diff
+		testContainersEqual(t, testCtr, ctrs[0])
-		// between actual and expected
+		testContainersEqual(t, ctrs[0], allCtrs[0])
-		if !testContainersEqual(testCtr, ctrs[0]) {
-			assert.EqualValues(t, testCtr, ctrs[0])
-		}
-		if !testContainersEqual(allCtrs[0], ctrs[0]) {
-			assert.EqualValues(t, allCtrs[0], ctrs[0])
-		}
 	})
 }
 
@@ -1980,11 +1942,7 @@ func TestAddContainerToPodWithAddContainer(t *testing.T) {
 		assert.NoError(t, err)
 		assert.Equal(t, 2, len(allCtrs))
 
-		// Use assert.EqualValues if the test fails to pretty print diff
+		testContainersEqual(t, testCtr1, ctrs[0])
-		// between actual and expected
-		if !testContainersEqual(testCtr1, ctrs[0]) {
-			assert.EqualValues(t, testCtr1, ctrs[0])
-		}
 	})
 }
 

libpod/test_common.go

@@ -4,12 +4,13 @@ import (
 	"encoding/json"
 	"net"
 	"path/filepath"
-	"reflect"
+	"testing"
 	"time"
 
 	"github.com/containers/storage"
 	"github.com/cri-o/ocicni/pkg/ocicni"
 	"github.com/opencontainers/runtime-tools/generate"
+	"github.com/stretchr/testify/assert"
 )
 
 // nolint
@@ -98,40 +99,41 @@ func getTestPod(id, name, locksDir string) (*Pod, error) {
 // This horrible hack tests if containers are equal in a way that should handle
 // empty arrays being dropped to nil pointers in the spec JSON
 // nolint
-func testContainersEqual(a, b *Container) bool {
+func testContainersEqual(t *testing.T, a, b *Container) {
 	if a == nil && b == nil {
-		return true
+		return
-	} else if a == nil || b == nil {
-		return false
 	}
+	assert.NotNil(t, a)
+	assert.NotNil(t, b)
 
-	if a.valid != b.valid {
+	aConfig := new(ContainerConfig)
-		return false
+	bConfig := new(ContainerConfig)
-	}
+	aState := new(containerState)
+	bState := new(containerState)
+
+	assert.Equal(t, a.valid, b.valid)
 
 	aConfigJSON, err := json.Marshal(a.config)
-	if err != nil {
+	assert.NoError(t, err)
-		return false
+	err = json.Unmarshal(aConfigJSON, aConfig)
-	}
+	assert.NoError(t, err)
 
 	bConfigJSON, err := json.Marshal(b.config)
-	if err != nil {
+	assert.NoError(t, err)
-		return false
+	err = json.Unmarshal(bConfigJSON, bConfig)
-	}
+	assert.NoError(t, err)
 
-	if !reflect.DeepEqual(aConfigJSON, bConfigJSON) {
+	assert.EqualValues(t, aConfig, bConfig)
-		return false
-	}
 
 	aStateJSON, err := json.Marshal(a.state)
-	if err != nil {
+	assert.NoError(t, err)
-		return false
+	err = json.Unmarshal(aStateJSON, aState)
-	}
+	assert.NoError(t, err)
 
 	bStateJSON, err := json.Marshal(b.state)
-	if err != nil {
+	assert.NoError(t, err)
-		return false
+	err = json.Unmarshal(bStateJSON, bState)
-	}
+	assert.NoError(t, err)
 
-	return reflect.DeepEqual(aStateJSON, bStateJSON)
+	assert.EqualValues(t, aState, bState)
 }