use crate::error::PfcpError;
use crate::ie::{Ie, IeType};
use crate::message::{header::Header, Message, MsgType};
use crate::types::{Seid, SequenceNumber};
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct SessionSetDeletionResponse {
pub header: Header,
pub node_id: Ie, pub cause: Ie, pub offending_ie: Option<Ie>, pub ies: Vec<Ie>,
}
impl SessionSetDeletionResponse {
pub fn new(
seq: impl Into<SequenceNumber>,
node_id: Ie,
cause: Ie,
offending_ie: Option<Ie>,
ies: Vec<Ie>,
) -> Self {
let mut payload_len = node_id.len() + cause.len();
if let Some(ref ie) = offending_ie {
payload_len += ie.len();
}
for ie in &ies {
payload_len += ie.len();
}
let mut header = Header::new(MsgType::SessionSetDeletionResponse, false, 0, seq);
header.length = 4 + payload_len;
SessionSetDeletionResponse {
header,
node_id,
cause,
offending_ie,
ies,
}
}
}
#[derive(Debug, Default)]
pub struct SessionSetDeletionResponseBuilder {
sequence: SequenceNumber,
node_id: Option<Ie>,
cause: Option<Ie>,
offending_ie: Option<Ie>,
ies: Vec<Ie>,
}
impl SessionSetDeletionResponseBuilder {
pub fn new(sequence: impl Into<SequenceNumber>) -> Self {
Self {
sequence: sequence.into(),
node_id: None,
cause: None,
offending_ie: None,
ies: Vec::new(),
}
}
pub fn node_id(mut self, node_id: Ie) -> Self {
self.node_id = Some(node_id);
self
}
pub fn cause(mut self, cause_value: crate::ie::cause::CauseValue) -> Self {
use crate::ie::cause::Cause;
use crate::ie::{Ie, IeType};
let cause = Cause::new(cause_value);
self.cause = Some(Ie::new(IeType::Cause, cause.marshal().to_vec()));
self
}
pub fn cause_accepted(self) -> Self {
self.cause(crate::ie::cause::CauseValue::RequestAccepted)
}
pub fn cause_rejected(self) -> Self {
self.cause(crate::ie::cause::CauseValue::RequestRejected)
}
pub fn cause_ie(mut self, cause: Ie) -> Self {
self.cause = Some(cause);
self
}
pub fn offending_ie(mut self, offending_ie: Ie) -> Self {
self.offending_ie = Some(offending_ie);
self
}
pub fn additional_ies(mut self, mut ies: Vec<Ie>) -> Self {
self.ies.append(&mut ies);
self
}
pub fn add_ie(mut self, ie: Ie) -> Self {
self.ies.push(ie);
self
}
pub fn build(self) -> SessionSetDeletionResponse {
let node_id = self.node_id.expect("Node ID is required");
let cause = self.cause.expect("Cause is required");
SessionSetDeletionResponse::new(self.sequence, node_id, cause, self.offending_ie, self.ies)
}
pub fn try_build(self) -> Result<SessionSetDeletionResponse, PfcpError> {
let node_id = self.node_id.ok_or_else(|| {
PfcpError::validation_error(
"SessionSetDeletionResponseBuilder",
"node_id",
"Node ID is required",
)
})?;
let cause = self.cause.ok_or_else(|| {
PfcpError::validation_error(
"SessionSetDeletionResponseBuilder",
"cause",
"Cause is required",
)
})?;
Ok(SessionSetDeletionResponse::new(
self.sequence,
node_id,
cause,
self.offending_ie,
self.ies,
))
}
pub fn marshal(self) -> Vec<u8> {
self.build().marshal()
}
}
impl Message for SessionSetDeletionResponse {
fn msg_type(&self) -> MsgType {
MsgType::SessionSetDeletionResponse
}
fn marshal(&self) -> Vec<u8> {
let mut buf = Vec::with_capacity(self.marshaled_size());
self.marshal_into(&mut buf);
buf
}
fn marshal_into(&self, buf: &mut Vec<u8>) {
buf.reserve(self.marshaled_size());
self.header.marshal_into(buf);
self.node_id.marshal_into(buf);
self.cause.marshal_into(buf);
if let Some(ref ie) = self.offending_ie {
ie.marshal_into(buf);
}
for ie in &self.ies {
ie.marshal_into(buf);
}
}
fn marshaled_size(&self) -> usize {
let mut size = self.header.len() as usize;
size += self.node_id.len() as usize;
size += self.cause.len() as usize;
if let Some(ref ie) = self.offending_ie {
size += ie.len() as usize;
}
for ie in &self.ies {
size += ie.len() as usize;
}
size
}
fn unmarshal(buf: &[u8]) -> Result<Self, PfcpError>
where
Self: Sized,
{
let header = Header::unmarshal(buf)?;
let mut node_id = None;
let mut cause = None;
let mut offending_ie = None;
let mut ies = Vec::new();
let mut cursor = header.len() as usize;
while cursor < buf.len() {
let ie = Ie::unmarshal(&buf[cursor..])?;
let ie_len = ie.len() as usize;
match ie.ie_type {
IeType::NodeId => node_id = Some(ie),
IeType::Cause => cause = Some(ie),
IeType::OffendingIe => offending_ie = Some(ie),
_ => ies.push(ie),
}
cursor += ie_len;
}
let node_id = node_id.ok_or(PfcpError::MissingMandatoryIe {
ie_type: IeType::NodeId,
message_type: Some(MsgType::SessionSetDeletionResponse),
parent_ie: None,
})?;
let cause = cause.ok_or(PfcpError::MissingMandatoryIe {
ie_type: IeType::Cause,
message_type: Some(MsgType::SessionSetDeletionResponse),
parent_ie: None,
})?;
Ok(SessionSetDeletionResponse {
header,
node_id,
cause,
offending_ie,
ies,
})
}
fn seid(&self) -> Option<Seid> {
if self.header.has_seid {
Some(self.header.seid)
} else {
None
}
}
fn sequence(&self) -> SequenceNumber {
self.header.sequence_number
}
fn set_sequence(&mut self, seq: SequenceNumber) {
self.header.sequence_number = seq;
}
fn ies(&self, ie_type: IeType) -> crate::message::IeIter<'_> {
use crate::message::IeIter;
match ie_type {
IeType::NodeId => IeIter::single(Some(&self.node_id), ie_type),
IeType::Cause => IeIter::single(Some(&self.cause), ie_type),
IeType::OffendingIe => IeIter::single(self.offending_ie.as_ref(), ie_type),
_ => IeIter::generic(&self.ies, ie_type),
}
}
fn all_ies(&self) -> Vec<&Ie> {
let mut result = vec![&self.node_id, &self.cause];
if let Some(ref ie) = self.offending_ie {
result.push(ie);
}
result.extend(self.ies.iter());
result
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::ie::cause::{Cause, CauseValue};
use crate::ie::node_id::NodeId;
use std::net::Ipv4Addr;
#[test]
fn test_session_set_deletion_response_marshal_unmarshal() {
let node_id_ie = Ie::new(
IeType::NodeId,
NodeId::IPv4(Ipv4Addr::new(10, 0, 0, 1)).marshal().to_vec(),
);
let cause_ie = Ie::new(
IeType::Cause,
Cause::new(CauseValue::RequestAccepted).marshal().to_vec(),
);
let original = SessionSetDeletionResponse::new(123, node_id_ie, cause_ie, None, Vec::new());
let marshaled = original.marshal();
let unmarshaled = SessionSetDeletionResponse::unmarshal(&marshaled).unwrap();
assert_eq!(
original.header.message_type,
unmarshaled.header.message_type
);
assert_eq!(
original.header.sequence_number,
unmarshaled.header.sequence_number
);
assert_eq!(original.node_id, unmarshaled.node_id);
assert_eq!(original.cause, unmarshaled.cause);
assert_eq!(original.offending_ie, unmarshaled.offending_ie);
}
#[test]
fn test_session_set_deletion_response_with_offending_ie() {
let node_id_ie = Ie::new(
IeType::NodeId,
NodeId::IPv4(Ipv4Addr::new(192, 168, 1, 1))
.marshal()
.to_vec(),
);
let cause_ie = Ie::new(
IeType::Cause,
Cause::new(CauseValue::InvalidLength).marshal().to_vec(),
);
let offending_ie = Ie::new(IeType::OffendingIe, vec![0x00, 0x39]);
let original = SessionSetDeletionResponse::new(
456,
node_id_ie,
cause_ie,
Some(offending_ie),
Vec::new(),
);
let marshaled = original.marshal();
let unmarshaled = SessionSetDeletionResponse::unmarshal(&marshaled).unwrap();
assert_eq!(original, unmarshaled);
assert!(unmarshaled.offending_ie.is_some());
}
#[test]
fn test_session_set_deletion_response_with_additional_ies() {
let node_id_ie = Ie::new(
IeType::NodeId,
NodeId::IPv4(Ipv4Addr::new(172, 16, 0, 1))
.marshal()
.to_vec(),
);
let cause_ie = Ie::new(
IeType::Cause,
Cause::new(CauseValue::RequestAccepted).marshal().to_vec(),
);
let additional_ies = vec![
Ie::new(IeType::LoadControlInformation, vec![0x01, 0x02, 0x03]),
Ie::new(IeType::Timer, vec![0x00, 0x00, 0x05, 0x00]), ];
let original =
SessionSetDeletionResponse::new(789, node_id_ie, cause_ie, None, additional_ies);
let marshaled = original.marshal();
let unmarshaled = SessionSetDeletionResponse::unmarshal(&marshaled).unwrap();
assert_eq!(original, unmarshaled);
assert_eq!(original.ies.len(), 2);
}
#[test]
fn test_session_set_deletion_response_missing_required_ies() {
let incomplete_data = [
0x21, 0x0F, 0x00, 0x05, 0x00, 0x13, 0x00, 0x01, 0x01, ];
let result = SessionSetDeletionResponse::unmarshal(&incomplete_data);
assert!(result.is_err());
let incomplete_data2 = [
0x21, 0x0F, 0x00, 0x09, 0x00, 0x3C, 0x00, 0x05, 0x01, 0x0A, 0x00, 0x00, 0x01, ];
let result2 = SessionSetDeletionResponse::unmarshal(&incomplete_data2);
assert!(result2.is_err());
}
#[test]
fn test_session_set_deletion_response_ies() {
let node_id_ie = Ie::new(
IeType::NodeId,
NodeId::IPv4(Ipv4Addr::new(10, 0, 0, 1)).marshal().to_vec(),
);
let cause_ie = Ie::new(
IeType::Cause,
Cause::new(CauseValue::NoResourcesAvailable)
.marshal()
.to_vec(),
);
let offending_ie = Ie::new(IeType::OffendingIe, vec![0x00, 0x39]);
let message = SessionSetDeletionResponse::new(
123,
node_id_ie,
cause_ie,
Some(offending_ie),
Vec::new(),
);
assert!(message.ies(IeType::NodeId).next().is_some());
assert!(message.ies(IeType::Cause).next().is_some());
assert!(message.ies(IeType::OffendingIe).next().is_some());
assert!(message.ies(IeType::Unknown).next().is_none());
}
#[test]
fn test_session_set_deletion_response_header_validation() {
let node_id_ie = Ie::new(
IeType::NodeId,
NodeId::IPv4(Ipv4Addr::new(10, 0, 0, 1)).marshal().to_vec(),
);
let cause_ie = Ie::new(
IeType::Cause,
Cause::new(CauseValue::RequestAccepted).marshal().to_vec(),
);
let message = SessionSetDeletionResponse::new(999, node_id_ie, cause_ie, None, Vec::new());
assert_eq!(message.msg_type(), MsgType::SessionSetDeletionResponse);
assert_eq!(*message.sequence(), 999);
assert_eq!(message.seid(), None); assert_eq!(message.version(), 1);
}
#[test]
fn test_session_set_deletion_response_error_scenarios() {
let node_id_ie = Ie::new(
IeType::NodeId,
NodeId::IPv4(Ipv4Addr::new(203, 0, 113, 1))
.marshal()
.to_vec(),
);
let error_causes = vec![
CauseValue::SessionContextNotFound,
CauseValue::SystemFailure,
CauseValue::NoResourcesAvailable,
CauseValue::ServiceNotSupported,
];
for cause_val in error_causes {
let cause_ie = Ie::new(IeType::Cause, Cause::new(cause_val).marshal().to_vec());
let message = SessionSetDeletionResponse::new(
555,
node_id_ie.clone(),
cause_ie,
None,
Vec::new(),
);
let marshaled = message.marshal();
let unmarshaled = SessionSetDeletionResponse::unmarshal(&marshaled).unwrap();
assert_eq!(message, unmarshaled);
}
}
#[test]
fn test_session_set_deletion_response_round_trip() {
let node_id_ie = Ie::new(
IeType::NodeId,
NodeId::IPv4(Ipv4Addr::new(198, 51, 100, 1))
.marshal()
.to_vec(),
);
let cause_ie = Ie::new(
IeType::Cause,
Cause::new(CauseValue::RequestAccepted).marshal().to_vec(),
);
let original = SessionSetDeletionResponse::new(777, node_id_ie, cause_ie, None, Vec::new());
let marshaled = original.marshal();
let unmarshaled = SessionSetDeletionResponse::unmarshal(&marshaled).unwrap();
assert_eq!(original, unmarshaled);
}
#[test]
fn test_session_set_deletion_response_builder_basic() {
let node_id_ie = Ie::new(
IeType::NodeId,
NodeId::IPv4(Ipv4Addr::new(10, 0, 0, 1)).marshal().to_vec(),
);
let cause_ie = Ie::new(
IeType::Cause,
Cause::new(CauseValue::RequestAccepted).marshal().to_vec(),
);
let message = SessionSetDeletionResponseBuilder::new(123)
.node_id(node_id_ie.clone())
.cause_ie(cause_ie.clone())
.build();
assert_eq!(*message.sequence(), 123);
assert_eq!(message.node_id, node_id_ie);
assert_eq!(message.cause, cause_ie);
assert!(message.offending_ie.is_none());
assert!(message.ies.is_empty());
}
#[test]
fn test_session_set_deletion_response_builder_with_offending_ie() {
let node_id_ie = Ie::new(
IeType::NodeId,
NodeId::IPv4(Ipv4Addr::new(192, 168, 1, 1))
.marshal()
.to_vec(),
);
let cause_ie = Ie::new(
IeType::Cause,
Cause::new(CauseValue::InvalidLength).marshal().to_vec(),
);
let offending_ie = Ie::new(IeType::OffendingIe, vec![0x00, 0x39]);
let message = SessionSetDeletionResponseBuilder::new(456)
.node_id(node_id_ie.clone())
.cause_ie(cause_ie.clone())
.offending_ie(offending_ie.clone())
.build();
assert_eq!(*message.sequence(), 456);
assert_eq!(message.node_id, node_id_ie);
assert_eq!(message.cause, cause_ie);
assert_eq!(message.offending_ie, Some(offending_ie));
}
#[test]
fn test_session_set_deletion_response_builder_with_additional_ies() {
let node_id_ie = Ie::new(
IeType::NodeId,
NodeId::IPv4(Ipv4Addr::new(172, 16, 0, 1))
.marshal()
.to_vec(),
);
let cause_ie = Ie::new(
IeType::Cause,
Cause::new(CauseValue::RequestAccepted).marshal().to_vec(),
);
let additional_ies = vec![
Ie::new(IeType::LoadControlInformation, vec![0x01, 0x02, 0x03]),
Ie::new(IeType::Timer, vec![0x00, 0x00, 0x05, 0x00]),
];
let message = SessionSetDeletionResponseBuilder::new(789)
.node_id(node_id_ie.clone())
.cause_ie(cause_ie.clone())
.additional_ies(additional_ies.clone())
.build();
assert_eq!(*message.sequence(), 789);
assert_eq!(message.node_id, node_id_ie);
assert_eq!(message.cause, cause_ie);
assert_eq!(message.ies, additional_ies);
}
#[test]
fn test_session_set_deletion_response_builder_add_ie() {
let node_id_ie = Ie::new(
IeType::NodeId,
NodeId::IPv4(Ipv4Addr::new(203, 0, 113, 1))
.marshal()
.to_vec(),
);
let cause_ie = Ie::new(
IeType::Cause,
Cause::new(CauseValue::NoResourcesAvailable)
.marshal()
.to_vec(),
);
let timer_ie = Ie::new(IeType::Timer, vec![0x00, 0x00, 0x0F, 0x00]);
let load_control_ie = Ie::new(IeType::LoadControlInformation, vec![0x04, 0x05]);
let message = SessionSetDeletionResponseBuilder::new(555)
.node_id(node_id_ie.clone())
.cause_ie(cause_ie.clone())
.add_ie(timer_ie.clone())
.add_ie(load_control_ie.clone())
.build();
assert_eq!(*message.sequence(), 555);
assert_eq!(message.ies.len(), 2);
assert_eq!(message.ies[0], timer_ie);
assert_eq!(message.ies[1], load_control_ie);
}
#[test]
fn test_session_set_deletion_response_builder_full() {
let node_id_ie = Ie::new(
IeType::NodeId,
NodeId::IPv4(Ipv4Addr::new(198, 51, 100, 1))
.marshal()
.to_vec(),
);
let cause_ie = Ie::new(
IeType::Cause,
Cause::new(CauseValue::SystemFailure).marshal().to_vec(),
);
let offending_ie = Ie::new(IeType::OffendingIe, vec![0x00, 0x3C]);
let timer_ie = Ie::new(IeType::Timer, vec![0x00, 0x00, 0x3C, 0x00]);
let message = SessionSetDeletionResponseBuilder::new(777)
.node_id(node_id_ie.clone())
.cause_ie(cause_ie.clone())
.offending_ie(offending_ie.clone())
.add_ie(timer_ie.clone())
.build();
assert_eq!(*message.sequence(), 777);
assert_eq!(message.node_id, node_id_ie);
assert_eq!(message.cause, cause_ie);
assert_eq!(message.offending_ie, Some(offending_ie));
assert_eq!(message.ies.len(), 1);
assert_eq!(message.ies[0], timer_ie);
}
#[test]
#[should_panic(expected = "Node ID is required")]
fn test_session_set_deletion_response_builder_missing_node_id() {
let cause_ie = Ie::new(
IeType::Cause,
Cause::new(CauseValue::RequestAccepted).marshal().to_vec(),
);
SessionSetDeletionResponseBuilder::new(123)
.cause_ie(cause_ie)
.build();
}
#[test]
#[should_panic(expected = "Cause is required")]
fn test_session_set_deletion_response_builder_missing_cause() {
let node_id_ie = Ie::new(
IeType::NodeId,
NodeId::IPv4(Ipv4Addr::new(10, 0, 0, 1)).marshal().to_vec(),
);
SessionSetDeletionResponseBuilder::new(123)
.node_id(node_id_ie)
.build();
}
#[test]
fn test_session_set_deletion_response_builder_try_build_success() {
let node_id_ie = Ie::new(
IeType::NodeId,
NodeId::IPv4(Ipv4Addr::new(10, 0, 0, 1)).marshal().to_vec(),
);
let cause_ie = Ie::new(
IeType::Cause,
Cause::new(CauseValue::RequestAccepted).marshal().to_vec(),
);
let result = SessionSetDeletionResponseBuilder::new(999)
.node_id(node_id_ie.clone())
.cause_ie(cause_ie.clone())
.try_build();
assert!(result.is_ok());
let message = result.unwrap();
assert_eq!(*message.sequence(), 999);
assert_eq!(message.node_id, node_id_ie);
assert_eq!(message.cause, cause_ie);
}
#[test]
fn test_session_set_deletion_response_builder_try_build_missing_node_id() {
let cause_ie = Ie::new(
IeType::Cause,
Cause::new(CauseValue::RequestAccepted).marshal().to_vec(),
);
let result = SessionSetDeletionResponseBuilder::new(123)
.cause_ie(cause_ie)
.try_build();
assert!(result.is_err());
assert!(matches!(
result.unwrap_err(),
PfcpError::ValidationError { .. }
));
}
#[test]
fn test_session_set_deletion_response_builder_try_build_missing_cause() {
let node_id_ie = Ie::new(
IeType::NodeId,
NodeId::IPv4(Ipv4Addr::new(10, 0, 0, 1)).marshal().to_vec(),
);
let result = SessionSetDeletionResponseBuilder::new(123)
.node_id(node_id_ie)
.try_build();
assert!(result.is_err());
assert!(matches!(
result.unwrap_err(),
PfcpError::ValidationError { .. }
));
}
#[test]
fn test_session_set_deletion_response_builder_marshal_unmarshal() {
let node_id_ie = Ie::new(
IeType::NodeId,
NodeId::IPv4(Ipv4Addr::new(203, 0, 113, 100))
.marshal()
.to_vec(),
);
let cause_ie = Ie::new(
IeType::Cause,
Cause::new(CauseValue::RequestAccepted).marshal().to_vec(),
);
let original = SessionSetDeletionResponseBuilder::new(888)
.node_id(node_id_ie)
.cause_ie(cause_ie)
.build();
let marshaled = original.marshal();
let unmarshaled = SessionSetDeletionResponse::unmarshal(&marshaled).unwrap();
assert_eq!(original, unmarshaled);
}
}