mirrors/bitcoin
1
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2024-11-19 01:42:58 +01:00
Code Issues Projects Releases Wiki Activity
b0222bbb49
bitcoin/test/lint
History
Ava Chow 7640cfdd62
Merge bitcoin/bitcoin#31118: doc: replace -? with -h and -help 
33a28e252a Change default help arg to `-help` and mention `-h` and `-?` as alternatives (Lőrinc)
f0130ab1a1 doc: replace `-?` with `-h` for bench_bitcoin help (Lőrinc)

Pull request description:

  The question mark is interpreted as a wildcard for any single character in Zsh (see https://www.techrepublic.com/article/globbing-wildcard-characters-with-zsh), so `bench_bitcoin -?` will not show the help message on systems using Zsh, such as macOS.

  Since `-h` provides equivalent help functionality (as defined in https://github.com/bitcoin/bitcoin/blob/master/src/common/args.cpp#L684-L693), the `benchmarking.md` documentation has been updated to ensure compatibility with macOS.

  ----

  ### -?
  > % cmake -B build -DBUILD_BENCH=ON && cmake --build build && build/src/bench/bench_bitcoin -?
  zsh: no matches found: -?

  ### -h
  > % cmake -B build -DBUILD_BENCH=ON && cmake --build build && build/src/bench/bench_bitcoin -h
  Usage:  bench_bitcoin [options]
  Options:
  ...

  ----

  Based on the comments the args help default was also changed to `-help`, mentioning `-h` and `-?` (instead of `-?` being the default)

ACKs for top commit:
  edilmedeiros:
    tACK 33a28e252a
  maflcko:
    lgtm ACK 33a28e252a
  achow101:
    ACK 33a28e252a
  rkrux:
    tACK 33a28e252a
  laanwj:
    Code review ACK 33a28e252a

Tree-SHA512: 8c6e27488462be9ba9186b34abe6249c1d93026b3963acc0f42c75496f39407563766ae518cf1839156039cc0047e29d91f70d191cfb97e0fbde85665e88c71e
2024-10-24 18:01:41 -04:00
..
test_runner doc: lint: correct outdated comment (s/Makefile.am/CMakeLists.txt/) 2024-10-10 12:25:14 +02: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
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 external_signer: replace boost::process with cpp-subprocess 2024-03-27 14:16:37 +00:00
lint-locale-dependence.py
lint-python-dead-code.py
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
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
lint-tests.py
README.md lint: Speed up flake8 checks 2024-08-29 07:03:42 +02:00
run-lint-format-strings.py log: Use ConstevalFormatString 2024-09-17 18:21:23 +02: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