Add health service (#90)

* Created health service client that uses a stubbed set of health data. To view health status information, the health status information is included when a user prints an instantiated unity object.

* Added print health status method to health service and updated how health statuses are printed to account for service's historical health status information.

* Removed uneeded health service unit test fixture.

* Updated how health status reports are generated so that the report can be reused in multiple places to improve consistency of the health status report.

* Updated CHANGELOG and version number.

* Testing different syntax to resolve flake8 linting error.

* Updated dictionary references to resolve flake8 linting errors.

* Update python-app.yml

* Update python-app.yml

* Update python-app.yml

* Update python-app.yml

* Update python-app.yml

* Update python-app.yml

* Update python-app.yml

* updating workflows

---------

Co-authored-by: mike-gangl <[email protected]>
Co-authored-by: mike-gangl <[email protected]>

.github/workflows/python-app.yml

@@ -44,12 +44,34 @@ jobs:
         UNITY_USER: '${{ secrets.UNITY_TEST_USER }}'
         UNITY_PASSWORD: '${{ secrets.UNITY_TEST_PASSWORD }}'
       run: |
-        poetry run pytest --cov=unity_sds_client -m "not regression"
+        poetry run pytest --cov-report=lcov --cov=unity_sds_client -m "not regression"
     - name: Regression Test with pytest
       env:
         UNITY_USER: '${{ secrets.UNITY_TEST_USER }}'
         UNITY_PASSWORD: '${{ secrets.UNITY_TEST_PASSWORD }}'
       run: |
-        poetry run pytest --cov=unity_sds_client -o log_cli=true --log-cli-level=DEBUG 
+        poetry run pytest --cov-report=lcov --cov=unity_sds_client -o log_cli=true --log-cli-level=DEBUG 
     - name: Coveralls
-      uses: coverallsapp/github-action@v2
+      uses: coverallsapp/[email protected]
+  version:
+    if: github.ref == 'refs/heads/develop' && github.event_name == 'push' 
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v2
+      - name: Install Poetry
+        uses: abatilo/[email protected]
+        with:
+          poetry-version: "1.5.1"
+      - name: version-bump
+        run: |
+          poetry version prerelease
+      - name: Commit Version Bump
+        run: |
+          git config --global user.name 'mdps bot'
+          git config --global user.email '[email protected]'
+          git commit -am "development version bump. [skip actions]"
+          git push
+        
+

CHANGELOG.md

@@ -5,6 +5,18 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## Unreleased (0.5.0)
+
+### Added
+* Health Service with variuos functions that allow user's to inspect the health status of the system
+### Fixed
+### Changed
+* Health status information is included when an instantiated unity object is printed.
+### Removed
+### Security
+### Deprecated
+
+
 ## [0.4.0] - 2024-03-29
 
 ### Added

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "unity-sds-client"
-version = "0.4.0"
+version = "0.5.0a0"
 description = "Unity-Py is a Python client to simplify interactions with NASA's Unity Platform."
 authors = ["Anil Natha, Mike Gangl"]
 readme = "README.md"

tests/test_unity_health_service.py

@@ -0,0 +1,50 @@
+"""
+This module contains a set of tests is to ensure that the
+Unity Health Service is functional.
+"""
+
+import pytest
+
+from unity_sds_client.unity import Unity
+from unity_sds_client.unity_services import UnityServices
+
+
+@pytest.mark.regression
+def test_health_service_client_creation():
+    """
+    Test that an instance of the health service can be instantiated.
+    """
+    s = Unity()
+    health_service = s.client(UnityServices.HEALTH_SERVICE)
+
+@pytest.mark.regression
+def test_health_status_retrieval():
+    """
+    Test that health statuses can be retrieved using the health service.
+    """
+    print("Example health status check")
+    s = Unity()
+    health_service = s.client(UnityServices.HEALTH_SERVICE)
+    health_statuses = health_service.get_health_status()
+    assert health_statuses is not None
+
+@pytest.mark.regression
+def test_health_status_printing():
+    """
+    Test that health statuses can be printed using the health service.
+    """
+    print("Example health status check")
+    s = Unity()
+    health_service = s.client(UnityServices.HEALTH_SERVICE)
+    health_service.print_health_status()
+
+@pytest.mark.regression
+def test_health_service_printing():
+    """
+    Test that when the health service client is printed, it outputs
+    the health status information
+    """
+    print("Example health status printing of health service object.")
+    s = Unity()
+    health_service = s.client(UnityServices.HEALTH_SERVICE)
+    print(health_service)

unity_sds_client/services/health_service.py

@@ -0,0 +1,99 @@
+from unity_sds_client.unity_session import UnitySession
+
+class HealthService(object):
+    """
+    The HealthService class is a wrapper to Unity's Health API endpoints.
+    """
+
+    def __init__(
+        self,
+        session:UnitySession
+    ):
+        """
+        Initialize the HealthService class.
+
+        Parameters
+        ----------
+        session : UnitySession
+            The Unity Session that will be used to facilitate making calls to the Health endpoints.
+
+        Returns
+        -------
+        List
+            List of applications and their health statses
+        """
+
+        self._health_statuses = None
+
+    def __str__(self):
+        return self.generate_health_status_report()
+
+    def get_health_status(self):
+        """
+        Returns a list of services and their respective health status
+        """
+
+        # Get Health Information
+        # Stubbed in health data until Health API endpoint is available
+        self._health_statuses = [
+          {
+            "service": "airflow",
+            "landingPage":"https://unity.jpl.nasa.gov/project/venue/processing/ui",
+            "healthChecks": [
+              {
+                "status": "HEALTHY",
+                "date": "2024-04-09T18:01:08Z"
+              }
+            ]
+          },
+          {
+            "service": "jupyter",
+            "landingPage":"https://unity.jpl.nasa.gov/project/venue/ads/jupyter",
+            "healthChecks": [
+              {
+                "status": "HEALTHY",
+                "date": "2024-04-09T18:01:08Z"
+              }
+            ]
+          },
+          {
+            "service": "other_service",
+            "landingPage":"https://unity.jpl.nasa.gov/project/venue/other_service",
+            "healthChecks": [
+              {
+                "status": "UNHEALTHY",
+                "date": "2024-04-09T18:01:08Z"
+              }
+            ]
+          }
+        ]
+
+        return self._health_statuses
+
+    def generate_health_status_report(self):
+        """
+        Return a generated report of health status information
+        """
+
+        if self._health_statuses is None:
+            self.get_health_status()
+
+        health_status_title = "HEALTH STATUS REPORT"
+        report = f"\n\n{health_status_title}\n"
+        report = report + len(health_status_title) * "-" + "\n\n"
+        for service in self._health_statuses:
+            service_name = service["service"]
+            report = report + f"{service_name}\n"
+            for status in service["healthChecks"]:
+                service_status = status["status"]
+                service_status_date = status["date"]
+                report = report + f"{service_status_date}: {service_status}\n"
+            report = report + "\n"
+
+        return report
+
+    def print_health_status(self):
+        """
+        Print the health status report
+        """
+        print(f"{self.generate_health_status_report()}")

unity_sds_client/unity.py

@@ -2,6 +2,7 @@
 from configparser import ConfigParser, ExtendedInterpolation
 from unity_sds_client.services.data_service import DataService
 from unity_sds_client.services.process_service import ProcessService
+from unity_sds_client.services.health_service import HealthService
 from unity_sds_client.unity_session import UnitySession
 from unity_sds_client.unity_exception import UnityException
 from unity_sds_client.unity_environments import UnityEnvironments
@@ -55,22 +56,26 @@ def client(self, service_name: UnityServices):
         """
         if service_name == UnityServices.DATA_SERVICE:
             return DataService(session=self._session)
+        if service_name == UnityServices.HEALTH_SERVICE:
+            return HealthService(session=self._session)
         elif service_name == UnityServices.PROCESS_SERVICE:
             return ProcessService(session=self._session)
         else:
             raise UnityException("Invalid service name: " + str(service_name))
 
     def __str__(self):
-        response = "UNITY CONFIGURATION"
-        response = response + "\n\n" + len(response) * "-" + "\n"
+        response = "\nUNITY CONFIGURATION"
+        response = response + "\n" + len(response) * "-" + "\n"
 
         config = self._session.get_config()
         config_sections = config.sections()
         for section in config_sections:
-            response = response + "\n{}\n".format(section)
+            response = response + "\n[{}]\n".format(section)
             for setting in dict(config[section]):
                 response = response + "{}: {}\n".format(setting, dict(config[section])[setting])
 
+        response = response + self.client(UnityServices.HEALTH_SERVICE).generate_health_status_report()
+
         return response
 
 

unity_sds_client/unity_services.py

@@ -6,6 +6,7 @@ class UnityServices(Enum):
     The UnityServices class is used to specify a service, when needed, when interacting with the unity_sds_client package.
     """
 
-    DATA_SERVICE = "data_service"
     APPLICATION_SERVICE = "app_service"
+    DATA_SERVICE = "data_service"
+    HEALTH_SERVICE = "health_service"
     PROCESS_SERVICE = "process_service"