extension_tests.rs

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