Skip to content

Commit

Permalink
ApiVersions rewrite
Browse files Browse the repository at this point in the history
  • Loading branch information
rukai committed Nov 26, 2024
1 parent a6a4b1c commit 1b71e42
Show file tree
Hide file tree
Showing 3 changed files with 70 additions and 3 deletions.
3 changes: 1 addition & 2 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion shotover/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ aws-config = { version = "1.0.0", optional = true }
aws-sdk-kms = { version = "1.1.0", optional = true }
chacha20poly1305 = { version = "0.10.0", features = ["std"], optional = true }
generic-array = { version = "0.14", features = ["serde"], optional = true }
kafka-protocol = { version = "0.13.0", optional = true, default-features = false, features = ["messages_enums", "broker", "client"] }
kafka-protocol = { version = "0.13.0", optional = true, default-features = false, features = ["messages_enums", "broker", "client"], git = "https://github.com/rukai/kafka-protocol-rs", branch = "shotover_fork" }
rustls = { version = "0.23.18", default-features = false, features = ["tls12"] }
tokio-rustls = { version = "0.26", default-features = false, features = ["ring"] }
rustls-pemfile = "2.0.0"
Expand Down
68 changes: 68 additions & 0 deletions shotover/src/transforms/kafka/sink_cluster/api_versions.rs
Original file line number Diff line number Diff line change
Expand Up @@ -60,3 +60,71 @@ pub(crate) fn versions_supported_by_key(api_key: i16) -> Option<VersionRange> {
Err(_) => None,
}
}

// This test gives visibility into the api versions that shotover doesnt support yet.
// If this test is failing after a `cargo update`, you can just alter EXPECTED_ERROR_MESSAGE to include the new versions.
// The actual upgrade can be done later.
#[test]
fn check_api_version_backlog() {
use std::fmt::Write;
const EXPECTED_ERROR_MESSAGE: &str = r#"
LeaderAndIsrKey kafka-protocol=0..7 shotover=NotSupported
StopReplicaKey kafka-protocol=0..4 shotover=NotSupported
UpdateMetadataKey kafka-protocol=0..8 shotover=NotSupported
ControlledShutdownKey kafka-protocol=0..3 shotover=NotSupported
WriteTxnMarkersKey kafka-protocol=0..1 shotover=NotSupported
DescribeAclsKey kafka-protocol=0..3 shotover=NotSupported
DeleteAclsKey kafka-protocol=0..3 shotover=NotSupported
AlterReplicaLogDirsKey kafka-protocol=0..2 shotover=NotSupported
CreateDelegationTokenKey kafka-protocol=0..3 shotover=NotSupported
RenewDelegationTokenKey kafka-protocol=0..2 shotover=NotSupported
ExpireDelegationTokenKey kafka-protocol=0..2 shotover=NotSupported
DescribeDelegationTokenKey kafka-protocol=0..3 shotover=NotSupported
IncrementalAlterConfigsKey kafka-protocol=0..1 shotover=NotSupported
DescribeClientQuotasKey kafka-protocol=0..1 shotover=NotSupported
AlterClientQuotasKey kafka-protocol=0..1 shotover=NotSupported
DescribeUserScramCredentialsKey kafka-protocol=0..0 shotover=NotSupported
AlterUserScramCredentialsKey kafka-protocol=0..0 shotover=NotSupported
VoteKey kafka-protocol=0..0 shotover=NotSupported
BeginQuorumEpochKey kafka-protocol=0..0 shotover=NotSupported
EndQuorumEpochKey kafka-protocol=0..0 shotover=NotSupported
DescribeQuorumKey kafka-protocol=0..1 shotover=NotSupported
UpdateFeaturesKey kafka-protocol=0..1 shotover=NotSupported
EnvelopeKey kafka-protocol=0..0 shotover=NotSupported
FetchSnapshotKey kafka-protocol=0..0 shotover=NotSupported
BrokerRegistrationKey kafka-protocol=0..3 shotover=NotSupported
BrokerHeartbeatKey kafka-protocol=0..1 shotover=NotSupported
UnregisterBrokerKey kafka-protocol=0..0 shotover=NotSupported
AllocateProducerIdsKey kafka-protocol=0..0 shotover=NotSupported
ControllerRegistrationKey kafka-protocol=0..0 shotover=NotSupported
GetTelemetrySubscriptionsKey kafka-protocol=0..0 shotover=NotSupported
PushTelemetryKey kafka-protocol=0..0 shotover=NotSupported
AssignReplicasToDirsKey kafka-protocol=0..0 shotover=NotSupported
ListClientMetricsResourcesKey kafka-protocol=0..0 shotover=NotSupported
DescribeTopicPartitionsKey kafka-protocol=0..0 shotover=NotSupported
"#;

let mut error_message = String::new();
for api_key in ApiKey::iterate_all() {
let shotover_version = versions_supported_by_key(api_key as i16);

let kafka_protocol_version = api_key.valid_versions();
if shotover_version != Some(kafka_protocol_version) {
let shotover_version = match shotover_version {
Some(version) => format!("{version}"),
None => "NotSupported".to_owned(),
};
writeln!(
error_message,
"{api_key:?} kafka-protocol={kafka_protocol_version} shotover={shotover_version}"
)
.unwrap();
}
}

pretty_assertions::assert_eq!(
error_message.trim(),
EXPECTED_ERROR_MESSAGE.trim(),
"The list of message types not supported by shotover differs from the expected list defined in EXPECTED_ERROR_MESSAGE",
);
}

0 comments on commit 1b71e42

Please sign in to comment.