diff options
| -rw-r--r-- | .pylintrc | 8 | ||||
| -rw-r--r-- | docs/getting-started/new_project_guide.md | 9 | ||||
| -rw-r--r-- | infra/base-images/base-builder/bisect_clang.py | 5 | ||||
| -rwxr-xr-x | infra/base-images/base-runner/coverage | 2 | ||||
| -rw-r--r-- | infra/build/functions/build_and_run_coverage.py | 2 | ||||
| -rw-r--r-- | infra/cifuzz/fuzz_target_test.py | 6 | ||||
| -rwxr-xr-x | infra/presubmit.py | 2 |
7 files changed, 16 insertions, 18 deletions
@@ -5,11 +5,11 @@ # run arbitrary code. extension-pkg-whitelist= -# Add files or directories to the blacklist. They should be base names, not +# Add files or directories to the blocklist. They should be base names, not # paths. ignore=CVS,base-clang,base-sanitizer-libs-builder -# Add files or directories matching the regex patterns to the blacklist. The +# Add files or directories matching the regex patterns to the blocklist. The # regex matches against base names, not paths. ignore-patterns= @@ -444,8 +444,8 @@ allow-global-unused-variables=yes callbacks=cb_, _cb -# A regular expression matching the name of dummy variables (i.e. expected to -# not be used). +# A regular expression matching the name of placeholder variables (i.e. expected +# to not be used). dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ # Argument names that match this expression will be ignored. Default to name diff --git a/docs/getting-started/new_project_guide.md b/docs/getting-started/new_project_guide.md index 71a886aa..3d113c9c 100644 --- a/docs/getting-started/new_project_guide.md +++ b/docs/getting-started/new_project_guide.md @@ -39,7 +39,7 @@ Before you can start setting up your new project for fuzzing, you must do the fo [docker-cleanup](https://gist.github.com/mikea/d23a839cba68778d94e0302e8a2c200f) periodically to garbage-collect unused images. -- (optional) [Install gsutil](https://cloud.google.com/storage/docs/gsutil_install) for local code coverage sanity check. +- (optional) [Install gsutil](https://cloud.google.com/storage/docs/gsutil_install) for local code coverage testing. For Google internal (gLinux) machines, please refer [here](https://cloud.google.com/storage/docs/gsutil_install#deb) instead. ## Creating the file structure @@ -325,10 +325,9 @@ You can build your docker image and fuzz targets locally, so you can test them b $ python infra/helper.py run_fuzzer $PROJECT_NAME <fuzz_target> --corpus-dir=<path-to-temp-corpus-dir> ``` -4. We recommend taking a look at your code coverage as a sanity check to make -sure that your fuzz targets get to the code you expect. This would use the -corpus generated from the previous `run_fuzzer` step in your local corpus -directory. +4. We recommend taking a look at your code coverage as a test to ensure that +your fuzz targets get to the code you expect. This would use the corpus +generated from the previous `run_fuzzer` step in your local corpus directory. ```bash $ python infra/helper.py build_fuzzers --sanitizer coverage $PROJECT_NAME diff --git a/infra/base-images/base-builder/bisect_clang.py b/infra/base-images/base-builder/bisect_clang.py index 8c530b62..2e2c0e49 100644 --- a/infra/base-images/base-builder/bisect_clang.py +++ b/infra/base-images/base-builder/bisect_clang.py @@ -64,7 +64,7 @@ class GitRepo: def test_commit(self, test_command): """Build LLVM at the currently checkedout commit, then run |test_command|. If returncode is 0 run 'git bisect good' otherwise return 'git bisect bad'. - Return None if bisect didn't terminate yet. Return the culprit commit if it + Return None if bisect didn't finish yet. Return the culprit commit if it does.""" build_clang(self.repo_dir) retcode, _, _ = execute(test_command, shell=True, expect_zero=False) @@ -208,8 +208,7 @@ def main(): 8288453f6aac05080b751b680455349e09d49825 """ # pylint: enable=line-too-long - # TODO(metzman): Sanity check CFLAGS for things like - # -fsanitize=fuzzer-no-link. + # TODO(metzman): Check CFLAGS for things like -fsanitize=fuzzer-no-link. # TODO(metzman): Allow test_command to be optional and for just build.sh to be # used instead. test_command = sys.argv[1] diff --git a/infra/base-images/base-runner/coverage b/infra/base-images/base-runner/coverage index 41142276..2fcf9e97 100755 --- a/infra/base-images/base-runner/coverage +++ b/infra/base-images/base-runner/coverage @@ -64,7 +64,7 @@ function run_fuzz_target { local profdata_file="$DUMPS_DIR/$target.profdata" local corpus_real="/corpus/${target}" - # -merge=1 requires an output directory, create a dummy dir for that. + # -merge=1 requires an output directory, create a new, empty dir for that. local corpus_dummy="$OUT/dummy_corpus_dir_for_${target}" rm -rf $corpus_dummy && mkdir -p $corpus_dummy diff --git a/infra/build/functions/build_and_run_coverage.py b/infra/build/functions/build_and_run_coverage.py index c1b693c2..71d7338f 100644 --- a/infra/build/functions/build_and_run_coverage.py +++ b/infra/build/functions/build_and_run_coverage.py @@ -162,7 +162,7 @@ def get_build_steps(project_name, project_yaml_file, dockerfile_lines, type='reports', date=report_date) - # Delete the existing report as gsutil cannot overwrite it in a sane way due + # Delete the existing report as gsutil cannot overwrite it in a useful way due # to the lack of `-T` option (it creates a subdir in the destination dir). build_steps.append(build_lib.gsutil_rm_rf_step(upload_report_url)) build_steps.append({ diff --git a/infra/cifuzz/fuzz_target_test.py b/infra/cifuzz/fuzz_target_test.py index 8f72f32c..e8ec1241 100644 --- a/infra/cifuzz/fuzz_target_test.py +++ b/infra/cifuzz/fuzz_target_test.py @@ -49,7 +49,7 @@ class IsReproducibleTest(fake_filesystem_unittest.TestCase): """Tests the is_reproducible method in the fuzz_target.FuzzTarget class.""" def setUp(self): - """Sets up dummy fuzz target to test is_reproducible method.""" + """Sets up example fuzz target to test is_reproducible method.""" self.fuzz_target_path = '/example/path' self.testcase_path = '/testcase' self.test_target = fuzz_target.FuzzTarget(self.fuzz_target_path, @@ -115,7 +115,7 @@ class GetTestCaseTest(unittest.TestCase): """Tests get_testcase.""" def setUp(self): - """Sets up dummy fuzz target to test get_testcase method.""" + """Sets up example fuzz target to test get_testcase method.""" self.test_target = fuzz_target.FuzzTarget('/example/path', 10, '/example/outdir') @@ -180,7 +180,7 @@ class IsCrashReportableTest(fake_filesystem_unittest.TestCase): """Tests the is_crash_reportable method of FuzzTarget.""" def setUp(self): - """Sets up dummy fuzz target to test is_crash_reportable method.""" + """Sets up example fuzz target to test is_crash_reportable method.""" self.fuzz_target_path = '/example/do_stuff_fuzzer' self.test_target = fuzz_target.FuzzTarget(self.fuzz_target_path, 100, '/example/outdir', 'example') diff --git a/infra/presubmit.py b/infra/presubmit.py index 653fa534..268a1149 100755 --- a/infra/presubmit.py +++ b/infra/presubmit.py @@ -199,7 +199,7 @@ class ProjectYamlChecker: if auto_ccs: email_addresses.extend(auto_ccs) - # Sanity check them. + # Check that email addresses seem normal. for email_address in email_addresses: if '@' not in email_address or '.' not in email_address: self.error(email_address + ' is an invalid email address.') |