diff --git a/.github/workflows/build-and-deploy.yml b/.github/workflows/build-and-deploy.yml deleted file mode 100644 index 700aea2..0000000 --- a/.github/workflows/build-and-deploy.yml +++ /dev/null @@ -1,31 +0,0 @@ ---- -name: Build and deploy images -on: - schedule: - # rebuild every 15th day of the month at 9:24 UTC - - cron: '24 9 15 * *' - push: - branches: - - main - - master - pull_request: - branches: - - main - - master - -permissions: - contents: read - packages: write - actions: read - -jobs: - build-images: - name: Build Docker images - runs-on: ubuntu-18.04 - steps: - - uses: actions/checkout@v2 - - id: build - uses: Seravo/actions/docker-build-and-release@main - name: Build image - with: - image: ghcr.io/seravo/flask:latest diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml new file mode 100644 index 0000000..ef194e4 --- /dev/null +++ b/.github/workflows/lint.yml @@ -0,0 +1,24 @@ +name: 'Lint Python code' + +on: [push, pull_request] + +jobs: + lint-python: + runs-on: ubuntu-latest + strategy: + matrix: + python_version: ['3.6', '3.8', '3.10'] + steps: + - name: Setup repository + uses: actions/checkout@v2 + + - name: Set up python ${{ matrix.python_version }} + uses: actions/setup-python@v2 + with: + python-version: ${{ matrix.python_version }} + + - name: Install essential tools + run: pip install flake8 + + - name: Run flake8 + run: flake8 diff --git a/Dockerfile b/Dockerfile index 3d02391..7234a85 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,45 +1,10 @@ -# This can be *any* Ubuntu/Debian base image with sufficient Python3 version -# available -FROM docker.io/ypcs/debian:bullseye +FROM ghcr.io/seravo/flask:latest ARG APT_PROXY -ENV APPDIR /app -ENV VEDIR /ve -ENV FLASK_APP hello:app - -RUN /usr/lib/docker-helpers/apt-setup && \ - /usr/lib/docker-helpers/apt-upgrade && \ - apt-get --assume-yes install \ - curl \ - entr \ - procps \ - python3 \ - python3-dev \ - python3-flask \ - python3-pip \ - python3-setuptools \ - python3-venv \ - python3-wheel \ - uwsgi \ - uwsgi-plugin-python3 && \ - /usr/lib/docker-helpers/apt-cleanup - -RUN mkdir -p "${APPDIR}" "${VEDIR}" - -RUN adduser --disabled-password --gecos "user,,," user && \ - chown user "${VEDIR}" +COPY requirements.txt /app/requirements.txt -COPY hello.py "${APPDIR}/hello.py" -COPY entrypoint.sh /entrypoint.sh +RUN pip install -r /app/requirements.txt -WORKDIR "${APPDIR}" -USER user - -RUN python3 -m venv --system-site-packages "${VEDIR}" && \ - echo 'export PATH="${VEDIR}:${PATH}"' >> /home/user/.profile - -ENTRYPOINT ["/entrypoint.sh"] - -HEALTHCHECK --interval=10s --timeout=5s --start-period=5s --retries=3 CMD curl -f http://localhost:8080/ || exit 1 -EXPOSE 8080/tcp +ENV FLASK_APP hello:app +COPY /app/ /app/ diff --git a/LICENSE b/LICENSE index 5c0bacf..261eeb9 100644 --- a/LICENSE +++ b/LICENSE @@ -1,21 +1,201 @@ -MIT License - -Copyright (c) 2019 Ville Korhonen - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/Makefile b/Makefile index b6da518..4f43442 100644 --- a/Makefile +++ b/Makefile @@ -1,10 +1,21 @@ APT_PROXY ?= DOCKER ?= docker +IMAGE ?= ypcs/FIXME:latest +CONTAINER ?= FIXME all: +clean: + $(DOCKER) rm -f "$(CONTAINER)" || : + build: - $(DOCKER) build --build-arg APT_PROXY="$(APT_PROXY)" -t ghcr.io/seravo/flask:latest . + $(DOCKER) build --build-arg APT_PROXY="$(APT_PROXY)" -t $(IMAGE) . + +run: clean + $(DOCKER) run --name "$(CONTAINER)" --rm --volume "$(shell pwd)/app/:/app/:ro" -p 127.0.42.1:8080:8080 -d $(IMAGE) + +reload: + $(DOCKER) exec "$(CONTAINER)" touch /tmp/reload-app -run: build - $(DOCKER) run --rm -p 127.0.0.1:8080:8080 -d ghcr.io/seravo/flask:latest +logs: + $(DOCKER) logs "$(CONTAINER)" diff --git a/README.md b/README.md index 0b854be..ff317cd 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ -# docker-flask +# Flask template -Flask in Docker +Flask project template ## Usage To run hello world app, :8080 provides HTTP endpoint (to uWSGI), and :9000 provides uWSGI endpoint. So, let's try accessing via HTTP: - docker run --rm -it -p 127.0.0.1:8080:8080 ghcr.io/seravo/flask:latest + docker run --rm -it -v $(pwd)/app:/app -e FLASK_APP=hello:app -p 127.0.0.1:8080:8080 ghcr.io/seravo/flask:latest now try to open http://127.0.0.1:8080/ , you should see familiar greeting. @@ -14,11 +14,11 @@ To publish your own app, mount your app to `/app`, and provide FLASK_APP environ Eg. - docker run --rm -it -v $(pwd)/myapp:/app -e FLASK_APP=myapp:app -p 127.0.0.1:8080:8080 ghcr.io/seravo/flask:latest + docker run --rm -it -v $(pwd)/app:/app -e FLASK_APP=app:app -p 127.0.0.1:8080:8080 ghcr.io/seravo/flask:latest if you had app code like - myapp/myapp.py: + app/app.py: from flask import Flask app = Flask(__name__) @@ -33,6 +33,21 @@ Usually you shouldn't expose this HTTP endpoint directly to internet, but use eg By default, you can manually reload the application by touching `/tmp/reload-app`. If you want your application to reload automatically after every save, set `FLASK_RELOAD` as `true`. - docker run --rm -it -v $(pwd)/myapp:/app -e FLASK_APP=myapp:app -e FLASK_RELOAD=true -p 127.0.0.1:8080:8080 ghcr.io/seravo/flask:latest + docker run --rm -it -v $(pwd)/app:/app -e FLASK_APP=app:app -e FLASK_RELOAD=true -p 127.0.0.1:8080:8080 ghcr.io/seravo/flask:latest -Now, if you modify the code in `myapp.py` and save, the app will reload and your changes will be in effect. +Now, if you modify the code in `app.py` and save, the app will reload and your changes will be in effect. + +## Tests + +Tests can be ran by executing `pytest-3` inside the container. For example, to run the tests for `hello.py` you would do it like this: + + docker exec -t {CONTAINER_NAME} pytest-3 hello.py -vv + +Test output should look something like this: + + platform linux -- Python 3.9.2, pytest-6.0.2, py-1.10.0, pluggy-0.13.0 -- /usr/bin/python3 + cachedir: .pytest_cache + rootdir: /app + collected 1 item + + hello.py::test_hello PASSED diff --git a/hello.py b/app/hello.py similarity index 59% rename from hello.py rename to app/hello.py index 5038830..a631f46 100644 --- a/hello.py +++ b/app/hello.py @@ -2,9 +2,11 @@ # -*- coding: utf-8 -*- from flask import Flask +import pytest app = Flask(__name__) + @app.route("/") def hello(): return "Hello World!" @@ -15,5 +17,16 @@ def db(): return "FIXME: Return database status if some variable has been set..." +@pytest.fixture +def client(): + with app.test_client() as client: + yield client + + +def test_hello(client): + response = client.get("/") + assert response.data == b"Hello World!" + + if __name__ == '__main__': app.run() diff --git a/entrypoint.sh b/entrypoint.sh deleted file mode 100755 index 18f1cf9..0000000 --- a/entrypoint.sh +++ /dev/null @@ -1,49 +0,0 @@ -#!/bin/sh -set -e - -# -# Launch uWSGI daemon -# - -[ -z "${FLASK_APP}" ] && echo "Error: Missing \$FLASK_APP!" && exit 1 -[ -z "${APPDIR}" ] && echo "Error: Missing \$APPDIR!" && exit 1 -[ -z "${VEDIR}" ] && echo "Error: Missing \$VEDIR!" && exit 1 - -UWSGI_PYTHON="python$(/usr/bin/python3 --version |awk '{print $2}' |cut -b1,3)" - -if [ -x "/app/flask-migrate" ] -then - /app/flask-migrate -fi - -# If FLASK_RELOAD was supplied, start a secondary process to gracefully reload uswgi -# if any of it's files get modified. -if [ "${FLASK_RELOAD}" = true ] -then - (find /app | entr -p -s "echo 'Entr: reloading...' && pkill --signal SIGHUP uwsgi" &) -fi - -cd "${APPDIR:-/app}" - -uwsgi \ - --plugins "${UWSGI_PYTHON}" \ - --master \ - --processes=10 \ - --workers=5 \ - --harakiri=30 \ - --chdir "${APPDIR}" \ - --vacuum \ - --die-on-term \ - --env LC_ALL=C.UTF-8 \ - --env LANG=C.UTF-8 \ - --procname "${FLASK_APP}" \ - --pythonpath "${APPDIR}" \ - --virtualenv "${VEDIR}" \ - --enable-threads \ - --stats 127.0.0.1:9191 \ - --socket=":9000" \ - --http-socket=":8080" \ - --touch-reload=/tmp/reload-app \ - --module "${FLASK_APP}" - -# --profiler diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..4faa21a --- /dev/null +++ b/requirements.txt @@ -0,0 +1 @@ +# your packages here