Skip to content

Commit

Permalink
tests: introduce new test for compression
Browse files Browse the repository at this point in the history
test are trying both algorithms (snappy, lz4), while
counting the size of the frames coming into scylla

for reference we also have one test doing the same without
compression

test main structure was borrowed from java-driver, the usage
of proxy to count the packets is unique to this change.
  • Loading branch information
fruch committed Feb 11, 2025
1 parent 73beaa3 commit 17d6fe9
Show file tree
Hide file tree
Showing 2 changed files with 134 additions and 0 deletions.
133 changes: 133 additions & 0 deletions scylla/tests/integration/compression.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,133 @@
use crate::utils::{test_with_3_node_cluster, unique_keyspace_name, PerformDDL};
use scylla::client::session::Session;
use scylla::client::session_builder::SessionBuilder;
use scylla::frame::Compression;
use scylla::statement::query::Query;

use scylla_proxy::{
Condition, ProxyError, Reaction, RequestReaction, RequestRule, ShardAwareness,
WorkerError,
};

use std::sync::Arc;
use tokio::sync::mpsc;

/// Tests the compression functionality of the Scylla driver by performing a series of operations
/// on a 3-node cluster with optional compression and verifying the total frame size of the requests.
///
/// # Arguments
///
/// * `compression` - An optional `Compression` enum value specifying the type of compression to use.
/// * `text_size` - The size of the text to be inserted into the test table.
/// * `expected_frame_total_size_range` - A range specifying the expected total size of the frames.
///
/// # Panics
///
/// This function will panic if the total frame size does not fall within the expected range or if
/// any of the operations (such as creating keyspace, table, or inserting/querying data) fail.
async fn test_compression(
compression: Option<Compression>,
text_size: usize,
expected_frame_total_size_range: std::ops::Range<usize>,
) {
let res = test_with_3_node_cluster(ShardAwareness::QueryNode, |proxy_uris, translation_map, mut running_proxy| async move {

let request_rule = |tx| {
RequestRule(
Condition::True,
RequestReaction::noop().with_feedback_when_performed(tx),
)
};

let (request_tx, mut request_rx) = mpsc::unbounded_channel();
for running_node in running_proxy.running_nodes.iter_mut() {
running_node.change_request_rules(Some(vec![request_rule(request_tx.clone())]));
}

let session: Session = SessionBuilder::new()
.known_node(proxy_uris[0].as_str())
.address_translator(Arc::new(translation_map))
.compression(compression)
.build()
.await
.unwrap();

let ks = unique_keyspace_name();
session.ddl(format!("CREATE KEYSPACE IF NOT EXISTS {} WITH REPLICATION = {{'class' : 'NetworkTopologyStrategy', 'replication_factor' : 3}}", ks)).await.unwrap();
session.use_keyspace(ks, false).await.unwrap();
session
.ddl("CREATE TABLE test (k text PRIMARY KEY, t text, i int, f float)")
.await
.unwrap();

let q = Query::from("INSERT INTO test (k, t, i, f) VALUES (?, ?, ?, ?)");
let large_string = "a".repeat(text_size);
session.query_unpaged(q.clone(), ("key", large_string.as_str(), 42_i32, 24.03_f32)).await.unwrap();

let result: Vec<(String, String, i32, f32)> = session
.query_unpaged("SELECT k, t, i, f FROM test WHERE k = 'key'", &[])
.await
.unwrap()
.into_rows_result()
.unwrap()
.rows::<(String, String, i32, f32)>()
.unwrap()
.collect::<Result<_, _>>()
.unwrap();

assert_eq!(result, vec![((String::from("key"), String::from(large_string), 42_i32, 24.03_f32))]);


let mut total_frame_size = 0;
while let Ok((request_frame, _shard)) = request_rx.try_recv() {
total_frame_size += request_frame.body.len();
}
println!("Total frame size: {}", total_frame_size);
assert!(expected_frame_total_size_range.contains(&total_frame_size));

running_proxy

}).await;

match res {
Ok(()) => (),
Err(ProxyError::Worker(WorkerError::DriverDisconnected(_))) => (),
Err(err) => panic!("{}", err),
}
}

#[tokio::test]
#[cfg(not(scylla_cloud_tests))]
async fn should_execute_queries_without_compression() {
test_compression(None, 1024, 4200..9000).await;
}

#[tokio::test]
#[cfg(not(scylla_cloud_tests))]
async fn should_execute_queries_without_compression_10mb() {
test_compression(None, 1024 * 10, 14300..19000).await;
}

#[tokio::test]
#[cfg(not(scylla_cloud_tests))]
async fn should_execute_queries_with_snappy_compression() {
test_compression(Some(Compression::Snappy), 1024, 3100..11000).await;
}

#[tokio::test]
#[cfg(not(scylla_cloud_tests))]
async fn should_execute_queries_with_snappy_compression_10mb() {
test_compression(Some(Compression::Snappy), 1024 * 10, 3300..11000).await;
}

#[tokio::test]
#[cfg(not(scylla_cloud_tests))]
async fn should_execute_queries_with_lz4_compression() {
test_compression(Some(Compression::Lz4), 1024, 3100..11000).await;
}

#[tokio::test]
#[cfg(not(scylla_cloud_tests))]
async fn should_execute_queries_with_lz4_compression_10mb() {
test_compression(Some(Compression::Lz4), 1024 * 10, 3300..11000).await;
}
1 change: 1 addition & 0 deletions scylla/tests/integration/main.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
mod authenticate;
mod batch;
mod compression;
mod consistency;
mod cql_collections;
mod cql_types;
Expand Down

0 comments on commit 17d6fe9

Please sign in to comment.