hubcio commented on code in PR #3377: URL: https://github.com/apache/iggy/pull/3377#discussion_r3347879892
########## core/integration/tests/connectors/source_suite.rs: ########## @@ -0,0 +1,97 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +use std::time::Duration; + +use iggy_common::{Consumer, Identifier, IggyMessage, MessageClient, PollingStrategy}; +use integration::harness::{TestHarness, seeds}; +use tokio::time::{sleep, timeout}; + +pub(crate) struct SourceSuiteConfig { Review Comment: `SourceSuiteConfig` carries 5 fields plus a `Default` impl, but the only caller goes through `::default()` with `min_messages=1` and never overrides anything, and `poll_until_min_messages` is `pub(crate)` with no other caller. that's parameterization with nothing to parameterize yet. non-blocking, but worth collapsing: inline the poll loop into `assert_source_produces_messages` with hardcoded constants (min 1, batch 100, 100ms retry, 5s timeout). bonus, it makes the multi-batch accumulate path unreachable by construction instead of unreachable by luck. when the real postgres/influxdb suite lands it'll want an observable-cursor abstraction, not this counter poller, so there's little to reuse here anyway. ########## core/integration/tests/connectors/source_suite.rs: ########## @@ -0,0 +1,97 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +use std::time::Duration; + +use iggy_common::{Consumer, Identifier, IggyMessage, MessageClient, PollingStrategy}; +use integration::harness::{TestHarness, seeds}; +use tokio::time::{sleep, timeout}; + +pub(crate) struct SourceSuiteConfig { + pub(crate) consumer_name: &'static str, + pub(crate) min_messages: usize, + pub(crate) poll_batch: u32, + pub(crate) retry_interval: Duration, + pub(crate) timeout: Duration, +} + +impl Default for SourceSuiteConfig { + fn default() -> Self { + Self { + consumer_name: "source_suite_consumer", + min_messages: 1, + poll_batch: 100, + retry_interval: Duration::from_millis(100), + timeout: Duration::from_secs(5), + } + } +} + +pub(crate) async fn poll_until_min_messages( + harness: &TestHarness, + config: &SourceSuiteConfig, +) -> Vec<IggyMessage> { + let client = harness.root_client().await.expect("root client"); + let stream_id: Identifier = seeds::names::STREAM.try_into().unwrap(); + let topic_id: Identifier = seeds::names::TOPIC.try_into().unwrap(); + let consumer_id: Identifier = config.consumer_name.try_into().unwrap(); + + let poll = async { + let mut messages = Vec::new(); + + loop { + if let Ok(mut polled) = client + .poll_messages( + &stream_id, + &topic_id, + None, + &Consumer::new(consumer_id.clone()), + &PollingStrategy::next(), + config.poll_batch, + true, + ) + .await + { + messages.append(&mut polled.messages); + + if messages.len() >= config.min_messages { + return messages; + } + } + + sleep(config.retry_interval).await; + } + }; + + timeout(config.timeout, poll).await.unwrap_or_else(|_| { + panic!( + "source suite timed out after {:?} waiting for {} messages for consumer {}", + config.timeout, config.min_messages, config.consumer_name + ) + }) +} + +pub(crate) async fn assert_source_produces_messages(harness: &TestHarness) -> Vec<IggyMessage> { Review Comment: `-> Vec<IggyMessage>` is unused - the sole caller (`random_source_produces_messages`) discards the result. make it `-> ()` unless a content-checking caller is coming soon. ########## core/integration/tests/connectors/source_suite.rs: ########## @@ -0,0 +1,97 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +use std::time::Duration; + +use iggy_common::{Consumer, Identifier, IggyMessage, MessageClient, PollingStrategy}; +use integration::harness::{TestHarness, seeds}; +use tokio::time::{sleep, timeout}; + +pub(crate) struct SourceSuiteConfig { + pub(crate) consumer_name: &'static str, + pub(crate) min_messages: usize, + pub(crate) poll_batch: u32, + pub(crate) retry_interval: Duration, + pub(crate) timeout: Duration, +} + +impl Default for SourceSuiteConfig { + fn default() -> Self { + Self { + consumer_name: "source_suite_consumer", + min_messages: 1, + poll_batch: 100, + retry_interval: Duration::from_millis(100), + timeout: Duration::from_secs(5), + } + } +} + +pub(crate) async fn poll_until_min_messages( + harness: &TestHarness, + config: &SourceSuiteConfig, +) -> Vec<IggyMessage> { + let client = harness.root_client().await.expect("root client"); + let stream_id: Identifier = seeds::names::STREAM.try_into().unwrap(); + let topic_id: Identifier = seeds::names::TOPIC.try_into().unwrap(); + let consumer_id: Identifier = config.consumer_name.try_into().unwrap(); + + let poll = async { + let mut messages = Vec::new(); + + loop { + if let Ok(mut polled) = client + .poll_messages( + &stream_id, + &topic_id, + None, + &Consumer::new(consumer_id.clone()), + &PollingStrategy::next(), + config.poll_batch, + true, + ) + .await + { + messages.append(&mut polled.messages); + + if messages.len() >= config.min_messages { + return messages; + } + } + + sleep(config.retry_interval).await; + } + }; + + timeout(config.timeout, poll).await.unwrap_or_else(|_| { + panic!( + "source suite timed out after {:?} waiting for {} messages for consumer {}", + config.timeout, config.min_messages, config.consumer_name + ) + }) +} + +pub(crate) async fn assert_source_produces_messages(harness: &TestHarness) -> Vec<IggyMessage> { + let messages = poll_until_min_messages(harness, &SourceSuiteConfig::default()).await; + assert!( Review Comment: this `assert!(!messages.is_empty())` can't fire - `poll_until_min_messages` only returns when `len() >= min_messages` (default 1) or panics on timeout, so a successful return already guarantees non-empty. drop it. (if you inline the loop here as suggested above it turns into a real guard, since the threshold constant would live alongside.) ########## core/integration/tests/connectors/source_suite.rs: ########## @@ -0,0 +1,97 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +use std::time::Duration; + +use iggy_common::{Consumer, Identifier, IggyMessage, MessageClient, PollingStrategy}; +use integration::harness::{TestHarness, seeds}; +use tokio::time::{sleep, timeout}; + +pub(crate) struct SourceSuiteConfig { + pub(crate) consumer_name: &'static str, + pub(crate) min_messages: usize, + pub(crate) poll_batch: u32, + pub(crate) retry_interval: Duration, + pub(crate) timeout: Duration, +} + +impl Default for SourceSuiteConfig { + fn default() -> Self { + Self { + consumer_name: "source_suite_consumer", Review Comment: the `source_suite` naming (this file, the struct, the `source_suite_consumer` id, the `source suite timed out` panic text) over-promises - the actual behaviour suite was deferred to the postgres/influxdb follow-up, and this is a liveness smoke for the one pure-test source. renaming to something like `random_source_liveness` would make the name match the scope. follow-up, not blocking. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
