diff --git a/.pylintrc b/.pylintrc deleted file mode 100644 index b731444c4..000000000 --- a/.pylintrc +++ /dev/null @@ -1,379 +0,0 @@ -[MASTER] - -# Specify a configuration file. -#rcfile= - -# Python code to execute, usually for sys.path manipulation such as -# pygtk.require(). -#init-hook= - -# Add files or directories to the blacklist. They should be base names, not -# paths. -ignore=CVS - -# Pickle collected data for later comparisons. -persistent=yes - -# List of plugins (as comma separated values of python modules names) to load, -# usually to register additional checkers. -load-plugins= - -# Use multiple processes to speed up Pylint. -jobs=1 - -# Allow loading of arbitrary C extensions. Extensions are imported into the -# active Python interpreter and may run arbitrary code. -unsafe-load-any-extension=no - -# A comma-separated list of package or module names from where C extensions may -# be loaded. Extensions are loading into the active Python interpreter and may -# run arbitrary code -extension-pkg-whitelist= - -# Allow optimization of some AST trees. This will activate a peephole AST -# optimizer, which will apply various small optimizations. For instance, it can -# be used to obtain the result of joining multiple strings with the addition -# operator. Joining a lot of strings can lead to a maximum recursion error in -# Pylint and this flag can prevent that. It has one side effect, the resulting -# AST will be different than the one from reality. -optimize-ast=no - - -[MESSAGES CONTROL] - -# Only show warnings with the listed confidence levels. Leave empty to show -# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED -confidence= - -# Enable the message, report, category or checker with the given id(s). You can -# either give multiple identifier separated by comma (,) or put this option -# multiple time (only on the command line, not in the configuration file where -# it should appear only once). See also the "--disable" option for examples. -#enable= - -# Disable the message, report, category or checker with the given id(s). You -# can either give multiple identifiers separated by comma (,) or put this -# option multiple times (only on the command line, not in the configuration -# file where it should appear only once).You can also use "--disable=all" to -# disable everything first and then reenable specific checks. For example, if -# you want to run only the similarities checker, you can use "--disable=all -# --enable=similarities". If you want to run only the classes checker, but have -# no Warning level messages displayed, use"--disable=all --enable=classes -# --disable=W" -# disable=next-method-called,no-absolute-import,raising-string,old-octal-literal,suppressed-message,backtick,cmp-method,delslice-method,using-cmp-argument,parameter-unpacking,coerce-builtin,cmp-builtin,useless-suppression,unpacking-in-except,input-builtin,map-builtin-not-iterating,basestring-builtin,unicode-builtin,coerce-method,apply-builtin,buffer-builtin,old-division,execfile-builtin,metaclass-assignment,zip-builtin-not-iterating,import-star-module-level,nonzero-method,hex-method,long-builtin,raw_input-builtin,intern-builtin,old-ne-operator,indexing-exception,range-builtin-not-iterating,old-raise-syntax,file-builtin,dict-view-method,oct-method,reload-builtin,unichr-builtin,setslice-method,xrange-builtin,reduce-builtin,long-suffix,print-statement,getslice-method,standarderror-builtin,filter-builtin-not-iterating,round-builtin,dict-iter-method -disable=bad-whitespace,global-statement,missing-docstring,multiple-statements,too-few-public-methods,unused-argument,too-many-lines,useless-return,no-else-return - -[REPORTS] - -# Set the output format. Available formats are text, parseable, colorized, msvs -# (visual studio) and html. You can also give a reporter class, eg -# mypackage.mymodule.MyReporterClass. -output-format=text - -# Put messages in a separate file for each module / package specified on the -# command line instead of printing them on stdout. Reports (if any) will be -# written in a file name "pylint_global.[txt|html]". -files-output=no - -# Tells whether to display a full report or only the messages -reports=yes - -# Python expression which should return a note less than 10 (10 is the highest -# note). You have access to the variables errors warning, statement which -# respectively contain the number of errors / warnings messages and the total -# number of statements analyzed. This is used by the global evaluation report -# (RP0004). -evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10) - -# Template used to display messages. This is a python new-style format string -# used to format the message information. See doc for all details -#msg-template= - - -[SPELLING] - -# Spelling dictionary name. Available dictionaries: none. To make it working -# install python-enchant package. -spelling-dict= - -# List of comma separated words that should not be checked. -spelling-ignore-words= - -# A path to a file that contains private dictionary; one word per line. -spelling-private-dict-file= - -# Tells whether to store unknown words to indicated private dictionary in -# --spelling-private-dict-file option instead of raising a message. -spelling-store-unknown-words=no - - -[MISCELLANEOUS] - -# List of note tags to take in consideration, separated by a comma. -notes=FIXME,XXX,TODO - - -[SIMILARITIES] - -# Minimum lines number of a similarity. -min-similarity-lines=4 - -# Ignore comments when computing similarities. -ignore-comments=yes - -# Ignore docstrings when computing similarities. -ignore-docstrings=yes - -# Ignore imports when computing similarities. -ignore-imports=no - - -[LOGGING] - -# Logging modules to check that the string format arguments are in logging -# function parameter format -logging-modules=logging - - -[FORMAT] - -# Maximum number of characters on a single line. -max-line-length=150 - -# Regexp for a line that is allowed to be longer than the limit. -ignore-long-lines=^\s*(# )??$ - -# Allow the body of an if to be on the same line as the test if there is no -# else. -single-line-if-stmt=yes - -# List of optional constructs for which whitespace checking is disabled. `dict- -# separator` is used to allow tabulation in dicts, etc.: {1 : 1,\n222: 2}. -# `trailing-comma` allows a space between comma and closing bracket: (a, ). -# `empty-line` allows space-only lines. -no-space-check=trailing-comma,dict-separator - -# Maximum number of lines in a module -max-module-lines=1000 - -# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 -# tab). -indent-string=' ' - -# Number of spaces of indent required inside a hanging or continued line. -indent-after-paren=4 - -# Expected format of line ending, e.g. empty (any line ending), LF or CRLF. -expected-line-ending-format= - - -[TYPECHECK] - -# Tells whether missing members accessed in mixin class should be ignored. A -# mixin class is detected if its name ends with "mixin" (case insensitive). -ignore-mixin-members=yes - -# List of module names for which member attributes should not be checked -# (useful for modules/projects where namespaces are manipulated during runtime -# and thus existing member attributes cannot be deduced by static analysis. It -# supports qualified module names, as well as Unix pattern matching. -ignored-modules= - -# List of classes names for which member attributes should not be checked -# (useful for classes with attributes dynamically set). This supports can work -# with qualified names. -ignored-classes= - -# List of members which are set dynamically and missed by pylint inference -# system, and so shouldn't trigger E1101 when accessed. Python regular -# expressions are accepted. -generated-members= - - -[BASIC] - -# List of builtins function names that should not be used, separated by a comma -bad-functions=map,filter - -# Good variable names which should always be accepted, separated by a comma -good-names=i,j,k,Run,_,fd,FS,GS,x,y,z,pc,sp,ps,ip - -# Bad variable names which should always be refused, separated by a comma -bad-names=foo,bar,baz,toto,tutu,tata - -# Colon-delimited sets of names that determine each other's naming style when -# the name regexes allow several styles. -name-group= - -# Include a hint for the correct naming format with invalid-name -include-naming-hint=no - -# Regular expression matching correct class names -class-rgx=[A-Z_][a-zA-Z0-9]+$ - -# Naming hint for class names -class-name-hint=[A-Z_][a-zA-Z0-9]+$ - -# Regular expression matching correct method names -method-rgx=[a-z_][a-z0-9_]{2,30}$ - -# Naming hint for method names -method-name-hint=[a-z_][a-z0-9_]{2,30}$ - -# Regular expression matching correct argument names -argument-rgx=[a-z_][a-z0-9_]{0,30}$ - -# Naming hint for argument names -argument-name-hint=[a-z_][a-z0-9_]{0,30}$ - -# Regular expression matching correct class attribute names -class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{0,30}|(__.*__))$ - -# Naming hint for class attribute names -class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{0,30}|(__.*__))$ - -# Regular expression matching correct module names -module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ - -# Naming hint for module names -module-name-hint=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ - -# Regular expression matching correct inline iteration names -inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$ - -# Naming hint for inline iteration names -inlinevar-name-hint=[A-Za-z_][A-Za-z0-9_]*$ - -# Regular expression matching correct constant names -const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$ - -# Naming hint for constant names -const-name-hint=(([A-Z_][A-Z0-9_]*)|(__.*__))$ - -# Regular expression matching correct variable names -variable-rgx=[a-z_][a-z0-9_]{0,30}$ - -# Naming hint for variable names -variable-name-hint=[a-z_][a-z0-9_]{0,30}$ - -# Regular expression matching correct attribute names -attr-rgx=[a-z_][a-z0-9_]{0,30}$ - -# Naming hint for attribute names -attr-name-hint=[a-z_][a-z0-9_]{0,30}$ - -# Regular expression matching correct function names -function-rgx=[a-z_][a-z0-9_]{2,30}$ - -# Naming hint for function names -function-name-hint=[a-z_][a-z0-9_]{2,30}$ - -# Regular expression which should only match function or class names that do -# not require a docstring. -no-docstring-rgx=^_ - -# Minimum line length for functions/classes that require docstrings, shorter -# ones are exempt. -docstring-min-length=-1 - - -[ELIF] - -# Maximum number of nested blocks for function / method body -max-nested-blocks=5 - - -[VARIABLES] - -# Tells whether we should check for unused import in __init__ files. -init-import=no - -# A regular expression matching the name of dummy variables (i.e. expectedly -# not used). -dummy-variables-rgx=_$|dummy - -# List of additional names supposed to be defined in builtins. Remember that -# you should avoid to define new builtins when possible. -additional-builtins= - -# List of strings which can identify a callback function by name. A callback -# name must start or end with one of those strings. -callbacks=cb_,_cb - - -[IMPORTS] - -# Deprecated modules which should not be used, separated by a comma -deprecated-modules=optparse - -# Create a graph of every (i.e. internal and external) dependencies in the -# given file (report RP0402 must not be disabled) -import-graph= - -# Create a graph of external dependencies in the given file (report RP0402 must -# not be disabled) -ext-import-graph= - -# Create a graph of internal dependencies in the given file (report RP0402 must -# not be disabled) -int-import-graph= - - -[DESIGN] - -# Maximum number of arguments for function / method -max-args=5 - -# Argument names that match this expression will be ignored. Default to name -# with leading underscore -ignored-argument-names=_.* - -# Maximum number of locals for function / method body -max-locals=15 - -# Maximum number of return / yield for function / method body -max-returns=6 - -# Maximum number of branch for function / method body -max-branches=12 - -# Maximum number of statements in function / method body -max-statements=50 - -# Maximum number of parents for a class (see R0901). -max-parents=7 - -# Maximum number of attributes for a class (see R0902). -max-attributes=7 - -# Minimum number of public methods for a class (see R0903). -min-public-methods=2 - -# Maximum number of public methods for a class (see R0904). -max-public-methods=20 - -# Maximum number of boolean expressions in a if statement -max-bool-expr=5 - - -[CLASSES] - -# List of method names used to declare (i.e. assign) instance attributes. -defining-attr-methods=__init__,__new__,setUp - -# List of valid names for the first argument in a class method. -valid-classmethod-first-arg=cls - -# List of valid names for the first argument in a metaclass class method. -valid-metaclass-classmethod-first-arg=mcs - -# List of member names, which should be excluded from the protected access -# warning. -exclude-protected=_asdict,_fields,_replace,_source,_make - - -[EXCEPTIONS] - -# Exceptions that will emit a warning when being caught. Defaults to -# "Exception" -overgeneral-exceptions=Exception diff --git a/Makefile b/Makefile index e3041412d..6b2d1352a 100644 --- a/Makefile +++ b/Makefile @@ -1,3 +1,6 @@ +PYLINTRC_PATH := ./.pylintrc +PYLINT_RULES := --disable=all --enable=F,E,unreachable,duplicate-key,unnecessary-semicolon,global-variable-not-assigned,unused-variable,binary-op-exception,bad-format-string,anomalous-backslash-in-string,bad-open-mode + test: testbins @cp gef.py /tmp/gef.py python3 tests/runtests.py @@ -15,4 +18,5 @@ testbins: tests/binaries/*.c @$(MAKE) -C tests/binaries all lint: - python3 -m pylint --rcfile ./.pylintrc tests/*.py + python3 -m pylint $(PYLINT_RULES) gef.py + python3 -m pylint $(PYLINT_RULES) tests/*.py diff --git a/tests/runtests.py b/tests/runtests.py index 26f41526d..5fb575d0f 100755 --- a/tests/runtests.py +++ b/tests/runtests.py @@ -19,7 +19,7 @@ class GefUnitTestGeneric(unittest.TestCase): """Generic class for command testing, that defines all helpers""" @staticmethod - def assertNoException(buf): #pylint: disable=invalid-name + def assertNoException(buf): if not ("Python Exception <" not in buf and "Traceback" not in buf and "'gdb.error'" not in buf @@ -28,12 +28,12 @@ def assertNoException(buf): #pylint: disable=invalid-name raise AssertionError("Detected error in gdb output") @staticmethod - def assertFailIfInactiveSession(buf): #pylint: disable=invalid-name + def assertFailIfInactiveSession(buf): if "No debugging session active" not in buf: raise AssertionError("No debugging session inactive warning") -class TestGefCommandsUnit(GefUnitTestGeneric): #pylint: disable=too-many-public-methods +class TestGefCommandsUnit(GefUnitTestGeneric): """Tests GEF GDB commands.""" def test_cmd_canary(self): @@ -674,24 +674,33 @@ def test_func_stack(self): class TestGefConfigUnit(GefUnitTestGeneric): """Test GEF configuration paramaters.""" - def test_config_show_opcodes_size(self): - res = gdb_run_cmd("entry-break", before=["gef config context.show_opcodes_size 4",]) - self.assertNoException(res) - self.assertTrue(len(res.splitlines()) > 1) - # match one of the following patterns - # 0x5555555546b2 897dec mov DWORD PTR [rbp-0x14], edi - # 0x5555555546b5 488975e0 mov QWORD PTR [rbp-0x20], rsi - # 0x5555555546b9 488955d8 mov QWORD PTR [rbp-0x28], rdx - # 0x5555555546bd 64488b04... mov rax, QWORD PTR fs:0x28 - self.assertRegex(res, r"0x.{12}\s([0-9a-f]{2}){1,4}(\.\.\.)?\s+.*") + def test_config_show_opcodes_size(self): + """Check opcodes are correctly shown""" + res = gdb_start_silent_cmd("context code", + before=[ + "gef config context.show_opcodes_size 4", + "gef config context.nb_lines_code_prev 0" + ],) + self.assertNoException(res) + pat = "code:x86:64 ────\n → " + res = res[res.find(pat)+len(pat):] + lines = res.splitlines()[:-1] + self.assertTrue(len(lines) > 1) + opcodes = [ col.split()[1] for col in lines ] + valid_opcodes = { + "f30f1efa", # endbr64 + "55", # push rbp + "4889e5", # mov rbp, rsp + } + self.assertSetEqual(valid_opcodes, set(opcodes[:len(valid_opcodes)])) return class TestNonRegressionUnit(GefUnitTestGeneric): """Non-regression tests.""" - def test_registers_show_registers_in_correct_order(self): #pylint: disable=invalid-name + def test_registers_show_registers_in_correct_order(self): """Ensure the registers are printed in the correct order (PR #670).""" cmd = "registers" x64_registers_in_correct_order = ["$rax", "$rbx", "$rcx", "$rdx", "$rsp", "$rbp", "$rsi", "$rdi", "$rip", "$r8", "$r9", "$r10", "$r11", "$r12", "$r13", "$r14", "$r15", "$eflags", "$cs", ] @@ -701,7 +710,7 @@ def test_registers_show_registers_in_correct_order(self): #pylint: disable=inval return - def test_context_correct_registers_refresh_with_frames(self): #pylint: disable=invalid-name + def test_context_correct_registers_refresh_with_frames(self): """Ensure registers are correctly refreshed when changing frame (PR #668)""" lines = gdb_run_silent_cmd("registers", after=["frame 5", "registers"], target="/tmp/nested.out").splitlines() rips = [ x for x in lines if x.startswith("$rip") ] @@ -712,7 +721,6 @@ def test_context_correct_registers_refresh_with_frames(self): #pylint: disable=i return - def run_tests(): unittest.main(testRunner=unittest.TextTestRunner(verbosity=3))