Some test refactoring (#357)

aaronliu0130 · cclauss · web-flow · commit bbba111d0a88 · 2025-04-07T19:43:03.000+02:00
* increase default pytest timeout to 481s for debugging room * [remove duplicate boost sample for testing inspect headers](1e39bff) * [use pytest parametrized instead of parameterized & google todo credit](c0eb131) * add script to update CLI test definitions --------- Co-authored-by: Christian Clauss <cclauss@me.com>
diff --git a/cpplint_clitest.py b/cpplint_clitest.py
@@ -39,7 +39,6 @@
 import tempfile
 
 import pytest
-from parameterized import parameterized  # type: ignore[import-untyped]
 from testfixtures import compare  # type: ignore[import-untyped]
 
 import cpplint  # noqa: F401
@@ -55,7 +54,7 @@ def run_shell_command(cmd: str, args: str, cwd: str = ".") -> tuple[int, bytes,
         args: A string with arguments to the command.
         cwd: from which folder to run.
     """
-    cmd, args = cmd.split(), args.split()  # type: ignore[assignment]
+    cmd, args = cmd.split(), args.replace('"', "").split()  # type: ignore[assignment]
     proc = subprocess.run(cmd + args, cwd=cwd, capture_output=True, check=False)
     out, err = proc.stdout, proc.stderr
 
@@ -175,14 +174,14 @@ class TestNoRepoSignature(TemporaryFolderClassSetup):
     def get_extra_command_args(self, cwd):
         return f" --repository {self._root} "
 
-    @parameterized.expand(
+    @pytest.mark.parametrize(
+        ("folder", "case"),
         [
             (folder, case[:-4])
             for folder in ["chromium", "vlc", "silly", "boost", "protobuf", "codelite", "v8"]
             for case in os.listdir(f"./samples/{folder}-sample")
             if case.endswith(".def")
         ],
-        name_func=lambda fun, _, x: f"test_{x.args[0]}_sample-{x.args[1]}",
     )
     @pytest.mark.timeout(180)
     def test_samples(self, folder, case):
diff --git a/cpplint_unittest.py b/cpplint_unittest.py
@@ -30,7 +30,7 @@
 
 """Unit test for cpplint.py."""
 
-# TODO(unknown): Add a good test that tests UpdateIncludeState.
+# TODO(google): Add a good test that tests UpdateIncludeState.
 
 import codecs
 import os
@@ -43,7 +43,6 @@
 import tempfile
 
 import pytest
-from parameterized import parameterized  # type: ignore[import-untyped]
 
 import cpplint
 
@@ -2230,7 +2229,7 @@ def testConstStringReferenceMembers(self):
             "const string &turing",
             "const string & godel",
         ]
-        # TODO(unknown): Enable also these tests if and when we ever
+        # TODO(google): Enable also these tests if and when we ever
         # decide to check for arbitrary member references.
         #                         "const Turing & a",
         #                         "const Church& a",
@@ -4604,7 +4603,7 @@ def testConditionals(self):
             "",
         )
 
-    @parameterized.expand(["else if", "if", "while", "for", "switch"])
+    @pytest.mark.parametrize("keyword", ["else if", "if", "while", "for", "switch"])
     def testControlClauseWithParensNewline(self, keyword):
         # The % 2 part is pseudorandom whitespace-support testing
         self.TestLintContains(
@@ -4616,7 +4615,7 @@ def testControlClauseWithParensNewline(self, keyword):
             f" should be on a separate line  [whitespace/newline] [5]",
         )
 
-    @parameterized.expand(["else", "do", "try"])
+    @pytest.mark.parametrize("keyword", ["else", "do", "try"])
     def testControlClauseWithoutParensNewline(self, keyword):
         # The % 2 part is pseudorandom whitespace-support testing
         self.TestLintContains(
diff --git a/pyproject.toml b/pyproject.toml
@@ -41,7 +41,6 @@ dependencies = [  ]
 
 optional-dependencies.dev = [
   "mypy",
-  "parameterized",
   "pylint>=3.3.4",
   "pytest",
   "pytest-cov",
@@ -206,4 +205,4 @@ addopts = "--color=yes --cov-fail-under=90 --cov=cpplint"
 python_files = [ "*test.py" ]
 required_plugins = [ "pytest-cov", "pytest-timeout" ]
 testpaths = [ "." ]
-timeout = 60
+timeout = 481
diff --git a/regen-defs.zsh b/regen-defs.zsh
@@ -0,0 +1,48 @@
+#!/bin/zsh
+
+# Input the path of cpplint here
+cpplint="$HOME/Documents/cpplint/cpplint.py"
+
+cd samples/ || exit 74  # EX_IOERROR
+
+# Loop through all .def files in the given directories
+folders=(${(f)"$(cat)"})
+for folder in $folders; do
+  cd "$folder-sample/" || exit 66  # EX_NOINPUT
+  for file in ./*.def; do
+    if [[ ! -s "$file" ]]; then
+      echo "Skipping empty file: $file"
+      continue
+    fi
+    echo "Processing $file..."
+
+    # Extract the command from the first line of the file
+    cmd=$(head -n 1 "$file")
+
+    # Create temporary files for stdout and stderr
+    stdout_file=$(mktemp)
+    stderr_file=$(mktemp)
+
+    # Execute the command and capture stdout and stderr
+    uv run "$cpplint" $cmd > "$stdout_file" 2> "$stderr_file"
+    ret_code=$?
+
+    # Count the number of lines in stdout
+    (( num_lines=$(wc -l < "$stdout_file") + 1 ))
+
+    # Overwrite the original definition file
+    {
+      echo "$cmd"
+      echo "$ret_code"
+      echo "$num_lines"
+      cat "$stdout_file"
+      echo
+      cat "$stderr_file"
+      echo
+    } > "$file"
+
+    # Clean up temporary files
+    rm "$stdout_file" "$stderr_file"
+  done
+  cd ..
+done
diff --git a/samples/boost-sample/exclude.def b/samples/boost-sample/exclude.def
diff --git a/samples/boost-sample/headers_inspect_exclude.def b/samples/boost-sample/headers_inspect_exclude.def
@@ -1,4 +1,4 @@
-src/inspect/*
+--recursive "--exclude=src/tr1/*" src
 1
 3
 Done processing src/inspect/unnamed_namespace_check.hpp

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-src/inspect/*`
	`1`	`+--recursive "--exclude=src/tr1/*" src`
`2`	`2`	`1`
`3`	`3`	`3`
`4`	`4`	`Done processing src/inspect/unnamed_namespace_check.hpp`