10 releases (5 breaking)

0.6.0-beta.1 Dec 1, 2023
0.5.0 Oct 19, 2023
0.4.0 Aug 21, 2023
0.3.2 Jan 19, 2023
0.1.0 Feb 18, 2022

#82 in Testing

Download history 29/week @ 2024-02-26 143/week @ 2024-03-04 144/week @ 2024-03-11 85/week @ 2024-03-18 169/week @ 2024-03-25 133/week @ 2024-04-01 126/week @ 2024-04-08 99/week @ 2024-04-15 133/week @ 2024-04-22 175/week @ 2024-04-29 128/week @ 2024-05-06 120/week @ 2024-05-13 100/week @ 2024-05-20 107/week @ 2024-05-27 133/week @ 2024-06-03 158/week @ 2024-06-10

502 downloads per month

MIT/Apache

1MB
35K SLoC

Rust 26K SLoC // 0.0% comments GraphQL 8K SLoC // 0.0% comments Python 3 SLoC

apollo-smith

A test case generator for GraphQL language.

Crates.io Download docs.rs docs

About

The goal of apollo-smith is to generate valid GraphQL documents by sampling from all available possibilities of GraphQL grammar.

We've written apollo-smith to use in fuzzing, but you may wish to use it for anything that requires GraphQL document generation.

apollo-smith is inspired by bytecodealliance's wasm-smith crate, and the article written by Nick Fitzgerald on writing test case generators in Rust.

This is still a work in progress, for outstanding issues, checkout out the apollo-smith label in our issue tracker.

Rust versions

apollo-smith is tested on the latest stable version of Rust. Older version may or may not be compatible.

Using apollo-smith with cargo fuzz

Define a new target with cargo fuzz,

$ cargo fuzz add my_apollo_smith_fuzz_target

and add apollo-smith to your Cargo.toml:

## fuzz/Cargo.toml

[dependencies]
apollo-smith = "0.6.0-beta.1"

It can then be used in a fuzz_target along with the arbitrary crate,

// fuzz/fuzz_targets/my_apollo_smith_fuzz_target.rs

#![no_main]

use libfuzzer_sys::fuzz_target;
use arbitrary::Unstructured;
use apollo_smith::DocumentBuilder;

fuzz_target!(|input: &[u8]| {
    let mut u = Unstructured::new(input);
    let gql_doc = DocumentBuilder::new(&mut u)?;
    let document = gql_doc.finish();
    let document_str = String::from(document);


});

and fuzzed with the following command:

$ cargo +nightly fuzz run my_apollo_smith_fuzz_target

Using apollo-smith with apollo-parser

You can use apollo-parser to generate valid operations in apollo-smith.

use std::fs;

use apollo_parser::Parser;
use apollo_smith::{Document, DocumentBuilder};

use libfuzzer_sys::arbitrary::{Result, Unstructured};

/// This generate an arbitrary valid GraphQL operation
pub fn generate_valid_operation(input: &[u8]) -> Result<String> {
    let parser = Parser::new(&fs::read_to_string("supergraph.graphql").expect("cannot read file"));

    let tree = parser.parse();
    if tree.errors().next().is_some() {
        panic!("cannot parse the graphql file");
    }

    let mut u = Unstructured::new(input);

    // Convert `apollo_parser::Document` into `apollo_smith::Document`.
    let apollo_smith_doc = Document::try_from(tree.document()).unwrap();

    // Create a `DocumentBuilder` given an existing document to match a schema.
    let mut gql_doc = DocumentBuilder::with_document(&mut u, apollo_smith_doc)?;
    let operation_def = gql_doc.operation_definition()?.unwrap();

    Ok(operation_def.into())
}

Limitations

  • Recursive object type not yet supported (example : myType { inner: myType })

License

Licensed under either of

at your option.

Dependencies

~7MB
~104K SLoC