page-intex (#13)

* page index * deepsource * style: format code with Black and isort This commit fixes the style issues introduced in b2ad53e according to the output from Black and isort. Details: #13 * 100% * style: format code with Black and isort This commit fixes the style issues introduced in 6eded52 according to the output from Black and isort. Details: #13 * 100% * security * security 2 --------- Co-authored-by: Heitor Polidoro <[email protected]> Co-authored-by: deepsource-autofix[bot] <62050782+deepsource-autofix[bot]@users.noreply.github.com>
heitorpolidoro · Jan 16, 2024 · 308c5ea · 308c5ea
1 parent d00c324
commit 308c5ea
Show file tree

Hide file tree

Showing 8 changed files with 84 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,5 @@
 <div align="center">
-<img src="img/bartholomew-logo.png" width="200" height="200">
+<img src="static/bartholomew-logo.png" width="200" height="200">
 </div>
 
 # Bartholomew "The Butler" Smith

diff --git a/src/app.py → app.py b/src/app.py → app.py
@@ -2,8 +2,9 @@
 import os
 import sys
 
+import markdown
 import sentry_sdk
-from flask import Flask
+from flask import Flask, abort, render_template
 from githubapp import webhook_handler
 from githubapp.events import CheckSuiteRequestedEvent
 
@@ -36,7 +37,7 @@ def sentry_init():
 
 app = Flask(__name__)
 sentry_init()
-webhook_handler.handle_with_flask(app)
+webhook_handler.handle_with_flask(app, use_default_index=False)
 
 
 @webhook_handler.webhook_handler(CheckSuiteRequestedEvent)
@@ -47,3 +48,24 @@ def handle(event: CheckSuiteRequestedEvent):
  """
  repository = event.repository
  handle_create_pull_request(repository, event.check_suite.head_branch)
+
+
+@app.route("/", methods=["GET"])
+def index():
+ """Return the index homepage"""
+ return file("README.md")
+
+
+@app.route("/<path:filename>", methods=["GET"])
+def file(filename):
+ """Convert a md file into HTML and return it"""
+ allowed_files = {f: f for f in ["README.md", "pull-request.md"]}
+ if filename not in allowed_files:
+ abort(404)
+ with open(allowed_files[filename]) as f:
+ md = f.read()
+ body = markdown.markdown(md)
+ title = "Bartholomew Smith"
+ if filename != "README.md":
+ title += f" - {filename.replace('-', ' ').replace('.md', '').title()}"
+ return render_template("index.html", title=title, body=body)
diff --git a/requirements.txt b/requirements.txt
@@ -2,3 +2,4 @@ github-app-handler==0.15
 sentry-sdk==1.39.2
 flask==3.0.0
 Polidoro-PyGithub==2.2.0
+Markdown==3.5.2
diff --git a/img/bartholomew-logo.png → static/bartholomew-logo.png b/img/bartholomew-logo.png → static/bartholomew-logo.png
diff --git a/static/favicon.ico b/static/favicon.ico
diff --git a/templates/index.html b/templates/index.html
@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<link rel="shortcut icon" href="../static/favicon.ico" type="image/x-icon">
+<link rel="icon" href="../static/favicon.ico" type="image/x-icon">
+
+<html lang="en">
+<head>
+ <meta charset="UTF-8">
+ <title>{{ title }}</title>
+</head>
+<body>
+{{ body|safe }}
+</body>
+</html>
diff --git a/tests/test_app.py b/tests/test_app.py
@@ -1,11 +1,14 @@
+from unittest import TestCase
 from unittest.mock import patch
 
-from src.app import handle, sentry_init
+import markdown
+
+from app import app, handle, sentry_init
 
 
 def test_sentry_init(monkeypatch):
  monkeypatch.setenv("SENTRY_DSN", "https://example.com")
- with patch("src.app.sentry_sdk") as mock_sentry:
+ with patch("app.sentry_sdk") as mock_sentry:
  sentry_init()
  mock_sentry.init.assert_called_once_with(
  dsn="https://example.com",
@@ -15,14 +18,48 @@ def test_sentry_init(monkeypatch):
 
 
 def test_sentry_dont_init(monkeypatch):
- with patch("src.app.sentry_sdk") as mock_sentry:
+ with patch("app.sentry_sdk") as mock_sentry:
  sentry_init()
  mock_sentry.init.assert_not_called()
 
 
-def test_handle_check_suite_requested(event):
- with patch("src.app.handle_create_pull_request") as mock_handle_create_pull_request:
+def test_handle_check_suite_requested(event, repository):
+ with patch("app.handle_create_pull_request") as mock_handle_create_pull_request:
  handle(event)
  mock_handle_create_pull_request.assert_called_once_with(
- event.repository, event.check_suite.head_branch
+ repository, event.check_suite.head_branch
  )
+
+
+class TestApp(TestCase):
+ def setUp(self):
+ self.app = app
+ self.client = app.test_client()
+
+ def test_index(self):
+ with patch("app.render_template") as mock_render_template:
+ response = self.client.get("/")
+ assert response.status_code == 200
+ with open("README.md") as f:
+ md = f.read()
+ body = markdown.markdown(md)
+ mock_render_template.assert_called_once_with(
+ "index.html", title="Bartholomew Smith", body=body
+ )
+
+ def test_file(self):
+ with patch("app.render_template") as mock_render_template:
+ response = self.client.get("/pull-request.md")
+ assert response.status_code == 200
+ with open("pull-request.md") as f:
+ md = f.read()
+ body = markdown.markdown(md)
+ mock_render_template.assert_called_once_with(
+ "index.html", title="Bartholomew Smith - Pull Request", body=body
+ )
+
+ def test_file_security(self):
+ with patch("app.render_template") as mock_render_template:
+ response = self.client.get("/other.txt")
+ assert response.status_code == 404
+ mock_render_template.assert_not_called()
diff --git a/vercel.json b/vercel.json
@@ -1,13 +1,13 @@
 {
  "version": 2,
  "builds": [
- {"src": "src/app.py",
+ {"src": "app.py",
  "use": "@vercel/python"
  }
  ],
  "routes": [
  {"src": "/.*",
- "dest": "src/app.py"
+ "dest": "app.py"
  }
  ]
 }