Skip to content

Fix Python and Pylint warnings in windows_testing.py #116

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Fix Python and Pylint warnings in windows_testing.py #116

Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
a3bff21
Fix use of the is operator on a string
gilles-peskine-arm Jul 20, 2023
3c5ed80
Fix anomalous backslash in strings
gilles-peskine-arm Jul 20, 2023
7153f95
Improve error backtraces
gilles-peskine-arm Jul 20, 2023
a5b3d85
Tell pylint we mean it when continuing after an exception
gilles-peskine-arm Jul 20, 2023
50035b1
Pacify a Pylint warning
gilles-peskine-arm Jul 20, 2023
da94cd9
Fix . in regex
gilles-peskine-arm Aug 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 19 additions & 15 deletions resources/windows/windows_testing.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,12 +149,12 @@ def __init__(self,
self.mingw_result = None
self.solution_file_pattern = r"(?i)mbed *TLS\.sln\Z"
self.visual_studio_build_success_patterns = [
"Build succeeded.", "\d+ Warning\(s\)", "0 Error\(s\)"
r"Build succeeded.", r"\d+ Warning\(s\)", r"0 Error\(s\)"
]
self.visual_studio_build_zero_warnings_string = "0 Warning(s)"
self.selftest_success_pattern = "\[ All tests (PASS|passed) \]"
self.test_suites_success_pattern = "100% tests passed, 0 tests failed"
self.mingw_success_pattern = "PASSED \(\d+ suites, \d+ tests run\)"
self.selftest_success_pattern = r"\[ All tests (PASS|passed) \]"
self.test_suites_success_pattern = r"100% tests passed, 0 tests failed"
self.mingw_success_pattern = r"PASSED \(\d+ suites, \d+ tests run\)"
self.config_pl_location = os.path.join("scripts", "config.pl")
self.selftest_exe = "selftest.exe"
self.mingw_command = "mingw32-make"
Expand Down Expand Up @@ -182,7 +182,7 @@ def setup_logger(self, name, log_file, level=logging.INFO):
)
console = logging.StreamHandler()
file_handler = logging.FileHandler(log_file)
if name is not "Results":
if name != "Results":
console.setFormatter(log_formatter)
file_handler.setFormatter(log_formatter)
logger = logging.getLogger(name)
Expand Down Expand Up @@ -218,7 +218,7 @@ def get_clean_worktree_for_git_reference(self, logger):
except subprocess.CalledProcessError as error:
self.set_return_code(2)
logger.error(error.output)
raise Exception("Checking out worktree failed, aborting")
raise Exception("Checking out worktree failed, aborting") from error

def cleanup_git_worktree(self, git_worktree_path, logger):
shutil.rmtree(git_worktree_path)
Expand All @@ -235,7 +235,7 @@ def cleanup_git_worktree(self, git_worktree_path, logger):
except subprocess.CalledProcessError as error:
self.set_return_code(2)
logger.error(error.output)
raise Exception("Worktree cleanup failed, aborting")
raise Exception("Worktree cleanup failed, aborting") from error

def set_config_on_code(self, git_worktree_path, logger):
"""Enables all config specified in config.pl, then disables config
Expand Down Expand Up @@ -267,7 +267,7 @@ def set_config_on_code(self, git_worktree_path, logger):
except subprocess.CalledProcessError as error:
self.set_return_code(2)
logger.error(error.output)
raise Exception("Setting config failed, aborting")
raise Exception("Setting config failed, aborting") from error

def generate_seedfile(self, filename):
"""This tests if a file exists, and if not, creates it with 64 bytes
Expand Down Expand Up @@ -308,7 +308,7 @@ def test_mingw_built_code(self):
)
if not self.mingw_result:
self.set_return_code(1)
except Exception as error:
except Exception as error: #pylint: disable=broad-except
self.set_return_code(2)
mingw_logger.error(error)
traceback.print_exc()
Expand Down Expand Up @@ -426,7 +426,7 @@ def run_test_suites_on_built_code(self, solution_dir, test_run, logger):

def get_environment_containing_VSCMD_START_DIR(self, solution_dir):
"""This is done to bypass a 'feature' added in Visual Studio 2017.
If the %USERPROFILE%\Source directory exists, then running
If the %USERPROFILE%\\Source directory exists, then running
vcvarsall.bat will silently change the directory to that directory.
Setting the VSCMD_START_DIR environment variable causes it to change
to that directory instead"""
Expand Down Expand Up @@ -480,7 +480,11 @@ def build_code_using_visual_studio(self,
"msbuild /nodeReuse:false /t:Rebuild /p:Configuration={},Platform={},"
"PlatformToolset={} /m \"{}\"\n".format(
test_run.configuration, test_run.architecture,
retarget, solution_file
retarget,
# The `for solution_file ...` loop has an else clause with
# an unconditional return, so solution_file is always defined
# by this point. Pylint doesn't realize that.
solution_file #pylint: disable=undefined-loop-variable
)
)
msbuild_process.stdin.close()
Expand Down Expand Up @@ -524,7 +528,7 @@ def build_visual_studio_solution_using_cmake(self,
except subprocess.CalledProcessError as error:
self.set_return_code(2)
logger.error(error.output)
raise Exception("Building solution using Cmake failed, aborting")
raise Exception("Building solution using Cmake failed, aborting") from error

def generate_source_files(self, git_worktree_path, logger):
"""Generate configuration-independent source files if required."""
Expand All @@ -551,7 +555,7 @@ def generate_source_files(self, git_worktree_path, logger):
except subprocess.CalledProcessError as error:
self.set_return_code(2)
logger.error(error.output)
raise Exception("{} failed, aborting".format(batch_script))
raise Exception("{} failed, aborting".format(batch_script)) from error

def test_visual_studio_built_code(self, test_run, solution_type):
log_name = "VS{} {} {}{} {}".format(
Expand Down Expand Up @@ -617,7 +621,7 @@ def test_visual_studio_built_code(self, test_run, solution_type):
selftest_code_path, vs_logger
)
test_run.results[solution_type + " selftest"] = selftest_result
except Exception as error:
except Exception as error: #pylint: disable=broad-except
vs_logger.error(error)
traceback.print_exc()
self.set_return_code(2)
Expand Down Expand Up @@ -701,7 +705,7 @@ def run_all_tests(self):
self.test_visual_studio_built_code(
vs_test_run, solution_type
)
except Exception:
except Exception: #pylint: disable=broad-except
traceback.print_exc()
self.set_return_code(2)
finally:
Expand Down