wasm-testsuite 0.7.2

use include_dir::{Dir, include_dir};
use std::{
    fmt::{Debug, Display},
    str::FromStr,
};

static DATA: Dir<'_> = include_dir!("$CARGO_MANIFEST_DIR/data");

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[non_exhaustive]
pub enum Proposal {
    Annotations,
    BulkMemoryOperations,
    CustomPageSizes,
    CustomDescriptors,
    ExceptionHandling,
    ExtendedConst,
    FunctionReferences,
    GC,
    Memory64,
    MultiMemory,
    MultiValue,
    MutableGlobal,
    NontrappingFloatToIntConversions,
    ReferenceTypes,
    RelaxedSimd,
    SignExtensionOps,
    Simd,
    TailCall,
    Threads,
    WideArithmetic,
}

impl Proposal {
    pub fn all() -> &'static [Proposal] {
        &[
            Proposal::Annotations,
            Proposal::BulkMemoryOperations,
            Proposal::CustomPageSizes,
            Proposal::CustomDescriptors,
            Proposal::ExceptionHandling,
            Proposal::ExtendedConst,
            Proposal::FunctionReferences,
            Proposal::GC,
            Proposal::Memory64,
            Proposal::MultiMemory,
            Proposal::MultiValue,
            Proposal::MutableGlobal,
            Proposal::NontrappingFloatToIntConversions,
            Proposal::ReferenceTypes,
            Proposal::RelaxedSimd,
            Proposal::SignExtensionOps,
            Proposal::Simd,
            Proposal::TailCall,
            Proposal::Threads,
            Proposal::WideArithmetic,
        ]
    }
}

impl Display for Proposal {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.write_str((*self).into())
    }
}

impl From<Proposal> for &'static str {
    fn from(proposal: Proposal) -> &'static str {
        match proposal {
            Proposal::Annotations => "annotations",
            Proposal::CustomPageSizes => "custom-page-sizes",
            Proposal::CustomDescriptors => "custom-descriptors",
            Proposal::ExceptionHandling => "exceptions",
            Proposal::ExtendedConst => "extended-const",
            Proposal::FunctionReferences => "function-references",
            Proposal::GC => "gc",
            Proposal::Memory64 => "memory64",
            Proposal::MultiMemory => "multi-memory",
            Proposal::Simd => "simd",
            Proposal::RelaxedSimd => "relaxed-simd",
            Proposal::TailCall => "tail-call",
            Proposal::Threads => "threads",
            Proposal::WideArithmetic => "wide-arithmetic",
            Proposal::BulkMemoryOperations => "bulk-memory",
            Proposal::MultiValue => "multi-value",
            Proposal::MutableGlobal => "mutable-global",
            Proposal::NontrappingFloatToIntConversions => "nontrapping-float-to-int-conversions",
            Proposal::ReferenceTypes => "reference-types",
            Proposal::SignExtensionOps => "sign-extension-ops",
        }
    }
}

impl From<&Proposal> for Proposal {
    fn from(val: &Proposal) -> Self {
        *val
    }
}

impl FromStr for Proposal {
    type Err = ();

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        Ok(match s {
            "annotations" => Proposal::Annotations,
            "custom-page-sizes" => Proposal::CustomPageSizes,
            "custom-descriptors" => Proposal::CustomDescriptors,
            "exception-handling" | "exceptions" => Proposal::ExceptionHandling,
            "extended-const" => Proposal::ExtendedConst,
            "function-references" => Proposal::FunctionReferences,
            "gc" => Proposal::GC,
            "memory64" => Proposal::Memory64,
            "multi-memory" => Proposal::MultiMemory,
            "simd" => Proposal::Simd,
            "relaxed-simd" => Proposal::RelaxedSimd,
            "tail-call" => Proposal::TailCall,
            "threads" => Proposal::Threads,
            "wide-arithmetic" => Proposal::WideArithmetic,
            "bulk-memory-operations" | "bulk-memory" => Proposal::BulkMemoryOperations,
            "multi-value" => Proposal::MultiValue,
            "mutable-global" => Proposal::MutableGlobal,
            "nontrapping-float-to-int-conversions" => Proposal::NontrappingFloatToIntConversions,
            "reference-types" => Proposal::ReferenceTypes,
            "sign-extension-ops" => Proposal::SignExtensionOps,
            _ => return Err(()),
        })
    }
}

#[derive(Debug, Clone, Copy)]
#[non_exhaustive]
pub enum SpecVersion {
    V1,
    V2,
    V3,
    Latest,
}

impl From<&SpecVersion> for SpecVersion {
    fn from(val: &SpecVersion) -> Self {
        *val
    }
}

impl SpecVersion {
    fn name(self) -> &'static str {
        match self {
            Self::V1 => "wasm-v1",
            Self::V2 => "wasm-v2",
            Self::V3 => "wasm-v3",
            Self::Latest => "wasm-latest",
        }
    }

    pub fn all() -> &'static [SpecVersion] {
        &[
            SpecVersion::V1,
            SpecVersion::V2,
            SpecVersion::V3,
            SpecVersion::Latest,
        ]
    }
}

/// Get all test files associated with a proposal
pub fn proposal(name: impl Into<Proposal>) -> impl Iterator<Item = TestFile<'static>> {
    let name: &'static str = name.into().into();
    let tests = DATA
        .get_dir(format!("proposals/{name}"))
        .expect("spec dir should always exist");

    tests.files().map(|file| TestFile {
        parent: name.to_string(),
        name: file
            .path()
            .file_name()
            .unwrap_or_default()
            .to_string_lossy()
            .to_string(),
        contents: file.contents_utf8().expect("file should be utf8"),
    })
}

/// Get all test files associated with a spec version
pub fn spec(version: impl Into<SpecVersion>) -> impl Iterator<Item = TestFile<'static>> {
    let name = version.into().name();
    let tests = DATA.get_dir(name).expect("spec dir should always exist");

    tests.files().map(|file| TestFile {
        parent: name.to_string(),
        name: file
            .path()
            .file_name()
            .unwrap_or_default()
            .to_string_lossy()
            .to_string(),
        contents: file.contents_utf8().expect("file should be utf8"),
    })
}

/// A test file
#[derive(Debug)]
pub struct TestFile<'a> {
    pub parent: String,
    pub name: String,
    pub contents: &'a str,
}

impl<'a> TestFile<'a> {
    /// Get the name of the test file
    pub fn name(&self) -> &str {
        &self.name
    }

    /// Get the parent of the test file (either a proposal or a spec version)
    pub fn parent(&self) -> &str {
        &self.parent
    }

    /// Get the raw contents of the test file
    pub fn raw(&self) -> &'a str {
        self.contents
    }

    #[cfg(feature = "wast")]
    /// Parse the contents of the test file
    pub fn wast(&self) -> wast::parser::Result<WastBuffer<'a>> {
        let mut lexer = wast::lexer::Lexer::new(self.contents);
        lexer.allow_confusing_unicode(true);
        let parse_buffer = wast::parser::ParseBuffer::new_with_lexer(lexer)?;

        Ok(WastBuffer {
            buffer: parse_buffer,
        })
    }
}

/// A wrapper around [`wast::parser::ParseBuffer`]
pub struct WastBuffer<'a> {
    // this wrapper struct is necessary to not use self-referential structs as WastDirective
    // contains a reference to the buffer which contains a reference to the original file data.
    buffer: wast::parser::ParseBuffer<'a>,
}

impl Debug for WastBuffer<'_> {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("WastBuffer").finish()
    }
}

impl<'a> WastBuffer<'a> {
    // Get the wast directives from the buffer
    pub fn directives(&'a self) -> wast::parser::Result<Vec<wast::WastDirective<'a>>> {
        Ok(wast::parser::parse::<wast::Wast<'a>>(&self.buffer)?.directives)
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_enum() {
        for p in Proposal::all() {
            let name = p.to_string();
            let parsed = Proposal::from_str(&name).expect("Failed to parse proposal");
            assert_eq!(*p, parsed);
        }
    }

    #[test]
    fn test_proposals() {
        for p in Proposal::all() {
            for test in proposal(p) {
                if let Err(e) = test.wast().expect("Failed to lex wast").directives() {
                    panic!(
                        "Failed to parse wast for {}/{}: {e:?}",
                        test.parent, test.name
                    );
                }
            }
        }
    }

    #[test]
    fn test_spec_versions() {
        for v in SpecVersion::all() {
            for test in spec(v) {
                if let Err(e) = test.wast().expect("Failed to lex wast").directives() {
                    panic!("Failed to parse wast: {e:?}, {test:?}");
                }
            }
        }
    }
}