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

Jump to bottom

feat(test): Adding betelgeuse docstrings to test_collection.py #274

Merged
merged 1 commit into from
Sep 19, 2024
+215 −34
Merged

feat(test): Adding betelgeuse docstrings to test_collection.py #274

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
249 changes: 215 additions & 34 deletions integration-tests/test_collection.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
"""
:casecomponent: insights-client
:requirement: RHSS-291297
:subsystemteam: sst_csi_client_tools
:caseautomation: Automated
:upstream: Yes
"""

import contextlib
import os
import tarfile
Expand All @@ -7,13 +15,31 @@
import conftest
import uuid


ARCHIVE_CACHE_DIRECTORY = "/var/cache/insights-client"


def test_output_file_valid_parameters(insights_client, tmp_path):
"""Test --output-file (with valid parameters)
Test --output-file option pointing to:
- a non-existing file (so a new one should be created properly)
"""
:id: 011e38c7-c6dc-4c17-add4-d67f0775f5cd
:title: Test --output-file with valid parameters
:description:
This test verifies that the --output-file option correctly
creates a new archive file when provided with a valid path
:tier: Tier 1
:steps:
1. Define the archive name path
2. Run insights-client in an offline mode with --output-file
pointing to the archive name
3. Verify that a new archive file is created
4. Verify that the command output confirms the collected
data was copied to the new archive
:expectedresults:
1. The archive name path is set correctly
2. The insights-client runs successfully with the specified output file path
3. A new archive file are created at the specified location
4. The command output confirms that the collected data was copied to the new
archive
"""
archive_name = tmp_path / "archive"

Expand All @@ -24,9 +50,27 @@ def test_output_file_valid_parameters(insights_client, tmp_path):


def test_output_file_non_existing_path(insights_client):
"""Test --output-file (with invalid parameters)
Test --output-file option pointing to:
- not existing path (parent directory doesn't exist)
"""
:id: 003faa12-8daa-417b-83bb-71aaa80209b6
:title: Test --output-file with non-existing path
:description:
Checks that the --output-file option fails with an appropriate error
message when provided with a non-existent path
:tier: Tier 1
:steps:
1. Define an archive file path in a non-existing directory
and define the parent directory path
2. Run insights-client with the --output-file option pointing
to an non-existing path
3. Verify that the command output fails with a return code of 1
4. Verify that the error message indicates the parent directory
does not exist
:expectedresults:
1. The archive path is set to a non-existent directory
and the parent directory path is correctly derived
2. The insights-client runs with the specified output file path
3. The command returns code of 1
4. The error message contains the expected message
"""
archive_location = "/not-existing-dir/archive_file.tar.gz"
parent_dir = os.path.dirname(archive_location)
Expand All @@ -39,15 +83,45 @@ def test_output_file_non_existing_path(insights_client):


def test_output_dir_without_specifying_a_path(insights_client):
"""Test --output-dir (without specifying path)"""
"""
:id: 63eb1ba0-b9dd-4185-b422-18325c12b503
:title: Test --output-dir without specifying a path
:description:
Verifies that the --output-dir option fails with an appropriate
error message when no path is specified
:tier: Tier 1
:steps:
1. Run insights-client with an empty --output-file option
2. Verify that the command fails with a return code of 1
3. Verify that the error message indicates that --output-file cannot be empty
:expectedresults:
1. The insights-client runs with an empty option
2. The command fails with a return code of 1
3. The error message is as expected
"""
cmd_result = insights_client.run("--output-file=", check=False)
assert cmd_result.returncode == 1
assert "ERROR: --output-file cannot be empty" in cmd_result.stderr


def test_output_specifying_both_dir_and_file(insights_client, tmp_path):
"""Test both --output-file and --output-dir (with valid parameters) at once.
This should fail with error message suggesting to specify only one at a time.
"""
:id: a572654d-904c-410e-ba00-f7b63f910e53
:title: Test --output-file specifying both directory and file
:description:
Verifies that specifying both output file and output directory
option together fails with an appropriate error message
:tier: Tier 1
:steps:
1. Define both output file and directory paths
2. Run insights-client with --output-file and --output-dir
3. Verify the command fails with an error code of 1
4. Verify the error message says they can't be used together
:expectedresults:
1. the output file and directory paths are set correctly
2. The insights-client runs with specified options
3. The command fails with a return code of 1
4. The error message is as expected
"""
# Parent directory does not exist
output_file = tmp_path / "output_file.tar.gz"
Expand All @@ -60,9 +134,25 @@ def test_output_specifying_both_dir_and_file(insights_client, tmp_path):


def test_output_file_with_relative_path(insights_client):
"""Test --output-file (with relative path)
Test --output-file option pointing to:
- relative path (so test will indicate path is already a directory)
"""
:id: e1236f11-46c3-452c-81b8-3c61506e1841
:title: Test --output-file with relative path
:description:
Verifies that using a relative path that points to a directory
with the --output-file option fails with an appropriate error message
:tier: Tier 1
:steps:
1. Define a relative path pointing to a directory
2. Run insights-client with the --output file option poining to
this relative path
3. Verify that the command fails with a return code of 1
4. Verify the error message says that --output
cannot be used with a directory
:expectedresults:
1. The relative path is correctly
2. The insights-client runs with the specified option
3. The command fails with an exit code of 1
4. The error message is as expected
"""
relative_path = os.path.realpath("")
cmd_result = insights_client.run(f"--output-file={relative_path}", check=False)
Expand All @@ -71,10 +161,23 @@ def test_output_file_with_relative_path(insights_client):


def test_output_dir_with_not_empty_directory(insights_client):
"""Test --output-dir (with not empty directory)
Test --output-dir option pointing to:
- execution path (just to indicate a not empty dir, so test will indicate
that dir already exists and is not empty)
"""
:id: 30384d37-92b4-4196-8423-0355b0cbef30
:title: Test --output-dir with non-empty directory
:description:
Verify that when the --output-dir option is used with an existing
non-empty directory, the command fails with an appropriate error message
:tier: Tier 1
:steps:
1. Define a path to an existing non-empty directory
2. Run insights-client with --output-dir option specified
3. Verify the command fails with a return code of 1
4. Verify the error message is as expected
:expectedresults:
1. The path to the non-empty directory is set correctly
3. The insights-client is run
4. The command fails with a return code of 1
5. The error message is as expected
"""
relative_path = os.path.realpath("")
cmd_result = insights_client.run(f"--output-dir={relative_path}", check=False)
Expand All @@ -86,10 +189,25 @@ def test_output_dir_with_not_empty_directory(insights_client):


def test_output_dir_creates_archive_for_directory(insights_client, tmp_path):
"""Test --output-file (indicating a directory, not a file)
Test --output-file option pointing to:
- existing directory (archive named should be generated combining
the name of directory+'.tar.gz')
"""
:id: 6a966179-3b61-4a74-8af4-68fa0c2c237e
:title: Test --output-file creates archive for directory
:description:
Checks that when the --output-file option is used with a path
that is an existing directory, the insights-client correctly generates
an archive with the directory name appended with .tar.gz
:tier: Tier 1
:steps:
1. Define a directory path
2. Run insights-client with the --output-file option pointing to that directory
3. Verify that the command creates an archive file with the directory name
and extension
4. Clean up by removing the generated archive file
:expectedresults:
1. The directory is set correctly
2. The insights-client runs with the specified dir path
3. An archive file with the directory name is created
4. The generated archive file is successfully removed
"""
directory = "/tmp/directory/"
try:
Expand All @@ -100,9 +218,24 @@ def test_output_dir_creates_archive_for_directory(insights_client, tmp_path):


def test_output_file_already_exists(insights_client, tmp_path):
"""Test --output-file (already existing archive)
Test --output-file option pointing to:
- already existing archive
"""
:id: 36456352-da31-4633-872a-061c2045176a
:title: Test --output-file already exists
:description:
Verify that when the --output-file option is used with a path
that points to an existing archive file, the command fails with an
appropriate error message
:tier: Tier 1
:steps:
1. Create an archive file at a specified location
2. Run insights-client with the --output-file option to this existing archive
3. Verify the command fails with a return code of 1
4. Verify that the error message indicates that the file already exists
:expectedresults:
1. The archive file is created at the specified location
2. The insights-client is run with the specified output file path
3. The command fails with a return code of 1
4. The error message indicates that the file already exists
"""
# File should already exist
output_file = tmp_path / "output_file.tar.gz"
Expand All @@ -118,10 +251,25 @@ def test_output_file_already_exists(insights_client, tmp_path):
@pytest.mark.usefixtures("register_subman")
def test_cmd_timeout(insights_client):
"""
Test cmd_timeout config option
Client executes all commands with timeout. If the command doesn't finish within
a specified amount of seconds, it is killed.
Test that setting a custom amount of seconds to cmd_timeout config option works.
:id: 0a55318c-28e0-4ca7-bdbf-3eb8c0d689ea
:title: Test cmd_timeout configuration
:description:
Verify that the cmd_timeout configuration correctly limits the
execution time of commands, killing them if they exceed said limit
:tier: Tier 2
:steps:
1. Register insights-client
2. Set the cmd_timeout option to 10 seconds
3. Run insights-client with a command that would take longer than the
the timeout limit
4. Verify the command is terminated after 10 seconds
5. Verify that the output includes the expected message
:expectedresults:
1. The insights-client is registered
2. The cmd_timeout option is set to 10 seconds
3. The command is run with the specified timeout
4. The command is terminated after 10 seconds
5. The output contains "Executing: [['timeout', '-s', '9', '10'"
"""
cmd_output_message = "Executing: [['timeout', '-s', '9', '10'"

Expand All @@ -138,12 +286,26 @@ def test_cmd_timeout(insights_client):
@pytest.mark.usefixtures("register_subman")
def test_branch_info(insights_client, test_config, subman):
"""
Test that branch_info includes all required information
branch_info is used to identify the host when it is connected via Satellite.
It uses branch_id and leaf_id to identify.
Ref:
https://docs.google.com/document/d/193mN5aBwxtzpP4U-vnL3yVawPxiG20n0zkzDYsam-eU/edit
:id: 22c7063c-e09d-4fdf-80ea-864a7027d2ee
:title: Test branch_info file includes all required information
:description:
Verify that the branch_info file generated by the insights-client
contains all necessary information for identifying the host when connected
via Satellite
:reference:
https://docs.google.com/document/d/193mN5aBwxtzpP4U-vnL3yVawPxiG20n0zkzDYsam-eU/edit
:tier: Tier 2
:steps:
1. Register insights-client
2. Run insights-client with the --no-upload option to generate the
branch_info file
3. Extract the latest archive
4. Inspect the branch_info file to verify it contains correct values
:expectedresults:
1. The insights-client is registered
2. The branch_info file is generated
3. The latest archive is successfully extracted
4. The branch_info includes correct values
"""
insights_client.register()
assert conftest.loop_until(lambda: insights_client.is_registered)
Expand Down Expand Up @@ -172,7 +334,26 @@ def test_branch_info(insights_client, test_config, subman):
@pytest.mark.usefixtures("register_subman")
def test_archive_structure(insights_client):
"""
Test that the archive have the correct structure
:id: 7a78cf8f-ed32-4011-8d15-787231f867c9
:title: Test archive structure
:description:
Verify that the generated archive from insights-client has the
correct directory structure and contains all the necessary directories
and subdirectories
:tier: Tier 1
:steps:
1. Register insights-client
2. Run insights-client with --no-upload
3. Extract the latest archive
4. Verify that all required directories are present in the archive
5. Verify that all required subdirectories are present under the
data directory
:expectedresults:
1. Insights-client is registered
2. The archive is generated
3. The latest archive is extracted
4. All required directories are present
5. All required subdirectories are present
"""
dirs_list = [
"blacklist_report",
Expand Down
Loading