add python binding for swss::Table (#159)

common/subscriberstatetable.cpp

@@ -24,7 +24,7 @@ SubscriberStateTable::SubscriberStateTable(DBConnector *db, string tableName)
     psubscribe(m_db, m_keyspace);
 
     vector<string> keys;
-    m_table.getTableKeys(keys);
+    m_table.getKeys(keys);
 
     for (auto key: keys)
     {

common/table.cpp

@@ -61,10 +61,10 @@ void Table::del(string key, string /* op */, string /*prefix*/)
     RedisReply r(m_db, string("DEL ") + getKeyName(key), REDIS_REPLY_INTEGER);
 }
 
-void TableEntryEnumerable::getTableContent(vector<KeyOpFieldsValuesTuple> &tuples)
+void TableEntryEnumerable::getContent(vector<KeyOpFieldsValuesTuple> &tuples)
 {
     vector<string> keys;
-    getTableKeys(keys);
+    getKeys(keys);
 
     tuples.clear();
 
@@ -78,7 +78,7 @@ void TableEntryEnumerable::getTableContent(vector<KeyOpFieldsValuesTuple> &tuple
     }
 }
 
-void Table::getTableKeys(vector<string> &keys)
+void Table::getKeys(vector<string> &keys)
 {
     string keys_cmd("KEYS " + getTableName() + getTableNameSeparator() + "*");
     RedisReply r(m_db, keys_cmd, REDIS_REPLY_ARRAY);

common/table.h

@@ -105,11 +105,11 @@ class TableEntryEnumerable {
     virtual bool get(std::string key, std::vector<FieldValueTuple> &values) = 0;
 
     /* get all the keys in the table */
-    virtual void getTableKeys(std::vector<std::string> &keys) = 0;
+    virtual void getKeys(std::vector<std::string> &keys) = 0;
 
     /* Read the whole table content from the DB directly */
     /* NOTE: Not an atomic function */
-    void getTableContent(std::vector<KeyOpFieldsValuesTuple> &tuples);
+    void getContent(std::vector<KeyOpFieldsValuesTuple> &tuples);
 };
 
 class Table : public RedisTransactioner, public TableBase, public TableEntryEnumerable {
@@ -129,9 +129,9 @@ class Table : public RedisTransactioner, public TableBase, public TableEntryEnum
 
     /* Read a value from the DB directly */
     /* Returns false if the key doesn't exists */
-    virtual bool get(std::string key, std::vector<FieldValueTuple> &values);
+    virtual bool get(std::string key, std::vector<FieldValueTuple> &ovalues);
 
-    void getTableKeys(std::vector<std::string> &keys);
+    void getKeys(std::vector<std::string> &keys);
 
     void dump(TableDump &tableDump);
 

pyext/swsscommon.i

@@ -1,15 +1,5 @@
 %module swsscommon
 
-%include <std_string.i>
-%include <std_vector.i>
-%include <std_pair.i>
-%include <typemaps.i>
-
-%template(FieldValuePair) std::pair<std::string, std::string>;
-%template(FieldValuePairs) std::vector<std::pair<std::string, std::string>>;
-%apply std::string& OUTPUT {std::string &key};
-%apply std::string& OUTPUT {std::string &op};
-
 %{
 #include "schema.h"
 #include "dbconnector.h"
@@ -27,6 +17,15 @@
 #include "notificationconsumer.h"
 %}
 
+%include <std_string.i>
+%include <std_vector.i>
+%include <std_pair.i>
+%include <typemaps.i>
+
+%template(FieldValuePair) std::pair<std::string, std::string>;
+%template(FieldValuePairs) std::vector<std::pair<std::string, std::string>>;
+%template(VectorString) std::vector<std::string>;
+
 %apply int *OUTPUT {int *fd};
 %typemap(in, numinputs=0) swss::Selectable ** (swss::Selectable *temp) {
     $1 = &temp;
@@ -49,9 +48,23 @@
 %include "redispipeline.h"
 %include "redisselect.h"
 %include "redistran.h"
+
+%apply std::vector<std::string>& OUTPUT {std::vector<std::string> &keys};
+%apply std::vector<std::pair<std::string, std::string>>& OUTPUT {std::vector<std::pair<std::string, std::string>> &ovalues};
 %include "table.h"
+%clear std::vector<std::string> &keys;
+%clear std::vector<std::pair<std::string, std::string>> &values;
+
 %include "producerstatetable.h"
+
+%apply std::string& OUTPUT {std::string &key};
+%apply std::string& OUTPUT {std::string &op};
+%apply std::vector<std::pair<std::string, std::string>>& OUTPUT {std::vector<std::pair<std::string, std::string>> &fvs};
 %include "consumertablebase.h"
+%clear std::string &key;
+%clear std::string &op;
+%clear std::vector<std::pair<std::string, std::string>> &fvs;
+
 %include "consumerstatetable.h"
 %include "subscriberstatetable.h"
 %include "notificationconsumer.h"

tests/redis_piped_ut.cpp

@@ -351,7 +351,7 @@ TEST(Table, piped_test)
 
     cout << "- Step 2. GET_TABLE_CONTENT" << endl;
     vector<KeyOpFieldsValuesTuple> tuples;
-    t.getTableContent(tuples);
+    t.getContent(tuples);
 
     cout << "Get total " << tuples.size() << " number of entries" << endl;
     EXPECT_EQ(tuples.size(), (size_t)2);
@@ -393,7 +393,7 @@ TEST(Table, piped_test)
     cout << "- Step 5. DEL and GET_TABLE_CONTENT" << endl;
     cout << "Delete key [b]" << endl;
     t.del(key_2);
-    t.getTableContent(tuples);
+    t.getContent(tuples);
 
     EXPECT_EQ(tuples.size(), unsigned(0));
 

tests/redis_ut.cpp

@@ -350,7 +350,7 @@ TEST(Table, test)
 
     cout << "- Step 2. GET_TABLE_CONTENT" << endl;
     vector<KeyOpFieldsValuesTuple> tuples;
-    t.getTableContent(tuples);
+    t.getContent(tuples);
 
     cout << "Get total " << tuples.size() << " number of entries" << endl;
     EXPECT_EQ(tuples.size(), (size_t)2);
@@ -392,7 +392,7 @@ TEST(Table, test)
     cout << "- Step 5. DEL and GET_TABLE_CONTENT" << endl;
     cout << "Delete key [b]" << endl;
     t.del(key_2);
-    t.getTableContent(tuples);
+    t.getContent(tuples);
 
     EXPECT_EQ(tuples.size(), unsigned(0));
 
@@ -431,7 +431,7 @@ TEST(Table, table_separator_test)
 
     cout << "- Step 2. GET_TABLE_CONTENT" << endl;
     vector<KeyOpFieldsValuesTuple> tuples;
-    t.getTableContent(tuples);
+    t.getContent(tuples);
 
     cout << "Get total " << tuples.size() << " number of entries" << endl;
     EXPECT_EQ(tuples.size(), (size_t)2);
@@ -473,7 +473,7 @@ TEST(Table, table_separator_test)
     cout << "- Step 5. DEL and GET_TABLE_CONTENT" << endl;
     cout << "Delete key [b]" << endl;
     t.del(key_2);
-    t.getTableContent(tuples);
+    t.getContent(tuples);
 
     EXPECT_EQ(tuples.size(), unsigned(0));
 

tests/test_redis_ut.py

@@ -6,13 +6,26 @@ def test_ProducerStateTable():
     cs = swsscommon.ConsumerStateTable(db, "abc")
     fvs = swsscommon.FieldValuePairs([('a','b')])
     ps.set("aaa", fvs)
-    cfvs = swsscommon.FieldValuePairs([])
-    (key, op) = cs.pop(cfvs)
+    (key, op, cfvs) = cs.pop()
     assert key == "aaa"
     assert op == "SET"
     assert len(cfvs) == 1
     assert cfvs[0] == ('a', 'b')
 
+def test_Table():
+    db = swsscommon.DBConnector(0, "localhost", 6379, 0)
+    tbl = swsscommon.Table(db, "test_TABLE")
+    fvs = swsscommon.FieldValuePairs([('a','b'), ('c', 'd')])
+    tbl.set("aaa", fvs)
+    keys = tbl.getKeys()
+    assert len(keys) == 1
+    assert keys[0] == "aaa"
+    (status, fvs) = tbl.get("aaa")
+    assert status == True
+    assert len(fvs) == 2
+    assert fvs[0] == ('a', 'b')
+    assert fvs[1] == ('c', 'd')
+
 def test_SubscriberStateTable():
     db = swsscommon.DBConnector(0, "localhost", 6379, 0)
     t = swsscommon.Table(db, "testsst", '|')
@@ -23,8 +36,7 @@ def test_SubscriberStateTable():
     t.set("aaa", fvs)
     (state, c, fd) = sel.select()
     assert state == swsscommon.Select.OBJECT
-    cfvs = swsscommon.FieldValuePairs([])
-    (key, op) = cst.pop(cfvs)
+    (key, op, cfvs) = cst.pop()
     assert key == "aaa"
     assert op == "SET"
     assert len(cfvs) == 1