def test_check__unknown(mocker):
"""
Test "check" method must return human readable statuses and exit code
(unknown case).
:param mocker: mock
:type mocker: MockerFixture
"""
expected = "UNKNOWN: 'example-unknown' not found in server response, 'example': OK"
data = [
{
"description": "pid 666, uptime 0 days, 0:00:00",
"pid": 666,
"stderr_logfile": "",
"stop": 0,
"logfile": "/var/log/example.log",
"exitstatus": 0,
"spawnerr": "",
"now": 0,
"group": "example",
"name": "example",
"statename": "RUNNING",
"start": 0,
"state": 20,
"stdout_logfile": "/var/log/example.log",
},
{
"description": "pid 666, uptime 0 days, 0:00:00",
"pid": 666,
"stderr_logfile": "",
"stop": 0,
"logfile": "/var/log/example.log",
"exitstatus": 0,
"spawnerr": "",
"now": 0,
"group": "example-unknown",
"name": "example-unknown",
"statename": "UNKNOWN",
"start": 0,
"state": 1000,
"stdout_logfile": "/var/log/example.log",
},
]
mocker.patch("sys.argv",
["check_supervisord.py", "-s", "127.0.0.1", "-p", "9001"])
mocker.patch(
"{name}._Method.__call__".format(**{"name": xmlrpclib.__name__}),
return_value=data,
)
checker = CheckSupervisord()
result, code = checker.check()
assert result.strip() == expected # nosec: B101
assert code == 3 # nosec: B101
def test__get_output__critical(mocker):
"""
Test "_get_status" method must return human readable statuses (critical case).
:param mocker: mock
:type mocker: MockerFixture
"""
expected = "CRITICAL: problem with 'example-critical': (FATAL), 'example': OK"
data = [
{
"description": "pid 666, uptime 0 days, 0:00:00",
"pid": 666,
"stderr_logfile": "",
"stop": 0,
"logfile": "/var/log/example.log",
"exitstatus": 0,
"spawnerr": "",
"now": 0,
"group": "example",
"name": "example",
"statename": "RUNNING",
"start": 0,
"state": 20,
"stdout_logfile": "/var/log/example.log",
},
{
"description": "pid 666, uptime 0 days, 0:00:00",
"pid": 666,
"stderr_logfile": "",
"stop": 0,
"logfile": "/var/log/example.log",
"exitstatus": 0,
"spawnerr": "",
"now": 0,
"group": "example-critical",
"name": "example-critical",
"statename": "FATAL",
"start": 0,
"state": 200,
"stdout_logfile": "/var/log/example.log",
},
]
mocker.patch("sys.argv",
["check_supervisord.py", "-s", "127.0.0.1", "-p", "9001"])
checker = CheckSupervisord()
status = checker._get_status(data=data)
result = checker._get_output(
data=data,
status=status,
)
assert result.strip() == expected # nosec: B101
def test__get_output__unknown(mocker):
"""
Test "_get_status" method must return human readable statuses (unknown case).
:param mocker: mock
:type mocker: MockerFixture
"""
expected = "UNKNOWN: 'example-unknown' not found in server response, 'example': OK"
data = [
{
"description": "pid 666, uptime 0 days, 0:00:00",
"pid": 666,
"stderr_logfile": "",
"stop": 0,
"logfile": "/var/log/example.log",
"exitstatus": 0,
"spawnerr": "",
"now": 0,
"group": "example",
"name": "example",
"statename": "RUNNING",
"start": 0,
"state": 20,
"stdout_logfile": "/var/log/example.log",
},
{
"description": "pid 666, uptime 0 days, 0:00:00",
"pid": 666,
"stderr_logfile": "",
"stop": 0,
"logfile": "/var/log/example.log",
"exitstatus": 0,
"spawnerr": "",
"now": 0,
"group": "example-unknown",
"name": "example-unknown",
"statename": "UNKNOWN",
"start": 0,
"state": 1000,
"stdout_logfile": "/var/log/example.log",
},
]
mocker.patch("sys.argv",
["check_supervisord.py", "-s", "127.0.0.1", "-p", "9001"])
checker = CheckSupervisord()
status = checker._get_status(data=data)
result = checker._get_output(
data=data,
status=status,
)
assert result.strip() == expected # nosec: B101
def test__get_status__warning__exited(mocker):
"""
Test "_get_status" method must return main check status (warning case)
(exited state).
:param mocker: mock
:type mocker: MockerFixture
"""
mocker.patch("sys.argv",
["check_supervisord.py", "-s", "127.0.0.1", "-p", "9001"])
checker = CheckSupervisord()
result = checker._get_status(data=[
{
"description": "pid 666, uptime 0 days, 0:00:00",
"pid": 666,
"stderr_logfile": "",
"stop": 0,
"logfile": "/var/log/example.log",
"exitstatus": 0,
"spawnerr": "",
"now": 0,
"group": "example",
"name": "example",
"statename": "RUNNING",
"start": 0,
"state": 20,
"stdout_logfile": "/var/log/example.log",
},
{
"description": "pid 666, uptime 0 days, 0:00:00",
"pid": 666,
"stderr_logfile": "",
"stop": 0,
"logfile": "/var/log/example.log",
"exitstatus": 0,
"spawnerr": "",
"now": 0,
"group": "example-warning",
"name": "example-warning",
"statename": "EXITED",
"start": 0,
"state": 100,
"stdout_logfile": "/var/log/example.log",
},
])
assert result == "warning" # nosec: B101
def test__get_data(mocker):
"""
Test "_get_data" method must return data from server.
:param mocker: mock
:type mocker: MockerFixture
"""
info = [{
"description": "pid 666, uptime 0 days, 0:00:00",
"pid": 666,
"stderr_logfile": "",
"stop": 0,
"logfile": "/var/log/example.log",
"exitstatus": 0,
"spawnerr": "",
"now": 0,
"group": "example",
"name": "example",
"statename": "RUNNING",
"start": 0,
"state": 20,
"stdout_logfile": "/var/log/example.log",
}]
mocker.patch("sys.argv",
["check_supervisord.py", "-s", "127.0.0.1", "-p", "9001"])
mocker.patch(
"{name}._Method.__call__".format(**{"name": xmlrpclib.__name__}),
return_value=info,
)
result = CheckSupervisord()._get_data()
assert result == info # nosec: B101
def test__get_connection__http_auth(mocker):
"""
Test "_get_connection" method must return http connection with authorization.
:param mocker: mock
:type mocker: MockerFixture
"""
mocker.patch(
"sys.argv",
[
"check_supervisord.py",
"-s",
"127.0.0.1",
"-p",
"9001",
"-u",
"supervisord",
"-S",
"password",
],
)
result = CheckSupervisord()._get_connection()
assert isinstance(result, xmlrpclib.ServerProxy) # nosec: B101
def test__get_connection__socket_auth(mocker):
"""
Test "_get_connection" method must return socket connection with authorization.
:param mocker: mock
:type mocker: MockerFixture
"""
with tempfile.NamedTemporaryFile() as sock:
mocker.patch(
"sys.argv",
[
"check_supervisord.py",
"-s",
sock.name,
"-u",
"supervisord",
"-S",
"password",
],
)
mocker.patch("stat.S_ISSOCK", return_value=True)
result = CheckSupervisord()._get_connection()
assert isinstance(result, xmlrpclib.ServerProxy) # nosec: B101
def test__get_connection_uri__http(mocker):
"""
Test "_get_connection_uri" method must return connection string for http.
:param mocker: mock
:type mocker: MockerFixture
"""
mocker.patch(
"sys.argv",
["check_supervisord.py", "-s", "127.0.0.1", "-p", "9001"],
)
checker = CheckSupervisord()
assert ( # nosec: B101
checker._get_connection_uri(
tpl=checker.URI_TPL_HTTP) == "http://127.0.0.1:9001")
def test__get_connection_uri__socket(mocker):
"""
Test "_get_connection_uri" method must return connection string for socket.
:param mocker: mock
:type mocker: MockerFixture
"""
mocker.patch(
"sys.argv",
["check_supervisord.py", "-s", "/tmp/supervisord.sock"], # nosec: B108
)
checker = CheckSupervisord()
assert ( # nosec: B101
checker._get_connection_uri(
tpl=checker.URI_TPL_SOCKET) == "unix:///tmp/supervisord.sock")
def test__get_output__unknown__no_data(mocker):
"""
Test "_get_status" method must return human readable statuses (unknown case)
(no data).
:param mocker: mock
:type mocker: MockerFixture
"""
expected = "UNKNOWN: No program configured/found"
data = []
mocker.patch("sys.argv",
["check_supervisord.py", "-s", "127.0.0.1", "-p", "9001"])
checker = CheckSupervisord()
status = checker._get_status(data=data)
result = checker._get_output(
data=data,
status=status,
)
assert result.strip() == expected # nosec: B101
def test__get_options(mocker):
"""
Test "_get_options" method must return argparse namespace.
:param mocker: mock
:type mocker: MockerFixture
"""
mocker.patch("sys.argv",
["check_supervisord.py", "-s", "127.0.0.1", "-p", "9001"])
checker = CheckSupervisord()
assert isinstance(checker.options, Namespace) # nosec: B101
def test_check__unknown__no_data(mocker):
"""
Test "check" method must return human readable statuses and exit code (unknown case)
(no data).
:param mocker: mock
:type mocker: MockerFixture
"""
expected = "UNKNOWN: No program configured/found"
data = []
mocker.patch("sys.argv",
["check_supervisord.py", "-s", "127.0.0.1", "-p", "9001"])
mocker.patch(
"{name}._Method.__call__".format(**{"name": xmlrpclib.__name__}),
return_value=data,
)
checker = CheckSupervisord()
result, code = checker.check()
assert result.strip() == expected # nosec: B101
assert code == 3 # nosec: B101
def test__get_code(mocker):
"""
Test "_get_code" method must return plugin exit code.
:param mocker: mock
:type mocker: MockerFixture
"""
mocker.patch("sys.argv",
["check_supervisord.py", "-s", "127.0.0.1", "-p", "9001"])
result = CheckSupervisord()._get_code(status="ok")
assert result == 0 # nosec: B101
def test__get_data__network_error(mocker):
"""
Test "_get_data" method must exit with server error.
:param mocker: mock
:type mocker: MockerFixture
"""
out = StringIO()
mocker.patch("sys.argv",
["check_supervisord.py", "-s", "127.0.0.1", "-p", "9001"])
mocker.patch(
"{name}._Method.__call__".format(**{"name": xmlrpclib.__name__}),
side_effect=OSError,
)
checker = CheckSupervisord()
with pytest.raises(SystemExit) as excinfo:
with contextlib2.redirect_stdout(out):
checker._get_data()
assert ( # nosec: B101
"ERROR: Server communication problem" in out.getvalue().strip())
assert excinfo.value.args == (3, ) # nosec: B101
def test__get_options__missing_server_option(mocker):
"""
Test "_get_options" method must exit with server option missing error.
:param mocker: mock
:type mocker: MockerFixture
"""
out = StringIO()
mocker.patch("sys.argv", ["check_supervisord.py"])
with pytest.raises(SystemExit):
with contextlib2.redirect_stderr(out):
CheckSupervisord()
assert ( # nosec: B101
"Required server address option missing" in out.getvalue().strip())
def test__get_connection__unix_support_not_available(mocker, capsys):
"""
Test "_get_connection" method must exit with
couldn't load supervisord library error.
:param mocker: mock
:type mocker: MockerFixture
:param capsys: std capture
:type capsys: CaptureFixture
"""
with tempfile.NamedTemporaryFile() as sock:
mocker.patch(
"sys.argv",
["check_supervisord.py", "-s", sock.name],
)
mocker.patch.dict("sys.modules", {"supervisor": None})
mocker.patch("stat.S_ISSOCK", return_value=True)
with pytest.raises(SystemExit):
CheckSupervisord()._get_connection()
assert ( # nosec: B101
"ERROR: Couldn't load module." in capsys.readouterr().out.strip())