🐛 fix: add run_async behaviour for device

Author: guptadev21

.gitignore

@@ -15,3 +15,5 @@ sdk_test/package_info.json
 config.json
 venv/
 htmlcov/
+ignore
+.vscode

rapyuta_io/clients/device.py

@@ -568,8 +568,9 @@ def execute_command(self, command, retry_limit=0):
         if response.status_code == requests.codes.BAD_REQUEST:
             raise ParameterMissingException(get_error(response.text))
         execution_result = get_api_response_data(response)
-        if not command.bg:
-            return execution_result[self.uuid]
+        if not command.run_async:
+            return execution_result 
+        
         jid = execution_result.get('jid')
         if not jid:
             raise ValueError("Job ID not found in the response")

rapyuta_io/clients/device_manager.py

@@ -178,7 +178,7 @@ def execute_command(
 
         execution_result = get_api_response_data(response)
 
-        if not command.bg:
+        if not command.run_async:
             return execution_result
 
         jid = execution_result.get('jid')

rapyuta_io/clients/model.py

@@ -52,6 +52,7 @@ class Command(ObjDict):
     :ivar shell: Represents the shell where it is going to execute
     :ivar env: List of environment variables.
     :ivar bg: Boolean value specifying whether the execution runs on the background or not
+    :ivar run_async: Boolean value to specify to run command in async mode i.e., to run command and return its jid (not depending on completion of the command).
     :ivar runas: Run the command as a specific user
     :ivar cmd: Command to execute on the device
     :ivar pwd: Present working directory
@@ -61,14 +62,15 @@ class Command(ObjDict):
 
     """
 
-    def __init__(self, cmd, shell=None, env=None, bg=False, runas=None, pwd=None, cwd=None, timeout=300):
+    def __init__(self, cmd, shell=None, env=None, bg=False, run_async=False, runas=None, pwd=None, cwd=None, timeout=300):
         super(ObjDict, self).__init__()
         if env is None:
             env = dict()
         self.cmd = cmd
         self.shell = shell
         self.env = env
         self.bg = bg
+        self.run_async = run_async
         self.runas = runas
         self.cwd = pwd
         if cwd is not None:
@@ -83,6 +85,8 @@ def validate(self):
             raise InvalidCommandException("Invalid shell")
         if self.bg is not None and not isinstance(self.bg, bool):
             raise InvalidCommandException("Invalid background option")
+        if self.run_async is not None and not isinstance(self.run_async, bool):
+            raise InvalidCommandException("Invalid run asynchronous option")
         if self.runas is not None and not isinstance(self.runas, six.string_types):
             raise InvalidCommandException("Invalid runas option")
         if self.cwd is not None and not isinstance(self.cwd, six.string_types):

tests/device_test.py

@@ -21,7 +21,7 @@
 from rapyuta_io.utils import ObjDict, InvalidCommandException
 from tests.utils.client import get_client, headers
 from tests.utils.device_respones import DEVICE_LIST, DEVICE_INFO, DEVICE_LIST_EMPTY, \
-    DEVICE_NOT_FOUND, EXECUTE_COMMAND_BAD_REQUEST, EXECUTE_COMMAND_OK, DELETE_DEVICE_BAD_REQUEST, \
+    DEVICE_NOT_FOUND, EXECUTE_COMMAND_BAD_REQUEST, EXECUTE_COMMAND_OK, EXECUTE_COMMAND_OK_BG, DELETE_DEVICE_BAD_REQUEST, \
     DELETE_DEVICE_OK, UPDATE_DEVICE_BAD_REQUEST, UPDATE_DEVICE_OK, DEVICE_SELECTION, APPLY_PARAMETERS_SUCCESS_RESPONSE, \
     CREATE_DIRECT_LINK_SUCCESS_RESPONSE, CREATE_DOCKERCOMPOSE_DEVICE_SUCCESS, GET_DOCKERCOMPOSE_DEVICE_SUCCESS, \
     CREATE_PREINSTALLED_DEVICE_SUCCESS, GET_PREINSTALLED_DEVICE_SUCCESS, UPGRADE_DOCKERCOMPOSE_DEVICE_SUCCESS, \
@@ -276,8 +276,31 @@ def test_execute_command_ok(self, mock_execute, get_device_response):
         command.cwd = ''
         result = device.execute_command(command)
         self.assertEqual(mock_execute.call_count, 2)
-        expected = 'Linux rapyuta 4.9.80-v7+ #1098 SMP Fri Mar 9         19:11:42 GMT2018 armv7l ' \
-                   'armv7l armv7l GNU/Linux'
+        expected = {'test_device_id':'Linux rapyuta 4.9.80-v7+ #1098 SMP Fri Mar 9         19:11:42 GMT2018 armv7l ' \
+                   'armv7l armv7l GNU/Linux'}
+        self.assertEqual(result, expected)
+
+    @patch('requests.Response', spec=Response)
+    @patch('rapyuta_io.utils.rest_client.RestClient.execute')
+    def test_execute_command_ok_background(self, mock_execute, get_device_response):
+        get_device_response.text = DEVICE_INFO
+        get_device_response.status_code = requests.codes.OK
+        execute_command_response = get_device_response()
+        execute_command_response.text = EXECUTE_COMMAND_OK_BG
+        execute_command_response.status_code = requests.codes.OK
+        mock_execute.side_effect = [get_device_response, execute_command_response]
+        mock_execute.return_value = get_device_response
+        client = get_client()
+        device = client.get_device('test_device_id')
+        self.assertIsInstance(device, Device, 'Object should be an instance of class Device')
+        command = Command('uname -a')
+        command.shell = '/bin/bash'
+        command.bg = True
+        command.runas = 'root'
+        command.cwd = ''
+        result = device.execute_command(command)
+        self.assertEqual(mock_execute.call_count, 2)
+        expected = {'test_device_id':'SUCCESS'}
         self.assertEqual(result, expected)
 
     def test_execute_command_invalid_parameters(self):
@@ -300,6 +323,12 @@ def test_execute_command_invalid_parameters(self):
                 'value': 'true',
                 'correct_value': False
             },
+            {
+                'response': 'Invalid run asynchronous option',
+                'key': 'run_async',
+                'value': 'true',
+                'correct_value': False
+            },
             {
                 'response': 'Invalid runas option',
                 'key': 'runas',

tests/utils/device_respones.py

@@ -523,6 +523,11 @@
         "data": { "test_device_id":  "Linux rapyuta 4.9.80-v7+ #1098 SMP Fri Mar 9\
          19:11:42 GMT2018 armv7l armv7l armv7l GNU/Linux" } } } '''
 
+EXECUTE_COMMAND_OK_BG = ''' {
+    "status": "success",
+    "response": {
+        "data": { "test_device_id":  "SUCCESS" } } } '''
+
 EXECUTE_COMMAND_BAD_REQUEST = ''' {
             "status": "error",
             "response": { "data": {}, "error": "device_ids parameter missing" } } '''