Source code for ops.hookcmds._utils

# Copyright 2025 Canonical Ltd.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

from __future__ import annotations

import datetime
import subprocess
from collections.abc import Sequence




class Error(Exception):
    """Raised when a hook command exits with a non-zero code."""

    returncode: int
    """Exit status of the child process."""

    cmd: list[str]
    """The command that was run.

    Arguments that may contain sensitive data, such as action results, are
    replaced with ``<redacted>``.
    """

    stdout: str = ''
    """Stdout output of the child process."""

    stderr: str = ''
    """Stderr output of the child process."""

    def __init__(self, *, returncode: int, cmd: list[str], stdout: str = '', stderr: str = ''):
        self.returncode = returncode
        self.cmd = cmd
        self.stdout = stdout
        self.stderr = stderr
        super().__init__(f'command {cmd!r} exited with status {returncode}')



def run(
    *args: str,
    input: str | None = None,
    redacted_cmd: Sequence[str] | None = None,
) -> str:
    """Run a hook command and return its stdout.

    Args:
        args: The hook command and its arguments.
        input: Data to send to the hook command's stdin.
        redacted_cmd: If provided, used in place of ``args`` in any raised
            :class:`Error`. Pass this when ``args`` may contain sensitive data,
            so that it doesn't end up in error messages and tracebacks.
    """
    try:
        result = subprocess.run(
            args, capture_output=True, check=True, encoding='utf-8', input=input
        )
    except subprocess.CalledProcessError as e:
        cmd = e.cmd if redacted_cmd is None else list(redacted_cmd)
        raise Error(returncode=e.returncode, cmd=cmd, stdout=e.stdout, stderr=e.stderr) from None
    return result.stdout


def datetime_to_rfc3339(dt: datetime.datetime) -> str:
    """Converts a datetime object to a RFC 3339 string."""
    if dt.tzinfo == datetime.timezone.utc:
        return dt.isoformat().replace('+00:00', 'Z')
    return dt.isoformat()