move tcp_echo_server from doc to example, test that it builds and parses as component

Author: pchickey

Cargo.toml

@@ -1,13 +1,12 @@
 [package]
 name = "wstd"
 version = "0.4.0"
-license = "MIT OR Apache-2.0 OR Apache-2.0 WITH LLVM-exception"
+license.workspace = true
 repository = "https://github.com/yoshuawuyts/wstd"
 documentation = "https://docs.rs/wstd"
 description = "An async standard library for Wasm Components and WASI 0.2"
 readme = "README.md"
-edition = "2021"
-resolver = "2"
+edition.workspace = true
 keywords = ["WebAssembly", "async", "stdlib", "Components"]
 categories = []
 authors = [
@@ -17,8 +16,32 @@ authors = [
 [features]
 
 [dependencies]
+slab.workspace = true
+url.workspace = true
+wasi.workspace = true
+
+[dev-dependencies]
+test-program-suite.workspace = true
+wasmtime.workspace = true
+
+[workspace]
+members = [
+    "test-programs",
+    "test-programs/suite",
+]
+resolver = "2"
+
+[workspace.package]
+edition = "2021"
+license = "MIT OR Apache-2.0 OR Apache-2.0 WITH LLVM-exception"
+
+[workspace.dependencies]
+cargo_metadata = "0.18.1"
+heck = "0.5"
 slab = "0.4.9"
+test-programs = { path = "test-programs" }
+test-program-suite = { path = "test-programs/suite" }
 url = "2.5.0"
 wasi = "0.13.1"
-
-[dev-dependencies]
+wstd = { path = "." }
+wasmtime = "26"

examples/tcp_echo_server.rs

@@ -0,0 +1,20 @@
+use wstd::io;
+use wstd::iter::AsyncIterator;
+use wstd::net::TcpListener;
+use wstd::runtime::block_on;
+
+fn main() -> io::Result<()> {
+    block_on(async move {
+        let listener = TcpListener::bind("127.0.0.1:8080").await?;
+        println!("Listening on {}", listener.local_addr()?);
+        println!("type `nc localhost 8080` to create a TCP client");
+
+        let mut incoming = listener.incoming();
+        while let Some(stream) = incoming.next().await {
+            let stream = stream?;
+            println!("Accepted from: {}", stream.peer_addr()?);
+            io::copy(&stream, &stream).await?;
+        }
+        Ok(())
+    })
+}

src/lib.rs

@@ -13,26 +13,7 @@
 //! **TCP echo server**
 //!
 //! ```rust,no_run
-//! use wstd::io;
-//! use wstd::iter::AsyncIterator;
-//! use wstd::net::TcpListener;
-//! use wstd::runtime::block_on;
-//!
-//! fn main() -> io::Result<()> {
-//!     block_on(async move {
-//!         let listener = TcpListener::bind("127.0.0.1:8080").await?;
-//!         println!("Listening on {}", listener.local_addr()?);
-//!         println!("type `nc localhost 8080` to create a TCP client");
-//!
-//!         let mut incoming = listener.incoming();
-//!         while let Some(stream) = incoming.next().await {
-//!             let stream = stream?;
-//!             println!("Accepted from: {}", stream.peer_addr()?);
-//!             io::copy(&stream, &stream).await?;
-//!         }
-//!         Ok(())
-//!     })
-//! }
+#![doc = include_str!("../examples/tcp_echo_server.rs")]
 //! ```
 //!
 //! # Design Decisions

test-programs/Cargo.toml

@@ -0,0 +1,8 @@
+[package]
+name = "test-programs"
+version = "0.1.0"
+edition = "2021"
+publish = false
+
+[dependencies]
+wstd.workspace = true

test-programs/src/bin/tcp_echo_server.rs

@@ -0,0 +1 @@
+include!("../../../examples/tcp_echo_server.rs");

test-programs/suite/Cargo.toml

@@ -0,0 +1,12 @@
+[package]
+name = "test-program-suite"
+version = "0.1.0"
+edition.workspace = true
+license.workspace = true
+publish = false
+
+[dependencies]
+
+[build-dependencies]
+cargo_metadata.workspace = true
+heck.workspace = true

test-programs/suite/build.rs

@@ -0,0 +1,62 @@
+use heck::ToShoutySnakeCase;
+use std::env::var_os;
+use std::path::PathBuf;
+use std::process::Command;
+
+fn main() {
+    let out_dir = PathBuf::from(var_os("OUT_DIR").expect("OUT_DIR env var exists"));
+
+    let meta = cargo_metadata::MetadataCommand::new()
+        .exec()
+        .expect("cargo metadata");
+    let test_programs_meta = meta
+        .packages
+        .iter()
+        .find(|p| p.name == "test-programs")
+        .expect("test-programs is in cargo metadata");
+    let test_programs_root = test_programs_meta.manifest_path.parent().unwrap();
+    println!(
+        "cargo:rerun-if-changed={}",
+        test_programs_root.as_os_str().to_str().unwrap()
+    );
+
+    let status = Command::new("cargo")
+        .arg("build")
+        .arg("--target=wasm32-wasip2")
+        .arg("--package=test-programs")
+        .env("CARGO_TARGET_DIR", &out_dir)
+        .env("CARGO_PROFILE_DEV_DEBUG", "2")
+        .env("RUSTFLAGS", rustflags())
+        .env_remove("CARGO_ENCODED_RUSTFLAGS")
+        .status()
+        .expect("cargo build test programs");
+    assert!(status.success());
+
+    let mut generated_code = "// THIS FILE IS GENERATED CODE\n".to_string();
+
+    for binary in test_programs_meta
+        .targets
+        .iter()
+        .filter(|t| t.kind == ["bin"])
+    {
+        let component_path = out_dir
+            .join("wasm32-wasip2")
+            .join("debug")
+            .join(format!("{}.wasm", binary.name));
+
+        let const_name = binary.name.to_shouty_snake_case();
+        generated_code += &format!(
+            "pub const {const_name}: &str = {:?};\n",
+            component_path.as_os_str().to_str().expect("path is str")
+        );
+    }
+
+    std::fs::write(out_dir.join("gen.rs"), generated_code).unwrap();
+}
+
+fn rustflags() -> &'static str {
+    match option_env!("RUSTFLAGS") {
+        Some(s) if s.contains("-D warnings") => "-D warnings",
+        _ => "",
+    }
+}

test-programs/suite/src/lib.rs

@@ -0,0 +1 @@
+include!(concat!(env!("OUT_DIR"), "/gen.rs"));

tests/test-programs.rs

@@ -0,0 +1,9 @@
+use wasmtime::{component::Component, Config, Engine};
+
+#[test]
+fn tcp_echo_server() {
+    let wasm = std::fs::read(test_program_suite::TCP_ECHO_SERVER).unwrap();
+    let config = Config::default();
+    let engine = Engine::new(&config).unwrap();
+    let _component = Component::new(&engine, wasm).unwrap();
+}