Skip to main content

nautilus_model/events/order/spec/
cancel_rejected.rs

1// -------------------------------------------------------------------------------------------------
2//  Copyright (C) 2015-2026 Nautech Systems Pty Ltd. All rights reserved.
3//  https://nautechsystems.io
4//
5//  Licensed under the GNU Lesser General Public License Version 3.0 (the "License");
6//  You may not use this file except in compliance with the License.
7//  You may obtain a copy of the License at https://www.gnu.org/licenses/lgpl-3.0.en.html
8//
9//  Unless required by applicable law or agreed to in writing, software
10//  distributed under the License is distributed on an "AS IS" BASIS,
11//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12//  See the License for the specific language governing permissions and
13//  limitations under the License.
14// -------------------------------------------------------------------------------------------------
15
16use nautilus_core::{UUID4, UnixNanos};
17use ustr::Ustr;
18
19use crate::{
20    events::OrderCancelRejected,
21    identifiers::{AccountId, ClientOrderId, InstrumentId, StrategyId, TraderId, VenueOrderId},
22    stubs::{TestDefault, test_uuid},
23};
24
25/// Test-only fluent spec for [`OrderCancelRejected`].
26///
27/// All fields carry sensible defaults so callers only set what differs.
28/// `build()` constructs the event through [`OrderCancelRejected::new`] so any future invariants
29/// added to the production constructor are exercised by tests built on this spec.
30#[derive(Debug, Clone, bon::Builder)]
31#[builder(finish_fn = into_spec)]
32pub struct OrderCancelRejectedSpec {
33    #[builder(default = TraderId::test_default())]
34    pub trader_id: TraderId,
35    #[builder(default = StrategyId::test_default())]
36    pub strategy_id: StrategyId,
37    #[builder(default = InstrumentId::test_default())]
38    pub instrument_id: InstrumentId,
39    #[builder(default = ClientOrderId::test_default())]
40    pub client_order_id: ClientOrderId,
41    #[builder(default = Ustr::from("TEST"))]
42    pub reason: Ustr,
43    #[builder(default = test_uuid())]
44    pub event_id: UUID4,
45    #[builder(default = UnixNanos::default())]
46    pub ts_event: UnixNanos,
47    #[builder(default = UnixNanos::default())]
48    pub ts_init: UnixNanos,
49    #[builder(default = false)]
50    pub reconciliation: bool,
51    pub venue_order_id: Option<VenueOrderId>,
52    pub account_id: Option<AccountId>,
53}
54
55impl<S: order_cancel_rejected_spec_builder::IsComplete> OrderCancelRejectedSpecBuilder<S> {
56    /// Builds the spec and constructs an [`OrderCancelRejected`] through its production constructor.
57    #[must_use]
58    pub fn build(self) -> OrderCancelRejected {
59        let spec = self.into_spec();
60        OrderCancelRejected::new(
61            spec.trader_id,
62            spec.strategy_id,
63            spec.instrument_id,
64            spec.client_order_id,
65            spec.reason,
66            spec.event_id,
67            spec.ts_event,
68            spec.ts_init,
69            spec.reconciliation,
70            spec.venue_order_id,
71            spec.account_id,
72        )
73    }
74}
75
76#[cfg(test)]
77mod tests {
78    use rstest::rstest;
79
80    use super::*;
81    use crate::stubs::reset_test_uuid_rng;
82
83    #[rstest]
84    fn defaults_are_sensible() {
85        // Pin the spec's no-arg defaults so accidental drift in any individual default surfaces here,
86        // rather than as silent behavior change in downstream tests.
87        let event = OrderCancelRejectedSpec::builder().build();
88        assert_eq!(event.trader_id, TraderId::test_default());
89        assert_eq!(event.strategy_id, StrategyId::test_default());
90        assert_eq!(event.instrument_id, InstrumentId::test_default());
91        assert_eq!(event.client_order_id, ClientOrderId::test_default());
92        assert_eq!(event.reason, Ustr::from("TEST"));
93        assert_eq!(event.ts_event, UnixNanos::default());
94        assert_eq!(event.ts_init, UnixNanos::default());
95        assert!(!event.reconciliation);
96        assert_eq!(event.venue_order_id, None);
97        assert_eq!(event.account_id, None);
98    }
99
100    #[rstest]
101    fn overrides_apply_through_constructor() {
102        let event = OrderCancelRejectedSpec::builder()
103            .reason(Ustr::from("ORDER_DOES_NOT_EXIST"))
104            .venue_order_id(VenueOrderId::from("V-1"))
105            .account_id(AccountId::from("SIM-002"))
106            .reconciliation(true)
107            .build();
108
109        assert_eq!(event.reason, Ustr::from("ORDER_DOES_NOT_EXIST"));
110        assert_eq!(event.venue_order_id, Some(VenueOrderId::from("V-1")));
111        assert_eq!(event.account_id, Some(AccountId::from("SIM-002")));
112        assert!(event.reconciliation);
113        assert_eq!(event.trader_id, TraderId::test_default());
114    }
115
116    #[rstest]
117    fn event_ids_are_unique_within_a_run() {
118        reset_test_uuid_rng();
119        let a = OrderCancelRejectedSpec::builder().build();
120        let b = OrderCancelRejectedSpec::builder().build();
121        let c = OrderCancelRejectedSpec::builder().build();
122        assert_ne!(a.event_id, b.event_id);
123        assert_ne!(b.event_id, c.event_id);
124        assert_ne!(a.event_id, c.event_id);
125    }
126
127    #[rstest]
128    fn event_id_sequence_is_reproducible() {
129        // Reset before each draw so the comparison is run-order independent.
130        reset_test_uuid_rng();
131        let first_run: Vec<_> = (0..3)
132            .map(|_| OrderCancelRejectedSpec::builder().build().event_id)
133            .collect();
134
135        reset_test_uuid_rng();
136        let second_run: Vec<_> = (0..3)
137            .map(|_| OrderCancelRejectedSpec::builder().build().event_id)
138            .collect();
139
140        assert_eq!(first_run, second_run);
141    }
142}