testbed/googleapis__python-aiplatform/samples/snippets/helpers.py

# -*- coding: utf-8 -*-

# Copyright 2022 Google LLC
#
# 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.
#

import collections
import re
import time
from timeit import default_timer as timer

from typing import Callable


def get_name(out, key="name"):
    pattern = re.compile(rf'{key}:\s*"([\-a-zA-Z0-9/]+)"')
    name = re.search(pattern, out).group(1)

    return name


def get_state(out):
    pattern = re.compile(r"state:\s*([._a-zA-Z0-9/]+)")
    state = re.search(pattern, out).group(1)

    return state


def get_featurestore_resource_name(out, key="name"):
    pattern = re.compile(rf'{key}:\s*"([\_\-a-zA-Z0-9/]+)"')
    name = re.search(pattern, out).group(1)

    return name


def wait_for_job_state(
    get_job_method: Callable[[str], "proto.Message"],  # noqa: F821
    name: str,
    expected_state: str = "CANCELLED",
    timeout: int = 90,
    freq: float = 1.5,
) -> None:
    """Waits until the Job state of provided resource name is a particular state.

    Args:
        get_job_method: Callable[[str], "proto.Message"]
            Required. The GAPIC getter method to poll. Takes 'name' parameter
            and has a 'state' attribute in its response.
        name (str):
            Required. Complete uCAIP resource name to pass to get_job_method
        expected_state (str):
            The state at which this method will stop waiting.
            Default is "CANCELLED".
        timeout (int):
            Maximum number of seconds to wait for expected_state. If the job
            state is not expected_state within timeout, a TimeoutError will be raised.
            Default is 90 seconds.
        freq (float):
            Number of seconds between calls to get_job_method.
            Default is 1.5 seconds.
    """

    for _ in range(int(timeout / freq)):
        response = get_job_method(name=name)
        if expected_state in str(response.state):
            return None
        time.sleep(freq)

    raise TimeoutError(
        f"Job state did not become {expected_state} within {timeout} seconds"
        "\nTry increasing the timeout in sample test"
        f"\nLast recorded state: {response.state}"
    )


def flaky_test_diagnostic(file_name, test_name, N=20):

    import pytest

    timing_dict = collections.defaultdict(list)
    for ri in range(N):
        start = timer()
        result = pytest.main(["-s", f"{file_name}::{test_name}"])
        end = timer()
        delta = end - start
        if result == pytest.ExitCode.OK:
            timing_dict["SUCCESS"].append(delta)
        else:
            timing_dict["FAILURE"].append(delta)

    return timing_dict