Merge branch 'ticket31578' into ticket31578_merged

changes/ticket31578

@@ -0,0 +1,6 @@
+  o Minor bugfixes (practracker):
+    - When running check-best-practices, only consider files in the
+      src subdirectory.  Previously we had recursively considered
+      all subdirectories, which made us get confused by the
+      temporary directories made by "make distcheck".  Fixes bug
+      31578; bugfix on 0.4.1.1-alpha.

scripts/maint/practracker/metrics.py

@@ -8,6 +8,7 @@ import re
 
 def get_file_len(f):
     """Get file length of file"""
+    i = -1
     for i, l in enumerate(f):
         pass
     return i + 1

scripts/maint/practracker/practracker.py

@@ -200,6 +200,9 @@ def main(argv):
                         help="Maximum lines per function")
     parser.add_argument("--max-dependency-violations", default=MAX_DEP_VIOLATIONS,
                         help="Maximum number of dependency violations to allow")
+    parser.add_argument("--include-dir", action="append",
+                        default=["src"],
+                        help="A directory (under topdir) to search for source")
     parser.add_argument("topdir", default=".", nargs="?",
                         help="Top-level directory for the tor source")
     args = parser.parse_args(argv[1:])
@@ -222,7 +225,7 @@ def main(argv):
     filt.addThreshold(problem.DependencyViolationItem("*.h", int(args.max_dependency_violations)))
 
     # 1) Get all the .c files we care about
-    files_list = util.get_tor_c_files(TOR_TOPDIR)
+    files_list = util.get_tor_c_files(TOR_TOPDIR, args.include_dir)
 
     # 2) Initialize problem vault and load an optional exceptions file so that
     # we don't warn about the past

scripts/maint/practracker/test_practracker.sh

@@ -25,9 +25,13 @@ DATA="${PRACTRACKER_DIR}/testdata"
 
 run_practracker() {
     "${PYTHON:-python}" "${PRACTRACKER_DIR}/practracker.py" \
-        --max-include-count=0 --max-file-size=0 \
-        --max-h-include-count=0 --max-h-file-size=0 \
-        --max-function-size=0 --terse \
+        --include-dir "" \
+        --max-file-size=0 \
+        --max-function-size=0 \
+        --max-h-file-size=0 \
+        --max-h-include-count=0 \
+        --max-include-count=0 \
+        --terse \
         "${DATA}/" "$@";
 }
 compare() {

scripts/maint/practracker/util.py

@@ -3,36 +3,41 @@ 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/rust/",
-                       "src/ext/", ".git/"}
+                       "src/ext/" }
 
 EXCLUDE_FILES = {"orconfig.h"}
 
 def _norm(p):
     return os.path.normcase(os.path.normpath(p))
 
-def get_tor_c_files(tor_topdir):
+def get_tor_c_files(tor_topdir, include_dirs=None):
     """
     Return a list with the .c and .h 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:
-            # We only care about .c and .h files
-            if not (filename.endswith(".c") or filename.endswith(".h")):
-                continue
-            if filename in EXCLUDE_FILES:
-                continue
-
-            full_path = os.path.join(root,filename)
-
-            files_list.append(full_path)
+    if include_dirs is None:
+        topdirs = [ tor_topdir ]
+    else:
+        topdirs = [ os.path.join(tor_topdir, inc) for inc in include_dirs ]
+
+    for topdir in topdirs:
+        for root, directories, filenames in os.walk(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:
+                # We only care about .c and .h files
+                if not (filename.endswith(".c") or filename.endswith(".h")):
+                    continue
+                if filename in EXCLUDE_FILES:
+                    continue
+
+                full_path = os.path.join(root,filename)
+
+                files_list.append(full_path)
 
     return files_list