August 2019 - tor-commits - lists.torproject.org

[tor/master] practracker: better warning/regen handling
by dgoulet＠torproject.org 01 Aug '19

01 Aug '19

commit a79e2c2975f478045c1a3a6fdd34d22d355cce8b Author: Nick Mathewson <nickm(a)torproject.org> Date: Tue Jul 30 11:54:05 2019 -0400 practracker: better warning/regen handling Now that there is only one toplevel place where we print problems, we can redirect just that one print to a file when we are regenerating the exceptions.txt file. Previously we redirected sys.stdout, which is naughty, and forced us to send warnings (and warnings alone) to stderr. --- scripts/maint/practracker/practracker.py | 9 +++++---- scripts/maint/practracker/problem.py | 4 ---- 2 files changed, 5 insertions(+), 8 deletions(-) diff --git a/scripts/maint/practracker/practracker.py b/scripts/maint/practracker/practracker.py index fb6649bdc..a60b0a842 100755 --- a/scripts/maint/practracker/practracker.py +++ b/scripts/maint/practracker/practracker.py @@ -192,11 +192,11 @@ def main(argv): if args.regen: tmpname = exceptions_file + ".tmp" tmpfile = open(tmpname, "w") - sys.stdout = tmpfile - sys.stdout.write(HEADER) + problem_file = tmpfile ProblemVault = problem.ProblemVault() else: ProblemVault = problem.ProblemVault(exceptions_file) + problem_file = sys.stdout # 2.1) Adjust the exceptions so that we warn only about small problems, # and produce errors on big ones. @@ -208,10 +208,11 @@ def main(argv): for item in filt.filter(consider_all_metrics(files_list)): status = ProblemVault.register_problem(item) if status == problem.STATUS_ERR: - print(item) + print(item, file=problem_file) found_new_issues += 1 elif status == problem.STATUS_WARN: - item.warn() + # warnings always go to stdout. + print("(warning) {}".format(item)) if args.regen: tmpfile.close() diff --git a/scripts/maint/practracker/problem.py b/scripts/maint/practracker/problem.py index d162e19ef..d09e94151 100644 --- a/scripts/maint/practracker/problem.py +++ b/scripts/maint/practracker/problem.py @@ -145,10 +145,6 @@ class Item(object): else: return STATUS_OK - def warn(self): - """Warn about this problem on stderr only.""" - print("(warning) {}".format(self), file=sys.stderr) - def key(self): """Generate a unique key that describes this problem that can be used as a dictionary key""" # Item location is a filesystem path, so we need to normalize this

1 0

[tor/master] Practracker: add an integration test.
by dgoulet＠torproject.org 01 Aug '19

01 Aug '19

commit 8d3f3e5d30fa97479bc218a2896cb538ea220514 Author: Nick Mathewson <nickm(a)torproject.org> Date: Tue Jul 30 12:07:40 2019 -0400 Practracker: add an integration test. This test runs practracker with a set of 0 thresholds, to make sure that it enumerates all its values right. It tries running with an empty exceptions file, and with an exceptions file that covers _some_ of the data, and it makes sure that the outputs are as expected. --- scripts/maint/practracker/test_practracker.sh | 50 ++++++++++++++++++++++ scripts/maint/practracker/testdata/a.c | 38 ++++++++++++++++ scripts/maint/practracker/testdata/b.c | 15 +++++++ scripts/maint/practracker/testdata/ex.txt | 0 .../maint/practracker/testdata/ex0-expected.txt | 7 +++ scripts/maint/practracker/testdata/ex0.txt | 0 .../maint/practracker/testdata/ex1-expected.txt | 3 ++ scripts/maint/practracker/testdata/ex1.txt | 11 +++++ scripts/maint/practracker/testdata/not_c_file | 2 + 9 files changed, 126 insertions(+) diff --git a/scripts/maint/practracker/test_practracker.sh b/scripts/maint/practracker/test_practracker.sh new file mode 100755 index 000000000..590525660 --- /dev/null +++ b/scripts/maint/practracker/test_practracker.sh @@ -0,0 +1,50 @@ +#!/bin/sh + +umask 077 + +TMPDIR="" +clean () { + if [ -n "$TMPDIR" ] && [ -d "$TMPDIR" ]; then + rm -rf "$TMPDIR" + fi +} +trap clean EXIT HUP INT TERM + +if test "${PRACTRACKER_DIR}" = "" || + test ! -e "${PRACTRACKER_DIR}/practracker.py" ; then + PRACTRACKER_DIR=$(dirname "$0") +fi + +TMPDIR="$(mktemp -d -t pracktracker.test.XXXXXX)" +if test -z "${TMPDIR}" || test ! -d "${TMPDIR}" ; then + echo >&2 "mktemp failed." + exit 1; +fi + +DATA="${PRACTRACKER_DIR}/testdata" + +run_practracker() { + "${PYTHON:-python}" "${PRACTRACKER_DIR}/practracker.py" \ + --max-include-count=0 --max-file-size=0 --max-function-size=0 --terse \ + "${DATA}/" "$@"; +} + +echo "ex0:" + +run_practracker --exceptions "${DATA}/ex0.txt" > "${TMPDIR}/ex0-received.txt" + +if cmp "${TMPDIR}/ex0-received.txt" "${DATA}/ex0-expected.txt" ; then + echo " OK" +else + exit 1 +fi + +echo "ex1:" + +run_practracker --exceptions "${DATA}/ex1.txt" > "${TMPDIR}/ex1-received.txt" + +if cmp "${TMPDIR}/ex1-received.txt" "${DATA}/ex1-expected.txt" ;then + echo " OK" +else + exit 1 +fi diff --git a/scripts/maint/practracker/testdata/a.c b/scripts/maint/practracker/testdata/a.c new file mode 100644 index 000000000..b52a14f56 --- /dev/null +++ b/scripts/maint/practracker/testdata/a.c @@ -0,0 +1,38 @@ + +#include "one.h" +#include "two.h" +#incldue "three.h" + +# include "four.h" + +int +i_am_a_function(void) +{ + call(); + call(); + /* comment + + another */ + + return 3; +} + +# include "five.h" + +long +another_function(long x, + long y) +{ + int abcd; + + abcd = x+y; + abcd *= abcd; + + /* comment here */ + + return abcd + + abcd + + abcd; +} + +/* And a comment to grow! */ diff --git a/scripts/maint/practracker/testdata/b.c b/scripts/maint/practracker/testdata/b.c new file mode 100644 index 000000000..bef277aaa --- /dev/null +++ b/scripts/maint/practracker/testdata/b.c @@ -0,0 +1,15 @@ + +MOCK_IMPL(int, +foo,(void)) +{ + // blah1 + return 0; +} + +MOCK_IMPL(int, +bar,( long z)) +{ + // blah2 + + return (int)(z+2); +} diff --git a/scripts/maint/practracker/testdata/ex.txt b/scripts/maint/practracker/testdata/ex.txt new file mode 100644 index 000000000..e69de29bb diff --git a/scripts/maint/practracker/testdata/ex0-expected.txt b/scripts/maint/practracker/testdata/ex0-expected.txt new file mode 100644 index 000000000..c021e6f71 --- /dev/null +++ b/scripts/maint/practracker/testdata/ex0-expected.txt @@ -0,0 +1,7 @@ +problem file-size a.c 38 +problem include-count a.c 4 +problem function-size a.c:i_am_a_function() 9 +problem function-size a.c:another_function() 12 +problem file-size b.c 15 +problem function-size b.c:foo() 4 +problem function-size b.c:bar() 5 diff --git a/scripts/maint/practracker/testdata/ex0.txt b/scripts/maint/practracker/testdata/ex0.txt new file mode 100644 index 000000000..e69de29bb diff --git a/scripts/maint/practracker/testdata/ex1-expected.txt b/scripts/maint/practracker/testdata/ex1-expected.txt new file mode 100644 index 000000000..58140a4d9 --- /dev/null +++ b/scripts/maint/practracker/testdata/ex1-expected.txt @@ -0,0 +1,3 @@ +problem function-size a.c:i_am_a_function() 9 +(warning) problem function-size a.c:another_function() 12 +problem function-size b.c:foo() 4 diff --git a/scripts/maint/practracker/testdata/ex1.txt b/scripts/maint/practracker/testdata/ex1.txt new file mode 100644 index 000000000..db42ae845 --- /dev/null +++ b/scripts/maint/practracker/testdata/ex1.txt @@ -0,0 +1,11 @@ + +problem file-size a.c 38 +problem include-count a.c 4 +# this problem will produce an error +problem function-size a.c:i_am_a_function() 8 +# this problem will produce a warning +problem function-size a.c:another_function() 11 +problem file-size b.c 15 +# This is removed, and so will produce an error. +# problem function-size b.c:foo() 4 +problem function-size b.c:bar() 5 diff --git a/scripts/maint/practracker/testdata/not_c_file b/scripts/maint/practracker/testdata/not_c_file new file mode 100644 index 000000000..e150962c0 --- /dev/null +++ b/scripts/maint/practracker/testdata/not_c_file @@ -0,0 +1,2 @@ + +This isn't a C file, so practracker shouldn't care about it.

1 0

[tor/master] Merge branch 'tor-github/pr/1177'
by dgoulet＠torproject.org 01 Aug '19

01 Aug '19

commit c4864de5734b623999701da30a42019cabc42e54 Merge: 6dba86d7c 19536fd18 Author: David Goulet <dgoulet(a)torproject.org> Date: Thu Aug 1 10:18:10 2019 -0400 Merge branch 'tor-github/pr/1177' Makefile.am | 2 +- changes/ticket29746 | 4 + changes/ticket30752 | 6 + scripts/maint/practracker/metrics.py | 10 +- scripts/maint/practracker/practracker.py | 125 +++++++++++++-------- scripts/maint/practracker/practracker_tests.py | 18 ++- scripts/maint/practracker/problem.py | 106 +++++++++++++---- scripts/maint/practracker/test_practracker.sh | 50 +++++++++ scripts/maint/practracker/testdata/a.c | 38 +++++++ scripts/maint/practracker/testdata/b.c | 15 +++ scripts/maint/practracker/testdata/ex.txt | 0 .../maint/practracker/testdata/ex0-expected.txt | 7 ++ scripts/maint/practracker/testdata/ex0.txt | 0 .../maint/practracker/testdata/ex1-expected.txt | 3 + scripts/maint/practracker/testdata/ex1.txt | 11 ++ scripts/maint/practracker/testdata/not_c_file | 2 + scripts/maint/practracker/util.py | 14 ++- 17 files changed, 331 insertions(+), 80 deletions(-)

1 0

[tor/master] Lower check of TOR_DISABLE_PRACTRACKER
by dgoulet＠torproject.org 01 Aug '19

01 Aug '19

commit 3221dc1b32f651f45184efab6bc3a8fa4863aea4 Author: Nick Mathewson <nickm(a)torproject.org> Date: Thu Aug 1 08:40:56 2019 -0400 Lower check of TOR_DISABLE_PRACTRACKER Since we sometimes call practracker directly, that's where we should check the TOR_DISABLE_PRACTRACKER envvar. --- Makefile.am | 4 +--- scripts/maint/practracker/practracker.py | 2 ++ 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/Makefile.am b/Makefile.am index d6ea72c17..b1e94ae0f 100644 --- a/Makefile.am +++ b/Makefile.am @@ -369,9 +369,7 @@ endif check-best-practices: if USEPYTHON - @if test "$$TOR_DISABLE_PRACTRACKER" = ""; then \ - $(PYTHON) $(top_srcdir)/scripts/maint/practracker/practracker.py $(top_srcdir); \ - fi + @$(PYTHON) $(top_srcdir)/scripts/maint/practracker/practracker.py $(top_srcdir) endif practracker-regen: diff --git a/scripts/maint/practracker/practracker.py b/scripts/maint/practracker/practracker.py index a60b0a842..245d01d36 100755 --- a/scripts/maint/practracker/practracker.py +++ b/scripts/maint/practracker/practracker.py @@ -246,4 +246,6 @@ variable. sys.exit(found_new_issues) if __name__ == '__main__': + if os.environ.get("TOR_DISABLE_PRACTRACKER"): + sys.exit(0) main(sys.argv)

1 0

[tor/master] practracker: replaces "overstrict" with "overbroad"
by dgoulet＠torproject.org 01 Aug '19

01 Aug '19

commit 19536fd18d02a52031f7914d5930645bb53b9dba Author: Nick Mathewson <nickm(a)torproject.org> Date: Thu Aug 1 09:35:33 2019 -0400 practracker: replaces "overstrict" with "overbroad" I had the logic reversed here. --- changes/ticket30752 | 2 +- scripts/maint/practracker/practracker.py | 8 ++++---- scripts/maint/practracker/problem.py | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/changes/ticket30752 b/changes/ticket30752 index 754a9003d..044c7c7d9 100644 --- a/changes/ticket30752 +++ b/changes/ticket30752 @@ -1,6 +1,6 @@ o Minor features (best practices tracker): - Give a warning rather than an error when a practracker exception is - violated by a small amount; add a --list-overstrict option to + violated by a small amount; add a --list-overbroad option to practracker that lists exceptions that are stricter than they need to be, and provide an environment variable for disabling practracker. Closes ticekt 30752. diff --git a/scripts/maint/practracker/practracker.py b/scripts/maint/practracker/practracker.py index 245d01d36..a4e951ac7 100755 --- a/scripts/maint/practracker/practracker.py +++ b/scripts/maint/practracker/practracker.py @@ -153,7 +153,7 @@ def main(argv): parser = argparse.ArgumentParser(prog=progname) parser.add_argument("--regen", action="store_true", help="Regenerate the exceptions file") - parser.add_argument("--list-overstrict", action="store_true", + parser.add_argument("--list-overbroad", action="store_true", help="List over-strict exceptions") parser.add_argument("--exceptions", help="Override the location for the exceptions file") @@ -200,7 +200,7 @@ def main(argv): # 2.1) Adjust the exceptions so that we warn only about small problems, # and produce errors on big ones. - if not (args.regen or args.list_overstrict or args.strict): + if not (args.regen or args.list_overbroad or args.strict): ProblemVault.set_tolerances(TOLERANCE_FNS) # 3) Go through all the files and report problems if they are not exceptions @@ -234,10 +234,10 @@ variable. """.format(found_new_issues, exceptions_file) print(new_issues_str) - if args.list_overstrict: + if args.list_overbroad: def k_fn(tup): return tup[0].key() - for (ex,p) in sorted(ProblemVault.list_overstrict_exceptions(), key=k_fn): + for (ex,p) in sorted(ProblemVault.list_overbroad_exceptions(), key=k_fn): if p is None: print(ex, "->", 0) else: diff --git a/scripts/maint/practracker/problem.py b/scripts/maint/practracker/problem.py index d09e94151..73519d446 100644 --- a/scripts/maint/practracker/problem.py +++ b/scripts/maint/practracker/problem.py @@ -82,7 +82,7 @@ class ProblemVault(object): return status - def list_overstrict_exceptions(self): + def list_overbroad_exceptions(self): """Return an iterator of tuples containing (ex,prob) where ex is an exceptions in this vault that are stricter than it needs to be, and prob is the worst problem (if any) that it covered.

1 0

[tor/master] Pracktracker: give the number of new errors found.
by dgoulet＠torproject.org 01 Aug '19

01 Aug '19

commit f93057fc0ae7308c85a888599643d2dc369444de Author: Nick Mathewson <nickm(a)torproject.org> Date: Wed Jul 17 14:09:47 2019 +0200 Pracktracker: give the number of new errors found. Part of 29746. --- scripts/maint/practracker/practracker.py | 41 +++++++++++++++++--------------- 1 file changed, 22 insertions(+), 19 deletions(-) diff --git a/scripts/maint/practracker/practracker.py b/scripts/maint/practracker/practracker.py index febb14639..0dc63f765 100755 --- a/scripts/maint/practracker/practracker.py +++ b/scripts/maint/practracker/practracker.py @@ -54,25 +54,27 @@ else: return open(fname, 'r', encoding='utf-8') def consider_file_size(fname, f): - """Consider file size issues for 'f' and return True if a new issue was found""" + """Consider file size issues for 'f' and return the number of new issues was found""" file_size = metrics.get_file_len(f) if file_size > MAX_FILE_SIZE: p = problem.FileSizeProblem(fname, file_size) - return ProblemVault.register_problem(p) - return False + if ProblemVault.register_problem(p): + return 1 + return 0 def consider_includes(fname, f): - """Consider #include issues for 'f' and return True if a new issue was found""" + """Consider #include issues for 'f' and return the number of new issues found""" include_count = metrics.get_include_count(f) if include_count > MAX_INCLUDE_COUNT: p = problem.IncludeCountProblem(fname, include_count) - return ProblemVault.register_problem(p) - return False + if ProblemVault.register_problem(p): + return 1 + return 0 def consider_function_size(fname, f): - """Consider the function sizes for 'f' and return True if a new issue was found""" - found_new_issues = False + """Consider the function sizes for 'f' and return the number of new issues found.""" + found_new_issues = 0 for name, lines in metrics.get_function_lines(f): # Don't worry about functions within our limits @@ -82,41 +84,42 @@ def consider_function_size(fname, f): # That's a big function! Issue a problem! canonical_function_name = "%s:%s()" % (fname, name) p = problem.FunctionSizeProblem(canonical_function_name, lines) - found_new_issues |= ProblemVault.register_problem(p) + if ProblemVault.register_problem(p): + found_new_issues += 1 return found_new_issues ####################################################### def consider_all_metrics(files_list): - """Consider metrics for all files, and return True if new issues were found""" - found_new_issues = False + """Consider metrics for all files, and return the number of new issues found.""" + found_new_issues = 0 for fname in files_list: with open_file(fname) as f: - found_new_issues |= consider_metrics_for_file(fname, f) + found_new_issues += consider_metrics_for_file(fname, f) return found_new_issues def consider_metrics_for_file(fname, f): """ Consider the various metrics for file with filename 'fname' and file descriptor 'f'. - Return True if we found new issues. + Return the number of new issues found. """ # Strip the useless part of the path if fname.startswith(TOR_TOPDIR): fname = fname[len(TOR_TOPDIR):] - found_new_issues = False + found_new_issues = 0 # Get file length - found_new_issues |= consider_file_size(fname, f) + found_new_issues += consider_file_size(fname, f) # Consider number of #includes f.seek(0) - found_new_issues |= consider_includes(fname, f) + found_new_issues += consider_includes(fname, f) # Get function length f.seek(0) - found_new_issues |= consider_function_size(fname, f) + found_new_issues += consider_function_size(fname, f) return found_new_issues @@ -201,13 +204,13 @@ def main(argv): # If new issues were found, try to give out some advice to the developer on how to resolve it. if found_new_issues and not args.regen: new_issues_str = """\ -FAILURE: practracker found new problems in the code: see warnings above. +FAILURE: practracker found {} new problem(s) in the code: see warnings above. Please fix the problems if you can, and update the exceptions file ({}) if you can't. See doc/HACKING/HelpfulTools.md for more information on using practracker.\ -""".format(exceptions_file) +""".format(found_new_issues, exceptions_file) print(new_issues_str) sys.exit(found_new_issues)

1 0

[tor/master] Changes file for 29746.
by dgoulet＠torproject.org 01 Aug '19

01 Aug '19

commit 78768aafe1068bd76419944bea1ed3453d85edfe Author: Nick Mathewson <nickm(a)torproject.org> Date: Thu Jul 18 09:27:49 2019 -0400 Changes file for 29746. --- changes/ticket29746 | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/changes/ticket29746 b/changes/ticket29746 new file mode 100644 index 000000000..63b9edb39 --- /dev/null +++ b/changes/ticket29746 @@ -0,0 +1,4 @@ + o Minor bugfixes (best practices tracker): + - Fix a few issues in the best-practices script, including tests, tab + tolerance, error reporting, and directory-exclusion logic. Fixes bug + 29746; bugfix on 0.4.1.1-alpha.

1 0

[tor/master] Practracker: allow tabs in include lines
by dgoulet＠torproject.org 01 Aug '19

01 Aug '19

commit 86d3d310f529bc1e13ce1ca5013c674837c9856b Author: Nick Mathewson <nickm(a)torproject.org> Date: Wed Jul 17 14:02:17 2019 +0200 Practracker: allow tabs in include lines This isn't actually something that Tor does, but it's cleaner to do it this way. Part of 29746. --- scripts/maint/practracker/metrics.py | 2 +- scripts/maint/practracker/practracker_tests.py | 10 ++++++++++ 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/scripts/maint/practracker/metrics.py b/scripts/maint/practracker/metrics.py index b35029b51..82f1cd64e 100644 --- a/scripts/maint/practracker/metrics.py +++ b/scripts/maint/practracker/metrics.py @@ -16,7 +16,7 @@ def get_include_count(f): """Get number of #include statements in the file""" include_count = 0 for line in f: - if re.match(r' *# *include', line): + if re.match(r'\s*#\s*include', line): include_count += 1 return include_count diff --git a/scripts/maint/practracker/practracker_tests.py b/scripts/maint/practracker/practracker_tests.py index f11c55a3b..865f68d18 100755 --- a/scripts/maint/practracker/practracker_tests.py +++ b/scripts/maint/practracker/practracker_tests.py @@ -48,5 +48,15 @@ class TestFunctionLength(unittest.TestCase): for name, lines in metrics.get_function_lines(funcs): self.assertEqual(lines, 4) +class TestIncludeCount(unittest.TestCase): + def test_include_count(self): + f = StringIO.StringIO(""" + # include <abc.h> + # include "def.h" +#include "ghi.h" +\t#\t include "jkl.h" +""") + self.assertEqual(metrics.get_include_count(f),4) + if __name__ == '__main__': unittest.main()

1 0

[tor/master] Practracker: improve exclude-directory logic
by dgoulet＠torproject.org 01 Aug '19

01 Aug '19

commit 43f163de80864a4918b1566c3fbc0b73aac6a327 Author: Nick Mathewson <nickm(a)torproject.org> Date: Wed Jul 17 14:30:12 2019 +0200 Practracker: improve exclude-directory logic Instead of excluding directories at the last minute if they happen to appear in our filenames, we exclude them early, before recursing into all their subdirectories. Part of 29746. --- scripts/maint/practracker/util.py | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/scripts/maint/practracker/util.py b/scripts/maint/practracker/util.py index b0ca73b99..5a8876a0f 100644 --- a/scripts/maint/practracker/util.py +++ b/scripts/maint/practracker/util.py @@ -2,15 +2,24 @@ import os # We don't want to run metrics for unittests, automatically-generated C files, # external libraries or git leftovers. -EXCLUDE_SOURCE_DIRS = {"/src/test/", "/src/trunnel/", "/src/ext/", "/.git/"} +EXCLUDE_SOURCE_DIRS = {"src/test/", "src/trunnel/", "src/rust/", + "src/ext/", ".git/"} + +def _norm(p): + return os.path.normcase(os.path.normpath(p)) def get_tor_c_files(tor_topdir): """ Return a list with the .c filenames we want to get metrics of. """ files_list = [] + exclude_dirs = { _norm(os.path.join(tor_topdir, p)) for p in EXCLUDE_SOURCE_DIRS } + for root, directories, filenames in os.walk(tor_topdir): + # Remove all the directories that are excluded. + directories[:] = [ d for d in directories + if _norm(os.path.join(root,d)) not in exclude_dirs ] directories.sort() filenames.sort() for filename in filenames: @@ -18,10 +27,7 @@ def get_tor_c_files(tor_topdir): if not filename.endswith(".c"): continue - # Exclude the excluded paths full_path = os.path.join(root,filename) - if any(os.path.normcase(exclude_dir) in full_path for exclude_dir in EXCLUDE_SOURCE_DIRS): - continue files_list.append(full_path)

1 0

[tor/master] Fix practracker_tests.py and practracker line counting.
by dgoulet＠torproject.org 01 Aug '19

01 Aug '19

commit 4c095329964c47c7a37c812fdaf58b9238cc9ff5 Author: Nick Mathewson <nickm(a)torproject.org> Date: Wed Jul 17 14:00:28 2019 +0200 Fix practracker_tests.py and practracker line counting. The practracker_tests.py unit test file called a function by its old name. Also, practracker counted functions as starting one line after the function name, and ending with the closing brace. Now they start with the open brace and end with the closing brace. --- scripts/maint/practracker/metrics.py | 8 ++++++-- scripts/maint/practracker/practracker_tests.py | 8 +++++--- 2 files changed, 11 insertions(+), 5 deletions(-) diff --git a/scripts/maint/practracker/metrics.py b/scripts/maint/practracker/metrics.py index 5fa305a86..b35029b51 100644 --- a/scripts/maint/practracker/metrics.py +++ b/scripts/maint/practracker/metrics.py @@ -31,6 +31,7 @@ def get_function_lines(f): "DISABLE_GCC_WARNING", "DISABLE_GCC_WARNINGS"} in_function = False + found_openbrace = False for lineno, line in enumerate(f): if not in_function: # find the start of a function @@ -41,10 +42,13 @@ def get_function_lines(f): continue func_start = lineno in_function = True - + elif not found_openbrace and line.startswith("{"): + found_openbrace = True + func_start = lineno else: # Find the end of a function if line.startswith("}"): - n_lines = lineno - func_start + n_lines = lineno - func_start + 1 in_function = False + found_openbrace = False yield (func_name, n_lines) diff --git a/scripts/maint/practracker/practracker_tests.py b/scripts/maint/practracker/practracker_tests.py index cdbab2908..f11c55a3b 100755 --- a/scripts/maint/practracker/practracker_tests.py +++ b/scripts/maint/practracker/practracker_tests.py @@ -1,3 +1,5 @@ +#!/usr/bin/python + """Some simple tests for practracker metrics""" import unittest @@ -38,13 +40,13 @@ class TestFunctionLength(unittest.TestCase): def test_function_length(self): funcs = StringIO.StringIO(function_file) # All functions should have length 2 - for name, lines in metrics.function_lines(funcs): + for name, lines in metrics.get_function_lines(funcs): self.assertEqual(name, "fun") funcs.seek(0) - for name, lines in metrics.function_lines(funcs): - self.assertEqual(lines, 2) + for name, lines in metrics.get_function_lines(funcs): + self.assertEqual(lines, 4) if __name__ == '__main__': unittest.main()

1 0