mod generation_lint¶
- module generation_lint¶
Toolchain generations an EESSI version carries, checked on a plan’s easystacks.
Each EESSI version is built on a fixed set of toolchain generations: 2023.06 on 2022b, 2023a and 2023b, 2025.06 on 2024a, 2025a and 2025b, 2026.06 on 2026.1.
data/eessi-generations.tomlis that table. An easystack entry on a toolchain outside its version’s generations cannot go into that version: software-layer #1472 put pv on GCCcore-12.3.0, which is 2023a, into a 2025.06 easystack. The bot builds one EESSI version per pull request, so easystacks for two versions in one pull request (#1834) fail as well.A plan that adds a second version of a software in one generation, next to one the plan or the stack already has, also fails unless that name is allowed explicitly. Some names carry several versions on purpose (CMake, Rust), and the allow is where a reviewer says so.
Variables
- const BUNDLED_GENERATIONS: &str¶
The table shipped with eb-stack.
Functions
- fn eessi_version_named(path: &str) -> Option<String>¶
The EESSI version a path names: the directory under
software.eessi.io/, or eessi-<V>-eb- in the file name.
- fn filename_generation(table: &GenerationTable, path: &str) -> Option<String>¶
The toolchain generation an easystack file name names, as a known generation of the table.
After eessi-<V>-eb-<X.Y.Z>-`, the token up to the next
-` or the ``.ymlis the generation. A non-generation group such as001-system,010-CUDAorcc70-CUDA, and any token the table does not list as a generation of some EESSI version, reads asNone. A suffix after the generation (-2023a-CUDA.yml) is dropped.
- fn lint_plan(table: &GenerationTable, plan: &Plan, eessi_version: Option<&str>, existing: &BTreeSet<String>, allow: &[VersionAllow]) -> Result<Vec<Finding>>¶
Lint one plan.
eessi_versionis the version for a path that names none, and the version every path is expected to name.existingholds the easyconfig filenames already in the stack.
- fn llvm_site_layer_warnings(policy: &Toolchain, also: &[Toolchain], easystack_files: &[String], added: &[(String, String)]) -> Vec<String>¶
Warn when a foss solve’s site layer is an LLVM-family package.
The LLVM family (
lfoss,lompi,lfbf,llvm-compilers) is invisible to a foss solve: the searched universe is the foss hierarchy, so an easystack entry onlfossdrops out of the baseline and the foss build of the same name is classified added. That added row is what the stack diff calls the site layer. Keep one lock per toolchain family.--baseline-also-toolchainfor that family puts its hierarchy back in the baseline, and this stays quiet for that family.policyis the solve’s toolchain.alsois--baseline-also-toolchain.easystack_filesare the easyconfig filenames the baseline easystacks name.addedis(package name, solved easyconfig path)for each added row. A solve whose own toolchain is in the LLVM family is that family’s lock, and returns no warnings.
- fn run_generation_lint(request: &GenerationLintRequest) -> Result<GenerationLintReport>¶
Lint easystack files, or the easystack changes of pull requests, against the generations of their EESSI version.
Enums
- enum FindingKind¶
What a finding is about.
- Outside¶
An entry on a toolchain outside its EESSI version’s generations.
- Mixed¶
Easystacks for more than one EESSI version, or not the one asked for.
- Versions¶
A second version of a name in one generation, not allowed.
- FileName¶
An entry whose generation differs from the generation its file name names, or a file naming a generation its EESSI version does not carry.
Structs and Unions
- struct Finding¶
One line of the report.
- kind: FindingKind¶
What it is about.
- message: String¶
The line the command prints.
- struct GenerationLintReport¶
What
stack generationprints.- stdout: String¶
Stdout, including the count line.
Implementations
- impl GenerationLintReport¶
Functions
- fn of(&self, kind: FindingKind) -> Vec<String>¶
The messages of one kind.
- struct GenerationLintRequest¶
Arguments for
stack generation.- easystacks: Vec<PathBuf>¶
Easystack files. Every entry is part of the plan.
- prs: Vec<PathBuf>¶
Pull-request JSON in the
pr-overlap --prshape. The lines each pull request adds are its plan, and the rest of the file is the stack.
- eessi_version: Option<String>¶
EESSI version for a path that names none, and the one every path should name.
- deployed: Vec<PathBuf>¶
Easystacks already deployed, or directories of them.
- allow_versions: Vec<String>¶
NAMEorNAME@GENERATIONallowed a second version.
- generations: Option<PathBuf>¶
Replace
data/eessi-generations.toml.
- struct GenerationTable¶
EESSI versions and the toolchain generations each one carries.
Implementations
- impl GenerationTable¶
Functions
- fn bundled() -> Result<Self>¶
The table shipped in
data/eessi-generations.toml.
- fn generation_of(&self, toolchain: &str) -> Option<String>¶
The generation a toolchain label such as
GCCcore-12.3.0is in.A toolchain whose version is a generation (
lompi-2025b) is in that generation even when no EESSI version carries it. A compiler version outside every hierarchy the table carries isNone.
- fn generations(&self, eessi: &str) -> Option<&[String]>¶
Generations
eessicarries, orNonefor a version the table lacks.
- fn load(path: &Path) -> Result<Self>¶
Read a table from
path.
- fn members(&self, generation: &str) -> Vec<String>¶
Toolchain labels of
generationother than system: the shipped foss hierarchy and the table’s extra toolchains.
- fn parse(text: &str) -> Result<Self>¶
Parse the TOML document.
A generation belongs to one EESSI version. That is what lets a finding name the version an entry belongs in.
- fn version_carrying(&self, generation: &str) -> Option<&str>¶
The EESSI version that carries
generation.
- fn versions(&self) -> Vec<&str>¶
EESSI versions the table knows, in order.
- struct Plan¶
The easystacks one pull request, or one run over easystack files, changes.
- label: Option<String>¶
#1472for a pull request.Nonefor easystack files.
- struct PlanFile¶
One easystack file of a plan.
- path: String¶
Path, from which the EESSI version is read.
- added: Vec<String>¶
Easyconfig filenames the plan adds.
- kept: Vec<String>¶
Easyconfig filenames already in the file, which count as installed.
- struct VersionAllow¶
A name allowed more than one version, in one generation or in all.
- name: String¶
EasyBuild name,
CMake.
- generation: Option<String>¶
Generation,
2025b.Noneallows every generation.
Implementations
- impl VersionAllow¶
Functions
- fn parse(spec: &str) -> Result<Self>¶
NAMEorNAME@GENERATION.