feat: flask app for local debugging (#30)

Author: GangGreenTemperTatum

.gitignore

@@ -86,4 +86,18 @@ release_notes.md
 
 # Development files
 
-dev/
+dev/
+
+# Python
+*.pyc
+__pycache__/
+*.pyo
+*.pyd
+*.pdb
+*.egg-info/
+*.egg
+*.whl
+*.py[cod]
+.venv/
+*.env
+*.venv/

tests/flask-options-app/Dockerfile

@@ -0,0 +1,12 @@
+FROM python:3.9-slim
+
+WORKDIR /app
+
+COPY requirements.txt requirements.txt
+RUN pip install --no-cache-dir -r requirements.txt
+
+COPY app.py app.py
+
+EXPOSE 5000
+
+CMD ["python", "app.py"]

tests/flask-options-app/README.md

@@ -0,0 +1,71 @@
+### Flask Options App
+
+This is a simple Flask application that demonstrates how to handle HTTP OPTIONS requests.
+It is designed to be run inside a Docker container and can be used for testing purposes.
+The app is configured to run on port 5000 inside the container and can be accessed on port 8081 on your localhost.
+
+- [Flask Options App](#flask-options-app)
+- [Testing the App](#testing-the-app)
+- [Accessing the App](#accessing-the-app)
+- [Stopping the App](#stopping-the-app)
+- [Testing HTTP OPTIONS Requests](#testing-http-options-requests)
+
+### Testing the App
+
+Navigate to the flask-options-app directory and execute the following commands:
+
+```bash
+docker build -t flask-options-app .
+docker run --rm -it -p 8081:5000 flask-options-app
+
+# If you want to run a shell inside the container for debugging:
+docker run -it -p 8081:5000 --entrypoint /bin/sh flask-options-app
+
+# If you want to run the app in the background:
+docker run -d -p 8081:5000 flask-options-app
+```
+
+This will build the Docker image and run the container, mapping port 5000 inside the container to port 8081 on your localhost.
+
+### Accessing the App
+
+Once the container is running, you can access the Flask app by navigating to [`http://localhost:8081/api/test`](http://localhost:8081/api/test) in your web browser.
+You should see the Flask app running and be able to interact with it.
+
+### Stopping the App
+
+To stop the app, you can either stop the container from your terminal or use `docker-compose down` if you are using Docker Compose.
+
+### Testing HTTP OPTIONS Requests
+
+You can test the app by sending a GET request to the `/api/test` endpoint. You can use tools like `curl`, Postman, or your web browser to do this.
+
+```bash
+curl -X GET http://localhost:8081/api/test \
+  -x http://127.0.0.1:9090 \
+  -k -v
+```
+
+```bash
+curl -X OPTIONS http://localhost:8081/api/test \
+  -x http://127.0.0.1:9090 \
+  -k -v
+```
+
+To find the traffic in Caido, you can use the following HTTQL query :
+
+```sql
+request.url == "http://localhost:8081/api/test"
+```
+
+Or:
+
+```sql
+request.url == "http://localhost:8081/api/test" and request.method == "OPTIONS"
+```
+
+Or:
+
+```sql
+request.url.path == "/api/test"
+```

tests/flask-options-app/app.py

@@ -0,0 +1,33 @@
+from flask import Flask, jsonify, make_response, request
+
+app = Flask(__name__)
+
+
+@app.route("/api/test", methods=["GET", "POST", "OPTIONS"])
+def test_endpoint():
+    if request.method == "OPTIONS":
+        response = make_response()
+        response.headers["Access-Control-Allow-Origin"] = "*"
+        response.headers["Access-Control-Allow-Methods"] = "GET, POST, OPTIONS"
+        response.headers["Access-Control-Allow-Headers"] = "Content-Type"
+        return response
+    elif request.method == "GET":
+        return jsonify({"message": "GET request received"})
+    elif request.method == "POST":
+        data = request.get_json()
+        return jsonify({"message": "POST request received", "data": data})
+
+
+# Add both Allow and Access-Control-Allow-Methods headers to all responses
+@app.after_request
+def add_allow_headers(response):
+    # Add standard Allow header (for non-CORS clients)
+    response.headers["Allow"] = "GET, POST, PUT, DELETE, OPTIONS"
+    return response
+
+
+# Add this section to run the server when the script is executed directly
+if __name__ == "__main__":
+    print("Starting Flask test server for MethodCheck on http://localhost:5000")
+    print("Available endpoint: http://localhost:5000/api/test")
+    app.run(host="0.0.0.0", port=5000, debug=True)

tests/flask-options-app/requirements.txt

@@ -0,0 +1,2 @@
+Flask==2.2.5
+Werkzeug==2.2.3