{"id":26365400,"url":"https://github.com/2moe/testutils","last_synced_at":"2026-02-16T20:36:10.524Z","repository":{"id":279418312,"uuid":"937537804","full_name":"2moe/testutils","owner":"2moe","description":"Offers a range of utility functions, macros, and tools, such as `simple_benchmark()` and `dbg_ref!()`, `os_cmd::Runner`, designed for testing purposes.","archived":false,"fork":false,"pushed_at":"2026-02-11T04:40:03.000Z","size":159,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-02-11T10:06:25.993Z","etag":null,"topics":["rust","testing-tools"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/2moe.png","metadata":{"files":{"readme":"docs/Readme-zh-Hant.md","changelog":null,"contributing":null,"funding":null,"license":"License","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-02-23T10:00:21.000Z","updated_at":"2026-02-11T04:40:07.000Z","dependencies_parsed_at":"2025-03-23T07:19:44.923Z","dependency_job_id":"fe069875-5bfc-4dbc-ad50-3d1ec95e1166","html_url":"https://github.com/2moe/testutils","commit_stats":null,"previous_names":["2moe/testutils"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/2moe/testutils","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/2moe%2Ftestutils","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/2moe%2Ftestutils/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/2moe%2Ftestutils/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/2moe%2Ftestutils/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/2moe","download_url":"https://codeload.github.com/2moe/testutils/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/2moe%2Ftestutils/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29517617,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-16T18:37:19.720Z","status":"ssl_error","status_checked_at":"2026-02-16T18:36:46.920Z","response_time":115,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["rust","testing-tools"],"created_at":"2025-03-16T19:36:17.177Z","updated_at":"2026-02-16T20:36:10.517Z","avatar_url":"https://github.com/2moe.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# TestUtils\n\n## Features\n\n- std\n  - 啟用後，無法在 no_std 環境中執行。\n- ext_traits\n  - 包含了 BoolExt (為 bool 型別提供 `.ok_or_else()`)\n  - `pub use tap::{Pipe, Tap};`\n- os_cmd\n  - 提供了一些可配置的 Cargo 命令的結構體\n    - 比如 CargoDoc, CargoCmd\n  - 提供了 RunnableCommand Trait\n\n## macros\n\n### dbg_ref\n\n`dbg_ref!` 會輸出傳入引數的型別以及值，主要用於除錯。\n\n與 `std::dbg!` 不同的是：它透過 `log::debug!` 來輸出，而不是直接 (用`eprintln!`) 輸出到 stderr。\n\n```rust\nuse testutils::dbg_ref;\n// env_logger::builder().filter_level(log::LevelFilter::Debug).init();\n\nlet x = 42;\ndbg_ref!(x); // Prints: [DEBUG] x: i32 = 42\n\nlet y = \"hello\";\ndbg_ref!(y); // Prints: [DEBUG] y: \u0026str = \"hello\"\n\nlet z = vec![1, 2, 3];\ndbg_ref!(z); // Prints: [DEBUG] z: alloc::vec::Vec\u003ci32\u003e = [1, 2, 3]\n```\n\n### `dbg!`\n\n透過 `eprintln!` 而不是 `log::debug!` 來輸出。\n\n```rust\nuse testutils::dbg;\n\nlet x = 42;\ndbg!(x); // Prints: x: i32 = 42\n\nlet y = \"hello\";\ndbg!(y); // Prints: y: \u0026str = \"hello\"\n```\n\n### generate_struct_arr\n\n`generate_struct_arr!` 可以將結構體轉換為陣列。\n\n```rust\nuse testutils::generate_struct_arr;\n\nstruct BuildStd {\n  std: bool,\n  core: bool,\n  alloc: bool,\n}\n\nlet b = BuildStd {\n  std: false,\n  core: true,\n  alloc: true,\n};\n\nlet arr = generate_struct_arr![ b =\u003e core, alloc, std ];\nassert_eq!(\n  arr,\n  [(\"core\", true), (\"alloc\", true), (\"std\", false)]\n);\n```\n\n## os_cmd\n\n### raw string\n\n```rust\nuse std::io;\nuse testutils::{get_pkg_name, os_cmd::Runner, tap::Pipe};\n\n#[ignore]\n#[test]\nfn build_rsdoc() -\u003e io::Result\u003c()\u003e {\n  let _ = format!(\n    r#\"\n    // nightly toolchain\n      cargo +nightly\n\n    // use rustdoc instead of doc\n      rustdoc\n\n    // --package\n      -p  {pkg}\n\n      --all-features\n\n      // open browser\n      --open\n\n      --\n\n    // 假設你在 lib.rs 中定義了 `#![cfg_attr(docsrs, feature(doc_auto_cfg, doc_notable_trait))]`，那麼 `cfg` 就是 `docsrs`\n      --cfg  docsrs\n\n    // 包含非“真正公開” (如 pub(crate) ) items in the generated documentation.\n      --document-private-items\n    \"#,\n    pkg = get_pkg_name!()\n  )\n  .pipe_deref(Runner::from)\n  .with_remove_comments(true) // Because the raw string contains `//` comments, this option (`with_remove_comments`) must be enabled.\n  .run()\n}\n```\n\n### CargoDoc\n\n對於 cargo rustdoc 命令，我們不需要從 raw string 中構造 runner，我們可以直接使用現有的 CargoDoc 結構體。\n\n預設的 CargoDoc 是：\n\n```rust\nCargoDoc {\n    pkg: \"\",\n    custom_cfg: \"docsrs\",\n    nightly: true,\n    all_features: true,\n    open: true,\n    enable_private_items: true,\n}\n```\n\n我們可以用 `CargoDoc::default()` 來初始化一個包含預設配置的 CargoDoc 結構體，然後匯入 `RunnableCommand` Trait, 最後呼叫 `.run()` 來執行命令。\n\n```rust\nuse std::io;\nuse testutils::{\n  get_pkg_name,\n  os_cmd::{RunnableCommand, presets::CargoDoc},\n};\n\n#[ignore]\n#[test]\nfn build_and_open_rust_doc() -\u003e io::Result\u003c()\u003e {\n  CargoDoc::default()\n    .with_pkg(get_pkg_name!())\n    .run()\n}\n```\n\n我們可以透過 `.with_[欄位名稱]` 來配置它\n\n```rust\nuse testutils::{dbg_ref, os_cmd::presets::CargoDoc, tap::Tap};\n\nuse crate::normal::init_logger;\n\n#[ignore]\n#[test]\nfn configure_cargo_doc() {\n  init_logger();\n  CargoDoc::default()\n    .with_pkg(\"\")\n    .with_custom_cfg(\"\")\n    .with_nightly(true)\n    .with_open(false)\n    .with_enable_private_items(false)\n    .with_all_features(true)\n    .tap(|x| dbg_ref!(x))\n    .into_slice()\n    .tap(|x| dbg_ref!(x));\n\n  assert_eq!(\n    x.as_slice(),\n    \u0026[\"cargo\", \"+nightly\", \"rustdoc\", \"--all-features\", \"--\"]\n  );\n}\n```\n\n## CargoCmd\n\n### Default\n\n```rust\nCargoCmd {\n    rust_flags: RustFlags {\n        crt_static: None,\n        prefer_dynamic: None,\n        linker: \"\",\n        linker_flavor: Ignore,\n        link_self_contained: None,\n        relocation_model: Ignore,\n        code_model: Ignore,\n        codegen_units: None,\n        native_target_cpu: None,\n        other_flags: [],\n    },\n    nightly: false,\n    sub_command: Build,\n    profile: \"release\",\n    pkg: \"\",\n    target: default,\n    all_packages: false,\n    all_features: false,\n    no_default_features: false,\n    features: [],\n    build_std: BuildStd {\n        build_default: false,\n        std: false,\n        core: false,\n        alloc: false,\n        panic_abort: false,\n        panic_unwind: false,\n        test: false,\n        proc_macro: false,\n    },\n    build_std_features: BuildStdFeatures {\n        panic_immediate_abort: false,\n        panic_unwind: false,\n        backtrace: false,\n        optimize_for_size: false,\n        llvm_libunwind: false,\n        system_llvm_libunwind: false,\n        debug_refcell: false,\n        debug_typeid: false,\n        std_detect_file_io: false,\n        std_detect_dlsym_getauxval: false,\n        std_detect_env_override: false,\n        windows_raw_dylib: false,\n    },\n    extra_args: [],\n}\n```\n\n### Example\n\n```rust\nuse testutils::{\n  get_pkg_name,\n  os_cmd::{\n    Runner,\n    presets::{\n      CargoCmd,\n      cargo_build::{BuildStd, BuildStdFeatures, RustcTarget},\n    },\n  },\n};\n\nlet vec = CargoCmd::default()\n  .with_nightly(true)\n  .with_pkg(get_pkg_name!().into())\n  .with_target(RustcTarget::aarch64_linux_android.into())\n  .with_build_std(\n    BuildStd::default()\n      .with_alloc(true)\n      .with_core(true),\n  )\n  .with_build_std_features(\n    BuildStdFeatures::default()\n      .with_panic_immediate_abort(true),\n  )\n  .into_vec();\n\nassert_eq!(\n  vec,\n  [\n    \"cargo\",\n    \"+nightly\",\n    \"build\",\n    \"--profile=release\",\n    \"--package=testutils\",\n    \"--target=aarch64-linux-android\",\n    \"-Z\",\n    \"build-std=core,alloc\",\n    \"-Z\",\n    \"build-std-features=panic_immediate_abort\"\n  ]\n);\nlet runner: Runner = vec.into();\n// runner.run();\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F2moe%2Ftestutils","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F2moe%2Ftestutils","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F2moe%2Ftestutils/lists"}