DGNum/uptime-kuma-api
6
0
Fork 1
Code Issues 17 Pull requests 5 Projects Releases 24 Packages Wiki Activity Actions

feat: check for required notification arguments #36

Merged
lucasheld merged 2 commits from feature/notification-required-params into master 2023-05-20 13:10:12 +02:00
Conversation 0 Commits 2 Files changed 4 +31 -28
3 changed files with 31 additions and 28 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files
Showing only changes of commit 86e80a0ae4 - Show all commits

8
scripts/build_notifications.py
View file

@ -118,6 +118,7 @@ def build_notification_providers(root):
attrs = input_.attrs attrs = input_.attrs
v_model = attrs.get("v-model") v_model = attrs.get("v-model")
param_name = re.match(r'\$parent.notification.(.*)$', v_model).group(1) param_name = re.match(r'\$parent.notification.(.*)$', v_model).group(1)
type_ = attrs.get("type") type_ = attrs.get("type")
if type_ == "number": if type_ == "number":
type_ = "int" type_ = "int"
@ -125,14 +126,17 @@ def build_notification_providers(root):
type_ = "bool" type_ = "bool"
else: else:
type_ = "str" type_ = "str"
required = attrs.get("required")
if required in ['', 'true']: required_true_values = ['', 'true']
if attrs.get("required") in required_true_values or attrs.get(":required") in required_true_values:
required = True required = True
else: else:
required = False required = False
min_ = attrs.get("min") min_ = attrs.get("min")
if min_: if min_:
conditions["min"] = int(min_) conditions["min"] = int(min_)
max_ = attrs.get("max") max_ = attrs.get("max")
if max_: if max_:
conditions["max"] = int(max_) conditions["max"] = int(max_)

7
uptime_kuma_api/api.py
View file

@ -305,10 +305,9 @@ def _check_arguments_notification(kwargs) -> None:
required_args = ["type", "name"] required_args = ["type", "name"]
_check_missing_arguments(required_args, kwargs) _check_missing_arguments(required_args, kwargs)
# TODO: collect required notification args from /src/components/notifications/* type_ = kwargs["type"]
# type_ = kwargs["type"] required_args = notification_provider_options[type_]
# required_args = notification_provider_options[type_] _check_missing_arguments(required_args, kwargs)
# _check_missing_arguments(required_args, kwargs)
_check_argument_conditions(notification_provider_conditions, kwargs) _check_argument_conditions(notification_provider_conditions, kwargs)

44
uptime_kuma_api/notification_providers.py
View file

@ -184,7 +184,7 @@ notification_provider_options = {
), ),
NotificationType.CLICKSENDSMS: dict( NotificationType.CLICKSENDSMS: dict(
clicksendsmsLogin=dict(type="str", required=True), clicksendsmsLogin=dict(type="str", required=True),
clicksendsmsPassword=dict(type="str", required=False), clicksendsmsPassword=dict(type="str", required=True),
clicksendsmsToNumber=dict(type="str", required=True), clicksendsmsToNumber=dict(type="str", required=True),
clicksendsmsSenderName=dict(type="str", required=False), clicksendsmsSenderName=dict(type="str", required=False),
), ),
@ -206,7 +206,7 @@ notification_provider_options = {
), ),
NotificationType.GOALERT: dict( NotificationType.GOALERT: dict(
goAlertBaseURL=dict(type="str", required=True), goAlertBaseURL=dict(type="str", required=True),
goAlertToken=dict(type="str", required=False), goAlertToken=dict(type="str", required=True),
), ),
NotificationType.GOOGLECHAT: dict( NotificationType.GOOGLECHAT: dict(
googleChatWebhookURL=dict(type="str", required=True), googleChatWebhookURL=dict(type="str", required=True),
@ -222,7 +222,7 @@ notification_provider_options = {
), ),
NotificationType.GOTIFY: dict( NotificationType.GOTIFY: dict(
gotifyserverurl=dict(type="str", required=True), gotifyserverurl=dict(type="str", required=True),
gotifyapplicationToken=dict(type="str", required=False), gotifyapplicationToken=dict(type="str", required=True),
gotifyPriority=dict(type="int", required=True), gotifyPriority=dict(type="int", required=True),
), ),
NotificationType.HOMEASSISTANT: dict( NotificationType.HOMEASSISTANT: dict(
@ -232,14 +232,14 @@ notification_provider_options = {
), ),
NotificationType.KOOK: dict( NotificationType.KOOK: dict(
kookGuildID=dict(type="str", required=True), kookGuildID=dict(type="str", required=True),
kookBotToken=dict(type="str", required=False), kookBotToken=dict(type="str", required=True),
), ),
NotificationType.LINE: dict( NotificationType.LINE: dict(
lineChannelAccessToken=dict(type="str", required=False), lineChannelAccessToken=dict(type="str", required=True),
lineUserID=dict(type="str", required=True), lineUserID=dict(type="str", required=True),
), ),
NotificationType.LINENOTIFY: dict( NotificationType.LINENOTIFY: dict(
lineNotifyAccessToken=dict(type="str", required=False), lineNotifyAccessToken=dict(type="str", required=True),
), ),
NotificationType.LUNASEA: dict( NotificationType.LUNASEA: dict(
lunaseaTarget=dict(type="str", required=True), lunaseaTarget=dict(type="str", required=True),
@ -249,7 +249,7 @@ notification_provider_options = {
NotificationType.MATRIX: dict( NotificationType.MATRIX: dict(
internalRoomId=dict(type="str", required=True), internalRoomId=dict(type="str", required=True),
accessToken=dict(type="str", required=True), accessToken=dict(type="str", required=True),
homeserverUrl=dict(type="str", required=False), homeserverUrl=dict(type="str", required=True),
), ),
NotificationType.MATTERMOST: dict( NotificationType.MATTERMOST: dict(
mattermostusername=dict(type="str", required=False), mattermostusername=dict(type="str", required=False),
@ -268,7 +268,7 @@ notification_provider_options = {
), ),
NotificationType.OCTOPUSH: dict( NotificationType.OCTOPUSH: dict(
octopushVersion=dict(type="str", required=False), octopushVersion=dict(type="str", required=False),
octopushAPIKey=dict(type="str", required=False), octopushAPIKey=dict(type="str", required=True),
octopushLogin=dict(type="str", required=True), octopushLogin=dict(type="str", required=True),
octopushPhoneNumber=dict(type="str", required=True), octopushPhoneNumber=dict(type="str", required=True),
octopushSMSType=dict(type="str", required=False), octopushSMSType=dict(type="str", required=False),
@ -289,7 +289,7 @@ notification_provider_options = {
pagerdutyAutoResolve=dict(type="str", required=False), pagerdutyAutoResolve=dict(type="str", required=False),
pagerdutyIntegrationUrl=dict(type="str", required=False), pagerdutyIntegrationUrl=dict(type="str", required=False),
pagerdutyPriority=dict(type="str", required=False), pagerdutyPriority=dict(type="str", required=False),
pagerdutyIntegrationKey=dict(type="str", required=False), pagerdutyIntegrationKey=dict(type="str", required=True),
), ),
NotificationType.PAGERTREE: dict( NotificationType.PAGERTREE: dict(
pagertreeAutoResolve=dict(type="str", required=False), pagertreeAutoResolve=dict(type="str", required=False),
@ -299,28 +299,28 @@ notification_provider_options = {
NotificationType.PROMOSMS: dict( NotificationType.PROMOSMS: dict(
promosmsAllowLongSMS=dict(type="bool", required=False), promosmsAllowLongSMS=dict(type="bool", required=False),
promosmsLogin=dict(type="str", required=True), promosmsLogin=dict(type="str", required=True),
promosmsPassword=dict(type="str", required=False), promosmsPassword=dict(type="str", required=True),
promosmsPhoneNumber=dict(type="str", required=True), promosmsPhoneNumber=dict(type="str", required=True),
promosmsSMSType=dict(type="str", required=False), promosmsSMSType=dict(type="str", required=False),
promosmsSenderName=dict(type="str", required=False), promosmsSenderName=dict(type="str", required=False),
), ),
NotificationType.PUSHBULLET: dict( NotificationType.PUSHBULLET: dict(
pushbulletAccessToken=dict(type="str", required=False), pushbulletAccessToken=dict(type="str", required=True),
), ),
NotificationType.PUSHDEER: dict( NotificationType.PUSHDEER: dict(
pushdeerKey=dict(type="str", required=False), pushdeerKey=dict(type="str", required=True),
), ),
NotificationType.PUSHOVER: dict( NotificationType.PUSHOVER: dict(
pushoveruserkey=dict(type="str", required=False), pushoveruserkey=dict(type="str", required=True),
pushoverapptoken=dict(type="str", required=False), pushoverapptoken=dict(type="str", required=True),
pushoversounds=dict(type="str", required=False), pushoversounds=dict(type="str", required=False),
pushoverpriority=dict(type="str", required=False), pushoverpriority=dict(type="str", required=False),
pushovertitle=dict(type="str", required=False), pushovertitle=dict(type="str", required=False),
pushoverdevice=dict(type="str", required=False), pushoverdevice=dict(type="str", required=False),
), ),
NotificationType.PUSHY: dict( NotificationType.PUSHY: dict(
pushyAPIKey=dict(type="str", required=False), pushyAPIKey=dict(type="str", required=True),
pushyToken=dict(type="str", required=False), pushyToken=dict(type="str", required=True),
), ),
NotificationType.ROCKET_CHAT: dict( NotificationType.ROCKET_CHAT: dict(
rocketchannel=dict(type="str", required=False), rocketchannel=dict(type="str", required=False),
@ -329,11 +329,11 @@ notification_provider_options = {
rocketwebhookURL=dict(type="str", required=True), rocketwebhookURL=dict(type="str", required=True),
), ),
NotificationType.SERVERCHAN: dict( NotificationType.SERVERCHAN: dict(
serverChanSendKey=dict(type="str", required=False), serverChanSendKey=dict(type="str", required=True),
), ),
NotificationType.SERWERSMS: dict( NotificationType.SERWERSMS: dict(
serwersmsUsername=dict(type="str", required=True), serwersmsUsername=dict(type="str", required=True),
serwersmsPassword=dict(type="str", required=False), serwersmsPassword=dict(type="str", required=True),
serwersmsPhoneNumber=dict(type="str", required=True), serwersmsPhoneNumber=dict(type="str", required=True),
serwersmsSenderName=dict(type="str", required=False), serwersmsSenderName=dict(type="str", required=False),
), ),
@ -352,7 +352,7 @@ notification_provider_options = {
smseagleEncoding=dict(type="bool", required=False), smseagleEncoding=dict(type="bool", required=False),
smseaglePriority=dict(type="int", required=False), smseaglePriority=dict(type="int", required=False),
smseagleRecipientType=dict(type="str", required=False), smseagleRecipientType=dict(type="str", required=False),
smseagleToken=dict(type="str", required=False), smseagleToken=dict(type="str", required=True),
smseagleRecipient=dict(type="str", required=True), smseagleRecipient=dict(type="str", required=True),
smseagleUrl=dict(type="str", required=True), smseagleUrl=dict(type="str", required=True),
), ),
@ -383,7 +383,7 @@ notification_provider_options = {
NotificationType.SPLUNK: dict( NotificationType.SPLUNK: dict(
splunkAutoResolve=dict(type="str", required=False), splunkAutoResolve=dict(type="str", required=False),
splunkSeverity=dict(type="str", required=False), splunkSeverity=dict(type="str", required=False),
splunkRestURL=dict(type="str", required=False), splunkRestURL=dict(type="str", required=True),
), ),
NotificationType.SQUADCAST: dict( NotificationType.SQUADCAST: dict(
squadcastWebhookURL=dict(type="str", required=True), squadcastWebhookURL=dict(type="str", required=True),
@ -395,14 +395,14 @@ notification_provider_options = {
webhookUrl=dict(type="str", required=True), webhookUrl=dict(type="str", required=True),
), ),
NotificationType.PUSHBYTECHULUS: dict( NotificationType.PUSHBYTECHULUS: dict(
pushAPIKey=dict(type="str", required=False), pushAPIKey=dict(type="str", required=True),
), ),
NotificationType.TELEGRAM: dict( NotificationType.TELEGRAM: dict(
telegramChatID=dict(type="str", required=True), telegramChatID=dict(type="str", required=True),
telegramSendSilently=dict(type="bool", required=False), telegramSendSilently=dict(type="bool", required=False),
telegramProtectContent=dict(type="bool", required=False), telegramProtectContent=dict(type="bool", required=False),
telegramMessageThreadID=dict(type="str", required=False), telegramMessageThreadID=dict(type="str", required=False),
telegramBotToken=dict(type="str", required=False), telegramBotToken=dict(type="str", required=True),
), ),
NotificationType.TWILIO: dict( NotificationType.TWILIO: dict(
twilioAccountSID=dict(type="str", required=True), twilioAccountSID=dict(type="str", required=True),