Skip to content

Commit a3c748b

Browse files
mohsenasmmohsenasm
committed
add test
1 parent 6206e6f commit a3c748b

8 files changed

+250
-7
lines changed

‎app/Dockerfile

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ RUN pip install --no-cache-dir -r requirements.txt
77

88
COPY . .
99

10-
CMD [ "python", "app.py" ]
10+
CMD ["./wait-for-it.sh", "db:5432", "--", "python", "app.py"]

‎app/requirements.txt

+2-1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,5 @@ Flask==1.1.2
22
flask-apispec==0.11.0
33
Flask-RESTful==0.3.8
44
Flask-SQLAlchemy==2.5.1
5-
psycopg2-binary==2.8.6
5+
psycopg2-binary==2.8.6
6+
Flask-Testing==0.8.1

‎app/resources.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ class MessageSchema(ma.Schema):
2020

2121

2222
class Car(MethodResource, Resource):
23-
@marshal_with(CarSchema(many=True), code=200)
23+
@marshal_with(CarSchema(many=True), code=200) # output list of `CarSchema`s
2424
def get(self):
2525
cars = CarsModel.query.all()
2626
return [
@@ -29,8 +29,8 @@ def get(self):
2929
"doors": car.doors
3030
} for car in cars]
3131

32-
@use_kwargs(CarSchema)
33-
@marshal_with(MessageSchema, code=200)
32+
@use_kwargs(CarSchema) # input CarSchema
33+
@marshal_with(MessageSchema, code=200) # output MessageSchema
3434
def post(self, **kwargs):
3535
if any(param not in kwargs for param in ["name", "doors"]):
3636
return {"message": "missed an argument"}, 400

‎app/test.py

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
import unittest
2+
from flask_testing import TestCase
3+
from app import create_app
4+
from models import db
5+
6+
7+
class TestBase(TestCase):
8+
def create_app(self):
9+
app = create_app()
10+
app.config['TESTING'] = True
11+
return app
12+
13+
def setUp(self):
14+
db.create_all()
15+
16+
def tearDown(self):
17+
db.session.remove()
18+
db.drop_all()
19+
20+
21+
class TestCar(TestBase):
22+
def test_car(self):
23+
response = self.client.post('/car', json={
24+
"name": "tesla",
25+
"doors": 4,
26+
})
27+
self.assertEqual(response.status_code, 200)
28+
29+
response = self.client.get('/car')
30+
response_json = response.get_json()
31+
self.assertEqual(len(response_json), 1)
32+
self.assertEqual(response_json[0], {"name": "tesla", "doors": 4})
33+
34+
35+
if __name__ == '__main__':
36+
unittest.main()

‎app/wait-for-it.sh

+182
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,182 @@
1+
#!/usr/bin/env bash
2+
# Use this script to test if a given TCP host/port are available
3+
4+
WAITFORIT_cmdname=${0##*/}
5+
6+
echoerr() { if [[ $WAITFORIT_QUIET -ne 1 ]]; then echo "$@" 1>&2; fi }
7+
8+
usage()
9+
{
10+
cat << USAGE >&2
11+
Usage:
12+
$WAITFORIT_cmdname host:port [-s] [-t timeout] [-- command args]
13+
-h HOST | --host=HOST Host or IP under test
14+
-p PORT | --port=PORT TCP port under test
15+
Alternatively, you specify the host and port as host:port
16+
-s | --strict Only execute subcommand if the test succeeds
17+
-q | --quiet Don't output any status messages
18+
-t TIMEOUT | --timeout=TIMEOUT
19+
Timeout in seconds, zero for no timeout
20+
-- COMMAND ARGS Execute command with args after the test finishes
21+
USAGE
22+
exit 1
23+
}
24+
25+
wait_for()
26+
{
27+
if [[ $WAITFORIT_TIMEOUT -gt 0 ]]; then
28+
echoerr "$WAITFORIT_cmdname: waiting $WAITFORIT_TIMEOUT seconds for $WAITFORIT_HOST:$WAITFORIT_PORT"
29+
else
30+
echoerr "$WAITFORIT_cmdname: waiting for $WAITFORIT_HOST:$WAITFORIT_PORT without a timeout"
31+
fi
32+
WAITFORIT_start_ts=$(date +%s)
33+
while :
34+
do
35+
if [[ $WAITFORIT_ISBUSY -eq 1 ]]; then
36+
nc -z $WAITFORIT_HOST $WAITFORIT_PORT
37+
WAITFORIT_result=$?
38+
else
39+
(echo -n > /dev/tcp/$WAITFORIT_HOST/$WAITFORIT_PORT) >/dev/null 2>&1
40+
WAITFORIT_result=$?
41+
fi
42+
if [[ $WAITFORIT_result -eq 0 ]]; then
43+
WAITFORIT_end_ts=$(date +%s)
44+
echoerr "$WAITFORIT_cmdname: $WAITFORIT_HOST:$WAITFORIT_PORT is available after $((WAITFORIT_end_ts - WAITFORIT_start_ts)) seconds"
45+
break
46+
fi
47+
sleep 1
48+
done
49+
return $WAITFORIT_result
50+
}
51+
52+
wait_for_wrapper()
53+
{
54+
# In order to support SIGINT during timeout: http://unix.stackexchange.com/a/57692
55+
if [[ $WAITFORIT_QUIET -eq 1 ]]; then
56+
timeout $WAITFORIT_BUSYTIMEFLAG $WAITFORIT_TIMEOUT $0 --quiet --child --host=$WAITFORIT_HOST --port=$WAITFORIT_PORT --timeout=$WAITFORIT_TIMEOUT &
57+
else
58+
timeout $WAITFORIT_BUSYTIMEFLAG $WAITFORIT_TIMEOUT $0 --child --host=$WAITFORIT_HOST --port=$WAITFORIT_PORT --timeout=$WAITFORIT_TIMEOUT &
59+
fi
60+
WAITFORIT_PID=$!
61+
trap "kill -INT -$WAITFORIT_PID" INT
62+
wait $WAITFORIT_PID
63+
WAITFORIT_RESULT=$?
64+
if [[ $WAITFORIT_RESULT -ne 0 ]]; then
65+
echoerr "$WAITFORIT_cmdname: timeout occurred after waiting $WAITFORIT_TIMEOUT seconds for $WAITFORIT_HOST:$WAITFORIT_PORT"
66+
fi
67+
return $WAITFORIT_RESULT
68+
}
69+
70+
# process arguments
71+
while [[ $# -gt 0 ]]
72+
do
73+
case "$1" in
74+
*:* )
75+
WAITFORIT_hostport=(${1//:/ })
76+
WAITFORIT_HOST=${WAITFORIT_hostport[0]}
77+
WAITFORIT_PORT=${WAITFORIT_hostport[1]}
78+
shift 1
79+
;;
80+
--child)
81+
WAITFORIT_CHILD=1
82+
shift 1
83+
;;
84+
-q | --quiet)
85+
WAITFORIT_QUIET=1
86+
shift 1
87+
;;
88+
-s | --strict)
89+
WAITFORIT_STRICT=1
90+
shift 1
91+
;;
92+
-h)
93+
WAITFORIT_HOST="$2"
94+
if [[ $WAITFORIT_HOST == "" ]]; then break; fi
95+
shift 2
96+
;;
97+
--host=*)
98+
WAITFORIT_HOST="${1#*=}"
99+
shift 1
100+
;;
101+
-p)
102+
WAITFORIT_PORT="$2"
103+
if [[ $WAITFORIT_PORT == "" ]]; then break; fi
104+
shift 2
105+
;;
106+
--port=*)
107+
WAITFORIT_PORT="${1#*=}"
108+
shift 1
109+
;;
110+
-t)
111+
WAITFORIT_TIMEOUT="$2"
112+
if [[ $WAITFORIT_TIMEOUT == "" ]]; then break; fi
113+
shift 2
114+
;;
115+
--timeout=*)
116+
WAITFORIT_TIMEOUT="${1#*=}"
117+
shift 1
118+
;;
119+
--)
120+
shift
121+
WAITFORIT_CLI=("$@")
122+
break
123+
;;
124+
--help)
125+
usage
126+
;;
127+
*)
128+
echoerr "Unknown argument: $1"
129+
usage
130+
;;
131+
esac
132+
done
133+
134+
if [[ "$WAITFORIT_HOST" == "" || "$WAITFORIT_PORT" == "" ]]; then
135+
echoerr "Error: you need to provide a host and port to test."
136+
usage
137+
fi
138+
139+
WAITFORIT_TIMEOUT=${WAITFORIT_TIMEOUT:-15}
140+
WAITFORIT_STRICT=${WAITFORIT_STRICT:-0}
141+
WAITFORIT_CHILD=${WAITFORIT_CHILD:-0}
142+
WAITFORIT_QUIET=${WAITFORIT_QUIET:-0}
143+
144+
# Check to see if timeout is from busybox?
145+
WAITFORIT_TIMEOUT_PATH=$(type -p timeout)
146+
WAITFORIT_TIMEOUT_PATH=$(realpath $WAITFORIT_TIMEOUT_PATH 2>/dev/null || readlink -f $WAITFORIT_TIMEOUT_PATH)
147+
148+
WAITFORIT_BUSYTIMEFLAG=""
149+
if [[ $WAITFORIT_TIMEOUT_PATH =~ "busybox" ]]; then
150+
WAITFORIT_ISBUSY=1
151+
# Check if busybox timeout uses -t flag
152+
# (recent Alpine versions don't support -t anymore)
153+
if timeout &>/dev/stdout | grep -q -e '-t '; then
154+
WAITFORIT_BUSYTIMEFLAG="-t"
155+
fi
156+
else
157+
WAITFORIT_ISBUSY=0
158+
fi
159+
160+
if [[ $WAITFORIT_CHILD -gt 0 ]]; then
161+
wait_for
162+
WAITFORIT_RESULT=$?
163+
exit $WAITFORIT_RESULT
164+
else
165+
if [[ $WAITFORIT_TIMEOUT -gt 0 ]]; then
166+
wait_for_wrapper
167+
WAITFORIT_RESULT=$?
168+
else
169+
wait_for
170+
WAITFORIT_RESULT=$?
171+
fi
172+
fi
173+
174+
if [[ $WAITFORIT_CLI != "" ]]; then
175+
if [[ $WAITFORIT_RESULT -ne 0 && $WAITFORIT_STRICT -eq 1 ]]; then
176+
echoerr "$WAITFORIT_cmdname: strict mode, refusing to execute subprocess"
177+
exit $WAITFORIT_RESULT
178+
fi
179+
exec "${WAITFORIT_CLI[@]}"
180+
else
181+
exit $WAITFORIT_RESULT
182+
fi

‎docker-compose.yml

-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ services:
66
restart: always
77
ports:
88
- 7654:7654
9-
# we should use something like `wait-for-it.sh` in real life
109

1110
db:
1211
image: 'postgres:13-alpine'

‎readme.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
# A template that aimed to quickstart your flask api development
22

3+
## Test
4+
docker-compose -f test-docker-compose.yml up --build
5+
36
## Run
47
docker-compose up --build
58

6-
## Documentation & Demo
9+
## See Documentation & Demo
710
http://localhost:7654/swagger-ui

‎test-docker-compose.yml

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
version: '3'
2+
3+
services:
4+
test-app:
5+
build: './app'
6+
ports:
7+
- 7654:7654
8+
command: ./wait-for-it.sh db:5432 -- python test.py
9+
10+
db:
11+
image: 'postgres:13-alpine'
12+
environment:
13+
POSTGRES_DB: 'the_db'
14+
POSTGRES_USER: 'postgres'
15+
POSTGRES_PASSWORD: 'the_pass'
16+
expose:
17+
- 5432
18+
volumes:
19+
- db_data:/var/lib/postgresql/data
20+
21+
volumes:
22+
db_data:

0 commit comments

Comments
 (0)