Skip to content

feat(test): add file/line to Env#6276

Merged
bthomee merged 11 commits intoXRPLF:developfrom
mvadari:env-file-loc
Feb 6, 2026
Merged

feat(test): add file/line to Env#6276
bthomee merged 11 commits intoXRPLF:developfrom
mvadari:env-file-loc

Conversation

@mvadari
Copy link
Copy Markdown
Collaborator

@mvadari mvadari commented Jan 23, 2026

High Level Overview of Change

This PR uses std::source_location to add to test Env error output the file and line location of the call that triggered the failed transaction.

There is no change to the source code.

Context of Change

Improved test logging, easier debugging

Type of Change

  • New feature (non-breaking change which adds functionality)

API Impact

N/A

Test Plan

I used this commit to help me debug a test failure in another branch.

Copilot AI review requested due to automatic review settings January 23, 2026 21:02
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR enhances test debugging by adding source location information (file and line number) to test environment error messages using C++20's std::source_location. When test transactions fail, the error output will now include the exact file and line where the test was invoked.

Changes:

  • Adds std::source_location parameters to submit(), sign_and_submit(), and postconditions() methods to capture call site location
  • Introduces WithSourceLoc wrapper struct to enable implicit conversion with source location capture for variadic template methods
  • Updates error messages to include file and line information in the format (filename:line)

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
src/test/jtx/Env.h Adds WithSourceLoc wrapper struct and updates method signatures to accept source location parameters
src/test/jtx/impl/Env.cpp Implements source location threading through submission methods and formats location info in error messages

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@codecov
Copy link
Copy Markdown

codecov bot commented Jan 23, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 79.9%. Comparing base (677758b) to head (f411ccd).
⚠️ Report is 2 commits behind head on develop.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##           develop   #6276   +/-   ##
=======================================
  Coverage     79.9%   79.9%           
=======================================
  Files          840     840           
  Lines        65483   65483           
  Branches      7255    7251    -4     
=======================================
+ Hits         52311   52319    +8     
+ Misses       13172   13164    -8     

see 3 files with indirect coverage changes

Impacted file tree graph

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copilot AI review requested due to automatic review settings January 28, 2026 21:06
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@mvadari mvadari added the Needs additional review PR requires at least one more code review approval before it can be merged label Jan 28, 2026
@mvadari mvadari requested a review from Copilot January 28, 2026 22:16
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines +66 to +72
WithSourceLoc(Json::Value v, std::source_location l = std::source_location::current()) : value(std::move(v)), loc(l)
{
}

WithSourceLoc(JTx v, std::source_location l = std::source_location::current()) : value(std::move(v)), loc(l)
{
}
Copy link

Copilot AI Jan 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Both constructors can be implemented more concisely on a single line since the bodies are empty. Consider: WithSourceLoc(Json::Value v, std::source_location l = std::source_location::current()) : value(std::move(v)), loc(l) {}

Suggested change
WithSourceLoc(Json::Value v, std::source_location l = std::source_location::current()) : value(std::move(v)), loc(l)
{
}
WithSourceLoc(JTx v, std::source_location l = std::source_location::current()) : value(std::move(v)), loc(l)
{
}
WithSourceLoc(Json::Value v, std::source_location l = std::source_location::current()) : value(std::move(v)), loc(l) {}
WithSourceLoc(JTx v, std::source_location l = std::source_location::current()) : value(std::move(v)), loc(l) {}

Copilot uses AI. Check for mistakes.
Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed the need for this in a61c815

@bthomee bthomee requested a review from a1q123456 January 30, 2026 12:41
Copy link
Copy Markdown
Contributor

@a1q123456 a1q123456 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some suggestions

namespace test {
namespace jtx {

class Env; // Forward declaration
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this is needed

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed in a61c815

Json::Value or JTx, allowing implicit conversion without template
argument deduction issues.
*/
struct WithSourceLoc
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

May be worth making it a template class so that you don't need to use std::variant and it's clearer.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot AI review requested due to automatic review settings February 5, 2026 18:33
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@mvadari mvadari requested a review from a1q123456 February 5, 2026 19:24
Copilot AI review requested due to automatic review settings February 5, 2026 19:38
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated no new comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@mvadari mvadari added Needs additional review PR requires at least one more code review approval before it can be merged and removed Needs additional review PR requires at least one more code review approval before it can be merged labels Feb 5, 2026
Copy link
Copy Markdown
Contributor

@a1q123456 a1q123456 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@a1q123456
Copy link
Copy Markdown
Contributor

Oh I thought I didn't approve it. Sorry for the noise.

Copilot AI review requested due to automatic review settings February 6, 2026 14:49
@bthomee bthomee removed the Needs additional review PR requires at least one more code review approval before it can be merged label Feb 6, 2026
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings February 6, 2026 15:25
@mvadari mvadari added the Ready to merge *PR author* thinks it's ready to merge. Has passed code review. Perf sign-off may still be required. label Feb 6, 2026
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated no new comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot AI review requested due to automatic review settings February 6, 2026 16:52
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated no new comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@bthomee bthomee enabled auto-merge (squash) February 6, 2026 17:25
@bthomee bthomee merged commit f5208fc into XRPLF:develop Feb 6, 2026
32 checks passed
gregtatcam added a commit to gregtatcam/rippled that referenced this pull request Mar 7, 2026
* chore: Set ColumnLimit to 120 in clang-format (XRPLF#6288)

This change updates the ColumnLimit from 80 to 120, and applies clang-format to reformat the code.

* chore: Remove unnecessary `boost::system` requirement from conanfile (XRPLF#6290)

* chore: Add cmake-format pre-commit hook (XRPLF#6279)

This change adds `cmake-format` as. a pre-commit hook. The style file closely matches that in Clio, and they will be made to be equivalent over time. For now, some files have been excluded, as those need some manual adjustments, which will be done in future changes.

* chore: Format all cmake files without comments (XRPLF#6294)

* ci: Update hashes of XRPLF/actions (XRPLF#6316)

This updates the hashes of all XRPLF/actions to their latest versions.

* chore: Add upper-case match for ARM64 in CompilationEnv (XRPLF#6315)

* fix: Restore config changes that broke standalone mode (XRPLF#6301)

When support was added for `xrpld.cfg` in addition to `rippled.cfg` in XRPLF#6098, as part of an effort to rename occurrences of ripple(d) to xrpl(d), the clearing and creation of the data directory were modified for what, at the time, seemed to result in an equivalent code flow. This has turned out to not be true, which is why this change restores two modifications to `Config.cpp` that currently break running the binary in standalone mode.

* docs: Update API changelog, add APIv2+APIv3 version documentation (XRPLF#6308)

This change cleans up the `API-CHANGELOG.md` file. It moves the version-specific documentation to other files and fleshes out the changelog with all the API-related changes in each version.

* chore: Add .zed editor config directory to .gitignore (XRPLF#6317)

This change adds the project configuration directory to `.gitignore` for the `zed` editor. 

As per the [documentation](https://zed.dev/docs/remote-development?highlight=.zed#zed-settings), the project configuration files are stored in the `.zed` directory at the project root dir.

* fix: Deletes expired NFToken offers from ledger (XRPLF#5707)

This change introduces the `fixExpiredNFTokenOfferRemoval` amendment that allows expired offers to pass through `preclaim()` and be deleted in `doApply()`, following the same pattern used for expired credentials.

* refactor: Add ServiceRegistry to help modularization (XRPLF#6222)

Currently we're passing the `Application` object around, whereby the `Application` class acts more like a service registry that gives other classes access to other services. In order to allow modularization, we should replace `Application` with a service registry class so that modules depending on `Application` for other services can be moved easily. This change adds the `ServiceRegistry` class.

* chore: Remove unity builds (XRPLF#6300)

Unity builds were intended to speed up builds, by bundling multiple files into compilation units. However, now that ccache is available on all platforms, there is no need for unity builds anymore, as ccache stores compiled individual build objects for reuse. This change therefore removes the ability to make unity builds.

* refactor: Replace include guards by '#pragma once' (XRPLF#6322)

This change replaces all include guards in the `src/` and `include/` directories by `#pragma once`.

* chore: Remove unnecessary script (XRPLF#6326)

* chore: Update secp256k1 and openssl (XRPLF#6327)

* fix typo in LendingHelpers unit-test (XRPLF#6215)

* fix: Increment sequence when accepting new manifests (XRPLF#6059)

The `ManifestCache::applyManifest` function was returning early without incrementing `seq_`. `OverlayImpl `uses this sequence to identify/invalidate a cached `TMManifests` message, which is exchanged with peers on connection. Depending on network size, startup sequencing, and topology, this can cause syncing issues. This change therefore increments `seq_` when a new manifest is accepted.

* refactor: Update secp256k1 to 0.7.1 (XRPLF#6331)

The latest secp256k1 release, 0.7.1, contains bug fixes that we may benefit from, see https://github.com/bitcoin-core/secp256k1/blob/master/CHANGELOG.md.

* chore: Restore unity builds (XRPLF#6328)

In certain cases, such as when modifying headers used by many compilation units, performing a unity build is slower than when performing a regular build with `ccache` enabled. There is also a benefit to a unity build in that it can detect things such as macro redefinitions within the group of files that are compiled together as a unit. This change therefore restores the ability to perform unity builds. However, instead of running every configuration with and without unity enabled, it is now only enabled for a single configuration to maintain lower computational use.

As part of restoring the code, it became clear that currently two configurations have coverage enabled, since the check doesn't focus specifically on Debian Bookworm so it also applies to Debian Trixie. This has been fixed too in this change.

* perf: Remove unnecessary caches (XRPLF#5439)

This change removes the cache in `DatabaseNodeImp` and simplifies the caching logic in `SHAMapStoreImp`. As NuDB and RocksDB internally already use caches, additional caches in the code are not very valuable or may even be unnecessary, as also confirmed during preliminary performance analyses.

* chore: Remove CODEOWNERS (XRPLF#6337)

* test: Add file and line location to Env (XRPLF#6276)

This change uses `std::source_location` to output the file and line location of the call that triggered a failed transaction.

* refactor: Fix spelling issues in tests (XRPLF#6199)

This change removes the `src/tests` exception from the `cspell` config and fixes all the issues that arise as a result. No functionality/test change.

* refactor: Change main thread name to `xrpld-main` (XRPLF#6336)

This change builds on the thread-renaming PR (XRPLF#6212), by renaming the main thread name to reduce ambiguity in performance monitoring tools.

* fix: Update invariant checks for Permissioned Domains (XRPLF#6134)

* refactor: Modularize WalletDB and Manifest (XRPLF#6223)

This change modularizes the `WalletDB` and `Manifest`. Note that the wallet db has nothing to do with account wallets and it stores node configuration, which is why it depends on the manifest code.

* refactor: Modularize RelationalDB (XRPLF#6224)

The rdb module was not properly designed, which is fixed in this change. The module had three classes:
1) The abstract class `RelationalDB`.
2) The abstract class `SQLiteDatabase`, which inherited from `RelationalDB` and added some pure virtual methods.
3) The concrete class `SQLiteDatabaseImp`, which inherited from `SQLiteDatabase` and implemented all methods.

The updated code simplifies this as follows:
* The `SQLiteDatabaseImp` has become `SQLiteDatabase`, and
* The former `SQLiteDatabase `has merged with `RelationalDatabase`.

* chore: Fix `gcov` lib coverage build failure on macOS (XRPLF#6350)

For coverage builds, we try to link against the `gcov` library (specific to the environment). But as macOS doesn't have this library and thus doesn't have the coverage tools to generate reports, the coverage builds on that platform were failing on linking.

We actually don't need to explicitly force this linking, as the `CodeCoverage` file already has correct detection logic (currently on lines 177-193), which is invoked when the `--coverage` flag is provided:
* AppleClang: Uses `xcrun -f llvm-cov` to set `GCOV_TOOL="llvm-cov gcov"`.
* Clang: Finds `llvm-cov` to set `GCOV_TOOL="llvm-cov gcov"`.
* GCC: Finds `gcov` to set `GCOV_TOOL="gcov"`.
The `GCOV_TOOL` is then passed to `gcovr` on line 416, so the correct tool is used for processing coverage data.

This change therefore removes the `gcov` suffix from lines 473 and 475 in the `CodeCoverage.cmake` file.

* refactor: Modularize the NetworkOPs interface (XRPLF#6225)

This change moves the NetworkOPs interface into `libxrpl` and it leaves its implementation in `xrpld`.

* chore: Fix minor issues in comments (XRPLF#6346)

* refactor: Modularize `HashRouter`, `Conditions`, and `OrderBookDB` (XRPLF#6226)

This change modularizes additional components by moving code to `libxrpl`.

* chore: Update clang-format to 21.1.8 (XRPLF#6352)

* refactor: Decouple app/tx from `Application` and `Config` (XRPLF#6227)

This change decouples app/tx from `Application` and `Config` to clear the way to moving transactors to `libxrpl`.

* refactor: Modularize app/tx (XRPLF#6228)

* ci: Add clang tidy workflow to ci (XRPLF#6369)

* chore: Set cmake-format width to 100 (XRPLF#6386)

* chore: Set clang-format width to 100 in config file (XRPLF#6387)

* chore: Apply clang-format width 100 (XRPLF#6387)

* Fix tautological assertion (XRPLF#6393)

* ci: Add dependabot config (XRPLF#6379)

* ci: Build docs in PRs and in private repos (XRPLF#6400)

* ci: [DEPENDABOT] bump codecov/codecov-action from 5.4.3 to 5.5.2 (XRPLF#6398)

Bumps [codecov/codecov-action](https://github.com/codecov/codecov-action) from 5.4.3 to 5.5.2.
- [Release notes](https://github.com/codecov/codecov-action/releases)
- [Changelog](https://github.com/codecov/codecov-action/blob/main/CHANGELOG.md)
- [Commits](codecov/codecov-action@18283e0...671740a)

---
updated-dependencies:
- dependency-name: codecov/codecov-action
  dependency-version: 5.5.2
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Fix merge conflicts, format, spelling,
replace all include guards by #pragma once

* Fix non-unity build

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Ayaz Salikhov <mathbunnyru@users.noreply.github.com>
Co-authored-by: Ed Hennis <ed@ripple.com>
Co-authored-by: Bart <bthomee@users.noreply.github.com>
Co-authored-by: Mayukha Vadari <mvadari@ripple.com>
Co-authored-by: Vito Tumas <5780819+Tapanito@users.noreply.github.com>
Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com>
Co-authored-by: Jingchen <a1q123456@users.noreply.github.com>
Co-authored-by: Niq Dudfield <ndudfield@gmail.com>
Co-authored-by: Valentin Balaschenko <13349202+vlntb@users.noreply.github.com>
Co-authored-by: Olek <115580134+oleks-rip@users.noreply.github.com>
Co-authored-by: Pratik Mankawde <3397372+pratikmankawde@users.noreply.github.com>
Co-authored-by: nuxtreact <nuxtreact@outlook.com>
Co-authored-by: Sergey Kuznetsov <skuznetsov@ripple.com>
Co-authored-by: Ayaz Salikhov <asalikhov@ripple.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
@mvadari mvadari deleted the env-file-loc branch March 12, 2026 17:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Ready to merge *PR author* thinks it's ready to merge. Has passed code review. Perf sign-off may still be required.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants