Compare commits

..

5 Commits

24 changed files with 148 additions and 472 deletions

View File

@ -1,11 +1,5 @@
ADMIN_EMAIL="" ADMIN_EMAIL=""
ADMIN_FIRST_NAME="" ADMIN_FIRST_NAME=""
APP_LIFECYCLE="dev"
APPROVED_DOMAINS="example.com,hello.com"
APPROVED_ROOMS="abc123,def456"
APPROVED_USERS="bob@example.com,john@me.com"
BOT_NAME="" BOT_NAME=""
N8N_WEBHOOK_URL="" N8N_WEBHOOK_URL=""
SENTRY_DSN=""
SENTRY_ENABLED="False"
WEBEX_API_KEY="" WEBEX_API_KEY=""

1
.github/CODEOWNERS vendored
View File

@ -1 +0,0 @@
* @luketainton

View File

@ -1,44 +0,0 @@
version: 2
updates:
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "daily"
assignees:
- "luketainton"
# reviewers:
# - "luketainton"
commit-message:
prefix: "chore(actions)"
include: "scope"
labels:
- "dependencies"
- package-ecosystem: "docker"
directory: "/"
schedule:
interval: "daily"
assignees:
- "luketainton"
# reviewers:
# - "luketainton"
commit-message:
prefix: "chore(docker)"
include: "scope"
labels:
- "dependencies"
- package-ecosystem: "pip"
directory: "/"
schedule:
interval: "daily"
assignees:
- "luketainton"
# reviewers:
# - "luketainton"
commit-message:
prefix: "chore(pip-prod)"
prefix-development: "chore(pip-dev)"
include: "scope"
labels:
- "dependencies"

View File

@ -1,64 +0,0 @@
name: Build
on:
push:
branches: [main]
env:
REGISTRY: ghcr.io
IMAGE_NAME: ${{ github.repository }}
jobs:
release:
name: Release
runs-on: ubuntu-latest
outputs:
new_tag: ${{ steps.tag_version.outputs.new_tag }}
steps:
- uses: actions/checkout@v4
- name: Bump version and push tag
id: tag_version
uses: mathieudutour/github-tag-action@v6.2
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
default_bump: minor
- name: Create a GitHub release
uses: ncipollo/release-action@v1
with:
tag: ${{ steps.tag_version.outputs.new_tag }}
name: ${{ steps.tag_version.outputs.new_tag }}
body: ${{ steps.tag_version.outputs.changelog }}
generateReleaseNotes: true
publish:
name: GitHub Container Registry
runs-on: ubuntu-latest
needs: release
permissions:
contents: read
packages: write
steps:
- uses: actions/checkout@v4
- name: Login to GitHub Container Registry
run: echo ${{ secrets.GITHUB_TOKEN }} | docker login ${{ env.REGISTRY }} -u ${{ github.actor }} --password-stdin
- name: Build image for GitHub Package Registry
run: |
docker build . --file Dockerfile \
--build-arg "version=${{ needs.release.outputs.new_tag }}" \
--tag ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${{ needs.release.outputs.new_tag }} \
--tag ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:latest
- name: Push image to GitHub Package Registry
run: |
docker push ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:latest
docker push ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${{ needs.release.outputs.new_tag }}
# deploy:
# name: Update Portainer Deployment
# runs-on: ubuntu-latest
# needs: publish
# steps:
# - uses: fjogeleit/http-request-action@v1
# with:
# url: ${{ secrets.PORTAINER_WEBHOOK_URL }}
# method: POST
# timeout: 60000
# preventFailureOnNoResponse: "true"

View File

@ -6,13 +6,16 @@ on:
- "README.md" - "README.md"
- "LICENSE.md" - "LICENSE.md"
- ".gitignore" - ".gitignore"
- ".github/CODEOWNERS" - "CODEOWNERS"
- ".github/renovate.json" - "renovate.json"
- ".github/dependabot.yml"
jobs: jobs:
ci: pythonci:
uses: luketainton/gha-workflows/.github/workflows/ci-python-with-docker.yml@main uses: luketainton/gha-workflows/.github/workflows/ci-python.yml@main
secrets:
SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
dockerci:
uses: luketainton/gha-workflows/.github/workflows/ci-docker.yml@main
secrets: secrets:
SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }} SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
SNYK_TOKEN: ${{ secrets.SNYK_TOKEN }}

View File

@ -1,18 +1,51 @@
name: Release name: Build
on: on:
workflow_dispatch: push:
schedule: branches: [main]
- cron: "0 9 * * 0"
jobs: jobs:
create_release: release:
name: Create Release name: Release
uses: luketainton/gha-workflows/.github/workflows/create-release.yml@main runs-on: ubuntu-latest
outputs:
new_tag: ${{ steps.tag_version.outputs.new_tag }}
steps:
- uses: actions/checkout@v4
- name: Bump version and push tag
id: tag_version
uses: mathieudutour/github-tag-action@v6.1
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
default_bump: minor
- name: Create a GitHub release
uses: ncipollo/release-action@v1
with:
tag: ${{ steps.tag_version.outputs.new_tag }}
name: ${{ steps.tag_version.outputs.new_tag }}
body: ${{ steps.tag_version.outputs.changelog }}
create_docker: publish:
name: Create Docker Image name: GitHub Container Registry
needs: create_release runs-on: ubuntu-latest
if: ${{ needs.create_release.outputs.success == 'true' }} needs: release
uses: luketainton/gha-workflows/.github/workflows/build-push-attest-docker.yml@main steps:
with: - uses: actions/checkout@v4
release: ${{ needs.create_release.outputs.release_name }} - name: Login to GitHub Container Registry
run: echo ${{ secrets.GHCR_ACCESS_TOKEN }} | docker login ghcr.io -u luketainton --password-stdin
- name: Build image for GitHub Package Registry
run: docker build . --file Dockerfile --tag ghcr.io/luketainton/roboluke-tasks:${{ needs.release.outputs.new_tag }} --tag ghcr.io/luketainton/roboluke-tasks:latest
- name: Push image to GitHub Package Registry
run: |
docker push ghcr.io/luketainton/roboluke-tasks:latest
docker push ghcr.io/luketainton/roboluke-tasks:${{ needs.release.outputs.new_tag }}
deploy:
name: Update Portainer Deployment
runs-on: ubuntu-latest
steps:
- uses: fjogeleit/http-request-action@v1
with:
url: ${{ secrets.PORTAINER_WEBHOOK_URL }}
method: POST
timeout: 30000
preventFailureOnNoResponse: 'true'

View File

@ -1,60 +0,0 @@
fail_fast: false
minimum_pre_commit_version: 3.8.0
default_install_hook_types: [pre-commit, commit-msg]
default_language_version:
python: python3.11
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.6.0
hooks:
- id: trailing-whitespace
- id: mixed-line-ending
- id: end-of-file-fixer
- id: requirements-txt-fixer
- id: check-yaml
- id: check-added-large-files
- id: check-ast
- id: check-docstring-first
- id: check-json
- id: check-merge-conflict
- id: check-toml
- id: check-xml
- id: detect-private-key
- id: no-commit-to-branch
- id: requirements-txt-fixer
- id: name-tests-test
args: [--pytest-test-first]
- id: pretty-format-json
args: [--autofix]
- repo: https://github.com/astral-sh/ruff-pre-commit
rev: v0.5.6
hooks:
- id: ruff-format # Run the formatter.
- id: ruff # Run the linter.
args: [--fix]
- repo: https://github.com/pycqa/isort
rev: 5.13.2
hooks:
- id: isort
- repo: https://github.com/pre-commit/pygrep-hooks
rev: v1.10.0
hooks:
- id: python-use-type-annotations
- repo: https://github.com/asottile/pyupgrade
rev: v3.17.0
hooks:
- id: pyupgrade
- repo: https://github.com/compilerla/conventional-pre-commit
rev: v3.4.0
hooks:
- id: conventional-pre-commit
stages: [commit-msg]

1
CODEOWNERS Normal file
View File

@ -0,0 +1 @@
* @luketainton

View File

@ -15,7 +15,4 @@ RUN pip install --no-cache-dir -r requirements.txt
ENTRYPOINT ["python3", "-B", "-m", "app.main"] ENTRYPOINT ["python3", "-B", "-m", "app.main"]
ARG version="dev"
ENV APP_VERSION=$version
COPY app /run/app COPY app /run/app

View File

@ -9,14 +9,8 @@ Add tasks to a Wekan to do list via Webex and n8n.
3. Edit `.env` as required: 3. Edit `.env` as required:
- `ADMIN_EMAIL` - comma-separated list of admin (who owns the to-do list) email addresses - `ADMIN_EMAIL` - comma-separated list of admin (who owns the to-do list) email addresses
- `ADMIN_FIRST_NAME` - admin first name - `ADMIN_FIRST_NAME` - admin first name
- `APP_LIFECYCLE` - for use in Sentry only, set the name of the environment
- `APPROVED_DOMAINS` - comma-separated list of domains that users are allowed to message the bot from
- `APPROVED_ROOMS` - comma-separated list of room IDs that users are allowed to message the bot from
- `APPROVED_USERS` - comma-separated list of email addresses of approved users
- `BOT_NAME` - Webex bot name - `BOT_NAME` - Webex bot name
- `N8N_WEBHOOK_URL` - n8n webhook URL - `N8N_WEBHOOK_URL` - n8n webhook URL
- `SENTRY_DSN` - for use in Sentry only, set the DSN of the Sentry project
- `SENTRY_ENABLED` - for use in Sentry only, enable sending data to Sentry
- `WEBEX_API_KEY` - Webex API key - `WEBEX_API_KEY` - Webex API key
## How to use ## How to use

View File

@ -1,7 +1,6 @@
#!/usr/bin/env python3 #!/usr/bin/env python3
import logging import logging
import sentry_sdk
from webex_bot.models.command import Command from webex_bot.models.command import Command
from webex_bot.models.response import Response, response_from_adaptive_card from webex_bot.models.response import Response, response_from_adaptive_card
@ -114,8 +113,7 @@ class SubmitTaskCommand(Command):
Submit(title="Cancel", data={"command_keyword": "exit"}), Submit(title="Cancel", data={"command_keyword": "exit"}),
], ],
) )
with sentry_sdk.start_transaction(name="submit_task_command"): return response_from_adaptive_card(card)
return response_from_adaptive_card(card)
class SubmitTaskCallback(Command): class SubmitTaskCallback(Command):
@ -149,8 +147,7 @@ class SubmitTaskCallback(Command):
) )
def execute(self, message, attachment_actions, activity) -> str: def execute(self, message, attachment_actions, activity) -> str:
with sentry_sdk.start_transaction(name="submit_task_callback"): return self.msg
return self.msg
class MyTasksCallback(Command): class MyTasksCallback(Command):
@ -161,13 +158,11 @@ class MyTasksCallback(Command):
self.msg: str = "" self.msg: str = ""
def pre_execute(self, message, attachment_actions, activity) -> str: def pre_execute(self, message, attachment_actions, activity) -> str:
with sentry_sdk.start_transaction(name="my_tasks_preexec"): return "Getting your tasks..."
return "Getting your tasks..."
def execute(self, message, attachment_actions, activity) -> str | None: def execute(self, message, attachment_actions, activity) -> str | None:
sender: str = attachment_actions.inputs.get("sender") sender: str = attachment_actions.inputs.get("sender")
result: bool = get_tasks(requestor=sender) result: bool = get_tasks(requestor=sender)
with sentry_sdk.start_transaction(name="my_tasks_exec"): if not result:
if not result: return "Failed to get tasks. Please try again."
return "Failed to get tasks. Please try again." return
return

View File

@ -1,32 +1,18 @@
#!/usr/bin/env python3 #!/usr/bin/env python3
import sentry_sdk
from sentry_sdk.integrations.stdlib import StdlibIntegration
from webex_bot.webex_bot import WebexBot from webex_bot.webex_bot import WebexBot
from app.commands.exit import ExitCommand from app.commands.exit import ExitCommand
from app.commands.submit_task import SubmitTaskCommand from app.commands.submit_task import SubmitTaskCommand
from app.utils.config import config from app.utils.config import config
if config.sentry_enabled:
apm = sentry_sdk.init(
dsn=config.sentry_dsn,
enable_tracing=True,
environment=config.environment,
release=config.version,
integrations=[StdlibIntegration()],
spotlight=True,
)
def create_bot() -> WebexBot: def create_bot() -> WebexBot:
"""Create and return a Webex Bot object.""" # Create a Bot Object
webex_bot: WebexBot = WebexBot( webex_bot: WebexBot = WebexBot(
bot_name=config.bot_name, bot_name=config.bot_name,
teams_bot_token=config.webex_token, teams_bot_token=config.webex_token,
approved_domains=config.approved_domains, approved_domains=["cisco.com"],
approved_rooms=config.approved_rooms,
approved_users=config.approved_users,
) )
webex_bot.commands.clear() webex_bot.commands.clear()
webex_bot.add_command(SubmitTaskCommand()) webex_bot.add_command(SubmitTaskCommand())

View File

@ -1,91 +1,35 @@
"""Configuration module.""" #!/usr/bin/env python3
import os import os
from app.utils.helpers import validate_email_syntax
class Config: class Config:
"""Configuration module."""
def __init__(self) -> None: def __init__(self) -> None:
"""Configuration module.""" self.__bot_name: str = os.environ["BOT_NAME"]
self.__webex_token: str = os.environ["WEBEX_API_KEY"]
# Sentry config needs to be processed first for loop prevention. self.__admin_first_name: str = os.environ["ADMIN_FIRST_NAME"]
self.__admin_emails: list = os.environ["ADMIN_EMAIL"].split(",")
self.__sentry_dsn: str = os.environ.get("SENTRY_DSN", "") self.__n8n_webhook_url: str = os.environ["N8N_WEBHOOK_URL"]
self.__sentry_enabled: bool = bool(
os.environ.get("SENTRY_ENABLED", "False").upper() == "TRUE"
and self.__sentry_dsn != ""
)
@property
def environment(self) -> str:
"""Returns the current app lifecycle."""
return os.environ.get("APP_LIFECYCLE", "DEV").upper()
@property
def version(self) -> str:
"""Returns the current app version."""
return os.environ["APP_VERSION"]
@property
def sentry_enabled(self) -> bool:
"""Returns True if Sentry SDK is enabled, else False."""
return self.__sentry_enabled
@property
def sentry_dsn(self) -> str:
"""Returns the Sentry DSN value if Sentry SDK is enabled AND
Sentry DSN is set, else blank string."""
if not self.__sentry_enabled:
return ""
return self.__sentry_dsn
@property @property
def bot_name(self) -> str: def bot_name(self) -> str:
"""Returns the bot name.""" return self.__bot_name
return os.environ["BOT_NAME"]
@property @property
def webex_token(self) -> str: def webex_token(self) -> str:
"""Returns the Webex API key.""" return self.__webex_token
return os.environ["WEBEX_API_KEY"]
@property @property
def admin_first_name(self) -> str: def admin_first_name(self) -> str:
"""Returns the first name of the bot admin.""" return self.__admin_first_name
return os.environ["ADMIN_FIRST_NAME"]
@property @property
def admin_emails(self) -> list: def admin_emails(self) -> list:
"""Returns a list of admin email addresses.""" return self.__admin_emails
return os.environ["ADMIN_EMAIL"].split(",")
@property @property
def n8n_webhook_url(self) -> str: def n8n_webhook_url(self) -> str:
"""Returns the n8n webhook URL.""" return self.__n8n_webhook_url
return os.environ["N8N_WEBHOOK_URL"]
@property
def approved_users(self) -> list:
"""Returns a list of approved users."""
emails: list[str] = os.environ.get("APPROVED_USERS", "").split(",")
emails = [i.strip() for i in emails if validate_email_syntax(i.strip())]
return emails
@property
def approved_rooms(self) -> list:
"""Returns a list of approved rooms."""
rooms: list[str] = os.environ.get("APPROVED_ROOMS", "").split(",")
return [i.strip() for i in rooms]
@property
def approved_domains(self) -> list:
"""Returns a list of approved domains."""
domains: list[str] = os.environ.get("APPROVED_DOMAINS", "").split(",")
return [i.strip() for i in domains]
config: Config = Config() config: Config = Config()

View File

@ -1,18 +1,7 @@
#!/usr/bin/env python3 #!/usr/bin/env python3
from datetime import datetime from datetime import datetime
from zoneinfo import ZoneInfo
def timestamp_to_date(timestamp: int) -> str: def timestamp_to_date(timestamp: int) -> str:
"""Convert timestamp to date. return datetime.utcfromtimestamp(timestamp).strftime("%Y-%m-%d")
Args:
timestamp (int): Timestamp to convert.
Returns:
str: Date in the format YYYY-MM-DD.
"""
return datetime.fromtimestamp(timestamp=timestamp, tz=ZoneInfo("UTC")).strftime(
"%Y-%m-%d"
)

View File

@ -1,16 +0,0 @@
"""Standalone helper functions."""
import re
def validate_email_syntax(email: str) -> bool:
"""Validate email syntax.
Args:
email (str): Email address.
Returns:
bool: True if valid, else False.
"""
pattern = r"^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$"
return re.match(pattern, email) is not None

View File

@ -1,18 +1,9 @@
import requests import requests
import sentry_sdk
from app.utils.config import config from app.utils.config import config
def __n8n_post(data: dict) -> bool: def __n8n_post(data: dict) -> bool:
"""Post data to N8N webhook URL.
Args:
data (dict): Data to post to webhook URL.
Returns:
bool: True if successful, else False.
"""
headers: dict = {"Content-Type": "application/json"} headers: dict = {"Content-Type": "application/json"}
resp: requests.Response = requests.post( resp: requests.Response = requests.post(
url=config.n8n_webhook_url, url=config.n8n_webhook_url,
@ -25,45 +16,22 @@ def __n8n_post(data: dict) -> bool:
def submit_task(summary, description, completion_date, requestor) -> bool: def submit_task(summary, description, completion_date, requestor) -> bool:
"""Submit task to N8N webhook URL. data: dict = {
"requestor": requestor,
Args: "title": summary,
summary (str): Summary of task. "description": description,
description (str): Description of task. "completiondate": completion_date,
completion_date (str): Completion date of task. }
requestor (str): Requestor of task. return __n8n_post(data=data)
Returns:
bool: True if successful, else False.
"""
with sentry_sdk.start_transaction(name="submit_task"):
data: dict = {
"requestor": requestor,
"title": summary,
"description": description,
"completiondate": completion_date,
}
_data = __n8n_post(data=data)
return _data
def get_tasks(requestor) -> bool: def get_tasks(requestor) -> bool:
"""Get tasks from N8N webhook URL. headers: dict = {"Content-Type": "application/json"}
resp: requests.Response = requests.get(
Args: url=config.n8n_webhook_url,
requestor (str): Requestor of tasks. headers=headers,
timeout=10,
Returns: verify=False,
bool: True if successful, else False. params={"requestor": requestor},
""" )
with sentry_sdk.start_transaction(name="get_tasks"): return bool(resp.status_code == 200)
headers: dict = {"Content-Type": "application/json"}
resp: requests.Response = requests.get(
url=config.n8n_webhook_url,
headers=headers,
timeout=10,
verify=False,
params={"requestor": requestor},
)
_data = bool(resp.status_code == 200)
return _data

View File

@ -1,47 +1,47 @@
{ {
"assignAutomerge": true,
"assigneesFromCodeOwners": true,
"baseBranches": [
"main"
],
"dependencyDashboardAutoclose": true,
"extends": [ "extends": [
"config:base", "config:base",
":semanticCommits", ":semanticCommits",
":semanticCommitTypeAll(fix)" ":semanticCommitTypeAll(fix)"
], ],
"baseBranches": [
"next"
],
"platformCommit": true,
"dependencyDashboardAutoclose": true,
"assignAutomerge": true,
"assigneesFromCodeOwners": true,
"rebaseWhen": "behind-base-branch",
"rollbackPrs": true,
"labels": [ "labels": [
"dependencies" "dependencies"
], ],
"packageRules": [ "packageRules": [
{ {
"labels": [
"linting"
],
"matchPackagePatterns": [ "matchPackagePatterns": [
"black", "black",
"pylint" "pylint"
],
"labels": [
"linting"
] ]
}, },
{ {
"labels": [
"unit-tests"
],
"matchPackagePatterns": [ "matchPackagePatterns": [
"coverage", "coverage",
"pytest" "pytest"
],
"labels": [
"unit-tests"
] ]
} }
], ],
"platformCommit": true,
"rebaseWhen": "behind-base-branch",
"rollbackPrs": true,
"vulnerabilityAlerts": { "vulnerabilityAlerts": {
"commitMessagePrefix": "[SECURITY] ",
"enabled": true, "enabled": true,
"labels": [ "labels": [
"security" "security"
], ],
"commitMessagePrefix": "[SECURITY] ",
"prCreation": "immediate" "prCreation": "immediate"
} }
} }

View File

@ -4,4 +4,3 @@ isort
pylint pylint
pylint-exit pylint-exit
pytest pytest
zipp>=3.19.1 # not directly required, pinned by Snyk to avoid a vulnerability

View File

@ -1,48 +1,46 @@
appdirs==1.4.4 appdirs==1.4.4
astroid==3.3.4 astroid==3.0.1
attrs==24.2.0 attrs==23.1.0
autopep8==2.3.1 autopep8==2.0.4
backoff==2.2.1 backoff==2.2.1
certifi==2024.8.30 certifi==2023.7.22
cfgv==3.4.0 cfgv==3.4.0
charset-normalizer==3.3.2 charset-normalizer==3.3.2
click==8.1.7 click==8.1.7
coloredlogs==15.0.1 coloredlogs==15.0.1
dill==0.3.9 dill==0.3.7
distlib==0.3.8 distlib==0.3.7
filelock==3.16.1 filelock==3.13.1
future==1.0.0 future==0.18.3
humanfriendly==10.0 humanfriendly==10.0
identify==2.6.1 identify==2.5.31
idna==3.10 idna==3.4
iniconfig==2.0.0 iniconfig==2.0.0
lazy-object-proxy==1.10.0 lazy-object-proxy==1.9.0
mccabe==0.7.0 mccabe==0.7.0
mypy-extensions==1.0.0 mypy-extensions==1.0.0
nodeenv==1.9.1 nodeenv==1.8.0
packaging==24.1 packaging==23.2
pathspec==0.12.1 pathspec==0.11.2
platformdirs==4.3.6 platformdirs==3.11.0
pluggy==1.5.0 pluggy==1.3.0
py==1.11.0 py==1.11.0
pycodestyle==2.12.1 pycodestyle==2.11.1
PyJWT==2.9.0 PyJWT==2.8.0
pyparsing==3.1.4 pyparsing==3.1.1
python-dateutil==2.9.0.post0 python-dateutil==2.8.2
python-dotenv==1.0.1 python-dotenv==1.0.0
PyYAML==6.0.2 PyYAML==6.0.1
requests==2.32.3 requests==2.31.0
requests-toolbelt==1.0.0 requests-toolbelt==1.0.0
sentry-sdk==2.15.0
six==1.16.0 six==1.16.0
toml==0.10.2 toml==0.10.2
tomli==2.0.2 tomli==2.0.1
tomlkit==0.13.2 tomlkit==0.12.2
urllib3==2.2.3 urllib3==2.0.7
virtualenv==20.26.6 virtualenv==20.24.6
webex-bot==0.5.2 webex-bot==0.4.1
webexteamssdk==1.6.1 webexteamssdk==1.6.1
websockets==11.0.3 websockets==10.2
wrapt==1.16.0 wrapt==1.15.0
xmltodict==0.13.0 xmltodict==0.13.0
zipp>=3.19.1 # not directly required, pinned by Snyk to avoid a vulnerability

View File

@ -1,3 +1,3 @@
export $(cat .env.test | xargs) export $(cat .env | xargs)
python -B -m app.main python -B -m app.main
unset ADMIN_EMAIL ADMIN_FIRST_NAME APP_LIFECYCLE APP_VERSION APPROVED_DOMAINS APPROVED_ROOMS APPROVED_USERS BOT_NAME N8N_WEBHOOK_URL SENTRY_DSN SENTRY_ENABLED WEBEX_API_KEY unset BOT_NAME WEBEX_API_KEY ADMIN_FIRST_NAME ADMIN_EMAIL N8N_WEBHOOK_URL

View File

View File

@ -1,23 +1,16 @@
#!/usr/bin/env python3 #!/usr/bin/env python3
# ruff: noqa: E402 pylint: disable=wrong-import-position
"""Provides test cases for app/utils/config.py.""" """Provides test cases for app/utils/config.py."""
import os import os
vars: dict = { vars: dict = {
"APP_VERSION": "dev",
"BOT_NAME": "TestBot", "BOT_NAME": "TestBot",
"WEBEX_API_KEY": "testing", "WEBEX_API_KEY": "testing",
"ADMIN_FIRST_NAME": "Test", "ADMIN_FIRST_NAME": "Test",
"ADMIN_EMAIL": "test@test.com", "ADMIN_EMAIL": "test@test.com",
"N8N_WEBHOOK_URL": "https://n8n.test.com/webhook/abcdefg", "N8N_WEBHOOK_URL": "https://n8n.test.com/webhook/abcdefg",
"SENTRY_ENABLED": "false",
"SENTRY_DSN": "http://localhost",
"APPROVED_USERS": "test@test.com",
"APPROVED_DOMAINS": "test.com",
"APPROVED_ROOMS": "test",
} }
@ -29,18 +22,8 @@ from app.utils.config import config # pragma: no cover
def test_config() -> None: def test_config() -> None:
assert config.admin_emails == vars["ADMIN_EMAIL"].split(",")
assert config.admin_first_name == vars["ADMIN_FIRST_NAME"]
assert config.approved_domains == vars["APPROVED_DOMAINS"].split(",")
assert config.approved_rooms == vars["APPROVED_ROOMS"].split(",")
assert config.approved_users == vars["APPROVED_USERS"].split(",")
assert config.bot_name == vars["BOT_NAME"] assert config.bot_name == vars["BOT_NAME"]
assert config.n8n_webhook_url == vars["N8N_WEBHOOK_URL"]
assert config.sentry_enabled == bool(vars["SENTRY_ENABLED"].upper() == "TRUE")
assert config.version == vars["APP_VERSION"]
assert config.webex_token == vars["WEBEX_API_KEY"] assert config.webex_token == vars["WEBEX_API_KEY"]
assert config.admin_first_name == vars["ADMIN_FIRST_NAME"]
if config.sentry_enabled: assert config.admin_emails == vars["ADMIN_EMAIL"].split(",")
assert config.sentry_dsn == vars["SENTRY_DSN"] assert config.n8n_webhook_url == vars["N8N_WEBHOOK_URL"]
else:
assert config.sentry_dsn == ""

View File

@ -1,23 +0,0 @@
#!/usr/bin/env python3
"""Provides test cases for app/utils/helpers.py."""
from app.utils.helpers import validate_email_syntax # pragma: no cover
def test_validate_email_syntax_true() -> None:
"""Test validate_email_syntax() with a real email address."""
email: str = "test@test.com"
assert validate_email_syntax(email)
def test_validate_email_syntax_false1() -> None:
"""Test validate_email_syntax() with an invalid email address."""
email: str = "test@test"
assert not validate_email_syntax(email)
def test_validate_email_syntax_false2() -> None:
"""Test validate_email_syntax() with an invalid email address."""
email: str = "test"
assert not validate_email_syntax(email)