Extended rule counters capabilities (#289)

* Extended rule counters capabilities

* Remove counters in tests when comparing rules

Author: jllorente

README.md

@@ -148,6 +148,7 @@ designed to simplify the interaction with the library, for example:
     {'INPUT': [], 'OUTPUT': [], 'POSTROUTING': [], 'PREROUTING': []}
     >>> iptc.easy.dump_chain('filter', 'OUTPUT', ipv6=False)
     [{'comment': {'comment': 'DNS traffic to Google'},
+      'counters': (1, 56),
       'dst': '8.8.8.8/32',
       'protocol': 'udp',
       'target': 'ACCEPT',

doc/examples.rst

@@ -14,6 +14,7 @@ designed to simplify the interaction with the library, for example:
     {'INPUT': [], 'OUTPUT': [], 'POSTROUTING': [], 'PREROUTING': []}
     >>> iptc.easy.dump_chain('filter', 'OUTPUT', ipv6=False)
     [{'comment': {'comment': 'DNS traffic to Google'},
+      'counters': (1, 56),
       'dst': '8.8.8.8/32',
       'protocol': 'udp',
       'target': 'ACCEPT',

iptc/easy.py

@@ -305,6 +305,8 @@ def encode_iptc_rule(rule_d, ipv6=False):
         try:
             if name in rule_attr:
                 continue
+            elif name == 'counters':
+                _iptc_setcounters(iptc_rule, value)
             elif name == 'target':
                 _iptc_settarget(iptc_rule, value)
             else:
@@ -353,6 +355,8 @@ def decode_iptc_rule(iptc_rule, ipv6=False):
             d['target'] = {'goto':iptc_rule.target.name}
         else:
             d['target'] = iptc_rule.target.name
+    # Get counters
+    d['counters'] = iptc_rule.counters
     # Return a filtered dictionary
     return _filter_empty_field(d)
 
@@ -388,6 +392,10 @@ def _iptc_getchain(table, chain, ipv6=False, raise_exc=True):
     except Exception as e:
         if raise_exc: raise
 
+def _iptc_setcounters(iptc_rule, value):
+    # Value is a tuple (numberOfBytes, numberOfPackets)
+    iptc_rule.counters = value
+
 def _iptc_setmatch(iptc_rule, name, value):
     # Iterate list/tuple recursively
     if isinstance(value, list) or isinstance(value, tuple):

iptc/ip4tc.py

@@ -1286,6 +1286,15 @@ def get_counters(self):
         counters = self.entry.counters
         return counters.pcnt, counters.bcnt
 
+    def set_counters(self, counters):
+        """This method set a tuple pair of the packet and byte counters of
+        the rule."""
+        self.entry.counters.pcnt = counters[0]
+        self.entry.counters.bcnt = counters[1]
+
+    counters = property(get_counters, set_counters)
+    """This is the packet and byte counters of the rule."""
+
     # override the following three for the IPv6 subclass
     def _entry_size(self):
         return xt_align(ct.sizeof(ipt_entry))

tests/test_iptc.py

@@ -581,6 +581,8 @@ def test_rule_to_dict(self):
         target = iptc.Target(rule, "ACCEPT")
         rule.target = target
         rule_d = iptc.easy.decode_iptc_rule(rule, ipv6=True)
+        # Remove counters when comparing rules
+        rule_d.pop('counters', None)
         self.assertEqual(rule_d, {"protocol": "tcp", "src": "::1/128", "target": "ACCEPT"})
 
     def test_rule_from_dict(self):
@@ -939,6 +941,8 @@ def test_rule_to_dict(self):
         target = iptc.Target(rule, "ACCEPT")
         rule.target = target
         rule_d = iptc.easy.decode_iptc_rule(rule)
+        # Remove counters when comparing rules
+        rule_d.pop('counters', None)
         self.assertEqual(rule_d, {"protocol": "tcp", "src": "127.0.0.1/32", "target": "ACCEPT"})
 
     def test_rule_from_dict(self):

tests/test_matches.py

@@ -499,6 +499,8 @@ def test_recent(self):
         }
         iptc.easy.add_rule(self.table, self.chain, rule_d)
         rule2_d = iptc.easy.get_rule(self.table, self.chain, -1)
+        # Remove counters when comparing rules
+        rule2_d.pop('counters', None)
         self.assertEqual(rule_d, rule2_d)
 
 def suite():