chore: add snapshot testing via md files

.gitignore

@@ -19,3 +19,5 @@ cloudflare/node_modules
 cloudflare/pkg
 
 .wrangler/
+
+/tests/snapshots/*.new

.prettierrc

@@ -8,12 +8,19 @@
     {
       "files": [
         "add-field-many-list.graphql",
+        "add-field-many-list.md",
         "add-field-many.graphql",
+        "add-field-many.md",
         "inline-many.graphql",
+        "inline-many.md",
         "inline-many-list.graphql",
+        "inline-many-list.md",
         "test-grpc.graphql",
+        "test-grpc.md",
         "test-expr-success.graphql",
-        "omit-many.graphql"
+        "test-expr-success.md",
+        "omit-many.graphql",
+        "omit-many.md"
       ],
       "options": {
         "printWidth": 200

Cargo.toml

@@ -87,6 +87,8 @@ criterion = "0.5.1"
 httpmock = "0.7.0"
 pretty_assertions = "1.4.0"
 stripmargin = "0.1.1"
+markdown = "1.0.0-alpha.16"
+insta = { version = "1.34.0", features = ["json"] }
 
 [features]
 
@@ -118,7 +120,12 @@ default = ["cli", "js"]
 
 
 [workspace]
-members = [".", "autogen", "cloudflare"]
+members = [".", "autogen", "cloudflare", "testconv"]
+
+# Boost execution_spec snapshot diffing performance
+[profile.dev.package]
+insta.opt-level = 3
+similar.opt-level = 3
 
 [profile.release]
 opt-level = 3
@@ -129,6 +136,10 @@ debug = false
 incremental = false
 overflow-checks = false
 
+[[test]]
+name = "execution_spec"
+harness = false
+
 [[bench]]
 name = "json_like_bench"
 harness = false

lint.sh

@@ -40,6 +40,13 @@ run_autogen_schema() {
     return $?
 }
 
+run_testconv() {
+    MODE=$1
+    if [ "$MODE" == "fix" ]; then
+        cargo run -p testconv
+    fi
+}
+
 # Extract the mode from the argument
 if [[ $1 == "--mode="* ]]; then
     MODE=${1#--mode=}
@@ -57,6 +64,8 @@ case $MODE in
         FMT_EXIT_CODE=$?
         run_cargo_clippy $MODE
         CLIPPY_EXIT_CODE=$?
+        run_testconv $MODE
+        TESTCONV_EXIT_CODE=$?
         run_prettier $MODE
         PRETTIER_EXIT_CODE=$?
         ;;
@@ -67,6 +76,6 @@ case $MODE in
 esac
 
 # If any command failed, exit with a non-zero status code
-if [ $FMT_EXIT_CODE -ne 0 ] || [ $CLIPPY_EXIT_CODE -ne 0 ] || [ $PRETTIER_EXIT_CODE -ne 0 ] || [ $AUTOGEN_SCHEMA_EXIT_CODE -ne 0 ]; then
+if [ $FMT_EXIT_CODE -ne 0 ] || [ $CLIPPY_EXIT_CODE -ne 0 ] || [ $PRETTIER_EXIT_CODE -ne 0 ] || [ $AUTOGEN_SCHEMA_EXIT_CODE -ne 0 ] || [ $TESTCONV_EXIT_CODE -ne 0 ]; then
     exit 1
 fi

testconv/Cargo.toml

@@ -0,0 +1,18 @@
+[package]
+name = "testconv"
+version = "0.1.0"
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+derive_setters = "0.1.6"
+indexmap = { version = "2", features = ["serde"] }
+serde = { version = "1.0", features = ["derive"] }
+serde_json = "1.0"
+serde_yaml = "0.9"
+tailcall = { path = ".." }
+url = { version = "2", features = ["serde"] }
+tokio = { version = "1.35.1", features = ["rt", "macros"] }
+async-graphql = { version = "7.0.1", features = ["dynamic-schema"] }
+regex = "1.10.3"

testconv/src/common.rs

@@ -0,0 +1,89 @@
+use std::collections::BTreeMap;
+
+use indexmap::IndexMap;
+use serde::{Deserialize, Serialize};
+use tailcall::http::Method;
+use tailcall::valid::Cause;
+use url::Url;
+
+#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, Eq)]
+#[serde(rename_all = "camelCase")]
+pub enum Annotation {
+    Skip,
+    Only,
+    Fail,
+}
+
+#[derive(Serialize, Deserialize, Clone, Debug, Eq, PartialEq)]
+#[serde(rename_all = "camelCase")]
+pub struct APIRequest {
+    #[serde(default)]
+    pub method: Method,
+    pub url: Url,
+    #[serde(default)]
+    #[serde(skip_serializing_if = "BTreeMap::is_empty")]
+    pub headers: BTreeMap<String, String>,
+    #[serde(default)]
+    pub body: serde_json::Value,
+}
+
+#[derive(Serialize, Deserialize, Clone, Debug)]
+#[serde(rename_all = "camelCase")]
+pub struct APIResponse {
+    #[serde(default = "default_status")]
+    pub status: u16,
+    #[serde(default)]
+    #[serde(skip_serializing_if = "IndexMap::is_empty")]
+    pub headers: IndexMap<String, String>,
+    #[serde(default)]
+    pub body: serde_json::Value,
+}
+
+fn default_status() -> u16 {
+    200
+}
+
+#[derive(Serialize, Deserialize, Clone, Debug, Eq, PartialEq)]
+pub struct UpstreamRequest(pub APIRequest);
+
+#[derive(Serialize, Deserialize, Clone, Debug)]
+pub struct UpstreamResponse(pub APIResponse);
+
+#[derive(Serialize, Deserialize, Clone, Debug)]
+pub struct DownstreamRequest(pub APIRequest);
+
+#[derive(Serialize, Deserialize, Clone, Debug)]
+pub struct DownstreamResponse(pub APIResponse);
+
+#[derive(Serialize, Deserialize, Clone, Debug)]
+pub struct Mock {
+    pub request: UpstreamRequest,
+    pub response: UpstreamResponse,
+}
+
+#[derive(Debug, Default, Deserialize, Serialize, PartialEq)]
+pub struct SDLError {
+    pub message: String,
+    pub trace: Vec<String>,
+    pub description: Option<String>,
+}
+
+impl<'a> From<Cause<&'a str>> for SDLError {
+    fn from(value: Cause<&'a str>) -> Self {
+        SDLError {
+            message: value.message.to_string(),
+            trace: value.trace.iter().map(|e| e.to_string()).collect(),
+            description: None,
+        }
+    }
+}
+
+impl From<Cause<String>> for SDLError {
+    fn from(value: Cause<String>) -> Self {
+        SDLError {
+            message: value.message.to_string(),
+            trace: value.trace.iter().map(|e| e.to_string()).collect(),
+            description: value.description,
+        }
+    }
+}

testconv/src/http.rs

@@ -0,0 +1,41 @@
+use std::collections::HashMap;
+
+use derive_setters::Setters;
+use serde::{Deserialize, Serialize};
+use tailcall::config::Config;
+
+use crate::common::{Annotation, DownstreamRequest, DownstreamResponse, Mock, UpstreamRequest};
+
+#[derive(Serialize, Deserialize, Clone, Debug)]
+pub struct DownstreamAssertion {
+    pub request: DownstreamRequest,
+    pub response: DownstreamResponse,
+}
+
+#[derive(Serialize, Deserialize, Clone, Debug)]
+#[serde(rename_all = "camelCase")]
+pub enum ConfigSource {
+    File(String),
+    Inline(Config),
+}
+
+#[derive(Serialize, Deserialize, Clone, Setters, Debug)]
+#[serde(rename_all = "camelCase")]
+pub struct HttpSpec {
+    pub config: ConfigSource,
+    pub name: String,
+    pub description: Option<String>,
+
+    #[serde(default)]
+    pub mock: Vec<Mock>,
+
+    #[serde(default)]
+    pub env: HashMap<String, String>,
+
+    #[serde(default)]
+    pub expected_upstream_requests: Vec<UpstreamRequest>,
+    pub assert: Vec<DownstreamAssertion>,
+
+    // Annotations for the runner
+    pub runner: Option<Annotation>,
+}