Add UI parameter type helper for "Yes" and "No" boolean values

The iSCSI RFC defines boolean values as "Yes" and "No" and the LIO
iSCSI target follows this convention to store boolean iSCSI session
parameters (e.g. ImmediateData=Yes). So it makes sense to have a
dedicated helper to validate them in targetcli.

Signed-off-by: Christophe Vu-Brugier <cvubrugier@fastmail.fm>

1 files changed, 23 insertions, 0 deletions

diff --git a/targetcli/ui_node.py b/targetcli/ui_node.py
index 5abfd7f..883fb4d 100644
--- a/targetcli/ui_node.py
+++ b/targetcli/ui_node.py
@@ -101,6 +101,29 @@ class UINode(ConfigNode):
         ConfigNode.ui_setgroup_global(self, parameter, value)
         self.get_root().refresh()
 
+    def ui_type_yesno(self, value=None, enum=False, reverse=False):
+        '''
+        UI parameter type helper for "Yes" and "No" boolean values.
+        "Yes" and "No" are used for boolean iSCSI session parameters.
+        '''
+        if reverse:
+            if value is not None:
+                return value
+            else:
+                return 'n/a'
+        type_enum = ('Yes', 'No')
+        syntax = '|'.join(type_enum)
+        if value is None:
+            if enum:
+                return enum_type
+            else:
+                return syntax
+        elif value in type_enum:
+            return value
+        else:
+            raise ValueError("Syntax error, '%s' is not %s."
+                             % (value, syntax))
+
 
 class UIRTSLibNode(UINode):
     '''