Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

RSU Errors Page #104

Open
wants to merge 11 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions services/api/src/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
from admin_new_org import AdminNewOrg
from admin_org import AdminOrg
from contact_support import ContactSupportResource
from rsu_error_summary import RSUErrorSummaryResource
import smtp_error_handler

log_level = os.environ.get("LOGGING_LEVEL", "INFO")
Expand Down Expand Up @@ -61,6 +62,7 @@
api.add_resource(AdminNotification, "/admin-notification")
api.add_resource(AdminNewNotification, "/admin-new-notification")
api.add_resource(ContactSupportResource, "/contact-support")
api.add_resource(RSUErrorSummaryResource, "/rsu-error-summary")

if __name__ == "__main__":
app.run(host="0.0.0.0", port=5000)
3 changes: 2 additions & 1 deletion services/api/src/middleware.py
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ def get_user_role(token):
"/rsu-geo-query": True,
"/admin-new-notification": False,
"/admin-notification": False,
"/rsu-error-summary": False,
}


Expand All @@ -69,7 +70,7 @@ def check_auth_exempt(method, path):
if method == "OPTIONS":
return True

exempt_paths = ["/", "/contact-support"]
exempt_paths = ["/", "/contact-support", "/rsu-error-summary"]
if path in exempt_paths:
return True

Expand Down
75 changes: 75 additions & 0 deletions services/api/src/rsu_error_summary.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
import logging
import os
from flask import abort, request
from flask_restful import Resource
from marshmallow import Schema
from marshmallow import fields

from common.emailSender import EmailSender

class RSUErrorSummarySchema(Schema):
emails = fields.Str(required=True)
subject = fields.Str(required=True)
message = fields.Str(required=True)

class RSUErrorSummaryResource(Resource):
options_headers = {
"Access-Control-Allow-Origin": os.environ["CORS_DOMAIN"],
"Access-Control-Allow-Headers": "Content-Type,Authorization",
"Access-Control-Allow-Methods": "POST,OPTIONS",
"Access-Control-Max-Age": "3600",
}

headers = {
"Access-Control-Allow-Origin": os.environ["CORS_DOMAIN"],
"Access-Control-Allow-Headers": "Content-Type,Authorization",
"Access-Control-Allow-Methods": "POST,OPTIONS",
"Content-Type": "application/json",
}

def options(self):
# CORS support
return ("", 204, self.options_headers)

def post(self):
logging.debug("RSUErrorSummary POST requested")
# Check for main body values
if not request.json:
logging.error("No JSON body provided")
abort(400)

self.validate_input(request.json)

try:
email_addresses = request.json["emails"].split(",")
subject = request.json["subject"]
message = request.json["message"]

for email_address in email_addresses:
logging.info(f"Sending email to {email_address}")
emailSender = EmailSender(
os.environ["CSM_TARGET_SMTP_SERVER_ADDRESS"],
587,
)
emailSender.send(
sender=os.environ["CSM_EMAIL_TO_SEND_FROM"],
recipient=email_address,
subject=subject,
message=message,
replyEmail="",
username=os.environ["CSM_EMAIL_APP_USERNAME"],
password=os.environ["CSM_EMAIL_APP_PASSWORD"],
pretty=True,
)
except Exception as e:
logging.error(f"Exception encountered: {e}")
abort(500)
return ("", 200, self.headers)

def validate_input(self, input):
try:
schema = RSUErrorSummarySchema()
schema.load(input)
except Exception as e:
logging.error(f"Exception encountered: {e}")
abort(400)
17 changes: 17 additions & 0 deletions services/api/tests/data/rsu_error_summary_data.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
CSM_EMAIL_TO_SEND_FROM = "[email protected]"
CSM_EMAIL_APP_USERNAME = "testusername"
CSM_EMAIL_APP_PASSWORD = "testpassword"
DEFAULT_CSM_TARGET_SMTP_SERVER_ADDRESS = "smtp.gmail.com"
DEFAULT_CSM_TARGET_SMTP_SERVER_PORT = 587


rsu_error_summary_data_good = {
"subject": "test_subject",
"message": "test_message",
"emails": "[email protected]",
}

rsu_error_summary_data_bad = {
"subject": "test_subject",
"message": "test_message",
}
150 changes: 150 additions & 0 deletions services/api/tests/src/test_rsu_error_summary.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,150 @@
import os
from unittest.mock import MagicMock

import api.src.rsu_error_summary as rsu_error_summary
import api.tests.data.rsu_error_summary_data as rsu_error_summary_data

# RSUErrorSummarySchema class tests ---

def test_rsu_error_summary_schema():
# prepare
schema = rsu_error_summary.RSUErrorSummarySchema()

# execute
exceptionOccurred = False
try:
schema.load(rsu_error_summary_data.rsu_error_summary_data_good)
except Exception as e:
exceptionOccurred = True

# assert
assert exceptionOccurred == False


def test_rsu_error_summary_schema_invalid():
# prepare
schema = rsu_error_summary.RSUErrorSummarySchema()

# execute
exceptionOccurred = False
try:
schema.load(rsu_error_summary_data.rsu_error_summary_data_bada)
except Exception as e:
exceptionOccurred = True

# assert
assert exceptionOccurred == True


# RSUErrorSummaryResource class tests ---

def test_options():
# prepare
os.environ["CSM_EMAIL_TO_SEND_FROM"] = rsu_error_summary_data.CSM_EMAIL_TO_SEND_FROM
os.environ["CSM_EMAIL_APP_USERNAME"] = rsu_error_summary_data.CSM_EMAIL_APP_USERNAME
os.environ["CSM_EMAIL_APP_PASSWORD"] = rsu_error_summary_data.CSM_EMAIL_APP_PASSWORD
os.environ[
"CSM_TARGET_SMTP_SERVER_ADDRESS"
] = rsu_error_summary_data.DEFAULT_CSM_TARGET_SMTP_SERVER_ADDRESS
os.environ["CSM_TARGET_SMTP_SERVER_PORT"] = str(rsu_error_summary_data.DEFAULT_CSM_TARGET_SMTP_SERVER_PORT)
RSUErrorSummaryResource = rsu_error_summary.RSUErrorSummaryResource()

# execute
result = RSUErrorSummaryResource.options()

# assert
assert result == ("", 204, RSUErrorSummaryResource.options_headers)

# cleanup
del os.environ["CSM_EMAIL_TO_SEND_FROM"]
del os.environ["CSM_EMAIL_APP_USERNAME"]
del os.environ["CSM_EMAIL_APP_PASSWORD"]
del os.environ["CSM_TARGET_SMTP_SERVER_ADDRESS"]
del os.environ["CSM_TARGET_SMTP_SERVER_PORT"]


def test_post_success():
# prepare
os.environ["CSM_EMAIL_TO_SEND_FROM"] = rsu_error_summary_data.CSM_EMAIL_TO_SEND_FROM
os.environ["CSM_EMAIL_APP_USERNAME"] = rsu_error_summary_data.CSM_EMAIL_APP_USERNAME
os.environ["CSM_EMAIL_APP_PASSWORD"] = rsu_error_summary_data.CSM_EMAIL_APP_PASSWORD
os.environ[
"CSM_TARGET_SMTP_SERVER_ADDRESS"
] = rsu_error_summary_data.DEFAULT_CSM_TARGET_SMTP_SERVER_ADDRESS
os.environ["CSM_TARGET_SMTP_SERVER_PORT"] = str(rsu_error_summary_data.DEFAULT_CSM_TARGET_SMTP_SERVER_PORT)
RSUErrorSummaryResource = rsu_error_summary.RSUErrorSummaryResource()
RSUErrorSummaryResource.validate_input = MagicMock()
RSUErrorSummaryResource.send = MagicMock()
rsu_error_summary.abort = MagicMock()
rsu_error_summary.request = MagicMock()

# execute
result = RSUErrorSummaryResource.post()

# assert
assert result == ("", 200, RSUErrorSummaryResource.headers)

# cleanup
del os.environ["CSM_EMAIL_TO_SEND_FROM"]
del os.environ["CSM_EMAIL_APP_USERNAME"]
del os.environ["CSM_EMAIL_APP_PASSWORD"]
del os.environ["CSM_TARGET_SMTP_SERVER_ADDRESS"]
del os.environ["CSM_TARGET_SMTP_SERVER_PORT"]


def test_post_no_json_body():
# prepare
os.environ["CSM_EMAIL_TO_SEND_FROM"] = rsu_error_summary_data.CSM_EMAIL_TO_SEND_FROM
os.environ["CSM_EMAIL_APP_USERNAME"] = rsu_error_summary_data.CSM_EMAIL_APP_USERNAME
os.environ["CSM_EMAIL_APP_PASSWORD"] = rsu_error_summary_data.CSM_EMAIL_APP_PASSWORD
os.environ[
"CSM_TARGET_SMTP_SERVER_ADDRESS"
] = rsu_error_summary_data.DEFAULT_CSM_TARGET_SMTP_SERVER_ADDRESS
os.environ["CSM_TARGET_SMTP_SERVER_PORT"] = str(rsu_error_summary_data.DEFAULT_CSM_TARGET_SMTP_SERVER_PORT)
RSUErrorSummaryResource = rsu_error_summary.RSUErrorSummaryResource()
RSUErrorSummaryResource.validate_input = MagicMock()
RSUErrorSummaryResource.send = MagicMock()
rsu_error_summary.abort = MagicMock()
rsu_error_summary.request = MagicMock()
rsu_error_summary.request.json = None

# execute
result = RSUErrorSummaryResource.post()

# assert
assert rsu_error_summary.abort.call_count == 2
assert result == ("", 200, RSUErrorSummaryResource.headers)

# cleanup
del os.environ["CSM_EMAIL_TO_SEND_FROM"]
del os.environ["CSM_EMAIL_APP_USERNAME"]
del os.environ["CSM_EMAIL_APP_PASSWORD"]
del os.environ["CSM_TARGET_SMTP_SERVER_ADDRESS"]
del os.environ["CSM_TARGET_SMTP_SERVER_PORT"]


def test_validate_input_good():
# prepare
os.environ["CSM_EMAIL_TO_SEND_FROM"] = rsu_error_summary_data.CSM_EMAIL_TO_SEND_FROM
os.environ["CSM_EMAIL_APP_USERNAME"] = rsu_error_summary_data.CSM_EMAIL_APP_USERNAME
os.environ["CSM_EMAIL_APP_PASSWORD"] = rsu_error_summary_data.CSM_EMAIL_APP_PASSWORD
os.environ[
"CSM_TARGET_SMTP_SERVER_ADDRESS"
] = rsu_error_summary_data.DEFAULT_CSM_TARGET_SMTP_SERVER_ADDRESS
os.environ["CSM_TARGET_SMTP_SERVER_PORT"] = str(rsu_error_summary_data.DEFAULT_CSM_TARGET_SMTP_SERVER_PORT)
RSUErrorSummaryResource = rsu_error_summary.RSUErrorSummaryResource()

# execute
result = RSUErrorSummaryResource.validate_input(
rsu_error_summary_data.rsu_error_summary_data_good
)

# assert
assert result == None

# cleanup
del os.environ["CSM_EMAIL_TO_SEND_FROM"]
del os.environ["CSM_EMAIL_APP_USERNAME"]
del os.environ["CSM_EMAIL_APP_PASSWORD"]
del os.environ["CSM_TARGET_SMTP_SERVER_ADDRESS"]
del os.environ["CSM_TARGET_SMTP_SERVER_PORT"]
9 changes: 9 additions & 0 deletions webapp/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions webapp/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@
"react-spinners": "^0.11.0",
"react-table": "^7.8.0",
"react-tabs": "^4.2.1",
"react-to-print": "^3.0.1",
"react-widgets": "5.8.4",
"reactstrap": "^9.2.2",
"recharts": "^2.12.6",
Expand Down
1 change: 1 addition & 0 deletions webapp/src/EnvironmentVars.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ class EnvironmentVars {
static adminAddOrg = `${this.getBaseApiUrl()}/admin-new-org`
static adminOrg = `${this.getBaseApiUrl()}/admin-org`
static contactSupport = `${this.getBaseApiUrl()}/contact-support`
static rsuErrorSummary = `${this.getBaseApiUrl()}/rsu-error-summary`
}

export default EnvironmentVars
9 changes: 9 additions & 0 deletions webapp/src/apis/rsu-api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,15 @@ class RsuApi {
body: JSON.stringify(json),
})
}

// POST
postRsuErrorSummary = async (json: Object): Promise<ApiMsgRespWithCodes<any>> => {
console.log('api: ', json)
return await apiHelper._postData({
url: EnvironmentVars.rsuErrorSummary,
body: JSON.stringify(json),
})
}
}

const rsuApiObject = new RsuApi()
Expand Down
9 changes: 7 additions & 2 deletions webapp/src/components/AdminTable.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ interface AdminTableProps {
data: any[]
title: string
editable?: any
selection?: boolean
tableLayout?: 'auto' | 'fixed'
pageSizeOptions?: any
}

const AdminTable = (props: AdminTableProps) => {
Expand All @@ -25,12 +28,14 @@ const AdminTable = (props: AdminTableProps) => {
title={props.title}
editable={props.editable}
options={{
selection: true,
selection: props.selection === undefined ? true : props.selection,
actionsColumnIndex: -1,
tableLayout: 'fixed',
tableLayout: props.tableLayout === undefined ? 'fixed' : props.tableLayout,
rowStyle: {
overflowWrap: 'break-word',
},
pageSize: 5,
pageSizeOptions: props.pageSizeOptions === undefined ? [5, 10, 20] : props.pageSizeOptions,
}}
/>
</ThemeProvider>
Expand Down
20 changes: 20 additions & 0 deletions webapp/src/components/RsuErrorSummary.test.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
import React from 'react'
import { render } from '@testing-library/react'
import RsuErrorSummary from './RsuErrorSummary'
import { replaceChaoticIds } from '../utils/test-utils'

it('should take a snapshot', () => {
const { container } = render(
<RsuErrorSummary
rsu={'string'}
online_status={''}
scms_status={''}
hidden={false}
setHidden={function (): void {
return null
}}
/>
)

expect(replaceChaoticIds(container)).toMatchSnapshot()
})
Loading
Loading