bitcoin/test/lint
Andrew Chow 6912a28f08
Merge bitcoin/bitcoin#25667: assumeutxo: snapshot initialization
bf95976061 doc: add note about snapshot chainstate init (James O'Beirne)
e4d7995286 test: add testcases for snapshot initialization (James O'Beirne)
cced4e7336 test: move-only-ish: factor out LoadVerifyActivateChainstate() (James O'Beirne)
51fc9241c0 test: allow on-disk coins and block tree dbs in tests (James O'Beirne)
3c361391b8 test: add reset_chainstate parameter for snapshot unittests (James O'Beirne)
00b357c215 validation: add ResetChainstates() (James O'Beirne)
3a29dfbfb2 move-only: test: make snapshot chainstate setup reusable (James O'Beirne)
8153bd9247 blockmanager: avoid undefined behavior during FlushBlockFile (James O'Beirne)
ad67ff377c validation: remove snapshot datadirs upon validation failure (James O'Beirne)
34d1590331 add utilities for deleting on-disk leveldb data (James O'Beirne)
252abd1e8b init: add utxo snapshot detection (James O'Beirne)
f9f1735f13 validation: rename snapshot chainstate dir (James O'Beirne)
d14bebf100 db: add StoragePath to CDBWrapper/CCoinsViewDB (James O'Beirne)

Pull request description:

  This is part of the [assumeutxo project](https://github.com/bitcoin/bitcoin/projects/11) (parent PR: https://github.com/bitcoin/bitcoin/pull/15606)

  ---

  Half of the replacement for #24232. The original PR grew larger than expected throughout the review process.

  This change adds the ability to initialize a snapshot-based chainstate during init if one is detected on disk. This is of course unused as of now (aside from in unittests) given that we haven't yet enabled actually loading snapshots.

  Don't be scared! There are some big move-only commits in here.

  Accompanying changes include:

  - moving the snapshot coinsdb directory from being called `chainstate_[base blockhash]` to `chainstate_snapshot`, since we only support one snapshot in use at a time. This simplifies some logic, but it necessitates writing that base blockhash out to a file within the coinsdb dir. See [discussion here](https://github.com/bitcoin/bitcoin/pull/24232#discussion_r832762880).
  - adding a simple fix in `FlushBlockFile()` that avoids a crash when attemping to flush to disk before `LoadBlockIndexDB()` is called, which happens when calling `MaybeRebalanceCaches()` during multiple chainstate init.
  - improving the unittest to allow testing with on-disk chainstates - necessary to test a simulated restart and re-initialization.

ACKs for top commit:
  naumenkogs:
    utACK bf95976061
  ariard:
    Code Review ACK bf9597606
  ryanofsky:
    Code review ACK bf95976061. Changes since last review: rebasing, switching from CAutoFile to AutoFile, adding comments, switching from BOOST_CHECK to Assert in test util, using chainman.GetMutex() in tests, destroying one ChainstateManager before creating a new one in tests
  fjahr:
    utACK bf95976061
  aureleoules:
    ACK bf95976061

Tree-SHA512: 15ae75caf19f8d12a12d2647c52897904d27b265a7af6b4ae7b858592eeadb8f9da6c2394b6baebec90adc28742c053e3eb506119577dae7c1e722ebb3b7bcc0
2022-10-13 10:19:27 -04:00
..
all-lint.py test: clean up all-lint.py 2022-06-07 10:24:55 +02:00
check-doc.py scripted-diff: Bump copyright headers 2020-12-31 09:45:41 +01:00
commit-script-check.sh script: redirecting stderr to stdout before pipelining into grep 2022-01-22 12:36:19 +01:00
git-subtree-check.sh scripted-diff: Bump copyright headers 2021-12-30 19:36:57 +02:00
lint-assertions.py lint: Mention NONFATAL_UNREACHABLE in lint-assertions.py 2022-04-26 10:01:54 +02:00
lint-circular-dependencies.py validation: rename snapshot chainstate dir 2022-09-13 13:30:12 -04:00
lint-files.py refactor: cleanups post unsubtree'ing univalue 2022-06-15 12:56:44 +01:00
lint-format-strings.py refactor: cleanups post unsubtree'ing univalue 2022-06-15 12:56:44 +01:00
lint-git-commit-check.py lint: Convert lint-git-commit-check.sh to Python 2022-04-16 15:43:19 +02:00
lint-include-guards.py refactor: cleanups post unsubtree'ing univalue 2022-06-15 12:56:44 +01:00
lint-includes.py refactor: Drop boost/algorithm/string/replace.hpp dependency 2022-08-08 11:53:23 +01:00
lint-locale-dependence.py Fix issues identified by codespell 2.2.1 and update ignored words 2022-09-15 13:03:40 +02:00
lint-logs.py logging: add LogPrintfCategory to log unconditionally with category 2022-06-08 14:02:54 +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-mutable-default-parameters.py Converted lint-python-mutable-default-parameters.sh to python 2022-04-08 11:53:47 -04:00
lint-python-utf8-encoding.py lint: Convert lint-python-utf8-encoding.sh to Python 2022-04-21 23:26:45 +02:00
lint-python.py lint: Convert Python linter to Python 2022-04-18 00:55:06 +02:00
lint-shell-locale.py refactor: cleanups post unsubtree'ing univalue 2022-06-15 12:56:44 +01:00
lint-shell.py refactor: cleanups post unsubtree'ing univalue 2022-06-15 12:56:44 +01:00
lint-spelling.py refactor: cleanups post unsubtree'ing univalue 2022-06-15 12:56:44 +01:00
lint-submodule.py lint: convert submodule linter test to Python 2022-04-20 05:21:13 +00:00
lint-tests.py Converted lint-tests.sh to python 2022-04-15 10:10:03 -04:00
lint-whitespace.py refactor: cleanups post unsubtree'ing univalue 2022-06-15 12:56:44 +01:00
README.md refactor: cleanups post unsubtree'ing univalue 2022-06-15 12:56:44 +01:00
run-lint-format-strings.py Move lint script and data file to avoid lint- prefix 2022-04-04 16:58:07 +02:00
spelling.ignore-words.txt Fix issues identified by codespell 2.2.1 and update ignored words 2022-09-15 13:03:40 +02:00

This folder contains lint scripts.

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

all-lint.py

Calls other scripts with the lint- prefix.