mirrors/bitcoin
1
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2025-01-19 05:45:05 +01:00
Code Issues Projects Releases Wiki Activity
62bd61de11
bitcoin/test/lint
History
Ryan Ofsky 676936845b
Merge bitcoin/bitcoin#30933: test: Prove+document ConstevalFormatString/tinyformat parity 
c93bf0e6e2 test: Add missing %c character test (Hodlinator)
76cca4aa6f test: Document non-parity between tinyformat and ConstevalFormatstring (Hodlinator)
533013cba2 test: Prove+document ConstevalFormatString/tinyformat parity (Hodlinator)
b81a465995 refactor test: Profit from using namespace + using detail function (Hodlinator)

Pull request description:

  Clarifies and puts the extent of parity under test.

  Broken out from #30546 based on https://github.com/bitcoin/bitcoin/pull/30546#discussion_r1755013263 and https://github.com/bitcoin/bitcoin/pull/30546#discussion_r1756495304.

ACKs for top commit:
  maflcko:
    re-ACK c93bf0e6e2 🗜
  l0rinc:
    ACK c93bf0e6e2
  ryanofsky:
    Code review ACK c93bf0e6e2. Just a few cleanups tweaking function declarations and commit comments and consolidating some test cases since last review.

Tree-SHA512: 5ecc893b26cf2761c0009861be392ec4c4fceb0ef95052a2f6f9df76b2e459cfb3f9e257f61be07c3bb2ecc6e525e72c5ca853be1f63b70b52785323d3db6b42
2024-12-10 22:05:03 -05:00
..
test_runner Merge bitcoin/bitcoin#31417: test: Avoid F541 (f-string without any placeholders) 2024-12-06 10:26:58 +00:00
check-doc.py Change default help arg to -help and mention -h and -? as alternatives 2024-10-21 11:08:51 +02:00
commit-script-check.sh lint: commit-script-check.sh: echo to stderr 2024-10-09 18:00:42 +02:00
git-subtree-check.sh scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
lint_ignore_dirs.py test: Refactor subtree exclusion in lint tests 2024-03-26 13:49:47 +03:00
lint-assertions.py rpc: Use CHECK_NONFATAL over Assert 2024-07-12 09:27:41 +02:00
lint-circular-dependencies.py refactor: Remove unused circular include dependency from validation.cpp 2023-11-01 17:45:48 +01:00
lint-files.py test: use built-in collection types for type hints (Python 3.9 / PEP 585) 2023-10-25 01:10:21 +02:00
lint-format-strings.py Remove redundant unterminated-logprintf tidy check 2024-10-01 11:34:22 +02:00
lint-git-commit-check.py lint: Fix COMMIT_RANGE issues 2024-03-21 20:15:08 +01:00
lint-include-guards.py test: Refactor subtree exclusion in lint tests 2024-03-26 13:49:47 +03:00
lint-includes.py Remove wallet::ParseISO8601DateTime, use ParseISO8601DateTime instead 2024-12-02 15:09:31 +01:00
lint-locale-dependence.py fuzz: Remove legacy int parse fuzz tests 2023-03-27 16:37:31 +02:00
lint-python-dead-code.py lint: Convert Python dead code linter to Python 2022-04-06 00:55:22 +02:00
lint-python-utf8-encoding.py lint: Ignore check_fileopens failure on **kwargs 2023-07-20 09:15:43 +02:00
lint-python.py lint: Speed up flake8 checks 2024-08-29 07:03:42 +02:00
lint-qt-translation.py lint: Add lint-qt-translation.py 2023-10-23 15:07:02 +01:00
lint-shell-locale.py refactor: cleanups post unsubtree'ing univalue 2022-06-15 12:56:44 +01:00
lint-shell.py lint: Include test_utxo_snapshots in lint_shell 2023-10-13 14:06:06 +02:00
lint-spelling.py doc: Updating docs from autotools to cmake 2024-09-18 11:04:52 -04:00
lint-submodule.py scripted-diff: Use new python 3.7 keywords 2023-01-18 13:00:34 +01:00
lint-tests.py scripted-diff: Use new python 3.7 keywords 2023-01-18 13:00:34 +01:00
README.md lint: Speed up flake8 checks 2024-08-29 07:03:42 +02:00
run-lint-format-strings.py test: Document non-parity between tinyformat and ConstevalFormatstring 2024-12-06 21:56:16 +01:00
spelling.ignore-words.txt Update spelling.ignore-words 2024-08-28 18:42:19 +02:00

README.md

This folder contains lint scripts.

Running locally

To run linters locally with the same versions as the CI environment, use the included Dockerfile:

DOCKER_BUILDKIT=1 docker build -t bitcoin-linter --file "./ci/lint_imagefile" ./ && docker run --rm -v $(pwd):/bitcoin -it bitcoin-linter

Building the container can be done every time, because it is fast when the result is cached and it prevents issues when the image changes.

test runner

To run all the lint checks in the test runner outside the docker you first need to install the rust toolchain using your package manager of choice or rustup.

Then you can use:

( cd ./test/lint/test_runner/ && cargo fmt && cargo clippy && RUST_BACKTRACE=1 cargo run )

If you wish to run individual lint checks, run the test_runner with --lint=TEST_TO_RUN arguments. If running with cargo run, arguments after -- are passed to the binary you are running e.g.:

( cd ./test/lint/test_runner/ && RUST_BACKTRACE=1 cargo run -- --lint=doc --lint=trailing_whitespace )

To see a list of all individual lint checks available in test_runner, use -h or --help:

( cd ./test/lint/test_runner/ && RUST_BACKTRACE=1 cargo run -- --help )

Dependencies

Lint test Dependency
lint-python.py lief
lint-python.py mypy
lint-python.py pyzmq
lint-python-dead-code.py vulture
lint-shell.py ShellCheck
lint-spelling.py codespell
py_lint ruff
markdown link check mlc

In use versions and install instructions are available in the CI setup.

Please be aware that on Linux distributions all dependencies are usually available as packages, but could be outdated.

Running the tests

Individual tests can be run by directly calling the test script, e.g.:

test/lint/lint-files.py

check-doc.py

Check for missing documentation of command line options.

commit-script-check.sh

Verification of scripted diffs. Scripted diffs are only assumed to run on the latest LTS release of Ubuntu. Running them on other operating systems might require installing GNU tools, such as GNU sed.

git-subtree-check.sh

Run this script from the root of the repository to verify that a subtree matches the contents of the commit it claims to have been updated to.

Usage: test/lint/git-subtree-check.sh [-r] DIR [COMMIT]
       test/lint/git-subtree-check.sh -?
  • DIR is the prefix within the repository to check.
  • COMMIT is the commit to check, if it is not provided, HEAD will be used.
  • -r checks that subtree commit is present in repository.

To do a full check with -r, make sure that you have fetched the upstream repository branch in which the subtree is maintained:

To do so, add the upstream repository as remote:

git remote add --fetch secp256k1 https://github.com/bitcoin-core/secp256k1.git

lint_ignore_dirs.py

Add list of common directories to ignore when running tests