update to python 3.7 + add tests

Author: mikespub

.gitignore

@@ -0,0 +1,116 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/

Dockerfile

@@ -1,5 +1,5 @@
-FROM python:2.7-alpine
-MAINTAINER "Matjaž Finžgar" <matjaz@finzgar.net>
+FROM python:3.7-alpine
+#FROM python:3.7-slim
 
 WORKDIR /app
 
@@ -9,4 +9,4 @@ RUN pip install -r requirements.txt
 COPY . /app
 
 EXPOSE 5000
-CMD ["python", "webhooks.py"]
+CMD ["python3", "webhooks.py"]

README.rst

@@ -230,9 +230,10 @@ License
 Credits
 =======
 
-This project is just the reinterpretation and merge of two approaches:
+This project is just the reinterpretation and merge of two approaches and a modification of Carlos Jenkins' work:
 
 - `github-webhook-wrapper <https://github.com/datafolklabs/github-webhook-wrapper>`_.
 - `flask-github-webhook <https://github.com/razius/flask-github-webhook>`_.
+- `python-github-webhooks <https://github.com/carlos-jenkins/python-github-webhooks>`_.
 
 Thanks.

requirements.txt

@@ -1,3 +1,3 @@
-Flask==0.12.2
-ipaddress==1.0.18
-requests==2.18.2
+Flask==1.0.2
+ipaddress==1.0.22
+requests==2.21.0

tests/test_webhooks.py

@@ -0,0 +1,38 @@
+import unittest
+import os
+import sys
+# import pytest
+
+sys.path.append(os.path.dirname(os.path.dirname(__file__)))
+from webhooks import application as app
+
+
+class WebhooksTest(unittest.TestCase):
+
+    def setUp(self):
+        app.config['TESTING'] = True
+        self.app = app.test_client()
+        self.output = False
+
+    def show_response(self, response):
+        if not self.output:
+            return
+        print('Status Code: %s' % response.status_code)
+        print(response.headers)
+        print(response.data)
+
+    def test_unit_get(self):
+        response = self.app.get('/')
+        self.show_response(response)
+        self.assertEqual(response.status_code, 405)
+
+    def test_unit_post(self):
+        response = self.app.post('/')
+        self.show_response(response)
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.data, b'{"msg": "pong"}')
+
+    def test_unit_notfound(self):
+        response = self.app.get('/notfound')
+        self.show_response(response)
+        self.assertEqual(response.status_code, 404)

webhooks.py

@@ -14,13 +14,10 @@
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-
 import logging
 from sys import stderr, hexversion
-logging.basicConfig(stream=stderr)
 
 import hmac
-from hashlib import sha1
 from json import loads, dumps
 from subprocess import Popen, PIPE
 from tempfile import mkstemp
@@ -31,6 +28,7 @@
 from ipaddress import ip_address, ip_network
 from flask import Flask, request, abort
 
+logging.basicConfig(stream=stderr)
 
 application = Flask(__name__)
 
@@ -43,13 +41,22 @@ def index():
 
     path = normpath(abspath(dirname(__file__)))
 
-    # Only POST is implemented
+    # Only POST is implemented - same effect as removing 'GET' in methods above
     if request.method != 'POST':
-        abort(501)
+        abort(405)
 
     # Load config
-    with open(join(path, 'config.json'), 'r') as cfg:
-        config = loads(cfg.read())
+    if isfile(join(path, 'config.json')):
+        with open(join(path, 'config.json'), 'r') as cfg:
+            config = loads(cfg.read())
+    else:
+        # abort(503, 'Configuration file config.json is missing.')
+        config = {
+            "github_ips_only": False,
+            "enforce_secret": "",
+            "return_scripts_info": False,
+            "hooks_path": "/missing"
+        }
 
     hooks = config.get('hooks_path', join(path, 'hooks'))