Bug fixes | POST multi-part has an updated API

Author: eshaan7

.gitignore

@@ -3,6 +3,7 @@ venv/
 virtualenv/
 __pycache__/
 app.py
+test.py
 build/
 dist/
 *.egg-info

docs/source/conf.py

@@ -26,7 +26,7 @@
 author = "Eshaan Bansal"
 
 # The full version, including alpha/beta/rc tags
-release = "1.4.0"
+release = "1.4.1"
 
 
 # -- General configuration ---------------------------------------------------

examples/custom_save_fn.py

@@ -24,12 +24,12 @@ def intercept_result(context, future: Future):
         with open(fname) as f:
             data = f.read()
         # 1. get current result object
-        res = future.result()
+        res = future.result()  # this returns a dictionary
         # 2. update the report variable,
         # you may update only these: report,error,status
-        res.report = data
+        res["report"] = data
         if context.get("force_success", False):
-            res.status = "success"
+            res["status"] = "success"
         # 3. set new result
         future._result = res
 

examples/multiple_files.py

@@ -1,6 +1,7 @@
 # system imports
 import requests
 import tempfile
+import json
 
 # web imports
 from flask import Flask
@@ -32,13 +33,16 @@ def test():
     ```
     """
     url = f"http://localhost:4000/cmd/{ENDPOINT}"
-    data = {"args": ["@inputfile", "@someotherfile"]}
+    # create and read dummy data from temporary files
     with tempfile.TemporaryFile() as fp:
         fp.write(b"Hello world!")
         fp.seek(0)
         f = fp.read()
-        files = {"inputfile": f, "someotherfile": f}
-    resp = requests.post(url=url, files=files, data=data)
+    # they key should be `request_json` only.
+    form_data = {"args": ["@inputfile", "@someotherfile"]}
+    req_data = {"request_json": json.dumps(form_data)}
+    req_files = {"inputfile": f, "someotherfile": f}
+    resp = requests.post(url=url, files=req_files, data=req_data)
     resp_data = resp.json()
     print(resp_data)
     key = resp_data["key"]

examples/run_script.py

@@ -16,6 +16,7 @@
 shell2http.register_command(endpoint="hacktheplanet", command_name="./fuxsocy.py")
 
 
+# Example route. Go to "/" to execute.
 @app.route("/")
 def test():
     """

examples/with_callback.py

@@ -21,6 +21,7 @@ def my_callback_fn(extra_callback_context, future: Future):
     print("[i] Process running ?:", future.running())
     print("[i] Process completed ?:", future.done())
     print("[+] Result: ", future.result())
+    # future.result() returns a dictionary
     print("[+] Context: ", extra_callback_context)
 
 

examples/with_signals.py

@@ -18,7 +18,7 @@
 # Signal Handling
 signal_handler = Namespace()
 my_signal = signal_handler.signal(f"on_{CMD}_complete")
-# ..or any other name of your choice,
+# ..or any other name of your choice
 
 
 @my_signal.connect

flask_shell2http/api.py

@@ -18,7 +18,7 @@
 from flask_executor.futures import Future
 
 # lib imports
-from .classes import RequestParser, Report, run_command
+from .classes import RequestParser, run_command
 from .helpers import get_logger
 
 
@@ -57,13 +57,12 @@ def get(self):
             self.executor.futures.pop(key)
 
             # if yes, get result from store
-            report: Report = future.result()
+            report: Dict = future.result()
             if not report:
                 raise Exception(f"Job: '{key}' --> No report exists.")
 
-            resp = report.to_dict()
-            logger.debug(f"Job: '{key}' --> Requested report: {resp}")
-            return make_response(jsonify(resp), HTTPStatus.OK)
+            logger.debug(f"Job: '{key}' --> Requested report: {report}")
+            return jsonify(report)
 
         except Exception as e:
             logger.error(e)

flask_shell2http/classes.py

@@ -1,15 +1,14 @@
 # system imports
 import time
+import json
 import subprocess
 import tempfile
 import shutil
-import dataclasses
-from typing import List, Dict, Any
+from typing import List, Dict
 
 # web imports
 from flask.helpers import safe_join
 from werkzeug.utils import secure_filename
-from http import HTTPStatus
 from flask_executor.futures import Future
 
 # lib imports
@@ -18,30 +17,7 @@
 logger = get_logger()
 
 
-@dataclasses.dataclass
-class Report:
-    """
-    Report dataclass to store the command's result.
-    Internal use only.
-    """
-
-    key: str
-    report: Any
-    error: Any
-    status: str
-    start_time: float
-    end_time: float
-    returncode: int
-    process_time: float = dataclasses.field(init=False)
-
-    def __post_init__(self):
-        self.process_time = self.end_time - self.start_time
-
-    def to_dict(self):
-        return dataclasses.asdict(self)
-
-
-def run_command(cmd: List[str], timeout: int, key: str) -> Report:
+def run_command(cmd: List[str], timeout: int, key: str) -> Dict:
     """
     This function is called by the executor to run given command
     using a subprocess asynchronously.
@@ -53,7 +29,7 @@ def run_command(cmd: List[str], timeout: int, key: str) -> Report:
     :param timeout: int
         maximum timeout in seconds (default = 3600)
 
-    :rtype Report
+    :rtype: Dict
 
     :returns:
         A Concurrent.Future object where future.result() is the report
@@ -85,14 +61,17 @@ def run_command(cmd: List[str], timeout: int, key: str) -> Report:
         stderr = str(e)
         logger.error(f"Job: '{key}' --> failed. Reason: \"{stderr}\".")
 
-    return Report(
+    end_time: float = time.time()
+    process_time = end_time - start_time
+    return dict(
         key=key,
         report=stdout,
         error=stderr,
         status=status,
-        start_time=start_time,
-        end_time=time.time(),
         returncode=returncode,
+        start_time=start_time,
+        end_time=end_time,
+        process_time=process_time,
     )
 
 
@@ -115,18 +94,14 @@ def __parse_multipart_req(args: List[str], files) -> (List[str], str):
         if not fnames:
             raise Exception(
                 "No filename(s) specified."
-                "Please prefix file argument(s) with @ character.",
-                HTTPStatus.BAD_REQUEST,
+                "Please prefix file argument(s) with @ character."
             )
 
         # create a new temporary directory
         tmpdir: str = tempfile.mkdtemp()
         for fname in fnames:
             if fname not in files:
-                raise Exception(
-                    f"No File part with filename: {fname} in request.",
-                    HTTPStatus.BAD_REQUEST,
-                )
+                raise Exception(f"No File part with filename: {fname} in request.")
             req_file = files.get(fname)
             filename = secure_filename(req_file.filename)
             # calc file location
@@ -152,10 +127,11 @@ def parse_req(self, request, base_command: str) -> (str, int, Dict, str):
             timeout: int = request.json.get("timeout", DEFAULT_TIMEOUT)
             callback_context = request.json.get("callback_context", {})
         elif request.files:
-            # request contains file
-            callback_context = request.form.get("callback_context", {})
-            received_args = request.form.getlist("args")
-            timeout: int = request.form.get("timeout", DEFAULT_TIMEOUT)
+            # request contains file and form_data
+            data = json.loads(request.form.get("request_json", "{}"))
+            received_args = data.get("args", [])
+            timeout: int = data.get("timeout", DEFAULT_TIMEOUT)
+            callback_context = data.get("callback_context", {})
             args, tmpdir = RequestParser.__parse_multipart_req(
                 received_args, request.files
             )
@@ -169,7 +145,9 @@ def parse_req(self, request, base_command: str) -> (str, int, Dict, str):
         return cmd, timeout, callback_context, key
 
     def cleanup_temp_dir(self, future: Future) -> None:
-        key: str = future.result().key
+        key: str = future.result().get("key", None)
+        if not key:
+            return None
         tmpdir: str = self.__tmpdirs.get(key, None)
         if not tmpdir:
             return None

setup.py

@@ -17,7 +17,7 @@
 
 setup(
     name="Flask-Shell2HTTP",
-    version="1.4.0",
+    version="1.4.1",
     url=GITHUB_URL,
     license="BSD",
     author="Eshaan Bansal",