fastapi Architecture Docs
Home / File/ test_security_http_basic_optional.py — fastapi Source File

test_security_http_basic_optional.py — fastapi Source File

Architecture documentation for test_security_http_basic_optional.py, a python file in the fastapi codebase. 6 imports, 0 dependents.

File python FastAPI Routing 6 imports 6 functions

Entity Profile

Dependency Diagram

graph LR
  f53d8651_2da6_f60c_1064_37fc2a84cd8b["test_security_http_basic_optional.py"]
  734b7bd2_2a77_3a17_a6c0_ce892aafd817["base64"]
  f53d8651_2da6_f60c_1064_37fc2a84cd8b --> 734b7bd2_2a77_3a17_a6c0_ce892aafd817
  0dda2280_3359_8460_301c_e98c77e78185["typing"]
  f53d8651_2da6_f60c_1064_37fc2a84cd8b --> 0dda2280_3359_8460_301c_e98c77e78185
  534f6e44_61b8_3c38_8b89_6934a6df9802["__init__.py"]
  f53d8651_2da6_f60c_1064_37fc2a84cd8b --> 534f6e44_61b8_3c38_8b89_6934a6df9802
  35c4ea20_c454_5afd_6cda_f0818bbcc650["__init__.py"]
  f53d8651_2da6_f60c_1064_37fc2a84cd8b --> 35c4ea20_c454_5afd_6cda_f0818bbcc650
  a7c04dee_ee23_5891_b185_47ff6bed036d["testclient.py"]
  f53d8651_2da6_f60c_1064_37fc2a84cd8b --> a7c04dee_ee23_5891_b185_47ff6bed036d
  a7f4e7b0_9725_db90_5cbc_7ca8211b323a["inline_snapshot"]
  f53d8651_2da6_f60c_1064_37fc2a84cd8b --> a7f4e7b0_9725_db90_5cbc_7ca8211b323a
  style f53d8651_2da6_f60c_1064_37fc2a84cd8b fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

from base64 import b64encode
from typing import Optional

from fastapi import FastAPI, Security
from fastapi.security import HTTPBasic, HTTPBasicCredentials
from fastapi.testclient import TestClient
from inline_snapshot import snapshot

app = FastAPI()

security = HTTPBasic(auto_error=False)


@app.get("/users/me")
def read_current_user(credentials: Optional[HTTPBasicCredentials] = Security(security)):
    if credentials is None:
        return {"msg": "Create an account first"}
    return {"username": credentials.username, "password": credentials.password}


client = TestClient(app)


def test_security_http_basic():
    response = client.get("/users/me", auth=("john", "secret"))
    assert response.status_code == 200, response.text
    assert response.json() == {"username": "john", "password": "secret"}


def test_security_http_basic_no_credentials():
    response = client.get("/users/me")
    assert response.status_code == 200, response.text
    assert response.json() == {"msg": "Create an account first"}


def test_security_http_basic_invalid_credentials():
    response = client.get(
        "/users/me", headers={"Authorization": "Basic notabase64token"}
    )
    assert response.status_code == 401, response.text
    assert response.headers["WWW-Authenticate"] == "Basic"
    assert response.json() == {"detail": "Not authenticated"}


def test_security_http_basic_non_basic_credentials():
    payload = b64encode(b"johnsecret").decode("ascii")
    auth_header = f"Basic {payload}"
    response = client.get("/users/me", headers={"Authorization": auth_header})
    assert response.status_code == 401, response.text
    assert response.headers["WWW-Authenticate"] == "Basic"
    assert response.json() == {"detail": "Not authenticated"}


def test_openapi_schema():
    response = client.get("/openapi.json")
    assert response.status_code == 200, response.text
    assert response.json() == snapshot(
        {
            "openapi": "3.1.0",
            "info": {"title": "FastAPI", "version": "0.1.0"},
            "paths": {
                "/users/me": {
                    "get": {
                        "responses": {
                            "200": {
                                "description": "Successful Response",
                                "content": {"application/json": {"schema": {}}},
                            }
                        },
                        "summary": "Read Current User",
                        "operationId": "read_current_user_users_me_get",
                        "security": [{"HTTPBasic": []}],
                    }
                }
            },
            "components": {
                "securitySchemes": {"HTTPBasic": {"type": "http", "scheme": "basic"}}
            },
        }
    )

Domain

Subdomains

Functions

Dependencies

Source

Frequently Asked Questions

What does test_security_http_basic_optional.py do?
test_security_http_basic_optional.py is a source file in the fastapi codebase, written in python. It belongs to the FastAPI domain, Routing subdomain.
What functions are defined in test_security_http_basic_optional.py?
test_security_http_basic_optional.py defines 6 function(s): read_current_user, test_openapi_schema, test_security_http_basic, test_security_http_basic_invalid_credentials, test_security_http_basic_no_credentials, test_security_http_basic_non_basic_credentials.
What does test_security_http_basic_optional.py depend on?
test_security_http_basic_optional.py imports 6 module(s): __init__.py, __init__.py, base64, inline_snapshot, testclient.py, typing.
Where is test_security_http_basic_optional.py in the architecture?
test_security_http_basic_optional.py is located at tests/test_security_http_basic_optional.py (domain: FastAPI, subdomain: Routing, directory: tests).

Analyze Your Own Codebase

Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.

Try Supermodel Free