Skip to main content

qubit_fs_testkit/
lib.rs

1// =============================================================================
2//    Copyright (c) 2026 Haixing Hu.
3//
4//    SPDX-License-Identifier: Apache-2.0
5//
6//    Licensed under the Apache License, Version 2.0.
7// =============================================================================
8//! Stateful contract suites for `qubit-fs` provider implementations.
9//!
10//! ```compile_fail,E0432
11//! use qubit_fs_testkit::assert_copy_contract;
12//! ```
13//!
14//! A provider supplies its own isolated fixture and runs the public suite:
15//!
16//! ```
17//! # mod support { include!(concat!(env!("CARGO_MANIFEST_DIR"), "/tests/common/rustdoc_support.rs")); }
18//! use qubit_fs_testkit::FileSystemContract;
19//! use qubit_fs_testkit::FileSystemContractSuite;
20//!
21//! let fixture = support::RustdocSyncFixture::new();
22//! let mut suite = FileSystemContractSuite::new(&fixture);
23//! let run = suite.run_contract(FileSystemContract::Properties);
24//! run.assert_satisfied();
25//! assert!(run.cleanup().completed());
26//! ```
27
28#![deny(missing_docs)]
29
30#[cfg(feature = "async")]
31mod async_copy_cancellation_stage;
32#[cfg(feature = "async")]
33mod async_copy_fixture_case;
34#[cfg(feature = "async")]
35mod async_file_system_contract_suite;
36#[cfg(feature = "async")]
37mod async_file_system_fixture;
38#[cfg(feature = "async")]
39mod async_write_cancellation_stage;
40#[cfg(feature = "async")]
41mod async_write_fixture_case;
42mod cleanup_report;
43#[cfg(feature = "async")]
44mod contract_async_copy_failure;
45#[cfg(feature = "async")]
46mod contract_async_write_failure;
47mod contract_check;
48mod contract_check_id;
49mod contract_check_outcome;
50mod contract_context;
51mod contract_failure;
52mod contract_registration;
53mod contract_report;
54mod contract_run;
55mod contract_source;
56mod contract_temp_failure;
57mod contract_writer_failure;
58#[cfg(feature = "async")]
59mod copy_cancellation_probe;
60mod copy_fixture_case;
61mod copy_scenario;
62mod delete_scenario;
63mod file_system_contract;
64mod file_system_contract_suite;
65mod file_system_fixture;
66mod fixture_error;
67mod fixture_preparation;
68mod fixture_support;
69mod internal;
70mod read_scenario;
71#[cfg(feature = "async")]
72mod write_cancellation_probe;
73mod write_fixture_case;
74mod write_scenario;
75
76#[cfg(test)]
77pub(crate) mod tests;
78#[cfg(feature = "async")]
79pub use async_copy_cancellation_stage::AsyncCopyCancellationStage;
80#[cfg(feature = "async")]
81pub use async_copy_fixture_case::AsyncCopyFixtureCase;
82#[cfg(feature = "async")]
83pub use async_file_system_contract_suite::AsyncFileSystemContractSuite;
84#[cfg(feature = "async")]
85pub use async_file_system_fixture::AsyncFileSystemFixture;
86#[cfg(feature = "async")]
87pub use async_file_system_fixture::FixtureFuture;
88#[cfg(feature = "async")]
89pub use async_write_cancellation_stage::AsyncWriteCancellationStage;
90#[cfg(feature = "async")]
91pub use async_write_fixture_case::AsyncWriteFixtureCase;
92pub use cleanup_report::CleanupReport;
93#[cfg(feature = "async")]
94pub use contract_async_copy_failure::ContractAsyncCopyFailure;
95#[cfg(feature = "async")]
96pub use contract_async_write_failure::ContractAsyncWriteFailure;
97pub use contract_check::ContractCheck;
98pub use contract_check_id::ContractCheckId;
99pub use contract_check_outcome::ContractCheckOutcome;
100pub use contract_failure::ContractFailure;
101pub use contract_report::ContractReport;
102pub use contract_run::ContractRun;
103pub use contract_source::ContractSource;
104pub use contract_temp_failure::ContractTempFailure;
105pub use contract_writer_failure::ContractWriterFailure;
106#[cfg(feature = "async")]
107pub use copy_cancellation_probe::CopyCancellationProbe;
108pub use copy_fixture_case::CopyFixtureCase;
109pub use copy_scenario::CopyScenario;
110pub use delete_scenario::DeleteScenario;
111pub use file_system_contract::FileSystemContract;
112pub use file_system_contract_suite::FileSystemContractSuite;
113pub use file_system_fixture::FileSystemFixture;
114pub use fixture_error::FixtureError;
115pub use fixture_error::FixtureResult;
116pub use fixture_preparation::FixturePreparation;
117pub use fixture_support::FixtureSupport;
118pub use read_scenario::ReadScenario;
119#[cfg(all(test, feature = "async"))]
120pub(crate) use tests::common;
121#[cfg(feature = "async")]
122pub use write_cancellation_probe::WriteCancellationProbe;
123pub use write_fixture_case::WriteFixtureCase;
124pub use write_scenario::WriteScenario;
125
126#[cfg(test)]
127pub use crate as qubit_fs_testkit;