src/tools/tidy/src/target_policy.rs

//! Tests for target tier policy compliance.
//!
//! As of writing, only checks that sanity-check assembly test for targets doesn't miss any targets.

use crate::walk::{filter_not_rust, walk};
use std::{collections::HashSet, path::Path};

const TARGET_DEFINITIONS_PATH: &str = "compiler/rustc_target/src/spec/targets/";
const ASSEMBLY_TEST_PATH: &str = "tests/assembly/targets/";
const REVISION_LINE_START: &str = "// revisions: ";
const EXCEPTIONS: &[&str] = &[
    // FIXME: disabled since it fails on CI saying the csky component is missing
    "csky_unknown_linux_gnuabiv2",
    "csky_unknown_linux_gnuabiv2hf",
];

pub fn check(root_path: &Path, bad: &mut bool) {
    let mut targets_to_find = HashSet::new();

    let definitions_path = root_path.join(TARGET_DEFINITIONS_PATH);
    for defn in ignore::WalkBuilder::new(&definitions_path)
        .max_depth(Some(1))
        .filter_entry(|e| !filter_not_rust(e.path()))
        .build()
    {
        let defn = defn.unwrap();
        // Skip directory itself.
        if defn.path() == definitions_path {
            continue;
        }

        let path = defn.path();
        let target_name = path.file_stem().unwrap().to_string_lossy().into_owned();
        let _ = targets_to_find.insert(target_name);
    }

    walk(&root_path.join(ASSEMBLY_TEST_PATH), |_, _| false, &mut |_, contents| {
        for line in contents.lines() {
            let Some(_) = line.find(REVISION_LINE_START) else {
                continue;
            };
            let (_, target_name) = line.split_at(REVISION_LINE_START.len());
            targets_to_find.remove(target_name);
        }
    });

    for target in targets_to_find {
        if !EXCEPTIONS.contains(&target.as_str()) {
            tidy_error!(bad, "{ASSEMBLY_TEST_PATH}: missing assembly test for {target}")
        }
    }
}