[PATCH 1/1] test: fix pydoc issues for EFI tests

[Ilias Apalodimas]

On Wed, 3 May 2023 at 10:29, Heinrich Schuchardt
<heinrich.schuchardt at canonical.com> wrote:
>
> Fix issues reported by pydocstyle.
>
> Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt at canonical.com>
> ---
>  test/py/tests/test_efi_bootmgr/conftest.py     |  6 ++----
>  test/py/tests/test_efi_capsule/capsule_defs.py |  2 ++
>  test/py/tests/test_efi_capsule/conftest.py     | 11 ++++++-----
>  test/py/tests/test_efi_secboot/conftest.py     |  6 ++++--
>  test/py/tests/test_efi_secboot/defs.py         |  2 ++
>  5 files changed, 16 insertions(+), 11 deletions(-)
>
> diff --git a/test/py/tests/test_efi_bootmgr/conftest.py b/test/py/tests/test_efi_bootmgr/conftest.py
> index a0a754afbe..eabafa5429 100644
> --- a/test/py/tests/test_efi_bootmgr/conftest.py
> +++ b/test/py/tests/test_efi_bootmgr/conftest.py
> @@ -1,7 +1,6 @@
>  # SPDX-License-Identifier:      GPL-2.0+
>
> -"""Fixture for UEFI bootmanager test
> -"""
> +"""Fixture for UEFI bootmanager test."""
>
>  import os
>  import shutil
> @@ -10,8 +9,7 @@ import pytest
>
>  @pytest.fixture(scope='session')
>  def efi_bootmgr_data(u_boot_config):
> -    """Set up a file system to be used in UEFI bootmanager
> -       tests
> +    """Set up a file system to be used in UEFI bootmanager tests.
>
>      Args:
>          u_boot_config -- U-boot configuration.
> diff --git a/test/py/tests/test_efi_capsule/capsule_defs.py b/test/py/tests/test_efi_capsule/capsule_defs.py
> index 59b40f11bd..3cc695e29b 100644
> --- a/test/py/tests/test_efi_capsule/capsule_defs.py
> +++ b/test/py/tests/test_efi_capsule/capsule_defs.py
> @@ -1,5 +1,7 @@
>  # SPDX-License-Identifier:      GPL-2.0+
>
> +"""Directoreis used for authentication and capsule tests."""
> +
>  # Directories
>  CAPSULE_DATA_DIR = '/EFI/CapsuleTestData'
>  CAPSULE_INSTALL_DIR = '/EFI/UpdateCapsule'
> diff --git a/test/py/tests/test_efi_capsule/conftest.py b/test/py/tests/test_efi_capsule/conftest.py
> index 0e5137de60..a337e62936 100644
> --- a/test/py/tests/test_efi_capsule/conftest.py
> +++ b/test/py/tests/test_efi_capsule/conftest.py
> @@ -2,8 +2,7 @@
>  # Copyright (c) 2020, Linaro Limited
>  # Author: AKASHI Takahiro <takahiro.akashi at linaro.org>
>
> -"""Fixture for UEFI capsule test
> -"""
> +"""Fixture for UEFI capsule test."""
>
>  from subprocess import call, check_call, CalledProcessError
>  import pytest
> @@ -11,13 +10,15 @@ from capsule_defs import CAPSULE_DATA_DIR, CAPSULE_INSTALL_DIR, EFITOOLS_PATH
>
>  @pytest.fixture(scope='session')
>  def efi_capsule_data(request, u_boot_config):
> -    """Set up a file system to be used in UEFI capsule and authentication test
> -    and return a ath to disk image to be used for testing
> +    """Set up a file system and return path to image.
> +
> +    The function sets up a file system to be used in UEFI capsule and
> +    authentication test and returns a path to disk image to be used
> +    for testing.
>
>      request -- Pytest request object.
>      u_boot_config -- U-boot configuration.
>      """
> -
>      mnt_point = u_boot_config.persistent_data_dir + '/test_efi_capsule'
>      data_dir = mnt_point + CAPSULE_DATA_DIR
>      install_dir = mnt_point + CAPSULE_INSTALL_DIR
> diff --git a/test/py/tests/test_efi_secboot/conftest.py b/test/py/tests/test_efi_secboot/conftest.py
> index 65cde7a2f2..30ff702943 100644
> --- a/test/py/tests/test_efi_secboot/conftest.py
> +++ b/test/py/tests/test_efi_secboot/conftest.py
> @@ -2,7 +2,7 @@
>  # Copyright (c) 2019, Linaro Limited
>  # Author: AKASHI Takahiro <takahiro.akashi at linaro.org>
>
> -""" Fixture for UEFI secure boot test """
> +"""Fixture for UEFI secure boot test."""
>
>  from subprocess import call, check_call, CalledProcessError
>  import pytest
> @@ -132,7 +132,9 @@ def efi_boot_env(request, u_boot_config):
>
>  @pytest.fixture(scope='session')
>  def efi_boot_env_intca(request, u_boot_config):
> -    """Set up a file system to be used in UEFI secure boot test
> +    """Set up file system for secure boot test.
> +
> +    Set up a file system to be used in UEFI secure boot test
>      of intermediate certificates.
>
>      Args:
> diff --git a/test/py/tests/test_efi_secboot/defs.py b/test/py/tests/test_efi_secboot/defs.py
> index b7a2a11851..6a2317e295 100644
> --- a/test/py/tests/test_efi_secboot/defs.py
> +++ b/test/py/tests/test_efi_secboot/defs.py
> @@ -1,5 +1,7 @@
>  # SPDX-License-Identifier:      GPL-2.0+
>
> +"""Constants used for secure boot test."""
> +
>  # Owner guid
>  GUID = '11111111-2222-3333-4444-123456789abc'
>
> --
> 2.39.2
>
Acked-by: Ilias Apalodimas <ilias.apalodimas at linaro.org>