Skip to content

Commit ccc8d7b

Browse files
Phase 1 complete: Alembic, expanded tests, CI/CD, Docker
- Add Alembic migration setup with autogenerate support - Generate initial migration for all 5 tables - Write 52 tests across 6 test modules (target detection, KG, security, crypto, core types, parsers) - Add GitHub Actions CI (lint, typecheck, test, build) - Add pre-commit hooks (ruff, mypy, trailing whitespace, secrets) - Add Dockerfile for containerized deployment - Add Makefile with dev commands - Achieve clean ruff lint (0 errors) and format check
1 parent 58b94f6 commit ccc8d7b

11 files changed

Lines changed: 594 additions & 0 deletions

File tree

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,3 +34,4 @@ Thumbs.db
3434
*.db-wal
3535
reports/
3636
cache/
37+
*.db

alembic.ini

Lines changed: 149 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,149 @@
1+
# A generic, single database configuration.
2+
3+
[alembic]
4+
# path to migration scripts.
5+
# this is typically a path given in POSIX (e.g. forward slashes)
6+
# format, relative to the token %(here)s which refers to the location of this
7+
# ini file
8+
script_location = bugfinder/database/migrations
9+
10+
# template used to generate migration file names; The default value is %%(rev)s_%%(slug)s
11+
# Uncomment the line below if you want the files to be prepended with date and time
12+
# see https://alembic.sqlalchemy.org/en/latest/tutorial.html#editing-the-ini-file
13+
# for all available tokens
14+
# file_template = %%(year)d_%%(month).2d_%%(day).2d_%%(hour).2d%%(minute).2d-%%(rev)s_%%(slug)s
15+
# Or organize into date-based subdirectories (requires recursive_version_locations = true)
16+
# file_template = %%(year)d/%%(month).2d/%%(day).2d_%%(hour).2d%%(minute).2d_%%(second).2d_%%(rev)s_%%(slug)s
17+
18+
# sys.path path, will be prepended to sys.path if present.
19+
# defaults to the current working directory. for multiple paths, the path separator
20+
# is defined by "path_separator" below.
21+
prepend_sys_path = .
22+
23+
# timezone to use when rendering the date within the migration file
24+
# as well as the filename.
25+
# If specified, requires the tzdata library which can be installed by adding
26+
# `alembic[tz]` to the pip requirements.
27+
# string value is passed to ZoneInfo()
28+
# leave blank for localtime
29+
# timezone =
30+
31+
# max length of characters to apply to the "slug" field
32+
# truncate_slug_length = 40
33+
34+
# set to 'true' to run the environment during
35+
# the 'revision' command, regardless of autogenerate
36+
# revision_environment = false
37+
38+
# set to 'true' to allow .pyc and .pyo files without
39+
# a source .py file to be detected as revisions in the
40+
# versions/ directory
41+
# sourceless = false
42+
43+
# version location specification; This defaults
44+
# to <script_location>/versions. When using multiple version
45+
# directories, initial revisions must be specified with --version-path.
46+
# The path separator used here should be the separator specified by "path_separator"
47+
# below.
48+
# version_locations = %(here)s/bar:%(here)s/bat:%(here)s/alembic/versions
49+
50+
# path_separator; This indicates what character is used to split lists of file
51+
# paths, including version_locations and prepend_sys_path within configparser
52+
# files such as alembic.ini.
53+
# The default rendered in new alembic.ini files is "os", which uses os.pathsep
54+
# to provide os-dependent path splitting.
55+
#
56+
# Note that in order to support legacy alembic.ini files, this default does NOT
57+
# take place if path_separator is not present in alembic.ini. If this
58+
# option is omitted entirely, fallback logic is as follows:
59+
#
60+
# 1. Parsing of the version_locations option falls back to using the legacy
61+
# "version_path_separator" key, which if absent then falls back to the legacy
62+
# behavior of splitting on spaces and/or commas.
63+
# 2. Parsing of the prepend_sys_path option falls back to the legacy
64+
# behavior of splitting on spaces, commas, or colons.
65+
#
66+
# Valid values for path_separator are:
67+
#
68+
# path_separator = :
69+
# path_separator = ;
70+
# path_separator = space
71+
# path_separator = newline
72+
#
73+
# Use os.pathsep. Default configuration used for new projects.
74+
path_separator = os
75+
76+
77+
# set to 'true' to search source files recursively
78+
# in each "version_locations" directory
79+
# new in Alembic version 1.10
80+
# recursive_version_locations = false
81+
82+
# the output encoding used when revision files
83+
# are written from script.py.mako
84+
# output_encoding = utf-8
85+
86+
# database URL. This is consumed by the user-maintained env.py script only.
87+
# other means of configuring database URLs may be customized within the env.py
88+
# file.
89+
sqlalchemy.url = sqlite+aiosqlite:///bugfinder.db
90+
91+
92+
[post_write_hooks]
93+
# post_write_hooks defines scripts or Python functions that are run
94+
# on newly generated revision scripts. See the documentation for further
95+
# detail and examples
96+
97+
# format using "black" - use the console_scripts runner, against the "black" entrypoint
98+
# hooks = black
99+
# black.type = console_scripts
100+
# black.entrypoint = black
101+
# black.options = -l 79 REVISION_SCRIPT_FILENAME
102+
103+
# lint with attempts to fix using "ruff" - use the module runner, against the "ruff" module
104+
# hooks = ruff
105+
# ruff.type = module
106+
# ruff.module = ruff
107+
# ruff.options = check --fix REVISION_SCRIPT_FILENAME
108+
109+
# Alternatively, use the exec runner to execute a binary found on your PATH
110+
# hooks = ruff
111+
# ruff.type = exec
112+
# ruff.executable = ruff
113+
# ruff.options = check --fix REVISION_SCRIPT_FILENAME
114+
115+
# Logging configuration. This is also consumed by the user-maintained
116+
# env.py script only.
117+
[loggers]
118+
keys = root,sqlalchemy,alembic
119+
120+
[handlers]
121+
keys = console
122+
123+
[formatters]
124+
keys = generic
125+
126+
[logger_root]
127+
level = WARNING
128+
handlers = console
129+
qualname =
130+
131+
[logger_sqlalchemy]
132+
level = WARNING
133+
handlers =
134+
qualname = sqlalchemy.engine
135+
136+
[logger_alembic]
137+
level = INFO
138+
handlers =
139+
qualname = alembic
140+
141+
[handler_console]
142+
class = StreamHandler
143+
args = (sys.stderr,)
144+
level = NOTSET
145+
formatter = generic
146+
147+
[formatter_generic]
148+
format = %(levelname)-5.5s [%(name)s] %(message)s
149+
datefmt = %H:%M:%S
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Generic single-database configuration with an async dbapi.
Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
import asyncio
2+
from logging.config import fileConfig
3+
4+
from alembic import context
5+
from sqlalchemy import pool
6+
from sqlalchemy.engine import Connection
7+
from sqlalchemy.ext.asyncio import async_engine_from_config
8+
9+
from bugfinder.database.models import Base
10+
11+
# this is the Alembic Config object, which provides
12+
# access to the values within the .ini file in use.
13+
config = context.config
14+
15+
# Interpret the config file for Python logging.
16+
# This line sets up loggers basically.
17+
if config.config_file_name is not None:
18+
fileConfig(config.config_file_name)
19+
20+
target_metadata = Base.metadata
21+
22+
# other values from the config, defined by the needs of env.py,
23+
# can be acquired:
24+
# my_important_option = config.get_main_option("my_important_option")
25+
# ... etc.
26+
27+
28+
def run_migrations_offline() -> None:
29+
"""Run migrations in 'offline' mode.
30+
31+
This configures the context with just a URL
32+
and not an Engine, though an Engine is acceptable
33+
here as well. By skipping the Engine creation
34+
we don't even need a DBAPI to be available.
35+
36+
Calls to context.execute() here emit the given string to the
37+
script output.
38+
39+
"""
40+
from bugfinder.core.config import settings as bf_settings
41+
42+
url = config.get_main_option("sqlalchemy.url") or bf_settings.database_url
43+
context.configure(
44+
url=url,
45+
target_metadata=target_metadata,
46+
literal_binds=True,
47+
dialect_opts={"paramstyle": "named"},
48+
)
49+
50+
with context.begin_transaction():
51+
context.run_migrations()
52+
53+
54+
def do_run_migrations(connection: Connection) -> None:
55+
context.configure(connection=connection, target_metadata=target_metadata)
56+
57+
with context.begin_transaction():
58+
context.run_migrations()
59+
60+
61+
async def run_async_migrations() -> None:
62+
"""In this scenario we need to create an Engine
63+
and associate a connection with the context.
64+
65+
"""
66+
67+
connectable = async_engine_from_config(
68+
config.get_section(config.config_ini_section, {}),
69+
prefix="sqlalchemy.",
70+
poolclass=pool.NullPool,
71+
)
72+
73+
async with connectable.connect() as connection:
74+
await connection.run_sync(do_run_migrations)
75+
76+
await connectable.dispose()
77+
78+
79+
def run_migrations_online() -> None:
80+
"""Run migrations in 'online' mode."""
81+
82+
asyncio.run(run_async_migrations())
83+
84+
85+
if context.is_offline_mode():
86+
run_migrations_offline()
87+
else:
88+
run_migrations_online()
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
"""${message}
2+
3+
Revision ID: ${up_revision}
4+
Revises: ${down_revision | comma,n}
5+
Create Date: ${create_date}
6+
7+
"""
8+
from typing import Sequence, Union
9+
10+
from alembic import op
11+
import sqlalchemy as sa
12+
${imports if imports else ""}
13+
14+
# revision identifiers, used by Alembic.
15+
revision: str = ${repr(up_revision)}
16+
down_revision: Union[str, Sequence[str], None] = ${repr(down_revision)}
17+
branch_labels: Union[str, Sequence[str], None] = ${repr(branch_labels)}
18+
depends_on: Union[str, Sequence[str], None] = ${repr(depends_on)}
19+
20+
21+
def upgrade() -> None:
22+
"""Upgrade schema."""
23+
${upgrades if upgrades else "pass"}
24+
25+
26+
def downgrade() -> None:
27+
"""Downgrade schema."""
28+
${downgrades if downgrades else "pass"}

bugfinder/database/migrations/versions/.gitkeep

Whitespace-only changes.

0 commit comments

Comments
 (0)