ffuzzy 0.3.16

Library to generate / parse / compare ssdeep Context Triggered Piecewise Hashes (CTPH)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165

// SPDX-License-Identifier: MIT
// SPDX-FileCopyrightText: Copyright (C) 2023–2025 Tsukasa OI <floss_ssdeep@irq.a4lg.com>.

//! Tests: [`crate::internals::compare_easy`].

#![cfg(test)]

#[cfg(all(not(feature = "std"), ffuzzy_error_in_core = "stable"))]
use core::error::Error;
#[cfg(feature = "std")]
use std::error::Error;

use alloc::format;

use crate::internals::compare_easy::{compare, ParseErrorEither, ParseErrorSide};
use crate::internals::hash::parser_state::{
    ParseError, ParseErrorInfo, ParseErrorKind, ParseErrorOrigin,
};

#[test]
fn parse_error_either_basic_and_impls() {
    // Internal values
    const SIDE: ParseErrorSide = ParseErrorSide::Left;
    const KIND: ParseErrorKind = ParseErrorKind::UnexpectedEndOfString;
    const ORIGIN: ParseErrorOrigin = ParseErrorOrigin::BlockHash1;
    const OFFSET: usize = 2;
    // Construct an error object.
    let err = ParseErrorEither(SIDE, ParseError(KIND, ORIGIN, OFFSET));
    // Check internal values.
    assert_eq!(err.side(), SIDE);
    assert_eq!(err.kind(), KIND);
    assert_eq!(err.origin(), ORIGIN);
    assert_eq!(err.offset(), OFFSET);
}

#[test]
fn parse_error_either_impls_display_and_debug_with_side() {
    for &(err, err_str_display) in crate::internals::hash::parser_state::tests::PARSE_ERROR_CASES {
        // Test Display
        assert_eq!(
            format!("{}", ParseErrorEither(ParseErrorSide::Left, err)),
            format!(
                "error occurred while parsing fuzzy hash 1 {}",
                err_str_display
            ),
            "failed on err={:?}",
            err
        );
        assert_eq!(
            format!("{}", ParseErrorEither(ParseErrorSide::Right, err)),
            format!(
                "error occurred while parsing fuzzy hash 2 {}",
                err_str_display
            ),
            "failed on err={:?}",
            err
        );
    }
}

#[cfg(any(feature = "std", ffuzzy_error_in_core = "stable"))]
#[test]
fn parse_error_either_source_with_side() {
    for &(err, _err_str_display) in crate::internals::hash::parser_state::tests::PARSE_ERROR_CASES {
        // Test source error
        assert_eq!(
            *ParseErrorEither(ParseErrorSide::Left, err)
                .source()
                .unwrap()
                .downcast_ref::<ParseError>()
                .unwrap(),
            err,
            "failed on err={:?}",
            err
        );
        assert_eq!(
            *ParseErrorEither(ParseErrorSide::Right, err)
                .source()
                .unwrap()
                .downcast_ref::<ParseError>()
                .unwrap(),
            err,
            "failed on err={:?}",
            err
        );
    }
}

#[test]
fn compare_example() {
    assert_eq!(
        compare(
            "6:3ll7QzDkmJmMHkQoO/llSZEnEuLszmbMAWn:VqDk5QtLbW",
            "6:3ll7QzDkmQjmMoDHglHOxPWT0lT0lT0lB:VqDk+n"
        )
        .unwrap(),
        46
    );
}

#[test]
fn compare_errors() {
    const STR_VALID: &str = "3::";
    const ERROR_CASES: &[(&str, ParseError)] = &[
        (
            "",
            ParseError(
                ParseErrorKind::UnexpectedEndOfString,
                ParseErrorOrigin::BlockSize,
                0,
            ),
        ),
        (
            "3:",
            ParseError(
                ParseErrorKind::UnexpectedEndOfString,
                ParseErrorOrigin::BlockHash1,
                2,
            ),
        ),
        (
            "4::",
            ParseError(
                ParseErrorKind::BlockSizeIsInvalid,
                ParseErrorOrigin::BlockSize,
                0,
            ),
        ),
    ];
    for &(hash_str_invalid, err) in ERROR_CASES {
        // Left side has an error.
        assert_eq!(
            compare(hash_str_invalid, STR_VALID),
            Err(ParseErrorEither(ParseErrorSide::Left, err)),
            "failed on hash_str_invalid={:?} (left)",
            hash_str_invalid
        );
        // Right side has an error.
        assert_eq!(
            compare(STR_VALID, hash_str_invalid),
            Err(ParseErrorEither(ParseErrorSide::Right, err)),
            "failed on hash_str_invalid={:?} (right)",
            hash_str_invalid
        );
    }
    /*
        If both sides are invalid, an error with ParseErrorSide::Left is
        generated on the current implementation but this property is not
        guaranteed by any version.
        It just makes sure that this is an actual error generated in an
        consistent manner (X side + parse error on the X side).
    */
    for &(hash_str_invalid_l, err_l) in ERROR_CASES {
        for &(hash_str_invalid_r, err_r) in ERROR_CASES {
            let err = compare(hash_str_invalid_l, hash_str_invalid_r);
            assert!(
                err == Err(ParseErrorEither(ParseErrorSide::Left, err_l))
                    || err == Err(ParseErrorEither(ParseErrorSide::Right, err_r)),
                "failed on hash_str_invalid_l={:?}, hash_str_invalid_r={:?}",
                hash_str_invalid_l,
                hash_str_invalid_r
            );
        }
    }
}