kata-containers/rust-vmm-ci
1
0
Fork 0
mirror of https://github.com/rust-vmm/rust-vmm-ci.git synced 2026-08-05 03:08:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

test: Format with black

Browse Source 
Signed-off-by: Jonathan Woollett-Light <jcawl@amazon.co.uk>
This commit is contained in:
Jonathan Woollett-Light
2023-06-05 09:55:04 +01:00
committed by Jonathan Woollett-Light
parent 285971e8c7
commit 56bfdc97bb
8 changed files with 198 additions and 194 deletions
Download Patch File Download Diff File Expand all files Collapse all files
integration_tests/conftest.py
+4 -10
View File
@@ -15,28 +15,22 @@ def pytest_addoption(parser):
"--profile",
default=PROFILE_CI,
choices=[PROFILE_CI, PROFILE_DEVEL],
help="Profile for running the test: {} or {}".format(
PROFILE_CI,
PROFILE_DEVEL
)
help="Profile for running the test: {} or {}".format(PROFILE_CI, PROFILE_DEVEL),
)
parser.addoption(
"--no-cleanup",
action="store_true",
default=False,
help="Keep the coverage report in `kcov_output` directory. If this "
"flag is not provided, both coverage related directories are "
"removed."
"flag is not provided, both coverage related directories are "
"removed.",
)
parser.addoption(
"--test-scope",
default=WORKSPACE,
choices=[WORKSPACE, CRATE],
help="Defines the scope of running tests: {} or {}".format(
WORKSPACE,
CRATE
)
help="Defines the scope of running tests: {} or {}".format(WORKSPACE, CRATE),
)
integration_tests/test_benchmark.py
+28 -32
View File
@@ -14,14 +14,12 @@ import subprocess
from utils import get_repo_root_path
REMOTE = \
os.environ.get('BUILDKITE_REPO') or \
os.environ.get('REMOTE') or \
"origin"
BASE_BRANCH = \
os.environ.get('BUILDKITE_PULL_REQUEST_BASE_BRANCH') or \
os.environ.get('BASE_BRANCH') or \
"main"
REMOTE = os.environ.get("BUILDKITE_REPO") or os.environ.get("REMOTE") or "origin"
BASE_BRANCH = (
os.environ.get("BUILDKITE_PULL_REQUEST_BASE_BRANCH")
or os.environ.get("BASE_BRANCH")
or "main"
)
# File used for saving the results of cargo bench
# when running on the PR branch.
PR_BENCH_RESULTS_FILE = "pr_bench_results"
@@ -67,12 +65,9 @@ def test_bench():
# This is a bit of a &*%^ way of checking if the benchmark does not
# exist. Hopefully it will be possible to check it in another way
# ...soon
print(
"There are no benchmarks in main. No comparison can happen."
)
print("There are no benchmarks in main. No comparison can happen.")
else:
assert return_code == 0, "stdout: {}\n stderr: {}".format(
stdout, stderr)
assert return_code == 0, "stdout: {}\n stderr: {}".format(stdout, stderr)
def _run_cargo_bench(baseline):
@@ -80,43 +75,44 @@ def _run_cargo_bench(baseline):
process = subprocess.run(
"cargo bench --bench main --all-features -- --noplot "
"--save-baseline {}".format(baseline),
shell=True, stderr=subprocess.PIPE, stdout=subprocess.PIPE
shell=True,
stderr=subprocess.PIPE,
stdout=subprocess.PIPE,
)
return process.returncode, process.stdout.decode('utf-8'),\
process.stderr.decode('utf-8')
return (
process.returncode,
process.stdout.decode("utf-8"),
process.stderr.decode("utf-8"),
)
def _run_critcmp():
p = subprocess.run(
"critcmp {} {}".format(
UPSTREAM_BENCH_RESULTS_FILE, PR_BENCH_RESULTS_FILE
),
shell=True, check=True,
"critcmp {} {}".format(UPSTREAM_BENCH_RESULTS_FILE, PR_BENCH_RESULTS_FILE),
shell=True,
check=True,
stdout=subprocess.PIPE,
stderr=subprocess.PIPE
stderr=subprocess.PIPE,
)
print(p.stdout.decode('utf-8'))
print('ERRORS')
print(p.stderr.decode('utf-8'))
print(p.stdout.decode("utf-8"))
print("ERRORS")
print(p.stderr.decode("utf-8"))
def _git_checkout_upstream_branch():
subprocess.run(
"git fetch {} {}".format(REMOTE, BASE_BRANCH),
shell=True, check=True
)
subprocess.run(
"git checkout FETCH_HEAD",
shell=True, check=True
"git fetch {} {}".format(REMOTE, BASE_BRANCH), shell=True, check=True
)
subprocess.run("git checkout FETCH_HEAD", shell=True, check=True)
def _git_checkout_pr_branch():
subprocess.run(
"git checkout -",
shell=True, check=True,
shell=True,
check=True,
stdout=subprocess.PIPE,
stderr=subprocess.PIPE
stderr=subprocess.PIPE,
)
integration_tests/test_commit_format.py
+28 -27
View File
@@ -16,14 +16,12 @@ from utils import get_cmd_output
COMMIT_TITLE_MAX_LEN = 60
COMMIT_BODY_LINE_MAX_LEN = 75
REMOTE = \
os.environ.get('BUILDKITE_REPO') or \
os.environ.get('REMOTE') or \
"origin"
BASE_BRANCH = \
os.environ.get('BUILDKITE_PULL_REQUEST_BASE_BRANCH') or \
os.environ.get('BASE_BRANCH') or \
"main"
REMOTE = os.environ.get("BUILDKITE_REPO") or os.environ.get("REMOTE") or "origin"
BASE_BRANCH = (
os.environ.get("BUILDKITE_PULL_REQUEST_BASE_BRANCH")
or os.environ.get("BASE_BRANCH")
or "main"
)
def test_commit_format():
@@ -50,8 +48,7 @@ def test_commit_format():
) from None
# Get hashes of PR's commits in their abbreviated form for
# a prettier printing.
shas_cmd = "git log --no-merges --pretty=%h --no-decorate " \
"FETCH_HEAD..HEAD"
shas_cmd = "git log --no-merges --pretty=%h --no-decorate " "FETCH_HEAD..HEAD"
shas = get_cmd_output(shas_cmd)
for sha in shas.split():
@@ -63,18 +60,20 @@ def test_commit_format():
message_cmd = "git show --pretty=format:%B -s " + sha
message = get_cmd_output(message_cmd)
message_lines = message.split("\n")
assert len(message_lines) >= 3,\
"The commit '{}' should contain at least 3 lines: title, " \
"blank line and a sign-off one." \
.format(sha)
assert len(message_lines) >= 3, (
"The commit '{}' should contain at least 3 lines: title, "
"blank line and a sign-off one.".format(sha)
)
title = message_lines[0]
assert message_lines[1] == "",\
"For commit '{}', title is divided into multiple lines. " \
"Please keep it one line long and make sure you add a blank " \
assert message_lines[1] == "", (
"For commit '{}', title is divided into multiple lines. "
"Please keep it one line long and make sure you add a blank "
"line between title and description.".format(sha)
assert len(title) <= COMMIT_TITLE_MAX_LEN,\
"For commit '{}', title exceeds {} chars. " \
)
assert len(title) <= COMMIT_TITLE_MAX_LEN, (
"For commit '{}', title exceeds {} chars. "
"Please keep it shorter.".format(sha, COMMIT_TITLE_MAX_LEN)
)
found_signed_off = False
@@ -85,11 +84,13 @@ def test_commit_format():
# the commit message ended and we don't want to check
# line lengths anymore for the current commit.
break
assert len(line) <= COMMIT_BODY_LINE_MAX_LEN,\
"For commit '{}', message line '{}' exceeds {} chars. " \
"Please keep it shorter or split it in " \
"multiple lines.".format(sha, line,
COMMIT_BODY_LINE_MAX_LEN)
assert found_signed_off, "Commit '{}' is not signed. " \
"Please run 'git commit -s --amend' " \
"on it.".format(sha)
assert len(line) <= COMMIT_BODY_LINE_MAX_LEN, (
"For commit '{}', message line '{}' exceeds {} chars. "
"Please keep it shorter or split it in "
"multiple lines.".format(sha, line, COMMIT_BODY_LINE_MAX_LEN)
)
assert found_signed_off, (
"Commit '{}' is not signed. "
"Please run 'git commit -s --amend' "
"on it.".format(sha)
)
integration_tests/test_coverage.py
+34 -38
View File
@@ -51,15 +51,16 @@ def _read_test_config():
assert "exclude_path" in coverage_config
assert "crate_features" in coverage_config
assert ' ' not in coverage_config["crate_features"], \
"spaces are not allowed in crate_features value"
assert (
" " not in coverage_config["crate_features"]
), "spaces are not allowed in crate_features value"
return coverage_config
def _write_coverage_config(coverage_config):
"""Updates the coverage config file as per `coverage_config`"""
with open(COVERAGE_CONFIG_PATH, 'w') as outfile:
with open(COVERAGE_CONFIG_PATH, "w") as outfile:
json.dump(coverage_config, outfile)
@@ -78,48 +79,43 @@ def _get_current_coverage(coverage_config, no_cleanup, test_scope):
shutil.rmtree(kcov_output_dir, ignore_errors=True)
shutil.rmtree(kcov_build_dir, ignore_errors=True)
exclude_pattern = (
'${CARGO_HOME:-$HOME/.cargo/},'
'usr/lib/,'
'lib/'
)
exclude_pattern = "${CARGO_HOME:-$HOME/.cargo/}," "usr/lib/," "lib/"
exclude_region = "'mod tests {'"
additional_exclude_path = coverage_config["exclude_path"]
if additional_exclude_path:
exclude_pattern += ',' + additional_exclude_path
exclude_pattern += "," + additional_exclude_path
additional_kcov_param = ''
additional_kcov_param = ""
if test_scope == pytest.workspace:
additional_kcov_param += '--all '
additional_kcov_param += "--all "
crate_features = coverage_config["crate_features"]
if crate_features:
additional_kcov_param += '--features=' + crate_features
additional_kcov_param += "--features=" + crate_features
kcov_cmd = "CARGO_TARGET_DIR={} cargo kcov {} " \
"--output {} -- " \
"--exclude-region={} " \
"--exclude-pattern={} " \
"--verify".format(
kcov_build_dir,
additional_kcov_param,
kcov_output_dir,
exclude_region,
exclude_pattern
)
kcov_cmd = (
"CARGO_TARGET_DIR={} cargo kcov {} "
"--output {} -- "
"--exclude-region={} "
"--exclude-pattern={} "
"--verify".format(
kcov_build_dir,
additional_kcov_param,
kcov_output_dir,
exclude_region,
exclude_pattern,
)
)
# Pytest closes stdin by default, but some tests might need it to be open.
# In the future, should the need arise, we can feed custom data to stdin.
subprocess.run(kcov_cmd, shell=True, check=True, input=b'')
subprocess.run(kcov_cmd, shell=True, check=True, input=b"")
# Read the coverage reported by kcov.
coverage_file = os.path.join(kcov_output_dir, 'index.js')
coverage_file = os.path.join(kcov_output_dir, "index.js")
with open(coverage_file) as cov_output:
coverage = float(re.findall(
r'"covered":"(\d+\.\d)"',
cov_output.read()
)[0])
coverage = float(re.findall(r'"covered":"(\d+\.\d)"', cov_output.read())[0])
# Remove coverage related directories.
# If user provided `--no-cleanup` flag, `kcov_output_dir`
@@ -140,14 +136,12 @@ def test_coverage(profile, no_cleanup, test_scope):
if previous_coverage < current_coverage:
if profile == pytest.profile_ci:
# In the CI Profile we expect the coverage to be manually updated.
assert False, \
"Coverage is increased from {} to {}. " \
"Please update the coverage in coverage_config_{}.json."\
.format(
previous_coverage,
current_coverage,
platform.machine()
assert False, (
"Coverage is increased from {} to {}. "
"Please update the coverage in coverage_config_{}.json.".format(
previous_coverage, current_coverage, platform.machine()
)
)
elif profile == pytest.profile_devel:
coverage_config["coverage_score"] = current_coverage
_write_coverage_config(coverage_config)
@@ -157,5 +151,7 @@ def test_coverage(profile, no_cleanup, test_scope):
# `pytest_addoption`.
assert False, "Invalid test profile."
elif previous_coverage > current_coverage:
assert False, "Coverage drops by {:.2f}%. Please add unit tests for " \
"the uncovered lines.".format(diff)
assert False, (
"Coverage drops by {:.2f}%. Please add unit tests for "
"the uncovered lines.".format(diff)
)
integration_tests/utils.py
+2 -3
View File
@@ -15,7 +15,6 @@ def get_repo_root_path():
def get_cmd_output(cmd):
"""Returns stdout content of `cmd` command."""
cmd_out = subprocess.run(cmd, shell=True, check=True,
stdout=subprocess.PIPE)
stdout = cmd_out.stdout.decode('utf-8')
cmd_out = subprocess.run(cmd, shell=True, check=True, stdout=subprocess.PIPE)
stdout = cmd_out.stdout.decode("utf-8")
return stdout