wit-bindgen-test 0.61.0

use crate::{Compile, LanguageMethods, Runner, Verify};
use anyhow::{Context as _, Result};
use std::env;
use std::fs;
use std::path::{Path, PathBuf};
use std::process::Command;

pub struct Go;

/// Go-specific state, stored in `Runner`, detected during `prepare`.
pub struct State {
    /// Whether the Go toolchain in use supports the `runtime.wasiOnIdle` hook
    /// required for component model async support.
    async_supported: bool,
}

impl Runner {
    fn go_async_supported(&self) -> bool {
        self.go_state
            .as_ref()
            .map(|s| s.async_supported)
            .unwrap_or(false)
    }
}

impl LanguageMethods for Go {
    fn display(&self) -> &str {
        "go"
    }

    fn comment_prefix_for_test_config(&self) -> Option<&str> {
        Some("//@")
    }

    fn should_fail_verify(
        &self,
        runner: &Runner,
        name: &str,
        config: &crate::config::WitConfig,
        _args: &[String],
    ) -> bool {
        if config.error_context {
            return true;
        }
        if name == "named-fixed-length-list.wit" {
            return true;
        }
        if !runner.go_async_supported() {
            return name == "async-trait-function.wit" || name == "issue-1598.wit";
        }

        false
    }

    fn should_fail_compile(
        &self,
        runner: &Runner,
        path: &Path,
        config: &crate::config::WitConfig,
    ) -> bool {
        // This test, even though it's part of async, compiles on any
        // toolchain.
        if path.ends_with("incomplete-writes/leaf.go") {
            return false;
        }

        // Bindings for async tests rely on `runtime.wasiOnIdle` (see `prepare`
        // below) and fail to link without a toolchain that provides it.
        if !runner.go_async_supported() {
            return config.async_;
        }

        false
    }

    fn default_bindgen_args_for_codegen(&self) -> &[&str] {
        &["--generate-stubs"]
    }

    fn prepare(&self, runner: &mut Runner) -> Result<()> {
        let cwd = env::current_dir()?;
        let dir = cwd.join(&runner.opts.artifacts).join("go");
        let bindings_dir = cwd.join("wit_component");

        super::write_if_different(&dir.join("test.go"), "package main\n\nfunc main() {}")?;
        super::write_if_different(&dir.join("go.mod"), "module test\n\ngo 1.25")?;

        replace_bindings_go_mod(runner, &bindings_dir)?;

        println!("Testing if `go build` works...");
        runner.run_command(
            Command::new("go")
                .current_dir(&dir)
                .env("GOOS", "wasip1")
                .env("GOARCH", "wasm")
                .arg("build")
                .arg("-buildmode=c-shared")
                .arg("-ldflags=-checklinkname=0"),
        )?;

        // Component model async support requires a `runtime.wasiOnIdle` hook
        // which, as of the time of this writing, is only available in a
        // patched build of Go. Detect whether the toolchain in use has
        // this hook by building a program that links against it, and if not
        // then async tests are expected to fail to build.
        println!("Testing if `go` supports `runtime.wasiOnIdle`...");
        let probe_dir = dir.join("wasi-on-idle-probe");
        super::write_if_different(
            &probe_dir.join("main.go"),
            r#"package main

import _ "unsafe"

//go:linkname wasiOnIdle runtime.wasiOnIdle
func wasiOnIdle(callback func() bool)
func init() { defer wasiOnIdle(func() bool { return false }) }
func main() {}
"#,
        )?;
        super::write_if_different(&probe_dir.join("go.mod"), "module probe\n\ngo 1.25")?;
        let async_supported = runner
            .run_command(
                Command::new("go")
                    .current_dir(&probe_dir)
                    .env("GOOS", "wasip1")
                    .env("GOARCH", "wasm")
                    .arg("build")
                    .arg("-o")
                    .arg("probe.wasm")
                    .arg("-buildmode=c-shared")
                    .arg("-ldflags=-checklinkname=0"),
            )
            .is_ok();
        println!("`runtime.wasiOnIdle` supported: {async_supported}");
        runner.go_state = Some(State { async_supported });

        Ok(())
    }

    fn compile(&self, runner: &Runner, compile: &Compile<'_>) -> Result<()> {
        let output = compile.output.with_extension("core.wasm");

        // Tests which involve importing and/or exporting more than one
        // interface may require more than one file since we can't define more
        // than one package in a single file in Go (AFAICT).  Here we search for
        // files related to `compile.component.path` based on a made-up naming
        // convention.  For example, if the filename is `test.go`, then we'll
        // also include `${prefix}+test.go` for any value of `${prefix}`.
        for path in all_paths(&compile.component.path)? {
            let test = fs::read_to_string(&path)
                .with_context(|| format!("unable to read `{}`", path.display()))?;
            let package_name = package_name(&test);
            let package_dir = compile.bindings_dir.join(package_name);
            fs::create_dir_all(&package_dir)
                .with_context(|| format!("unable to create `{}`", package_dir.display()))?;
            let output = &package_dir.join(path.file_name().unwrap());
            fs::write(output, test.as_bytes())
                .with_context(|| format!("unable to write `{}`", output.display()))?;
        }

        replace_bindings_go_mod(runner, compile.bindings_dir)?;

        runner.run_command(
            Command::new("go")
                .current_dir(compile.bindings_dir)
                .env("GOOS", "wasip1")
                .env("GOARCH", "wasm")
                .arg("build")
                .arg("-o")
                .arg(&output)
                .arg("-buildmode=c-shared")
                .arg("-ldflags=-checklinkname=0"),
        )?;

        runner.convert_p1_to_component(&output, compile)?;

        Ok(())
    }

    fn verify(&self, runner: &Runner, verify: &Verify<'_>) -> Result<()> {
        replace_bindings_go_mod(runner, verify.bindings_dir)?;

        // `go vet`
        runner.run_command(
            Command::new("go")
                .current_dir(&verify.bindings_dir)
                .arg("vet")
                .arg("-unsafeptr=false")
                .arg("./..."),
        )?;

        // `go build`
        runner.run_command(
            Command::new("go")
                .current_dir(verify.bindings_dir)
                .env("GOOS", "wasip1")
                .env("GOARCH", "wasm")
                .arg("build")
                .arg("-o")
                .arg(verify.artifacts_dir.join("tmp.wasm"))
                .arg("-buildmode=c-shared")
                .arg("-ldflags=-checklinkname=0"),
        )?;
        Ok(())
    }
}

fn package_name(package: &str) -> &str {
    package
        .lines()
        .filter_map(|l| l.strip_prefix("package "))
        .next()
        .unwrap()
        .trim()
}

fn all_paths(path: &Path) -> Result<Vec<PathBuf>> {
    let mut paths = vec![path.into()];
    let suffix = ".go";
    if let Some(name) = path
        .file_name()
        .unwrap()
        .to_str()
        .and_then(|name| name.strip_suffix(suffix))
    {
        let suffix = &format!("+{name}{suffix}");
        let parent = path.parent().unwrap();
        for entry in parent
            .read_dir()
            .with_context(|| format!("unable to read dir `{}`", parent.display()))?
        {
            let entry = entry?;
            if entry
                .file_name()
                .to_str()
                .and_then(|name| name.strip_suffix(suffix))
                .is_some()
            {
                paths.push(entry.path());
            }
        }
    }
    Ok(paths)
}

fn replace_bindings_go_mod(runner: &Runner, bindings_dir: &Path) -> Result<()> {
    let test_crate = PathBuf::from(env!("CARGO_MANIFEST_DIR"));
    let wit_bindgen_root = test_crate.parent().unwrap().parent().unwrap();
    let go_package_path = wit_bindgen_root.join("crates/go/src/pkg");

    super::write_if_different(
        &bindings_dir.join("go.mod"),
        format!(
            "module wit_component\n\ngo 1.25\n\nreplace go.bytecodealliance.org/pkg => {}",
            go_package_path.display()
        ),
    )?;

    runner.run_command(
        Command::new("go")
            .current_dir(bindings_dir)
            .arg("mod")
            .arg("tidy"),
    )?;

    Ok(())
}