| 1 |
# Copyright (c) Meta Platforms, Inc. and affiliates. |
| 2 |
# SPDX-License-Identifier: LGPL-2.1-or-later |
| 3 |
|
| 4 |
import io |
| 5 |
|
| 6 |
from drgn import Program, TypeEnumerator |
| 7 |
from drgn.helpers.common.format import ( |
| 8 |
CellFormat, |
| 9 |
RowOptions, |
| 10 |
decode_enum_type_flags, |
| 11 |
decode_flags, |
| 12 |
number_in_binary_units, |
| 13 |
print_table, |
| 14 |
) |
| 15 |
from tests import MOCK_PLATFORM, TestCase |
| 16 |
|
| 17 |
|
| 18 |
class TestDecodeFlags(TestCase): |
| 19 |
FLAGS_BIT_NUMBERS = (("BOLD", 0), ("ITALIC", 1), ("UNDERLINE", 2)) |
| 20 |
FLAGS_VALUES = tuple( |
| 21 |
(name, 1 << bit_number) for name, bit_number in FLAGS_BIT_NUMBERS |
| 22 |
) |
| 23 |
|
| 24 |
def assertDecodeFlags(self, value, expected): |
| 25 |
self.assertEqual(decode_flags(value, self.FLAGS_BIT_NUMBERS), expected) |
| 26 |
self.assertEqual(decode_flags(value, self.FLAGS_VALUES, False), expected) |
| 27 |
|
| 28 |
def test_one(self): |
| 29 |
self.assertDecodeFlags(1, "BOLD") |
| 30 |
self.assertDecodeFlags(2, "ITALIC") |
| 31 |
self.assertDecodeFlags(4, "UNDERLINE") |
| 32 |
|
| 33 |
def test_multiple(self): |
| 34 |
self.assertDecodeFlags(3, "BOLD|ITALIC") |
| 35 |
self.assertDecodeFlags(5, "BOLD|UNDERLINE") |
| 36 |
self.assertDecodeFlags(6, "ITALIC|UNDERLINE") |
| 37 |
self.assertDecodeFlags(7, "BOLD|ITALIC|UNDERLINE") |
| 38 |
|
| 39 |
def test_all_unknown(self): |
| 40 |
self.assertDecodeFlags(8, "0x8") |
| 41 |
|
| 42 |
def test_some_unknown(self): |
| 43 |
self.assertDecodeFlags(9, "BOLD|0x8") |
| 44 |
|
| 45 |
def test_alias(self): |
| 46 |
self.assertEqual( |
| 47 |
decode_flags(2, (("SMALL", 0), ("BIG", 1), ("LARGE", 1))), "BIG|LARGE" |
| 48 |
) |
| 49 |
self.assertEqual( |
| 50 |
decode_flags(2, (("SMALL", 1), ("BIG", 2), ("LARGE", 2)), False), |
| 51 |
"BIG|LARGE", |
| 52 |
) |
| 53 |
|
| 54 |
def test_no_aliases(self): |
| 55 |
self.assertEqual( |
| 56 |
decode_flags(2, (("SMALL", 0), ("BIG", 1), ("LARGE", 1)), aliases=False), |
| 57 |
"BIG", |
| 58 |
) |
| 59 |
|
| 60 |
def test_no_aliases_all_unknown(self): |
| 61 |
self.assertEqual( |
| 62 |
decode_flags(8, (("SMALL", 0), ("BIG", 1), ("LARGE", 1)), aliases=False), |
| 63 |
"0x8", |
| 64 |
) |
| 65 |
|
| 66 |
def test_no_aliases_some_unknown(self): |
| 67 |
self.assertEqual( |
| 68 |
decode_flags(10, (("SMALL", 0), ("BIG", 1), ("LARGE", 1)), aliases=False), |
| 69 |
"BIG|0x8", |
| 70 |
) |
| 71 |
|
| 72 |
def test_zero(self): |
| 73 |
self.assertDecodeFlags(0, "0") |
| 74 |
|
| 75 |
def test_decode_enum_type_flags(self): |
| 76 |
prog = Program(MOCK_PLATFORM) |
| 77 |
|
| 78 |
for bit_numbers, flags in ( |
| 79 |
(True, self.FLAGS_BIT_NUMBERS), |
| 80 |
(False, self.FLAGS_VALUES), |
| 81 |
): |
| 82 |
with self.subTest(bit_numbers=bit_numbers): |
| 83 |
type = prog.enum_type( |
| 84 |
None, |
| 85 |
prog.int_type("int", 4, True), |
| 86 |
[TypeEnumerator(*flag) for flag in flags], |
| 87 |
) |
| 88 |
self.assertEqual( |
| 89 |
decode_enum_type_flags(4, type, bit_numbers), "UNDERLINE" |
| 90 |
) |
| 91 |
self.assertEqual( |
| 92 |
decode_enum_type_flags(27, type, bit_numbers), "BOLD|ITALIC|0x18" |
| 93 |
) |
| 94 |
|
| 95 |
def test_decode_enum_type_flags_incomplete(self): |
| 96 |
self.assertRaisesRegex( |
| 97 |
TypeError, |
| 98 |
"incomplete", |
| 99 |
decode_enum_type_flags, |
| 100 |
2, |
| 101 |
Program().enum_type(None), |
| 102 |
) |
| 103 |
|
| 104 |
|
| 105 |
class TestNumberInBinaryUnits(TestCase): |
| 106 |
def test_zero(self): |
| 107 |
self.assertEqual(number_in_binary_units(0), "0") |
| 108 |
|
| 109 |
def test_small(self): |
| 110 |
self.assertEqual(number_in_binary_units(100), "100") |
| 111 |
self.assertEqual(number_in_binary_units(1023), "1023") |
| 112 |
|
| 113 |
def test_small_negative(self): |
| 114 |
self.assertEqual(number_in_binary_units(-100), "-100") |
| 115 |
self.assertEqual(number_in_binary_units(-1023), "-1023") |
| 116 |
|
| 117 |
def test_integer(self): |
| 118 |
self.assertEqual(number_in_binary_units(1024), "1K") |
| 119 |
self.assertEqual(number_in_binary_units(1024**2), "1M") |
| 120 |
self.assertEqual(number_in_binary_units(1024**3), "1G") |
| 121 |
self.assertEqual(number_in_binary_units(1024**4), "1T") |
| 122 |
self.assertEqual(number_in_binary_units(1024**5), "1P") |
| 123 |
self.assertEqual(number_in_binary_units(1024**6), "1E") |
| 124 |
self.assertEqual(number_in_binary_units(1024**7), "1Z") |
| 125 |
self.assertEqual(number_in_binary_units(1024**8), "1Y") |
| 126 |
|
| 127 |
def test_negative_integer(self): |
| 128 |
self.assertEqual(number_in_binary_units(-1024), "-1K") |
| 129 |
self.assertEqual(number_in_binary_units(-(1024**2)), "-1M") |
| 130 |
self.assertEqual(number_in_binary_units(-(1024**3)), "-1G") |
| 131 |
self.assertEqual(number_in_binary_units(-(1024**4)), "-1T") |
| 132 |
self.assertEqual(number_in_binary_units(-(1024**5)), "-1P") |
| 133 |
self.assertEqual(number_in_binary_units(-(1024**6)), "-1E") |
| 134 |
self.assertEqual(number_in_binary_units(-(1024**7)), "-1Z") |
| 135 |
self.assertEqual(number_in_binary_units(-(1024**8)), "-1Y") |
| 136 |
|
| 137 |
def test_almost_integer(self): |
| 138 |
self.assertEqual(number_in_binary_units(1025), "1.0K") |
| 139 |
self.assertEqual(number_in_binary_units(1024**4 + 1), "1.0T") |
| 140 |
|
| 141 |
def test_precision(self): |
| 142 |
n = 1088 |
| 143 |
self.assertEqual(number_in_binary_units(n, precision=0), "1K") |
| 144 |
self.assertEqual(number_in_binary_units(n, precision=1), "1.1K") |
| 145 |
self.assertEqual(number_in_binary_units(n, precision=2), "1.06K") |
| 146 |
|
| 147 |
def test_huge(self): |
| 148 |
self.assertEqual(number_in_binary_units(1024**8 * 1.5), "1.5Y") |
| 149 |
self.assertEqual(number_in_binary_units(1024**10), "1048576Y") |
| 150 |
|
| 151 |
|
| 152 |
class TestPrintTable(TestCase): |
| 153 |
def assert_print_table(self, rows, expected, **kwargs): |
| 154 |
f = io.StringIO() |
| 155 |
print_table(rows, file=f) |
| 156 |
self.assertEqual(f.getvalue(), expected) |
| 157 |
|
| 158 |
def test_empty(self): |
| 159 |
self.assert_print_table([], "") |
| 160 |
|
| 161 |
def test_one_row(self): |
| 162 |
self.assert_print_table([["abc", "de", "fghi"]], "abc de fghi\n") |
| 163 |
|
| 164 |
def test_align(self): |
| 165 |
self.assert_print_table( |
| 166 |
[[2, 2000, 4], [13, 3, 19]], |
| 167 |
"""\ |
| 168 |
2 2000 4 |
| 169 |
13 3 19 |
| 170 |
""", |
| 171 |
) |
| 172 |
|
| 173 |
def test_empty_cell(self): |
| 174 |
self.assert_print_table( |
| 175 |
[[2, 2000, 4], ["", 3, 13, 19]], |
| 176 |
"""\ |
| 177 |
2 2000 4 |
| 178 |
3 13 19 |
| 179 |
""", |
| 180 |
) |
| 181 |
|
| 182 |
def test_cell_format(self): |
| 183 |
self.assert_print_table( |
| 184 |
[ |
| 185 |
["DECIMAL", "HEXADECIMAL"], |
| 186 |
[CellFormat(10, "<"), CellFormat(10, "<x")], |
| 187 |
], |
| 188 |
"""\ |
| 189 |
DECIMAL HEXADECIMAL |
| 190 |
10 a |
| 191 |
""", |
| 192 |
) |
| 193 |
|
| 194 |
def test_row_options(self): |
| 195 |
self.assert_print_table( |
| 196 |
[ |
| 197 |
["LETTER", "INDEX"], |
| 198 |
["A", 1], |
| 199 |
RowOptions(["WORD", "LENGTH"], group=1), |
| 200 |
RowOptions(["angstrom", 8], group=1), |
| 201 |
["LETTER", "INDEX"], |
| 202 |
["B", 2], |
| 203 |
RowOptions(["WORD", "LENGTH"], group=1), |
| 204 |
RowOptions(["banana", 6], group=1), |
| 205 |
], |
| 206 |
"""\ |
| 207 |
LETTER INDEX |
| 208 |
A 1 |
| 209 |
WORD LENGTH |
| 210 |
angstrom 8 |
| 211 |
LETTER INDEX |
| 212 |
B 2 |
| 213 |
WORD LENGTH |
| 214 |
banana 6 |
| 215 |
""", |
| 216 |
) |