core/fuzz/fuzz_writer.rs

// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License.  You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.  See the License for the
// specific language governing permissions and limitations
// under the License.

#![no_main]

use libfuzzer_sys::arbitrary::Arbitrary;
use libfuzzer_sys::arbitrary::Unstructured;
use libfuzzer_sys::fuzz_target;
use opendal::Operator;
use opendal::Result;
use opendal::tests::TEST_RUNTIME;
use opendal::tests::WriteAction;
use opendal::tests::WriteChecker;
use opendal::tests::init_test_service;

const MAX_DATA_SIZE: usize = 16 * 1024 * 1024;

#[derive(Debug, Clone)]
struct FuzzInput {
    actions: Vec<WriteAction>,
    buffer: Option<usize>,
    concurrent: Option<usize>,
}

impl Arbitrary<'_> for FuzzInput {
    fn arbitrary(u: &mut Unstructured<'_>) -> arbitrary::Result<Self> {
        let mut actions = vec![];
        let buffer = if u.int_in_range(0..=1)? == 1 {
            Some(u.int_in_range(1..=8 * 1024 * 1024)?)
        } else {
            None
        };
        let concurrent = if u.int_in_range(0..=1)? == 1 {
            Some(u.int_in_range(0..=16)?)
        } else {
            None
        };

        let count = u.int_in_range(1..=1024)?;

        for _ in 0..count {
            let size = u.int_in_range(1..=MAX_DATA_SIZE)?;
            actions.push(WriteAction::Write(size));
        }

        Ok(FuzzInput {
            actions,
            buffer,
            concurrent,
        })
    }
}

async fn fuzz_writer(op: Operator, input: FuzzInput) -> Result<()> {
    let path = uuid::Uuid::new_v4().to_string();

    let total_size = input
        .actions
        .iter()
        .map(|a| match a {
            WriteAction::Write(size) => *size,
        })
        .collect();

    let checker = WriteChecker::new(total_size);

    let mut writer = op.writer_with(&path);
    if let Some(buffer) = input.buffer {
        writer = writer.chunk(buffer);
    } else if let Some(min_size) = op.info().full_capability().write_multi_min_size {
        writer = writer.chunk(min_size);
    }
    if let Some(concurrent) = input.concurrent {
        writer = writer.concurrent(concurrent);
    }

    let mut writer = writer.await?;

    for chunk in checker.chunks() {
        writer.write(chunk.clone()).await?;
    }

    writer.close().await?;

    let result = op.read(&path).await?.to_bytes();

    checker.check(&result);

    op.delete(&path).await?;
    Ok(())
}

fuzz_target!(|input: FuzzInput| {
    let _ = logforth::starter_log::stderr().try_apply();

    let op = init_test_service().expect("operator init must succeed");
    if let Some(op) = op {
        if !op.info().full_capability().write_can_multi {
            log::warn!("service doesn't support write multi, skip fuzzing");
            return;
        }

        TEST_RUNTIME.block_on(async {
            fuzz_writer(op, input.clone())
                .await
                .unwrap_or_else(|err| panic!("fuzz reader must succeed: {err:?}"));
        })
    }
});