mod file_presence

module file_presence

Patch and source files an easystack’s easyconfigs need, found before a bot build.

EasyBuild downloads what a URL names and looks everything else up on disk: patches, sources no URL fetches, and patch files named only in checksums. A file that is in neither the easyconfig’s directory nor the robot path fails the build on every target, after the job has queued. Software-layer pull request 1842 pinned a commit whose tree lacked pip’s patch and failed on all of them.

The lookup is EasyBuild’s obtain_file: the easyconfig’s directory, then each robot path, each tried as <letter>/<name>/`, <name>/`, and itself, with ``extensions/ and packages/ also tried for an extension’s file. A from-commit pin puts that commit’s whole easybuild/easyconfigs tree on the robot path. A Bundle component’s patch is fetched twice, once under the bundle’s name and once under the component’s; for a from-commit easyconfig the second lookup skips the easyconfig’s directory (easybuild-framework issue 5133).

A missing patch or easyconfig fails the check. A source no URL names is a warning: EasyBuild’s last resort is sources.easybuild.io, which mirrors the sources of released easyconfigs but not of licensed software.

Functions

fn run_file_presence(request: &FilePresenceRequest) -> Result<FilePresenceReport>

Check every local file of every easystack entry.

Enums

enum MissingKind

What a missing file is.

Easyconfig

The easyconfig itself is on no robot path.

Patch

A patches entry of the recipe, an extension, or a component.

Source

A sources entry no URL downloads. Reported in FilePresenceReport::no_url.

ChecksumPatch

A patch named only as a checksums key.

Traits implemented

impl From<LocalFileKind> for MissingKind

Structs and Unions

struct FilePresenceReport

What stack files prints.

stdout: String

Stdout, ending with the count line.

missing: Vec<MissingFile>

Patches and easyconfigs the bot would not find. Non-empty fails the command.

no_url: Vec<MissingFile>

Sources no URL names and no tree holds. The bot’s last resort is sources.easybuild.io, which mirrors released sources, so these warn.

unchecked: Vec<String>

Entries that could not be checked, and why.

checked: usize

Easyconfigs read.

files: usize

Local files looked up across those easyconfigs.

struct FilePresenceRequest

Arguments for stack files.

easystacks: Vec<PathBuf>

Easystacks whose entries are checked. Repeatable.

easyconfigs: Vec<PathBuf>

Robot-path easyconfig trees, the EasyBuild release the bot runs.

commit_trees: Vec<String>

COMMIT=DIR: the easyconfigs tree of one from-commit pin.

easyconfigs_repo: Option<PathBuf>

easybuild-easyconfigs git checkout a from-commit pin is read from when no --commit-tree names it.

sourcepaths: Vec<PathBuf>

Source directories EasyBuild also searches. Repeatable.

path_maps: Vec<String>

FROM=TO: read an easystack path that starts with FROM from TO.

struct MissingFile

One file the bot would not find.

easystack: String

Easystack the entry is in.

easyconfig: String

Easyconfig filename.

from_commit: Option<String>

from-commit of the entry.

file: String

File name EasyBuild asks for.

kind: MissingKind

What the file is.

owner: Option<LocalFileOwner>

Recipe, extension, or component that names the file.

message: String

The line the command prints.