Scaffold utility and library (#3)

Signed-off-by: Cyrill Leutwiler <bigcyrill@hotmail.com>
Signed-off-by: xermicus <bigcyrill@hotmail.com>

crates/format/src/case.rs

@@ -0,0 +1,12 @@
+use serde::Deserialize;
+
+use crate::{input::Input, mode::Mode};
+
+#[derive(Debug, Default, Deserialize, Clone, Eq, PartialEq)]
+pub struct Case {
+    pub name: Option<String>,
+    pub comment: Option<String>,
+    pub modes: Option<Vec<Mode>>,
+    pub inputs: Vec<Input>,
+    pub group: Option<String>,
+}

crates/format/src/corpus.rs

@@ -0,0 +1,67 @@
+use std::{
+    fs::File,
+    path::{Path, PathBuf},
+};
+
+use serde::Deserialize;
+
+use crate::metadata::Metadata;
+
+#[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq, Hash)]
+pub struct Corpus {
+    pub name: String,
+    pub path: PathBuf,
+}
+
+impl Corpus {
+    /// Try to read and parse the corpus definition file at given `path`.
+    pub fn try_from_path(path: &Path) -> anyhow::Result<Self> {
+        let file = File::open(path)?;
+        Ok(serde_json::from_reader(file)?)
+    }
+
+    /// Scan the corpus base directory and return all tests found.
+    pub fn enumerate_tests(&self) -> Vec<Metadata> {
+        let mut tests = Vec::new();
+        collect_metadata(&self.path, &mut tests);
+        tests
+    }
+}
+
+/// Recursively walks `path` and parses any JSON or Solidity file into a test
+/// definition [Metadata].
+///
+/// Found tests are inserted into `tests`.
+///
+/// `path` is expected to be a directory.
+pub fn collect_metadata(path: &Path, tests: &mut Vec<Metadata>) {
+    let dir_entry = match std::fs::read_dir(path) {
+        Ok(dir_entry) => dir_entry,
+        Err(error) => {
+            log::error!("failed to read dir '{}': {error}", path.display());
+            return;
+        }
+    };
+
+    for entry in dir_entry {
+        let entry = match entry {
+            Ok(entry) => entry,
+            Err(error) => {
+                log::error!("error reading dir entry: {error}");
+                continue;
+            }
+        };
+
+        let path = entry.path();
+        if path.is_dir() {
+            collect_metadata(&path, tests);
+            continue;
+        }
+
+        if path.is_file() {
+            if let Some(metadata) = Metadata::try_from_file(&path) {
+                tests.push(metadata)
+            }
+        }
+    }
+}

crates/format/src/input.rs

@@ -0,0 +1,132 @@
+use std::collections::HashMap;
+
+use alloy::{
+    json_abi::Function, network::TransactionBuilder, primitives::Address,
+    rpc::types::TransactionRequest,
+};
+use semver::VersionReq;
+use serde::{Deserialize, de::Deserializer};
+use serde_json::Value;
+
+#[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq)]
+pub struct Input {
+    #[serde(default = "default_caller")]
+    pub caller: Address,
+    pub comment: Option<String>,
+    #[serde(default = "default_instance")]
+    pub instance: String,
+    #[serde(deserialize_with = "deserialize_method")]
+    pub method: Method,
+    pub calldata: Option<Calldata>,
+    pub expected: Option<Expected>,
+    pub value: Option<String>,
+    pub storage: Option<HashMap<String, Calldata>>,
+}
+
+#[derive(Clone, Debug, Deserialize, Eq, PartialEq)]
+#[serde(untagged)]
+pub enum Expected {
+    Calldata(Calldata),
+    Expected(ExpectedOutput),
+    ExpectedMany(Vec<ExpectedOutput>),
+}
+
+#[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq)]
+pub struct ExpectedOutput {
+    compiler_version: Option<VersionReq>,
+    return_data: Option<Calldata>,
+    events: Option<Value>,
+    exception: Option<bool>,
+}
+
+#[derive(Clone, Debug, Deserialize, Eq, PartialEq)]
+#[serde(untagged)]
+pub enum Calldata {
+    Single(String),
+    Compound(Vec<String>),
+}
+
+/// Specify how the contract is called.
+#[derive(Debug, Default, Clone, Eq, PartialEq)]
+pub enum Method {
+    /// Initiate a deploy transaction, calling contracts constructor.
+    ///
+    /// Indicated by `#deployer`.
+    Deployer,
+    /// Does not calculate and insert a function selector.
+    ///
+    /// Indicated by `#fallback`.
+    #[default]
+    Fallback,
+    /// Call the public function with this selector.
+    ///
+    /// Calculates the selector if neither deployer or fallback matches.
+    Function([u8; 4]),
+}
+
+fn deserialize_method<'de, D>(deserializer: D) -> Result<Method, D::Error>
+where
+    D: Deserializer<'de>,
+{
+    Ok(match String::deserialize(deserializer)?.as_str() {
+        "#deployer" => Method::Deployer,
+        "#fallback" => Method::Fallback,
+        signature => {
+            let signature = if signature.ends_with(')') {
+                signature.to_string()
+            } else {
+                format!("{signature}()")
+            };
+            match Function::parse(&signature) {
+                Ok(function) => Method::Function(function.selector().0),
+                Err(error) => {
+                    return Err(serde::de::Error::custom(format!(
+                        "parsing function signature '{signature}' error: {error}"
+                    )));
+                }
+            }
+        }
+    })
+}
+
+impl Input {
+    fn instance_to_address(
+        &self,
+        instance: &str,
+        deployed_contracts: &HashMap<String, Address>,
+    ) -> anyhow::Result<Address> {
+        deployed_contracts
+            .get(instance)
+            .copied()
+            .ok_or_else(|| anyhow::anyhow!("instance {instance} not deployed"))
+    }
+
+    /// Parse this input into a legacy transaction.
+    pub fn legacy_transaction(
+        &self,
+        chain_id: u64,
+        nonce: u64,
+        deployed_contracts: &HashMap<String, Address>,
+    ) -> anyhow::Result<TransactionRequest> {
+        let to = match self.method {
+            Method::Deployer => Address::ZERO,
+            _ => self.instance_to_address(&self.instance, deployed_contracts)?,
+        };
+
+        Ok(TransactionRequest::default()
+            .with_from(self.caller)
+            .with_to(to)
+            .with_nonce(nonce)
+            .with_chain_id(chain_id)
+            .with_gas_price(20_000_000_000)
+            .with_gas_limit(20_000_000_000))
+    }
+}
+
+fn default_instance() -> String {
+    "Test".to_string()
+}
+
+fn default_caller() -> Address {
+    "90F8bf6A479f320ead074411a4B0e7944Ea8c9C1".parse().unwrap()
+}

crates/format/src/lib.rs

@@ -0,0 +1,7 @@
+//! The revive differential tests case format.
+
+pub mod case;
+pub mod corpus;
+pub mod input;
+pub mod metadata;
+pub mod mode;

crates/format/src/metadata.rs

@@ -0,0 +1,168 @@
+use std::{
+    collections::BTreeMap,
+    fs::{File, read_to_string},
+    path::{Path, PathBuf},
+};
+
+use serde::Deserialize;
+
+use crate::{
+    case::Case,
+    mode::{Mode, SolcMode},
+};
+
+pub const METADATA_FILE_EXTENSION: &str = "json";
+pub const SOLIDITY_CASE_FILE_EXTENSION: &str = "sol";
+pub const SOLIDITY_CASE_COMMENT_MARKER: &str = "//!";
+
+#[derive(Debug, Default, Deserialize, Clone, Eq, PartialEq)]
+pub struct Metadata {
+    pub cases: Vec<Case>,
+    pub contracts: Option<BTreeMap<String, String>>,
+    pub libraries: Option<BTreeMap<String, BTreeMap<String, String>>>,
+    pub ignore: Option<bool>,
+    pub modes: Option<Vec<Mode>>,
+    pub file_path: Option<PathBuf>,
+}
+
+impl Metadata {
+    /// Returns the solc modes of this metadata, inserting a default mode if not present.
+    pub fn solc_modes(&self) -> Vec<SolcMode> {
+        self.modes
+            .to_owned()
+            .unwrap_or_else(|| vec![Mode::Solidity(Default::default())])
+            .iter()
+            .filter_map(|mode| match mode {
+                Mode::Solidity(solc_mode) => Some(solc_mode),
+                Mode::Unknown(mode) => {
+                    log::debug!("compiler: ignoring unknown mode '{mode}'");
+                    None
+                }
+            })
+            .cloned()
+            .collect()
+    }
+
+    /// Returns the base directory of this metadata.
+    pub fn directory(&self) -> anyhow::Result<PathBuf> {
+        Ok(self
+            .file_path
+            .as_ref()
+            .and_then(|path| path.parent())
+            .ok_or_else(|| anyhow::anyhow!("metadata invalid file path: {:?}", self.file_path))?
+            .to_path_buf())
+    }
+
+    /// Extract the contract sources.
+    ///
+    /// Returns a mapping of contract IDs to their source path and contract name.
+    pub fn contract_sources(&self) -> anyhow::Result<BTreeMap<String, (PathBuf, String)>> {
+        let directory = self.directory()?;
+        let mut sources = BTreeMap::new();
+        let Some(contracts) = &self.contracts else {
+            return Ok(sources);
+        };
+
+        for (id, contract) in contracts {
+            // TODO: broken if a colon is in the dir name..
+            let mut parts = contract.split(':');
+            let (Some(file_name), Some(contract_name)) = (parts.next(), parts.next()) else {
+                anyhow::bail!("metadata contains invalid contract: {contract}");
+            };
+            let file = directory.to_path_buf().join(file_name);
+            if !file.is_file() {
+                anyhow::bail!("contract {id} is not a file: {}", file.display());
+            }
+
+            sources.insert(id.clone(), (file, contract_name.to_string()));
+        }
+
+        Ok(sources)
+    }
+
+    /// Try to parse the test metadata struct from the given file at `path`.
+    ///
+    /// Returns `None` if `path` didn't contain a test metadata or case definition.
+    ///
+    /// # Panics
+    /// Expects the supplied `path` to be a file.
+    pub fn try_from_file(path: &Path) -> Option<Self> {
+        assert!(path.is_file(), "not a file: {}", path.display());
+
+        let Some(file_extension) = path.extension() else {
+            log::debug!("skipping corpus file: {}", path.display());
+            return None;
+        };
+
+        if file_extension == METADATA_FILE_EXTENSION {
+            return Self::try_from_json(path);
+        }
+
+        if file_extension == SOLIDITY_CASE_FILE_EXTENSION {
+            return Self::try_from_solidity(path);
+        }
+
+        log::debug!("ignoring invalid corpus file: {}", path.display());
+        None
+    }
+
+    fn try_from_json(path: &Path) -> Option<Self> {
+        let file = File::open(path)
+            .inspect_err(|error| {
+                log::error!(
+                    "opening JSON test metadata file '{}' error: {error}",
+                    path.display()
+                );
+            })
+            .ok()?;
+
+        match serde_json::from_reader::<_, Metadata>(file) {
+            Ok(mut metadata) => {
+                metadata.file_path = Some(path.to_path_buf());
+                Some(metadata)
+            }
+            Err(error) => {
+                log::error!(
+                    "parsing JSON test metadata file '{}' error: {error}",
+                    path.display()
+                );
+                None
+            }
+        }
+    }
+
+    fn try_from_solidity(path: &Path) -> Option<Self> {
+        let buf = read_to_string(path)
+            .inspect_err(|error| {
+                log::error!(
+                    "opening JSON test metadata file '{}' error: {error}",
+                    path.display()
+                );
+            })
+            .ok()?
+            .lines()
+            .filter_map(|line| line.strip_prefix(SOLIDITY_CASE_COMMENT_MARKER))
+            .fold(String::new(), |mut buf, string| {
+                buf.push_str(string);
+                buf
+            });
+
+        if buf.is_empty() {
+            return None;
+        }
+
+        match serde_json::from_str::<Self>(&buf) {
+            Ok(mut metadata) => {
+                metadata.file_path = Some(path.to_path_buf());
+                Some(metadata)
+            }
+            Err(error) => {
+                log::error!(
+                    "parsing Solidity test metadata file '{}' error: {error}",
+                    path.display()
+                );
+                None
+            }
+        }
+    }
+}

crates/format/src/mode.rs

@@ -0,0 +1,96 @@
+use semver::Version;
+use serde::Deserialize;
+use serde::de::Deserializer;
+
+/// Specifies the compilation mode of the test artifact.
+#[derive(Debug, Clone, Eq, PartialEq)]
+pub enum Mode {
+    Solidity(SolcMode),
+    Unknown(String),
+}
+
+/// Specify Solidity specific compiler options.
+#[derive(Debug, Default, Clone, Eq, PartialEq)]
+pub struct SolcMode {
+    pub solc_version: Option<semver::VersionReq>,
+    solc_optimize: Option<bool>,
+    pub llvm_optimizer_settings: Vec<String>,
+}
+
+impl SolcMode {
+    /// Try to parse a mode string into a solc mode.
+    /// Returns `None` if the string wasn't a solc YUL mode string.
+    ///
+    /// The mode string is expected to start with the `Y` ID (YUL ID),
+    /// optionally followed by `+` or `-` for the solc optimizer settings.
+    ///
+    /// Options can be separated by a whitespace contain the following
+    /// - A solc `SemVer version requirement` string
+    /// - One or more `-OX` where X is a supposed to be an LLVM opt mode
+    pub fn parse_from_mode_string(mode_string: &str) -> Option<Self> {
+        let mut result = Self::default();
+
+        let mut parts = mode_string.trim().split(" ");
+
+        match parts.next()? {
+            "Y" => {}
+            "Y+" => result.solc_optimize = Some(true),
+            "Y-" => result.solc_optimize = Some(false),
+            _ => return None,
+        }
+
+        for part in parts {
+            if let Ok(solc_version) = semver::VersionReq::parse(part) {
+                result.solc_version = Some(solc_version);
+                continue;
+            }
+            if let Some(level) = part.strip_prefix("-O") {
+                result.llvm_optimizer_settings.push(level.to_string());
+                continue;
+            }
+            panic!("the YUL mode string {mode_string} failed to parse, invalid part: {part}")
+        }
+
+        Some(result)
+    }
+
+    /// Returns whether to enable the solc optimizer.
+    pub fn solc_optimize(&self) -> bool {
+        self.solc_optimize.unwrap_or(true)
+    }
+
+    /// Calculate the latest matching solc patch version. Returns:
+    /// - `latest_supported` if no version request was specified.
+    /// - A matching version with the same minor version as `latest_supported`, if any.
+    /// - `None` if no minor version of the `latest_supported` version matches.
+    pub fn last_patch_version(&self, latest_supported: &Version) -> Option<Version> {
+        let Some(version_req) = self.solc_version.as_ref() else {
+            return Some(latest_supported.to_owned());
+        };
+
+        // lgtm
+        for patch in (0..latest_supported.patch + 1).rev() {
+            let version = Version::new(0, latest_supported.minor, patch);
+            if version_req.matches(&version) {
+                return Some(version);
+            }
+        }
+
+        None
+    }
+}
+
+impl<'de> Deserialize<'de> for Mode {
+    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
+    where
+        D: Deserializer<'de>,
+    {
+        let mode_string = String::deserialize(deserializer)?;
+
+        if let Some(solc_mode) = SolcMode::parse_from_mode_string(&mode_string) {
+            return Ok(Self::Solidity(solc_mode));
+        }
+
+        Ok(Self::Unknown(mode_string))
+    }
+}