mod arch_known_failures

module arch_known_failures

Known per-architecture failures of entries that do build.

An entry in data/arch-unsupported.toml cannot be built on an architecture at all. The entries in data/arch-known-failures.toml can, but a bot run on one target has already failed them: a fetch, a build step, a test, a test timeout, or a sanity check. Each one names the remedy the maintainers settled on (a runtest skip, a preinstallopts line, an ARCH conditional, a pin) and the EESSI hook that applies it, when there is one. A plan that includes such an entry, or depends on one, gets a warning and that remedy before the bot runs.

EESSI hooks that rewrite an easyconfig are in the same table. The CUDA demotion in inject_gpu_property is one: an entry with requires_dependency = "CUDA" applies only when the easyconfig depends on CUDA, because only then does the hook move it to a build dependency.

Variables

const BUNDLED_KNOWN_FAILURES: &str

The table shipped with eb-stack.

Functions

fn citations(sources: &[String]) -> String

software-layer #1871, #1829; software-layer-scripts #330, from the GitHub pull request and commit links in sources.

fn known_failures_in_plan(list: &KnownFailureList, arches: &[String], candidates: &[Candidate], plan: &[EasystackEntry], context: &PlanContext, is_installed: &dyn Fn(&ModuleKey) -> bool) -> Vec<KnownHit>

Known failures that plan includes or depends on, for arches.

arches empty checks every architecture in the table. A module is_installed reports is not rebuilt, so it is not a hit, and the closure stops there.

fn run_known_failures(request: &KnownFailuresRequest) -> Result<KnownFailuresReport>

Warn about known per-architecture failures a plan includes or depends on.

Enums

enum Phase

Where in the bot run the entry fails.

Fetch

The source or wheel cannot be downloaded.

Build

Configure, build, or install fails.

Test

A test fails.

Timeout

A test runs out of time.

Sanity

The sanity check fails after the install.

Implementations

impl Phase

Functions

fn label(self) -> &'static str

The words the warning uses.

Structs and Unions

struct KnownFailure

One known failure and its remedy.

id: String

Short unique handle, orjson-a64fx-zoneinfo-utc.

names: Vec<String>

EasyBuild names. An exts_list extension of that name matches too.

versions: Vec<String>

Versions seen failing. Empty is every version.

arches: Vec<String>

Targets, families, or * for every architecture.

phase: Phase

Where the run fails.

symptom: String

What the bot log shows.

remedy: String

The easyconfig remedy, as text.

hook: Option<String>

EESSI hook that applies the remedy, if one does.

caused_by_hook: Option<String>

EESSI hook whose rewrite of the easyconfig causes the failure.

requires_dependency: Option<String>

Only when the easyconfig depends on this name.

min_easybuild: Option<String>

Only from this EasyBuild release.

eessi_versions: Vec<String>

Only for these EESSI versions. Empty is every version.

fixed_by: Vec<String>

Commits whose pin carries the remedy.

fixed_marker: Option<String>

Text the easyconfig contains once the remedy is in it.

sources: Vec<String>

Pull requests and comments the entry was seeded from.

struct KnownFailureList

The known-failure table.

Implementations

impl KnownFailureList

Functions

fn bundled() -> Result<Self>

The table shipped in data/arch-known-failures.toml.

fn entries(&self) -> &[KnownFailure]

Every entry, in file order.

fn get(&self, id: &str) -> Option<&KnownFailure>

The entry with this id.

fn load(path: &Path) -> Result<Self>

Read a table from path. An empty file is an empty table.

fn parse(text: &str) -> Result<Self>

Parse the TOML document.

struct KnownFailuresReport

What stack known-failures prints.

stdout: String

Stdout, including the count line.

hits: Vec<KnownHit>

Every hit, warnings and remedied ones.

Implementations

impl KnownFailuresReport

Functions

fn strict_error(&self) -> Option<String>

The --strict error: one line per remaining warning, each naming the easyconfig, the architectures, and the phase. None when every hit is remedied, so --strict exits 0.

fn warnings(&self) -> impl Iterator<Item = &KnownHit>

Hits whose remedy is not in place yet.

struct KnownFailuresRequest

Arguments for stack known-failures.

arches: Vec<String>

Architectures to check. Empty checks every one in the table.

easystacks: Vec<PathBuf>

Easystacks whose entries are the plan. Repeatable.

easyconfigs: Vec<PathBuf>

Robot trees the dependency closure is read from. Empty checks only the filenames the easystacks name.

installed: Option<PathBuf>

Installed modules, one Name/VersionFull per line. An installed module is not rebuilt, so it is not warned about.

known_failures: Option<PathBuf>

Override data/arch-known-failures.toml.

eessi_version: Option<String>

Override the EESSI version in each easystack file name.

easybuild_version: Option<String>

Override the EasyBuild release in each easystack file name.

struct KnownHit

One known failure a plan includes or depends on.

id: String

The table entry.

file: String

Easyconfig filename that fails.

extension: Option<String>

name version of the extension that fails, when the match is an exts_list entry rather than the easyconfig itself.

arches: Vec<String>

Architectures it fails on, as reported.

phase: Phase

Where the run fails.

symptom: String

What the bot log shows.

remedy: String

The easyconfig remedy.

hook: Option<String>

EESSI hook that applies it.

caused_by_hook: Option<String>

EESSI hook whose rewrite causes it.

sources: Vec<String>

Evidence.

required_by: BTreeSet<String>

Plan entries that depend on file. Empty when the plan names it.

remedied: Option<String>

Why the remedy is already in place. None is a warning.

Implementations

impl KnownHit

Functions

fn message(&self) -> String

The lines the command prints for this hit, without a final newline.

fn warning_summary(&self) -> String

A one-line summary naming the easyconfig, the architectures, and the phase, for the --strict error text.

struct PlanContext

The EESSI and EasyBuild versions a plan is built for.

None means the plan does not say, and every entry applies.

eessi_version: Option<String>

EESSI version, 2025.06.

easybuild_version: Option<String>

EasyBuild release, 5.4.0.

Implementations

impl PlanContext

Functions

fn from_easystack_name(name: &str, eessi_version: Option<&str>, easybuild_version: Option<&str>) -> Self

Versions from an EESSI easystack file name such as eessi-2026.06-eb-5.4.0-2026.1.yml, unless an override is given.