# Sample Student Data CRUD App > The following sample app showcases how to use the FastAPI framework and the Keploy Platform. ## Using Docker Compose ๐Ÿณ ๐Ÿช„ Dive into the world of User CRUD Apps and see how seamlessly Keploy integrated with FastAPI and PostgreSQL. Buckle up, it's gonna be a fun ride! ๐ŸŽข ### Clone the sample Student Data CRUD app ๐Ÿงช ```bash git clone https://github.com/keploy/samples-python.git && cd samples-python/fastapi-postgres ``` ### Lights, Camera, Record! ๐ŸŽฅ Capture the test-cases- ```shell keploy record -c "docker compose up" --container-name "fastapi-app" --build-delay 50 ``` ๐Ÿ”ฅ**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.** **1. Make a POST request** ```bash curl --location 'http://127.0.0.1:8000/students/' \ --header 'Content-Type: application/json' \ --data-raw '{ "name": "Eva White", "email": "evawhite@example.com", "password": "evawhite111" }' ``` **2. Make a GET request** ```bash curl --location 'http://127.0.0.1:8000/students/' ``` **3. Make a PUT request** ```bash curl --location --request PUT 'http://127.0.0.1:8000/students/1' \ --header 'Content-Type: application/json' \ --data-raw ' { "name": "John Dow", "email": "doe.john@example.com", "password": "johndoe123", "stream": "Arts" }' ``` **4. Make a GET request** ```bash curl --location 'http://127.0.0.1:8000/students/1' ``` **5. Make a DELETE request** ```bash curl --location --request DELETE 'http://127.0.0.1:8000/students/1' ``` 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` and `mocks.yml`. ```yaml version: api.keploy.io/v1beta2 kind: Http name: test-1 spec: metadata: {} req: method: GET proto_major: 1 proto_minor: 1 url: http://127.0.0.1:8000/students/ header: Accept: "*/*" Host: 127.0.0.1:8000 User-Agent: curl/7.81.0 body: "" body_type: "" timestamp: 2023-11-06T10:42:43.046337785+05:30 resp: status_code: 404 header: Content-Length: "29" Content-Type: application/json Date: Mon, 06 Nov 2023 05:12:42 GMT Server: uvicorn body: '{"detail":"Data not found!!"}' body_type: "" status_message: "" proto_major: 0 proto_minor: 0 timestamp: 2023-11-06T10:42:45.959907593+05:30 objects: [] assertions: noise: - header.Date created: 1699247565 curl: | curl --request GET \ --url http://127.0.0.1:8000/students/ \ --header 'User-Agent: curl/7.81.0' \ --header 'Accept: */*' \ --header 'Host: 127.0.0.1:8000' \ ``` This is how `mocks.yml` generated would look like:- ```yaml version: api.keploy.io/v1beta2 kind: Postgres name: mocks spec: metadata: {} postgresrequests: - header: [Q] identifier: ClientRequest length: 8 query: string: SELECT students."ID" AS "students_ID", students."Name" AS "students_Name", students."Email" AS "students_Email", students."Hashed Password" AS "students_Hashed Password", students."Subject Stream" AS "students_Subject Stream" FROM students LIMIT 100 OFFSET 0 msg_type: 81 auth_type: 0 postgresresponses: - header: [T, C, Z] identifier: ServerResponse length: 8 authentication_md5_password: salt: - 0 - 0 - 0 - 0 command_complete: - command_tag: - 83 - 69 - 76 - 69 - 67 - 84 - 32 - 48 ready_for_query: txstatus: 84 row_description: {fields: [{name: [115, 116, 117, 100, 101, 110, 116, 115, 95, 73, 68], table_oid: 24577, table_attribute_number: 1, data_type_oid: 23, data_type_size: 4, type_modifier: -1, format: 0}, {name: [115, 116, 117, 100, 101, 110, 116, 115, 95, 78, 97, 109, 101], table_oid: 24577, table_attribute_number: 2, data_type_oid: 1043, data_type_size: -1, type_modifier: -1, format: 0}, {name: [115, 116, 117, 100, 101, 110, 116, 115, 95, 69, 109, 97, 105, 108], table_oid: 24577, table_attribute_number: 3, data_type_oid: 1043, data_type_size: -1, type_modifier: -1, format: 0}, {name: [115, 116, 117, 100, 101, 110, 116, 115, 95, 72, 97, 115, 104, 101, 100, 32, 80, 97, 115, 115, 119, 111, 114, 100], table_oid: 24577, table_attribute_number: 4, data_type_oid: 1043, data_type_size: -1, type_modifier: -1, format: 0}, {name: [115, 116, 117, 100, 101, 110, 116, 115, 95, 83, 117, 98, 106, 101, 99, 116, 32, 83, 116, 114, 101, 97, 109], table_oid: 24577, table_attribute_number: 5, data_type_oid: 1043, data_type_size: -1, type_modifier: -1, format: 0}]} msg_type: 90 auth_type: 0 reqtimestampmock: 2023-11-06T10:42:43.063446464+05:30 restimestampmock: 2023-11-06T10:42:43.063544657+05:30 ``` Want to see if everything works as expected? #### Run Tests Time to put things to the test ๐Ÿงช ```shell keploy test -c "docker compose up" --container-name "fastapi-app" --build-delay 50 --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 DB response in the `mocks.yml`, or fiddle with the request or response in `test-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! โœจ๐Ÿ‘ฉโ€๐Ÿ’ป๐Ÿ‘จโ€๐Ÿ’ปโœจ ## Running App Locally on Linux/WSL ๐Ÿง We'll be running our sample application right on Linux, but just to make things a tad more thrilling, we'll have the database (PostgreSQL) chill on Docker. Ready? Let's get the party started!๐ŸŽ‰ ### Clone the sample Student Data CRUD app ๐Ÿงช ```bash git clone https://github.com/keploy/samples-python.git && cd samples-python/fastapi-postgres ``` ### Lights, Camera, Record! ๐ŸŽฅ Capture the test-cases- ```bash 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.** **1. Make a POST request** ```bash curl --location 'http://127.0.0.1:8000/students/' \ --header 'Content-Type: application/json' \ --data-raw '{ "name": "Eva White", "email": "evawhite@example.com", "password": "evawhite111" }' ``` **2. Make a GET request** ```bash curl --location 'http://127.0.0.1:8000/students/' ``` **3. Make a PUT request** ```bash curl --location --request PUT 'http://127.0.0.1:8000/students/1' \ --header 'Content-Type: application/json' \ --data-raw ' { "name": "John Dow", "email": "doe.john@example.com", "password": "johndoe123", "stream": "Arts" }' ``` **4. Make a GET request** ```bash curl --location 'http://127.0.0.1:8000/students/1' ``` **5. Make a DELETE request** ```bash curl --location --request DELETE 'http://127.0.0.1:8000/students/1' ``` 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` and `mocks.yml`. ```yaml version: api.keploy.io/v1beta2 kind: Http name: test-1 spec: metadata: {} req: method: GET proto_major: 1 proto_minor: 1 url: http://127.0.0.1:8000/students/ header: Accept: "*/*" Host: 127.0.0.1:8000 User-Agent: curl/7.81.0 body: "" body_type: "" timestamp: 2023-11-06T10:42:43.046337785+05:30 resp: status_code: 404 header: Content-Length: "29" Content-Type: application/json Date: Mon, 06 Nov 2023 05:12:42 GMT Server: uvicorn body: '{"detail":"Data not found!!"}' body_type: "" status_message: "" proto_major: 0 proto_minor: 0 timestamp: 2023-11-06T10:42:45.959907593+05:30 objects: [] assertions: noise: - header.Date created: 1699247565 curl: | curl --request GET \ --url http://127.0.0.1:8000/students/ \ --header 'User-Agent: curl/7.81.0' \ --header 'Accept: */*' \ --header 'Host: 127.0.0.1:8000' \ ``` This is how `mocks.yml` generated would look like:- ```yaml version: api.keploy.io/v1beta2 kind: Postgres name: mocks spec: metadata: {} postgresrequests: - header: [Q] identifier: ClientRequest length: 8 query: string: SELECT students."ID" AS "students_ID", students."Name" AS "students_Name", students."Email" AS "students_Email", students."Hashed Password" AS "students_Hashed Password", students."Subject Stream" AS "students_Subject Stream" FROM students LIMIT 100 OFFSET 0 msg_type: 81 auth_type: 0 postgresresponses: - header: [T, C, Z] identifier: ServerResponse length: 8 authentication_md5_password: salt: - 0 - 0 - 0 - 0 command_complete: - command_tag: - 83 - 69 - 76 - 69 - 67 - 84 - 32 - 48 ready_for_query: txstatus: 84 row_description: {fields: [{name: [115, 116, 117, 100, 101, 110, 116, 115, 95, 73, 68], table_oid: 24577, table_attribute_number: 1, data_type_oid: 23, data_type_size: 4, type_modifier: -1, format: 0}, {name: [115, 116, 117, 100, 101, 110, 116, 115, 95, 78, 97, 109, 101], table_oid: 24577, table_attribute_number: 2, data_type_oid: 1043, data_type_size: -1, type_modifier: -1, format: 0}, {name: [115, 116, 117, 100, 101, 110, 116, 115, 95, 69, 109, 97, 105, 108], table_oid: 24577, table_attribute_number: 3, data_type_oid: 1043, data_type_size: -1, type_modifier: -1, format: 0}, {name: [115, 116, 117, 100, 101, 110, 116, 115, 95, 72, 97, 115, 104, 101, 100, 32, 80, 97, 115, 115, 119, 111, 114, 100], table_oid: 24577, table_attribute_number: 4, data_type_oid: 1043, data_type_size: -1, type_modifier: -1, format: 0}, {name: [115, 116, 117, 100, 101, 110, 116, 115, 95, 83, 117, 98, 106, 101, 99, 116, 32, 83, 116, 114, 101, 97, 109], table_oid: 24577, table_attribute_number: 5, data_type_oid: 1043, data_type_size: -1, type_modifier: -1, format: 0}]} msg_type: 90 auth_type: 0 reqtimestampmock: 2023-11-06T10:42:43.063446464+05:30 restimestampmock: 2023-11-06T10:42:43.063544657+05:30 ``` Want to see if everything works as expected? #### Run Tests Time to put things to the test ๐Ÿงช ```shell 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 DB response in the `mocks.yml`, or fiddle with the request or response in `test-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. ๐Ÿ˜Š๐Ÿš€