def test_ScanOverrides_get_formatted_overrides_success(get_endpoint_mock,
parse_webinspect_mock,
run_env_mock):
# Given
overrides = _setup_overrides()
# When
scan_overrides_object = ScanOverrides(overrides)
formatted_overrides_dict = scan_overrides_object.get_formatted_overrides()
# Expect
assert formatted_overrides_dict['webinspect_settings'] == 'Default'
assert formatted_overrides_dict['webinspect_scan_name'] is None
assert formatted_overrides_dict['webinspect_upload_settings'] is None
assert formatted_overrides_dict['webinspect_upload_policy'] is None
assert formatted_overrides_dict['webinspect_upload_webmacros'] is None
assert formatted_overrides_dict['webinspect_overrides_scan_mode'] is None
assert formatted_overrides_dict['webinspect_overrides_scan_scope'] is None
assert formatted_overrides_dict['webinspect_overrides_login_macro'] is None
assert formatted_overrides_dict['webinspect_overrides_scan_policy'] is None
assert formatted_overrides_dict['webinspect_overrides_scan_start'] is None
assert formatted_overrides_dict['webinspect_overrides_start_urls'] == []
assert formatted_overrides_dict['webinspect_scan_targets'] is None
assert formatted_overrides_dict['webinspect_workflow_macros'] == []
assert formatted_overrides_dict['webinspect_allowed_hosts'] == []
assert formatted_overrides_dict['webinspect_scan_size'] == 'large'
assert formatted_overrides_dict['fortify_user'] is None
def test_ScanOverrides_parse_upload_webmacros_overrides_success(get_endpoint_mock, parse_webinspect_mock, run_env_mock):
# Given
overrides = _setup_overrides()
# When
scan_overrides_object = ScanOverrides(overrides)
scan_overrides_object._parse_upload_webmacros_overrides()
# Expect
assert scan_overrides_object.webinspect_upload_webmacros is None
def test_ScanOverrides_parse_scan_name_overrides_cli_passed_scan_name_success(get_endpoint_mock, parse_webinspect_mock, run_env_mock):
# Given
overrides = _setup_overrides(expected_scan_name="Expected_Scan_Name")
# When
scan_overrides_object = ScanOverrides(overrides)
scan_overrides_object._parse_scan_name_overrides()
# Expect
assert scan_overrides_object.scan_name in ["Expected_Scan_Name"]
def test_ScanOverrides_parse_assigned_hosts_overrides_success(get_endpoint_mock, parse_webinspect_mock, run_env_mock):
# Given
overrides = _setup_overrides()
# When
scan_overrides_object = ScanOverrides(overrides)
scan_overrides_object._parse_assigned_hosts_overrides()
# Expect
assert scan_overrides_object.allowed_hosts == [] # nothing passed
def test_ScanOverrides_parse_scan_name_overrides_success(get_endpoint_mock, parse_webinspect_mock, run_env_mock):
# Given
overrides = _setup_overrides()
WebInspectLogHelper.log_error_scan_overrides_parsing_error = MagicMock()
# When
scan_overrides_object = ScanOverrides(overrides)
scan_overrides_object._parse_scan_name_overrides()
# Expect
assert scan_overrides_object.scan_name[0:11] in ['webinspect-'] # the randomly generated scan name
def test_ScanOverrides_parse_upload_setings_overrides_for_scan_target_success(
get_endpoint_mock, parse_webinspect_mock, run_env_mock):
# Given
overrides = _setup_overrides()
# When
scan_overrides_object = ScanOverrides(overrides)
scan_overrides_object._parse_upload_settings_overrides_for_scan_target()
# Expect
assert scan_overrides_object.targets is None
def test_ScanOverrides_parse_assigned_hosts_overrides_with_allowed_hosts_success(
get_endpoint_mock, parse_webinspect_mock, run_env_mock):
# Given
overrides = _setup_overrides(expected_allowed_hosts=["some.site.com"])
# When
scan_overrides_object = ScanOverrides(overrides)
scan_overrides_object._parse_assigned_hosts_overrides()
# Expect
assert scan_overrides_object.allowed_hosts == ["some.site.com"]
def test_ScanOverrides_trim_overrides_success(get_endpoint_mock, parse_webinspect_mock, run_env_mock, trim_mock):
# Trim ext is tested elsewhere so in this test all we really care about is that it is called 7 times.
# Given
overides = _setup_overrides()
scan_overrides_object = ScanOverrides(overides)
# When
scan_overrides_object._trim_overrides()
# Expect
assert trim_mock.call_count == 7
def test_ScanOverrides_parse_upload_settings_overrides_cli_passed_settings_success(
get_endpoint_mock, parse_webinspect_mock, run_env_mock, isfile_mock):
# Given
isfile_mock.return_value = False
overrides = _setup_overrides(expected_settings="NotDefault")
scan_overrides_object = ScanOverrides(overrides)
# When
scan_overrides_object._parse_upload_settings_overrides()
# Expect
assert scan_overrides_object.webinspect_upload_settings in '/path/to/git/settings/NotDefault.xml'
def test_ScanOverrides_parse_login_macro_overrides_cli_passed_loging_macro_success(
get_endpoint_mock, parse_webinspect_mock, run_env_mock):
# Given
overrides = _setup_overrides(expected_login_macro="macro.xml")
# When
scan_overrides_object = ScanOverrides(overrides)
scan_overrides_object._parse_login_macro_overrides()
# Expect
assert scan_overrides_object.login_macro is "macro.xml"
assert scan_overrides_object.webinspect_upload_webmacros == ["macro.xml"]
def test_ScanOverrides_parse_upload_settings_overrides_success(
get_endpoint_mock, parse_webinspect_mock, run_env_mock, isfile_mock):
# Given
isfile_mock.return_value = False
overrides = _setup_overrides()
scan_overrides_object = ScanOverrides(overrides)
# When
scan_overrides_object._parse_upload_settings_overrides()
# Expect
assert scan_overrides_object.webinspect_upload_settings is None
def test_ScanOverrides_parse_workflow_macros_overrides_cli_passed_workflow_macros_success(get_endpoint_mock,
parse_webinspect_mock,
run_env_mock):
# Given
overrides = _setup_overrides(expected_workflow_macro=("workflow_macro.xml",))
# When
scan_override_object = ScanOverrides(overrides)
scan_override_object._parse_workflow_macros_overrides()
# Expect
assert scan_override_object.workflow_macros == ["workflow_macro.xml"]
assert scan_override_object.webinspect_upload_webmacros == ["workflow_macro.xml"]
def test_ScanOverrides_parse_upload_settings_cli_passed_upload_settings_success(
get_endpoint_mock, parse_webinspect_mock, run_env_mock, isfile_mock):
# Given
overrides = _setup_overrides(
expected_upload_settings="/valid/path/NotDefault.xml")
scan_overrides_object = ScanOverrides(overrides)
# os.path.isfile is tricky have to mock it this way or there are odd side effects
isfile_mock.side_effect = [False, True]
# When
scan_overrides_object._parse_upload_settings_overrides()
# Expect
assert scan_overrides_object.webinspect_upload_settings == "/valid/path/NotDefault.xml"
def test_ScanOverrides_parse_scan_name_overrides_jenkins_job_BUILD_TAG_success(
get_endpoint_mock, parse_webinspect_mock, run_env_mock, getenv_mock):
# Given
run_env_mock.return_value = "jenkins"
# _parse_scan_name_overrides makes 2 calls to getevn, first one checks if there is a / in the return value and
# follows 2 different paths. We want to test both paths
getenv_mock.side_effect = ["/JOB_NAME/", "EXPECTED_BUILD_TAG"]
overrides = _setup_overrides()
# When
scan_overrides_object = ScanOverrides(overrides)
scan_overrides_object._parse_scan_name_overrides()
# Expect
assert scan_overrides_object.scan_name in ['EXPECTED_BUILD_TAG']
def test_ScanOverrides_parse_upload_setings_overrides_for_scan_target_cli_passed_upload_settings_success(get_endpoint_mock,
parse_webinspect_mock,
run_env_mock,
scan_targets_mock):
# Given
# mock this because we aren't testing this here.
scan_targets_mock.return_value = {"some.site.com", "some.other.site"}
overrides = _setup_overrides(expected_upload_settings="settings.xml")
# When
scan_overrides_object = ScanOverrides(overrides)
scan_overrides_object._parse_upload_settings_overrides_for_scan_target()
# Expect
assert scan_overrides_object.targets == {'some.other.site', 'some.site.com'}
def test_ScanOverrides_parse_upload_setings_overrides_for_scan_target_failure_NameError_exception(
get_endpoint_mock, parse_webinspect_mock, run_env_mock,
scan_targets_mock):
# Given
# a file that can't be found
overrides = _setup_overrides(expected_upload_settings="settings.xml")
scan_targets_mock.side_effect = NameError
WebInspectLogHelper.log_no_settings_file = MagicMock()
# When
scan_overrides_object = ScanOverrides(overrides)
with pytest.raises(SystemExit):
scan_overrides_object._parse_upload_settings_overrides_for_scan_target(
)
# Expect
assert WebInspectLogHelper.log_no_settings_file.call_count == 1
def test_ScanOverrides_init_failure_type_error_exception(get_endpoint_mock, parse_webinspect_mock, run_env_mock):
# I'm not 100% where this is raised, but I can't be certain nothing doesn't call it so going to be a bit hacky
# and just call it somewhere to make sure it is properly handled with a sys.exit and a log call.
# Given
# mock function calls within init so we can focus the test
parse_webinspect_mock.side_effect = TypeError
WebInspectLogHelper.log_error_scan_overrides_parsing_error = MagicMock()
overrides = _setup_overrides()
# When
with pytest.raises(SystemExit):
ScanOverrides(overrides)
assert WebInspectLogHelper.log_error_scan_overrides_parsing_error.call_count == 1
def test_ScanOverrides_parse_webinspect_overrides_success(trim_mock, scan_name_mock, upload_settings_mock,
login_macro_mock, workflow_macro_mock, upload_webmacro_mock,
upload_policy_mock, upload_settings_scan_target_mock,
assigned_hosts_mock, get_endpoint_mock, check_run_env_mock):
# Given
# can't use setup_mocks sadly - can't mock parse_webinspect_options
overrides = _setup_overrides()
# When
ScanOverrides(overrides) # this will call _parse_webinspect_overrides
# Expect
assert trim_mock.call_count == 1
assert scan_name_mock.call_count == 1
assert upload_settings_mock.call_count == 1
assert login_macro_mock.call_count == 1
assert workflow_macro_mock.call_count == 1
assert upload_webmacro_mock.call_count == 1
assert upload_policy_mock.call_count == 1
assert upload_settings_scan_target_mock.call_count == 1
assert assigned_hosts_mock.call_count == 1
def test_ScanOverrides_init_success(get_endpoint_mock, parse_webinspect_mock,
run_env_mock):
# Given
# mock function calls within init so we can focus the test.
get_endpoint_mock.return_value = "webinspect_url"
run_env_mock.return_value = "expected_run_env"
overrides = _setup_overrides()
# When
scan_override_object = ScanOverrides(overrides)
# Expect
assert scan_override_object.webinspect_dir == '/path/to/git'
assert scan_override_object.username is None
assert scan_override_object.password is None
assert scan_override_object.settings is 'Default'
assert scan_override_object.scan_name is None
assert scan_override_object.webinspect_upload_settings is None
assert scan_override_object.webinspect_upload_policy is None
assert scan_override_object.webinspect_upload_webmacros is None
assert scan_override_object.scan_mode is None
assert scan_override_object.scan_scope is None
assert scan_override_object.login_macro is None
assert scan_override_object.scan_policy is None
assert scan_override_object.scan_start is None
assert scan_override_object.scan_size == 'large'
assert scan_override_object.fortify_user is None
assert scan_override_object.allowed_hosts == [
] # is converted from a tuple
assert scan_override_object.start_urls == [] # converted form tuple
assert scan_override_object.workflow_macros == [] # converted from tuple
assert scan_override_object.endpoint == "webinspect_url"
assert scan_override_object.runenv == "expected_run_env"