diff options
author | Hervé Beraud <hberaud@redhat.com> | 2020-07-21 13:39:30 +0200 |
---|---|---|
committer | Hervé Beraud <hberaud@redhat.com> | 2020-09-15 17:10:31 +0200 |
commit | 2f4cb354f773d1236289bd7e0e00cdc5cea30020 (patch) | |
tree | 40c8c49350479edbec58c12c0f7563a60004e8cd | |
parent | aaf3a726ba8a941ee1c834e4be7acd68516b4362 (diff) | |
download | oslotest-2f4cb354f773d1236289bd7e0e00cdc5cea30020.tar.gz |
Adding pre-commit
Introduced changes:
- pre-commit config and rules
- Add pre-commit to pep8 gate, Flake8 is covered in the pre-commit hooks.
- Applying fixes for pre-commit compliance in all code.
Also commit hash will be used instead of version tags in pre-commit to
prevend arbitrary code from running in developer's machines.
pre-commit will be used to:
- trailing whitespace;
- Replaces or checks mixed line ending (mixed-line-ending);
- Forbid files which have a UTF-8 byte-order marker (check-byte-order-marker);
- Checks that non-binary executables have a proper
shebang (check-executables-have-shebangs);
- Check for files that contain merge conflict strings (check-merge-conflict);
- Check for debugger imports and py37+ breakpoint()
calls in python source (debug-statements);
- Attempts to load all yaml files to verify syntax (check-yaml);
- Run flake8 checks (flake8) (local)
For further details about tests please refer to:
https://github.com/pre-commit/pre-commit-hooks
Change-Id: Icd2a9bded756b2bcba1fb7da6abe48503fd9b2d6
Signed-off-by: Moisés Guimarães de Medeiros <moguimar@redhat.com>
-rw-r--r-- | .pre-commit-config.yaml | 35 | ||||
-rw-r--r--[-rwxr-xr-x] | doc/source/conf.py | 1 | ||||
-rw-r--r-- | test-requirements.txt | 2 | ||||
-rwxr-xr-x | tools/oslo_run_pre_release_tests | 7 | ||||
-rw-r--r-- | tox.ini | 2 |
5 files changed, 43 insertions, 4 deletions
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..9d94556 --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,35 @@ +# We from the Oslo project decided to pin repos based on the +# commit hash instead of the version tag to prevend arbitrary +# code from running in developer's machines. To update to a +# newer version, run `pre-commit autoupdate` and then replace +# the newer versions with their commit hash. + +default_language_version: + python: python3 + +repos: + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: ebc15addedad713c86ef18ae9632c88e187dd0af # v3.1.0 + hooks: + - id: trailing-whitespace + # Replaces or checks mixed line ending + - id: mixed-line-ending + args: ['--fix', 'lf'] + exclude: '.*\.(svg)$' + # Forbid files which have a UTF-8 byte-order marker + - id: check-byte-order-marker + # Checks that non-binary executables have a proper shebang + - id: check-executables-have-shebangs + # Check for files that contain merge conflict strings. + - id: check-merge-conflict + # Check for debugger imports and py37+ breakpoint() + # calls in python source + - id: debug-statements + - id: check-yaml + files: .*\.(yaml|yml)$ + - repo: https://gitlab.com/pycqa/flake8 + rev: 181bb46098dddf7e2d45319ea654b4b4d58c2840 # 3.8.3 + hooks: + - id: flake8 + additional_dependencies: + - hacking>=3.0.1,<3.1.0 diff --git a/doc/source/conf.py b/doc/source/conf.py index 789874b..6d034ed 100755..100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -1,4 +1,5 @@ # -*- coding: utf-8 -*- +# Copyright (C) 2020 Red Hat, Inc. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. diff --git a/test-requirements.txt b/test-requirements.txt index 758471d..60dd8fd 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -11,3 +11,5 @@ coverage!=4.4,>=4.0 # Apache-2.0 oslo.config>=5.2.0 # Apache-2.0 stestr>=2.0.0 + +pre-commit>=2.6.0 # MIT diff --git a/tools/oslo_run_pre_release_tests b/tools/oslo_run_pre_release_tests index 4fc0d5c..378a0db 100755 --- a/tools/oslo_run_pre_release_tests +++ b/tools/oslo_run_pre_release_tests @@ -26,8 +26,7 @@ import pkg_resources def find_all_projects(repo_root): - """Scan the checked out repositories for all available projects. - """ + """Scan the checked out repositories for all available projects.""" pattern = os.path.join(repo_root, 'openstack/*') candidates = glob.glob(pattern) prefix_len = len(repo_root) @@ -39,7 +38,9 @@ def find_all_projects(repo_root): def find_consuming_projects(lib_name, repo_root, projects): - """Filter the list of projects to only include entries that use the library. + """Filter the list of projects + + Filter the list of projects to only include entries that use the library. """ for p in projects: consumer = False @@ -12,7 +12,7 @@ deps = commands = stestr run --slowest {posargs} [testenv:pep8] -commands = flake8 +commands = pre-commit run -a [testenv:cover] setenv = |