def test_verbose(self): cb = CallbackBase() result = {'item': 'some_item LEFTIN', '_ansible_verbose_always': 'chicane'} json_out = cb._dump_results(result) self.assertFalse('SENTINEL' in json_out) self.assertTrue('LEFTIN' in json_out)
def test_difflist(self): # TODO: split into smaller tests? cb = CallbackBase() difflist = [{'before': ['preface\nThe Before String\npostscript'], 'after': ['preface\nThe After String\npostscript'], 'before_header': 'just before', 'after_header': 'just after' }, {'before': ['preface\nThe Before String\npostscript'], 'after': ['preface\nThe After String\npostscript'], }, {'src_binary': 'chicane'}, {'dst_binary': 'chicanery'}, {'dst_larger': 1}, {'src_larger': 2}, {'prepared': 'what does prepared do?'}, {'before_header': 'just before'}, {'after_header': 'just after'}] res = cb._get_diff(difflist) self.assertIn('Before String', res) self.assertIn('After String', res) self.assertIn('just before', res) self.assertIn('just after', res)
def test_exception(self): cb = CallbackBase() result = {'item': 'some_item LEFTIN', 'exception': ['frame1', 'SENTINEL']} json_out = cb._dump_results(result) self.assertFalse('SENTINEL' in json_out) self.assertFalse('exception' in json_out) self.assertTrue('LEFTIN' in json_out)
def test_get_item_no_log(self): cb = CallbackBase() results = {'item': 'some_item', '_ansible_no_log': True} res = cb._get_item(results) self.assertEquals(res, "(censored due to no_log)") results = {'item': 'some_item', '_ansible_no_log': False} res = cb._get_item(results) self.assertEquals(res, "some_item")
def test_no_log(self): cb = CallbackBase() result = {'item': 'some_item', '_ansible_no_log': True, 'some_secrets': 'SENTINEL'} json_out = cb._dump_results(result) self.assertFalse('SENTINEL' in json_out) self.assertTrue('no_log' in json_out) self.assertTrue('output has been hidden' in json_out)
def test_clean_results(self): cb = CallbackBase() result = {'item': 'some_item', 'invocation': 'foo --bar whatever [some_json]', 'changed': True} self.assertTrue('changed' in result) self.assertTrue('invocation' in result) cb._clean_results(result, 'debug')
def test_exception(self): cb = CallbackBase() result = { 'item': 'some_item LEFTIN', 'exception': ['frame1', 'SENTINEL'] } json_out = cb._dump_results(result) assert 'SENTINEL' not in json_out assert 'exception' not in json_out assert 'LEFTIN' in json_out
def test_mixed_keys(self): cb = CallbackBase() result = {3: 'pi', 'tau': 6} json_out = cb._dump_results(result) round_trip_result = json.loads(json_out) assert len(round_trip_result) == 2 assert '3' in round_trip_result assert 'tau' in round_trip_result assert round_trip_result['3'] == 'pi' assert round_trip_result['tau'] == 6
def test_diff(self): cb = CallbackBase() result = { 'item': 'some_item LEFTIN', 'diff': ['remove stuff', 'added LEFTIN'], '_ansible_verbose_always': 'chicane' } json_out = cb._dump_results(result) assert 'SENTINEL' not in json_out assert 'LEFTIN' in json_out
def test_clean_results(self): cb = CallbackBase() result = {'item': 'some_item', 'invocation': 'foo --bar whatever [some_json]', 'a': 'a single a in result note letter a is in invocation', 'b': 'a single b in result note letter b is not in invocation', 'changed': True} expected_result = result.copy() cb._clean_results(result, 'ebug') self.assertEqual(result, expected_result)
def test_clean_results(self): cb = CallbackBase() result = {'item': 'some_item', 'invocation': 'foo --bar whatever [some_json]', 'changed': True} self.assertTrue('changed' in result) self.assertTrue('invocation' in result) cb._clean_results(result, 'debug') self.assertFalse('changed' in result) self.assertFalse('invocation' in result)
class TestCopyResultExclude(unittest.TestCase): def setUp(self): class DummyClass(): def __init__(self): self.bar = [1, 2, 3] self.a = { "b": 2, "c": 3, } self.b = { "c": 3, "d": 4, } self.foo = DummyClass() self.cb = CallbackBase() def tearDown(self): pass def test_copy_logic(self): res = self.cb._copy_result_exclude(self.foo, ()) self.assertEqual(self.foo.bar, res.bar) def test_copy_deep(self): res = self.cb._copy_result_exclude(self.foo, ()) self.assertNotEqual(id(self.foo.bar), id(res.bar)) def test_no_exclude(self): res = self.cb._copy_result_exclude(self.foo, ()) self.assertEqual(self.foo.bar, res.bar) self.assertEqual(self.foo.a, res.a) self.assertEqual(self.foo.b, res.b) def test_exclude(self): res = self.cb._copy_result_exclude(self.foo, ['bar', 'b']) self.assertIsNone(res.bar) self.assertIsNone(res.b) self.assertEqual(self.foo.a, res.a) def test_result_unmodified(self): bar_id = id(self.foo.bar) a_id = id(self.foo.a) res = self.cb._copy_result_exclude(self.foo, ['bar', 'a']) self.assertEqual(self.foo.bar, [1, 2, 3]) self.assertEqual(bar_id, id(self.foo.bar)) self.assertEqual(self.foo.a, dict(b=2, c=3)) self.assertEqual(a_id, id(self.foo.a)) self.assertRaises(AttributeError, self.cb._copy_result_exclude, self.foo, ['a', 'c', 'bar'])
def test_clean_results_debug_task_no_invocation(self): cb = CallbackBase() result = {'item': 'some_item', 'a': 'a single a in result note letter a is in invocation', 'b': 'a single b in result note letter b is not in invocation', 'changed': True} cb._clean_results(result, 'debug') self.assertTrue('a' in result) self.assertTrue('b' in result) self.assertFalse('changed' in result) self.assertFalse('invocation' in result)
def test_internal_keys(self): cb = CallbackBase() result = {'item': 'some_item', '_ansible_some_var': 'SENTINEL', 'testing_ansible_out': 'should_be_left_in LEFTIN', 'invocation': 'foo --bar whatever [some_json]', 'some_dict_key': {'a_sub_dict_for_key': 'baz'}, 'bad_dict_key': {'_ansible_internal_blah': 'SENTINEL'}, 'changed': True} json_out = cb._dump_results(result) self.assertFalse('"_ansible_' in json_out) self.assertFalse('SENTINEL' in json_out) self.assertTrue('LEFTIN' in json_out)
def test_clean_results_debug_task(self): cb = CallbackBase() result = {'item': 'some_item', 'invocation': 'foo --bar whatever [some_json]', 'a': 'a single a in result note letter a is in invocation', 'b': 'a single b in result note letter b is not in invocation', 'changed': True} cb._clean_results(result, 'debug') # See https://github.com/ansible/ansible/issues/33723 self.assertTrue('a' in result) self.assertTrue('b' in result) self.assertFalse('invocation' in result) self.assertFalse('changed' in result)
def setUp(self): class DummyClass(): def __init__(self): self.bar = [1, 2, 3] self.a = { "b": 2, "c": 3, } self.b = { "c": 3, "d": 4, } self.foo = DummyClass() self.cb = CallbackBase()
def __init__(self, *args, **kwargs): self.num_tasks = 0 self.cur_task_no = 0 self.results = [] super().__init__(*args, **kwargs) parent_class = CallbackBase() parent_methods = [ attr for attr in dir(parent_class) if type(getattr(parent_class, attr)).__name__ == 'method' and attr != '__init__' ] for fn in parent_methods: def delegate(self, *args, fn=fn, **kwargs): warn('-' * 80) warn('delegate: {}({}, {})'.format(fn, args, kwargs)) for arg in args: warn(' arg: ', arg, type(arg), dir(type(arg))) for k in kwargs.keys(): warn(" kwarg: {{ '{}': {} }}".format(k, kwargs[k])) warn('') exists = getattr(self.__class__, fn) # TODO Hook up 'exists' to log sink if exists and exists.__module__ == sys.modules[__name__].__name__: setattr(self.__class__, fn, exists) else: if environ.get('DEBUG', False): setattr(self.__class__, fn, delegate)
class TestCopyResultExclude(unittest.TestCase): def setUp(self): class DummyClass: def __init__(self): self.bar = [1, 2, 3] self.a = {"b": 2, "c": 3} self.b = {"c": 3, "d": 4} self.foo = DummyClass() self.cb = CallbackBase() def tearDown(self): pass def test_copy_logic(self): res = self.cb._copy_result_exclude(self.foo, ()) self.assertEqual(self.foo.bar, res.bar) def test_copy_deep(self): res = self.cb._copy_result_exclude(self.foo, ()) self.assertNotEqual(id(self.foo.bar), id(res.bar)) def test_no_exclude(self): res = self.cb._copy_result_exclude(self.foo, ()) self.assertEqual(self.foo.bar, res.bar) self.assertEqual(self.foo.a, res.a) self.assertEqual(self.foo.b, res.b) def test_exclude(self): res = self.cb._copy_result_exclude(self.foo, ["bar", "b"]) self.assertIsNone(res.bar) self.assertIsNone(res.b) self.assertEqual(self.foo.a, res.a) def test_result_unmodified(self): bar_id = id(self.foo.bar) a_id = id(self.foo.a) res = self.cb._copy_result_exclude(self.foo, ["bar", "a"]) self.assertEqual(self.foo.bar, [1, 2, 3]) self.assertEqual(bar_id, id(self.foo.bar)) self.assertEqual(self.foo.a, dict(b=2, c=3)) self.assertEqual(a_id, id(self.foo.a)) self.assertRaises(AttributeError, self.cb._copy_result_exclude, self.foo, ["a", "c", "bar"])
def run(self, tmp=None, task_vars=None): self._task.diff = True self._result = super(ActionModule, self).run(tmp, task_vars) self._check_argspec() self._set_vars() diff_dict = {'before': self._before, 'after': self._after} diff_text = CallbackBase()._get_diff(diff_dict) ansi_escape = re.compile(r'\x1B[@-_][0-?]*[ -/]*[@-~]') diff_text = ansi_escape.sub('', diff_text) self._result.update({ 'diff': diff_dict, 'changed': self._before != self._after, 'diff_lines': diff_text.splitlines() }) return self._result
def test_host_label_delegated(self): result = TaskResult( host=Host('host1'), task=None, return_data={'_ansible_delegated_vars': { 'ansible_host': 'host2' }}, ) self.assertEquals(CallbackBase.host_label(result), 'host1 -> host2')
def setUp(self): class DummyClass: def __init__(self): self.bar = [1, 2, 3] self.a = {"b": 2, "c": 3} self.b = {"c": 3, "d": 4} self.foo = DummyClass() self.cb = CallbackBase()
def run(self, tmp=None, task_vars=None): self._task.diff = True self._result = super(ActionModule, self).run(tmp, task_vars) self._check_argspec() self._set_vars() self._dotme() diff_dict = {"before": self._before, "after": self._after} diff_text = CallbackBase()._get_diff(diff_dict) ansi_escape = re.compile(r"\x1B[@-_][0-?]*[ -/]*[@-~]") diff_text = ansi_escape.sub("", diff_text) self._result.update({ "diff": diff_dict, "changed": self._before != self._after, "diff_lines": diff_text.splitlines(), }) return self._result
def __init__(self, pb_callout=None, logger=None): self.logger = logger self.stats = { 'task_state': { 'success': 0, 'failed': 0, 'skipped': 0, 'unreachable': 0 }, 'failures': {}, 'successes': {}, 'task_name': '' } self.done = 0 self.pb_callout = pb_callout CallbackBase.__init__(self)
def diff(self): self._after = self._task_args["after"] self._before = self._task_args["before"] self._errors = [] self._skip_lines = self._task_args["plugin"]["vars"].get("skip_lines") self._check_valid_regexes() if self._errors: return {"errors": " ".join(self._errors)} self._xform() diff = CallbackBase()._get_diff({ "before": self._before, "after": self._after }) return {"diff": diff}
class TestCallbackDiff(unittest.TestCase): def setUp(self): self.cb = CallbackBase() def _strip_color(self, s): return re.sub('\033\\[[^m]*m', '', s) def test_difflist(self): # TODO: split into smaller tests? difflist = [{'before': ['preface\nThe Before String\npostscript'], 'after': ['preface\nThe After String\npostscript'], 'before_header': 'just before', 'after_header': 'just after' }, {'before': ['preface\nThe Before String\npostscript'], 'after': ['preface\nThe After String\npostscript'], }, {'src_binary': 'chicane'}, {'dst_binary': 'chicanery'}, {'dst_larger': 1}, {'src_larger': 2}, {'prepared': 'what does prepared do?'}, {'before_header': 'just before'}, {'after_header': 'just after'}] res = self.cb._get_diff(difflist) self.assertIn('Before String', res) self.assertIn('After String', res) self.assertIn('just before', res) self.assertIn('just after', res) def test_simple_diff(self): self.assertMultiLineEqual( self._strip_color(self.cb._get_diff({ 'before_header': 'somefile.txt', 'after_header': 'generated from template somefile.j2', 'before': 'one\ntwo\nthree\n', 'after': 'one\nthree\nfour\n', })), textwrap.dedent('''\ --- before: somefile.txt +++ after: generated from template somefile.j2 @@ -1,3 +1,3 @@ one -two three +four ''')) def test_new_file(self): self.assertMultiLineEqual( self._strip_color(self.cb._get_diff({ 'before_header': 'somefile.txt', 'after_header': 'generated from template somefile.j2', 'before': '', 'after': 'one\ntwo\nthree\n', })), textwrap.dedent('''\ --- before: somefile.txt +++ after: generated from template somefile.j2 @@ -0,0 +1,3 @@ +one +two +three ''')) def test_clear_file(self): self.assertMultiLineEqual( self._strip_color(self.cb._get_diff({ 'before_header': 'somefile.txt', 'after_header': 'generated from template somefile.j2', 'before': 'one\ntwo\nthree\n', 'after': '', })), textwrap.dedent('''\ --- before: somefile.txt +++ after: generated from template somefile.j2 @@ -1,3 +0,0 @@ -one -two -three ''')) def test_no_trailing_newline_before(self): self.assertMultiLineEqual( self._strip_color(self.cb._get_diff({ 'before_header': 'somefile.txt', 'after_header': 'generated from template somefile.j2', 'before': 'one\ntwo\nthree', 'after': 'one\ntwo\nthree\n', })), textwrap.dedent('''\ --- before: somefile.txt +++ after: generated from template somefile.j2 @@ -1,3 +1,3 @@ one two -three \\ No newline at end of file +three ''')) def test_no_trailing_newline_after(self): self.assertMultiLineEqual( self._strip_color(self.cb._get_diff({ 'before_header': 'somefile.txt', 'after_header': 'generated from template somefile.j2', 'before': 'one\ntwo\nthree\n', 'after': 'one\ntwo\nthree', })), textwrap.dedent('''\ --- before: somefile.txt +++ after: generated from template somefile.j2 @@ -1,3 +1,3 @@ one two -three +three \\ No newline at end of file ''')) def test_no_trailing_newline_both(self): self.assertMultiLineEqual( self.cb._get_diff({ 'before_header': 'somefile.txt', 'after_header': 'generated from template somefile.j2', 'before': 'one\ntwo\nthree', 'after': 'one\ntwo\nthree', }), '') def test_no_trailing_newline_both_with_some_changes(self): self.assertMultiLineEqual( self._strip_color(self.cb._get_diff({ 'before_header': 'somefile.txt', 'after_header': 'generated from template somefile.j2', 'before': 'one\ntwo\nthree', 'after': 'one\nfive\nthree', })), textwrap.dedent('''\ --- before: somefile.txt +++ after: generated from template somefile.j2 @@ -1,3 +1,3 @@ one -two +five three \\ No newline at end of file ''')) def test_diff_dicts(self): self.assertMultiLineEqual( self._strip_color(self.cb._get_diff({ 'before': dict(one=1, two=2, three=3), 'after': dict(one=1, three=3, four=4), })), textwrap.dedent('''\ --- before +++ after @@ -1,5 +1,5 @@ { + "four": 4, "one": 1, - "three": 3, - "two": 2 + "three": 3 } '''))
def setUp(self): self.cb = CallbackBase()
def test_on_any(self): cb = CallbackBase() cb.v2_on_any('whatever', some_keyword='blippy') cb.on_any('whatever', some_keyword='blippy')
def test_get_item(self): cb = CallbackBase() results = {'item': 'some_item'} res = cb._get_item(results) self.assertEquals(res, 'some_item')
def test_display_verbose(self): display_mock = MagicMock() display_mock.verbosity = 5 cb = CallbackBase(display=display_mock) self.assertIs(cb._display, display_mock)
def __init__(self): self.result = dict() CallbackBase.__init__(self)
def test_are_methods(self): cb = CallbackBase() for method in self._find_on_methods(cb): self.assertIsInstance(method, types.MethodType)
def test_clean_results_debug_task_empty_results(self): cb = CallbackBase() result = {} cb._clean_results(result, 'debug') self.assertFalse('invocation' in result) self.assertEqual(len(result), 0)
class TestCallbackDiff(unittest.TestCase): def setUp(self): self.cb = CallbackBase() def _strip_color(self, s): return re.sub('\033\\[[^m]*m', '', s) def test_difflist(self): # TODO: split into smaller tests? difflist = [{ 'before': u'preface\nThe Before String\npostscript', 'after': u'preface\nThe After String\npostscript', 'before_header': u'just before', 'after_header': u'just after' }, { 'before': u'preface\nThe Before String\npostscript', 'after': u'preface\nThe After String\npostscript', }, { 'src_binary': 'chicane' }, { 'dst_binary': 'chicanery' }, { 'dst_larger': 1 }, { 'src_larger': 2 }, { 'prepared': u'what does prepared do?' }, { 'before_header': u'just before' }, { 'after_header': u'just after' }] res = self.cb._get_diff(difflist) self.assertIn(u'Before String', res) self.assertIn(u'After String', res) self.assertIn(u'just before', res) self.assertIn(u'just after', res) def test_simple_diff(self): self.assertMultiLineEqual( self._strip_color( self.cb._get_diff({ 'before_header': 'somefile.txt', 'after_header': 'generated from template somefile.j2', 'before': 'one\ntwo\nthree\n', 'after': 'one\nthree\nfour\n', })), textwrap.dedent('''\ --- before: somefile.txt +++ after: generated from template somefile.j2 @@ -1,3 +1,3 @@ one -two three +four ''')) def test_new_file(self): self.assertMultiLineEqual( self._strip_color( self.cb._get_diff({ 'before_header': 'somefile.txt', 'after_header': 'generated from template somefile.j2', 'before': '', 'after': 'one\ntwo\nthree\n', })), textwrap.dedent('''\ --- before: somefile.txt +++ after: generated from template somefile.j2 @@ -0,0 +1,3 @@ +one +two +three ''')) def test_clear_file(self): self.assertMultiLineEqual( self._strip_color( self.cb._get_diff({ 'before_header': 'somefile.txt', 'after_header': 'generated from template somefile.j2', 'before': 'one\ntwo\nthree\n', 'after': '', })), textwrap.dedent('''\ --- before: somefile.txt +++ after: generated from template somefile.j2 @@ -1,3 +0,0 @@ -one -two -three ''')) def test_no_trailing_newline_before(self): self.assertMultiLineEqual( self._strip_color( self.cb._get_diff({ 'before_header': 'somefile.txt', 'after_header': 'generated from template somefile.j2', 'before': 'one\ntwo\nthree', 'after': 'one\ntwo\nthree\n', })), textwrap.dedent('''\ --- before: somefile.txt +++ after: generated from template somefile.j2 @@ -1,3 +1,3 @@ one two -three \\ No newline at end of file +three ''')) def test_no_trailing_newline_after(self): self.assertMultiLineEqual( self._strip_color( self.cb._get_diff({ 'before_header': 'somefile.txt', 'after_header': 'generated from template somefile.j2', 'before': 'one\ntwo\nthree\n', 'after': 'one\ntwo\nthree', })), textwrap.dedent('''\ --- before: somefile.txt +++ after: generated from template somefile.j2 @@ -1,3 +1,3 @@ one two -three +three \\ No newline at end of file ''')) def test_no_trailing_newline_both(self): self.assertMultiLineEqual( self.cb._get_diff({ 'before_header': 'somefile.txt', 'after_header': 'generated from template somefile.j2', 'before': 'one\ntwo\nthree', 'after': 'one\ntwo\nthree', }), '') def test_no_trailing_newline_both_with_some_changes(self): self.assertMultiLineEqual( self._strip_color( self.cb._get_diff({ 'before_header': 'somefile.txt', 'after_header': 'generated from template somefile.j2', 'before': 'one\ntwo\nthree', 'after': 'one\nfive\nthree', })), textwrap.dedent('''\ --- before: somefile.txt +++ after: generated from template somefile.j2 @@ -1,3 +1,3 @@ one -two +five three \\ No newline at end of file ''')) def test_diff_dicts(self): self.assertMultiLineEqual( self._strip_color( self.cb._get_diff({ 'before': dict(one=1, two=2, three=3), 'after': dict(one=1, three=3, four=4), })), textwrap.dedent('''\ --- before +++ after @@ -1,5 +1,5 @@ { + "four": 4, "one": 1, - "three": 3, - "two": 2 + "three": 3 } ''')) def test_diff_before_none(self): self.assertMultiLineEqual( self._strip_color( self.cb._get_diff({ 'before': None, 'after': 'one line\n', })), textwrap.dedent('''\ --- before +++ after @@ -0,0 +1 @@ +one line ''')) def test_diff_after_none(self): self.assertMultiLineEqual( self._strip_color( self.cb._get_diff({ 'before': 'one line\n', 'after': None, })), textwrap.dedent('''\ --- before +++ after @@ -1 +0,0 @@ -one line '''))
def __init__(self, total_tasks_num, task_name_max_len): """ Constructor """ CallbackBase.__init__(self) self._pbar = ExecutionProgressBar(total_tasks_num, task_name_max_len)
def test_init(self): CallbackBase()