Requirements and Specification
System Requirements
lobster/tools/codebeamer/import_query.trlc
TRLC System_requirement codebeamer_req.Query_Id_Parameter
IF an element given through the yaml config file option "import_query" is a valid codebeamer query id, THEN the tool shall request items from the codebeamer server with the given query id AND write the obtained codebeamer items in the LOBSTER interchange format to the file given in the "out" parameter
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
TRLC System_requirement codebeamer_req.Query_String_Parameter
IF an element given through the yaml config file option "import_query" is valid codebeamer query string, THEN the tool shall request items from the codebeamer server with the given query string AND write the obtained codebeamer items in the LOBSTER interchange format to the file given in the "out" parameter
Issues:
missing reference to System Test
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
lobster/tools/codebeamer/requirements.trlc
TRLC System_requirement codebeamer_req.Empty_Query_String_Parameter
IF the configuration parameter "import_query" is empty, THEN the tool shall display an error message and exit with a non-zero return code.
Issues:
missing reference to System Test
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
TRLC System_requirement codebeamer_req.Empty_Query_Message
IF the codebeamer server returns an empty list as (a result of the query), THEN the tool shall display a message to the user.
Issues:
missing reference to System Test
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
TRLC System_requirement codebeamer_req.Retry_On_Specific_HTTPS_Status_Codes
IF the actual HTTPS return code is in the list specified by the configuration parameter "retry_error_codes" AND the configuration parameter "num_request_retry" is greater than 0 or not defined, THEN the tool shall retry the request up to a maximum of "num_request_retry" times (default is 5 if not set).
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
TRLC System_requirement codebeamer_req.Missing_Error_Code
IF the configuration parameter "retry_error_codes" is not defined, THEN the retry logic shall not be executed, regardless of the value of "num_request_retry".
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
TRLC System_requirement codebeamer_req.References_Field_Support
IF an element given through the yaml config file option "refs" is list of codebeamer field names, THEN the tool shall extract the corresponding references from the given codebeamer item fields AND add a Tracing_Tag entry to the LOBSTER item for each referenced item ID
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
Software Requirements
TRLC Software_requirement codebeamer_req.Get_Query_Zero_Items_Message
The function "get_query" shall print a message to the user IF the query returns zero items.
Issues:
missing reference to Software Test
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
Implementation
Code
lobster/tools/codebeamer/bearer_auth.py
Python Constructor bearer_auth.BearerAuth.__init__
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
Python Method bearer_auth.BearerAuth.__call__
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
lobster/tools/codebeamer/codebeamer.py
Python Method codebeamer.SupportedConfigKeys.as_set
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
Python Function codebeamer.get_authentication
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
Python Function codebeamer.query_cb_single
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
Python Function codebeamer.get_single_item
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
Python Function codebeamer.get_many_items
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
Python Function codebeamer.get_query
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
Python Function codebeamer.get_schema_config
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
Python Function codebeamer.to_lobster
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
Python Function codebeamer._create_common_params
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
Python Function codebeamer._create_lobster_item
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
Python Function codebeamer.import_tagged
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
Python Function codebeamer.ensure_list
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
Python Function codebeamer.update_authentication_parameters
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
Python Function codebeamer.parse_yaml_config
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
Python Function codebeamer.parse_config_data
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
Python Function codebeamer.main
Issues:
unknown tracing target req codebeamer_req.Dummy_Requirement
missing up reference
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
lobster/tools/codebeamer/config.py
Python Method config.Config.base
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
Verification and Validation
System Test
tests-system/lobster-codebeamer/lobster_codebeamer_test_runner.py
PyUnit Test lobster_codebeamer_test_runner.LobsterCodebeamerTestRunner.run_tool_test:80
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
tests-system/lobster-codebeamer/test_extract_requirements.py
PyUnit Test test_extract_requirements.LobsterCodebeamerExtractRequirementsTest.test_extract_requirements_scenarios:21
Issues:
unknown tracing target req UseCases.Incorrect_Number_of_Codebeamer_Items_in_Output
unknown tracing target req UseCases.Wrong_Codebeamer_IDs_in_Output
unknown tracing target req UseCases.Codebeamer_Summary_in_Output
missing up reference
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
tests-system/lobster-codebeamer/test_lobster_codebeamer.py
PyUnit Test test_lobster_codebeamer.LobsterCodebeamerTest.test_retry_if_configured:24
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
PyUnit Test test_lobster_codebeamer.LobsterCodebeamerTest.test_retry_then_success:45
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
PyUnit Test test_lobster_codebeamer.LobsterCodebeamerTest.test_no_retry_if_not_configured:95
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
tests-system/lobster-codebeamer/test_valid_flow.py
PyUnit Test test_valid_flow.LobsterCodebeamerTest.test_valid_query_id:23
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
PyUnit Test test_valid_flow.LobsterCodebeamerTest.test_references_tracing_tag_added:65
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
Software Test
tests-unit/lobster-codebeamer/test_authentication.py
PyUnit Test test_authentication.AuthenticationTest.test_get_bearer_auth:12
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
PyUnit Test test_authentication.AuthenticationTest.test_get_basic_auth:28
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
tests-unit/lobster-codebeamer/test_codebeamer.py
PyUnit Test test_codebeamer.QueryCodebeamerTest.test_get_query_with_ID:49
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
PyUnit Test test_codebeamer.QueryCodebeamerTest.test_get_query_with_query:85
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
PyUnit Test test_codebeamer.QueryCodebeamerTest.test_get_query_with_invalid_data:119
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
PyUnit Test test_codebeamer.QueryCodebeamerTest.test_get_single_item:131
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
PyUnit Test test_codebeamer.QueryCodebeamerTest.test_get_single_item_invalid_id:146
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
PyUnit Test test_codebeamer.QueryCodebeamerTest.test_get_many_items:153
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
PyUnit Test test_codebeamer.QueryCodebeamerTest.test_import_tagged:172
Issues:
unknown tracing target req codebeamer_req.Dummy_Requirement_Unit_Test
missing up reference
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
PyUnit Test test_codebeamer.ParseYamlTests.test_codebeamer_base:208
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
tests-unit/lobster-codebeamer/test_codebeamer_schema.py
PyUnit Test test_codebeamer_schema.CbConfigTest.test_main_missing_yaml_file:16
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
PyUnit Test test_codebeamer_schema.CbConfigTest.test_missing_config_field:31
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
PyUnit Test test_codebeamer_schema.CbConfigTest.test_unsupported_config_keys:41
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
PyUnit Test test_codebeamer_schema.CbConfigTest.test_cb_config_without_credentials_no_netrc:52
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
PyUnit Test test_codebeamer_schema.CbConfigTest.test_cb_config_with_token:73
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
PyUnit Test test_codebeamer_schema.CbConfigTest.test_cb_config_with_user_pass:90
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
PyUnit Test test_codebeamer_schema.CbConfigTest.test_cb_config_with_netrc:104
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
PyUnit Test test_codebeamer_schema.CbConfigTest.test_cb_config_with_netrc_and_sub_root:116
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00
PyUnit Test test_codebeamer_schema.CbConfigTest.test_cb_config_netrc_missing_machine_entry:128
Build Reference: 1083b4e668b60a00d05d8ab710726d39582d7caf | Timestamp: 2025-06-26 14:53:54+00:00