{"id":135338,"date":"2024-09-06T10:30:46","date_gmt":"2024-09-06T05:00:46","guid":{"rendered":"https:\/\/www.vskills.in\/certification\/tutorial\/?page_id=135338"},"modified":"2024-09-06T10:34:08","modified_gmt":"2024-09-06T05:04:08","slug":"running-fastapi-tests-in-test-mode","status":"publish","type":"page","link":"https:\/\/www.vskills.in\/certification\/tutorial\/running-fastapi-tests-in-test-mode\/","title":{"rendered":"Running FastAPI Tests in &#8216;Test&#8217; Mode"},"content":{"rendered":"\n<p>When developing and testing FastAPI applications, it&#8217;s often desirable to run the application in a &#8216;test&#8217; mode with specific configurations or behaviors. This can help isolate tests, prevent unintended side effects, and streamline the development process.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\"><strong>Creating a Test Configuration<\/strong><\/h2>\n\n\n\n<p><strong>Define a Configuration Model:<\/strong><\/p>\n\n\n\n<p>Python<\/p>\n\n\n\n<p>from pydantic import BaseModel<\/p>\n\n\n\n<p>class Settings(BaseModel):<br>debug: bool = True<br>test_mode: bool = False<\/p>\n\n\n\n<p><strong>Load the Configuration:<\/strong><\/p>\n\n\n\n<p>Python<\/p>\n\n\n\n<p>from dotenv import load_dotenv<br>from pathlib import Path<\/p>\n\n\n\n<p>def get_settings():<br>load_dotenv()<br>return Settings()<\/p>\n\n\n\n<p><strong>Inject the Configuration into Endpoints:<\/strong><\/p>\n\n\n\n<p>Python<\/p>\n\n\n\n<p>from fastapi import Depends<\/p>\n\n\n\n<p>def get_settings(settings: Settings = Depends(get_settings)):<br>return settings<\/p>\n\n\n\n<h2 class=\"wp-block-heading\"><strong>Running Tests in Test Mode<\/strong><\/h2>\n\n\n\n<p><strong>Set the <code>TEST_MODE<\/code> Environment Variable:<\/strong><\/p>\n\n\n\n<p>Bash<\/p>\n\n\n\n<p>export TEST_MODE=True<\/p>\n\n\n\n<p><strong>Use the Configuration in Tests:<\/strong><\/p>\n\n\n\n<p>Python<\/p>\n\n\n\n<p>def test_read_root(client, settings: Settings = Depends(get_settings)):<br>assert settings.test_mode<br># Perform test logic<\/p>\n\n\n\n<h2 class=\"wp-block-heading\"><strong>Conditional Logic in Endpoints<\/strong><\/h2>\n\n\n\n<p>You can use the <code class=\"\">test_mode<\/code> flag to conditionally modify the behavior of your endpoints:<\/p>\n\n\n\n<p>Python<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>@app.get(\"\/\")\ndef read_root(settings: Settings = Depends(get_settings)):\n    if settings.test_mode:\n        return {\"message\": \"This is test mode\"}\n    else:\n        # Regular endpoint logic\n<\/code><\/pre>\n\n\n\n<p>By running FastAPI tests in &#8216;test&#8217; mode, you can create a controlled environment for testing your application&#8217;s functionality, ensuring that it behaves as expected in different scenarios.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>When developing and testing FastAPI applications, it&#8217;s often desirable to run the application in a &#8216;test&#8217; mode with specific configurations or behaviors. This can help isolate tests, prevent unintended side effects, and streamline the development process. Creating a Test Configuration Define a Configuration Model: Python from pydantic import BaseModel class Settings(BaseModel):debug: bool = Truetest_mode: bool&#8230;<\/p>\n","protected":false},"author":16,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":""},"categories":[],"tags":[],"class_list":["post-135338","page","type-page","status-publish","hentry"],"acf":[],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v24.5 - https:\/\/yoast.com\/wordpress\/plugins\/seo\/ -->\n<title>Running FastAPI Tests in &#039;Test&#039; Mode - Tutorial<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/www.vskills.in\/certification\/tutorial\/running-fastapi-tests-in-test-mode\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Running FastAPI Tests in &#039;Test&#039; Mode - Tutorial\" \/>\n<meta property=\"og:description\" content=\"When developing and testing FastAPI applications, it&#8217;s often desirable to run the application in a &#8216;test&#8217; mode with specific configurations or behaviors. This can help isolate tests, prevent unintended side effects, and streamline the development process. Creating a Test Configuration Define a Configuration Model: Python from pydantic import BaseModel class Settings(BaseModel):debug: bool = Truetest_mode: bool...\" \/>\n<meta property=\"og:url\" content=\"https:\/\/www.vskills.in\/certification\/tutorial\/running-fastapi-tests-in-test-mode\/\" \/>\n<meta property=\"og:site_name\" content=\"Tutorial\" \/>\n<meta property=\"article:publisher\" content=\"https:\/\/www.facebook.com\/vskills.in\/\" \/>\n<meta property=\"article:modified_time\" content=\"2024-09-06T05:04:08+00:00\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"1 minute\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/www.vskills.in\/certification\/tutorial\/running-fastapi-tests-in-test-mode\/\",\"url\":\"https:\/\/www.vskills.in\/certification\/tutorial\/running-fastapi-tests-in-test-mode\/\",\"name\":\"Running FastAPI Tests in 'Test' Mode - Tutorial\",\"isPartOf\":{\"@id\":\"https:\/\/www.vskills.in\/certification\/tutorial\/#website\"},\"datePublished\":\"2024-09-06T05:00:46+00:00\",\"dateModified\":\"2024-09-06T05:04:08+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/www.vskills.in\/certification\/tutorial\/running-fastapi-tests-in-test-mode\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/www.vskills.in\/certification\/tutorial\/running-fastapi-tests-in-test-mode\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/www.vskills.in\/certification\/tutorial\/running-fastapi-tests-in-test-mode\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/www.vskills.in\/certification\/tutorial\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Running FastAPI Tests in &#8216;Test&#8217; Mode\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/www.vskills.in\/certification\/tutorial\/#website\",\"url\":\"https:\/\/www.vskills.in\/certification\/tutorial\/\",\"name\":\"Tutorial\",\"description\":\"Vskills - A initiative in elearning and certification\",\"publisher\":{\"@id\":\"https:\/\/www.vskills.in\/certification\/tutorial\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/www.vskills.in\/certification\/tutorial\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/www.vskills.in\/certification\/tutorial\/#organization\",\"name\":\"Vskills\",\"url\":\"https:\/\/www.vskills.in\/certification\/tutorial\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/www.vskills.in\/certification\/tutorial\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/www.vskills.in\/certification\/tutorial\/wp-content\/uploads\/2017\/07\/vskills-min-logo.jpg\",\"contentUrl\":\"https:\/\/www.vskills.in\/certification\/tutorial\/wp-content\/uploads\/2017\/07\/vskills-min-logo.jpg\",\"width\":73,\"height\":55,\"caption\":\"Vskills\"},\"image\":{\"@id\":\"https:\/\/www.vskills.in\/certification\/tutorial\/#\/schema\/logo\/image\/\"},\"sameAs\":[\"https:\/\/www.facebook.com\/vskills.in\/\",\"https:\/\/x.com\/vskills_in\",\"https:\/\/www.linkedin.com\/company-beta\/1371554\/\",\"https:\/\/www.youtube.com\/channel\/UCMWnscxPwRF_PqXo9B7q_Tw\"]}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Running FastAPI Tests in 'Test' Mode - Tutorial","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/www.vskills.in\/certification\/tutorial\/running-fastapi-tests-in-test-mode\/","og_locale":"en_US","og_type":"article","og_title":"Running FastAPI Tests in 'Test' Mode - Tutorial","og_description":"When developing and testing FastAPI applications, it&#8217;s often desirable to run the application in a &#8216;test&#8217; mode with specific configurations or behaviors. This can help isolate tests, prevent unintended side effects, and streamline the development process. Creating a Test Configuration Define a Configuration Model: Python from pydantic import BaseModel class Settings(BaseModel):debug: bool = Truetest_mode: bool...","og_url":"https:\/\/www.vskills.in\/certification\/tutorial\/running-fastapi-tests-in-test-mode\/","og_site_name":"Tutorial","article_publisher":"https:\/\/www.facebook.com\/vskills.in\/","article_modified_time":"2024-09-06T05:04:08+00:00","twitter_misc":{"Est. reading time":"1 minute"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/www.vskills.in\/certification\/tutorial\/running-fastapi-tests-in-test-mode\/","url":"https:\/\/www.vskills.in\/certification\/tutorial\/running-fastapi-tests-in-test-mode\/","name":"Running FastAPI Tests in 'Test' Mode - Tutorial","isPartOf":{"@id":"https:\/\/www.vskills.in\/certification\/tutorial\/#website"},"datePublished":"2024-09-06T05:00:46+00:00","dateModified":"2024-09-06T05:04:08+00:00","breadcrumb":{"@id":"https:\/\/www.vskills.in\/certification\/tutorial\/running-fastapi-tests-in-test-mode\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/www.vskills.in\/certification\/tutorial\/running-fastapi-tests-in-test-mode\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/www.vskills.in\/certification\/tutorial\/running-fastapi-tests-in-test-mode\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/www.vskills.in\/certification\/tutorial\/"},{"@type":"ListItem","position":2,"name":"Running FastAPI Tests in &#8216;Test&#8217; Mode"}]},{"@type":"WebSite","@id":"https:\/\/www.vskills.in\/certification\/tutorial\/#website","url":"https:\/\/www.vskills.in\/certification\/tutorial\/","name":"Tutorial","description":"Vskills - A initiative in elearning and certification","publisher":{"@id":"https:\/\/www.vskills.in\/certification\/tutorial\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/www.vskills.in\/certification\/tutorial\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/www.vskills.in\/certification\/tutorial\/#organization","name":"Vskills","url":"https:\/\/www.vskills.in\/certification\/tutorial\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/www.vskills.in\/certification\/tutorial\/#\/schema\/logo\/image\/","url":"https:\/\/www.vskills.in\/certification\/tutorial\/wp-content\/uploads\/2017\/07\/vskills-min-logo.jpg","contentUrl":"https:\/\/www.vskills.in\/certification\/tutorial\/wp-content\/uploads\/2017\/07\/vskills-min-logo.jpg","width":73,"height":55,"caption":"Vskills"},"image":{"@id":"https:\/\/www.vskills.in\/certification\/tutorial\/#\/schema\/logo\/image\/"},"sameAs":["https:\/\/www.facebook.com\/vskills.in\/","https:\/\/x.com\/vskills_in","https:\/\/www.linkedin.com\/company-beta\/1371554\/","https:\/\/www.youtube.com\/channel\/UCMWnscxPwRF_PqXo9B7q_Tw"]}]}},"_links":{"self":[{"href":"https:\/\/www.vskills.in\/certification\/tutorial\/wp-json\/wp\/v2\/pages\/135338","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.vskills.in\/certification\/tutorial\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/www.vskills.in\/certification\/tutorial\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/www.vskills.in\/certification\/tutorial\/wp-json\/wp\/v2\/users\/16"}],"replies":[{"embeddable":true,"href":"https:\/\/www.vskills.in\/certification\/tutorial\/wp-json\/wp\/v2\/comments?post=135338"}],"version-history":[{"count":2,"href":"https:\/\/www.vskills.in\/certification\/tutorial\/wp-json\/wp\/v2\/pages\/135338\/revisions"}],"predecessor-version":[{"id":135349,"href":"https:\/\/www.vskills.in\/certification\/tutorial\/wp-json\/wp\/v2\/pages\/135338\/revisions\/135349"}],"wp:attachment":[{"href":"https:\/\/www.vskills.in\/certification\/tutorial\/wp-json\/wp\/v2\/media?parent=135338"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.vskills.in\/certification\/tutorial\/wp-json\/wp\/v2\/categories?post=135338"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.vskills.in\/certification\/tutorial\/wp-json\/wp\/v2\/tags?post=135338"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}