Module glean.testing

Utilities for writing unit tests involving Glean.

Functions

def reset_glean(*,
application_id: str,
application_version: str,
configuration: Configuration | None = None,
clear_stores: bool = True) ‑> None

Expand source code

def reset_glean(
    *,
    application_id: str,
    application_version: str,
    configuration: Optional[Configuration] = None,
    clear_stores: bool = True,
) -> None:
    """
    Resets the Glean singleton.

    Args:
        application_id (str): The application id to use when sending pings.
        application_version (str): The version of the application sending
            Glean data.
        configuration (glean.config.Configuration): (optional) An object with
            global settings.
    """
    from glean import Glean

    data_dir: Optional[Path] = None
    if not clear_stores:
        Glean._destroy_data_dir = False
        data_dir = Glean._data_dir

    Glean._reset()

    Glean._testing_mode = True
    glean_set_test_mode(True)
    glean_set_log_pings(True)

    if data_dir is None:
        Glean._initialize_with_tempdir_for_testing(
            application_id=application_id,
            application_version=application_version,
            upload_enabled=True,
            configuration=configuration,
        )
    else:
        Glean.initialize(
            application_id=application_id,
            application_version=application_version,
            upload_enabled=True,
            data_dir=data_dir,
            configuration=configuration,
        )

Resets the Glean singleton.

Args

application_id : str

The application id to use when sending pings.

application_version : str

The version of the application sending Glean data.

configuration : Configuration

(optional) An object with global settings.

Classes

class ErrorType (value, names=None, *, module=None, qualname=None, type=None, start=1)

Expand source code

class ErrorType(enum.Enum):
    INVALID_VALUE = 0
    
    INVALID_LABEL = 1
    
    INVALID_STATE = 2
    
    INVALID_OVERFLOW = 3

An enumeration.

Ancestors

• enum.Enum

Class variables

var INVALID_LABEL

var INVALID_OVERFLOW

var INVALID_STATE

var INVALID_VALUE