FOGL-7699 Add a pytest fixture in conftest.py which collects support bundle of fledge by Mohit04tomar · Pull Request #1059 · fledge-iot/fledge

Mohit04tomar · 2023-04-27T10:16:37Z

No description provided.

Signed-off-by: Mohit Singh Tomar <M.singh19994@gmail.com>

… and save it at PROJECT_ROOT directory Signed-off-by: Mohit Singh Tomar <M.singh19994@gmail.com>

Mohit04tomar · 2023-04-27T14:33:59Z

I have ran this Jenkins Job with changes --> http://jenkins.dianomic.com:8080/view/PI%20stuff/job/fledge_packages_pi_web_api/517/

Signed-off-by: Mohit Singh Tomar <M.singh19994@gmail.com>

Mohit04tomar · 2023-04-28T13:43:39Z

This is the latest job build of this PR --> http://jenkins.dianomic.com:8080/view/PI%20stuff/job/fledge_packages_pi_web_api/519/

YashTatkondawar · 2023-04-28T14:20:22Z

tests/system/python/conftest.py

+            conn = http.client.HTTPConnection("{}".format(url))
+            conn.request("POST", "/fledge/support")
+            r = conn.getresponse()
+            assert 200 == r.status
+            r = r.read().decode()
+            jdoc = json.loads(r)


def post_request from utils.py can be used instead of this.

for that I have to import utils into conftest file

that is good, we should use utils def

YashTatkondawar · 2023-04-28T14:25:21Z

tests/system/python/conftest.py

+            r = r.read().decode()
+            jdoc = json.loads(r)
+            assert jdoc["bundle created"]
+            subprocess.run(["mkdir -p {0}/support/ && cp -r {1} {0}/support/.".format(PROJECT_ROOT, jdoc["bundle created"])], shell=True, check=True)


In case of package based system tests, what will be the PROJECT_ROOT? Are support bundles stored in PROJECT_ROOT path?
What is the value for jdoc["bundle created"] ?

PROJECT_ROOT is the directory that contains the tests to be executed.
Support Bundle store in PROJECT_ROOT/support/ directory and jdoc["bundle created"] is FLEDGE_ROOT/data/support/support_bundle.tar.gz

praveen-garg · 2023-05-01T14:29:18Z

tests/system/python/conftest.py

+@pytest.fixture(scope="function", autouse=True)
+def collect_support_bundle(request):
+    def _collect_support_bundle():
+        PROJECT_ROOT = subprocess.getoutput("git rev-parse --show-toplevel")


Let's keep the old way, We can fix it later at all places with other PR

praveen-garg · 2023-05-01T14:29:57Z

tests/system/python/conftest.py

+            conn = http.client.HTTPConnection("{}".format(url))
+            conn.request("POST", "/fledge/support")
+            r = conn.getresponse()
+            assert 200 == r.status
+            r = r.read().decode()
+            jdoc = json.loads(r)


that is good, we should use utils def

praveen-garg · 2023-05-01T15:19:34Z

tests/system/python/conftest.py

+            if OS_NAME == 'Ubuntu':
+                LOG_FILE = "/var/log/syslog"
+            elif OS_NAME == 'CentOS Stream':
+                LOG_FILE = "/var/log/messages"  


We have PKG_MGR to identify platform

praveen-garg · 2023-05-01T15:20:31Z

tests/system/python/conftest.py

+                LOG_FILE = "/var/log/syslog"
+            elif OS_NAME == 'CentOS Stream':
+                LOG_FILE = "/var/log/messages"  
+            subprocess.run(["mkdir -p {0}/support/ && cp {1} {0}/support/syslog_{2}".format(PROJECT_ROOT, LOG_FILE, time.strftime("%Y_%m_%d_%H_%M_%S"))], shell=True, check=True)  


let's put {0}/support/syslog_{2} in save_to to copy_to variable to keep this statement short

praveen-garg · 2023-05-01T15:21:23Z

tests/system/python/conftest.py

+            subprocess.run(["mkdir -p {0}/support/ && cp {1} {0}/support/syslog_{2}".format(PROJECT_ROOT, LOG_FILE, time.strftime("%Y_%m_%d_%H_%M_%S"))], shell=True, check=True)  
+
+    url = request.config.getoption("--fledge-url")
+    request.addfinalizer(_collect_support_bundle)


why do we need this?

We need addfinalizer() function to execute this fixture at end of each test functions.

I think we need only at end of test module not each function.

This requirement arises due to the common practice in system tests, where each test function resets the fledge before testing starts. This reset purges older data, regardless of whether the test passes or not. Consequently, the status of the fledge at that specific time remains unknown to us.

praveen-garg · 2023-05-01T15:21:52Z

tests/system/python/conftest.py

+                LOG_FILE = "/var/log/messages"  
+            subprocess.run(["mkdir -p {0}/support/ && cp {1} {0}/support/syslog_{2}".format(PROJECT_ROOT, LOG_FILE, time.strftime("%Y_%m_%d_%H_%M_%S"))], shell=True, check=True)  
+
+    url = request.config.getoption("--fledge-url")


use fledge_url def for that

I tried fledge_url def but that was not working, So I have used this request.config.getoption("--fledge-url")

We should be able to use another fixture as arg collect_support_bundle(request, fledge_url):

Signed-off-by: Mohit Singh Tomar <M.singh19994@gmail.com>

Mohit04tomar · 2023-05-02T11:39:54Z

The Jenkins job run on latest commit --> http://jenkins.dianomic.com:8080/view/PI%20stuff/job/fledge_packages_pi_web_api/521/

tests/system/python/conftest.py

praveen-garg · 2023-05-04T06:16:48Z

tests/system/python/conftest.py

+            subprocess.run(["mkdir -p {0}/support/ && cp {1} {0}/support/syslog_{2}".format(PROJECT_ROOT, LOG_FILE, time.strftime("%Y_%m_%d_%H_%M_%S"))], shell=True, check=True)  
+
+    url = request.config.getoption("--fledge-url")
+    request.addfinalizer(_collect_support_bundle)


I think we need only at end of test module not each function.

praveen-garg · 2023-05-04T06:18:37Z

tests/system/python/conftest.py

+                LOG_FILE = "/var/log/messages"  
+            subprocess.run(["mkdir -p {0}/support/ && cp {1} {0}/support/syslog_{2}".format(PROJECT_ROOT, LOG_FILE, time.strftime("%Y_%m_%d_%H_%M_%S"))], shell=True, check=True)  
+
+    url = request.config.getoption("--fledge-url")


We should be able to use another fixture as arg collect_support_bundle(request, fledge_url):

praveen-garg · 2023-05-04T06:22:41Z

tests/system/python/conftest.py

+            copy_to = "mkdir -p {0}/support/ && cp -r {1} {0}/support".format(PROJECT_ROOT, jdoc['bundle created'])
+            subprocess.run(["{}/.".format(copy_to)], shell=True, check=True)


copy_to_cmd = "mkdir -p {0}/support/ && cp -r {1} {0}/support/.".format(PROJECT_ROOT, jdoc['bundle created']) subprocess.run([copy_to_cmd], shell=True, check=True)

praveen-garg · 2023-05-04T06:26:10Z

tests/system/python/conftest.py

+            copy_to = "mkdir -p {0}/support/ && cp -r {1} {0}/support".format(PROJECT_ROOT, LOG_FILE)
+            subprocess.run(["{0}/syslog_{1}".format(copy_to, time.strftime("%Y_%m_%d_%H_%M_%S"))], shell=True, check=True)  


ts = time.strftime("%Y_%m_%d_%H_%M_%S") copy_to_cmd = "mkdir -p {0}/support/logs/ && cp {1} {0}/support/logs/syslog_{1}".format(PROJECT_ROOT, log_file, ts) subprocess.run([copy_to_cmd], shell=True, check=True)

tests/system/python/conftest.py

Signed-off-by: Mohit Singh Tomar <M.singh19994@gmail.com>

ashish-jabble · 2023-08-08T06:14:08Z

tests/system/python/conftest.py

    return _disable_sch


+@pytest.fixture(scope="function", autouse=True)


You typically use autouse fixtures when you want to use them for setup/teardown only.

Yes, I have used an autouse fixture with a function-limited scope. This ensures that it is executed at the end of every test function/case in any system test, allowing it to collect a support bundle before executing next test function/case.

ashish-jabble · 2023-08-08T06:18:38Z

tests/system/python/conftest.py

+@pytest.fixture(scope="function", autouse=True)
+def collect_support_bundle(request, fledge_url):
+    def _collect_support_bundle():
+        PROJECT_ROOT = Path(__file__).absolute().parent.parent.parent.parent


This is wrong practice. We should avoid this and maybe use Pathlib which is a native Python library for handling files and paths and also provides a making code more readable and maintainable.

We are currently utilizing the Pathlib library, given that the Path() function is associated with this library. As an alternative approach, we could use the "git rev-parse --show-toplevel" command to pinpoint the precise path of the PROJECT_ROOT. However, I will explore more optimal methods to determine this path.

Try this code snippet to get PROJECT_ROOT

import pathlib PROJECT_NAME="tests" PROJECT_ROOT = str(pathlib.Path().resolve()).split(PROJECT_NAME)[0] print(PROJECT_ROOT)

tests/system/python/conftest.py

ashish-jabble · 2023-08-08T06:25:53Z

tests/system/python/conftest.py

+            log_file = "/var/log/syslog"
+            if pytest.PKG_MGR == 'yum':
+                log_file = "/var/log/messages"  
+            ts = time.strftime("%Y_%m_%d_%H_%M_%S")
+            copy_to_cmd = "mkdir -p {0}/support/logs/ && cp {1} {0}/support/logs/syslog_{2}".format(PROJECT_ROOT, log_file, ts)


IN case of exception we should only get the Fledge related logs. Not the full dump from path.

ok, I'll update the code to only get logs related to Fledge.

tests/system/python/conftest.py

Signed-off-by: Mohit Singh Tomar <M.singh19994@gmail.com>

Mohit04tomar · 2023-09-01T09:49:37Z

Below are the jobs that I run on latest commit(3c12c2e):

ashish-jabble · 2023-12-19T13:57:01Z

tests/system/python/conftest.py

+            print("Copying syslog")
+            log_file = "/var/log/syslog"
+            if pytest.PKG_MGR == 'yum':
+                log_file = "/var/log/messages"  
+            ts = time.strftime("%Y_%m_%d_%H_%M_%S")
+            copy_to_cmd = f"mkdir -p {PROJECT_ROOT}/support/logs/ && grep -i 'fledge' {log_file} > {PROJECT_ROOT}/support/logs/syslog_{ts}"
+            subprocess.run([copy_to_cmd], shell=True, check=True)  


Fixture should have flexibility to collect support bundle even in success case as well.

ashish-jabble · 2025-09-25T06:51:33Z

@Mohit04tomar Is there anything remaining for this PR, or is it outdated and can be closed?

ashish-jabble · 2025-11-14T13:53:25Z

@Mohit04tomar Is there anything remaining for this PR, or is it outdated and can be closed?

Any updates?

Mohit04tomar added 2 commits April 26, 2023 19:08

Added Fixture for collecting Support Bundle

703142a

Signed-off-by: Mohit Singh Tomar <M.singh19994@gmail.com>

Fixed code to generate support bundle

1e933b1

Signed-off-by: Mohit Singh Tomar <M.singh19994@gmail.com>

Mohit04tomar requested review from YashTatkondawar and praveen-garg April 27, 2023 10:16

Mohit04tomar and others added 2 commits April 27, 2023 17:26

Added code for collecting support bundle at end of evry test function…

9ffc533

… and save it at PROJECT_ROOT directory Signed-off-by: Mohit Singh Tomar <M.singh19994@gmail.com>

Merge branch 'develop' into FOGL-7699

432ff12

Mohit04tomar and others added 2 commits April 28, 2023 18:23

Added code to handle failure of fledge when it is down

548d2bf

Signed-off-by: Mohit Singh Tomar <M.singh19994@gmail.com>

Merge branch 'develop' into FOGL-7699

ca2a784

YashTatkondawar reviewed Apr 28, 2023

View reviewed changes

praveen-garg requested changes May 1, 2023

View reviewed changes

Mohit04tomar and others added 2 commits May 2, 2023 15:31

Feedback chnages

486cefb

Signed-off-by: Mohit Singh Tomar <M.singh19994@gmail.com>

Merge branch 'develop' into FOGL-7699

5acbc86

Merge branch 'develop' into FOGL-7699

61be221

praveen-garg reviewed May 4, 2023

View reviewed changes

Feedback changes

420d4dc

Signed-off-by: Mohit Singh Tomar <M.singh19994@gmail.com>

Mohit04tomar requested a review from praveen-garg May 5, 2023 10:27

Mohit04tomar added 2 commits May 8, 2023 14:53

Merge branch 'develop' into FOGL-7699

bf0e187

Merge branch 'develop' into FOGL-7699

cfd1cd3

ashish-jabble reviewed Aug 8, 2023

View reviewed changes

tests/system/python/conftest.py Outdated Show resolved Hide resolved

ashish-jabble reviewed Aug 8, 2023

View reviewed changes

tests/system/python/conftest.py Outdated Show resolved Hide resolved

Merge branch 'develop' into FOGL-7699

ff08c28

Mohit04tomar requested a review from ashish-jabble August 9, 2023 12:29

Mohit04tomar and others added 2 commits August 9, 2023 18:26

Feedback changes

eda71b8

Signed-off-by: Mohit Singh Tomar <M.singh19994@gmail.com>

Merge branch 'develop' into FOGL-7699

db66585

Merge branch 'develop' into FOGL-7699

3c12c2e

ashish-jabble reviewed Dec 19, 2023

View reviewed changes

Merge branch 'develop' into FOGL-7699

b04a5b1

		copy_to = "mkdir -p {0}/support/ && cp -r {1} {0}/support".format(PROJECT_ROOT, jdoc['bundle created'])
		subprocess.run(["{}/.".format(copy_to)], shell=True, check=True)

		copy_to = "mkdir -p {0}/support/ && cp -r {1} {0}/support".format(PROJECT_ROOT, LOG_FILE)
		subprocess.run(["{0}/syslog_{1}".format(copy_to, time.strftime("%Y_%m_%d_%H_%M_%S"))], shell=True, check=True)

		return _disable_sch


		@pytest.fixture(scope="function", autouse=True)

Conversation

Mohit04tomar commented Apr 27, 2023

Uh oh!

Mohit04tomar commented Apr 27, 2023

Uh oh!

Mohit04tomar commented Apr 28, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Mohit04tomar commented May 2, 2023

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Mohit04tomar commented Sep 1, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ashish-jabble commented Sep 25, 2025

Uh oh!

ashish-jabble commented Nov 14, 2025

Uh oh!

Reviewers

Assignees

Labels

Mohit04tomar commented Sep 1, 2023 •

edited

Loading