Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

FOGL-7699 Add a pytest fixture in conftest.py which collects support bundle of fledge #1059

Open
wants to merge 17 commits into
base: develop
Choose a base branch
from
Open

FOGL-7699 Add a pytest fixture in conftest.py which collects support bundle of fledge #1059

Changes from 9 commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
703142a
Added Fixture for collecting Support Bundle
Mohit04tomar Apr 26, 2023
1e933b1
Fixed code to generate support bundle
Mohit04tomar Apr 27, 2023
9ffc533
Added code for collecting support bundle at end of evry test function…
Mohit04tomar Apr 27, 2023
432ff12
Merge branch 'develop' into FOGL-7699
Mohit04tomar Apr 27, 2023
548d2bf
Added code to handle failure of fledge when it is down
Mohit04tomar Apr 28, 2023
ca2a784
Merge branch 'develop' into FOGL-7699
Mohit04tomar Apr 28, 2023
486cefb
Feedback chnages
Mohit04tomar May 2, 2023
5acbc86
Merge branch 'develop' into FOGL-7699
Mohit04tomar May 2, 2023
61be221
Merge branch 'develop' into FOGL-7699
Mohit04tomar May 4, 2023
420d4dc
Feedback changes
Mohit04tomar May 4, 2023
bf0e187
Merge branch 'develop' into FOGL-7699
Mohit04tomar May 8, 2023
cfd1cd3
Merge branch 'develop' into FOGL-7699
Mohit04tomar May 9, 2023
ff08c28
Merge branch 'develop' into FOGL-7699
Mohit04tomar Aug 9, 2023
eda71b8
Feedback changes
Mohit04tomar Aug 9, 2023
db66585
Merge branch 'develop' into FOGL-7699
Mohit04tomar Aug 16, 2023
3c12c2e
Merge branch 'develop' into FOGL-7699
Mohit04tomar Aug 30, 2023
b04a5b1
Merge branch 'develop' into FOGL-7699
Mohit04tomar Dec 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 26 additions & 1 deletion tests/system/python/conftest.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@
from urllib.parse import quote
from pathlib import Path
import pytest
import time
from helpers import utils

__author__ = "Vaibhav Singhal"
__copyright__ = "Copyright (c) 2019 Dianomic Systems"
Expand Down Expand Up @@ -668,6 +670,30 @@ def _disable_sch(fledge_url, sch_name):
return _disable_sch


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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

def collect_support_bundle(request):
def _collect_support_bundle():
PROJECT_ROOT = Path(__file__).absolute().parent.parent.parent.parent
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)


try:
jdoc = utils.post_request(url, "/fledge/support", None)
assert jdoc["bundle created"]
ashish-jabble marked this conversation as resolved.
Show resolved Hide resolved
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 link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

   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)

except Exception as e:
print("\n Failed to get Support Bundle from Fledge REST API due to {}".format(str(e)))
ashish-jabble marked this conversation as resolved.
Show resolved Hide resolved
print("Copying syslog")
if pytest.PKG_MGR == 'yum':
LOG_FILE = "/var/log/messages"
else:
LOG_FILE = "/var/log/syslog"
ashish-jabble marked this conversation as resolved.
Show resolved Hide resolved
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)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

 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)


url = request.config.getoption("--fledge-url")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use fledge_url def for that

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

request.addfinalizer(_collect_support_bundle)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why do we need this?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.



def pytest_addoption(parser):
parser.addoption("--storage-plugin", action="store", default="sqlite",
help="Database plugin to use for tests")
Expand Down Expand Up @@ -918,7 +944,6 @@ def asset_name(request):
def fledge_url(request):
return request.config.getoption("--fledge-url")


@pytest.fixture
def wait_time(request):
return request.config.getoption("--wait-time")
Expand Down