-
Notifications
You must be signed in to change notification settings - Fork 111
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into test-registerkeys-service
- Loading branch information
Showing
18 changed files
with
316 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -7,7 +7,7 @@ for: | |
| - macOS, | ||
| - Ubuntu, | ||
| - Docker: | ||
| - Debian Bullseye. | ||
| - Debian Bookworm. | ||
|
|
||
| ## Memory Issues | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| mod snapshot; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,151 @@ | ||
| //! Snapshot tests for Zebra Scan gRPC responses. | ||
| //! | ||
| //! Currently we snapshot the `get_info` and `get_results` responses for both mainnet and testnet with a | ||
| //! mocked scanner database. Calls that return `Empty` responses are not snapshoted in this suite. | ||
| //! | ||
| //! To update these snapshots, run: | ||
| //! ```sh | ||
| //! cargo insta test --review --delete-unreferenced-snapshots | ||
| //! ``` | ||
| use std::{collections::BTreeMap, thread::sleep, time::Duration}; | ||
|
|
||
| use zebra_chain::{block::Height, parameters::Network, transaction}; | ||
| use zebra_test::mock_service::MockService; | ||
|
|
||
| use zebra_node_services::scan_service::{ | ||
| request::Request as ScanRequest, response::Response as ScanResponse, | ||
| }; | ||
|
|
||
| use crate::{ | ||
| scanner::{ | ||
| scanner_client::ScannerClient, Empty, GetResultsRequest, GetResultsResponse, InfoReply, | ||
| }, | ||
| server::init, | ||
| }; | ||
|
|
||
| /// The extended Sapling viewing key of [ZECpages](https://zecpages.com/boardinfo) | ||
| pub const ZECPAGES_SAPLING_VIEWING_KEY: &str = "zxviews1q0duytgcqqqqpqre26wkl45gvwwwd706xw608hucmvfalr759ejwf7qshjf5r9aa7323zulvz6plhttp5mltqcgs9t039cx2d09mgq05ts63n8u35hyv6h9nc9ctqqtue2u7cer2mqegunuulq2luhq3ywjcz35yyljewa4mgkgjzyfwh6fr6jd0dzd44ghk0nxdv2hnv4j5nxfwv24rwdmgllhe0p8568sgqt9ckt02v2kxf5ahtql6s0ltjpkckw8gtymxtxuu9gcr0swvz"; | ||
|
|
||
| #[tokio::test(flavor = "multi_thread")] | ||
| async fn test_grpc_response_data() { | ||
| let _init_guard = zebra_test::init(); | ||
|
|
||
| tokio::join!( | ||
| test_mocked_rpc_response_data_for_network( | ||
| Network::Mainnet, | ||
| zebra_test::net::random_known_port() | ||
| ), | ||
| test_mocked_rpc_response_data_for_network( | ||
| Network::Testnet, | ||
| zebra_test::net::random_known_port() | ||
| ), | ||
| ); | ||
| } | ||
|
|
||
| async fn test_mocked_rpc_response_data_for_network(network: Network, random_port: u16) { | ||
| // get a mocked scan service | ||
| let mock_scan_service = MockService::build().for_unit_tests(); | ||
|
|
||
| // start the gRPC server | ||
| let listen_addr: std::net::SocketAddr = format!("127.0.0.1:{random_port}") | ||
| .parse() | ||
| .expect("hard-coded IP and u16 port should parse successfully"); | ||
|
|
||
| { | ||
| let mock_scan_service = mock_scan_service.clone(); | ||
| tokio::spawn(async move { | ||
| init(listen_addr, mock_scan_service) | ||
| .await | ||
| .expect("Possible port conflict"); | ||
| }); | ||
| } | ||
|
|
||
| // wait for the server to start | ||
| sleep(Duration::from_secs(1)); | ||
|
|
||
| // connect to the gRPC server | ||
| let client = ScannerClient::connect(format!("http://127.0.0.1:{random_port}")) | ||
| .await | ||
| .expect("server should receive connection"); | ||
|
|
||
| // insta settings | ||
| let mut settings = insta::Settings::clone_current(); | ||
| settings.set_snapshot_suffix(network.lowercase_name()); | ||
|
|
||
| // snapshot the get_info grpc call | ||
| let get_info_response_fut = { | ||
| let mut client = client.clone(); | ||
| let get_info_request = tonic::Request::new(Empty {}); | ||
| tokio::spawn(async move { client.get_info(get_info_request).await }) | ||
| }; | ||
|
|
||
| { | ||
| let mut mock_scan_service = mock_scan_service.clone(); | ||
| tokio::spawn(async move { | ||
| mock_scan_service | ||
| .expect_request_that(|req| matches!(req, ScanRequest::Info)) | ||
| .await | ||
| .respond(ScanResponse::Info { | ||
| min_sapling_birthday_height: network.sapling_activation_height(), | ||
| }) | ||
| }); | ||
| } | ||
|
|
||
| // snapshot the get_info grpc call | ||
|
|
||
| let get_info_response = get_info_response_fut | ||
| .await | ||
| .expect("tokio task should join successfully") | ||
| .expect("get_info request should succeed"); | ||
|
|
||
| snapshot_rpc_getinfo(get_info_response.into_inner(), &settings); | ||
|
|
||
| // snapshot the get_results grpc call | ||
|
|
||
| let get_results_response_fut = { | ||
| let mut client = client.clone(); | ||
| let get_results_request = tonic::Request::new(GetResultsRequest { | ||
| keys: vec![ZECPAGES_SAPLING_VIEWING_KEY.to_string()], | ||
| }); | ||
| tokio::spawn(async move { client.get_results(get_results_request).await }) | ||
| }; | ||
|
|
||
| { | ||
| let mut mock_scan_service = mock_scan_service.clone(); | ||
| tokio::spawn(async move { | ||
| let zec_pages_sapling_efvk = ZECPAGES_SAPLING_VIEWING_KEY.to_string(); | ||
| let mut fake_results = BTreeMap::new(); | ||
| for fake_result_height in [Height::MIN, Height(1), Height::MAX] { | ||
| fake_results.insert( | ||
| fake_result_height, | ||
| [transaction::Hash::from([0; 32])].repeat(3), | ||
| ); | ||
| } | ||
|
|
||
| let mut fake_results_response = BTreeMap::new(); | ||
| fake_results_response.insert(zec_pages_sapling_efvk, fake_results); | ||
|
|
||
| mock_scan_service | ||
| .expect_request_that(|req| matches!(req, ScanRequest::Results(_))) | ||
| .await | ||
| .respond(ScanResponse::Results(fake_results_response)) | ||
| }); | ||
| } | ||
|
|
||
| let get_results_response = get_results_response_fut | ||
| .await | ||
| .expect("tokio task should join successfully") | ||
| .expect("get_results request should succeed"); | ||
|
|
||
| snapshot_rpc_getresults(get_results_response.into_inner(), &settings); | ||
| } | ||
|
|
||
| /// Snapshot `getinfo` response, using `cargo insta` and JSON serialization. | ||
| fn snapshot_rpc_getinfo(info: InfoReply, settings: &insta::Settings) { | ||
| settings.bind(|| insta::assert_json_snapshot!("get_info", info)); | ||
| } | ||
|
|
||
| /// Snapshot `getresults` response, using `cargo insta` and JSON serialization. | ||
| fn snapshot_rpc_getresults(results: GetResultsResponse, settings: &insta::Settings) { | ||
| settings.bind(|| insta::assert_json_snapshot!("get_results", results)); | ||
| } |
Oops, something went wrong.