1use gh_workflow::*;
2use indoc::{formatdoc, indoc};
3
4use crate::tasks::workflows::{
5 extension_bump::compare_versions,
6 run_tests::{orchestrate_without_package_filter, tests_pass},
7 runners,
8 steps::{
9 self, CommonJobConditions, FluentBuilder, NamedJob, cache_rust_dependencies_namespace,
10 named,
11 },
12 vars::{PathCondition, StepOutput, one_workflow_per_non_main_branch},
13};
14
15pub(crate) const ZED_EXTENSION_CLI_SHA: &str = "03d8e9aee95ea6117d75a48bcac2e19241f6e667";
16
17// This should follow the set target in crates/extension/src/extension_builder.rs
18const EXTENSION_RUST_TARGET: &str = "wasm32-wasip2";
19
20// This is used by various extensions repos in the zed-extensions org to run automated tests.
21pub(crate) fn extension_tests() -> Workflow {
22 let should_check_rust = PathCondition::new("check_rust", r"^(Cargo.lock|Cargo.toml|.*\.rs)$");
23 let should_check_extension =
24 PathCondition::new("check_extension", r"^(extension\.toml|.*\.scm)$");
25
26 let orchestrate =
27 orchestrate_without_package_filter(&[&should_check_rust, &should_check_extension]);
28
29 let jobs = [
30 orchestrate,
31 should_check_rust.guard(check_rust()),
32 should_check_extension.guard(check_extension()),
33 ];
34
35 let tests_pass = tests_pass(&jobs);
36
37 named::workflow()
38 .add_event(Event::default().workflow_call(WorkflowCall::default()))
39 .concurrency(one_workflow_per_non_main_branch())
40 .add_env(("CARGO_TERM_COLOR", "always"))
41 .add_env(("RUST_BACKTRACE", 1))
42 .add_env(("CARGO_INCREMENTAL", 0))
43 .add_env(("ZED_EXTENSION_CLI_SHA", ZED_EXTENSION_CLI_SHA))
44 .add_env(("RUSTUP_TOOLCHAIN", "stable"))
45 .add_env(("CARGO_BUILD_TARGET", EXTENSION_RUST_TARGET))
46 .map(|workflow| {
47 jobs.into_iter()
48 .chain([tests_pass])
49 .fold(workflow, |workflow, job| {
50 workflow.add_job(job.name, job.job)
51 })
52 })
53}
54
55fn install_rust_target() -> Step<Run> {
56 named::bash(format!("rustup target add {EXTENSION_RUST_TARGET}",))
57}
58
59fn run_clippy() -> Step<Run> {
60 named::bash("cargo clippy --release --all-features -- --deny warnings")
61}
62
63fn check_rust() -> NamedJob {
64 let job = Job::default()
65 .with_repository_owner_guard()
66 .runs_on(runners::LINUX_LARGE_RAM)
67 .timeout_minutes(6u32)
68 .add_step(steps::checkout_repo())
69 .add_step(steps::cache_rust_dependencies_namespace())
70 .add_step(install_rust_target())
71 .add_step(steps::cargo_fmt())
72 .add_step(run_clippy())
73 .add_step(steps::cargo_install_nextest())
74 .add_step(
75 steps::cargo_nextest(runners::Platform::Linux)
76 // Set the target to the current platform again
77 .with_target("$(rustc -vV | sed -n 's|host: ||p')")
78 .add_env(("NEXTEST_NO_TESTS", "warn")),
79 );
80
81 named::job(job)
82}
83
84pub(crate) fn check_extension() -> NamedJob {
85 let (cache_download, cache_hit) = cache_zed_extension_cli();
86 let (check_version_job, version_changed, _) = compare_versions();
87
88 let job = Job::default()
89 .with_repository_owner_guard()
90 .runs_on(runners::LINUX_LARGE_RAM)
91 .timeout_minutes(6u32)
92 .add_step(steps::checkout_repo().with_full_history())
93 .add_step(cache_download)
94 .add_step(download_zed_extension_cli(cache_hit))
95 .add_step(cache_rust_dependencies_namespace()) // Extensions can compile Rust, so provide the cache if needed.
96 .add_step(check())
97 .add_step(check_version_job)
98 .add_step(verify_version_did_not_change(version_changed));
99
100 named::job(job)
101}
102
103pub fn cache_zed_extension_cli() -> (Step<Use>, StepOutput) {
104 let step = named::uses(
105 "actions",
106 "cache",
107 "0057852bfaa89a56745cba8c7296529d2fc39830",
108 )
109 .id("cache-zed-extension-cli")
110 .with(
111 Input::default()
112 .add("path", "zed-extension")
113 .add("key", "zed-extension-${{ env.ZED_EXTENSION_CLI_SHA }}"),
114 );
115 let output = StepOutput::new(&step, "cache-hit");
116 (step, output)
117}
118
119pub fn download_zed_extension_cli(cache_hit: StepOutput) -> Step<Run> {
120 named::bash(
121 indoc! {
122 r#"
123 wget --quiet "https://zed-extension-cli.nyc3.digitaloceanspaces.com/$ZED_EXTENSION_CLI_SHA/x86_64-unknown-linux-gnu/zed-extension"
124 chmod +x zed-extension
125 "#,
126 }
127 ).if_condition(Expression::new(format!("{} != 'true'", cache_hit.expr())))
128}
129
130pub fn check() -> Step<Run> {
131 named::bash(indoc! {
132 r#"
133 mkdir -p /tmp/ext-scratch
134 mkdir -p /tmp/ext-output
135 ./zed-extension --source-dir . --scratch-dir /tmp/ext-scratch --output-dir /tmp/ext-output
136 "#
137 })
138}
139
140fn verify_version_did_not_change(version_changed: StepOutput) -> Step<Run> {
141 named::bash(formatdoc! {r#"
142 if [[ {version_changed} == "true" && "${{{{ github.event_name }}}}" == "pull_request" && "${{{{ github.event.pull_request.user.login }}}}" != "zed-zippy[bot]" ]] ; then
143 echo "Version change detected in your change!"
144 echo "Version changes happen in separate PRs and will be performed by the zed-zippy bot"
145 exit 42
146 fi
147 "#
148 })
149}