Introduction
๐ช Dive into the world of SMS Sending Apps and see how seamlessly Keploy can be integrated with FastAPI and Twilio. Buckle up, it's gonna be a fun ride! ๐ข
Pre-Requisite ๐ ๏ธ
- Install WSL (
wsl --install
) forWindows.
- Install Colima(
brew install colima && colima start
) forMacOs.
Get Started! ๐ฌ
Setup the Twilio Account ๐ฌ
You can get your Twilio credentials by signing in to Twilio Console.
Once you get the Twilio Account SID, Auth Token, and Phone Number
, modify the .env
file with your credentials.
Clone the sample Student Data CRUD app ๐งช
git clone https://github.com/keploy/samples-python.git && cd samples-python/fastapi-twilio
Installation ๐ฅ
Depending on your OS, choose your adventure:
Linux or
Windows
Alright, let's equip ourselves with the latest Keploy binary:
curl --silent --location "https://github.com/keploy/keploy/releases/latest/download/keploy_linux_amd64.tar.gz" | tar xz -C /tmp sudo mkdir -p /usr/local/bin && sudo mv /tmp/keploy /usr/local/bin && keploy
If everything goes right, your screen should look a bit like this:
Moving on...
Run App with
Docker
Add alias for Keploy:
alias keploy='sudo docker run --pull always --name keploy-v2 -p 16789:16789 --privileged --pid=host -it -v "$(pwd)":/files -v /sys/fs/cgroup:/sys/fs/cgroup -v /sys/kernel/debug:/sys/kernel/debug -v /sys/fs/bpf:/sys/fs/bpf -v /var/run/docker.sock:/var/run/docker.sock --rm ghcr.io/keploy/keploy'
Lights, Camera, Record! ๐ฅ
Create the docker image of the app:
docker build -t fastapi-twilio:1.0 .
Capture the test-cases-
keploy record -c "docker run -p 8000:8000 --name fastapi-twilio fastapi-twilio:1.0"
๐ฅMake some API calls. Postman, Hoppscotch or even curl - take your pick!
Let's make URLs short and sweet:
Generate testcases
To generate testcases we just need to make some API calls.
Make the POST requests
Replace the place holder below i.e.
YOUR_REGISTERED_PERSONAL_PHONE_NUMBER
with your registered personal phone number that you linked with Twilio.curl --location 'http://127.0.0.1:8000/send-sms/' \ --header 'Content-Type: application/json' \ --data '{ "Body": "Test, testtt, testttttttssss :)", "To": "YOUR_REGISTERED_PERSONAL_PHONE_NUMBER", }'
Replace the place holder below i.e.
SOME_WRONG_PHONE_NUMBER
with any wrong phone number and make the request.curl --location 'http://127.0.0.1:8000/send-sms/' \ --header 'Content-Type: application/json' \ --data '{ "Body": "Test, testtt, testttttttssss :)", "To": "SOME_WRONG_PHONE_NUMBER", }'
Give yourself a pat on the back! With that simple spell, you've conjured up a test case with a mock! Explore the Keploy directory and you'll discover your handiwork in
test-1.yml
andmocks.yml
.version: api.keploy.io/v1beta1 kind: Http name: test-1 spec: metadata: {} req: method: POST proto_major: 1 proto_minor: 1 url: http://127.0.0.1:8000/send-sms/ header: Accept: "*/*" Accept-Encoding: gzip, deflate, br Connection: keep-alive Content-Length: "75" Content-Type: application/json Host: 127.0.0.1:8000 Postman-Token: c871b715-7aae-46b6-8e0d-1341aa426624 User-Agent: PostmanRuntime/7.34.0 body: |- { "Body": "Test, testtt, testttttttssss :)", "To": "+91700004379" } body_type: "" timestamp: 2023-11-14T14:56:25.800517709+05:30 resp: status_code: 200 header: Content-Length: "73" Content-Type: application/json Date: Tue, 14 Nov 2023 09:26:25 GMT Server: uvicorn body: '{"message":"Failed to send SMS. Please check the provided phone number."}' body_type: "" status_message: "" proto_major: 0 proto_minor: 0 timestamp: 2023-11-14T14:56:32.013566624+05:30 objects: [] assertions: noise: header.Date: [] created: 1699953992 curl: |- curl --request POST \ --url http://127.0.0.1:8000/send-sms/ \ --header 'User-Agent: PostmanRuntime/7.34.0' \ --header 'Accept: */*' \ --header 'Postman-Token: c871b715-7aae-46b6-8e0d-1341aa426624' \ --header 'Host: 127.0.0.1:8000' \ --header 'Accept-Encoding: gzip, deflate, br' \ --header 'Connection: keep-alive' \ --header 'Content-Type: application/json' \ --data '{ "Body": "Test, testtt, testttttttssss :)", "To": "+91700004379" }'
This is how
mocks.yml
generated would look like:-version: api.keploy.io/v1beta1 kind: Http name: mocks spec: metadata: name: Http operation: POST type: HTTP_CLIENT req: method: POST proto_major: 1 proto_minor: 1 url: /2010-04-01/Accounts/AC19413687d9ce28c80cda944730f8b286/Messages.json header: Accept: "*/*" Accept-Encoding: gzip, deflate Authorization: Basic QUMxOTQxMzY4N2Q5Y2UyOGM4MGNkYTk0NDczMGY4YjI4NjpjMTc0MDc5YzU2NTA0N2FmYWJmNDk5MWI2ZGQ1MmFiYg== Connection: keep-alive Content-Length: "81" Content-Type: application/x-www-form-urlencoded User-Agent: python-requests/2.31.0 body: Body=Test%2C+testtt%2C+testttttttssss+%3A%29&From=%2B16413324066&To=%2B9170000437 body_type: "" timestamp: 0001-01-01T00:00:00Z resp: status_code: 400 header: Access-Control-Allow-Credentials: "true" Access-Control-Allow-Headers: Accept, Authorization, Content-Type, If-Match, If-Modified-Since, If-None-Match, If-Unmodified-Since, Idempotency-Key Access-Control-Allow-Methods: GET, POST, DELETE, OPTIONS Access-Control-Allow-Origin: "*" Access-Control-Expose-Headers: ETag Connection: keep-alive Content-Length: 335,335 Content-Type: application/json Date: Tue, 14 Nov 2023 09:27:21 GMT Twilio-Concurrent-Requests: "1" Twilio-Request-Duration: "0.080" Twilio-Request-Id: RQb54d7f05d29e83bc89889cc136bcd99d X-Api-Domain: api.twilio.com X-Home-Region: us1 X-Powered-By: AT-5000 X-Shenanigans: none body: '{"code": 21608, "message": "The number +917000XXXX is unverified. Trial accounts cannot send messages to unverified numbers; verify +917000XXXX at twilio.com/user/account/phone-numbers/verified, or purchase a Twilio number to send messages to unverified numbers", "more_info": "https://www.twilio.com/docs/errors/21608", "status": 400}' body_type: "" status_message: "" proto_major: 0 proto_minor: 0 timestamp: 0001-01-01T00:00:00Z objects: [] created: 1699954041 reqTimestampMock: 2023-11-14T14:57:20.914415283+05:30 resTimestampMock: 2023-11-14T14:57:21.298027703+05:30
Want to see if everything works as expected?
Run Tests
Time to put things to the test ๐งช
keploy test -c "docker run -p 8000:8000 --name fastapi-twilio fastapi-twilio:1.0" --delay 10
The
--delay
flag? Oh, that's just giving your app a little breather (in seconds) before the test cases come knocking.Final thoughts? Dive deeper! Try different API calls, tweak the Twilio response in the
mocks.yml
, or fiddle with the request or response intest-x.yml
. Run the tests again and see the magic unfold!โจ๐ฉโ๐ป๐จโ๐ปโจWrapping it up ๐
Congrats on the journey so far! You've seen Keploy's power, flexed your coding muscles, and had a bit of fun too! Now, go out there and keep exploring, innovating, and creating! Remember, with the right tools and a sprinkle of fun, anything's possible.๐๐
Happy coding! โจ๐ฉโ๐ป๐จโ๐ปโจ
Run App on ๐ง Linux
We'll be running our sample application right on Linux. Ready? Let's get the party started!๐
๐ผ Roll the Tape - Recording Time!
Install Python's virtual environment library:
pip3 install virtualenv
Create a virtual environment and activate it:
python3 -m virtualenv venv && source venv/bin/activate
Install the dependencies using the
requirements.txt
file:pip3 install -r requirements.txt
Ready, set, record! Here's how:
keploy record -c "uvicorn application.main:app --reload"
Keep an eye out for the
-c
flag! It's the command charm to run the app.Alright, magician! With the app alive and kicking, let's weave some test cases. The spell? Making some API calls! Postman, Hoppscotch, or the classic curl - pick your wand.
Generate testcases
To generate testcases we just need to make some API calls.
Make the POST requests
Replace the place holder below i.e.
YOUR_REGISTERED_PERSONAL_PHONE_NUMBER
with your registered personal phone number that you linked with Twilio.curl --location 'http://127.0.0.1:8000/send-sms/' \ --header 'Content-Type: application/json' \ --data '{ "Body": "Test, testtt, testttttttssss :)", "To": "YOUR_REGISTERED_PERSONAL_PHONE_NUMBER", }'
Replace the place holder below i.e.
SOME_WRONG_PHONE_NUMBER
with any wrong phone number and make the request.curl --location 'http://127.0.0.1:8000/send-sms/' \ --header 'Content-Type: application/json' \ --data '{ "Body": "Test, testtt, testttttttssss :)", "To": "SOME_WRONG_PHONE_NUMBER", }'
Give yourself a pat on the back! With that simple spell, you've conjured up a test case with a mock! Explore the Keploy directory and you'll discover your handiwork in
test-1.yml
andmocks.yml
.version: api.keploy.io/v1beta1 kind: Http name: test-1 spec: metadata: {} req: method: POST proto_major: 1 proto_minor: 1 url: http://127.0.0.1:8000/send-sms/ header: Accept: "*/*" Accept-Encoding: gzip, deflate, br Connection: keep-alive Content-Length: "75" Content-Type: application/json Host: 127.0.0.1:8000 Postman-Token: c871b715-7aae-46b6-8e0d-1341aa426624 User-Agent: PostmanRuntime/7.34.0 body: |- { "Body": "Test, testtt, testttttttssss :)", "To": "+91700004379" } body_type: "" timestamp: 2023-11-14T14:56:25.800517709+05:30 resp: status_code: 200 header: Content-Length: "73" Content-Type: application/json Date: Tue, 14 Nov 2023 09:26:25 GMT Server: uvicorn body: '{"message":"Failed to send SMS. Please check the provided phone number."}' body_type: "" status_message: "" proto_major: 0 proto_minor: 0 timestamp: 2023-11-14T14:56:32.013566624+05:30 objects: [] assertions: noise: header.Date: [] created: 1699953992 curl: |- curl --request POST \ --url http://127.0.0.1:8000/send-sms/ \ --header 'User-Agent: PostmanRuntime/7.34.0' \ --header 'Accept: */*' \ --header 'Postman-Token: c871b715-7aae-46b6-8e0d-1341aa426624' \ --header 'Host: 127.0.0.1:8000' \ --header 'Accept-Encoding: gzip, deflate, br' \ --header 'Connection: keep-alive' \ --header 'Content-Type: application/json' \ --data '{ "Body": "Test, testtt, testttttttssss :)", "To": "+91700004379" }'
This is how
mocks.yml
generated would look like:-version: api.keploy.io/v1beta1 kind: Http name: mocks spec: metadata: name: Http operation: POST type: HTTP_CLIENT req: method: POST proto_major: 1 proto_minor: 1 url: /2010-04-01/Accounts/AC19413687d9ce28c80cda944730f8b286/Messages.json header: Accept: "*/*" Accept-Encoding: gzip, deflate Authorization: Basic QUMxOTQxMzY4N2Q5Y2UyOGM4MGNkYTk0NDczMGY4YjI4NjpjMTc0MDc5YzU2NTA0N2FmYWJmNDk5MWI2ZGQ1MmFiYg== Connection: keep-alive Content-Length: "81" Content-Type: application/x-www-form-urlencoded User-Agent: python-requests/2.31.0 body: Body=Test%2C+testtt%2C+testttttttssss+%3A%29&From=%2B16413324066&To=%2B9170000437 body_type: "" timestamp: 0001-01-01T00:00:00Z resp: status_code: 400 header: Access-Control-Allow-Credentials: "true" Access-Control-Allow-Headers: Accept, Authorization, Content-Type, If-Match, If-Modified-Since, If-None-Match, If-Unmodified-Since, Idempotency-Key Access-Control-Allow-Methods: GET, POST, DELETE, OPTIONS Access-Control-Allow-Origin: "*" Access-Control-Expose-Headers: ETag Connection: keep-alive Content-Length: 335,335 Content-Type: application/json Date: Tue, 14 Nov 2023 09:27:21 GMT Twilio-Concurrent-Requests: "1" Twilio-Request-Duration: "0.080" Twilio-Request-Id: RQb54d7f05d29e83bc89889cc136bcd99d X-Api-Domain: api.twilio.com X-Home-Region: us1 X-Powered-By: AT-5000 X-Shenanigans: none body: '{"code": 21608, "message": "The number +917000XXXX is unverified. Trial accounts cannot send messages to unverified numbers; verify +917000XXXX at twilio.com/user/account/phone-numbers/verified, or purchase a Twilio number to send messages to unverified numbers", "more_info": "https://www.twilio.com/docs/errors/21608", "status": 400}' body_type: "" status_message: "" proto_major: 0 proto_minor: 0 timestamp: 0001-01-01T00:00:00Z objects: [] created: 1699954041 reqTimestampMock: 2023-11-14T14:57:20.914415283+05:30 resTimestampMock: 2023-11-14T14:57:21.298027703+05:30
Want to see if everything works as expected?
Run Tests
Time to put things to the test ๐งช
keploy test -c "uvicorn application.main:app --reload" --delay 10
The
--delay
flag? Oh, that's just giving your app a little breather (in seconds) before the test cases come knocking.Final thoughts? Dive deeper! Try different API calls, tweak the Twilio response in the
mocks.yml
, or fiddle with the request or response intest-x.yml
. Run the tests again and see the magic unfold!โจ๐ฉโ๐ป๐จโ๐ปโจWrapping it up ๐
Congrats on the journey so far! You've seen Keploy's power, flexed your coding muscles, and had a bit of fun too! Now, go out there and keep exploring, innovating, and creating! Remember, with the right tools and a sprinkle of fun, anything's possible. ๐๐
Happy coding! โจ๐ฉโ๐ป๐จโ๐ปโจ
MacOs
Dive straight in, but first, give Colima a gentle nudge with (
colima start
). Let's make sure it's awake and ready for action!Add alias for Keploy ๐ฐ:
For the sake of convenience (and a bit of Mac magic ๐ช), let's set up a shortcut for Keploy:
alias keploy='sudo docker run --pull always --name keploy-v2 -p 16789:16789 --privileged --pid=host -it -v "$(pwd)":/files -v /sys/fs/cgroup:/sys/fs/cgroup -v /sys/kernel/debug:/sys/kernel/debug -v /sys/fs/bpf:/sys/fs/bpf -v /var/run/docker.sock:/var/run/docker.sock --rm ghcr.io/keploy/keploy'
Lights, Camera, Record! ๐ฅ
Create the docker image of the app:
docker build -t fastapi-twilio:1.0 .
Capture the test-cases-
keploy record -c "docker run -p 8000:8000 --name fastapi-twilio fastapi-twilio:1.0"
๐ฅMake some API calls. Postman, Hoppscotch or even curl - take your pick!
Let's make URLs short and sweet:
Generate testcases
To generate testcases we just need to make some API calls.
Make the POST requests
Replace the place holder below i.e.
YOUR_REGISTERED_PERSONAL_PHONE_NUMBER
with your registered personal phone number that you linked with Twilio.curl --location 'http://127.0.0.1:8000/send-sms/' \ --header 'Content-Type: application/json' \ --data '{ "Body": "Test, testtt, testttttttssss :)", "To": "YOUR_REGISTERED_PERSONAL_PHONE_NUMBER", }'
Replace the place holder below i.e.
SOME_WRONG_PHONE_NUMBER
with any wrong phone number and make the request.curl --location 'http://127.0.0.1:8000/send-sms/' \ --header 'Content-Type: application/json' \ --data '{ "Body": "Test, testtt, testttttttssss :)", "To": "SOME_WRONG_PHONE_NUMBER", }'
Give yourself a pat on the back! With that simple spell, you've conjured up a test case with a mock! Explore the Keploy directory and you'll discover your handiwork in
test-1.yml
andmocks.yml
.version: api.keploy.io/v1beta1 kind: Http name: test-1 spec: metadata: {} req: method: POST proto_major: 1 proto_minor: 1 url: http://127.0.0.1:8000/send-sms/ header: Accept: "*/*" Accept-Encoding: gzip, deflate, br Connection: keep-alive Content-Length: "75" Content-Type: application/json Host: 127.0.0.1:8000 Postman-Token: c871b715-7aae-46b6-8e0d-1341aa426624 User-Agent: PostmanRuntime/7.34.0 body: |- { "Body": "Test, testtt, testttttttssss :)", "To": "+91700004379" } body_type: "" timestamp: 2023-11-14T14:56:25.800517709+05:30 resp: status_code: 200 header: Content-Length: "73" Content-Type: application/json Date: Tue, 14 Nov 2023 09:26:25 GMT Server: uvicorn body: '{"message":"Failed to send SMS. Please check the provided phone number."}' body_type: "" status_message: "" proto_major: 0 proto_minor: 0 timestamp: 2023-11-14T14:56:32.013566624+05:30 objects: [] assertions: noise: header.Date: [] created: 1699953992 curl: |- curl --request POST \ --url http://127.0.0.1:8000/send-sms/ \ --header 'User-Agent: PostmanRuntime/7.34.0' \ --header 'Accept: */*' \ --header 'Postman-Token: c871b715-7aae-46b6-8e0d-1341aa426624' \ --header 'Host: 127.0.0.1:8000' \ --header 'Accept-Encoding: gzip, deflate, br' \ --header 'Connection: keep-alive' \ --header 'Content-Type: application/json' \ --data '{ "Body": "Test, testtt, testttttttssss :)", "To": "+91700004379" }'
This is how
mocks.yml
generated would look like:-version: api.keploy.io/v1beta1 kind: Http name: mocks spec: metadata: name: Http operation: POST type: HTTP_CLIENT req: method: POST proto_major: 1 proto_minor: 1 url: /2010-04-01/Accounts/AC19413687d9ce28c80cda944730f8b286/Messages.json header: Accept: "*/*" Accept-Encoding: gzip, deflate Authorization: Basic QUMxOTQxMzY4N2Q5Y2UyOGM4MGNkYTk0NDczMGY4YjI4NjpjMTc0MDc5YzU2NTA0N2FmYWJmNDk5MWI2ZGQ1MmFiYg== Connection: keep-alive Content-Length: "81" Content-Type: application/x-www-form-urlencoded User-Agent: python-requests/2.31.0 body: Body=Test%2C+testtt%2C+testttttttssss+%3A%29&From=%2B16413324066&To=%2B9170000437 body_type: "" timestamp: 0001-01-01T00:00:00Z resp: status_code: 400 header: Access-Control-Allow-Credentials: "true" Access-Control-Allow-Headers: Accept, Authorization, Content-Type, If-Match, If-Modified-Since, If-None-Match, If-Unmodified-Since, Idempotency-Key Access-Control-Allow-Methods: GET, POST, DELETE, OPTIONS Access-Control-Allow-Origin: "*" Access-Control-Expose-Headers: ETag Connection: keep-alive Content-Length: 335,335 Content-Type: application/json Date: Tue, 14 Nov 2023 09:27:21 GMT Twilio-Concurrent-Requests: "1" Twilio-Request-Duration: "0.080" Twilio-Request-Id: RQb54d7f05d29e83bc89889cc136bcd99d X-Api-Domain: api.twilio.com X-Home-Region: us1 X-Powered-By: AT-5000 X-Shenanigans: none body: '{"code": 21608, "message": "The number +917000XXXX is unverified. Trial accounts cannot send messages to unverified numbers; verify +917000XXXX at twilio.com/user/account/phone-numbers/verified, or purchase a Twilio number to send messages to unverified numbers", "more_info": "https://www.twilio.com/docs/errors/21608", "status": 400}' body_type: "" status_message: "" proto_major: 0 proto_minor: 0 timestamp: 0001-01-01T00:00:00Z objects: [] created: 1699954041 reqTimestampMock: 2023-11-14T14:57:20.914415283+05:30 resTimestampMock: 2023-11-14T14:57:21.298027703+05:30
Want to see if everything works as expected?
Run Tests
Time to put things to the test ๐งช
keploy test -c "docker run -p 8000:8000 --name fastapi-twilio fastapi-twilio:1.0" --delay 10
The
--delay
flag? Oh, that's just giving your app a little breather (in seconds) before the test cases come knocking.Final thoughts? Dive deeper! Try different API calls, tweak the Twilio response in the
mocks.yml
, or fiddle with the request or response intest-x.yml
. Run the tests again and see the magic unfold!โจ๐ฉโ๐ป๐จโ๐ปโจWrapping it up ๐
Congrats on the journey so far! You've seen Keploy's power, flexed your coding muscles, and had a bit of fun too! Now, go out there and keep exploring, innovating, and creating! Remember, with the right tools and a sprinkle of fun, anything's possible.๐๐
Happy coding! โจ๐ฉโ๐ป๐จโ๐ปโจ