openrecords.py

About this file

This file helps running pytest and coverage reports. It also has other functions to add users, generate reports, run unit tests, run deployment tasks, etc.

Code Check Report


openrecords.py:48:1: E402 module level import not at top of file
openrecords.py:49:1: E402 module level import not at top of file
openrecords.py:50:1: E402 module level import not at top of file
openrecords.py:52:1: E402 module level import not at top of file
openrecords.py:54:1: E402 module level import not at top of file
openrecords.py:55:1: E402 module level import not at top of file
openrecords.py:56:1: E402 module level import not at top of file
openrecords.py:57:1: E402 module level import not at top of file
openrecords.py:59:1: E402 module level import not at top of file
openrecords.py:60:1: E402 module level import not at top of file
openrecords.py:78:1: E402 module level import not at top of file
openrecords.py:79:1: E402 module level import not at top of file
openrecords.py:80:1: E402 module level import not at top of file
openrecords.py:81:1: E402 module level import not at top of file

Documentation drawn from source code

`.` `.` ...` .... ...`
`;'', :##+ +##`#####, .######` +##.+####
.'''` `### +##' ###,:##: ###`'##+ .###
`'''''''''''. ''''''''''''. .''''''''` ,''''''''. ;'''''''''': .''''''''''. `'''''''',
`''':::::;'''' '''';;;;;;;;. .'''':.,:''''` :'''',.,:''''. ;'''::::,''''. .''';;;;''''', ;'''.``.''''`
`'''. .'''. '''' ,'''. :''' :'''` ,'''. ;''' '''; .'''` ,''', ''', :,:.
`'''. `'''' ''''''''''': '''; `''', ''': ;''' ,'''` .'''` ;''' .''''''':.
`'''''''''''. '''''''''''; ''': `'''. '''; ;'''''''''': .'''` ;''' ,''''''''.
`'''. '''' '''' :'''` :''' '''' .'''. ;''' ,'''` .'''` ''':,::: ;'''`
`'''. .''' '''' '''', :'''. ''''. :''': ;''' ''', .'''. .;'''' .''': ;
`'''. '''. ''''''''''''. .'''''''''' .''''''''''` ;''' ;''; .'''''''''''. '''''''''';

import os
from dotenv import load_dotenv

basedir = os.path.abspath(os.path.dirname(__file__))

dotenv_path = os.path.join(basedir, '.env')
load_dotenv(dotenv_path)

from datetime import datetime
from urllib.parse import unquote
import sys

import click

from flask import url_for
from flask.cli import main
from flask_migrate import Migrate, upgrade
from werkzeug.contrib.profiler import ProfilerMiddleware

from app import create_app, db
from app.models import (
Agencies,
AgencyUsers,
CustomRequestForms,
Determinations,
Emails,
EnvelopeTemplates,
Envelopes,
Events,
LetterTemplates,
Letters,
Reasons,
Requests,
Responses,
Roles,
UserRequests,
Users,
)
from app.report.utils import generate_request_closing_user_report, generate_monthly_metrics_report
from app.request.utils import generate_guid
from app.search.utils import recreate
from app.user.utils import make_user_admin

if os.getenv('FLASK_ENV') != 'production':
import pytest

app = create_app(os.getenv("FLASK_CONFIG") or "default")

migrate = Migrate(app, db)

COV = None
if os.environ.get("FLASK_COVERAGE"):
import coverage

COV = coverage.coverage(
branch=True, include="app/*", config_file=os.path.join(os.curdir, ".coveragerc")
)
COV.start()

@app.shell_context_processor

make_shell_context():
def make_shell_context():
return dict(
app=app,
db=db,
Users=Users,
Agencies=Agencies,
Determinations=Determinations,
Requests=Requests,
Responses=Responses,
Events=Events,
Reasons=Reasons,
Roles=Roles,
UserRequests=UserRequests,
AgencyUsers=AgencyUsers,
Emails=Emails,
Letters=Letters,
LetterTemplates=LetterTemplates,
Envelopes=Envelopes,
EnvelopeTemplates=EnvelopeTemplates,
CustomRequestForms=CustomRequestForms,
)

@app.cli.command()
@click.option("--first_name", prompt="First Name")
@click.option("--middle_initial", default="", prompt="Middle Initial")
@click.option("--last_name", prompt="Last Name")
@click.option("--email", prompt="Email Address")
@click.option("--agency_ein", prompt="Agency EIN (e.g. 0002)")
@click.option(
--is_admin", default=False, prompt="Should user be made an agency administrator?
)
@click.option(
--is_active", default=False, prompt="Should user be activated immediately?
)

add_user(
def add_user(
first_name: str,
last_name: str,
email: str,
agency_ein: str,
middle_initial: str = None,
is_admin: bool = False,
is_active: bool = False,
):

if not first_name:
raise click.UsageError("First name is required")
if not last_name:
raise click.UsageError("Last name is required")
if not email:
raise click.UsageError("Email Address is required")
if not agency_ein:
raise click.UsageError("Agency EIN is required")

user = Users(
guid=generate_guid(),
first_name=first_name,
middle_initial=middle_initial,
last_name=last_name,
email=email,
email_validated=False,
is_nyc_employee=True,
is_anonymous_requester=False,
)
db.session.add(user)

agency_user = AgencyUsers(
user_guid=user.guid,
agency_ein=agency_ein,
is_agency_active=is_active,
is_agency_admin=is_admin,
is_primary_agency=True,
)

db.session.add(agency_user)
db.session.commit()
if is_admin:
redis_key = "{current_user_guid}-{update_user_guid}-{agency_ein}-{timestamp}".format(
current_user_guid="openrecords_support",
update_user_guid=user.guid,
agency_ein=agency_ein,
timestamp=datetime.now(),
)
make_user_admin.apply_async(
args=(user.guid, "openrecords_support", agency_ein), task_id=redis_key
)

print(user)

@app.cli.command()
@click.option("--agency_ein", prompt="Agency EIN (e.g. 0002)")
@click.option("--date_from", prompt="Date From (e.g. 2000-01-01")
@click.option("--date_to", prompt="Date To (e.g. 2000-02-01)")
@click.option("--emails", prompt="Emails (e.g. test@mailinator.com,test2@mailinator.com)")

generate_closing_report(agency_ein: str, date_from: str, date_to: str, emails: str):
def generate_closing_report(agency_ein: str, date_from: str, date_to: str, emails: str):

email_list = emails.split(',')
generate_request_closing_user_report(agency_ein, date_from, date_to, email_list)

@app.cli.command()
@click.option("--agency_ein", prompt="Agency EIN (e.g. 0002)")
@click.option("--date_from", prompt="Date From (e.g. 2000-01-01")
@click.option("--date_to", prompt="Date To (e.g. 2000-02-01)")
@click.option("--emails", prompt="Emails (e.g. test@mailinator.com,test2@mailinator.com)")

generate_monthly_report(agency_ein: str, date_from: str, date_to: str, emails: str):
def generate_monthly_report(agency_ein: str, date_from: str, date_to: str, emails: str):

email_list = emails.split(',')
generate_monthly_metrics_report(agency_ein, date_from, date_to, email_list)

@app.cli.command()

es_recreate():
def es_recreate():

recreate()

@app.cli.command

routes():
def routes():

output = []
for rule in app.url_map.iter_rules():
options = {}
for arg in rule.arguments:
if arg == "year":
options[arg] = "{}".format(datetime.now().year)
continue
options[arg] = "[{}]".format(arg)

methods = ",".join(rule.methods)
url = url_for(rule.endpoint, **options)

if str(datetime.now().year) in url:
url = url.replace(str(datetime.now().year), "[year]")
line = unquote("{:50} {:20} {}".format(rule.endpoint, methods, url))

output.append(line)

for line in sorted(output):
print(line)

@app.cli.command()
@click.option("--test-name", help="Specify tests (file, class, or specific test)")
@click.option(
--coverage/--no-coverage", "use_coverage", default=False, help="Run tests under code coverage.
)
@click.option("--verbose", is_flag=True, default=False, help="Py.Test verbose mode")

test(test_name: str = None, use_coverage: bool = False, verbose: bool = False):
def test(test_name: str = None, use_coverage: bool = False, verbose: bool = False):
Run the unit tests.
Run the unit tests.

if use_coverage and not os.environ.get("FLASK_COVERAGE"):
os.environ["FLASK_COVERAGE"] = "1
os.execvp(sys.executable, [sys.executable] + sys.argv)

command = []

if verbose:
command.append("-v")

if test_name:
command.append("tests/{test_name}".format(test_name=test_name))
else:
command.append("tests/")

pytest.main(command)

if COV:
COV.stop()
COV.save()
print("Coverage Summary:")
COV.report()
COV.html_report()
COV.xml_report()

@app.cli.command()
@click.option(
--length",
default=25,
help="Number of functions to include in the profiler report.",
)
@click.option(
--profile-dir", default=None, help="Directory where profiler data files are saved.
)

profile(length, profile_dir):
def profile(length, profile_dir):

app.wsgi_app = ProfilerMiddleware(
app.wsgi_app, restrictions=[length], profile_dir=profile_dir
)
app.run()

@app.cli.command()

deploy():
def deploy():

# migrate database to latest revision
upgrade()

# pre-populate
list(
map(
lambda x: x.populate(),
(
Roles,
Agencies,
Reasons,
Users,
LetterTemplates,
EnvelopeTemplates,
CustomRequestForms,
),
)
)
recreate()

if __name__ == "__main__":
main()

Source code