Storage

FileStorage

Bases: Protocol

Protocol for representing required file uploader interfaces.

Source code in pytest_qaseio/storage.py

class FileStorage(typing.Protocol):
    """Protocol for representing required file uploader interfaces."""

    def save_file_obj(self, content: bytes, filename: str) -> str:
        """Upload file to storage and return URL."""
        ...

save_file_obj(content, filename)

Upload file to storage and return URL.

Source code in pytest_qaseio/storage.py

def save_file_obj(self, content: bytes, filename: str) -> str:
    """Upload file to storage and return URL."""
    ...

QaseFileStorage

Upload files to Qase S3 bucket as attachment.

Source code in pytest_qaseio/storage.py

class QaseFileStorage:
    """Upload files to Qase S3 bucket as attachment."""

    def __init__(
        self,
        qase_token: str,
        qase_project_code: str,
    ) -> None:
        """Prepare ApiClient for qase io using credentials."""
        self._client = ApiClient(
            configuration=qaseio_config.Configuration(
                api_key={
                    "TokenAuth": qase_token,
                },
            ),
        )
        self._project_code = qase_project_code

    def save_file_obj(self, content: bytes, filename: str) -> str:
        """Upload file to Qase.io S3 bucket via attachment API."""
        attachment_response_result = (
            AttachmentsApi(
                self._client,
            )
            .upload_attachment(
                code=self._project_code,
                file=[content],
            )
            .result
        )
        assert attachment_response_result is not None  # noqa: S101

        return typing.cast(str, attachment_response_result[0].url)

__init__(qase_token, qase_project_code)

Prepare ApiClient for qase io using credentials.

Source code in pytest_qaseio/storage.py

def __init__(
    self,
    qase_token: str,
    qase_project_code: str,
) -> None:
    """Prepare ApiClient for qase io using credentials."""
    self._client = ApiClient(
        configuration=qaseio_config.Configuration(
            api_key={
                "TokenAuth": qase_token,
            },
        ),
    )
    self._project_code = qase_project_code

save_file_obj(content, filename)

Upload file to Qase.io S3 bucket via attachment API.

Source code in pytest_qaseio/storage.py

def save_file_obj(self, content: bytes, filename: str) -> str:
    """Upload file to Qase.io S3 bucket via attachment API."""
    attachment_response_result = (
        AttachmentsApi(
            self._client,
        )
        .upload_attachment(
            code=self._project_code,
            file=[content],
        )
        .result
    )
    assert attachment_response_result is not None  # noqa: S101

    return typing.cast(str, attachment_response_result[0].url)