5:12 a.m.
From: Ondrej Lichtner <olichtne(a)redhat.com>
This module defines the DeviceReq and HostReq classes, which can be used
to create a global description of Requirements for a network test. You
can use these to define class attributes of a BaseRecipe derived class
to specify "general" requirements for that Recipe, or you can add them
to an instance of a Recipe derived class based on it's parameters to
define requirements "specific" for that single test run.
The module also defines a Requirements class which serves as a container
for HostReq objects, while HostReq classes also serve as containers for
DeviceReq objects. The object tree created this way is translated to a
dictionary used by the internal LNST matching algorithm against
available machines.
Signed-off-by: Ondrej Lichtner <olichtne(a)redhat.com>
---
lnst/Controller/Requirements.py | 113 ++++++++++++++++++++++++++++++++++++++++
1 file changed, 113 insertions(+)
create mode 100644 lnst/Controller/Requirements.py
diff --git a/lnst/Controller/Requirements.py b/lnst/Controller/Requirements.py
new file mode 100644
index 0000000..ffefdfb
--- /dev/null
+++ b/lnst/Controller/Requirements.py
@@ -0,0 +1,113 @@
+"""
+This module defines the DeviceReq and HostReq classes, which can be used to
+create a global description of Requirements for a network test. You can use
+these to define class attributes of a BaseRecipe derived class to specify
+"general" requirements for that Recipe, or you can add them to an instance of
a
+Recipe derived class based on it's parameters to define requirements
"specific"
+for that single test run.
+
+The module also specifies a Requirements class which serves as a container for
+HostReq objects, while HostReq classes also serve as containers for DeviceReq
+objects. The object tree created this way is translated to a dictionary used by
+the internal LNST matching algorithm against available machines.
+
+Copyright 2017 Red Hat, Inc.
+Licensed under the GNU General Public License, version 2 as
+published by the Free Software Foundation; see COPYING for details.
+"""
+
+__author__ = """
+olichtne(a)redhat.com (Ondrej Lichtner)
+"""
+
+from lnst.Common.LnstError import LnstError
+from lnst.Common.Parameters import Parameters, Param
+
+class RequirementError(LnstError):
+ pass
+
+class HostReq(object):
+ """Specifies a Slave machine requirement
+
+ To define a Host requirement you assign a HostReq instance to a class
+ attribute of a BaseRecipe derived class.
+ Example:
+ class MyRecipe(BaseRecipe):
+ m1 = HostReq()
+
+ Args:
+ kwargs -- any other arguments will be treated as arbitrary string
+ parameters that will be matched to parameters of Slave machines
+ which can define their parameter values based on the implementation
+ of the SlaveMachineParser
+ """
+ def __init__(self, **kwargs):
+ self.params = Parameters()
+ for name, val in kwargs.items():
+ if name == "params":
+ raise RequirementError("'params' is a reserved
keyword.")
+ p = Param()
+ p.val = val
+ setattr(self.params, name, p)
+
+ def __iter__(self):
+ for x in dir(self):
+ val = getattr(self, x)
+ if isinstance(val, DeviceReq):
+ yield (x, val)
+
+ def _to_dict(self):
+ res = {'interfaces': {}, 'params': {}}
+ for dev_id, dev in self:
+ res['interfaces'][dev_id] = dev._to_dict()
+ res['params'] = self.params._to_dict()
+ return res
+
+class DeviceReq(object):
+ """Specifies an Ethernet Device requirement
+
+ To define a Device requirement you assign a DeviceReq instance to a HostReq
+ instance in a BaseRecipe derived class.
+ Example:
+ class MyRecipe(BaseRecipe):
+ m1 = HostReq()
+ m1.eth0 = DeviceReq(label="net1")
+
+ Args:
+ label -- string value indicating the network the Device is connected to
+ kwargs -- any other arguments will be treated as arbitrary string
+ parameters that will be matched to parameters of Slave machines
+ which can define their parameter values based on the implementation
+ of the SlaveMachineParser
+ """
+ def __init__(self, label, **kwargs):
+ self.label = label
+ self.params = Parameters()
+ for name, val in kwargs.items():
+ if name == "params":
+ raise RequirementError("'params' is a reserved
keyword.")
+ p = Param()
+ p.val = val
+ setattr(self.params, name, p)
+
+ def _to_dict(self):
+ res = {'network': self.label,
+ 'params': self.params._to_dict()}
+ return res
+
+class _Requirements(object):
+ """Hosts a copy of requirements for a Recipe instance
+
+ Internally used class.
+ """
+ def _to_dict(self):
+ res = {}
+ for h_id, host in self:
+ res[h_id] = host._to_dict()
+ return res
+
+ def __iter__(self):
+ for x in dir(self):
+ val = getattr(self, x)
+ if isinstance(val, HostReq):
+ yield (x, val)
--
2.13.0