Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixes #179: Ensure uniqueness in leaf-list #200

Merged
merged 3 commits into from
May 16, 2018
Merged

Fixes #179: Ensure uniqueness in leaf-list #200

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d0b6f59
Clean up tests and add new to ensure uniqueness of leaf-lists
jwilhelm-godaddy May 15, 2018
456346d
Add an optional uniqueness check to TypedLists
jwilhelm-godaddy May 15, 2018
2f6ec57
Remove pypy3 from the testing matrix because bitarray
jwilhelm-godaddy May 15, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 11 additions & 5 deletions pyangbind/lib/yangtypes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -377,19 +377,25 @@ class TypedList(collections.MutableSequence):
_list = list()

def __init__(self, *args, **kwargs):
self._unique = kwargs.pop('unique', False)
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there ever a scenario that we expect that a list is not unique? If not, it might be best to make this flag work the other way around such that we have something that says to skip the uniqueness check?

self._allowed_type = allowed_type
self._list = list()
if len(args):
if isinstance(args[0], list):
tmp = []
for i in args[0]:
tmp.append(self.check(i))
if not self._unique or i not in tmp:
tmp.append(self.check(i))
self._list.extend(tmp)
else:
tmp = self.check(args[0])
self._list.append(tmp)

def check(self, v):
# Short circuit uniqueness check
if self._unique and v in self._list:
raise ValueError("Values in this list must be unique.")

passed = False
count = 0
for i in self._allowed_type:
Expand Down Expand Up @@ -446,16 +452,16 @@ def __delitem__(self, i):
del self._list[i]

def __setitem__(self, i, v):
self.check(v)
self._list.insert(i, v)
self.insert(i, v)

def insert(self, i, v):
val = self.check(v)
self._list.insert(i, val)

def append(self, v):
val = self.check(v)
self._list.append(val)
if not self._unique or v not in self._list:
val = self.check(v)
self._list.append(val)

def __str__(self):
return str(self._list)
Expand Down
2 changes: 1 addition & 1 deletion pyangbind/plugin/pybind.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -844,7 +844,7 @@ def get_children(ctx, fd, i_children, module, parent, path=str(),
# TypedList (see lib.yangtypes) with a particular set of types allowed.
class_str["name"] = "__%s" % (i["name"])
class_str["type"] = "YANGDynClass"
class_str["arg"] = "base="
class_str["arg"] = "unique=True, base="
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Having the unique the other way around in TypedListType would mean that we could avoid this in the generated code?

if isinstance(i["type"]["native_type"][1], list):
allowed_type = "["
for subtype in i["type"]["native_type"][1]:
Expand Down
48 changes: 30 additions & 18 deletions tests/leaf-list/run.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,22 +16,21 @@ def setUp(self):
self.leaflist_obj = self.bindings.leaflist()

def test_container_exists(self):
self.assertTrue(hasattr(self.leaflist_obj, "container"), "Base container is missing.")
self.assertTrue(hasattr(self.leaflist_obj, "container"))

def test_leaflist_exists(self):
self.assertTrue(hasattr(self.leaflist_obj.container, "leaflist"), "Leaf-list instance is missing.")
self.assertTrue(hasattr(self.leaflist_obj.container, "leaflist"))

def test_leaflist_length_is_zero(self):
self.assertEqual(len(self.leaflist_obj.container.leaflist), 0, "Length of leaflist was not zero.")
self.assertEqual(len(self.leaflist_obj.container.leaflist), 0)

def test_append_to_leaflist(self):
self.leaflist_obj.container.leaflist.append("itemOne")
self.assertEqual(len(self.leaflist_obj.container.leaflist), 1, "Did not successfully append string to list.")
self.assertEqual(len(self.leaflist_obj.container.leaflist), 1)

def test_retrieve_leaflist_item_value(self):
self.leaflist_obj.container.leaflist.append("itemOne")
self.assertEqual(self.leaflist_obj.container.leaflist[0], "itemOne",
"Cannot successfully address an item from the list.")
self.assertEqual(self.leaflist_obj.container.leaflist[0], "itemOne")

def test_append_int_to_string_leaflist(self):
with self.assertRaises(ValueError):
Expand All @@ -41,30 +40,30 @@ def test_getitem(self):
self.leaflist_obj.container.leaflist.append("itemOne")
self.leaflist_obj.container.leaflist.append("itemTwo")

self.assertEqual(self.leaflist_obj.container.leaflist[1], "itemTwo", "getitem did not return the correct value.")
self.assertEqual(self.leaflist_obj.container.leaflist[1], "itemTwo")

def test_setitem(self):
self.leaflist_obj.container.leaflist.append("itemOne")
self.leaflist_obj.container.leaflist.append("itemTwo")
self.leaflist_obj.container.leaflist[1] = "indexOne"

self.assertEqual(self.leaflist_obj.container.leaflist[1], "indexOne", "setitem did not set the correct node.")
self.assertEqual(self.leaflist_obj.container.leaflist[1], "indexOne")

def test_insert(self):
self.leaflist_obj.container.leaflist.append("itemOne")
self.leaflist_obj.container.leaflist.append("itemTwo")
self.leaflist_obj.container.leaflist[1] = "indexOne"
self.leaflist_obj.container.leaflist.insert(0, "indexZero")

self.assertEqual(self.leaflist_obj.container.leaflist[0], "indexZero", "Incorrectly set index 0 value")
self.assertEqual(self.leaflist_obj.container.leaflist[0], "indexZero")

def test_leaflist_grows_from_various_modification_methods(self):
self.leaflist_obj.container.leaflist.append("itemOne")
self.leaflist_obj.container.leaflist.append("itemTwo")
self.leaflist_obj.container.leaflist[1] = "indexOne"
self.leaflist_obj.container.leaflist.insert(0, "indexZero")

self.assertEqual(len(self.leaflist_obj.container.leaflist), 4, "List item was not added by insert()")
self.assertEqual(len(self.leaflist_obj.container.leaflist), 4)

def test_delete_item_from_leaflist(self):
self.leaflist_obj.container.leaflist.append("itemOne")
Expand All @@ -74,7 +73,7 @@ def test_delete_item_from_leaflist(self):

del self.leaflist_obj.container.leaflist[0]

self.assertEqual(len(self.leaflist_obj.container.leaflist), 3, "List item not successfully removed by delitem")
self.assertEqual(len(self.leaflist_obj.container.leaflist), 3)

def test_get_full_leaflist(self):
self.leaflist_obj.container.leaflist.append("itemOne")
Expand All @@ -87,23 +86,21 @@ def test_get_full_leaflist(self):
self.leaflist_obj.get(),
{'container': {'leaflist': ['itemOne', 'indexOne', 'itemTwo'],
'listtwo': [],
'listthree': []}},
"get did not correctly return the dictionary"
'listthree': []}}
)

def test_leaflist_assignment(self):
self.leaflist_obj.container.leaflist = ["itemOne", "itemTwo"]

self.assertEqual(self.leaflist_obj.container.leaflist, ["itemOne", "itemTwo"],
"Leaflist assignment did not function correctly")
self.assertEqual(self.leaflist_obj.container.leaflist, ["itemOne", "itemTwo"])

def test_leaflist_assignment_of_wrong_type(self):
with self.assertRaises(ValueError):
self.leaflist_obj.container.leaflist = [1, 2]

def test_restricted_string(self):
self.leaflist_obj.container.listtwo.append("a-valid-string")
self.assertEqual(len(self.leaflist_obj.container.listtwo), 1, "Restricted lefalist did not function correctly.")
self.assertEqual(len(self.leaflist_obj.container.listtwo), 1)

def test_restricted_string_invalid_value(self):
with self.assertRaises(ValueError):
Expand All @@ -117,8 +114,23 @@ def test_union_type(self):
self.leaflist_obj.container.listthree.append(pair[0])
except ValueError:
allowed = False
self.assertEqual(allowed, pair[1], "leaf-list of union type had invalid result (%s != %s for %s)" %
(allowed, pair[1], pair[0]))
self.assertEqual(allowed, pair[1])

def test_leaf_lists_are_unique_after_assignment(self):
self.leaflist_obj.container.leaflist = ['foo', 'bar', 'foo']
self.assertEqual(self.leaflist_obj.container.get(filter=True), {'leaflist': ['foo', 'bar']})

def test_leaf_lists_are_unique_after_append(self):
self.leaflist_obj.container.leaflist.append('foo')
self.leaflist_obj.container.leaflist.append('bar')
self.leaflist_obj.container.leaflist.append('foo')
self.assertEqual(self.leaflist_obj.container.get(filter=True), {'leaflist': ['foo', 'bar']})

def test_leaf_lists_insert_non_unique_value_raises_keyerror(self):
self.leaflist_obj.container.leaflist[0] = 'foo'
self.leaflist_obj.container.leaflist[1] = 'bar'
with self.assertRaises(ValueError):
self.leaflist_obj.container.leaflist[2] = 'foo'


if __name__ == '__main__':
Expand Down
2 changes: 1 addition & 1 deletion tox.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[tox]
envlist = py{27,34,35,36,37,py2,py3},flake8
envlist = py{27,34,35,36,37,py2},flake8
skip_missing_interpreters = True

[testenv]
Expand Down