Introducing an automatic way to test examples

forc-plugins/forc-crypto/Cargo.toml

@@ -13,6 +13,7 @@ anyhow = "1.0.75"
 async-trait = "0.1.58"
 atty = "0.2.14"
 clap = { version = "3", features = ["derive", "env"] }
+forc = { version = "0.48.1", path = "../../forc" }
 forc-tracing = { version = "0.48.1", path = "../../forc-tracing" }
 fuel-core-types = { workspace = true }
 fuel-crypto = { workspace = true, features = ["random"] }

forc-plugins/forc-crypto/src/address.rs

@@ -4,28 +4,8 @@ use fuels_core::types::bech32::Bech32Address;
 use serde_json::json;
 use std::str::{from_utf8, FromStr};
 
-fn help() -> &'static str {
-    Box::leak(
-        format!(
-            r#"
-EXAMPLES:
-    {}
-"#,
-            examples()
-        )
-        .into_boxed_str(),
-    )
-}
-
-pub(crate) fn examples() -> &'static str {
-    r#"# Convert address formats
-
-    ## Converts address from one format to another
-    forc crypto address 0x565e671a359a43e90c4c99761a02ddc448c0fae749a3e45ffeb7d275318a7589
-
-    ## Converts address from one format to another
-    forc crypto address fuel12e0xwx34nfp7jrzvn9mp5qkac3yvp7h8fx37ghl7klf82vv2wkys6wd523
-"#
+forc::examples! {
+    [ Convert any valid address to all other supported formats => crypto "address" "fuel12e0xwx34nfp7jrzvn9mp5qkac3yvp7h8fx37ghl7klf82vv2wkys6wd523" ]
 }
 
 #[derive(Debug, clap::Args)]

forc-plugins/forc-crypto/src/args.rs

@@ -6,45 +6,19 @@ use std::{
     path::Path,
 };
 
-pub(crate) fn examples(sub_command: &str, example: &str) -> String {
-    format!(
-        r#"# Hashes a given data with the {sub_command} algorithm
-
-    ## Hashes passing the data from the argument
-    forc crypto {sub_command} "{example}"
-
-    ## Hashes a data through unix pipes
-    echo {example} | forc crypto {sub_command}
-
-    ## Hashes passing the data through the stdin
-    forc crypto {sub_command}
-    {example}^D
-
-    ## Hashes a file
-    forc crypto {sub_command} /path/to/file.txt
-"#
-    )
-}
-
-fn after_long_help() -> &'static str {
-    Box::leak(
-        format!(
-            r#"EXAMPLES:
-    {}
-    {}"#,
-            examples("keccack256", "fuel"),
-            examples("sha256", "fuel")
-        )
-        .into_boxed_str(),
-    )
+forc::examples! {
+    [ Hashes data passing as an argument with SHA256 => crypto "sha256" "test" ]
+    [ Hashes data passing as an argument with Keccak256 => crypto "keccak256" "test" ]
+    [ Hashes a file path as an argument with Sha256 => crypto "sha256" "src/args.rs" ]
+    [ Hashes a file path as an argument with Keccak256 => crypto "keccak256" "src/args.rs" ]
 }
 
 #[derive(Debug, Clone, clap::Args)]
 #[clap(
     author,
     version,
     about = "Hashes the argument or file with this hash",
-    after_long_help = after_long_help(),
+    after_long_help = help(),
 )]
 pub struct HashArgs {
     /// This argument is optional, it can be either:

forc-plugins/forc-crypto/src/keygen/new_key.rs

@@ -15,34 +15,15 @@ use std::ops::Deref;
 
 const ABOUT: &str = "Creates a new key for use with fuel-core";
 
-pub(crate) fn examples() -> String {
-    format!(
-        r#"# {}
-
-    ## Creates a new key for block-production
-    forc crypto new-key
-
-    ## Creates a new key for
-    forc crypto new-key -k peering
-    "#,
-        ABOUT
-    )
-}
-
-fn after_long_help() -> &'static str {
-    Box::leak(
-        format!(
-            r#"EXAMPLES:
-    {}"#,
-            examples()
-        )
-        .into_boxed_str(),
-    )
+forc::examples! {
+    [ Creates a new key for block production by default => crypto "new-key" ]
+    [ Creates a new key for peering => crypto "new-key" "-k" "peering" ]
+    [ Creates a new key for block production => crypto "new-key" "-k" "peering" ]
 }
 
 /// Generate a random new secret & public key in the format expected by fuel-core
 #[derive(Debug, clap::Args)]
-#[clap(author, version, about = ABOUT, after_long_help = after_long_help())]
+#[clap(author, version, about = ABOUT, after_long_help = help())]
 pub struct Arg {
     /// Key type to generate. It can either be `block-production` or `peering`.
     #[clap(

forc-plugins/forc-crypto/src/keygen/parse_secret.rs

@@ -9,30 +9,13 @@ use std::{ops::Deref, str::FromStr};
 
 const ABOUT: &str = "Parses a private key to view the associated public key";
 
-pub(crate) fn examples() -> String {
-    let secret = "{secret}";
-    format!(
-        r#"# {}
+#[cfg(test)]
+#[allow(non_upper_case_globals)]
+const PrivateKey: &str = "f5204427d0ab9a311266c96a377f7c329cb8a41b9088225b6fcf40eefb423e28";
 
-    ## Parses the secret for a block-production secret
-    forc crypto parse-secret "{secret}"
-
-    ## Parses the secret for a block-production secret
-    forc crypto parse-secret "{secret}" -k peering
-    "#,
-        ABOUT
-    )
-}
-
-fn after_long_help() -> &'static str {
-    Box::leak(
-        format!(
-            r#"EXAMPLES:
-    {}"#,
-            examples()
-        )
-        .into_boxed_str(),
-    )
+forc::examples! {
+    [ Parses the secret of a block production  => crypto "parse-secret" PrivateKey ]
+    [ Parses the secret of a peering  => crypto "parse-secret" "-k" "peering" PrivateKey ]
 }
 
 /// Parse a secret key to view the associated public key
@@ -41,7 +24,7 @@ fn after_long_help() -> &'static str {
     author,
     version,
     about = ABOUT,
-    after_long_help = after_long_help(),
+    after_long_help = help(),
 )]
 pub struct Arg {
     /// A private key in hex format

forc-plugins/forc-crypto/src/main.rs

@@ -21,15 +21,8 @@ const ABOUT: &str = "Forc plugin for hashing arbitrary data.";
 fn after_long_help() -> &'static str {
     Box::leak(
         format!(
-            r#"EXAMPLES:
-    {}
-    {}
-    {}
-    {}
-    {}
-"#,
-            args::examples("keccack256", "fuel"),
-            args::examples("sha256", "fuel"),
+            "EXAMPLES:\n{}{}{}{}",
+            args::examples(),
             address::examples(),
             keygen::new_key::examples(),
             keygen::parse_secret::examples(),

forc/Cargo.toml

@@ -29,6 +29,7 @@ forc-util = { version = "0.48.1", path = "../forc-util" }
 fs_extra = "1.2"
 fuel-asm = { workspace = true }
 hex = "0.4.3"
+paste = "1.0.14"
 serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0.73"
 sway-core = { version = "0.48.1", path = "../sway-core" }

forc/src/cli/help.rs

@@ -0,0 +1,38 @@
+#[macro_export]
+macro_rules! examples {
+    ($( [ $($description:ident)* => $command:tt $($arg:expr)* ] )*) => {
+            $(
+            $crate::paste::paste! {
+                #[cfg(test)]
+                #[test]
+                fn [<$($description:lower _)*:snake example>] () {
+
+                    let mut proc = std::process::Command::new("cargo");
+                    proc.arg("run");
+                    proc.arg("--bin");
+                    proc.arg(format!("forc-{}", stringify!($command)));
+                    proc.arg("--");
+                    $(
+                        proc.arg($arg);
+                    )*
+                    let output = proc.output().expect(stringify!($command));
+                    assert!(output.status.success(), "{}: {:?}", stringify!($($description)*), output);
+                }
+            }
+            )*
+
+        fn help() -> &'static str {
+            Box::leak(format!("EXAMPLES:\n{}", examples()).into_boxed_str())
+        }
+
+        pub fn examples() -> &'static str {
+            Box::leak( [
+            $(
+            $crate::paste::paste! {
+                    format!("\t#{}\n\tforc {} {}\n\n", stringify!($($description)*), stringify!($command), stringify!($($arg)*) )
+            },
+            )*
+            ].concat().into_boxed_str())
+        }
+    };
+}

forc/src/cli/mod.rs

@@ -24,6 +24,8 @@ pub use test::Command as TestCommand;
 use tracing::metadata::LevelFilter;
 pub use update::Command as UpdateCommand;
 
+#[macro_use]
+pub mod help;
 mod commands;
 mod plugin;
 pub mod shared;

forc/src/lib.rs

@@ -12,3 +12,5 @@ pub mod test {
 pub mod util {
     pub use sway_utils::constants;
 }
+
+pub extern crate paste;