feat: return runtime versions used by the application with a doctor hook (#35)

Co-authored-by: William Bergamin <wbergamin@salesforce.com>

Author: zimeg

README.md

@@ -33,11 +33,12 @@ The CLI will always use the version of the `python-slack-hooks` that is specifie
 
 ### Supported Hooks
 
-The hooks currently supported for use within the Slack CLI include `check-update`, `get-hooks`, `get-manifest`, and `start`:
+The hooks currently supported for use within the Slack CLI include `check-update`, `doctor`, `get-hooks`, `get-manifest`, and `start`:
 
 | Hook Name  | CLI Command  | File  |  Description  |
 | --- | --- | --- | --- |
 | `check-update` | `slack update` | [check_update.py](./slack_cli_hooks/hooks/check_update.py) | Checks the project's Slack dependencies to determine whether or not any libraries need to be updated. |
+| `doctor` | `slack doctor` | [doctor.py](./slack_cli_hooks/hooks/doctor.py) | Returns runtime versions and other system dependencies required by the application. |
 | `get-hooks` | All | [get_hooks.py](./slack_cli_hooks/hooks/get_hooks.py) | Fetches the list of available hooks for the CLI from this repository. |
 | `get-manifest` | `slack manifest` | [get_manifest.py](./slack_cli_hooks/hooks/get_manifest.py) | Converts a `manifest.json` file into a valid manifest JSON payload. |
 | `start` | `slack run` | [start.py](./slack_cli_hooks/hooks/start.py) | While developing locally, the CLI manages a socket connection with Slack's backend and utilizes this hook for events received via this connection. |

slack_cli_hooks/hooks/doctor.py

@@ -0,0 +1,32 @@
+#!/usr/bin/env python
+import json
+import platform
+
+from slack_cli_hooks.protocol import (
+    Protocol,
+    build_protocol,
+)
+
+PROTOCOL: Protocol
+
+
+doctor_payload = {
+    "versions": [
+        {
+            "name": "python",
+            "current": platform.python_version(),
+        },
+        {
+            "name": "implementation",
+            "current": platform.python_implementation(),
+        },
+        {
+            "name": "compiler",
+            "current": platform.python_compiler(),
+        },
+    ],
+}
+
+if __name__ == "__main__":
+    PROTOCOL = build_protocol()
+    PROTOCOL.respond(json.dumps(doctor_payload))

slack_cli_hooks/hooks/get_hooks.py

@@ -16,6 +16,7 @@
         "get-manifest": f"{EXEC} -m slack_cli_hooks.hooks.get_manifest",
         "start": f"{EXEC} -X dev -m slack_cli_hooks.hooks.start",
         "check-update": f"{EXEC} -m slack_cli_hooks.hooks.check_update",
+        "doctor": f"{EXEC} -m slack_cli_hooks.hooks.doctor",
     },
     "config": {
         "watch": {"filter-regex": "(^manifest\\.json$)", "paths": ["."]},

tests/slack_cli_hooks/hooks/test_doctor.py

@@ -0,0 +1,16 @@
+import platform
+
+from slack_cli_hooks.hooks.doctor import doctor_payload
+
+
+class TestDoctor:
+    def test_versions(self):
+        versions = doctor_payload.get("versions")
+        assert versions is not None
+
+        assert versions[0].get("name") == "python"
+        assert versions[0].get("current") == platform.python_version()
+        assert versions[1].get("name") == "implementation"
+        assert versions[1].get("current") == platform.python_implementation()
+        assert versions[2].get("name") == "compiler"
+        assert versions[2].get("current") == platform.python_compiler()

tests/slack_cli_hooks/hooks/test_get_hooks.py

@@ -9,6 +9,7 @@ def test_hooks_payload(self):
         assert "slack_cli_hooks.hooks.get_manifest" in hooks["get-manifest"]
         assert "slack_cli_hooks.hooks.start" in hooks["start"]
         assert "slack_cli_hooks.hooks.check_update" in hooks["check-update"]
+        assert "slack_cli_hooks.hooks.doctor" in hooks["doctor"]
 
     def test_hooks_payload_config(self):
         config = hooks_payload["config"]