diff --git a/.env b/.env deleted file mode 100644 index 03dc5c3..0000000 --- a/.env +++ /dev/null @@ -1,3 +0,0 @@ -DEBUG=True -DATABASE_URL=postgresql+psycopg2://user:password@localhost:5432/url_db -BASE_URL=http://localhost:8000 \ No newline at end of file diff --git a/README.md b/README.md index cf24f59..5dc2252 100644 --- a/README.md +++ b/README.md @@ -24,4 +24,10 @@ http://127.0.0.1:8000/shorten PYTHONPATH=./ pytest export PYTHONPATH=$(pwd) python -m pytest --cov=app --cov-report=term-missing +``` + +## Running Alembic revision +```bash +cd /opt/kjc/int/URL-shortener +alembic revision --autogenerate -m "create urls table" ``` \ No newline at end of file diff --git a/alembic.ini b/alembic.ini new file mode 100644 index 0000000..f29c9f9 --- /dev/null +++ b/alembic.ini @@ -0,0 +1,118 @@ +# A generic, single database configuration. + +[alembic] +# path to migration scripts +# Use forward slashes (/) also on windows to provide an os agnostic path +script_location = alembic + +# template used to generate migration file names; The default value is %%(rev)s_%%(slug)s +# Uncomment the line below if you want the files to be prepended with date and time +# see https://alembic.sqlalchemy.org/en/latest/tutorial.html#editing-the-ini-file +# for all available tokens +# file_template = %%(year)d_%%(month).2d_%%(day).2d_%%(hour).2d%%(minute).2d-%%(rev)s_%%(slug)s + +# sys.path path, will be prepended to sys.path if present. +# defaults to the current working directory. +prepend_sys_path = . + +# timezone to use when rendering the date within the migration file +# as well as the filename. +# If specified, requires the python>=3.9 or backports.zoneinfo library and tzdata library. +# Any required deps can installed by adding `alembic[tz]` to the pip requirements +# string value is passed to ZoneInfo() +# leave blank for localtime +# timezone = + +# max length of characters to apply to the "slug" field +# truncate_slug_length = 40 + +# set to 'true' to run the environment during +# the 'revision' command, regardless of autogenerate +# revision_environment = false + +# set to 'true' to allow .pyc and .pyo files without +# a source .py file to be detected as revisions in the +# versions/ directory +# sourceless = false + +# version location specification; This defaults +# to alembic/versions. When using multiple version +# directories, initial revisions must be specified with --version-path. +# The path separator used here should be the separator specified by "version_path_separator" below. +# version_locations = %(here)s/bar:%(here)s/bat:alembic/versions + +# version path separator; As mentioned above, this is the character used to split +# version_locations. The default within new alembic.ini files is "os", which uses os.pathsep. +# If this key is omitted entirely, it falls back to the legacy behavior of splitting on spaces and/or commas. +# Valid values for version_path_separator are: +# +# version_path_separator = : +# version_path_separator = ; +# version_path_separator = space +# version_path_separator = newline +# +# Use os.pathsep. Default configuration used for new projects. +version_path_separator = os + +# set to 'true' to search source files recursively +# in each "version_locations" directory +# new in Alembic version 1.10 +# recursive_version_locations = false + +# the output encoding used when revision files +# are written from script.py.mako +# output_encoding = utf-8 + +sqlalchemy.url = sqlite:///./test.db + +[post_write_hooks] +# post_write_hooks defines scripts or Python functions that are run +# on newly generated revision scripts. See the documentation for further +# detail and examples + +# format using "black" - use the console_scripts runner, against the "black" entrypoint +# hooks = black +# black.type = console_scripts +# black.entrypoint = black +# black.options = -l 79 REVISION_SCRIPT_FILENAME + +# lint with attempts to fix using "ruff" - use the exec runner, execute a binary +# hooks = ruff +# ruff.type = exec +# ruff.executable = %(here)s/.venv/bin/ruff +# ruff.options = --fix REVISION_SCRIPT_FILENAME + +# Logging configuration +[loggers] +keys = root,sqlalchemy,alembic + +[handlers] +keys = console + +[formatters] +keys = generic + +[logger_root] +level = WARNING +handlers = console +qualname = + +[logger_sqlalchemy] +level = WARNING +handlers = +qualname = sqlalchemy.engine + +[logger_alembic] +level = INFO +handlers = +qualname = alembic + +[handler_console] +class = StreamHandler +args = (sys.stderr,) +level = NOTSET +formatter = generic + +[formatter_generic] +format = %(levelname)-5.5s [%(name)s] %(message)s +datefmt = %H:%M:%S diff --git a/alembic/README b/alembic/README new file mode 100644 index 0000000..98e4f9c --- /dev/null +++ b/alembic/README @@ -0,0 +1 @@ +Generic single-database configuration. \ No newline at end of file diff --git a/alembic/env.py b/alembic/env.py new file mode 100644 index 0000000..4125426 --- /dev/null +++ b/alembic/env.py @@ -0,0 +1,82 @@ +from alembic import context +from sqlalchemy import engine_from_config, pool +from logging.config import fileConfig + +from app.db.base import Base +from app.db import models +from app.core.config import settings + +target_metadata = Base.metadata + +# this is the Alembic Config object, which provides +# access to the values within the .ini file in use. +config = context.config + +# Interpret the config file for Python logging. +# This line sets up loggers basically. +if config.config_file_name is not None: + fileConfig(config.config_file_name) + +# add your model's MetaData object here +# for 'autogenerate' support +# from myapp import mymodel +# target_metadata = mymodel.Base.metadata +target_metadata = Base.metadata + +# other values from the config, defined by the needs of env.py, +# can be acquired: +# my_important_option = config.get_main_option("my_important_option") +# ... etc. + + +def run_migrations_offline() -> None: + """Run migrations in 'offline' mode. + + This configures the context with just a URL + and not an Engine, though an Engine is acceptable + here as well. By skipping the Engine creation + we don't even need a DBAPI to be available. + + Calls to context.execute() here emit the given string to the + script output. + + """ + + config.set_main_option("sqlalchemy.url", settings.database_url) + context.configure( + url=url, + target_metadata=target_metadata, + literal_binds=True, + dialect_opts={"paramstyle": "named"}, + ) + + with context.begin_transaction(): + context.run_migrations() + + +def run_migrations_online() -> None: + """Run migrations in 'online' mode. + + In this scenario we need to create an Engine + and associate a connection with the context. + + """ + connectable = engine_from_config( + config.get_section(config.config_ini_section, {}), + prefix="sqlalchemy.", + poolclass=pool.NullPool, + ) + + with connectable.connect() as connection: + context.configure( + connection=connection, target_metadata=target_metadata + ) + + with context.begin_transaction(): + context.run_migrations() + + +if context.is_offline_mode(): + run_migrations_offline() +else: + run_migrations_online() diff --git a/alembic/script.py.mako b/alembic/script.py.mako new file mode 100644 index 0000000..fbc4b07 --- /dev/null +++ b/alembic/script.py.mako @@ -0,0 +1,26 @@ +"""${message} + +Revision ID: ${up_revision} +Revises: ${down_revision | comma,n} +Create Date: ${create_date} + +""" +from typing import Sequence, Union + +from alembic import op +import sqlalchemy as sa +${imports if imports else ""} + +# revision identifiers, used by Alembic. +revision: str = ${repr(up_revision)} +down_revision: Union[str, None] = ${repr(down_revision)} +branch_labels: Union[str, Sequence[str], None] = ${repr(branch_labels)} +depends_on: Union[str, Sequence[str], None] = ${repr(depends_on)} + + +def upgrade() -> None: + ${upgrades if upgrades else "pass"} + + +def downgrade() -> None: + ${downgrades if downgrades else "pass"} diff --git a/alembic/versions/0132ba841ec5_create_urls_table.py b/alembic/versions/0132ba841ec5_create_urls_table.py new file mode 100644 index 0000000..a6633ce --- /dev/null +++ b/alembic/versions/0132ba841ec5_create_urls_table.py @@ -0,0 +1,30 @@ +"""create urls table + +Revision ID: 0132ba841ec5 +Revises: +Create Date: 2026-03-02 09:13:50.764599 + +""" +from typing import Sequence, Union + +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision: str = '0132ba841ec5' +down_revision: Union[str, None] = None +branch_labels: Union[str, Sequence[str], None] = None +depends_on: Union[str, Sequence[str], None] = None + + +def upgrade() -> None: + # ### commands auto generated by Alembic - please adjust! ### + pass + # ### end Alembic commands ### + + +def downgrade() -> None: + # ### commands auto generated by Alembic - please adjust! ### + pass + # ### end Alembic commands ### diff --git a/app/core/config.py b/app/core/config.py index 54c8793..ec944bf 100644 --- a/app/core/config.py +++ b/app/core/config.py @@ -1,7 +1,7 @@ # app/core/config.py from functools import lru_cache -from pydantic import BaseSettings +from pydantic_settings import BaseSettings from typing import List diff --git a/app/test_main.py b/app/test_main.py deleted file mode 100644 index bfe170a..0000000 --- a/app/test_main.py +++ /dev/null @@ -1,66 +0,0 @@ -from fastapi.testclient import TestClient -import sys -import os - -sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), '..'))) -from app.main import app -from app.core.config import settings -import tempfile -import pytest - -@pytest.fixture -def test_client(): - with tempfile.NamedTemporaryFile() as tmp: - settings.database_url = tmp.name - with TestClient(app) as c: - yield c - -@pytest.fixture -def use_temp_db(): - with tempfile.NamedTemporaryFile() as tmp: - settings.database_url = tmp.name - yield - -def test_home(test_client): - response = test_client.get("/") - assert response.status_code == 200 - assert response.json() == {"message": "URL Shortener API"} - -def test_shorten_url(test_client): - response = test_client.post("/shorten", json={"url": "https://google.com"}) - assert response.status_code == 200 - data = response.json() - assert "short_url" in data - short_url = data["short_url"] - assert short_url.startswith("http://localhost:8000/") - -def test_redirect(test_client): - response = test_client.post("/shorten", json={"url": "https://google.com"}) - short_url = response.json()["short_url"] - code = short_url.split("/")[-1] - - redirect = test_client.get(f"/{code}", follow_redirects=False) - assert redirect.status_code == 307 - -def test_duplicate_url_returns_same_code(test_client): - r1 = test_client.post("/shorten", json={"url": "https://example.com"}) - r2 = test_client.post("/shorten", json={"url": "https://example.com"}) - - assert r1.status_code == 200 - assert r2.status_code == 200 - assert r1.json()["short_url"] == r2.json()["short_url"] - -def test_stats_endpoint(test_client): - response = test_client.post("/shorten", json={"url": "https://stats-test.com"}) - code = response.json()["short_url"].split("/")[-1] - - test_client.get(f"/{code}", follow_redirects=False) - - stats = test_client.get(f"/stats/{code}") - assert stats.status_code == 200 - data = stats.json() - assert data["clicks"] == 1 - -def test_redirect_404(test_client): - response = test_client.get("/nonexistent", follow_redirects=False) - assert response.status_code == 404 \ No newline at end of file diff --git a/app/tests/conftest.py b/app/tests/conftest.py index 226c36c..55dffc8 100644 --- a/app/tests/conftest.py +++ b/app/tests/conftest.py @@ -1,4 +1,4 @@ -# tests/conftest.py +# app/tests/conftest.py import pytest from sqlalchemy import create_engine diff --git a/app/tests/test_routes.py b/app/tests/test_routes.py index 13498ee..c1edf37 100644 --- a/app/tests/test_routes.py +++ b/app/tests/test_routes.py @@ -1,4 +1,4 @@ -# tests/test_routes.py +# app/tests/test_routes.py import pytest diff --git a/app/utils.py b/app/utils.py index 785e0b4..efe5e4f 100644 --- a/app/utils.py +++ b/app/utils.py @@ -1,3 +1,5 @@ +# app/utils.py + import string import random diff --git a/test.db b/test.db index efee9ea..32c0952 100644 Binary files a/test.db and b/test.db differ diff --git a/urls.db b/urls.db deleted file mode 100644 index f14833d..0000000 Binary files a/urls.db and /dev/null differ