Skip to content

Commit

Permalink
Issue #419 - refactor Runner.print_issue() to utils.issue_string_tuple()
Browse files Browse the repository at this point in the history
  • Loading branch information
@jantman
jantman committed Sep 5, 2019
1 parent 19d65d9 commit f3986e5
Show file tree
Hide file tree
Showing 4 changed files with 253 additions and 221 deletions.
47 changes: 4 additions & 43 deletions awslimitchecker/runner.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
import time

from .checker import AwsLimitChecker
from .utils import StoreKeyValuePair, dict2cols, color_output
from .utils import StoreKeyValuePair, dict2cols, issue_string_tuple
from .limit import SOURCE_TA, SOURCE_API
from .metrics import MetricsProvider
from .alerts import AlertProvider
Expand Down Expand Up @@ -312,47 +312,6 @@ def show_usage(self):
v=limits[svc][lim].get_current_usage_str())
print(dict2cols(data))

def print_issue(self, service_name, limit, crits, warns):
"""
Return a 2-tuple of key (service/limit name)/value (usage) strings
describing a limit that has crossed its threshold.
:param service_name: the name of the service
:type service_name: str
:param limit: the Limit this relates to
:type limit: :py:class:`~.AwsLimit`
:param crits: the specific usage values that crossed the critical
threshold
:type usage: :py:obj:`list` of :py:class:`~.AwsLimitUsage`
:param crits: the specific usage values that crossed the warning
threshold
:type usage: :py:obj:`list` of :py:class:`~.AwsLimitUsage`
:returns: 2-tuple of strings describing crossed thresholds,
first describing the service and limit name and second listing the
limit and usage
:rtype: tuple
"""
usage_str = ''
if len(crits) > 0:
tmp = 'CRITICAL: '
tmp += ', '.join([str(x) for x in sorted(crits)])
usage_str += color_output(tmp, 'red', colorize=self.colorize)
if len(warns) > 0:
if len(crits) > 0:
usage_str += ' '
tmp = 'WARNING: '
tmp += ', '.join([str(x) for x in sorted(warns)])
usage_str += color_output(tmp, 'yellow', colorize=self.colorize)
k = "{s}/{l}".format(
s=service_name,
l=limit.name,
)
v = "(limit {v}) {u}".format(
v=limit.get_limit(),
u=usage_str,
)
return k, v

def check_thresholds(self, metrics=None):
have_warn = False
have_crit = False
Expand Down Expand Up @@ -382,7 +341,9 @@ def check_thresholds(self, metrics=None):
have_crit = True
if len(warns) > 0:
have_warn = True
k, v = self.print_issue(svc, limit, crits, warns)
k, v = issue_string_tuple(
svc, limit, crits, warns, colorize=self.colorize
)
columns[k] = v
d2c = dict2cols(columns)
print(d2c)
Expand Down
218 changes: 41 additions & 177 deletions awslimitchecker/tests/test_runner.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -869,11 +869,12 @@ def test_many_problems(self):
}
mock_checker.get_limits.return_value = {}

def se_print(cls, s, l, c, w):
def se_print(s, l, c, w, colorize=True):
return ('{s}/{l}'.format(s=s, l=l.name), '')

self.cls.checker = mock_checker
with patch('awslimitchecker.runner.Runner.print_issue',
self.cls.colorize = False
with patch('%s.issue_string_tuple' % pb,
autospec=True) as mock_print:
mock_print.side_effect = se_print
with patch('awslimitchecker.runner.dict2cols') as mock_d2c:
Expand All @@ -883,10 +884,19 @@ def se_print(cls, s, l, c, w):
call.check_thresholds(use_ta=True, service=None)
]
assert mock_print.mock_calls == [
call(self.cls, 'svc1', mock_limit1, [mock_c1], [mock_w1]),
call(self.cls, 'svc1', mock_limit2, [], [mock_w2]),
call(self.cls, 'svc2', mock_limit3, [], [mock_w3]),
call(self.cls, 'svc2', mock_limit4, [mock_c2], []),
call(
'svc1', mock_limit1, [mock_c1], [mock_w1],
colorize=False
),
call(
'svc1', mock_limit2, [], [mock_w2], colorize=False
),
call(
'svc2', mock_limit3, [], [mock_w3], colorize=False
),
call(
'svc2', mock_limit4, [mock_c2], [], colorize=False
),
]
assert mock_d2c.mock_calls == [
call({
Expand Down Expand Up @@ -931,12 +941,12 @@ def test_when_skip_check(self):
}
mock_checker.get_limits.return_value = {}

def se_print(cls, s, l, c, w):
def se_print(s, l, c, w, colorize=True):
return ('{s}/{l}'.format(s=s, l=l.name), '')

self.cls.checker = mock_checker
self.cls.skip_check = ['svc1/limit1']
with patch('awslimitchecker.runner.Runner.print_issue',
with patch('%s.issue_string_tuple' % pb,
autospec=True) as mock_print:
mock_print.side_effect = se_print
with patch('awslimitchecker.runner.dict2cols') as mock_d2c:
Expand All @@ -947,7 +957,9 @@ def se_print(cls, s, l, c, w):
call.check_thresholds(use_ta=True, service=None)
]
assert mock_print.mock_calls == [
call(self.cls, 'svc1', mock_limit2, [], [mock_w2]),
call(
'svc1', mock_limit2, [], [mock_w2], colorize=True
),
]
assert mock_d2c.mock_calls == [
call({
Expand Down Expand Up @@ -986,7 +998,7 @@ def test_warn(self):
mock_checker.get_limits.return_value = {}

self.cls.checker = mock_checker
with patch('awslimitchecker.runner.Runner.print_issue',
with patch('%s.issue_string_tuple' % pb,
autospec=True) as mock_print:
mock_print.return_value = ('', '')
with patch('awslimitchecker.runner.dict2cols') as mock_d2c:
Expand All @@ -996,8 +1008,13 @@ def test_warn(self):
call.check_thresholds(use_ta=True, service=None)
]
assert mock_print.mock_calls == [
call(self.cls, 'svc1', mock_limit1, [], [mock_w1, mock_w2]),
call(self.cls, 'svc2', mock_limit2, [], [mock_w3]),
call(
'svc1', mock_limit1, [], [mock_w1, mock_w2],
colorize=True
),
call(
'svc2', mock_limit2, [], [mock_w3], colorize=True
),
]
assert res == (1, {
'svc2': {
Expand Down Expand Up @@ -1031,7 +1048,7 @@ def test_warn_one_service(self):

self.cls.checker = mock_checker
self.cls.service_name = ['svc2']
with patch('awslimitchecker.runner.Runner.print_issue',
with patch('%s.issue_string_tuple' % pb,
autospec=True) as mock_print:
mock_print.return_value = ('', '')
with patch('awslimitchecker.runner.dict2cols') as mock_d2c:
Expand All @@ -1041,7 +1058,9 @@ def test_warn_one_service(self):
call.check_thresholds(use_ta=True, service=['svc2'])
]
assert mock_print.mock_calls == [
call(self.cls, 'svc2', mock_limit2, [], [mock_w3]),
call(
'svc2', mock_limit2, [], [mock_w3], colorize=True
),
]
assert res == (1, {
'svc2': {
Expand All @@ -1067,7 +1086,7 @@ def test_crit(self):

self.cls.checker = mock_checker
self.cls.skip_ta = True
with patch('awslimitchecker.runner.Runner.print_issue',
with patch('%s.issue_string_tuple' % pb,
autospec=True) as mock_print:
mock_print.return_value = ('', '')
with patch('awslimitchecker.runner.dict2cols') as mock_d2c:
Expand All @@ -1077,7 +1096,10 @@ def test_crit(self):
call.check_thresholds(use_ta=False, service=None)
]
assert mock_print.mock_calls == [
call(self.cls, 'svc1', mock_limit1, [mock_c1, mock_c2], []),
call(
'svc1', mock_limit1, [mock_c1, mock_c2], [],
colorize=True
),
]
assert res == (2, {
'svc1': {
Expand All @@ -1086,166 +1108,6 @@ def test_crit(self):
}, ' \n')


class TestPrintIssue(RunnerTester):

def test_crit_one(self):
mock_limit = Mock(spec_set=AwsLimit)
type(mock_limit).name = 'limitname'
mock_limit.get_limit.return_value = 12

c1 = AwsLimitUsage(mock_limit, 56)

def se_color(s, c, colorize=True):
return 'xX%sXx' % s

with patch('%s.color_output' % pb) as m_co:
m_co.side_effect = se_color
res = self.cls.print_issue(
'svcname',
mock_limit,
[c1],
[]
)
assert res == ('svcname/limitname',
'(limit 12) xXCRITICAL: 56Xx')
assert m_co.mock_calls == [
call('CRITICAL: 56', 'red', colorize=True)
]

def test_crit_multi(self):
mock_limit = Mock(spec_set=AwsLimit)
type(mock_limit).name = 'limitname'
mock_limit.get_limit.return_value = 5

c1 = AwsLimitUsage(mock_limit, 10)
c2 = AwsLimitUsage(mock_limit, 12, resource_id='c2id')
c3 = AwsLimitUsage(mock_limit, 8)

def se_color(s, c, colorize=True):
return 'xX%sXx' % s

with patch('%s.color_output' % pb) as m_co:
m_co.side_effect = se_color
res = self.cls.print_issue(
'svcname',
mock_limit,
[c1, c2, c3],
[]
)
assert res == ('svcname/limitname',
'(limit 5) xXCRITICAL: 8, 10, c2id=12Xx')
assert m_co.mock_calls == [
call('CRITICAL: 8, 10, c2id=12', 'red', colorize=True)
]

def test_warn_one(self):
mock_limit = Mock(spec_set=AwsLimit)
type(mock_limit).name = 'limitname'
mock_limit.get_limit.return_value = 12

w1 = AwsLimitUsage(mock_limit, 11)

def se_color(s, c, colorize=True):
return 'xX%sXx' % s

with patch('%s.color_output' % pb) as m_co:
m_co.side_effect = se_color
res = self.cls.print_issue(
'svcname',
mock_limit,
[],
[w1]
)
assert res == ('svcname/limitname', '(limit 12) xXWARNING: 11Xx')
assert m_co.mock_calls == [
call('WARNING: 11', 'yellow', colorize=True)
]

def test_warn_multi(self):
mock_limit = Mock(spec_set=AwsLimit)
type(mock_limit).name = 'limitname'
mock_limit.get_limit.return_value = 12

w1 = AwsLimitUsage(mock_limit, 11)
w2 = AwsLimitUsage(mock_limit, 10, resource_id='w2id')
w3 = AwsLimitUsage(mock_limit, 10, resource_id='w3id')

def se_color(s, c, colorize=True):
return 'xX%sXx' % s

with patch('%s.color_output' % pb) as m_co:
m_co.side_effect = se_color
res = self.cls.print_issue(
'svcname',
mock_limit,
[],
[w1, w2, w3]
)
assert res == ('svcname/limitname',
'(limit 12) xXWARNING: w2id=10, w3id=10, 11Xx')
assert m_co.mock_calls == [
call('WARNING: w2id=10, w3id=10, 11', 'yellow', colorize=True)
]

def test_both_one(self):
self.cls.colorize = False
mock_limit = Mock(spec_set=AwsLimit)
type(mock_limit).name = 'limitname'
mock_limit.get_limit.return_value = 12

c1 = AwsLimitUsage(mock_limit, 10)
w1 = AwsLimitUsage(mock_limit, 10, resource_id='w3id')

def se_color(s, c, colorize=True):
return 'xX%sXx' % s

with patch('%s.color_output' % pb) as m_co:
m_co.side_effect = se_color
res = self.cls.print_issue(
'svcname',
mock_limit,
[c1],
[w1]
)
assert res == ('svcname/limitname',
'(limit 12) xXCRITICAL: 10Xx xXWARNING: w3id=10Xx')
assert m_co.mock_calls == [
call('CRITICAL: 10', 'red', colorize=False),
call('WARNING: w3id=10', 'yellow', colorize=False)
]

def test_both_multi(self):
mock_limit = Mock(spec_set=AwsLimit)
type(mock_limit).name = 'limitname'
mock_limit.get_limit.return_value = 12

c1 = AwsLimitUsage(mock_limit, 10)
c2 = AwsLimitUsage(mock_limit, 12, resource_id='c2id')
c3 = AwsLimitUsage(mock_limit, 8)
w1 = AwsLimitUsage(mock_limit, 11)
w2 = AwsLimitUsage(mock_limit, 10, resource_id='w2id')
w3 = AwsLimitUsage(mock_limit, 10, resource_id='w3id')

def se_color(s, c, colorize=True):
return 'xX%sXx' % s

with patch('%s.color_output' % pb) as m_co:
m_co.side_effect = se_color
res = self.cls.print_issue(
'svcname',
mock_limit,
[c1, c2, c3],
[w1, w2, w3]
)
assert res == ('svcname/limitname',
'(limit 12) xXCRITICAL: 8, 10, c2id=12Xx '
'xXWARNING: w2id=10, w3id=10, 11Xx')
assert m_co.mock_calls == [
call('CRITICAL: 8, 10, c2id=12', 'red', colorize=True),
call('WARNING: w2id=10, w3id=10, 11', 'yellow', colorize=True)
]


class TestConsoleEntryPoint(RunnerTester):

def test_version(self, capsys):
Expand Down Expand Up @@ -2059,7 +1921,9 @@ def test_no_color(self):
with patch('%s.Runner.check_thresholds' % pb,
autospec=True) as mock_ct:
mock_ct.return_value = 0, {}, 'foo'
with patch('%s.color_output' % pb) as m_co:
with patch(
'awslimitchecker.utils.color_output'
) as m_co:
m_co.return_value = 'COLORIZED'
with pytest.raises(SystemExit):
self.cls.console_entry_point()
Expand Down
Loading

0 comments on commit f3986e5

Please sign in to comment.