1
0
mirror of https://github.com/netbox-community/netbox.git synced 2024-05-10 07:54:54 +00:00

Improve documentation and testing for conditions

This commit is contained in:
jeremystretch
2021-11-03 14:02:43 -04:00
parent 839afe5ac0
commit dcececf9c0
3 changed files with 50 additions and 3 deletions

View File

@ -23,14 +23,47 @@ A condition is expressed as a JSON object with the following keys:
* `in`: Is present within a list of values
* `contains`: Contains the specified value
### Accessing Nested Keys
To access nested keys, use dots to denote the path to the desired attribute. For example, assume the following data:
```json
{
"a": {
"b": {
"c": 123
}
}
}
```
The following condition will evaluate as true:
```json
{
"attr": "a.b.c",
"value": 123
}
```
### Examples
`name` equals "foobar":
`name` equals "foo":
```json
{
"attr": "name",
"value": "foobar"
"value": "foo"
}
```
`name` does not equal "foo"
```json
{
"attr": "name",
"value": "foo",
"negate": true
}
```

View File

@ -64,7 +64,11 @@ class Condition:
"""
Evaluate the provided data to determine whether it matches the condition.
"""
value = functools.reduce(dict.get, self.attr.split('.'), data)
try:
value = functools.reduce(dict.get, self.attr.split('.'), data)
except TypeError:
# Invalid key path
value = None
result = self.eval_func(value)
if self.negate:

View File

@ -35,6 +35,16 @@ class ConditionTestCase(TestCase):
# 'gt' supports only numeric values
Condition('x', 'foo', 'gt')
#
# Nested attrs tests
#
def test_nested(self):
c = Condition('x.y.z', 1)
self.assertTrue(c.eval({'x': {'y': {'z': 1}}}))
self.assertFalse(c.eval({'x': {'y': {'z': 2}}}))
self.assertFalse(c.eval({'a': {'b': {'c': 1}}}))
#
# Operator tests
#