openjd-model 0.2.1

Open Job Description model library — parsing, validation, and job creation
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92

// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// Copyright by contributors to this project.
// SPDX-License-Identifier: (Apache-2.0 OR MIT)

//! Standard capability definitions for the Open Job Description specification.
//!
//! Capability lookup functions take `(SpecificationRevision, &Extensions)` and
//! return `Result` because the set of standard capabilities may vary by revision,
//! and future extensions may add or modify capabilities that are only valid for
//! certain revision+extension combinations.

use crate::error::ModelError;
use crate::types::{Extensions, SpecificationRevision};

/// Standard amount capabilities and their names.
const STANDARD_AMOUNT_CAPABILITIES_V2023_09: &[&str] = &[
    "amount.worker.vcpu",
    "amount.worker.memory",
    "amount.worker.gpu",
    "amount.worker.gpu.memory",
    "amount.worker.disk.scratch",
];

/// Standard attribute capabilities, their names, and allowed values.
const STANDARD_ATTRIBUTE_CAPABILITIES_V2023_09: &[(&str, &[&str])] = &[
    ("attr.worker.os.family", &["linux", "windows", "macos"]),
    ("attr.worker.cpu.arch", &["x86_64", "arm64"]),
];

fn unsupported_revision(revision: SpecificationRevision) -> ModelError {
    ModelError::DecodeValidation(format!("Unsupported specification revision: {revision}"))
}

/// Return the standard amount capability names for the given revision and extensions.
pub fn standard_amount_capability_names(
    revision: SpecificationRevision,
    _extensions: &Extensions,
) -> Result<&'static [&'static str], ModelError> {
    #[allow(unreachable_patterns)] // wildcard needed for forward compat with new revisions
    match revision {
        SpecificationRevision::V2023_09 => Ok(STANDARD_AMOUNT_CAPABILITIES_V2023_09),
        _ => Err(unsupported_revision(revision)),
    }
}

/// Return the standard attribute capability names for the given revision and extensions.
pub fn standard_attribute_capability_names(
    revision: SpecificationRevision,
    _extensions: &Extensions,
) -> Result<Vec<&'static str>, ModelError> {
    #[allow(unreachable_patterns)]
    match revision {
        SpecificationRevision::V2023_09 => Ok(STANDARD_ATTRIBUTE_CAPABILITIES_V2023_09
            .iter()
            .map(|(name, _)| *name)
            .collect()),
        _ => Err(unsupported_revision(revision)),
    }
}

/// Return the standard attribute capabilities (name + allowed values) for the given
/// revision and extensions.
pub fn standard_attribute_capabilities(
    revision: SpecificationRevision,
    _extensions: &Extensions,
) -> Result<&'static [(&'static str, &'static [&'static str])], ModelError> {
    #[allow(unreachable_patterns)]
    match revision {
        SpecificationRevision::V2023_09 => Ok(STANDARD_ATTRIBUTE_CAPABILITIES_V2023_09),
        _ => Err(unsupported_revision(revision)),
    }
}

/// Validate that a string is a valid amount capability name.
pub fn validate_amount_capability_name(name: &str) -> Result<(), String> {
    let re = &crate::template::validate_v2023_09::helpers::AMOUNT_CAP_RE;
    if re.is_match(name) {
        Ok(())
    } else {
        Err(format!("'{name}' is not a valid amount capability name"))
    }
}

/// Validate that a string is a valid attribute capability name.
pub fn validate_attribute_capability_name(name: &str) -> Result<(), String> {
    let re = &crate::template::validate_v2023_09::helpers::ATTR_CAP_RE;
    if re.is_match(name) {
        Ok(())
    } else {
        Err(format!("'{name}' is not a valid attribute capability name"))
    }
}