11535771630

Committed 26 Oct 2024 11:32PM UTC coverage: 67.45% (-0.008%) from 67.458%

Build # 11535771630

Build Type

Pull #1224

github

Committed by

web-flow

Commit Message

Merge 2bec3298c into de652a71c

Pull Request Pull Request #1224: fix: docs should build again

Run Details

6337 of 10227 branches covered (61.96%)

Branch coverage included in aggregate %.

3 of 4 new or added lines in 1 file covered. (75.0%)

2 existing lines in 1 file now uncovered.

7957 of 10965 relevant lines covered (72.57%)

5.75 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

85.37

/flexmeasures/ui/__init__.py

"""
Backoffice user interface & charting support.
"""

import os

from flask import current_app, Flask, Blueprint, send_from_directory, request
from flask_security import login_required, roles_accepted
from flask_login import current_user

import pandas as pd
import rq_dashboard
from humanize import naturaldelta

from werkzeug.exceptions import Forbidden

from flexmeasures.auth.policy import ADMIN_ROLE, ADMIN_READER_ROLE
from flexmeasures.utils.flexmeasures_inflection import (
    capitalize,
    parameterize,
    pluralize,
)
from flexmeasures.utils.time_utils import (
    localized_datetime_str,
    naturalized_datetime_str,
    to_utc_timestamp,
)
from flexmeasures.utils.app_utils import (
    parse_config_entry_by_account_roles,
    find_first_applicable_config_entry,
)

# The ui blueprint. It is registered with the Flask app (see app.py)
flexmeasures_ui = Blueprint(
    "flexmeasures_ui",
    __name__,
    static_folder="static",
    static_url_path="/ui/static",
    template_folder="templates",
)


def register_at(app: Flask):
    """This can be used to register this blueprint together with other ui-related things"""

    from flexmeasures.ui.crud.assets import AssetCrudUI
    from flexmeasures.ui.crud.users import UserCrudUI
    from flexmeasures.ui.crud.accounts import AccountCrudUI
    from flexmeasures.ui.views.sensors import SensorUI
    from flexmeasures.ui.utils.color_defaults import get_color_settings

    AssetCrudUI.register(app)
    UserCrudUI.register(app)
    SensorUI.register(app)
    AccountCrudUI.register(app)

    import flexmeasures.ui.views  # noqa: F401 this is necessary to load the views

    app.register_blueprint(
        flexmeasures_ui
    )  # now registering the blueprint will affect all views

    register_rq_dashboard(app)

    # Injects Flexmeasures default colors into all templates
    @app.context_processor
    def inject_global_vars():
        return get_color_settings(None)

    @app.route("/favicon.ico")
    def favicon():
        return send_from_directory(
            flexmeasures_ui.static_folder,
            "favicon.ico",
            mimetype="image/vnd.microsoft.icon",
        )

    from flexmeasures.ui.error_handlers import add_html_error_views

    add_html_error_views(app)
    add_jinja_filters(app)
    add_jinja_variables(app)


def register_rq_dashboard(app):
    app.config.update(
        RQ_DASHBOARD_REDIS_URL=[
            "redis://:%s@%s:%s/%s"
            % (
                app.config.get("FLEXMEASURES_REDIS_PASSWORD", ""),
                app.config.get("FLEXMEASURES_REDIS_URL", ""),
                app.config.get("FLEXMEASURES_REDIS_PORT", ""),
                app.config.get("FLEXMEASURES_REDIS_DB_NR", ""),
            ),
            # it is possible to add additional rq instances to this list
        ]
    )

    @login_required
    def basic_auth():
        """Ensure basic authorization."""
        return

    @login_required
    @roles_accepted(ADMIN_ROLE, ADMIN_READER_ROLE)
    def basic_admin_auth():
        """Ensure basic admin authorization."""

        if (
            current_user.has_role(ADMIN_READER_ROLE)
            and (request.method != "GET")
            and ("requeue" not in request.path)
        ):
            raise Forbidden(
                f"User with `{ADMIN_READER_ROLE}` role is only allowed to list/inspect tasks, queues and workers. Edition or deletion operations are forbidden."
            )

        return

    # Logged-in users can view queues on the demo server, but only admins can view them on other servers
    if app.config.get("FLEXMEASURES_ENV") != "documentation":
        if app.config.get("FLEXMEASURES_MODE", "") == "demo":
            rq_dashboard.blueprint.before_request(basic_auth)
        else:
            rq_dashboard.blueprint.before_request(basic_admin_auth)

    # To set template variables, use set_global_template_variables in app.py
    app.register_blueprint(rq_dashboard.blueprint, url_prefix="/tasks")


def add_jinja_filters(app):
    from flexmeasures.ui.utils.view_utils import asset_icon_name, username, accountname

    app.jinja_env.filters["zip"] = zip  # Allow zip function in templates
    app.jinja_env.add_extension(
        "jinja2.ext.do"
    )  # Allow expression statements (e.g. for modifying lists)
    app.jinja_env.filters["localized_datetime"] = localized_datetime_str
    app.jinja_env.filters["naturalized_datetime"] = naturalized_datetime_str
    app.jinja_env.filters["to_utc_timestamp"] = to_utc_timestamp
    app.jinja_env.filters["naturalized_timedelta"] = naturaldelta
    app.jinja_env.filters["capitalize"] = capitalize
    app.jinja_env.filters["pluralize"] = pluralize
    app.jinja_env.filters["parameterize"] = parameterize
    app.jinja_env.filters["isnull"] = pd.isnull
    app.jinja_env.filters["hide_nan_if_desired"] = lambda x: (
        ""
        if x in ("nan", "nan%", "NAN")
        and current_app.config.get("FLEXMEASURES_HIDE_NAN_IN_UI", False)
        else x
    )
    app.jinja_env.filters["asset_icon"] = asset_icon_name
    app.jinja_env.filters["username"] = username
    app.jinja_env.filters["accountname"] = accountname
    app.jinja_env.filters["parse_config_entry_by_account_roles"] = (
        parse_config_entry_by_account_roles
    )
    app.jinja_env.filters["find_first_applicable_config_entry"] = (
        find_first_applicable_config_entry
    )


def add_jinja_variables(app):
    # Set variables for Jinja template context
    for v, d in (
        ("FLEXMEASURES_MODE", ""),
        ("FLEXMEASURES_PLATFORM_NAME", ""),
        ("FLEXMEASURES_MENU_LISTED_VIEWS", []),
        ("FLEXMEASURES_MENU_LISTED_VIEW_ICONS", {}),
        ("FLEXMEASURES_MENU_LISTED_VIEW_TITLES", {}),
        ("FLEXMEASURES_PUBLIC_DEMO_CREDENTIALS", ""),
    ):
        app.jinja_env.globals[v] = app.config.get(v, d)
    app.jinja_env.globals["documentation_exists"] = (
        True
        if os.path.exists(
            "%s/static/documentation/html/index.html" % flexmeasures_ui.root_path
        )
        else False
    )

1	"""	4✔
2	Backoffice user interface & charting support.
3	"""
4
5	import os	8✔
6
7	from flask import current_app, Flask, Blueprint, send_from_directory, request	8✔
8	from flask_security import login_required, roles_accepted	8✔
9	from flask_login import current_user	8✔
10
11	import pandas as pd	8✔
12	import rq_dashboard	8✔
13	from humanize import naturaldelta	8✔
14
15	from werkzeug.exceptions import Forbidden	8✔
16
17	from flexmeasures.auth.policy import ADMIN_ROLE, ADMIN_READER_ROLE	8✔
18	from flexmeasures.utils.flexmeasures_inflection import (	8✔
19	capitalize,
20	parameterize,
21	pluralize,
22	)
23	from flexmeasures.utils.time_utils import (	8✔
24	localized_datetime_str,
25	naturalized_datetime_str,
26	to_utc_timestamp,
27	)
28	from flexmeasures.utils.app_utils import (	8✔
29	parse_config_entry_by_account_roles,
30	find_first_applicable_config_entry,
31	)
32
33	# The ui blueprint. It is registered with the Flask app (see app.py)
34	flexmeasures_ui = Blueprint(	8✔
35	"flexmeasures_ui",
36	__name__,
37	static_folder="static",
38	static_url_path="/ui/static",
39	template_folder="templates",
40	)
41
42
43	def register_at(app: Flask):	8✔
44	"""This can be used to register this blueprint together with other ui-related things"""
45
46	from flexmeasures.ui.crud.assets import AssetCrudUI	8✔
47	from flexmeasures.ui.crud.users import UserCrudUI	8✔
48	from flexmeasures.ui.crud.accounts import AccountCrudUI	8✔
49	from flexmeasures.ui.views.sensors import SensorUI	8✔
50	from flexmeasures.ui.utils.color_defaults import get_color_settings	8✔
51
52	AssetCrudUI.register(app)	8✔
53	UserCrudUI.register(app)	8✔
54	SensorUI.register(app)	8✔
55	AccountCrudUI.register(app)	8✔
56
57	import flexmeasures.ui.views # noqa: F401 this is necessary to load the views	8✔
58
59	app.register_blueprint(	8✔
60	flexmeasures_ui
61	) # now registering the blueprint will affect all views
62
63	register_rq_dashboard(app)	8✔
64
65	# Injects Flexmeasures default colors into all templates
66	@app.context_processor	8✔
67	def inject_global_vars():	8✔
68	return get_color_settings(None)	8✔
69
70	@app.route("/favicon.ico")	8✔
71	def favicon():	8✔
72	return send_from_directory(	×
73	flexmeasures_ui.static_folder,
74	"favicon.ico",
75	mimetype="image/vnd.microsoft.icon",
76	)
77
78	from flexmeasures.ui.error_handlers import add_html_error_views	8✔
79
80	add_html_error_views(app)	8✔
81	add_jinja_filters(app)	8✔
82	add_jinja_variables(app)	8✔
83
84
85	def register_rq_dashboard(app):	8✔
86	app.config.update(	8✔
87	RQ_DASHBOARD_REDIS_URL=[
88	"redis://:%s@%s:%s/%s"
89	% (
90	app.config.get("FLEXMEASURES_REDIS_PASSWORD", ""),
91	app.config.get("FLEXMEASURES_REDIS_URL", ""),
92	app.config.get("FLEXMEASURES_REDIS_PORT", ""),
93	app.config.get("FLEXMEASURES_REDIS_DB_NR", ""),
94	),
95	# it is possible to add additional rq instances to this list
96	]
97	)
98
99	@login_required	8✔
100	def basic_auth():	8✔
101	"""Ensure basic authorization."""
102	return	×
103
104	@login_required	8✔
105	@roles_accepted(ADMIN_ROLE, ADMIN_READER_ROLE)	8✔
106	def basic_admin_auth():	8✔
107	"""Ensure basic admin authorization."""
108
109	if (	×
110	current_user.has_role(ADMIN_READER_ROLE)
111	and (request.method != "GET")
112	and ("requeue" not in request.path)
113	):
114	raise Forbidden(	×
115	f"User with `{ADMIN_READER_ROLE}` role is only allowed to list/inspect tasks, queues and workers. Edition or deletion operations are forbidden."
116	)
117
118	return	×
119
120	# Logged-in users can view queues on the demo server, but only admins can view them on other servers
121	if app.config.get("FLEXMEASURES_ENV") != "documentation":	8✔
122	if app.config.get("FLEXMEASURES_MODE", "") == "demo":	8✔
NEW 123	rq_dashboard.blueprint.before_request(basic_auth)	×
124	else:
125	rq_dashboard.blueprint.before_request(basic_admin_auth)	8✔
126
127	# To set template variables, use set_global_template_variables in app.py
128	app.register_blueprint(rq_dashboard.blueprint, url_prefix="/tasks")	8!
129
130
131	def add_jinja_filters(app):	8✔
132	from flexmeasures.ui.utils.view_utils import asset_icon_name, username, accountname	8✔
133
134	app.jinja_env.filters["zip"] = zip # Allow zip function in templates	8✔
135	app.jinja_env.add_extension(	8✔
136	"jinja2.ext.do"
137	) # Allow expression statements (e.g. for modifying lists)
138	app.jinja_env.filters["localized_datetime"] = localized_datetime_str	8✔
139	app.jinja_env.filters["naturalized_datetime"] = naturalized_datetime_str	8✔
140	app.jinja_env.filters["to_utc_timestamp"] = to_utc_timestamp	8✔
141	app.jinja_env.filters["naturalized_timedelta"] = naturaldelta	8✔
142	app.jinja_env.filters["capitalize"] = capitalize	8✔
143	app.jinja_env.filters["pluralize"] = pluralize	8✔
144	app.jinja_env.filters["parameterize"] = parameterize	8✔
145	app.jinja_env.filters["isnull"] = pd.isnull	8✔
146	app.jinja_env.filters["hide_nan_if_desired"] = lambda x: (	8✔
147	""
148	if x in ("nan", "nan%", "NAN")
149	and current_app.config.get("FLEXMEASURES_HIDE_NAN_IN_UI", False)
150	else x
151	)
152	app.jinja_env.filters["asset_icon"] = asset_icon_name	8✔
153	app.jinja_env.filters["username"] = username	8✔
154	app.jinja_env.filters["accountname"] = accountname	8✔
155	app.jinja_env.filters["parse_config_entry_by_account_roles"] = (	8✔
156	parse_config_entry_by_account_roles
157	)
158	app.jinja_env.filters["find_first_applicable_config_entry"] = (	8✔
159	find_first_applicable_config_entry
160	)
161
162
163	def add_jinja_variables(app):	8✔
164	# Set variables for Jinja template context
165	for v, d in (	8✔
166	("FLEXMEASURES_MODE", ""),
167	("FLEXMEASURES_PLATFORM_NAME", ""),
168	("FLEXMEASURES_MENU_LISTED_VIEWS", []),
169	("FLEXMEASURES_MENU_LISTED_VIEW_ICONS", {}),
170	("FLEXMEASURES_MENU_LISTED_VIEW_TITLES", {}),
171	("FLEXMEASURES_PUBLIC_DEMO_CREDENTIALS", ""),
172	):
173	app.jinja_env.globals[v] = app.config.get(v, d)	8✔
174	app.jinja_env.globals["documentation_exists"] = (	8✔
175	True
176	if os.path.exists(
177	"%s/static/documentation/html/index.html" % flexmeasures_ui.root_path
178	)
179	else False
180	)

FlexMeasures / flexmeasures / 11535771630

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous