mirror of
https://github.com/bevyengine/bevy
synced 2024-11-10 07:04:33 +00:00
new example showcase tool (#8561)
# Objective - Replace the `example_showcase.sh` script - Helper tool to prepare the example page on the website ## Solution - Have a command to run all the examples: `cargo run -p example-showcase -- run` - Have a command to take screenshots of all examples: `cargo run -p example-showcase -- run --screenshot` - Have a command to build the markdown files for the website: `cargo run -p example-showcase -- build-website-list --content-folder content` - Have a command to build all the examples in wasm/WebGPU: `cargo run -p example-showcase -- build-web-gpu-examples --content-folder webgpus` (with `--website-hacks` to enable the hacks for the Bevy website: canvas id, resizing and loading bar) This is the first step to an improved example page (all examples marked as wasm, uses the card layout, has screenshots, reuse name, category and description from the metadata). As one of the goal is to have a page with WebGPU examples before the official release, this is not touching the example page for now but targeting a new one. <img width="1912" alt="Screenshot 2023-05-06 at 17 16 25" src="https://user-images.githubusercontent.com/8672791/236632744-4372c95f-c50a-4168-973f-349412548f33.png">
This commit is contained in:
François
GitHub
parent
44a365d540
commit
57fdb83620
4 changed files with 370 additions and 19 deletions
|
|
@ -24,6 +24,7 @@ members = [
|
|||
"tools/ci",
|
||||
"tools/build-templated-pages",
|
||||
"tools/build-wasm-example",
|
||||
"tools/example-showcase",
|
||||
"errors",
|
||||
]
|
||||
|
||||
|
|
@ -1673,7 +1674,7 @@ path = "examples/stress_tests/transform_hierarchy.rs"
|
|||
name = "Transform Hierarchy"
|
||||
description = "Various test cases for hierarchy and transform propagation performance"
|
||||
category = "Stress Tests"
|
||||
wasm = true
|
||||
wasm = false
|
||||
|
||||
[[example]]
|
||||
name = "text_pipeline"
|
||||
|
|
|
|||
13
tools/example-showcase/Cargo.toml
Normal file
13
tools/example-showcase/Cargo.toml
Normal file
|
|
@ -0,0 +1,13 @@
|
|||
[package]
|
||||
name = "example-showcase"
|
||||
version = "0.1.0"
|
||||
edition = "2021"
|
||||
description = "Run examples"
|
||||
publish = false
|
||||
license = "MIT OR Apache-2.0"
|
||||
|
||||
[dependencies]
|
||||
xshell = "0.2"
|
||||
clap = { version = "4.0", features = ["derive"] }
|
||||
ron = "0.8"
|
||||
toml_edit = "0.19"
|
||||
355
tools/example-showcase/src/main.rs
Normal file
355
tools/example-showcase/src/main.rs
Normal file
|
|
@ -0,0 +1,355 @@
|
|||
use std::{
|
||||
collections::HashMap,
|
||||
fs::{self, File},
|
||||
io::Write,
|
||||
path::{Path, PathBuf},
|
||||
process::exit,
|
||||
thread,
|
||||
time::{Duration, Instant},
|
||||
};
|
||||
|
||||
use clap::Parser;
|
||||
use toml_edit::Document;
|
||||
use xshell::{cmd, Shell};
|
||||
|
||||
#[derive(Parser, Debug)]
|
||||
struct Args {
|
||||
#[arg(long, default_value = "release")]
|
||||
/// Compilation profile to use
|
||||
profile: String,
|
||||
|
||||
#[command(subcommand)]
|
||||
action: Action,
|
||||
}
|
||||
|
||||
#[derive(clap::Subcommand, Debug)]
|
||||
enum Action {
|
||||
/// Run all the examples
|
||||
Run {
|
||||
#[arg(long)]
|
||||
/// WGPU backend to use
|
||||
wgpu_backend: Option<String>,
|
||||
|
||||
#[arg(long)]
|
||||
/// Don't stop automatically
|
||||
manual_stop: bool,
|
||||
|
||||
#[arg(long)]
|
||||
/// Take a screenshot
|
||||
screenshot: bool,
|
||||
},
|
||||
/// Build the markdown files for the website
|
||||
BuildWebsiteList {
|
||||
#[arg(long)]
|
||||
/// Path to the folder where the content should be created
|
||||
content_folder: String,
|
||||
},
|
||||
/// BUild the examples in wasm / WebGPU
|
||||
BuildWebGPUExamples {
|
||||
#[arg(long)]
|
||||
/// Path to the folder where the content should be created
|
||||
content_folder: String,
|
||||
|
||||
#[arg(long)]
|
||||
/// Enable hacks for Bevy website integration
|
||||
website_hacks: bool,
|
||||
},
|
||||
}
|
||||
|
||||
fn main() {
|
||||
let cli = Args::parse();
|
||||
|
||||
let profile = cli.profile;
|
||||
|
||||
match cli.action {
|
||||
Action::Run {
|
||||
wgpu_backend,
|
||||
manual_stop,
|
||||
screenshot,
|
||||
} => {
|
||||
let examples_to_run = parse_examples();
|
||||
|
||||
let mut failed_examples = vec![];
|
||||
|
||||
let mut extra_parameters = vec![];
|
||||
|
||||
match (manual_stop, screenshot) {
|
||||
(true, true) => {
|
||||
let mut file = File::create("example_showcase_config.ron").unwrap();
|
||||
file.write_all(
|
||||
b"(exit_after: None, frame_time: Some(0.05), screenshot_frames: [100])",
|
||||
)
|
||||
.unwrap();
|
||||
extra_parameters.push("--features");
|
||||
extra_parameters.push("bevy_ci_testing");
|
||||
}
|
||||
(true, false) => (),
|
||||
(false, true) => {
|
||||
let mut file = File::create("example_showcase_config.ron").unwrap();
|
||||
file.write_all(
|
||||
b"(exit_after: Some(300), frame_time: Some(0.05), screenshot_frames: [100])",
|
||||
)
|
||||
.unwrap();
|
||||
extra_parameters.push("--features");
|
||||
extra_parameters.push("bevy_ci_testing");
|
||||
}
|
||||
(false, false) => {
|
||||
let mut file = File::create("example_showcase_config.ron").unwrap();
|
||||
file.write_all(b"(exit_after: Some(300))").unwrap();
|
||||
extra_parameters.push("--features");
|
||||
extra_parameters.push("bevy_ci_testing");
|
||||
}
|
||||
}
|
||||
|
||||
for to_run in examples_to_run {
|
||||
let sh = Shell::new().unwrap();
|
||||
let example = &to_run.technical_name;
|
||||
let extra_parameters = extra_parameters.clone();
|
||||
let mut cmd = cmd!(
|
||||
sh,
|
||||
"cargo run --profile {profile} --example {example} {extra_parameters...}"
|
||||
);
|
||||
|
||||
if let Some(backend) = wgpu_backend.as_ref() {
|
||||
cmd = cmd.env("WGPU_BACKEND", backend);
|
||||
}
|
||||
|
||||
if !manual_stop || screenshot {
|
||||
cmd = cmd.env("CI_TESTING_CONFIG", "example_showcase_config.ron");
|
||||
}
|
||||
|
||||
let before = Instant::now();
|
||||
|
||||
if cmd.run().is_ok() {
|
||||
if screenshot {
|
||||
let _ = fs::create_dir_all(Path::new("screenshots").join(&to_run.category));
|
||||
let _ = fs::rename(
|
||||
"screenshot-100.png",
|
||||
Path::new("screenshots")
|
||||
.join(&to_run.category)
|
||||
.join(format!("{}.png", to_run.technical_name)),
|
||||
);
|
||||
}
|
||||
} else {
|
||||
failed_examples.push(to_run);
|
||||
}
|
||||
|
||||
let duration = before.elapsed();
|
||||
println!("took {duration:?}");
|
||||
|
||||
thread::sleep(Duration::from_secs(1));
|
||||
}
|
||||
if failed_examples.is_empty() {
|
||||
println!("All examples passed!");
|
||||
} else {
|
||||
println!("Failed examples:");
|
||||
for example in failed_examples {
|
||||
println!(
|
||||
" {} / {} ({})",
|
||||
example.category, example.name, example.technical_name
|
||||
);
|
||||
}
|
||||
exit(1);
|
||||
}
|
||||
}
|
||||
Action::BuildWebsiteList { content_folder } => {
|
||||
let examples_to_run = parse_examples();
|
||||
|
||||
let root_path = Path::new(&content_folder);
|
||||
|
||||
let _ = fs::create_dir_all(root_path);
|
||||
|
||||
let mut index = File::create(root_path.join("_index.md")).unwrap();
|
||||
index
|
||||
.write_all(
|
||||
"+++
|
||||
title = \"Bevy Examples in WebGPU\"
|
||||
template = \"examples-webgpu.html\"
|
||||
sort_by = \"weight\"
|
||||
|
||||
[extra]
|
||||
header_message = \"Examples (WebGPU)\"
|
||||
+++"
|
||||
.as_bytes(),
|
||||
)
|
||||
.unwrap();
|
||||
|
||||
let mut categories = HashMap::new();
|
||||
|
||||
for to_show in examples_to_run {
|
||||
if !to_show.wasm {
|
||||
continue;
|
||||
}
|
||||
let category_path = root_path.join(&to_show.category);
|
||||
|
||||
if !categories.contains_key(&to_show.category) {
|
||||
let _ = fs::create_dir_all(&category_path);
|
||||
let mut category_index = File::create(category_path.join("_index.md")).unwrap();
|
||||
category_index
|
||||
.write_all(
|
||||
format!(
|
||||
"+++
|
||||
title = \"{}\"
|
||||
sort_by = \"weight\"
|
||||
weight = {}
|
||||
+++",
|
||||
to_show.category,
|
||||
categories.len()
|
||||
)
|
||||
.as_bytes(),
|
||||
)
|
||||
.unwrap();
|
||||
categories.insert(to_show.category.clone(), 0);
|
||||
}
|
||||
let example_path = category_path.join(&to_show.technical_name.replace('_', "-"));
|
||||
let _ = fs::create_dir_all(&example_path);
|
||||
|
||||
let code_path = example_path.join(Path::new(&to_show.path).file_name().unwrap());
|
||||
let _ = fs::copy(&to_show.path, &code_path);
|
||||
|
||||
let mut example_index = File::create(example_path.join("index.md")).unwrap();
|
||||
example_index
|
||||
.write_all(
|
||||
format!(
|
||||
"+++
|
||||
title = \"{}\"
|
||||
template = \"example-webgpu.html\"
|
||||
weight = {}
|
||||
description = \"{}\"
|
||||
|
||||
[extra]
|
||||
technical_name = \"{}\"
|
||||
link = \"examples-webgpu/{}/{}\"
|
||||
image = \"../static/screenshots/{}/{}.png\"
|
||||
code_path = \"content/examples-webgpu/{}\"
|
||||
github_code_path = \"{}\"
|
||||
header_message = \"Examples (WebGPU)\"
|
||||
+++",
|
||||
to_show.name,
|
||||
categories.get(&to_show.category).unwrap(),
|
||||
to_show.description.replace('"', "'"),
|
||||
&to_show.technical_name.replace('_', "-"),
|
||||
&to_show.category,
|
||||
&to_show.technical_name.replace('_', "-"),
|
||||
&to_show.category,
|
||||
&to_show.technical_name,
|
||||
code_path
|
||||
.components()
|
||||
.skip(1)
|
||||
.collect::<PathBuf>()
|
||||
.display(),
|
||||
&to_show.path,
|
||||
)
|
||||
.as_bytes(),
|
||||
)
|
||||
.unwrap();
|
||||
}
|
||||
}
|
||||
Action::BuildWebGPUExamples {
|
||||
content_folder,
|
||||
website_hacks,
|
||||
} => {
|
||||
let examples_to_build = parse_examples();
|
||||
|
||||
let root_path = Path::new(&content_folder);
|
||||
|
||||
let _ = fs::create_dir_all(root_path);
|
||||
|
||||
if website_hacks {
|
||||
let sh = Shell::new().unwrap();
|
||||
|
||||
// setting a canvas by default to help with integration
|
||||
cmd!(sh, "sed -i.bak 's/canvas: None,/canvas: Some(\"#bevy\".to_string()),/' crates/bevy_window/src/window.rs").run().unwrap();
|
||||
cmd!(sh, "sed -i.bak 's/fit_canvas_to_parent: false,/fit_canvas_to_parent: true,/' crates/bevy_window/src/window.rs").run().unwrap();
|
||||
|
||||
// setting the asset folder root to the root url of this domain
|
||||
cmd!(sh, "sed -i.bak 's/asset_folder: \"assets\"/asset_folder: \"\\/assets\\/examples\\/\"/' crates/bevy_asset/src/lib.rs").run().unwrap();
|
||||
}
|
||||
|
||||
for to_build in examples_to_build {
|
||||
if !to_build.wasm {
|
||||
continue;
|
||||
}
|
||||
|
||||
let sh = Shell::new().unwrap();
|
||||
let example = &to_build.technical_name;
|
||||
cmd!(
|
||||
sh,
|
||||
"cargo run -p build-wasm-example -- --api webgpu {example}"
|
||||
)
|
||||
.run()
|
||||
.unwrap();
|
||||
|
||||
let category_path = root_path.join(&to_build.category);
|
||||
let _ = fs::create_dir_all(&category_path);
|
||||
|
||||
let example_path = category_path.join(&to_build.technical_name.replace('_', "-"));
|
||||
let _ = fs::create_dir_all(&example_path);
|
||||
|
||||
if website_hacks {
|
||||
// set up the loader bar for asset loading
|
||||
cmd!(sh, "sed -i.bak -e 's/getObject(arg0).fetch(/window.bevyLoadingBarFetch(/' -e 's/input = fetch(/input = window.bevyLoadingBarFetch(/' examples/wasm/target/wasm_example.js").run().unwrap();
|
||||
}
|
||||
|
||||
let _ = fs::rename(
|
||||
Path::new("examples/wasm/target/wasm_example.js"),
|
||||
&example_path.join("wasm_example.js"),
|
||||
);
|
||||
let _ = fs::rename(
|
||||
Path::new("examples/wasm/target/wasm_example_bg.wasm"),
|
||||
&example_path.join("wasm_example_bg.wasm"),
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fn parse_examples() -> Vec<Example> {
|
||||
let manifest_file = std::fs::read_to_string("Cargo.toml").unwrap();
|
||||
let manifest = manifest_file.parse::<Document>().unwrap();
|
||||
let metadatas = manifest
|
||||
.get("package")
|
||||
.unwrap()
|
||||
.get("metadata")
|
||||
.as_ref()
|
||||
.unwrap()["example"]
|
||||
.clone();
|
||||
|
||||
manifest["example"]
|
||||
.as_array_of_tables()
|
||||
.unwrap()
|
||||
.iter()
|
||||
.flat_map(|val| {
|
||||
let technical_name = val.get("name").unwrap().as_str().unwrap().to_string();
|
||||
|
||||
if metadatas
|
||||
.get(&technical_name)
|
||||
.and_then(|metadata| metadata.get("hidden"))
|
||||
.and_then(|hidden| hidden.as_bool())
|
||||
.and_then(|hidden| hidden.then_some(()))
|
||||
.is_some()
|
||||
{
|
||||
return None;
|
||||
}
|
||||
|
||||
metadatas.get(&technical_name).map(|metadata| Example {
|
||||
technical_name,
|
||||
path: val["path"].as_str().unwrap().to_string(),
|
||||
name: metadata["name"].as_str().unwrap().to_string(),
|
||||
description: metadata["description"].as_str().unwrap().to_string(),
|
||||
category: metadata["category"].as_str().unwrap().to_string(),
|
||||
wasm: metadata["wasm"].as_bool().unwrap(),
|
||||
})
|
||||
})
|
||||
.collect()
|
||||
}
|
||||
|
||||
#[derive(Debug, PartialEq, Eq, Clone)]
|
||||
struct Example {
|
||||
technical_name: String,
|
||||
path: String,
|
||||
name: String,
|
||||
description: String,
|
||||
category: String,
|
||||
wasm: bool,
|
||||
}
|
||||
|
|
@ -1,18 +0,0 @@
|
|||
#!/bin/bash
|
||||
|
||||
duration='2'
|
||||
function wait_seconds() { perl -e 'alarm shift; exec @ARGV' "$@"; }
|
||||
run_example() {
|
||||
cargo build --example "$1"
|
||||
wait_seconds "$duration" cargo run --example "$1"
|
||||
}
|
||||
|
||||
example_list="$(cargo build --example 2>&1)"
|
||||
example_list=${example_list//$'\n'/}
|
||||
example_list="${example_list#error\: \"--example\" takes one argument.Available examples\: }"
|
||||
echo "$example_list"
|
||||
for example in $example_list
|
||||
do
|
||||
echo "Running example: $example"
|
||||
run_example "$example"
|
||||
done
|
||||
Loading…
Reference in a new issue