[cli] Add contribution guide #14435

gregnazario · 2024-08-27T18:10:18Z

Description

Adds a contribution guide, outlining a bunch of the decisions in the CLI and how to add commands.

Type of Change

Which Components or Systems Does This Change Impact?

How Has This Been Tested?

Key Areas to Review

Checklist

I have read and followed the CONTRIBUTING doc
I have performed a self-review of my own code
I have commented my code, particularly in hard-to-understand areas
I identified and added all stakeholders and component owners affected by this change as reviewers
I tested both happy and unhappy path of the functionality
I have made corresponding changes to the documentation

trunk-io · 2024-08-27T18:10:22Z

⏱️ 2h 3m total CI duration on this PR

Job	Cumulative Duration	Recent Runs
forge-compat-test / forge	34m	🟩 🟩
forge-e2e-test / forge	29m	🟩 🟥
execution-performance / test-target-determinator	12m	🟩 🟩
test-target-determinator	12m	🟩 🟩
check	7m	🟩 🟩
general-lints	6m	🟩 🟩 🟩
rust-cargo-deny	5m	🟩 🟩 🟩
rust-doc-tests	5m	🟩
check-dynamic-deps	3m	🟩 🟩 🟩
rust-move-tests	2m	🟩
semgrep/ci	2m	🟩 🟩 🟩
rust-move-tests	2m	🟩
rust-move-tests	1m	🟩
file_change_determinator	35s	🟩 🟩 🟩
file_change_determinator	35s	🟩 🟩 🟩
file_change_determinator	25s	🟩 🟩
forge-framework-upgrade-test / forge	25s	🟩 🟩
execution-performance / single-node-performance	21s	🟩 🟩
permission-check	14s	🟩 🟩 🟩
permission-check	12s	🟩 🟩 🟩
permission-check	7s	🟩 🟩 🟩
permission-check	6s	🟩 🟩
permission-check	6s	🟩 🟩 🟩
determine-docker-build-metadata	4s	🟩 🟩

🚨 3 jobs on the last run were significantly faster/slower than expected

Job	Duration	vs 7d avg
forge-compat-test / forge	21m	15m
forge-framework-upgrade-test / forge	13s	12m
execution-performance / single-node-performance	10s	18m

_{settings ⋅ feedback ⋅ docs ⋅ learn more about trunk.io}

GhostWalker562

🖊️

github-actions · 2024-08-29T16:29:07Z

❌ Forge suite `realistic_env_max_load` failure on `52a8de362c94f58c401533af1d28c347513ec70c`

two traffics test: inner traffic : committed: 12864.81 txn/s, latency: 3083.01 ms, (p50: 2700 ms, p90: 3900 ms, p99: 10200 ms), latency samples: 4891500
two traffics test : committed: 100.05 txn/s, latency: 3212.08 ms, (p50: 2500 ms, p90: 5900 ms, p99: 10600 ms), latency samples: 1820
Latency breakdown for phase 0: ["QsBatchToPos: max: 0.233, avg: 0.220", "QsPosToProposal: max: 0.234, avg: 0.185", "ConsensusProposalToOrdered: max: 0.313, avg: 0.294", "ConsensusOrderedToCommit: max: 0.496, avg: 0.457", "ConsensusProposalToCommit: max: 0.790, avg: 0.751"]
Test Failed: check for success

Caused by:
    Failed latency check, for ["P90 latency is 5.9s and exceeds limit of 4.5s"]

Stack backtrace:
   0: anyhow::error::<impl anyhow::Error>::msg
             at /usr/local/cargo/registry/src/index.crates.io-6f17d22bba15001f/anyhow-1.0.79/src/error.rs:83:36
   1: aptos_forge::success_criteria::SuccessCriteriaChecker::check_latency
             at ./testsuite/forge/src/success_criteria.rs:560:13
   2: aptos_forge::success_criteria::SuccessCriteriaChecker::check_for_success::{{closure}}
             at ./testsuite/forge/src/success_criteria.rs:304:9
   3: aptos_forge::interface::network::NetworkContext::check_for_success::{{closure}}
             at ./testsuite/forge/src/interface/network.rs:112:10
   4: <dyn aptos_testcases::NetworkLoadTest as aptos_forge::interface::network::NetworkTest>::run::{{closure}}
             at ./testsuite/testcases/src/lib.rs:322:14
   5: <core::pin::Pin<P> as core::future::future::Future>::poll
             at /rustc/9b00956e56009bab2aa15d7bff10916599e3d6d6/library/core/src/future/future.rs:123:9
   6: <aptos_testcases::two_traffics_test::TwoTrafficsTest as aptos_forge::interface::network::NetworkTest>::run::{{closure}}
             at ./testsuite/testcases/src/two_traffics_test.rs:77:47
   7: <core::pin::Pin<P> as core::future::future::Future>::poll
             at /rustc/9b00956e56009bab2aa15d7bff10916599e3d6d6/library/core/src/future/future.rs:123:9
   8: <aptos_testcases::CompositeNetworkTest as aptos_forge::interface::network::NetworkTest>::run::{{closure}}
             at ./testsuite/testcases/src/lib.rs:628:37
   9: <core::pin::Pin<P> as core::future::future::Future>::poll
             at /rustc/9b00956e56009bab2aa15d7bff10916599e3d6d6/library/core/src/future/future.rs:123:9
  10: tokio::runtime::park::CachedParkThread::block_on::{{closure}}
             at /usr/local/cargo/registry/src/index.crates.io-6f17d22bba15001f/tokio-1.35.1/src/runtime/park.rs:282:63
  11: tokio::runtime::coop::with_budget
             at /usr/local/cargo/registry/src/index.crates.io-6f17d22bba15001f/tokio-1.35.1/src/runtime/coop.rs:107:5
  12: tokio::runtime::coop::budget
             at /usr/local/cargo/registry/src/index.crates.io-6f17d22bba15001f/tokio-1.35.1/src/runtime/coop.rs:73:5
  13: tokio::runtime::park::CachedParkThread::block_on
             at /usr/local/cargo/registry/src/index.crates.io-6f17d22bba15001f/tokio-1.35.1/src/runtime/park.rs:282:31
  14: tokio::runtime::context::blocking::BlockingRegionGuard::block_on
             at /usr/local/cargo/registry/src/index.crates.io-6f17d22bba15001f/tokio-1.35.1/src/runtime/context/blocking.rs:66:9
  15: tokio::runtime::handle::Handle::block_on::{{closure}}
             at /usr/local/cargo/registry/src/index.crates.io-6f17d22bba15001f/tokio-1.35.1/src/runtime/handle.rs:310:22
  16: tokio::runtime::context::runtime::enter_runtime
             at /usr/local/cargo/registry/src/index.crates.io-6f17d22bba15001f/tokio-1.35.1/src/runtime/context/runtime.rs:65:16
  17: tokio::runtime::handle::Handle::block_on
             at /usr/local/cargo/registry/src/index.crates.io-6f17d22bba15001f/tokio-1.35.1/src/runtime/handle.rs:309:9
  18: aptos_forge::runner::Forge<F>::run::{{closure}}
             at ./testsuite/forge/src/runner.rs:628:49
  19: aptos_forge::runner::run_test
             at ./testsuite/forge/src/runner.rs:701:11
  20: aptos_forge::runner::Forge<F>::run
             at ./testsuite/forge/src/runner.rs:628:30
  21: forge::run_forge
             at ./testsuite/forge-cli/src/main.rs:458:11
  22: forge::main
             at ./testsuite/forge-cli/src/main.rs:384:21
  23: core::ops::function::FnOnce::call_once
             at /rustc/9b00956e56009bab2aa15d7bff10916599e3d6d6/library/core/src/ops/function.rs:250:5
  24: std::sys_common::backtrace::__rust_begin_short_backtrace
             at /rustc/9b00956e56009bab2aa15d7bff10916599e3d6d6/library/std/src/sys_common/backtrace.rs:155:18
  25: std::rt::lang_start::{{closure}}
             at /rustc/9b00956e56009bab2aa15d7bff10916599e3d6d6/library/std/src/rt.rs:166:18
  26: core::ops::function::impls::<impl core::ops::function::FnOnce<A> for &F>::call_once
             at /rustc/9b00956e56009bab2aa15d7bff10916599e3d6d6/library/core/src/ops/function.rs:284:13
  27: std::panicking::try::do_call
             at /rustc/9b00956e56009bab2aa15d7bff10916599e3d6d6/library/std/src/panicking.rs:552:40
  28: std::panicking::try
             at /rustc/9b00956e56009bab2aa15d7bff10916599e3d6d6/library/std/src/panicking.rs:516:19
  29: std::panic::catch_unwind
             at /rustc/9b00956e56009bab2aa15d7bff10916599e3d6d6/library/std/src/panic.rs:146:14
  30: std::rt::lang_start_internal::{{closure}}
             at /rustc/9b00956e56009bab2aa15d7bff10916599e3d6d6/library/std/src/rt.rs:148:48
  31: std::panicking::try::do_call
             at /rustc/9b00956e56009bab2aa15d7bff10916599e3d6d6/library/std/src/panicking.rs:552:40
  32: std::panicking::try
             at /rustc/9b00956e56009bab2aa15d7bff10916599e3d6d6/library/std/src/panicking.rs:516:19
  33: std::panic::catch_unwind
             at /rustc/9b00956e56009bab2aa15d7bff10916599e3d6d6/library/std/src/panic.rs:146:14
  34: std::rt::lang_start_internal
             at /rustc/9b00956e56009bab2aa15d7bff10916599e3d6d6/library/std/src/rt.rs:148:20
  35: main
  36: __libc_start_main
  37: _start
Trailing Log Lines:
  32: std::panicking::try
             at /rustc/9b00956e56009bab2aa15d7bff10916599e3d6d6/library/std/src/panicking.rs:516:19
  33: std::panic::catch_unwind
             at /rustc/9b00956e56009bab2aa15d7bff10916599e3d6d6/library/std/src/panic.rs:146:14
  34: std::rt::lang_start_internal
             at /rustc/9b00956e56009bab2aa15d7bff10916599e3d6d6/library/std/src/rt.rs:148:20
  35: main
  36: __libc_start_main
  37: _start


Swarm logs can be found here: See fgi output for more information.
{"level":"INFO","source":{"package":"aptos_forge","file":"testsuite/forge/src/backend/k8s/cluster_helper.rs:292"},"thread_name":"main","hostname":"forge-e2e-pr-14435-1724948129-52a8de362c94f58c401533af1d28c3475","timestamp":"2024-08-29T16:29:01.626093Z","message":"Deleting namespace forge-e2e-pr-14435: Some(NamespaceStatus { conditions: None, phase: Some(\"Terminating\") })"}
{"level":"INFO","source":{"package":"aptos_forge","file":"testsuite/forge/src/backend/k8s/cluster_helper.rs:400"},"thread_name":"main","hostname":"forge-e2e-pr-14435-1724948129-52a8de362c94f58c401533af1d28c3475","timestamp":"2024-08-29T16:29:01.626130Z","message":"aptos-node resources for Forge removed in namespace: forge-e2e-pr-14435"}
Failed to run tests:
Tests Failed

failures:
    CompositeNetworkTest

test result: FAILED. 0 passed; 1 failed; 0 filtered out

Error: Tests Failed

Stack backtrace:
   0: anyhow::error::<impl anyhow::Error>::msg
             at /usr/local/cargo/registry/src/index.crates.io-6f17d22bba15001f/anyhow-1.0.79/src/error.rs:83:36
   1: aptos_forge::runner::Forge<F>::run
             at ./testsuite/forge/src/runner.rs:653:13
   2: forge::run_forge
             at ./testsuite/forge-cli/src/main.rs:458:11
   3: forge::main
             at ./testsuite/forge-cli/src/main.rs:384:21
   4: core::ops::function::FnOnce::call_once
             at /rustc/9b00956e56009bab2aa15d7bff10916599e3d6d6/library/core/src/ops/function.rs:250:5
   5: std::sys_common::backtrace::__rust_begin_short_backtrace
             at /rustc/9b00956e56009bab2aa15d7bff10916599e3d6d6/library/std/src/sys_common/backtrace.rs:155:18
   6: std::rt::lang_start::{{closure}}
             at /rustc/9b00956e56009bab2aa15d7bff10916599e3d6d6/library/std/src/rt.rs:166:18
   7: core::ops::function::impls::<impl core::ops::function::FnOnce<A> for &F>::call_once
             at /rustc/9b00956e56009bab2aa15d7bff10916599e3d6d6/library/core/src/ops/function.rs:284:13
   8: std::panicking::try::do_call
             at /rustc/9b00956e56009bab2aa15d7bff10916599e3d6d6/library/std/src/panicking.rs:552:40
   9: std::panicking::try
             at /rustc/9b00956e56009bab2aa15d7bff10916599e3d6d6/library/std/src/panicking.rs:516:19
  10: std::panic::catch_unwind
             at /rustc/9b00956e56009bab2aa15d7bff10916599e3d6d6/library/std/src/panic.rs:146:14
  11: std::rt::lang_start_internal::{{closure}}
             at /rustc/9b00956e56009bab2aa15d7bff10916599e3d6d6/library/std/src/rt.rs:148:48
  12: std::panicking::try::do_call
             at /rustc/9b00956e56009bab2aa15d7bff10916599e3d6d6/library/std/src/panicking.rs:552:40
  13: std::panicking::try
             at /rustc/9b00956e56009bab2aa15d7bff10916599e3d6d6/library/std/src/panicking.rs:516:19
  14: std::panic::catch_unwind
             at /rustc/9b00956e56009bab2aa15d7bff10916599e3d6d6/library/std/src/panic.rs:146:14
  15: std::rt::lang_start_internal
             at /rustc/9b00956e56009bab2aa15d7bff10916599e3d6d6/library/std/src/rt.rs:148:20
  16: main
  17: __libc_start_main
  18: _start
Debugging output:
NAME                                    READY   STATUS      RESTARTS   AGE
aptos-node-0-fullnode-eforge220-0       1/1     Running     0          13m
aptos-node-0-validator-0                1/1     Running     0          13m
aptos-node-1-fullnode-eforge220-0       1/1     Running     0          13m
aptos-node-1-validator-0                1/1     Running     0          13m
aptos-node-2-fullnode-eforge220-0       1/1     Running     0          13m
aptos-node-2-validator-0                1/1     Running     0          13m
aptos-node-3-fullnode-eforge220-0       1/1     Running     0          13m
aptos-node-3-validator-0                1/1     Running     0          13m
aptos-node-4-fullnode-eforge220-0       1/1     Running     0          13m
aptos-node-4-validator-0                1/1     Running     0          13m
aptos-node-5-validator-0                1/1     Running     0          13m
aptos-node-6-validator-0                1/1     Running     0          13m
genesis-aptos-genesis-eforge220-6r9zb   0/1     Completed   0          13m

github-actions · 2024-08-29T16:34:35Z

✅ Forge suite `compat` success on `d1bf834728a0cf166d993f4728dfca54f3086fb0` ==> `52a8de362c94f58c401533af1d28c347513ec70c`

Compatibility test results for d1bf834728a0cf166d993f4728dfca54f3086fb0 ==> 52a8de362c94f58c401533af1d28c347513ec70c (PR)
1. Check liveness of validators at old version: d1bf834728a0cf166d993f4728dfca54f3086fb0
compatibility::simple-validator-upgrade::liveness-check : committed: 9145.23 txn/s, latency: 3634.63 ms, (p50: 2400 ms, p90: 7100 ms, p99: 28100 ms), latency samples: 372500
2. Upgrading first Validator to new version: 52a8de362c94f58c401533af1d28c347513ec70c
compatibility::simple-validator-upgrade::single-validator-upgrading : committed: 6659.43 txn/s, latency: 4203.71 ms, (p50: 4500 ms, p90: 5600 ms, p99: 5800 ms), latency samples: 130100
compatibility::simple-validator-upgrade::single-validator-upgrade : committed: 7113.37 txn/s, latency: 4497.20 ms, (p50: 4500 ms, p90: 6800 ms, p99: 7000 ms), latency samples: 239420
3. Upgrading rest of first batch to new version: 52a8de362c94f58c401533af1d28c347513ec70c
compatibility::simple-validator-upgrade::half-validator-upgrading : committed: 7820.64 txn/s, latency: 3570.05 ms, (p50: 4000 ms, p90: 4300 ms, p99: 4400 ms), latency samples: 146420
compatibility::simple-validator-upgrade::half-validator-upgrade : committed: 7589.64 txn/s, latency: 4252.93 ms, (p50: 4300 ms, p90: 4800 ms, p99: 5000 ms), latency samples: 253940
4. upgrading second batch to new version: 52a8de362c94f58c401533af1d28c347513ec70c
compatibility::simple-validator-upgrade::rest-validator-upgrading : committed: 11283.54 txn/s, latency: 2423.89 ms, (p50: 2600 ms, p90: 2900 ms, p99: 4300 ms), latency samples: 201160
compatibility::simple-validator-upgrade::rest-validator-upgrade : committed: 11177.04 txn/s, latency: 2960.69 ms, (p50: 2800 ms, p90: 3900 ms, p99: 4900 ms), latency samples: 366240
5. check swarm health
Compatibility test for d1bf834728a0cf166d993f4728dfca54f3086fb0 ==> 52a8de362c94f58c401533af1d28c347513ec70c passed
Test Ok

[cli] Add contribution guide

ddbaaf0

gregnazario requested a review from GhostWalker562 August 27, 2024 18:10

gregnazario requested a review from banool as a code owner August 27, 2024 18:10

GhostWalker562 approved these changes Aug 27, 2024

View reviewed changes

vineethk approved these changes Aug 29, 2024

View reviewed changes

gregnazario enabled auto-merge (squash) August 29, 2024 03:23

This comment has been minimized.

Sign in to view

wrwg approved these changes Aug 29, 2024

View reviewed changes

Merge branch 'main' into cli-contribution-guide

52a8de3

This comment has been minimized.

Sign in to view

gregnazario disabled auto-merge September 17, 2024 20:48

gregnazario merged commit 994bd3c into aptos-labs:main Sep 17, 2024
45 of 46 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[cli] Add contribution guide #14435

[cli] Add contribution guide #14435

gregnazario commented Aug 27, 2024 •

edited

Loading

trunk-io bot commented Aug 27, 2024 •

edited

Loading

GhostWalker562 left a comment

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

github-actions bot commented Aug 29, 2024

github-actions bot commented Aug 29, 2024

[cli] Add contribution guide #14435

[cli] Add contribution guide #14435

Conversation

gregnazario commented Aug 27, 2024 • edited Loading

Description

Type of Change

Which Components or Systems Does This Change Impact?

How Has This Been Tested?

Key Areas to Review

Checklist

trunk-io bot commented Aug 27, 2024 • edited Loading

GhostWalker562 left a comment

Choose a reason for hiding this comment

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

github-actions bot commented Aug 29, 2024

❌ Forge suite realistic_env_max_load failure on 52a8de362c94f58c401533af1d28c347513ec70c

github-actions bot commented Aug 29, 2024

✅ Forge suite compat success on d1bf834728a0cf166d993f4728dfca54f3086fb0 ==> 52a8de362c94f58c401533af1d28c347513ec70c

gregnazario commented Aug 27, 2024 •

edited

Loading

trunk-io bot commented Aug 27, 2024 •

edited

Loading

❌ Forge suite `realistic_env_max_load` failure on `52a8de362c94f58c401533af1d28c347513ec70c`

✅ Forge suite `compat` success on `d1bf834728a0cf166d993f4728dfca54f3086fb0` ==> `52a8de362c94f58c401533af1d28c347513ec70c`