domino_admin_toolkit.checks.test_domino_filesystem module

class domino_admin_toolkit.checks.test_domino_filesystem.DominoFileSystemClient

Bases: object

class SearchStatus(value, names=None, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Class for representing the search status.

Attributes:

Found (str): Represents the status when an item is found. NoProjectsFound (str): Represents the status when no projects are found. NoReadmeFound (str): Represents the status when no README file is found.

Found = 'Found'

NoProjectsFound = 'NoProjectsFound'

NoReadmeFound = 'NoReadmeFound'

check_project_for_readme(project_id)

Checks if a given project contains a README file.

Return type:

bool

Attributes:

project_id (str): Represents the ID of the project.

Returns:

bool: True if the project contains a README file, False otherwise.

get_readme_response(project_id)

Sends a GET request to the README file of a given project.

Return type:

Response

Attributes:

project_id (str): Represents the ID of the project.

Returns:

Response object: Represents the server’s response to the request.

get_status()

Checks the status of the Domino File System.

Return type:

ServiceCheckResult

Returns:

ServiceCheckResult: Represents the status of the Domino File System.

The status is ‘green’ if a project with a fetchable README file is found, ‘red’ otherwise.

retrieve_project_id_with_readme()

Retrieves the ID of a project that has a README file.

Return type:

tuple[str | None, SearchStatus]

Returns:

str: The ID of a project that has a README file. If no such project is found, returns None.