nautilus_testkit/lib.rs
1// -------------------------------------------------------------------------------------------------
2// Copyright (C) 2015-2025 Posei Systems Pty Ltd. All rights reserved.
3// https://poseitrader.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
16//! Test utilities and data management for [PoseiTrader](http://poseitrader.io).
17//!
18//! The *testkit* crate provides comprehensive testing utilities including test data management,
19//! file handling, and common testing patterns. This crate supports robust testing workflows
20//! across the entire PoseiTrader ecosystem with automated data downloads and validation:
21//!
22//! - **Test data management**: Automated downloading and caching of test datasets.
23//! - **File utilities**: File integrity verification with SHA-256 checksums.
24//! - **Path resolution**: Platform-agnostic test data path management.
25//! - **Precision handling**: Support for both 64-bit and 128-bit precision test data.
26//! - **Common patterns**: Reusable test utilities and helper functions.
27//!
28//! # Platform
29//!
30//! [PoseiTrader](http://poseitrader.io) is an open-source, high-performance, production-grade
31//! algorithmic trading platform, providing quantitative traders with the ability to backtest
32//! portfolios of automated trading strategies on historical data with an event-driven engine,
33//! and also deploy those same strategies live, with no code changes.
34//!
35//! PoseiTrader's design, architecture, and implementation philosophy prioritizes software correctness and safety at the
36//! highest level, with the aim of supporting mission-critical, trading system backtesting and live deployment workloads.
37//!
38//! # Feature flags
39//!
40//! This crate provides feature flags to control source code inclusion during compilation,
41//! depending on the intended use case, i.e. whether to provide Python bindings
42//! for the [posei_trader](https://pypi.org/project/posei_trader) Python package,
43//! or as part of a Rust only build.
44//!
45//! - `python`: Enables Python bindings from [PyO3](https://pyo3.rs).
46//! - `high-precision`: Enables [high-precision mode](docs/latestnightly/getting_started/installation#precision-mode) to use 128-bit value types.
47
48#![warn(rustc::all)]
49#![deny(unsafe_code)]
50#![deny(nonstandard_style)]
51#![deny(missing_debug_implementations)]
52#![deny(clippy::missing_errors_doc)]
53#![deny(clippy::missing_panics_doc)]
54#![deny(rustdoc::broken_intra_doc_links)]
55
56pub mod common;
57pub mod files;
58
59#[cfg(feature = "python")]
60pub mod python;