Skip to content

Commit

Permalink
- Database module is refactored
Browse files Browse the repository at this point in the history
- New command `set-timezone`
- Command `get-timestamp` uses a timezone from result of the previous command
  • Loading branch information
soksanichenko committed Mar 30, 2024
1 parent 057acb0 commit 2bb017b
Show file tree
Hide file tree
Showing 19 changed files with 458 additions and 86 deletions.
6 changes: 4 additions & 2 deletions ansible/roles/deploy_bot_container/defaults/main/docker.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
---
docker_lib_folder: "/var/lib/docker"
docker_volumes:
- "volumes/meow-bot/sources"
- "volumes/meow-bot/postgres"
sources:
path: "volumes/meow-bot/sources"
postgres:
path: "volumes/meow-bot/postgres"
docker_network: "active"
...
25 changes: 20 additions & 5 deletions ansible/roles/deploy_bot_container/tasks/docker.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,16 @@
register: timezone_output
changed_when: false

- name: Get existing of a docker network
docker_network_info:
name: "{{ docker_network }}"
register: docker_network_result

- name: Add a separate docker network
docker_network:
name: "{{ docker_network }}"
when: not docker_network_result.exists

- name: Create temporary build directory
tempfile:
state: directory
Expand All @@ -19,13 +29,13 @@

- name: Create volume directory for a container
file:
path: "{{ docker_lib_folder }}/{{ item }}"
path: "{{ docker_lib_folder }}/{{ item.value.path }}"
recurse: yes
state: directory
owner: root
group: root
become: yes
with_items: "{{ docker_volumes }}"
with_dict: "{{ docker_volumes }}"

- name: Copy req.txt for building a docker image
copy:
Expand All @@ -34,7 +44,7 @@

- name: Copy sources
synchronize:
dest: "{{ docker_lib_folder }}/volumes/meow-bot/sources"
dest: "{{ docker_lib_folder }}/{{ docker_volumes['sources']['path'] }}"
src: "../../../../sources/"
owner: false
group: false
Expand All @@ -59,7 +69,7 @@
restart_policy: always
restart: yes
mounts:
- source: "{{ docker_lib_folder }}/volumes/meow-bot/postgres"
- source: "{{ docker_lib_folder }}/{{ docker_volumes['postgres']['path'] }}"
target: "/var/lib/postgresql/data"
type: bind
networks:
Expand All @@ -77,8 +87,13 @@
state: started
restart_policy: always
restart: yes
entrypoint: |
bash -c
"venv/bin/python3 sources/scripts/create_db.py
venv/bin/alembic -c sources/alembic.ini upgrade head &&
venv/bin/python3 sources/scripts/main.py"
mounts:
- source: "{{ docker_lib_folder }}/volumes/meow-bot/sources"
- source: "{{ docker_lib_folder }}/{{ docker_volumes['sources']['path'] }}"
target: "/code/sources"
read_only: yes
type: bind
Expand Down
1 change: 0 additions & 1 deletion ansible/roles/deploy_bot_container/templates/Dockerfile.j2
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,3 @@ WORKDIR /code
COPY prod.txt sources/prod.txt
RUN python3.9 -m venv --symlinks venv
RUN source venv/bin/activate && python3.9 -m pip install pip -U && pip install -r sources/prod.txt
ENTRYPOINT ["venv/bin/python3", "sources/main.py"]
1 change: 1 addition & 0 deletions requirements/prod.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
alembic==1.13.1
asyncpg==0.29.0
discord==2.3.2
git+https://github.com/soksanichenko/dateparser.git@master
Expand Down
116 changes: 116 additions & 0 deletions sources/alembic.ini
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
# A generic, single database configuration.

[alembic]
# path to migration scripts
script_location = sources/lib/db/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
# 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.
# 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 sources/lib/db/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:sources/lib/db/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 = os # Use os.pathsep. Default configuration used for new projects.

# 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

# It's not used, because env.py is modified
# for using internal config & db_engine objects
# sqlalchemy.url = driver://user:pass@localhost/dbname


[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 = WARN
handlers = console
qualname =

[logger_sqlalchemy]
level = WARN
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
33 changes: 0 additions & 33 deletions sources/lib/commands/get_timestamp.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,39 +43,6 @@ def parse_and_validate(
)


class TimezoneView(discord.ui.View):
"""
View class for a user's timezone
"""

def __init__(self, date: str = '', time: str = ''):
super().__init__()
self.time = time
self.date = date

@discord.ui.select(
placeholder='Select timezone',
min_values=1,
max_values=1,
options=[
discord.SelectOption(label=timezone, description='')
for timezone in pytz.all_timezones
],
)
async def select_callback(
self,
interaction: discord.Interaction, # pylint: disable=W0613
select: discord.ui.Select,
):
"""
Callback for selecting a current user's timezone
:param interaction: an object of interaction with a user
:param select: a select option
:return: None
"""
return select.values[0]


class TimestampFormatView(discord.ui.View):
"""
View class for timestamp formatting
Expand Down
19 changes: 19 additions & 0 deletions sources/lib/commands/utils.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
"""
Utils for the bot commands
"""

import discord


async def get_command(
commands_tree: discord.app_commands.CommandTree,
command_name: str,
) -> discord.app_commands.Command:
"""
Get a command of the bot
:param commands_tree: A tree of commands
:param command_name: A name of command
:return: object of Command
"""
commands = await commands_tree.fetch_commands()
return next(iter(filter(lambda c: c.name == command_name, commands)))
14 changes: 0 additions & 14 deletions sources/lib/db/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,8 @@
async_sessionmaker,
async_scoped_session,
)
from sqlalchemy_utils import (
database_exists,
create_database,
)

from sources.config import config
from sources.lib.db.models import Base


async_engine = create_async_engine(url=config.async_db_url)
Expand All @@ -24,12 +19,3 @@
session_factory=async_session_factory,
scopefunc=current_task,
)


async def create_db_if_not_exists():
"""Creates database if it doesn't exist"""
async with AsyncSession() as db_session:
if not database_exists(config.sync_db_url):
create_database(config.sync_db_url)
async with db_session.bind.begin() as conn:
await conn.run_sync(Base.metadata.create_all)
1 change: 1 addition & 0 deletions sources/lib/db/alembic/README
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Generic single-database configuration with an async dbapi.
97 changes: 97 additions & 0 deletions sources/lib/db/alembic/env.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@
"""
Alembic env file
"""

import asyncio
from logging.config import fileConfig

from sqlalchemy.engine import Connection

from alembic import context

from sources.config import config as general_config
from sources.lib.db import async_engine
from sources.lib.db.models import Base

# this is the Alembic Config object, which provides
# access to the values within the .ini file in use.
config = context.config # pylint: disable=E1101

# 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.
"""
url = general_config.async_db_url
context.configure( # pylint: disable=E1101
url=url,
target_metadata=target_metadata,
literal_binds=True,
dialect_opts={"paramstyle": "named"},
)

with context.begin_transaction(): # pylint: disable=E1101
context.run_migrations() # pylint: disable=E1101


def do_run_migrations(connection: Connection) -> None:
"""
Run migrations
:param connection: Connection object
:return: None
"""
context.configure( # pylint: disable=E1101
connection=connection,
target_metadata=target_metadata,
)

with context.begin_transaction(): # pylint: disable=E1101
context.run_migrations() # pylint: disable=E1101


async def run_async_migrations() -> None:
"""In this scenario we need to create an Engine
and associate a connection with the context.
"""

async with async_engine.connect() as connection:
await connection.run_sync(do_run_migrations)

await async_engine.dispose()


def run_migrations_online() -> None:
"""Run migrations in 'online' mode."""

asyncio.run(run_async_migrations())


if context.is_offline_mode(): # pylint: disable=E1101
run_migrations_offline()
else:
run_migrations_online()
Loading

0 comments on commit 2bb017b

Please sign in to comment.