Add execute script methods to ActionButton

Author: tynanford

phoebusgen/widget/properties.py

@@ -709,7 +709,7 @@ def stretch_to_fit(self, val: bool) -> None:
         self._shared.boolean_property(self.root, 'stretch_image', val)
 
 class _Actions(object):
-    def _add_action(self, action_type, description, args, macros=None):
+    def _add_action(self, action_type, description, args, isScript, macros=None):
         root_action = self.root.find('actions')
         if root_action is None:
             root_action = SubElement(self.root, 'actions')
@@ -723,9 +723,16 @@ def _add_action(self, action_type, description, args, macros=None):
             else:
                 for key, val in macros.items():
                     self._shared.add_macro(key, val, action)
-        for arg, val in args.items():
-            sub = SubElement(action, arg)
-            sub.text = str(val)
+        if isScript:
+            script_element = SubElement(action, 'script')
+            script_element.attrib['file'] = args['file']
+            if args.get('script') is not None:
+                text_element = SubElement(script_element, 'text')
+                text_element.text = args['script']
+        else:
+            for arg, val in args.items():
+                sub = SubElement(action, arg)
+                sub.text = str(val)
 
     def action_execute_as_one(self, val: bool) -> None:
         """
@@ -769,7 +776,7 @@ def action_open_display(self, file: str, target: str, description: str = None, m
             print('The macro parameter must be a dictionary with key=MacroName and val=MacroValue')
             return
         args = {'file': file, 'target': target.lower()}
-        self._add_action('open_display', description, args, macros)
+        self._add_action('open_display', description, args, False, macros)
 
     def action_write_pv(self, pv_name: str, value: Union[str, int, float], description: str = None) -> None:
         """
@@ -782,7 +789,7 @@ def action_write_pv(self, pv_name: str, value: Union[str, int, float], descripti
         if description is None:
             description = 'Write PV'
         args = {'pv_name': pv_name, 'value': value}
-        self._add_action('write_pv', description, args)
+        self._add_action('write_pv', description, args, False)
 
     def action_execute_command(self, command: str, description: str = None) -> None:
         """
@@ -794,7 +801,43 @@ def action_execute_command(self, command: str, description: str = None) -> None:
         if description is None:
             description = 'Execute Command'
         args = {'command': command}
-        self._add_action('command', description, args)
+        self._add_action('command', description, args, False)
+
+    def action_execute_python_script(self, script: str, description: str = None) -> None:
+        """
+        Add Execute Command action to widget. description is optional
+
+        :param script: Python script to execute as action
+        :param description: Description of action. Default is None
+        """
+        if description is None:
+            description = 'Execute Script'
+        args = {'file': 'EmbeddedPy', 'script': script}
+        self._add_action('execute', description, args, True)
+
+    def action_execute_javascript_script(self, script: str, description: str = None) -> None:
+        """
+        Add Execute Command action to widget. description is optional
+
+        :param script: Javascript code to execute as action
+        :param description: Description of action. Default is None
+        """
+        if description is None:
+            description = 'Execute Script'
+        args = {'file': 'EmbeddedJs', 'script': script}
+        self._add_action('execute', description, args, True)
+
+    def action_execute_external_script(self, file_name: str, description: str = None) -> None:
+        """
+        Add Execute Command action to widget. description is optional
+
+        :param file_name: External script file name
+        :param description: Description of action. Default is None
+        """
+        if description is None:
+            description = 'Execute Script'
+        args = {'file': file_name}
+        self._add_action('execute', description, args, True)
 
     def action_open_file(self, file: str, description: str = None) -> None:
         """
@@ -806,7 +849,7 @@ def action_open_file(self, file: str, description: str = None) -> None:
         if description is None:
             description = 'Open File'
         args = {'file': file}
-        self._add_action('open_file', description, args)
+        self._add_action('open_file', description, args, False)
 
     def action_open_webpage(self, url: str, description: str = None) -> None:
         """
@@ -818,7 +861,7 @@ def action_open_webpage(self, url: str, description: str = None) -> None:
         if description is None:
             description = 'Open Webpage'
         args = {'url': url}
-        self._add_action('open_webpage', description, args)
+        self._add_action('open_webpage', description, args, False)
 
 class _Label(object):
     def label(self, val: str) -> None:

tests/property_helpers.py

@@ -928,6 +928,24 @@ def action_test(self, action_type, desc, action_args, macros=None):
                         self.assertIsNotNone(mac)
                         self.assertEqual(v, mac.text)
 
+    def script_test(self, script_file, desc, script=None):
+        parent_element = self.element.find_element('actions')
+        self.assertTrue(len(parent_element) > 0)
+        foundIt = False
+        for parent in parent_element:
+            if parent.attrib == {'type': 'execute'}:
+                foundIt = True
+                description = parent.find('description')
+                self.assertEqual(description.text, desc)
+                script_element = parent.find('script')
+                self.assertIsNotNone(script_element)
+                self.assertEqual(script_file, script_element.attrib['file'])
+                if script_file == 'EmbeddedPy' or script_file == 'EmbeddedJs':
+                    text_element = script_element.find('text')
+                    self.assertIsNotNone(text_element)
+                    self.assertEqual(text_element.text, script)
+        self.assertTrue(foundIt);
+
     def test_execute_as_one(self):
         tag_name = 'actions'
         self.element.action_execute_as_one(True)
@@ -1002,6 +1020,35 @@ def test_open_webpage(self):
         self.element.action_open_webpage(url)
         self.action_test('open_webpage', 'Open Webpage', {'url': url})
 
+    def test_execute_python_script(self):
+        script = '''# Embedded python script
+from org.csstudio.display.builder.runtime.script import PVUtil, ScriptUtil
+print 'Hello'
+# widget.setPropertyValue('text', PVUtil.getString(pvs[0]))
+
+PVUtil.writePV("loc://test", 5, 1000)
+        '''
+        self.element.action_execute_python_script(script)
+        self.action_test('execute', 'Execute Script', {'script': None})
+        self.script_test('EmbeddedPy', 'Execute Script', script)
+
+    def test_execute_javascript_script(self):
+        script = '''/* Embedded javascript */
+importClass(org.csstudio.display.builder.runtime.script.PVUtil);
+importClass(org.csstudio.display.builder.runtime.script.ScriptUtil);
+logger = ScriptUtil.getLogger();
+logger.info("Hello");
+/* widget.setPropertyValue("text", PVUtil.getString(pvs[0])); */
+        '''
+        self.element.action_execute_javascript_script(script)
+        self.action_test('execute', 'Execute Script', {'script': None})
+        self.script_test('EmbeddedJs', 'Execute Script', script)
+
+    def test_execute_external_script(self):
+        file_name = 'test.py'
+        self.element.action_execute_external_script(file_name)
+        self.action_test('execute', 'Execute Script', {'script': None})
+        self.script_test(file_name, 'Execute Script')
 
 class TestHorizontal(GenericTest):
     def test_default(self):