Compare commits

..

5 Commits

16 changed files with 64 additions and 220 deletions

View File

@ -1,6 +1,3 @@
APP_LIFECYCLE="dev"
SENTRY_ENABLED="False"
SENTRY_DSN=""
ADMIN_EMAIL="" ADMIN_EMAIL=""
ADMIN_FIRST_NAME="" ADMIN_FIRST_NAME=""
BOT_NAME="" BOT_NAME=""

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

@ -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

@ -13,7 +13,7 @@ jobs:
- uses: actions/checkout@v4 - uses: actions/checkout@v4
- name: Bump version and push tag - name: Bump version and push tag
id: tag_version id: tag_version
uses: mathieudutour/github-tag-action@v6.2 uses: mathieudutour/github-tag-action@v6.1
with: with:
github_token: ${{ secrets.GITHUB_TOKEN }} github_token: ${{ secrets.GITHUB_TOKEN }}
default_bump: minor default_bump: minor
@ -23,8 +23,7 @@ jobs:
tag: ${{ steps.tag_version.outputs.new_tag }} tag: ${{ steps.tag_version.outputs.new_tag }}
name: ${{ steps.tag_version.outputs.new_tag }} name: ${{ steps.tag_version.outputs.new_tag }}
body: ${{ steps.tag_version.outputs.changelog }} body: ${{ steps.tag_version.outputs.changelog }}
generateReleaseNotes: true
publish: publish:
name: GitHub Container Registry name: GitHub Container Registry
runs-on: ubuntu-latest runs-on: ubuntu-latest
@ -34,11 +33,7 @@ jobs:
- name: Login to GitHub Container Registry - name: Login to GitHub Container Registry
run: echo ${{ secrets.GHCR_ACCESS_TOKEN }} | docker login ghcr.io -u luketainton --password-stdin run: echo ${{ secrets.GHCR_ACCESS_TOKEN }} | docker login ghcr.io -u luketainton --password-stdin
- name: Build image for GitHub Package Registry - name: Build image for GitHub Package Registry
run: | run: docker build . --file Dockerfile --tag ghcr.io/luketainton/roboluke-tasks:${{ needs.release.outputs.new_tag }} --tag ghcr.io/luketainton/roboluke-tasks:latest
docker build . --file Dockerfile \
--build-arg "version=${{ needs.release.outputs.new_tag }}" \
--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 - name: Push image to GitHub Package Registry
run: | run: |
docker push ghcr.io/luketainton/roboluke-tasks:latest docker push ghcr.io/luketainton/roboluke-tasks:latest
@ -47,11 +42,10 @@ jobs:
deploy: deploy:
name: Update Portainer Deployment name: Update Portainer Deployment
runs-on: ubuntu-latest runs-on: ubuntu-latest
needs: publish
steps: steps:
- uses: fjogeleit/http-request-action@v1 - uses: fjogeleit/http-request-action@v1
with: with:
url: ${{ secrets.PORTAINER_WEBHOOK_URL }} url: ${{ secrets.PORTAINER_WEBHOOK_URL }}
method: POST method: POST
timeout: 60000 timeout: 30000
preventFailureOnNoResponse: "true" preventFailureOnNoResponse: 'true'

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

@ -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,8 +1,5 @@
#!/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
@ -10,19 +7,8 @@ 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,

View File

@ -1,71 +1,34 @@
"""Configuration module.""" #!/usr/bin/env python3
import os import os
class Config: class Config:
"""Configuration module."""
def __init__(self) -> None: def __init__(self) -> None:
"""Configuration module."""
self.__environment: str = os.environ.get("APP_LIFECYCLE", "DEV").upper()
self.__version: str = os.environ["APP_VERSION"]
self.__bot_name: str = os.environ["BOT_NAME"] self.__bot_name: str = os.environ["BOT_NAME"]
self.__webex_token: str = os.environ["WEBEX_API_KEY"] self.__webex_token: str = os.environ["WEBEX_API_KEY"]
self.__admin_first_name: str = os.environ["ADMIN_FIRST_NAME"] self.__admin_first_name: str = os.environ["ADMIN_FIRST_NAME"]
self.__admin_emails: list = os.environ["ADMIN_EMAIL"].split(",") self.__admin_emails: list = os.environ["ADMIN_EMAIL"].split(",")
self.__n8n_webhook_url: str = os.environ["N8N_WEBHOOK_URL"] self.__n8n_webhook_url: str = os.environ["N8N_WEBHOOK_URL"]
self.__sentry_dsn: str = os.environ.get("SENTRY_DSN", "")
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 self.__environment
@property
def version(self) -> str:
"""Returns the current app version."""
return self.__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 self.__bot_name
@property @property
def webex_token(self) -> str: def webex_token(self) -> str:
"""Returns the Webex API key."""
return self.__webex_token return self.__webex_token
@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 self.__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 self.__admin_emails
@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 self.__n8n_webhook_url

View File

@ -1,18 +1,7 @@
#!/usr/bin/env python3 #!/usr/bin/env python3
from zoneinfo import ZoneInfo
from datetime import datetime from datetime import datetime
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,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,46 @@
appdirs==1.4.4 appdirs==1.4.4
astroid==3.1.0 astroid==3.0.1
attrs==23.2.0 attrs==23.1.0
autopep8==2.1.0 autopep8==2.0.4
backoff==2.2.1 backoff==2.2.1
certifi==2024.2.2 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.8 dill==0.3.7
distlib==0.3.8 distlib==0.3.7
filelock==3.13.4 filelock==3.13.1
future==1.0.0 future==0.18.3
humanfriendly==10.0 humanfriendly==10.0
identify==2.5.36 identify==2.5.31
idna==3.7 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.8.0 nodeenv==1.8.0
packaging==24.0 packaging==23.2
pathspec==0.12.1 pathspec==0.11.2
platformdirs==4.2.1 platformdirs==3.11.0
pluggy==1.5.0 pluggy==1.3.0
py==1.11.0 py==1.11.0
pycodestyle==2.11.1 pycodestyle==2.11.1
PyJWT==2.8.0 PyJWT==2.8.0
pyparsing==3.1.2 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.1 PyYAML==6.0.1
requests==2.31.0 requests==2.31.0
requests-toolbelt==1.0.0 requests-toolbelt==1.0.0
sentry-sdk==2.0.1
six==1.16.0 six==1.16.0
toml==0.10.2 toml==0.10.2
tomli==2.0.1 tomli==2.0.1
tomlkit==0.12.4 tomlkit==0.12.2
urllib3==2.2.1 urllib3==2.0.7
virtualenv==20.26.0 virtualenv==20.24.6
webex-bot==0.5.1 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

View File

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

View File

View File

@ -6,14 +6,11 @@ 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"
} }