Merge eab2afa848 into 912dee68b1

Refactored obj.go to a more generic approach
Added object support for already implemented expressions
Added test for limit object
Fixes https://github.com/google/nftables/issues/253

nftables_test.go

@@ -2105,7 +2105,7 @@ func TestGetObjReset(t *testing.T) {
 	}
 
 	filter := &nftables.Table{Name: "filter", Family: nftables.TableFamilyIPv4}
-	obj, err := c.ResetObject(&nftables.ObjAttr{
+	obj, err := c.ResetObject(&nftables.NamedObj{
 		Table: filter,
 		Name:  "fwded",
 		Type:  nftables.ObjTypeCounter,
@@ -2114,7 +2114,7 @@ func TestGetObjReset(t *testing.T) {
 		t.Fatal(err)
 	}
 
-	co, ok := obj.(*nftables.ObjAttr)
+	co, ok := obj.(*nftables.NamedObj)
 	if !ok {
 		t.Fatalf("unexpected type: got %T, want *nftables.ObjAttr", obj)
 	}
@@ -2168,7 +2168,7 @@ func TestObjAPI(t *testing.T) {
 		Priority: nftables.ChainPriorityFilter,
 	})
 
-	counter1 := c.AddObj(&nftables.ObjAttr{
+	counter1 := c.AddObj(&nftables.NamedObj{
 		Table: table,
 		Name:  "fwded1",
 		Type:  nftables.ObjTypeCounter,
@@ -2178,7 +2178,7 @@ func TestObjAPI(t *testing.T) {
 		},
 	})
 
-	counter2 := c.AddObj(&nftables.ObjAttr{
+	counter2 := c.AddObj(&nftables.NamedObj{
 		Table: table,
 		Name:  "fwded2",
 		Type:  nftables.ObjTypeCounter,
@@ -2188,7 +2188,7 @@ func TestObjAPI(t *testing.T) {
 		},
 	})
 
-	c.AddObj(&nftables.ObjAttr{
+	c.AddObj(&nftables.NamedObj{
 		Table: tableOther,
 		Name:  "fwdedOther",
 		Type:  nftables.ObjTypeCounter,
@@ -2236,7 +2236,7 @@ func TestObjAPI(t *testing.T) {
 		t.Errorf("c.GetObject(counter1) failed: %v failed", err)
 	}
 
-	rcounter1, ok := obj1.(*nftables.ObjAttr)
+	rcounter1, ok := obj1.(*nftables.NamedObj)
 	if !ok {
 		t.Fatalf("unexpected type: got %T, want *nftables.ObjAttr", obj1)
 	}
@@ -2250,7 +2250,7 @@ func TestObjAPI(t *testing.T) {
 		t.Errorf("c.GetObject(counter2) failed: %v failed", err)
 	}
 
-	rcounter2, ok := obj2.(*nftables.ObjAttr)
+	rcounter2, ok := obj2.(*nftables.NamedObj)
 	if !ok {
 		t.Fatalf("unexpected type: got %T, want *nftables.CounterObj", obj2)
 	}
@@ -2271,7 +2271,7 @@ func TestObjAPI(t *testing.T) {
 		t.Errorf("c.GetObject(counter1) failed: %v failed", err)
 	}
 
-	if counter1 := obj1.(*nftables.ObjAttr).Obj.(*expr.Counter); counter1.Packets > 0 {
+	if counter1 := obj1.(*nftables.NamedObj).Obj.(*expr.Counter); counter1.Packets > 0 {
 		t.Errorf("unexpected packets number: got %d, want %d", counter1.Packets, 0)
 	}
 
@@ -2281,7 +2281,7 @@ func TestObjAPI(t *testing.T) {
 		t.Errorf("c.GetObject(counter2) failed: %v failed", err)
 	}
 
-	if counter2 := obj2.(*nftables.ObjAttr).Obj.(*expr.Counter); counter2.Packets != 1 {
+	if counter2 := obj2.(*nftables.NamedObj).Obj.(*expr.Counter); counter2.Packets != 1 {
 		t.Errorf("unexpected packets number: got %d, want %d", counter2.Packets, 1)
 	}
 
@@ -6674,7 +6674,7 @@ func TestAddLimitObj(t *testing.T) {
 		Burst: 5,
 		Over:  false,
 	}
-	o := &nftables.ObjAttr{
+	o := &nftables.NamedObj{
 		Table: tr,
 		Name:  "limit_test",
 		Type:  nftables.ObjTypeLimit,
@@ -6686,7 +6686,7 @@ func TestAddLimitObj(t *testing.T) {
 		t.Errorf("conn.Flush() failed: %v", err)
 	}
 
-	obj, err := conn.GetObj(&nftables.ObjAttr{
+	obj, err := conn.GetObj(&nftables.NamedObj{
 		Table: table,
 		Name:  "limit_test",
 		Type:  nftables.ObjTypeLimit,
@@ -6699,7 +6699,7 @@ func TestAddLimitObj(t *testing.T) {
 		t.Fatalf("unexpected object list length: got %d, want %d", got, want)
 	}
 
-	o1, ok := obj[0].(*nftables.ObjAttr)
+	o1, ok := obj[0].(*nftables.NamedObj)
 	if !ok {
 		t.Fatalf("unexpected type: got %T, want *ObjAttr", obj[0])
 	}
@@ -6745,7 +6745,7 @@ func TestAddQuotaObj(t *testing.T) {
 	}
 	conn.AddChain(c)
 
-	o := &nftables.ObjAttr{
+	o := &nftables.NamedObj{
 		Table: tr,
 		Name:  "q_test",
 		Type:  nftables.ObjTypeQuota,
@@ -6761,7 +6761,7 @@ func TestAddQuotaObj(t *testing.T) {
 		t.Fatalf("conn.Flush() failed: %v", err)
 	}
 
-	obj, err := conn.GetObj(&nftables.ObjAttr{
+	obj, err := conn.GetObj(&nftables.NamedObj{
 		Table: table,
 		Name:  "q_test",
 		Type:  nftables.ObjTypeQuota,
@@ -6774,7 +6774,7 @@ func TestAddQuotaObj(t *testing.T) {
 		t.Fatalf("unexpected object list length: got %d, want %d", got, want)
 	}
 
-	o1, ok := obj[0].(*nftables.ObjAttr)
+	o1, ok := obj[0].(*nftables.NamedObj)
 	if !ok {
 		t.Fatalf("unexpected type: got %T, want *ObjAttr", obj[0])
 	}
@@ -6878,7 +6878,7 @@ func TestDeleteQuotaObjMixedTypes(t *testing.T) {
 	}
 	conn.AddChain(c)
 
-	o := &nftables.ObjAttr{
+	o := &nftables.NamedObj{
 		Table: tr,
 		Name:  "q_test",
 		Type:  nftables.ObjTypeQuota,
@@ -6894,7 +6894,7 @@ func TestDeleteQuotaObjMixedTypes(t *testing.T) {
 		t.Fatalf("conn.Flush() failed: %v", err)
 	}
 
-	obj, err := conn.GetObj(&nftables.ObjAttr{
+	obj, err := conn.GetObj(&nftables.NamedObj{
 		Table: tr,
 		Name:  "q_test",
 		Type:  nftables.ObjTypeQuota,
@@ -6908,7 +6908,7 @@ func TestDeleteQuotaObjMixedTypes(t *testing.T) {
 	}
 
 	o2, _ := o.Obj.(*expr.Quota)
-	want := &nftables.ObjAttr{
+	want := &nftables.NamedObj{
 		Table: tr,
 		Name:  "q_test",
 		Type:  nftables.ObjTypeQuota,

obj.go

@@ -69,33 +69,33 @@ type Obj interface {
 	objType() ObjType
 }
 
-// ObjAttr represents nftables stateful object attributes
+// NamedObj represents nftables stateful object attributes
 // Corresponds to netfilter nft_object_attributes as per
 // https://git.netfilter.org/libnftnl/tree/include/linux/netfilter/nf_tables.h?id=116e95aa7b6358c917de8c69f6f173874030b46b#n1626
-type ObjAttr struct {
+type NamedObj struct {
 	Table *Table
 	Name  string
 	Type  ObjType
 	Obj   expr.Any
 }
 
-func (o *ObjAttr) table() *Table {
+func (o *NamedObj) table() *Table {
 	return o.Table
 }
 
-func (o *ObjAttr) family() TableFamily {
+func (o *NamedObj) family() TableFamily {
 	return o.Table.Family
 }
 
-func (o *ObjAttr) data() expr.Any {
+func (o *NamedObj) data() expr.Any {
 	return o.Obj
 }
 
-func (o *ObjAttr) name() string {
+func (o *NamedObj) name() string {
 	return o.Name
 }
 
-func (o *ObjAttr) objType() ObjType {
+func (o *NamedObj) objType() ObjType {
 	return o.Type
 }
 
@@ -157,32 +157,26 @@ func (cc *Conn) DeleteObject(o Obj) {
 
 // GetObj is a legacy method that return all Obj that belongs
 // to the same table as the given one
-// This function will determine whether returned object will be
+// This function returns the same concrete type as passed,
-// one of legacy types QuotaObj/CounterObj or the new ObjAttr
+// e.g. QuotaObj, CounterObj or NamedObj. Prefer using the more
-// type struct based passed o parameter type
+// generic NamedObj over the legacy QuotaObj and CounterObj types.
-// If o is of type ObjAttr, the implementation will work with
-// the new ObjAttr type, otherwise falls back to legacy QuotaObj/CounterObj
 func (cc *Conn) GetObj(o Obj) ([]Obj, error) {
 	return cc.getObjWithLegacyType(nil, o.table(), unix.NFT_MSG_GETOBJ, cc.useLegacyObjType(o))
 }
 
 // GetObjReset is a legacy method that reset all Obj that belongs
 // the same table as the given one
-// This function will determine whether returned object will be
+// This function returns the same concrete type as passed,
-// one of legacy types QuotaObj/CounterObj or the new ObjAttr
+// e.g. QuotaObj, CounterObj or NamedObj. Prefer using the more
-// type struct based passed o parameter type
+// generic NamedObj over the legacy QuotaObj and CounterObj types.
-// If o is of type ObjAttr, the implementation will work with
-// the new ObjAttr type, otherwise falls back to legacy QuotaObj/CounterObj
 func (cc *Conn) GetObjReset(o Obj) ([]Obj, error) {
 	return cc.getObjWithLegacyType(nil, o.table(), unix.NFT_MSG_GETOBJ_RESET, cc.useLegacyObjType(o))
 }
 
 // GetObject gets the specified Object
-// This function will determine whether returned object will be
+// This function returns the same concrete type as passed,
-// one of legacy types QuotaObj/CounterObj or the new ObjAttr
+// e.g. QuotaObj, CounterObj or NamedObj. Prefer using the more
-// type struct based passed o parameter type
+// generic NamedObj over the legacy QuotaObj and CounterObj types.
-// If o is of type ObjAttr, the implementation will work with
-// the new ObjAttr type, otherwise falls back to legacy QuotaObj/CounterObj
 func (cc *Conn) GetObject(o Obj) (Obj, error) {
 	objs, err := cc.getObj(o, o.table(), unix.NFT_MSG_GETOBJ)
 
@@ -201,11 +195,9 @@ func (cc *Conn) GetObjects(t *Table) ([]Obj, error) {
 }
 
 // ResetObject reset the given Obj
-// This function will determine whether returned object will be
+// This function returns the same concrete type as passed,
-// one of legacy types QuotaObj/CounterObj or the new ObjAttr
+// e.g. QuotaObj, CounterObj or NamedObj. Prefer using the more
-// type struct based passed o parameter type
+// generic NamedObj over the legacy QuotaObj and CounterObj types.
-// If o is of type ObjAttr, the implementation will work with
-// the new ObjAttr type, otherwise falls back to legacy QuotaObj/CounterObj
 func (cc *Conn) ResetObject(o Obj) (Obj, error) {
 	objs, err := cc.getObj(o, o.table(), unix.NFT_MSG_GETOBJ_RESET)
 
@@ -250,7 +242,7 @@ func objFromMsg(msg netlink.Message, returnLegacyType bool) (Obj, error) {
 				return objDataFromMsgLegacy(ad, table, name, objectType)
 			}
 
-			o := ObjAttr{
+			o := NamedObj{
 				Table: table,
 				Name:  name,
 				Type:  ObjType(objectType),
@@ -260,13 +252,13 @@ func objFromMsg(msg netlink.Message, returnLegacyType bool) (Obj, error) {
 			if err != nil {
 				return nil, err
 			}
+			if len(objs) == 0 {
+				return nil, fmt.Errorf("objFromMsg: objs is empty for obj %v", o)
+			}
 			exprs := make([]expr.Any, len(objs))
 			for i := range exprs {
 				exprs[i] = objs[i].(expr.Any)
 			}
-			if len(exprs) == 0 {
-				return nil, fmt.Errorf("objFromMsg: exprs is empty for obj %v", o)
-			}
 
 			o.Obj = exprs[0]
 			return &o, ad.Err()
@@ -380,7 +372,7 @@ func (cc *Conn) useLegacyObjType(o Obj) bool {
 	useLegacyType := true
 	if o != nil {
 		switch o.(type) {
-		case *ObjAttr:
+		case *NamedObj:
 			useLegacyType = false
 		}
 	}