Skip to main content

caixa_core/
lib.rs

1// SPDX-License-Identifier: MIT
2//! `caixa-core` — manifest types, layout invariants, and version contract
3//! for the caixa tatara-lisp package system.
4//!
5//! The `caixa.lisp` manifest is itself a [`tatara_lisp::domain::TataraDomain`]
6//! — parsing is the derive macro, which makes ill-typed manifests impossible
7//! at load time (the same discipline Cargo gets from `Cargo.toml`, but
8//! enforced by Rust types rather than TOML schema).
9//!
10//! Layout invariants (lib/ presence, exe/ population, service entries) are
11//! enforced by [`LayoutInvariants`], run by `caixa-feira` before any build
12//! step.
13
14extern crate self as caixa_core;
15
16pub mod aplicacao;
17pub mod behavior;
18pub mod dep;
19pub mod dialeto;
20pub mod kind;
21pub mod layout;
22pub mod limits;
23pub mod manifest;
24pub mod render;
25pub mod supervisor;
26pub mod upgrade;
27pub mod version;
28
29pub use aplicacao::{
30    AplicacaoError, AplicacaoSpec, CircuitBreaker, DEFAULT_SERVICO_PORT, Entrada, Membro,
31    MeshPolicy, POLICY_BREAKER_MAX_FAILURES_MAX, POLICY_BREAKER_WINDOW_MAX, POLICY_RATE_LIMIT_MAX,
32    POLICY_RETRIES_MAX, POLICY_TIMEOUT_MAX, Placement, PlacementStrategy, RateLimit, RateLimitUnit,
33    SERVICO_PORT_MIN, WitContract, WitTarget,
34};
35pub use behavior::{BehaviorError, BehaviorSpec};
36pub use dep::{Dep, DepError, DepList, DepSource};
37pub use dialeto::{CaixaDialeto, DialetoError, classify as classify_dialeto};
38pub use kind::CaixaKind;
39pub use layout::{LayoutError, LayoutInvariants, StandardLayout};
40pub use limits::{
41    LIMITS_CPU_MILLICORES_MAX, LIMITS_FUEL_MAX, LIMITS_MEMORY_WASM32_MAX_BYTES,
42    LIMITS_MEMORY_WASM32_PAGE_BYTES, LIMITS_WALL_CLOCK_MAX, LimitsError, LimitsSpec,
43};
44pub use manifest::{Caixa, LeituraError, ManifestError};
45pub use render::{
46    CAIXA_KEY_DEPS, CAIXA_KEY_DEPS_DEV, CAIXA_KIND_LABEL_ACAO, CAIXA_KIND_LABEL_APLICACAO,
47    CAIXA_KIND_LABEL_BIBLIOTECA, CAIXA_KIND_LABEL_BINARIO, CAIXA_KIND_LABEL_SERVICO,
48    CAIXA_KIND_LABEL_SUPERVISOR, CARGO_FEATURE_NAME_MAX_LEN, CILIUM_API_VERSION,
49    CILIUM_AUTH_MODE_DISABLED, CILIUM_AUTH_MODE_REQUIRED, CILIUM_KEY_AUTHENTICATION,
50    CILIUM_KEY_ENDPOINT_SELECTOR, CILIUM_KEY_FROM_ENDPOINTS, CILIUM_KEY_HTTP, CILIUM_KEY_INGRESS,
51    CILIUM_KEY_MODE, CILIUM_KEY_PATH, CILIUM_KEY_PORTS, CILIUM_KEY_TO_PORTS,
52    CILIUM_KIND_NETWORK_POLICY, CIRCUIT_BREAKER_KEY_MAX_FAILURES, CIRCUIT_BREAKER_KEY_WINDOW,
53    CLUSTER_BUNDLE_LAREIRA_ENABLED_DEFAULT, COMPUTEUNIT_MODULE_KEY_SOURCE,
54    COMPUTEUNIT_SPEC_KEY_CAPABILITIES, COMPUTEUNIT_SPEC_KEY_MODULE, COMPUTEUNIT_SPEC_KEY_TRIGGER,
55    COMPUTEUNIT_YAML_SUFFIX, CONTRATO_EDGE_LABEL_SEPARATOR, CONTRATO_KEY_DE, CONTRATO_KEY_PARA,
56    CONTRATO_KEY_WIT, CiDecomposeFailure, DEFAULT_FLUX_CHART_SOURCE_SUBPATH,
57    DEFAULT_FLUX_KUSTOMIZATION_TIMEOUT, DEFAULT_FLUX_RECONCILE_INTERVAL,
58    DEFAULT_FLUX_SYSTEM_NAMESPACE, DEFAULT_GATEWAY_CLASS_NAME, DEFAULT_LIBRARY_NAME,
59    DEFAULT_NAMESPACE, DEP_AUTHOR_KEY_DEPS, DEP_AUTHOR_KEY_DEPS_DEV, DEP_SOURCE_KEY_TIPO,
60    DEP_SOURCE_TIPO_GIT, DEP_SOURCE_TIPO_PATH, DNS_1123_LABEL_MAX_LEN, ENTRADA_KEY_HOST,
61    ENTRADA_KEY_PARA, ENTRADA_KEY_PATHS, ENTRADA_KEY_PORT, FLEET_PROGRAMS_KEY_APLICACAO,
62    FLEET_PROGRAMS_KEY_NAME, FLEET_PROGRAMS_KEY_PROGRAMS, FLEET_PROGRAMS_KEY_VERSAO,
63    FLUX_GITREPOSITORY_API_VERSION, FLUX_GITREPOSITORY_KEY_REF, FLUX_GITREPOSITORY_KEY_URL,
64    FLUX_GITREPOSITORY_REF_KEY_BRANCH, FLUX_GITREPOSITORY_REF_KEY_COMMIT,
65    FLUX_GITREPOSITORY_REF_KEY_TAG, FLUX_GITREPOSITORY_YAML_FILENAME,
66    FLUX_HELMCHART_TEMPLATE_KEY_CHART, FLUX_HELMRELEASE_API_VERSION,
67    FLUX_HELMRELEASE_CREATE_NAMESPACE_DEFAULT, FLUX_HELMRELEASE_KEY_CREATE_NAMESPACE,
68    FLUX_HELMRELEASE_KEY_INSTALL, FLUX_HELMRELEASE_KEY_REMEDIATE_LAST_FAILURE,
69    FLUX_HELMRELEASE_KEY_REMEDIATION, FLUX_HELMRELEASE_KEY_RETRIES, FLUX_HELMRELEASE_KEY_UPGRADE,
70    FLUX_HELMRELEASE_REMEDIATE_LAST_FAILURE_DEFAULT, FLUX_HELMRELEASE_REMEDIATION_RETRIES_DEFAULT,
71    FLUX_HELMRELEASE_YAML_FILENAME, FLUX_KEY_CHART, FLUX_KEY_HEALTH_CHECKS, FLUX_KEY_INTERVAL,
72    FLUX_KEY_SOURCE_REF, FLUX_KEY_VALUES, FLUX_KIND_GIT_REPOSITORY, FLUX_KIND_HELM_RELEASE,
73    FLUX_KIND_KUSTOMIZATION, FLUX_KUSTOMIZATION_API_VERSION, FLUX_KUSTOMIZATION_KEY_PATH,
74    FLUX_KUSTOMIZATION_KEY_PRUNE, FLUX_KUSTOMIZATION_KEY_TIMEOUT, FLUX_KUSTOMIZATION_PRUNE_DEFAULT,
75    FLUX_KUSTOMIZATION_YAML_FILENAME, GATEWAY_API_API_VERSION,
76    GATEWAY_API_DEFAULT_HTTP_LISTENER_NAME, GATEWAY_API_DEFAULT_HTTP_LISTENER_PORT,
77    GATEWAY_API_DEFAULT_HTTP_ROUTE_PATH, GATEWAY_API_HOSTNAME_MAX_LEN,
78    GATEWAY_API_HTTP_PATH_MAX_LEN, GATEWAY_API_KEY_ATTEMPTS, GATEWAY_API_KEY_BACKEND_REFS,
79    GATEWAY_API_KEY_GATEWAY_CLASS_NAME, GATEWAY_API_KEY_HOSTNAME, GATEWAY_API_KEY_HOSTNAMES,
80    GATEWAY_API_KEY_LISTENERS, GATEWAY_API_KEY_MATCHES, GATEWAY_API_KEY_NAME,
81    GATEWAY_API_KEY_PARENT_REFS, GATEWAY_API_KEY_PATH, GATEWAY_API_KEY_REQUEST,
82    GATEWAY_API_KEY_RETRY, GATEWAY_API_KEY_SECTION_NAME, GATEWAY_API_KEY_TIMEOUTS,
83    GATEWAY_API_KEY_VALUE, GATEWAY_API_KIND_GATEWAY, GATEWAY_API_KIND_HTTP_ROUTE,
84    GATEWAY_API_PATH_MATCH_TYPE_PATH_PREFIX, GATEWAY_API_PROTOCOL_HTTP, GIT_OID_SHA1_LEN,
85    GIT_OID_SHA256_LEN, GIT_REF_NAME_MAX_LEN, GIT_REPO_URL_MAX_LEN, HELM_CHART_API_VERSION,
86    HELM_CHART_DEPENDENCY_KEY_ALIAS, HELM_CHART_DEPENDENCY_KEY_NAME,
87    HELM_CHART_DEPENDENCY_KEY_REPOSITORY, HELM_CHART_DEPENDENCY_KEY_VERSION,
88    HELM_CHART_KEY_API_VERSION, HELM_CHART_KEY_APP_VERSION, HELM_CHART_KEY_DEPENDENCIES,
89    HELM_CHART_KEY_TYPE, HELM_CHART_README_FILENAME, HELM_CHART_TYPE_APPLICATION,
90    HELM_CHART_TYPE_LIBRARY, HELM_CHART_YAML_FILENAME, HELM_VALUES_KEY_ENABLED,
91    HELM_VALUES_YAML_FILENAME, KUBE_KEY_API_VERSION, KUBE_KEY_KIND, KUBE_KEY_LABELS,
92    KUBE_KEY_MATCH_LABELS, KUBE_KEY_METADATA, KUBE_KEY_NAME, KUBE_KEY_NAMESPACE, KUBE_KEY_PORT,
93    KUBE_KEY_PROTOCOL, KUBE_KEY_RULES, KUBE_KEY_SPEC, KUBE_KEY_TYPE, KUBE_PROTOCOL_TCP,
94    KindMismatch, KubeReceiver, LABEL_APLICACAO, LABEL_CONTRATO, LABEL_PROGRAM,
95    LAREIRA_CHART_KEYWORDS, LAREIRA_CHART_NAME_NOME_MAX_LEN, LAREIRA_CHART_NAME_PREFIX,
96    LAYOUT_DIR_EXE, LAYOUT_DIR_LIB, LAYOUT_DIR_SERVICOS,
97    LAYOUT_MISSING_ENTRY_KIND_BEHAVIOR_CALLBACK, LAYOUT_MISSING_ENTRY_KIND_BIBLIOTECA,
98    LAYOUT_MISSING_ENTRY_KIND_EXE, LAYOUT_MISSING_ENTRY_KIND_SERVICO,
99    LAYOUT_MISSING_ENTRY_KIND_UPGRADE_SCRIPT, LISP_SOURCE_EXTENSION, M2_AUTHOR_KEY_BEHAVIOR,
100    M2_AUTHOR_KEY_LIMITS, M2_AUTHOR_KEY_UPGRADE_FROM, M2_BEHAVIOR_AUTHOR_KEY_ON_CALL,
101    M2_BEHAVIOR_AUTHOR_KEY_ON_CAST, M2_BEHAVIOR_AUTHOR_KEY_ON_INFO, M2_BEHAVIOR_AUTHOR_KEY_ON_INIT,
102    M2_BEHAVIOR_AUTHOR_KEY_ON_STATE_CHANGE, M2_BEHAVIOR_AUTHOR_KEY_ON_TERMINATE,
103    M2_BEHAVIOR_KEY_ON_CALL, M2_BEHAVIOR_KEY_ON_CAST, M2_BEHAVIOR_KEY_ON_INFO,
104    M2_BEHAVIOR_KEY_ON_INIT, M2_BEHAVIOR_KEY_ON_STATE_CHANGE, M2_BEHAVIOR_KEY_ON_TERMINATE,
105    M2_KEY_BEHAVIOR, M2_KEY_LIMITS, M2_KEY_UPGRADE_FROM, M2_LIMITS_KEY_CPU, M2_LIMITS_KEY_FUEL,
106    M2_LIMITS_KEY_MEMORY, M2_LIMITS_KEY_WALL_CLOCK, M2_UPGRADE_FROM_KEY_FROM,
107    M2_UPGRADE_FROM_KEY_INSTRUCTIONS, M2_UPGRADE_INSTRUCTION_FIELD_KEY_MODULE,
108    M2_UPGRADE_INSTRUCTION_FIELD_KEY_SCRIPT, M2_UPGRADE_INSTRUCTION_KEY_KIND,
109    M2_UPGRADE_INSTRUCTION_KIND_LOAD_MODULE, M2_UPGRADE_INSTRUCTION_KIND_PURGE,
110    M2_UPGRADE_INSTRUCTION_KIND_RESTART, M2_UPGRADE_INSTRUCTION_KIND_SOFT_PURGE,
111    M2_UPGRADE_INSTRUCTION_KIND_STATE_CHANGE, M3_AUTHOR_KEY_CONTRATOS, M3_AUTHOR_KEY_ENTRADA,
112    M3_AUTHOR_KEY_MEMBROS, M3_AUTHOR_KEY_PLACEMENT, M3_AUTHOR_KEY_POLITICAS, M3_KEY_PLACEMENT,
113    M3_PLACEMENT_ESTRATEGIA_REPLICATED, M3_PLACEMENT_ESTRATEGIA_SHARDED,
114    M3_PLACEMENT_ESTRATEGIA_SINGLE_NODE, M3_PLACEMENT_KEY_AFFINITY, M3_PLACEMENT_KEY_CLUSTERS,
115    M3_PLACEMENT_KEY_ESTRATEGIA, M3_PLACEMENT_KEY_SHARD_KEY, MEMBRO_KEY_CAIXA, MEMBRO_KEY_VERSAO,
116    MappingExt, MissingCiSlot, NATS_SUBJECT_MAX_LEN, OCI_SCHEME_PREFIX, PLEME_LABEL_PREFIX,
117    POLITICAS_KEY_CIRCUIT_BREAKER, POLITICAS_KEY_MTLS_REQUIRED, POLITICAS_KEY_RATE_LIMIT,
118    POLITICAS_KEY_RETRIES, POLITICAS_KEY_TIMEOUT, PathShapeViolation, RenderError, RenderedFile,
119    STANDALONE_LAREIRA_ENABLED_DEFAULT, SUPERVISOR_AUTHOR_KEY_CHILDREN,
120    SUPERVISOR_AUTHOR_KEY_ESTRATEGIA, SUPERVISOR_AUTHOR_KEY_MAX_RESTARTS,
121    SUPERVISOR_AUTHOR_KEY_RESTART_WINDOW, SUPERVISOR_CHILD_KEY_CAIXA, SUPERVISOR_CHILD_KEY_RESTART,
122    SUPERVISOR_CHILD_KEY_VERSAO, SUPERVISOR_CHILD_RESTART_PERMANENT,
123    SUPERVISOR_CHILD_RESTART_TEMPORARY, SUPERVISOR_CHILD_RESTART_TRANSIENT,
124    SUPERVISOR_ESTRATEGIA_ONE_FOR_ALL, SUPERVISOR_ESTRATEGIA_ONE_FOR_ONE,
125    SUPERVISOR_ESTRATEGIA_REST_FOR_ONE, SUPERVISOR_ESTRATEGIA_SIMPLE_ONE_FOR_ONE,
126    SUPERVISOR_KEY_CHILDREN, SUPERVISOR_KEY_ESTRATEGIA, SUPERVISOR_KEY_MAX_RESTARTS,
127    SUPERVISOR_KEY_RESTART_WINDOW, SequenceExt, ServicoCountMismatch, WASI_KV_SLOT_MAX_LEN,
128    WIT_IDENT_MAX_LEN, assert_str_reexport_identity, ci_declared_edge_count, cilium_auth_mode,
129    cilium_network_policy_name, contrato_edge_label, decompose_ci, find_ascii_whitespace_byte,
130    find_by_api_version, find_by_kind, find_by_label, find_by_name, find_by_namespace,
131    find_non_ascii_whitespace_char, flux_kustomization_source_subtree, gateway_api_http_route_name,
132    insert_first_seen, is_cargo_feature_name, is_computeunit_yaml_extension,
133    is_digit_only_magnitude, is_dns_1123_label, is_gateway_api_http_path, is_git_oid,
134    is_git_ref_name, is_git_repo_url, is_lareira_chart_name_shape,
135    is_leading_zero_padded_magnitude, is_lisp_extension, is_nats_subject,
136    is_sandboxed_relative_path, is_wasi_keyvalue_slot, is_wit_world_ref, kube_api_version,
137    kube_api_version_is, kube_bool, kube_kind, kube_kind_is, kube_map, kube_match_label,
138    kube_match_label_is, kube_match_labels, kube_metadata, kube_metadata_field,
139    kube_metadata_label, kube_metadata_label_is, kube_metadata_labels, kube_metadata_map_field,
140    kube_metadata_seq_field, kube_metadata_str_field, kube_name, kube_name_is, kube_namespace,
141    kube_namespace_is, kube_resource_skeleton, kube_root_bool_field, kube_root_map_field,
142    kube_root_seq_field, kube_root_str_field, kube_seq, kube_seq_first, kube_spec,
143    kube_spec_bool_field, kube_spec_field, kube_spec_map_field, kube_spec_seq_field,
144    kube_spec_seq_first, kube_spec_str_field, kube_str, kube_u64, label_selector,
145    lareira_chart_name, oci_chart_ref, pleme_program_in_aplicacao_selector, pleme_program_selector,
146    require_acao_view, require_aplicacao_view, require_ci, require_kind,
147    require_positive_bounded_u32, require_positive_bounded_u64,
148    require_positive_canonical_bounded_duration, require_single_servico, require_v0_servico_shape,
149    require_valid_dns_1123_label, require_valid_versao_requirement, servico_m2_overlay,
150    servico_spec_and_m2_overlay_entries, single_field_overlay, singleton_mapping_sequence,
151    string_keyed_entries, upsert_named_entry, yaml_string_mapping,
152};
153pub use supervisor::{
154    ChildSpec, RestartPolicy, RestartStrategy, SUPERVISOR_MAX_RESTARTS_MAX,
155    SUPERVISOR_RESTART_WINDOW_MAX, SupervisorError, SupervisorSpec,
156};
157pub use upgrade::{
158    UpgradeError, UpgradeFromEntry, UpgradeInstruction, validate_upgrade_from,
159    validate_upgrade_from_against_behavior, validate_upgrade_from_against_versao,
160};
161pub use version::{
162    CaixaVersion, DEFAULT_GIT_REMOTE, DEFAULT_PLEME_GIT_ORG, DEFAULT_PUBLISH_TAG_PREFIX,
163    VersionError, parse_requirement,
164};