Merge branch 'scylladb:main' into query_rows_result_displayer

Author: Michu1596

.github/workflows/cassandra.yml

@@ -31,7 +31,7 @@ jobs:
       run: cargo build --verbose --tests --features "full-serialization"
     - name: Run tests on cassandra
       run: |
-        CDC='disabled' RUST_LOG=trace SCYLLA_URI=172.42.0.2:9042 SCYLLA_URI2=172.42.0.3:9042 SCYLLA_URI3=172.42.0.4:9042 cargo test --verbose --features "full-serialization" -- --skip test_views_in_schema_info --skip test_large_batch_statements
+        CDC='disabled' RUSTFLAGS="--cfg cassandra_tests" RUST_LOG=trace SCYLLA_URI=172.42.0.2:9042 SCYLLA_URI2=172.42.0.3:9042 SCYLLA_URI3=172.42.0.4:9042 cargo test --verbose --features "full-serialization" -- --skip test_views_in_schema_info --skip test_large_batch_statements
     - name: Stop the cluster
       if: ${{ always() }}
       run: docker compose -f test/cluster/cassandra/docker-compose.yml stop

CONTRIBUTING.md

@@ -49,6 +49,18 @@ The above commands will leave a running ScyllaDB cluster in the background.
 To stop it, use `make down`.\
 Starting a cluster without running any test is possible with `make up`.
 
+### Writing tests that need to connect to Scylla
+
+If you test requires connecting to Scylla, there are a few things you should consider.
+
+1. Such tests are considered integration tests and should be placed in `scylla/tests/integration`.
+2. To avoid name conflicts while creating a keyspace use `unique_keyspace_name` function from `utils` module.
+3. This `utils` module (`scylla/tests/integration/utils.rs`) contains other functions that may be helpful for writing tests.
+   For example `create_new_session_builder` or `test_with_3_node_cluster`.
+4. To perform DDL queries (creating / altering / dropping a keyspace / table /type) use `ddl` method from the utils module.
+   To do this, import the `PerformDDL` trait (`use crate::utils::PerformDDL;`). Then you can call `ddl` method on a
+   `Session`.
+
 ### Tracing in tests
 
 By default cargo captures `print!` macro's output from tests and prints them for failed tests.

docs/source/data-types/date.md

@@ -42,7 +42,7 @@ while let Some((date_value,)) = iter.try_next().await? {
 
 ## chrono::NaiveDate
 
-If full range is not required and `chrono` feature is enabled,
+If full range is not required and `chrono-04` feature is enabled,
 [`chrono::NaiveDate`](https://docs.rs/chrono/0.4/chrono/naive/struct.NaiveDate.html) can be used.
 [`chrono::NaiveDate`](https://docs.rs/chrono/0.4/chrono/naive/struct.NaiveDate.html) supports dates from
 -262145-01-01 to 262143-12-31.
@@ -78,7 +78,7 @@ while let Some((date_value,)) = iter.try_next().await? {
 
 ## time::Date
 
-Alternatively, `time` feature can be used to enable support of
+Alternatively, the `time-03` feature can be used to enable support of
 [`time::Date`](https://docs.rs/time/0.3/time/struct.Date.html).
 [`time::Date`](https://docs.rs/time/0.3/time/struct.Date.html)'s value range depends on feature flags, see its
 documentation to get more info.

docs/source/data-types/time.md

@@ -42,7 +42,7 @@ while let Some((value,)) = iter.try_next().await? {
 
 ## chrono::NaiveTime
 
-If `chrono` feature is enabled, [`chrono::NaiveTime`](https://docs.rs/chrono/0.4/chrono/naive/struct.NaiveDate.html)
+If the `chrono-04` feature is enabled, [`chrono::NaiveTime`](https://docs.rs/chrono/0.4/chrono/naive/struct.NaiveDate.html)
 can be used to interact with the database. Although chrono can represent leap seconds, they are not supported.
 Attempts to convert [`chrono::NaiveTime`](https://docs.rs/chrono/0.4/chrono/naive/struct.NaiveDate.html) with leap
 second to `CqlTime` or write it to the database will return an error.
@@ -78,7 +78,7 @@ while let Some((time_value,)) = iter.try_next().await? {
 
 ## time::Time
 
-If `time` feature is enabled, [`time::Time`](https://docs.rs/time/0.3/time/struct.Time.html) can be used to interact
+If the `time-03` feature is enabled, [`time::Time`](https://docs.rs/time/0.3/time/struct.Time.html) can be used to interact
 with the database.
 
 ```rust

docs/source/data-types/timestamp.md

@@ -43,7 +43,7 @@ while let Some((value,)) = iter.try_next().await? {
 
 ## chrono::DateTime
 
-If full value range is not required, `chrono` feature can be used to enable support of
+If the full value range is not required, the `chrono-04` feature can be used to enable support of
 [`chrono::DateTime`](https://docs.rs/chrono/0.4/chrono/struct.DateTime.html). All values are expected to be converted
 to UTC timezone explicitly, as [timestamp](https://docs.scylladb.com/stable/cql/types.html#timestamps) doesn't store
 timezone information. Any precision finer than 1ms will be lost.
@@ -83,7 +83,7 @@ while let Some((timestamp_value,)) = iter.try_next().await? {
 
 ## time::OffsetDateTime
 
-Alternatively, `time` feature can be used to enable support of
+Alternatively, the `time-03` feature can be used to enable support of
 [`time::OffsetDateTime`](https://docs.rs/time/0.3/time/struct.OffsetDateTime.html). As
 [timestamp](https://docs.scylladb.com/stable/cql/types.html#timestamps) doesn't support timezone information, time will
 be corrected to UTC and timezone info will be erased on write. On read, UTC timestamp is returned. Any precision finer

scylla/Cargo.toml

@@ -99,4 +99,4 @@ harness = false
 [lints.rust]
 unnameable_types = "warn"
 unreachable_pub = "warn"
-unexpected_cfgs = { level = "warn", check-cfg = ['cfg(scylla_cloud_tests)'] }
+unexpected_cfgs = { level = "warn", check-cfg = ['cfg(scylla_cloud_tests)', 'cfg(cassandra_tests)'] }

scylla/src/history.rs

@@ -449,28 +449,21 @@ fn write_fiber_attempts(fiber: &FiberHistory, f: &mut std::fmt::Formatter<'_>) -
 
 #[cfg(test)]
 mod tests {
-    use std::{
-        net::{IpAddr, Ipv4Addr, SocketAddr},
-        sync::Arc,
-    };
+    use std::net::{IpAddr, Ipv4Addr, SocketAddr};
 
     use crate::{
-        query::Query,
         retry_policy::RetryDecision,
         test_utils::setup_tracing,
         transport::errors::{DbError, QueryError},
-        utils::test_utils::unique_keyspace_name,
     };
 
     use super::{
         AttemptId, AttemptResult, HistoryCollector, HistoryListener, QueryHistoryResult, QueryId,
         SpeculativeId, StructuredHistory, TimePoint,
     };
-    use crate::test_utils::create_new_session_builder;
     use assert_matches::assert_matches;
     use chrono::{DateTime, NaiveDate, NaiveDateTime, NaiveTime, Utc};
-    use futures::StreamExt as _;
-    use scylla_cql::{frame::response::result::Row, Consistency};
+    use scylla_cql::Consistency;
 
     // Set a single time for all timestamps within StructuredHistory.
     // HistoryCollector sets the timestamp to current time which changes with each test.
@@ -510,53 +503,6 @@ mod tests {
         history
     }
 
-    // Set a single node for all attempts within StructuredHistory.
-    // When running against real life nodes this address may change,
-    // setting it to one value makes it possible to run tests consistently.
-    fn set_one_node(mut history: StructuredHistory) -> StructuredHistory {
-        let the_node: SocketAddr = node1_addr();
-
-        for query in &mut history.queries {
-            for fiber in std::iter::once(&mut query.non_speculative_fiber)
-                .chain(query.speculative_fibers.iter_mut())
-            {
-                for attempt in &mut fiber.attempts {
-                    attempt.node_addr = the_node;
-                }
-            }
-        }
-
-        history
-    }
-
-    // Set a single error message for all DbErrors within StructuredHistory.
-    // The error message changes between Scylla/Cassandra/their versions.
-    // Setting it to one value makes it possible to run tests consistently.
-    fn set_one_db_error_message(mut history: StructuredHistory) -> StructuredHistory {
-        let set_msg = |err: &mut QueryError| {
-            if let QueryError::DbError(_, msg) = err {
-                *msg = "Error message from database".to_string();
-            }
-        };
-
-        for query in &mut history.queries {
-            if let Some(QueryHistoryResult::Error(_, err)) = &mut query.result {
-                set_msg(err);
-            }
-            for fiber in std::iter::once(&mut query.non_speculative_fiber)
-                .chain(query.speculative_fibers.iter_mut())
-            {
-                for attempt in &mut fiber.attempts {
-                    if let Some(AttemptResult::Error(_, err, _)) = &mut attempt.result {
-                        set_msg(err);
-                    }
-                }
-            }
-        }
-
-        history
-    }
-
     fn node1_addr() -> SocketAddr {
         SocketAddr::new(IpAddr::V4(Ipv4Addr::new(127, 0, 0, 1)), 19042)
     }
@@ -913,195 +859,4 @@ mod tests {
 ";
         assert_eq!(displayed, format!("{}", set_one_time(history)));
     }
-
-    #[tokio::test]
-    async fn successful_query_history() {
-        setup_tracing();
-        let session = create_new_session_builder().build().await.unwrap();
-
-        let mut query = Query::new("SELECT * FROM system.local");
-        let history_collector = Arc::new(HistoryCollector::new());
-        query.set_history_listener(history_collector.clone());
-
-        session.query_unpaged(query.clone(), ()).await.unwrap();
-
-        let history: StructuredHistory = history_collector.clone_structured_history();
-
-        let displayed = "Queries History:
-=== Query #0 ===
-| start_time: 2022-02-22 20:22:22 UTC
-| Non-speculative attempts:
-| - Attempt #0 sent to 127.0.0.1:19042
-|   request send time: 2022-02-22 20:22:22 UTC
-|   Success at 2022-02-22 20:22:22 UTC
-|
-| Query successful at 2022-02-22 20:22:22 UTC
-=================
-";
-        assert_eq!(
-            displayed,
-            format!(
-                "{}",
-                set_one_db_error_message(set_one_node(set_one_time(history)))
-            )
-        );
-
-        // Prepared queries retain the history listener set in Query.
-        let prepared = session.prepare(query).await.unwrap();
-        session.execute_unpaged(&prepared, ()).await.unwrap();
-
-        let history2: StructuredHistory = history_collector.clone_structured_history();
-
-        let displayed2 = "Queries History:
-=== Query #0 ===
-| start_time: 2022-02-22 20:22:22 UTC
-| Non-speculative attempts:
-| - Attempt #0 sent to 127.0.0.1:19042
-|   request send time: 2022-02-22 20:22:22 UTC
-|   Success at 2022-02-22 20:22:22 UTC
-|
-| Query successful at 2022-02-22 20:22:22 UTC
-=================
-=== Query #1 ===
-| start_time: 2022-02-22 20:22:22 UTC
-| Non-speculative attempts:
-| - Attempt #0 sent to 127.0.0.1:19042
-|   request send time: 2022-02-22 20:22:22 UTC
-|   Success at 2022-02-22 20:22:22 UTC
-|
-| Query successful at 2022-02-22 20:22:22 UTC
-=================
-";
-        assert_eq!(
-            displayed2,
-            format!(
-                "{}",
-                set_one_db_error_message(set_one_node(set_one_time(history2)))
-            )
-        );
-    }
-
-    #[tokio::test]
-    async fn failed_query_history() {
-        setup_tracing();
-        let session = create_new_session_builder().build().await.unwrap();
-
-        let mut query = Query::new("This isnt even CQL");
-        let history_collector = Arc::new(HistoryCollector::new());
-        query.set_history_listener(history_collector.clone());
-
-        assert!(session.query_unpaged(query.clone(), ()).await.is_err());
-
-        let history: StructuredHistory = history_collector.clone_structured_history();
-
-        let displayed =
-"Queries History:
-=== Query #0 ===
-| start_time: 2022-02-22 20:22:22 UTC
-| Non-speculative attempts:
-| - Attempt #0 sent to 127.0.0.1:19042
-|   request send time: 2022-02-22 20:22:22 UTC
-|   Error at 2022-02-22 20:22:22 UTC
-|   Error: Database returned an error: The submitted query has a syntax error, Error message: Error message from database
-|   Retry decision: DontRetry
-|
-| Query failed at 2022-02-22 20:22:22 UTC
-| Error: Database returned an error: The submitted query has a syntax error, Error message: Error message from database
-=================
-";
-        assert_eq!(
-            displayed,
-            format!(
-                "{}",
-                set_one_db_error_message(set_one_node(set_one_time(history)))
-            )
-        );
-    }
-
-    #[tokio::test]
-    async fn iterator_query_history() {
-        setup_tracing();
-        let session = create_new_session_builder().build().await.unwrap();
-        let ks = unique_keyspace_name();
-        session
-        .query_unpaged(format!("CREATE KEYSPACE {} WITH REPLICATION = {{'class' : 'NetworkTopologyStrategy', 'replication_factor' : 1}}", ks), &[])
-        .await
-        .unwrap();
-        session.use_keyspace(ks, true).await.unwrap();
-
-        session
-            .query_unpaged("CREATE TABLE t (p int primary key)", ())
-            .await
-            .unwrap();
-        for i in 0..32 {
-            session
-                .query_unpaged("INSERT INTO t (p) VALUES (?)", (i,))
-                .await
-                .unwrap();
-        }
-
-        let mut iter_query: Query = Query::new("SELECT * FROM t");
-        iter_query.set_page_size(8);
-        let history_collector = Arc::new(HistoryCollector::new());
-        iter_query.set_history_listener(history_collector.clone());
-
-        let mut rows_iterator = session
-            .query_iter(iter_query, ())
-            .await
-            .unwrap()
-            .rows_stream::<Row>()
-            .unwrap();
-        while let Some(_row) = rows_iterator.next().await {
-            // Receive rows...
-        }
-
-        let history = history_collector.clone_structured_history();
-
-        assert!(history.queries.len() >= 4);
-
-        let displayed_prefix = "Queries History:
-=== Query #0 ===
-| start_time: 2022-02-22 20:22:22 UTC
-| Non-speculative attempts:
-| - Attempt #0 sent to 127.0.0.1:19042
-|   request send time: 2022-02-22 20:22:22 UTC
-|   Success at 2022-02-22 20:22:22 UTC
-|
-| Query successful at 2022-02-22 20:22:22 UTC
-=================
-=== Query #1 ===
-| start_time: 2022-02-22 20:22:22 UTC
-| Non-speculative attempts:
-| - Attempt #0 sent to 127.0.0.1:19042
-|   request send time: 2022-02-22 20:22:22 UTC
-|   Success at 2022-02-22 20:22:22 UTC
-|
-| Query successful at 2022-02-22 20:22:22 UTC
-=================
-=== Query #2 ===
-| start_time: 2022-02-22 20:22:22 UTC
-| Non-speculative attempts:
-| - Attempt #0 sent to 127.0.0.1:19042
-|   request send time: 2022-02-22 20:22:22 UTC
-|   Success at 2022-02-22 20:22:22 UTC
-|
-| Query successful at 2022-02-22 20:22:22 UTC
-=================
-=== Query #3 ===
-| start_time: 2022-02-22 20:22:22 UTC
-| Non-speculative attempts:
-| - Attempt #0 sent to 127.0.0.1:19042
-|   request send time: 2022-02-22 20:22:22 UTC
-|   Success at 2022-02-22 20:22:22 UTC
-|
-| Query successful at 2022-02-22 20:22:22 UTC
-=================
-";
-        let displayed_str = format!(
-            "{}",
-            set_one_db_error_message(set_one_node(set_one_time(history)))
-        );
-
-        assert!(displayed_str.starts_with(displayed_prefix),);
-    }
 }

scylla/src/lib.rs

@@ -257,10 +257,8 @@ pub mod transport;
 
 pub(crate) mod utils;
 
-/// This module is NOT part of the public API (it is `pub` only for internal use of integration tests).
-/// Future minor releases are free to introduce breaking API changes inside it.
-#[doc(hidden)]
-pub use utils::test_utils;
+#[cfg(test)]
+pub(crate) use utils::test_utils;
 
 pub use statement::batch;
 pub use statement::prepared_statement;