Skip to content

Commit 005e21a

Browse files
authored
Merge branch 'master' into python-http-server
2 parents 47aeae0 + 02a2f1a commit 005e21a

File tree

23 files changed

+796
-9
lines changed

23 files changed

+796
-9
lines changed
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: Continuous Integration
2+
3+
on:
4+
pull_request:
5+
branches:
6+
- master
7+
push:
8+
branches:
9+
- master
10+
11+
jobs:
12+
build:
13+
name: Build Docker image and run end-to-end tests
14+
runs-on: ubuntu-latest
15+
steps:
16+
- name: Checkout code from GitHub
17+
uses: actions/checkout@v3
18+
- name: Run end-to-end tests
19+
run: >
20+
docker compose --profile testing up
21+
--build
22+
--exit-code-from test-service
23+
- name: Login to Docker Hub
24+
uses: docker/login-action@v2
25+
if: ${{ github.event_name == 'push' }}
26+
with:
27+
username: ${{ secrets.DOCKERHUB_USERNAME }}
28+
password: ${{ secrets.DOCKERHUB_TOKEN }}
29+
- name: Push image to Docker Hub
30+
uses: docker/[email protected]
31+
if: ${{ github.event_name == 'push' }}
32+
with:
33+
context: ./web
34+
push: true
35+
tags: |
36+
${{ secrets.DOCKERHUB_USERNAME }}/page-tracker:${{ github.sha }}
37+
${{ secrets.DOCKERHUB_USERNAME }}/page-tracker:latest
Lines changed: 264 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,264 @@
1+
# Created by https://www.toptal.com/developers/gitignore/api/python,pycharm+all
2+
# Edit at https://www.toptal.com/developers/gitignore?templates=python,pycharm+all
3+
4+
### PyCharm+all ###
5+
# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
6+
# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
7+
8+
# User-specific stuff
9+
.idea/**/workspace.xml
10+
.idea/**/tasks.xml
11+
.idea/**/usage.statistics.xml
12+
.idea/**/dictionaries
13+
.idea/**/shelf
14+
15+
# AWS User-specific
16+
.idea/**/aws.xml
17+
18+
# Generated files
19+
.idea/**/contentModel.xml
20+
21+
# Sensitive or high-churn files
22+
.idea/**/dataSources/
23+
.idea/**/dataSources.ids
24+
.idea/**/dataSources.local.xml
25+
.idea/**/sqlDataSources.xml
26+
.idea/**/dynamic.xml
27+
.idea/**/uiDesigner.xml
28+
.idea/**/dbnavigator.xml
29+
30+
# Gradle
31+
.idea/**/gradle.xml
32+
.idea/**/libraries
33+
34+
# Gradle and Maven with auto-import
35+
# When using Gradle or Maven with auto-import, you should exclude module files,
36+
# since they will be recreated, and may cause churn. Uncomment if using
37+
# auto-import.
38+
# .idea/artifacts
39+
# .idea/compiler.xml
40+
# .idea/jarRepositories.xml
41+
# .idea/modules.xml
42+
# .idea/*.iml
43+
# .idea/modules
44+
# *.iml
45+
# *.ipr
46+
47+
# CMake
48+
cmake-build-*/
49+
50+
# Mongo Explorer plugin
51+
.idea/**/mongoSettings.xml
52+
53+
# File-based project format
54+
*.iws
55+
56+
# IntelliJ
57+
out/
58+
59+
# mpeltonen/sbt-idea plugin
60+
.idea_modules/
61+
62+
# JIRA plugin
63+
atlassian-ide-plugin.xml
64+
65+
# Cursive Clojure plugin
66+
.idea/replstate.xml
67+
68+
# SonarLint plugin
69+
.idea/sonarlint/
70+
71+
# Crashlytics plugin (for Android Studio and IntelliJ)
72+
com_crashlytics_export_strings.xml
73+
crashlytics.properties
74+
crashlytics-build.properties
75+
fabric.properties
76+
77+
# Editor-based Rest Client
78+
.idea/httpRequests
79+
80+
# Android studio 3.1+ serialized cache file
81+
.idea/caches/build_file_checksums.ser
82+
83+
### PyCharm+all Patch ###
84+
# Ignore everything but code style settings and run configurations
85+
# that are supposed to be shared within teams.
86+
87+
.idea/*
88+
89+
!.idea/codeStyles
90+
!.idea/runConfigurations
91+
92+
### Python ###
93+
# Byte-compiled / optimized / DLL files
94+
__pycache__/
95+
*.py[cod]
96+
*$py.class
97+
98+
# C extensions
99+
*.so
100+
101+
# Distribution / packaging
102+
.Python
103+
build/
104+
develop-eggs/
105+
dist/
106+
downloads/
107+
eggs/
108+
.eggs/
109+
lib/
110+
lib64/
111+
parts/
112+
sdist/
113+
var/
114+
wheels/
115+
share/python-wheels/
116+
*.egg-info/
117+
.installed.cfg
118+
*.egg
119+
MANIFEST
120+
121+
# PyInstaller
122+
# Usually these files are written by a python script from a template
123+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
124+
*.manifest
125+
*.spec
126+
127+
# Installer logs
128+
pip-log.txt
129+
pip-delete-this-directory.txt
130+
131+
# Unit test / coverage reports
132+
htmlcov/
133+
.tox/
134+
.nox/
135+
.coverage
136+
.coverage.*
137+
.cache
138+
nosetests.xml
139+
coverage.xml
140+
*.cover
141+
*.py,cover
142+
.hypothesis/
143+
.pytest_cache/
144+
cover/
145+
146+
# Translations
147+
*.mo
148+
*.pot
149+
150+
# Django stuff:
151+
*.log
152+
local_settings.py
153+
db.sqlite3
154+
db.sqlite3-journal
155+
156+
# Flask stuff:
157+
instance/
158+
.webassets-cache
159+
160+
# Scrapy stuff:
161+
.scrapy
162+
163+
# Sphinx documentation
164+
docs/_build/
165+
166+
# PyBuilder
167+
.pybuilder/
168+
target/
169+
170+
# Jupyter Notebook
171+
.ipynb_checkpoints
172+
173+
# IPython
174+
profile_default/
175+
ipython_config.py
176+
177+
# pyenv
178+
# For a library or package, you might want to ignore these files since the code is
179+
# intended to run in multiple environments; otherwise, check them in:
180+
# .python-version
181+
182+
# pipenv
183+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
184+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
185+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
186+
# install all needed dependencies.
187+
#Pipfile.lock
188+
189+
# poetry
190+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
191+
# This is especially recommended for binary packages to ensure reproducibility, and is more
192+
# commonly ignored for libraries.
193+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
194+
#poetry.lock
195+
196+
# pdm
197+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
198+
#pdm.lock
199+
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
200+
# in version control.
201+
# https://pdm.fming.dev/#use-with-ide
202+
.pdm.toml
203+
204+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
205+
__pypackages__/
206+
207+
# Celery stuff
208+
celerybeat-schedule
209+
celerybeat.pid
210+
211+
# SageMath parsed files
212+
*.sage.py
213+
214+
# Environments
215+
.env
216+
.venv
217+
env/
218+
venv/
219+
ENV/
220+
env.bak/
221+
venv.bak/
222+
223+
# Spyder project settings
224+
.spyderproject
225+
.spyproject
226+
227+
# Rope project settings
228+
.ropeproject
229+
230+
# mkdocs documentation
231+
/site
232+
233+
# mypy
234+
.mypy_cache/
235+
.dmypy.json
236+
dmypy.json
237+
238+
# Pyre type checker
239+
.pyre/
240+
241+
# pytype static type analyzer
242+
.pytype/
243+
244+
# Cython debug symbols
245+
cython_debug/
246+
247+
# PyCharm
248+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
249+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
250+
# and can be added to the global gitignore or merged into this file. For a more nuclear
251+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
252+
#.idea/
253+
254+
### Python Patch ###
255+
# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
256+
poetry.toml
257+
258+
# ruff
259+
.ruff_cache/
260+
261+
# LSP config files
262+
pyrightconfig.json
263+
264+
# End of https://www.toptal.com/developers/gitignore/api/python,pycharm+all
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Build Robust Continuous Integration With Docker and Friends
2+
3+
Supporting materials for the Real Python tutorial [Build Robust Continuous Integration With Docker and Friends](https://realpython.com/docker-continuous-integration/).
4+
5+
## Running
6+
7+
To start the application in the background, run the following command:
8+
9+
```shell
10+
$ docker compose up -d
11+
```
12+
13+
Then, navigate your web browser to <http://localhost>, and keep refreshing the page to update the number of page views.
14+
15+
## Testing
16+
17+
You can run the end-to-end tests by enabling another service using a special profile and then browse the logs:
18+
19+
```shell
20+
$ docker compose --profile testing up -d
21+
$ docker compose logs test-service
22+
```
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
services:
2+
redis-service:
3+
image: "redis:7.0.10-bullseye"
4+
networks:
5+
- backend-network
6+
volumes:
7+
- "redis-volume:/data"
8+
web-service:
9+
build: ./web
10+
ports:
11+
- "80:8000"
12+
environment:
13+
REDIS_URL: "redis://redis-service:6379"
14+
networks:
15+
- backend-network
16+
depends_on:
17+
- redis-service
18+
command: "gunicorn page_tracker.app:app --bind 0.0.0.0:8000"
19+
test-service:
20+
profiles:
21+
- testing
22+
build:
23+
context: ./web
24+
dockerfile: Dockerfile.dev
25+
environment:
26+
REDIS_URL: "redis://redis-service:6379"
27+
FLASK_URL: "http://web-service:8000"
28+
networks:
29+
- backend-network
30+
depends_on:
31+
- redis-service
32+
- web-service
33+
command: >
34+
sh -c 'python -m pytest test/e2e/ -vv
35+
--redis-url $$REDIS_URL
36+
--flask-url $$FLASK_URL'
37+
38+
networks:
39+
backend-network:
40+
41+
volumes:
42+
redis-volume:

0 commit comments

Comments
 (0)