Author: benjamin.peterson Date: Sat Sep 27 23:03:06 2008 New Revision: 66652 Log: add tests for lib2to3.refactor Added: sandbox/trunk/2to3/lib2to3/tests/data/fixers/ sandbox/trunk/2to3/lib2to3/tests/data/fixers/bad_order.py (contents, props changed) sandbox/trunk/2to3/lib2to3/tests/data/fixers/myfixes/ sandbox/trunk/2to3/lib2to3/tests/data/fixers/myfixes/__init__.py (contents, props changed) sandbox/trunk/2to3/lib2to3/tests/data/fixers/myfixes/fix_explicit.py (contents, props changed) sandbox/trunk/2to3/lib2to3/tests/data/fixers/myfixes/fix_first.py (contents, props changed) sandbox/trunk/2to3/lib2to3/tests/data/fixers/myfixes/fix_last.py (contents, props changed) sandbox/trunk/2to3/lib2to3/tests/data/fixers/myfixes/fix_parrot.py (contents, props changed) sandbox/trunk/2to3/lib2to3/tests/data/fixers/myfixes/fix_preorder.py (contents, props changed) sandbox/trunk/2to3/lib2to3/tests/data/fixers/no_fixer_cls.py (contents, props changed) sandbox/trunk/2to3/lib2to3/tests/data/fixers/parrot_example.py (contents, props changed) sandbox/trunk/2to3/lib2to3/tests/test_refactor.py (contents, props changed) Added: sandbox/trunk/2to3/lib2to3/tests/data/fixers/bad_order.py ============================================================================== --- (empty file) +++ sandbox/trunk/2to3/lib2to3/tests/data/fixers/bad_order.py Sat Sep 27 23:03:06 2008 @@ -0,0 +1,5 @@ +from lib2to3.fixer_base import BaseFix + +class FixBadOrder(BaseFix): + + order = "crazy" Added: sandbox/trunk/2to3/lib2to3/tests/data/fixers/myfixes/__init__.py ============================================================================== Added: sandbox/trunk/2to3/lib2to3/tests/data/fixers/myfixes/fix_explicit.py ============================================================================== --- (empty file) +++ sandbox/trunk/2to3/lib2to3/tests/data/fixers/myfixes/fix_explicit.py Sat Sep 27 23:03:06 2008 @@ -0,0 +1,6 @@ +from lib2to3.fixer_base import BaseFix + +class FixExplicit(BaseFix): + explicit = True + + def match(self): return False Added: sandbox/trunk/2to3/lib2to3/tests/data/fixers/myfixes/fix_first.py ============================================================================== --- (empty file) +++ sandbox/trunk/2to3/lib2to3/tests/data/fixers/myfixes/fix_first.py Sat Sep 27 23:03:06 2008 @@ -0,0 +1,6 @@ +from lib2to3.fixer_base import BaseFix + +class FixFirst(BaseFix): + run_order = 1 + + def match(self, node): return False Added: sandbox/trunk/2to3/lib2to3/tests/data/fixers/myfixes/fix_last.py ============================================================================== --- (empty file) +++ sandbox/trunk/2to3/lib2to3/tests/data/fixers/myfixes/fix_last.py Sat Sep 27 23:03:06 2008 @@ -0,0 +1,7 @@ +from lib2to3.fixer_base import BaseFix + +class FixLast(BaseFix): + + run_order = 10 + + def match(self, node): return False Added: sandbox/trunk/2to3/lib2to3/tests/data/fixers/myfixes/fix_parrot.py ============================================================================== --- (empty file) +++ sandbox/trunk/2to3/lib2to3/tests/data/fixers/myfixes/fix_parrot.py Sat Sep 27 23:03:06 2008 @@ -0,0 +1,13 @@ +from lib2to3.fixer_base import BaseFix +from lib2to3.fixer_util import Name + +class FixParrot(BaseFix): + """ + Change functions named 'parrot' to 'cheese'. + """ + + PATTERN = """funcdef < 'def' name='parrot' any* >""" + + def transform(self, node, results): + name = results["name"] + name.replace(Name("cheese", name.get_prefix())) Added: sandbox/trunk/2to3/lib2to3/tests/data/fixers/myfixes/fix_preorder.py ============================================================================== --- (empty file) +++ sandbox/trunk/2to3/lib2to3/tests/data/fixers/myfixes/fix_preorder.py Sat Sep 27 23:03:06 2008 @@ -0,0 +1,6 @@ +from lib2to3.fixer_base import BaseFix + +class FixPreorder(BaseFix): + order = "pre" + + def match(self, node): return False Added: sandbox/trunk/2to3/lib2to3/tests/data/fixers/no_fixer_cls.py ============================================================================== --- (empty file) +++ sandbox/trunk/2to3/lib2to3/tests/data/fixers/no_fixer_cls.py Sat Sep 27 23:03:06 2008 @@ -0,0 +1 @@ +# This is empty so trying to fetch the fixer class gives an AttributeError Added: sandbox/trunk/2to3/lib2to3/tests/data/fixers/parrot_example.py ============================================================================== --- (empty file) +++ sandbox/trunk/2to3/lib2to3/tests/data/fixers/parrot_example.py Sat Sep 27 23:03:06 2008 @@ -0,0 +1,2 @@ +def parrot(): + pass Added: sandbox/trunk/2to3/lib2to3/tests/test_refactor.py ============================================================================== --- (empty file) +++ sandbox/trunk/2to3/lib2to3/tests/test_refactor.py Sat Sep 27 23:03:06 2008 @@ -0,0 +1,175 @@ +""" +Unit tests for refactor.py. +""" + +import sys +import os +import operator +import StringIO +import tempfile +import unittest + +from lib2to3 import refactor, pygram, fixer_base + +from . import support + + +FIXER_DIR = os.path.join(os.path.dirname(__file__), "data/fixers") + +sys.path.append(FIXER_DIR) +try: + _DEFAULT_FIXERS = refactor.get_fixers_from_package("myfixes") +finally: + sys.path.pop() + +class TestRefactoringTool(unittest.TestCase): + + def setUp(self): + sys.path.append(FIXER_DIR) + + def tearDown(self): + sys.path.pop() + + def check_instances(self, instances, classes): + for inst, cls in zip(instances, classes): + if not isinstance(inst, cls): + self.fail("%s are not instances of %s" % instances, classes) + + def rt(self, options=None, fixers=_DEFAULT_FIXERS, explicit=None): + return refactor.RefactoringTool(fixers, options, explicit) + + def test_print_function_option(self): + gram = pygram.python_grammar + save = gram.keywords["print"] + try: + rt = self.rt({"print_function" : True}) + self.assertRaises(KeyError, operator.itemgetter("print"), + gram.keywords) + finally: + gram.keywords["print"] = save + + def test_fixer_loading_helpers(self): + contents = ["explicit", "first", "last", "parrot", "preorder"] + non_prefixed = refactor.get_all_fix_names("myfixes") + prefixed = refactor.get_all_fix_names("myfixes", False) + full_names = refactor.get_fixers_from_package("myfixes") + self.assertEqual(prefixed, ["fix_" + name for name in contents]) + self.assertEqual(non_prefixed, contents) + self.assertEqual(full_names, + ["myfixes.fix_" + name for name in contents]) + + def test_get_headnode_dict(self): + class NoneFix(fixer_base.BaseFix): + PATTERN = None + + class FileInputFix(fixer_base.BaseFix): + PATTERN = "file_input< any * >" + + no_head = NoneFix({}, []) + with_head = FileInputFix({}, []) + d = refactor.get_headnode_dict([no_head, with_head]) + expected = {None: [no_head], + pygram.python_symbols.file_input : [with_head]} + self.assertEqual(d, expected) + + def test_fixer_loading(self): + from myfixes.fix_first import FixFirst + from myfixes.fix_last import FixLast + from myfixes.fix_parrot import FixParrot + from myfixes.fix_preorder import FixPreorder + + rt = self.rt() + pre, post = rt.get_fixers() + + self.check_instances(pre, [FixPreorder]) + self.check_instances(post, [FixFirst, FixParrot, FixLast]) + + def test_naughty_fixers(self): + self.assertRaises(ImportError, self.rt, fixers=["not_here"]) + self.assertRaises(refactor.FixerError, self.rt, fixers=["no_fixer_cls"]) + self.assertRaises(refactor.FixerError, self.rt, fixers=["bad_order"]) + + def test_refactor_string(self): + rt = self.rt() + input = "def parrot(): pass\n\n" + tree = rt.refactor_string(input, "<test>") + self.assertNotEqual(str(tree), input) + + input = "def f(): pass\n\n" + tree = rt.refactor_string(input, "<test>") + self.assertEqual(str(tree), input) + + def test_refactor_stdin(self): + + class MyRT(refactor.RefactoringTool): + + def print_output(self, lines): + diff_lines.extend(lines) + + diff_lines = [] + rt = MyRT(_DEFAULT_FIXERS) + save = sys.stdin + sys.stdin = StringIO.StringIO("def parrot(): pass\n\n") + try: + rt.refactor_stdin() + finally: + sys.stdin = save + expected = """--- <stdin> (original) ++++ <stdin> (refactored) +@@ -1,2 +1,2 @@ +-def parrot(): pass ++def cheese(): pass""".splitlines() + self.assertEqual(diff_lines[:-1], expected) + + def test_refactor_file(self): + test_file = os.path.join(FIXER_DIR, "parrot_example.py") + backup = test_file + ".bak" + old_contents = open(test_file, "r").read() + rt = self.rt() + + rt.refactor_file(test_file) + self.assertEqual(old_contents, open(test_file, "r").read()) + + rt.refactor_file(test_file, True) + try: + self.assertNotEqual(old_contents, open(test_file, "r").read()) + self.assertTrue(os.path.exists(backup)) + self.assertEqual(old_contents, open(backup, "r").read()) + finally: + open(test_file, "w").write(old_contents) + try: + os.unlink(backup) + except OSError: + pass + + def test_refactor_docstring(self): + rt = self.rt() + + def example(): + """ + >>> example() + 42 + """ + out = rt.refactor_docstring(example.__doc__, "<test>") + self.assertEqual(out, example.__doc__) + + def parrot(): + """ + >>> def parrot(): + ... return 43 + """ + out = rt.refactor_docstring(parrot.__doc__, "<test>") + self.assertNotEqual(out, parrot.__doc__) + + def test_explicit(self): + from myfixes.fix_explicit import FixExplicit + + rt = self.rt(fixers=["myfixes.fix_explicit"]) + self.assertEqual(len(rt.post_order), 0) + + rt = self.rt(explicit=["myfixes.fix_explicit"]) + for fix in rt.post_order[None]: + if isinstance(fix, FixExplicit): + break + else: + self.fail("explicit fixer not loaded")