URL: https://github.com/SSSD/sssd/pull/5914
Author: spoore1
 Title: #5914: Tests: add docstring in intg/test_infopipe.py
Action: synchronized

To pull the PR as Git branch:
git remote add ghsssd https://github.com/SSSD/sssd
git fetch ghsssd pull/5914/head:pr5914
git checkout pr5914
From f83986ad77c0ea42a44059c3cf0bf6609d37ba27 Mon Sep 17 00:00:00 2001
From: Scott Poore <spo...@redhat.com>
Date: Thu, 9 Dec 2021 11:42:42 -0600
Subject: [PATCH] Tests: add docstring in intg/test_infopipe.py

Adding docstring to test_find_by_valid_certificate to define some
metadata for tracking the test case.

Minimal content needed is:
- """<test_function_name_next_to_opening_docstring_quotes>
- <blank line after opening quotes>
- :id: <generated UUID>
- :title: SSSD-TC: <Feature or functional area>: <Title of test>
- :casecompoent: sssd
- :subsystemteam: sst_idm_sssd

The id and title will differ per tests going forward but, the last two
are defaults needed.

The opening quotes line needs to include the test function or method
name so that the UUID used for the id is associated with function name
within the docstring.  The blank line is also needed after to indicate
the start of the parameters list.

Command used to generate UUID:
python3 -c 'import uuid; print(uuid.uuid4())'

Tests: #5224
---
 src/tests/intg/test_infopipe.py | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/src/tests/intg/test_infopipe.py b/src/tests/intg/test_infopipe.py
index d493a94514..71e3cb8393 100644
--- a/src/tests/intg/test_infopipe.py
+++ b/src/tests/intg/test_infopipe.py
@@ -718,6 +718,13 @@ def test_update_member_list_and_get_all(dbus_system_bus,
 def test_find_by_valid_certificate(dbus_system_bus,
                                    ldap_conn,
                                    add_user_with_cert):
+    """test_find_by_valid_certificate
+
+    :id: 3f212e6e-00ce-44ac-95d4-59925cb5a14a
+    :title: SSSD-TC: Infopipe: Find by valid certificate
+    :casecomponent: sssd
+    :subsystemteam: sst_idm_sssd
+    """
     users_obj = dbus_system_bus.get_object(
         'org.freedesktop.sssd.infopipe',
         '/org/freedesktop/sssd/infopipe/Users')
_______________________________________________
sssd-devel mailing list -- sssd-devel@lists.fedorahosted.org
To unsubscribe send an email to sssd-devel-le...@lists.fedorahosted.org
Fedora Code of Conduct: 
https://docs.fedoraproject.org/en-US/project/code-of-conduct/
List Guidelines: https://fedoraproject.org/wiki/Mailing_list_guidelines
List Archives: 
https://lists.fedorahosted.org/archives/list/sssd-devel@lists.fedorahosted.org
Do not reply to spam on the list, report it: 
https://pagure.io/fedora-infrastructure

Reply via email to