Files
wickra/fuzz/fuzz_targets/indicator_update_candle.rs
T
kingchencandGitHub 4e3c41ea80 feat(family-15): add 17 risk/performance metrics (#54)
* feat(family-15): add 17 risk/performance metrics

Implements Family 15 pragmatically as standard `Indicator`s instead of a
separate `wickra-metrics` crate. Input is scalar `f64` per bar — period
return, equity sample, or per-trade P&L depending on the metric.

Scalar `Indicator<f64>` (14):
- SharpeRatio(period, risk_free)
- SortinoRatio(period, mar)
- CalmarRatio(period)
- OmegaRatio(period, threshold)
- MaxDrawdown(period)          — rolling, peak-to-trough
- AverageDrawdown(period)
- DrawdownDuration             — cumulative, bars under water (u32 output)
- PainIndex(period)
- ValueAtRisk(period, confidence)
- ConditionalValueAtRisk(period, confidence)
- ProfitFactor(period)
- GainLossRatio(period)
- RecoveryFactor               — cumulative, net return / max drawdown
- KellyCriterion(period)

Two-series `Indicator<(f64, f64)>` for (asset, benchmark) returns (3):
- TreynorRatio(period, risk_free)
- InformationRatio(period)
- Alpha(period, risk_free)     — Jensen / CAPM

Touchpoints:
- 17 new files under `crates/wickra-core/src/indicators/`.
- `mod.rs` + `lib.rs` re-exports.
- Python bindings (`bindings/python/src/lib.rs`, `__init__.py`).
- Node bindings (`bindings/node/src/lib.rs`, `index.js`).
- WASM bindings (`bindings/wasm/src/lib.rs`).
- Fuzz: scalar metrics appended to `indicator_update.rs`; new
  `indicator_update_pair.rs` fuzz target for `(f64, f64)` indicators.
- Python tests: SCALAR + new PAIR parameter lists in `test_new_indicators.py`,
  reference-value cases in `test_known_values.py`.
- Node tests: scalar factories + new pair-factory block in
  `bindings/node/__tests__/indicators.test.js`.
- Benches: 5 Family-15 benches added in `crates/wickra/benches/indicators.rs`.
- Docs: README family-table row + counter (71 -> 88), CHANGELOG entry under
  [Unreleased].

Note: Family 12 (statistik-regression, PR #51) introduces
`node_pair_indicator!` and `wasm_pair_indicator!` macros for Pearson /
Beta / Spearman. Family 15 needs the same pair-input pattern but Family 12
is not yet in main, so the three pair wrappers below are written by hand
in this PR. When PR #51 lands, the trivial merge-conflict is resolved by
keeping the macros from Family 12 and re-using them for Treynor / IR /
Alpha (drop the three handwritten wrappers).

cargo check --workspace --all-features: green.

* fix(family-15): satisfy clippy doc_markdown / if_not_else / digit_grouping

* fix(family-15): unused TreynorRatio import, duplicate pairFactories, _eq_nan inf handling

* fix(family-15): node eq() handles matching infinities for ratio indicators

* test(family-15): cover cold paths flagged by codecov patch
2026-05-26 20:44:21 +02:00

313 lines
12 KiB
Rust

#![no_main]
//! Fuzz OHLCV-input indicator updates with arbitrary candle sequences.
//!
//! Every candle-input indicator must tolerate any sequence of validated OHLCV
//! candles — extreme magnitudes, micro-spreads, zero-volume bars, abrupt
//! reversals — without panicking. The fuzzer chunks the raw `f64` stream into
//! `[open, high, low, close, volume]` tuples and constructs each candle via
//! `Candle::new`; entries that fail OHLCV-invariant validation are skipped so
//! the indicator only ever sees structurally-valid candles. Each iteration
//! then drives that candle stream through every candle-input indicator twice
//! (streaming `update` + batch).
//!
//! Audit finding R9: the previous fuzz suite had no candle-input coverage at
//! all. This target now covers every candle-input indicator including the
//! ones the audit named explicitly (ATR, ADX, Stochastic, PSAR) plus the
//! complete catalogue: Keltner, Donchian, SuperTrend, Chandelier Exit, ATR
//! Trailing Stop, Aroon, AwesomeOscillator, CCI, WilliamsR, MFI, OBV, VWAP,
//! RollingVWAP, ADL, VPT, ChaikinMoneyFlow, ChaikinOscillator, ForceIndex,
//! EaseOfMovement, NATR, AroonOscillator, ChandeKrollStop, Vortex, MassIndex,
//! ChoppinessIndex, TrueRange, ChaikinVolatility, AcceleratorOscillator,
//! BalanceOfPower, UltimateOscillator, VWMA, TypicalPrice, MedianPrice,
//! WeightedClose.
use libfuzzer_sys::fuzz_target;
use wickra_core::{
AccelerationBands, AcceleratorOscillator, AdOscillator, Adl, Adx, Adxr, Alligator,
AnchoredVwap, Aroon, AroonOscillator, Atr, AtrBands, AtrTrailingStop, AwesomeOscillator,
AwesomeOscillatorHistogram, BalanceOfPower, BatchExt, Camarilla, Candle, Cci, ChaikinMoneyFlow,
ChaikinOscillator, ChaikinVolatility, ChandeKrollStop, ChandelierExit, ChoppinessIndex,
ClassicPivots, DemandIndex, DemarkPivots, Doji, Donchian, DonchianStop, EaseOfMovement,
Engulfing, Evwma, FibonacciPivots, ForceIndex, FractalChaosBands, GarmanKlassVolatility,
Hammer, HangingMan, Harami, HeikinAshi, HiLoActivator, HurstChannel, Ichimoku, Indicator,
Inertia, InitialBalance, InvertedHammer, Keltner, Kvo, MarketFacilitationIndex, Marubozu,
MassIndex, MedianPrice, Mfi, MorningEveningStar, Natr, Nvi, Obv, OpeningRange,
ParkinsonVolatility, Pgo, PiercingDarkCloud, Psar, Pvi, RogersSatchellVolatility, RollingVwap,
Rvi, Rwi, ShootingStar, Smi, SpinningTop, StarcBands, Stochastic, SuperTrend, TdCombo,
TdCountdown, TdDeMarker, TdDifferential, TdLines, TdOpen, TdPressure, TdRangeProjection, TdRei,
TdRiskLevel, TdSequential, TdSetup, ThreeInside, ThreeOutside, ThreeSoldiersOrCrows, TrueRange,
Tsv, TtmSqueeze, Tweezer, TypicalPrice, UltimateOscillator, ValueArea, VoltyStop,
VolumeOscillator, VolumePriceTrend, Vortex, Vwap, VwapStdDevBands, Vwma, Vzo, WaveTrend,
WeightedClose, WilliamsFractals, WilliamsR, WoodiePivots, YangZhangVolatility, YoyoExit,
ZigZag,
};
/// Convert a flat `f64` stream into a `Vec<Candle>` by chunking it into
/// `[open, high, low, close, volume]` groups. Tuples that fail OHLCV
/// validation are dropped so the indicator under test only ever sees a
/// structurally-valid candle stream (the *parser* is fuzz-tested elsewhere;
/// this target focuses on indicator robustness).
fn candles_from(data: &[f64]) -> Vec<Candle> {
data.chunks_exact(5)
.enumerate()
.filter_map(|(i, ch)| {
// A monotonic timestamp avoids surprising any indicator that might
// care about ordering. The fuzz input drives OHLCV; time is just a
// tie-breaker.
Candle::new(ch[0], ch[1], ch[2], ch[3], ch[4], i as i64).ok()
})
.collect()
}
/// Streaming + batch sweep through one candle-input indicator. `#[inline(never)]`
/// keeps each indicator on its own frame in any panic backtrace.
#[inline(never)]
fn drive<I, O>(make: impl Fn() -> I, candles: &[Candle])
where
I: Indicator<Input = Candle, Output = O> + BatchExt,
{
let mut streaming = make();
for c in candles {
let _ = streaming.update(*c);
}
let _ = make().batch(candles);
}
fuzz_target!(|data: Vec<f64>| {
let candles = candles_from(&data);
if candles.is_empty() {
return;
}
// --- Volatility & ATR family ---
drive(|| Atr::new(14).unwrap(), &candles);
drive(|| Natr::new(14).unwrap(), &candles);
drive(TrueRange::new, &candles);
drive(|| ChaikinVolatility::new(10, 10).unwrap(), &candles);
drive(|| ParkinsonVolatility::new(20, 252).unwrap(), &candles);
drive(|| GarmanKlassVolatility::new(20, 252).unwrap(), &candles);
drive(|| RogersSatchellVolatility::new(20, 252).unwrap(), &candles);
drive(|| YangZhangVolatility::new(20, 252).unwrap(), &candles);
// --- Bands & Channels ---
drive(|| Keltner::new(20, 10, 2.0).unwrap(), &candles);
drive(|| Donchian::new(20).unwrap(), &candles);
// --- Trailing Stops ---
drive(|| Psar::new(0.02, 0.02, 0.20).unwrap(), &candles);
drive(|| SuperTrend::new(14, 3.0).unwrap(), &candles);
drive(|| ChandelierExit::new(22, 3.0).unwrap(), &candles);
drive(|| ChandeKrollStop::new(10, 1.0, 9).unwrap(), &candles);
drive(|| AtrTrailingStop::new(14, 3.0).unwrap(), &candles);
drive(|| HiLoActivator::new(3).unwrap(), &candles);
drive(|| VoltyStop::new(14, 2.0).unwrap(), &candles);
drive(|| YoyoExit::new(14, 2.0).unwrap(), &candles);
// --- Trend & Directional ---
drive(|| Adx::new(14).unwrap(), &candles);
drive(|| Adxr::new(14).unwrap(), &candles);
drive(|| Aroon::new(14).unwrap(), &candles);
drive(|| Alligator::new(13, 8, 5).unwrap(), &candles);
drive(|| AroonOscillator::new(14).unwrap(), &candles);
drive(|| Vortex::new(14).unwrap(), &candles);
drive(|| Rwi::new(14).unwrap(), &candles);
drive(|| WaveTrend::classic().unwrap(), &candles);
drive(|| MassIndex::new(9, 25).unwrap(), &candles);
drive(|| ChoppinessIndex::new(14).unwrap(), &candles);
// --- Momentum & Oscillators ---
drive(|| Cci::new(20).unwrap(), &candles);
drive(|| Rvi::new(10).unwrap(), &candles);
drive(|| Inertia::new(14, 20).unwrap(), &candles);
drive(|| Pgo::new(14).unwrap(), &candles);
drive(|| Smi::classic(), &candles);
drive(|| WilliamsR::new(14).unwrap(), &candles);
drive(|| AwesomeOscillator::new(5, 34).unwrap(), &candles);
drive(
|| AwesomeOscillatorHistogram::new(5, 34, 5).unwrap(),
&candles,
);
drive(|| AcceleratorOscillator::new(5, 34, 5).unwrap(), &candles);
drive(|| UltimateOscillator::new(7, 14, 28).unwrap(), &candles);
drive(BalanceOfPower::new, &candles);
// --- Volume ---
drive(Obv::new, &candles);
drive(|| Mfi::new(14).unwrap(), &candles);
drive(Vwap::new, &candles);
drive(|| RollingVwap::new(20).unwrap(), &candles);
drive(|| Vwma::new(20).unwrap(), &candles);
drive(|| Evwma::new(20).unwrap(), &candles);
drive(Adl::new, &candles);
drive(VolumePriceTrend::new, &candles);
drive(|| ChaikinMoneyFlow::new(20).unwrap(), &candles);
drive(|| ChaikinOscillator::new(3, 10).unwrap(), &candles);
drive(|| ForceIndex::new(13).unwrap(), &candles);
drive(|| EaseOfMovement::with_divisor(14, 1e8).unwrap(), &candles);
drive(|| Kvo::new(34, 55).unwrap(), &candles);
drive(|| VolumeOscillator::new(14, 28).unwrap(), &candles);
drive(Nvi::new, &candles);
drive(Pvi::new, &candles);
drive(AdOscillator::new, &candles);
drive(AnchoredVwap::new, &candles);
drive(|| DemandIndex::new(10).unwrap(), &candles);
drive(|| Tsv::new(18).unwrap(), &candles);
drive(|| Vzo::new(14).unwrap(), &candles);
drive(MarketFacilitationIndex::new, &candles);
// --- Price transformations ---
drive(TypicalPrice::new, &candles);
drive(MedianPrice::new, &candles);
drive(WeightedClose::new, &candles);
// --- Stochastic (multi-output) ---
{
let mut s = Stochastic::new(14, 3).unwrap();
for c in &candles {
let _ = s.update(*c);
}
let _ = Stochastic::new(14, 3).unwrap().batch(&candles);
}
// --- Market Profile (multi-output) ---
drive(|| ValueArea::new(20, 50, 0.70).unwrap(), &candles);
drive(|| InitialBalance::new(12).unwrap(), &candles);
drive(|| OpeningRange::new(6).unwrap(), &candles);
// --- Ichimoku (5 lines, hand-rolled because of multi-Option output) ---
{
let mut ichi = Ichimoku::classic();
for c in &candles {
let _ = ichi.update(*c);
}
let _ = Ichimoku::classic().batch(&candles);
}
// --- Heikin-Ashi (4-field candle transform) ---
{
let mut ha = HeikinAshi::new();
for c in &candles {
let _ = ha.update(*c);
}
let _ = HeikinAshi::new().batch(&candles);
}
// --- DeMark family ---
drive(|| TdSetup::new(4, 9).unwrap(), &candles);
drive(|| TdDeMarker::new(14).unwrap(), &candles);
drive(|| TdRei::new(5).unwrap(), &candles);
drive(|| TdPressure::new(5).unwrap(), &candles);
drive(|| TdCombo::new(4, 9, 2, 13).unwrap(), &candles);
drive(|| TdCountdown::new(4, 9, 2, 13).unwrap(), &candles);
drive(TdDifferential::new, &candles);
drive(TdOpen::new, &candles);
drive(TdRangeProjection::new, &candles);
{
let mut s = TdSequential::new(4, 9, 2, 13).unwrap();
for c in &candles {
let _ = s.update(*c);
}
let _ = TdSequential::new(4, 9, 2, 13).unwrap().batch(&candles);
}
{
let mut s = TdLines::new(4, 9).unwrap();
for c in &candles {
let _ = s.update(*c);
}
let _ = TdLines::new(4, 9).unwrap().batch(&candles);
}
{
let mut s = TdRiskLevel::new(4, 9).unwrap();
for c in &candles {
let _ = s.update(*c);
}
let _ = TdRiskLevel::new(4, 9).unwrap().batch(&candles);
}
// --- Pivots & Support/Resistance (multi-output) ---
drive(ClassicPivots::new, &candles);
drive(FibonacciPivots::new, &candles);
drive(Camarilla::new, &candles);
drive(WoodiePivots::new, &candles);
drive(DemarkPivots::new, &candles);
drive(WilliamsFractals::new, &candles);
drive(|| ZigZag::new(0.05).unwrap(), &candles);
// --- Donchian Stop (multi-output) ---
{
let mut s = DonchianStop::new(10).unwrap();
for c in &candles {
let _ = s.update(*c);
}
let _ = DonchianStop::new(10).unwrap().batch(&candles);
}
// --- Family 05: candle-input band/channel indicators (multi-output) ---
{
let mut ab = AccelerationBands::new(20, 0.001).unwrap();
for c in &candles {
let _ = ab.update(*c);
}
let _ = AccelerationBands::new(20, 0.001).unwrap().batch(&candles);
}
{
let mut sb = StarcBands::new(6, 15, 2.0).unwrap();
for c in &candles {
let _ = sb.update(*c);
}
let _ = StarcBands::new(6, 15, 2.0).unwrap().batch(&candles);
}
{
let mut atrb = AtrBands::new(14, 3.0).unwrap();
for c in &candles {
let _ = atrb.update(*c);
}
let _ = AtrBands::new(14, 3.0).unwrap().batch(&candles);
}
{
let mut hc = HurstChannel::new(10, 0.5).unwrap();
for c in &candles {
let _ = hc.update(*c);
}
let _ = HurstChannel::new(10, 0.5).unwrap().batch(&candles);
}
{
let mut ts = TtmSqueeze::new(20, 2.0, 1.5).unwrap();
for c in &candles {
let _ = ts.update(*c);
}
let _ = TtmSqueeze::new(20, 2.0, 1.5).unwrap().batch(&candles);
}
{
let mut fc = FractalChaosBands::new(2).unwrap();
for c in &candles {
let _ = fc.update(*c);
}
let _ = FractalChaosBands::new(2).unwrap().batch(&candles);
}
{
let mut vb = VwapStdDevBands::new(2.0).unwrap();
for c in &candles {
let _ = vb.update(*c);
}
let _ = VwapStdDevBands::new(2.0).unwrap().batch(&candles);
}
// --- Candlestick Patterns (family 14) ---
drive(Doji::new, &candles);
drive(Hammer::new, &candles);
drive(InvertedHammer::new, &candles);
drive(HangingMan::new, &candles);
drive(ShootingStar::new, &candles);
drive(Engulfing::new, &candles);
drive(Harami::new, &candles);
drive(MorningEveningStar::new, &candles);
drive(ThreeSoldiersOrCrows::new, &candles);
drive(PiercingDarkCloud::new, &candles);
drive(Marubozu::new, &candles);
drive(Tweezer::new, &candles);
drive(SpinningTop::new, &candles);
drive(ThreeInside::new, &candles);
drive(ThreeOutside::new, &candles);
});