1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112
|
# Copyright (c) Meta Platforms, Inc. and affiliates.
#
# This source code is licensed under the MIT license found in the
# LICENSE file in the root directory of this source tree.
#
from textwrap import dedent
from typing import Dict
import libcst as cst
from libcst.codemod import (
Codemod,
CodemodContext,
CodemodTest,
SkipFile,
transform_module,
TransformExit,
TransformFailure,
TransformSkip,
TransformSuccess,
)
class TestRunner(CodemodTest):
def test_runner_default(self) -> None:
before = """
def foo() -> None:
pass
def bar() -> int:
return 5
"""
after = """
# A comment
def foo() -> None:
pass
def bar() -> int:
return 5
"""
class SimpleCodemod(Codemod):
def transform_module_impl(self, tree: cst.Module) -> cst.Module:
self.warn("Testing")
return tree.with_changes(
header=[cst.EmptyLine(comment=cst.Comment("# A comment"))]
)
transform = SimpleCodemod(CodemodContext())
response = transform_module(transform, dedent(before))
self.assertIsInstance(response, TransformSuccess)
assert isinstance(response, TransformSuccess)
self.assertCodeEqual(response.code, after)
self.assertEqual(response.warning_messages, ["Testing"])
def test_runner_interrupted(self) -> None:
code = """
def foo() -> None:
pass
def bar() -> int:
return 5
"""
class SimpleCodemod(Codemod):
def transform_module_impl(self, tree: cst.Module) -> cst.Module:
raise KeyboardInterrupt("Testing")
transform = SimpleCodemod(CodemodContext())
response = transform_module(transform, dedent(code))
self.assertIsInstance(response, TransformExit)
def test_runner_skip(self) -> None:
code = """
def foo() -> None:
pass
def bar() -> int:
return 5
"""
class SimpleCodemod(Codemod):
def transform_module_impl(self, tree: cst.Module) -> cst.Module:
self.warn("Testing")
raise SkipFile()
transform = SimpleCodemod(CodemodContext())
response = transform_module(transform, dedent(code))
self.assertIsInstance(response, TransformSkip)
self.assertEqual(response.warning_messages, ["Testing"])
def test_runner_failure(self) -> None:
code = """
def foo() -> None:
pass
def bar() -> int:
return 5
"""
class SimpleCodemod(Codemod):
def transform_module_impl(self, tree: cst.Module) -> cst.Module:
self.warn("Testing")
somedict: Dict[str, str] = {}
somedict["invalid_key"]
return tree
transform = SimpleCodemod(CodemodContext())
response = transform_module(transform, dedent(code))
self.assertIsInstance(response, TransformFailure)
assert isinstance(response, TransformFailure)
self.assertEqual(response.warning_messages, ["Testing"])
self.assertIsInstance(response.error, KeyError)
|