Source code for cylc.flow.main_loop.health_check

# THIS FILE IS PART OF THE CYLC WORKFLOW ENGINE.
# Copyright (C) NIWA & British Crown (Met Office) & Contributors.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
"""Checks the integrity of the workflow run directory.

* Ensures workflow run directory is still present.
* Ensures contact file is present and consistent with the running workflow.

Shuts down the workflow in the event of inconsistency or error.

"""
import os

from cylc.flow import workflow_files
from cylc.flow.exceptions import CylcError, ServiceFileError
from cylc.flow.main_loop import periodic


[docs] @periodic async def health_check(scheduler, _): """Perform workflow health checks.""" # 1. check if workflow run dir still present - if not shutdown. _check_workflow_run_dir(scheduler) # 2. check if contact file consistent with current start - if not # shutdown. _check_contact_file(scheduler)
def _check_workflow_run_dir(scheduler): if not os.path.exists(scheduler.workflow_run_dir): raise CylcError( 'Workflow run directory does not exist:' f' {scheduler.workflow_run_dir}' ) def _check_contact_file(scheduler): try: contact_data = workflow_files.load_contact_file( scheduler.workflow) if contact_data != scheduler.contact_data: raise CylcError('contact file modified') except (AssertionError, IOError, ValueError, ServiceFileError) as exc: raise CylcError( '%s: contact file corrupted/modified and may be left' % workflow_files.get_contact_file_path(scheduler.workflow) ) from exc