7097579067

Committed 05 Dec 2023 07:34AM UTC coverage: 86.691% (+0.02%) from 86.671%

Build # 7097579067

Build Type

Pull #219

github

Committed by

web-flow

Commit Message

Merge dbc6a9187 into b23ef5037

Pull Request Pull Request #219: Add landing page with configuration

Run Details

607 of 721 branches covered (0.0%)

Branch coverage included in aggregate %.

11 of 16 new or added lines in 3 files covered. (68.75%)

17 existing lines in 2 files now uncovered.

1790 of 2044 relevant lines covered (87.57%)

0.88 hits per line

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

90.0

/greenwave/app_factory.py

# SPDX-License-Identifier: GPL-2.0+

import logging
import logging.config

from flask import Flask, current_app, jsonify
from greenwave.api_v1 import api
from greenwave.utils import json_error, load_config, mangle_key
from greenwave.policies import load_policies
from greenwave.subjects.subject_type import load_subject_types

from dogpile.cache import make_region
import requests
from werkzeug.exceptions import default_exceptions

log = logging.getLogger(__name__)


# applicaiton factory http://flask.pocoo.org/docs/0.12/patterns/appfactories/
def create_app(config_obj=None):
    app = Flask(__name__)

    app.config.update(load_config(config_obj))
    if app.config['PRODUCTION'] and app.secret_key == 'replace-me-with-something-random':  # nosec
        raise Warning("You need to change the app.secret_key value for production")

    logging_config = app.config.get('LOGGING')
    if logging_config:
        logging.config.dictConfig(logging_config)

    policies_dir = app.config['POLICIES_DIR']
    log.debug("config: Loading policies from %r", policies_dir)
    app.config['policies'] = load_policies(policies_dir)

    subject_types_dir = app.config['SUBJECT_TYPES_DIR']
    log.debug("config: Loading subject types from %r", subject_types_dir)
    app.config['subject_types'] = load_subject_types(subject_types_dir)

    if app.config.get('DIST_GIT_URL_TEMPLATE') and app.config.get('DIST_GIT_BASE_URL'):
        app.config['DIST_GIT_URL_TEMPLATE'] = app.config['DIST_GIT_URL_TEMPLATE'].replace(
            '{DIST_GIT_BASE_URL}', app.config['DIST_GIT_BASE_URL']
        )

    # register error handlers
    for code in default_exceptions.keys():
        app.register_error_handler(code, json_error)
    app.register_error_handler(ConnectionError, json_error)
    app.register_error_handler(requests.ConnectionError, json_error)
    app.register_error_handler(requests.Timeout, json_error)

    # register blueprints
    app.register_blueprint(api, url_prefix="/api/v1.0")
    app.add_url_rule('/', view_func=landing_page)
    app.add_url_rule('/healthcheck', view_func=healthcheck)

    # Initialize the cache.
    app.cache = make_region(key_mangler=mangle_key)
    app.cache.configure(**app.config['CACHE'])

    return app


def landing_page():
    return (
        jsonify({
            "documentation": current_app.config["DOCUMENTATION_URL"],
            "api_v1": current_app.config["GREENWAVE_API_URL"],
            "resultsdb_api": current_app.config["RESULTSDB_API_URL"],
            "waiverdb_api": current_app.config["WAIVERDB_API_URL"],
            "koji_api": current_app.config["KOJI_BASE_URL"],
            "outcomes_passed": current_app.config["OUTCOMES_PASSED"],
            "outcomes_error": current_app.config["OUTCOMES_ERROR"],
            "outcomes_incomplete": current_app.config["OUTCOMES_INCOMPLETE"],
        }),
        200,
    )


def healthcheck():
    """
    Request handler for performing an application-level health check. This is
    not part of the published API, it is intended for use by OpenShift or other
    monitoring tools.

    Returns a 200 response if the application is alive and able to serve requests.
    """
    return 'Health check OK', 200, [('Content-Type', 'text/plain')]

1	# SPDX-License-Identifier: GPL-2.0+
2
3	import logging	1✔
4	import logging.config	1✔
5
6	from flask import Flask, current_app, jsonify	1✔
7	from greenwave.api_v1 import api	1✔
8	from greenwave.utils import json_error, load_config, mangle_key	1✔
9	from greenwave.policies import load_policies	1✔
10	from greenwave.subjects.subject_type import load_subject_types	1✔
11
12	from dogpile.cache import make_region	1✔
13	import requests	1✔
14	from werkzeug.exceptions import default_exceptions	1✔
15
16	log = logging.getLogger(__name__)	1✔
17
18
19	# applicaiton factory http://flask.pocoo.org/docs/0.12/patterns/appfactories/
20	def create_app(config_obj=None):	1✔
21	app = Flask(__name__)	1✔
22
23	app.config.update(load_config(config_obj))	1✔
24	if app.config['PRODUCTION'] and app.secret_key == 'replace-me-with-something-random': # nosec	1!
25	raise Warning("You need to change the app.secret_key value for production")	×
26
27	logging_config = app.config.get('LOGGING')	1✔
28	if logging_config:	1!
29	logging.config.dictConfig(logging_config)	×
30
31	policies_dir = app.config['POLICIES_DIR']	1✔
32	log.debug("config: Loading policies from %r", policies_dir)	1✔
33	app.config['policies'] = load_policies(policies_dir)	1✔
34
35	subject_types_dir = app.config['SUBJECT_TYPES_DIR']	1✔
36	log.debug("config: Loading subject types from %r", subject_types_dir)	1✔
37	app.config['subject_types'] = load_subject_types(subject_types_dir)	1✔
38
39	if app.config.get('DIST_GIT_URL_TEMPLATE') and app.config.get('DIST_GIT_BASE_URL'):	1✔
40	app.config['DIST_GIT_URL_TEMPLATE'] = app.config['DIST_GIT_URL_TEMPLATE'].replace(	1✔
41	'{DIST_GIT_BASE_URL}', app.config['DIST_GIT_BASE_URL']
42	)
43
44	# register error handlers
45	for code in default_exceptions.keys():	1✔
46	app.register_error_handler(code, json_error)	1✔
47	app.register_error_handler(ConnectionError, json_error)	1✔
48	app.register_error_handler(requests.ConnectionError, json_error)	1✔
49	app.register_error_handler(requests.Timeout, json_error)	1✔
50
51	# register blueprints
52	app.register_blueprint(api, url_prefix="/api/v1.0")	1✔
53	app.add_url_rule('/', view_func=landing_page)	1✔
54	app.add_url_rule('/healthcheck', view_func=healthcheck)	1✔
55
56	# Initialize the cache.
57	app.cache = make_region(key_mangler=mangle_key)	1✔
58	app.cache.configure(**app.config['CACHE'])	1✔
59
60	return app	1✔
61
62
63	def landing_page():	1✔
64	return (	1✔
65	jsonify({
66	"documentation": current_app.config["DOCUMENTATION_URL"],
67	"api_v1": current_app.config["GREENWAVE_API_URL"],
68	"resultsdb_api": current_app.config["RESULTSDB_API_URL"],
69	"waiverdb_api": current_app.config["WAIVERDB_API_URL"],
70	"koji_api": current_app.config["KOJI_BASE_URL"],
71	"outcomes_passed": current_app.config["OUTCOMES_PASSED"],
72	"outcomes_error": current_app.config["OUTCOMES_ERROR"],
73	"outcomes_incomplete": current_app.config["OUTCOMES_INCOMPLETE"],
74	}),
75	200,
76	)
77
78
79	def healthcheck():	1✔
80	"""
81	Request handler for performing an application-level health check. This is
82	not part of the published API, it is intended for use by OpenShift or other
83	monitoring tools.
84
85	Returns a 200 response if the application is alive and able to serve requests.
86	"""
UNCOV 87	return 'Health check OK', 200, [('Content-Type', 'text/plain')]	×

release-engineering / greenwave / 7097579067

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