add httpbin extension (#25)

Author: thrau

httpbin/Makefile

@@ -0,0 +1,39 @@
+VENV_BIN = python3 -m venv
+VENV_DIR ?= .venv
+VENV_ACTIVATE = $(VENV_DIR)/bin/activate
+VENV_RUN = . $(VENV_ACTIVATE)
+
+venv: $(VENV_ACTIVATE)
+
+$(VENV_ACTIVATE): setup.py setup.cfg
+	test -d .venv || $(VENV_BIN) .venv
+	$(VENV_RUN); pip install --upgrade pip setuptools plux wheel
+	$(VENV_RUN); pip install --upgrade black isort pyproject-flake8 flake8-black flake8-isort
+	$(VENV_RUN); pip install -e .
+	touch $(VENV_DIR)/bin/activate
+
+clean:
+	rm -rf .venv/
+	rm -rf build/
+	rm -rf .eggs/
+	rm -rf *.egg-info/
+
+lint: venv
+	$(VENV_RUN); python -m pflake8 --show-source
+
+format: venv
+	$(VENV_RUN); python -m isort .; python -m black .
+
+install: venv
+	$(VENV_RUN); python setup.py develop
+
+dist: venv
+	$(VENV_RUN); python setup.py sdist bdist_wheel
+
+publish: clean-dist venv dist
+	$(VENV_RUN); pip install --upgrade twine; twine upload dist/*
+
+clean-dist: clean
+	rm -rf dist/
+
+.PHONY: clean clean-dist dist install publish

httpbin/README.md

@@ -0,0 +1,57 @@
+LocalStack httpbin extension
+===============================
+
+A simple HTTP Request & Response Service directly in LocalStack
+using [httpbin](https://github.com/postmanlabs/httpbin).
+Get the full httpbin experience directly in LocalStack without connecting to httpbin.org!
+
+The httpbin API is served through the hostname `http://httpbin.localhost.localstack.cloud:4566`.
+
+## Install
+
+Install the extension by running:
+
+```bash
+localstack extensions install localstack-extension-httpbin
+```
+
+## Usage
+
+Opening http://httpbin.localhost.localstack.cloud:4566 in the browser will show you the flasgger UI:
+![Screenshot at 2023-07-27 14-33-03](https://github.com/localstack/localstack-extensions/assets/3996682/68442f91-13b8-4308-8f04-966340cff082)
+
+And you can call the API endpoints just as you would httpbin.org.
+![Screenshot at 2023-07-27 14-34-15](https://github.com/localstack/localstack-extensions/assets/3996682/bebe444a-d6f9-4953-87ef-cca79daa00e8)
+
+## Development
+
+### Install local development version
+
+To install the extension into localstack in developer mode, you will need Python 3.10, and create a virtual
+environment in the extensions project.
+
+In the newly generated project, simply run
+
+```bash
+make install
+```
+
+Then, to enable the extension for LocalStack, run
+
+```bash
+localstack extensions dev enable .
+```
+
+You can then start LocalStack with `EXTENSION_DEV_MODE=1` to load all enabled extensions:
+
+```bash
+EXTENSION_DEV_MODE=1 localstack start
+```
+
+## Licensing
+
+* httpbin is licensed under the ISC license: https://github.com/postmanlabs/httpbin/blob/master/LICENSE
+* The httpbin source code is vendored with this extension, slight modifications were made to make it
+  compatible with the latest Python and Werkzeug version.
+  The modifications retain the ISC license
+* The extension code is licensed under the Apache 2.0 License

httpbin/localstack_httpbin/__init__.py

@@ -0,0 +1 @@
+name = "localstack_httpbin"

httpbin/localstack_httpbin/extension.py

@@ -0,0 +1,52 @@
+import logging
+from typing import Optional
+
+from localstack import config, constants
+from localstack.config import get_edge_url
+from localstack.extensions.api import Extension, http
+from localstack.utils.net import get_free_tcp_port
+
+from localstack_httpbin.server import HttpbinServer
+
+LOG = logging.getLogger(__name__)
+
+
+class HttpbinExtension(Extension):
+    name = "httpbin"
+
+    hostname_prefix = "httpbin."
+
+    server: Optional[HttpbinServer]
+
+    def __init__(self):
+        self.server = None
+
+    def on_extension_load(self):
+        level = logging.DEBUG if config.DEBUG else logging.INFO
+        logging.getLogger("localstack_httpbin").setLevel(level=level)
+        logging.getLogger("httpbin").setLevel(level=level)
+
+    def on_platform_start(self):
+        from localstack_httpbin.vendor.httpbin import core
+        core.template['host'] = f"{self.get_public_hostname()}:{config.get_edge_port_http()}"
+
+        self.server = HttpbinServer(get_free_tcp_port())
+        LOG.debug("starting httpbin on %s", self.server.url)
+        self.server.start()
+
+    def get_public_hostname(self) -> str:
+        # FIXME: reconcile with LOCALSTACK_HOST, but this should be accessible via the host
+        return  f"{self.hostname_prefix}{constants.LOCALHOST_HOSTNAME}"
+
+    def on_platform_ready(self):
+        LOG.info("Serving httpbin on %s", get_edge_url(localstack_hostname=self.get_public_hostname()))
+
+    def on_platform_shutdown(self):
+        if self.server:
+            self.server.shutdown()
+
+    def update_gateway_routes(self, router: http.Router[http.RouteHandler]):
+        endpoint = http.ProxyHandler(forward_base_url=self.server.url)
+
+        router.add("/", host=f"{self.hostname_prefix}<host>", endpoint=endpoint)
+        router.add("/<path:path>", host=f"{self.hostname_prefix}<host>", endpoint=endpoint)

httpbin/localstack_httpbin/server.py

@@ -0,0 +1,27 @@
+import logging
+
+from localstack.utils.run import ShellCommandThread
+from localstack.utils.serving import Server
+from localstack.utils.threads import TMP_THREADS
+
+
+class HttpbinServer(Server):
+    logger = logging.getLogger("httpbin")
+
+    def do_start_thread(self):
+        thread = ShellCommandThread(
+            [
+                "/opt/code/localstack/.venv/bin/python",
+                "-m",
+                "localstack_httpbin.vendor.httpbin.core",
+                "--port",
+                str(self.port),
+            ],
+            log_listener=self._log_listener,
+        )
+        TMP_THREADS.append(thread)
+        thread.start()
+        return thread
+
+    def _log_listener(self, line, **_kwargs):
+        self.logger.debug(line.rstrip())

httpbin/localstack_httpbin/vendor/__init__.py

@@ -0,0 +1 @@
+"""Vendored libraries"""

httpbin/localstack_httpbin/vendor/httpbin/__init__.py

@@ -0,0 +1,3 @@
+# -*- coding: utf-8 -*-
+
+from .core import *