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 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300
|
#
# Copyright 2015 Red Hat, Inc.
#
# SPDX-License-Identifier: Apache-2.0
import ast
from unittest import mock
import sys
import testtools
from bandit.core import context
def make_str(s):
if sys.version_info >= (3, 14):
return ast.Constant(s)
return ast.Str(s)
def make_num(n):
if sys.version_info >= (3, 14):
return ast.Constant(n)
return ast.Num(n)
def make_bytes(b):
if sys.version_info >= (3, 14):
return ast.Constant(b)
return ast.Bytes(b)
def literal_value(node):
"""Return the actual value of an AST literal node, handling Python 3.14+"""
if isinstance(node, ast.Constant):
return node.value
if hasattr(ast, "Num") and isinstance(node, ast.Num):
return node.n
if hasattr(ast, "Str") and isinstance(node, ast.Str):
return node.s
if hasattr(ast, "Bytes") and isinstance(node, ast.Bytes):
return node.s
if hasattr(ast, "NameConstant") and isinstance(node, ast.NameConstant):
return node.value
if isinstance(node, ast.Name):
return node.id
return None
class ContextTests(testtools.TestCase):
def test_context_create(self):
ref_context = mock.Mock()
new_context = context.Context(context_object=ref_context)
self.assertEqual(ref_context, new_context._context)
new_context = context.Context()
self.assertIsInstance(new_context._context, dict)
def test_repr(self):
ref_object = dict(spam="eggs")
expected_repr = f"<Context {ref_object}>"
new_context = context.Context(context_object=ref_object)
self.assertEqual(expected_repr, repr(new_context))
@mock.patch("bandit.core.context.Context._get_literal_value")
def test_call_args(self, get_literal_value):
get_literal_value.return_value = "eggs"
ref_call = mock.Mock()
ref_call.args = [mock.Mock(attr="spam"), "eggs"]
ref_context = dict(call=ref_call)
new_context = context.Context(context_object=ref_context)
expected_args = ["spam", "eggs"]
self.assertListEqual(expected_args, new_context.call_args)
def test_call_args_count(self):
ref_call = mock.Mock()
ref_call.args = ["spam", "eggs"]
ref_context = dict(call=ref_call)
new_context = context.Context(context_object=ref_context)
self.assertEqual(len(ref_call.args), new_context.call_args_count)
ref_context = dict(call={})
new_context = context.Context(context_object=ref_context)
self.assertIsNone(new_context.call_args_count)
new_context = context.Context()
self.assertIsNone(new_context.call_args_count)
def test_call_function_name(self):
expected_string = "spam"
ref_context = dict(name=expected_string)
new_context = context.Context(context_object=ref_context)
self.assertEqual(expected_string, new_context.call_function_name)
new_context = context.Context()
self.assertIsNone(new_context.call_function_name)
def test_call_function_name_qual(self):
expected_string = "spam"
ref_context = dict(qualname=expected_string)
new_context = context.Context(context_object=ref_context)
self.assertEqual(expected_string, new_context.call_function_name_qual)
new_context = context.Context()
self.assertIsNone(new_context.call_function_name_qual)
@mock.patch("bandit.core.context.Context._get_literal_value")
def test_call_keywords(self, get_literal_value):
get_literal_value.return_value = "eggs"
ref_keyword1 = mock.Mock(arg="arg1", value=mock.Mock(attr="spam"))
ref_keyword2 = mock.Mock(arg="arg2", value="eggs")
ref_call = mock.Mock()
ref_call.keywords = [ref_keyword1, ref_keyword2]
ref_context = dict(call=ref_call)
new_context = context.Context(context_object=ref_context)
expected_dict = dict(arg1="spam", arg2="eggs")
self.assertDictEqual(expected_dict, new_context.call_keywords)
ref_context = dict(call=None)
new_context = context.Context(context_object=ref_context)
self.assertIsNone(new_context.call_keywords)
new_context = context.Context()
self.assertIsNone(new_context.call_keywords)
def test_node(self):
expected_node = "spam"
ref_context = dict(node=expected_node)
new_context = context.Context(context_object=ref_context)
self.assertEqual(expected_node, new_context.node)
new_context = context.Context()
self.assertIsNone(new_context.node)
def test_string_val(self):
expected_string = "spam"
ref_context = dict(str=expected_string)
new_context = context.Context(context_object=ref_context)
self.assertEqual(expected_string, new_context.string_val)
new_context = context.Context()
self.assertIsNone(new_context.string_val)
def test_statement(self):
expected_string = "spam"
ref_context = dict(statement=expected_string)
new_context = context.Context(context_object=ref_context)
self.assertEqual(expected_string, new_context.statement)
new_context = context.Context()
self.assertIsNone(new_context.statement)
@mock.patch("bandit.core.utils.get_qual_attr")
def test_function_def_defaults_qual(self, get_qual_attr):
get_qual_attr.return_value = "spam"
ref_node = mock.Mock(args=mock.Mock(defaults=["spam"]))
ref_context = dict(node=ref_node, import_aliases=None)
new_context = context.Context(context_object=ref_context)
self.assertListEqual(["spam"], new_context.function_def_defaults_qual)
ref_node = mock.Mock(args=mock.Mock(defaults=[]))
ref_context = dict(node=ref_node, import_aliases=None)
new_context = context.Context(context_object=ref_context)
self.assertListEqual([], new_context.function_def_defaults_qual)
new_context = context.Context()
self.assertListEqual([], new_context.function_def_defaults_qual)
def test__get_literal_value(self):
new_context = context.Context()
value = make_num(42)
expected = literal_value(value)
self.assertEqual(expected, new_context._get_literal_value(value))
value = make_str("spam")
expected = literal_value(value)
self.assertEqual(expected, new_context._get_literal_value(value))
value = ast.List([make_str("spam"), make_num(42)], ast.Load())
expected = [literal_value(x) for x in value.elts]
self.assertListEqual(expected, new_context._get_literal_value(value))
value = ast.Tuple([make_str("spam"), make_num(42)], ast.Load())
expected = tuple(literal_value(x) for x in value.elts)
self.assertTupleEqual(expected, new_context._get_literal_value(value))
value = ast.Set([make_str("spam"), make_num(42)])
expected = {literal_value(x) for x in value.elts}
self.assertSetEqual(expected, new_context._get_literal_value(value))
value = ast.Dict([make_str("spam"), make_str("eggs")],
[make_num(42), make_str("foo")])
expected = {literal_value(k): literal_value(v) for k, v in zip(value.keys, value.values)}
self.assertDictEqual(expected, new_context._get_literal_value(value))
if sys.version_info >= (3, 14):
value = ast.Constant(Ellipsis)
else:
value = ast.Ellipsis()
self.assertEqual(None, new_context._get_literal_value(value))
value = ast.Name("spam", ast.Load())
expected = literal_value(value)
self.assertEqual(expected, new_context._get_literal_value(value))
value = make_bytes(b"spam")
expected = literal_value(value)
self.assertEqual(expected, new_context._get_literal_value(value))
self.assertIsNone(new_context._get_literal_value(None))
@mock.patch(
"bandit.core.context.Context.call_keywords",
new_callable=mock.PropertyMock,
)
def test_check_call_arg_value(self, call_keywords):
new_context = context.Context()
call_keywords.return_value = dict(spam="eggs")
self.assertTrue(new_context.check_call_arg_value("spam", "eggs"))
self.assertTrue(
new_context.check_call_arg_value("spam", ["spam", "eggs"])
)
self.assertFalse(new_context.check_call_arg_value("spam", "spam"))
self.assertFalse(new_context.check_call_arg_value("spam"))
self.assertFalse(new_context.check_call_arg_value("eggs"))
new_context = context.Context()
self.assertIsNone(new_context.check_call_arg_value(None))
@mock.patch(
"bandit.core.context.Context.node", new_callable=mock.PropertyMock
)
def test_get_lineno_for_call_arg(self, node):
expected_lineno = 42
keyword1 = mock.Mock(
arg="spam", value=mock.Mock(lineno=expected_lineno)
)
node.return_value = mock.Mock(keywords=[keyword1])
new_context = context.Context()
actual_lineno = new_context.get_lineno_for_call_arg("spam")
self.assertEqual(expected_lineno, actual_lineno)
new_context = context.Context()
missing_lineno = new_context.get_lineno_for_call_arg("eggs")
self.assertIsNone(missing_lineno)
def test_get_call_arg_at_position(self):
expected_arg = "spam"
ref_call = mock.Mock()
ref_call.args = [make_str(expected_arg)]
ref_context = dict(call=ref_call)
new_context = context.Context(context_object=ref_context)
self.assertEqual(expected_arg, new_context.get_call_arg_at_position(0))
self.assertIsNone(new_context.get_call_arg_at_position(1))
ref_call = mock.Mock()
ref_call.args = []
ref_context = dict(call=ref_call)
new_context = context.Context(context_object=ref_context)
self.assertIsNone(new_context.get_call_arg_at_position(0))
new_context = context.Context()
self.assertIsNone(new_context.get_call_arg_at_position(0))
def test_is_module_being_imported(self):
ref_context = dict(module="spam")
new_context = context.Context(context_object=ref_context)
self.assertTrue(new_context.is_module_being_imported("spam"))
self.assertFalse(new_context.is_module_being_imported("eggs"))
new_context = context.Context()
self.assertFalse(new_context.is_module_being_imported("spam"))
def test_is_module_imported_exact(self):
ref_context = dict(imports=["spam"])
new_context = context.Context(context_object=ref_context)
self.assertTrue(new_context.is_module_imported_exact("spam"))
self.assertFalse(new_context.is_module_imported_exact("eggs"))
new_context = context.Context()
self.assertFalse(new_context.is_module_being_imported("spam"))
def test_is_module_imported_like(self):
ref_context = dict(imports=[["spam"], ["eggs"]])
new_context = context.Context(context_object=ref_context)
self.assertTrue(new_context.is_module_imported_like("spam"))
self.assertFalse(new_context.is_module_imported_like("bacon"))
new_context = context.Context()
self.assertFalse(new_context.is_module_imported_like("spam"))
def test_filename(self):
ref_context = dict(filename="spam.py")
new_context = context.Context(context_object=ref_context)
self.assertEqual(new_context.filename, "spam.py")
new_context = context.Context()
self.assertIsNone(new_context.filename)
|