mutatis 0.5.2

`mutatis` is a library for writing custom, structure-aware test-case mutators for fuzzers in Rust.
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

use super::*;
use std::ffi::OsString;

/// The default mutator for `OsString` values.
///
/// See the [`os_string()`] function to create new instances and for example
/// usage.
#[derive(Clone, Debug, Default)]
pub struct OsStringMutator {
    string_mutator: StringMutator<Char>,
}

/// Create a new mutator for `OsString` values.
///
/// # Example
///
/// ```
/// # fn foo() -> mutatis::Result<()> {
/// use mutatis::{mutators as m, Mutate, Session};
/// use std::ffi::OsString;
///
/// let mut value = OsString::from("hello");
///
/// let mut mutator = m::os_string();
///
/// let mut session = Session::new();
/// for _ in 0..5 {
///     session.mutate_with(&mut mutator, &mut value)?;
///     println!("value = {value:?}");
/// }
///
/// // Example output:
/// //
/// //     value = ".."
/// //     value = "\\"
/// //     value = "\\"
/// //     value = "\\🭪"
/// # Ok(()) }
/// # foo().unwrap();
/// ```
pub fn os_string() -> OsStringMutator {
    OsStringMutator::default()
}

impl Mutate<OsString> for OsStringMutator {
    #[inline]
    fn mutation_count(&self, value: &OsString, shrink: bool) -> core::option::Option<u32> {
        let can_remove = value.to_str().map_or(false, |s| !s.is_empty());
        let mut count = 0u32;
        // Remove a random character.
        count += can_remove as u32;
        // Add a random character.
        count += !shrink as u32;
        // Special: empty.
        count += !value.is_empty() as u32;
        // Specials: ".", "..", "/", "\\".
        count += 4;
        Some(count)
    }

    #[inline]
    fn mutate(&mut self, c: &mut Candidates, value: &mut OsString) -> Result<()> {
        // Remove a random character.
        if let Some(s) = value.to_str() {
            let len = s.len();
            if len != 0 {
                c.mutation(|ctx| {
                    let i = ctx.rng().gen_index(len).unwrap();
                    let s: alloc::string::String = value
                        .to_str()
                        .unwrap()
                        .char_indices()
                        .filter_map(|(j, c)| if i == j { None } else { Some(c) })
                        .collect();
                    *value = OsString::from(s);
                    Ok(())
                })?;
            }
        }

        // Add a random character.
        if !c.shrink() {
            c.mutation(|ctx| {
                let ch = ctx.rng().gen_char();
                let mut buf = [0u8; 4];
                let s = ch.encode_utf8(&mut buf);
                value.push(s);
                Ok(())
            })?;
        }

        // Special: empty.
        if !value.is_empty() {
            c.mutation(|_ctx| {
                *value = OsString::new();
                Ok(())
            })?;
        }

        // Special: ".".
        c.mutation(|_ctx| {
            *value = OsString::from(".");
            Ok(())
        })?;

        // Special: "..".
        c.mutation(|_ctx| {
            *value = OsString::from("..");
            Ok(())
        })?;

        // Special: "/".
        c.mutation(|_ctx| {
            *value = OsString::from("/");
            Ok(())
        })?;

        // Special: "\\".
        c.mutation(|_ctx| {
            *value = OsString::from("\\");
            Ok(())
        })?;

        Ok(())
    }
}

impl Generate<OsString> for OsStringMutator {
    #[inline]
    fn generate(&mut self, ctx: &mut Context) -> Result<OsString> {
        let s = self.string_mutator.generate(ctx)?;
        Ok(OsString::from(s))
    }
}

impl DefaultMutate for OsString {
    type DefaultMutate = OsStringMutator;
}