Customize Health Page Title

CHANGELOG.rst

@@ -6,6 +6,12 @@ snovault
 Change Log
 ----------
 
+11.14.0
+=======
+
+* Allow customization of health page title
+
+
 11.13.0
 =======
 

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "dcicsnovault"
-version = "11.13.0"
+version = "11.14.0"
 description = "Storage support for 4DN Data Portals."
 authors = ["4DN-DCIC Team <[email protected]>"]
 license = "MIT"
@@ -84,6 +84,7 @@ xlrd = "^1.0.0"
 "zope.interface" = ">=4.7.2,<6"
 "zope.sqlalchemy" = "1.6"
 jsonschema = {extras = ["format-nongpl"], version = "^4.19.0"}
+uptime = "^3.0.1"
 
 [tool.poetry.dev-dependencies]
 boto3-stubs = ">=1.28.62"  # no particular version required, but this speeds up search

snovault/project/health.py

@@ -0,0 +1,5 @@
+class SnovaultProjectHealthValue:
+
+    @staticmethod
+    def get_app_namespace():
+        return 'ENCODED'

snovault/project_defs.py

@@ -6,6 +6,7 @@
 from .project.loadxl import SnovaultProjectLoadxl
 from .project.renderers import SnovaultProjectRenderers
 from .project.schema_views import SnovaultProjectSchemaViews
+from .project.health import SnovaultProjectHealthValue
 
 
 @C4ProjectRegistry.register("dcicsnovault")
@@ -16,6 +17,7 @@ class SnovaultProject(SnovaultProjectAccessKey,
                       SnovaultProjectLoadxl,
                       SnovaultProjectRenderers,
                       SnovaultProjectSchemaViews,
+                      SnovaultProjectHealthValue,
                       C4Project):
     NAMES = {"NAME": "snovault", "PYPI_NAME": "dcicsnovault"}
     ACCESSION_PREFIX = "SNO"

snovault/root.py

@@ -14,6 +14,7 @@
 from .appdefs import APP_VERSION_REGISTRY_KEY, ITEM_INDEX_ORDER
 from .schema_formats import is_accession
 from .util import SettingsKey
+from .project_app import app_project
 
 
 def includeme(config):
@@ -124,8 +125,8 @@ class ExtendedHealthPageKey(HealthPageKey):
             h.BEANSTALK_APP_VERSION: settings.get(s.EB_APP_VERSION),
             h.BEANSTALK_ENV: env_name,
             h.BLOB_BUCKET: settings.get(s.BLOB_BUCKET),
-            h.DATABASE: settings.get(s.SQLALCHEMY_URL).split('@')[1],  # don't show user /password
-            h.DISPLAY_TITLE: "ENCODED Portal Status and Foursight Monitoring",
+            h.DATABASE: settings.get(s.SQLALCHEMY_URL, 'dummy@postgres').split('@')[1],  # don't show user /password
+            h.DISPLAY_TITLE: f"{app_project().get_app_namespace()} Portal Status and Foursight Monitoring",
             h.ELASTICSEARCH: settings.get(s.ELASTICSEARCH_SERVER),
             h.FILE_UPLOAD_BUCKET: settings.get(s.FILE_UPLOAD_BUCKET),
             h.FOURSIGHT: foursight_url,

snovault/tests/root.py

@@ -8,6 +8,7 @@
     Deny,
     Everyone,
 )
+from ..root import health_check
 from ..schema_utils import format_checker
 from ..calculated import calculated_property
 from ..resources import Root
@@ -19,6 +20,7 @@
 
 
 def includeme(config):
+    config.include(health_check)
     config.scan(__name__)
 
 

snovault/tests/test_health_path.py

@@ -0,0 +1,12 @@
+import pytest
+from dcicutils.misc_utils import ignored
+
+
+ignored(pytest)
+
+
+def test_health_page_basic(testapp):
+    """ Tests that we can reach the health page and that the customization works """
+    health = testapp.get('/health').json
+    assert health['display_title'] == 'ENCODED Portal Status and Foursight Monitoring'
+    assert health['database'] == 'postgres'

snovault/tests/testappfixtures.py

@@ -6,6 +6,7 @@
 from .. import main  # Function main actually defined in __init__.py (should maybe be defined elsewhere)
 
 _app_settings = {
+    'env.name': 'snovault',
     'collection_datastore': 'database',
     'item_datastore': 'database',
     'load_test_only': True,