lattice-common 2026.1.203

Shared types, configuration, and error handling for Lattice scheduler
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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
//! OCI distribution spec image resolver.
//!
//! Talks to OCI-compliant registries (Docker Hub, JFrog, GHCR, ORAS) to
//! resolve image references to content-addressed digests.

use async_trait::async_trait;
use std::time::Duration;

use crate::traits::{ImageResolveError, ImageResolver};
use crate::types::{ImageMetadata, ImageRef, ImageType};

/// Accept header for OCI distribution spec manifest requests.
const OCI_ACCEPT_HEADER: &str = "application/vnd.oci.image.manifest.v1+json, application/vnd.docker.distribution.manifest.v2+json";

/// An [`ImageResolver`] that talks to OCI distribution spec registries.
///
/// Resolves human-readable image specs (e.g., `registry.io/name:tag`) to
/// content-addressed [`ImageRef`]s by querying the registry manifest API.
pub struct OciRegistryResolver {
    client: reqwest::Client,
    default_registry: String,
}

/// Components parsed from an image spec string.
#[derive(Debug, Clone, PartialEq, Eq)]
struct ImageSpec {
    registry: String,
    name: String,
    /// Tag or digest reference (e.g., "latest" or "sha256:abc123").
    reference: String,
    /// True when the reference is a digest (contains `@sha256:`).
    is_digest: bool,
}

impl OciRegistryResolver {
    /// Create a new resolver with the given default registry.
    ///
    /// The default registry is used when an image spec does not include a
    /// registry prefix (e.g., `myimage:latest` becomes
    /// `<default_registry>/myimage:latest`).
    pub fn new(default_registry: &str) -> Self {
        let client = reqwest::Client::builder()
            .timeout(Duration::from_secs(10))
            .build()
            .expect("failed to build reqwest client");
        Self {
            client,
            default_registry: default_registry.to_string(),
        }
    }

    /// Create a resolver with a pre-built client (useful for testing).
    #[cfg(test)]
    fn with_client(client: reqwest::Client, default_registry: &str) -> Self {
        Self {
            client,
            default_registry: default_registry.to_string(),
        }
    }

    /// Parse an image spec string into its components.
    ///
    /// Accepted formats:
    /// - `registry.io/name:tag`
    /// - `registry.io/org/name:tag`
    /// - `name:tag` (uses default registry)
    /// - `name@sha256:abc123` (digest reference)
    /// - `registry.io/name@sha256:abc123`
    fn parse_spec(&self, spec: &str) -> Result<ImageSpec, ImageResolveError> {
        let spec = spec.trim();
        if spec.is_empty() {
            return Err(ImageResolveError::InvalidSpec {
                spec: spec.to_string(),
                reason: "empty image spec".to_string(),
            });
        }

        // Check for digest reference (@sha256:...)
        if let Some(at_pos) = spec.find('@') {
            let before_at = &spec[..at_pos];
            let digest = &spec[at_pos + 1..];

            if !digest.starts_with("sha256:") {
                return Err(ImageResolveError::InvalidSpec {
                    spec: spec.to_string(),
                    reason: "digest must start with sha256:".to_string(),
                });
            }

            let (registry, name) = self.split_registry_name(before_at)?;
            return Ok(ImageSpec {
                registry,
                name,
                reference: digest.to_string(),
                is_digest: true,
            });
        }

        // Tag reference — split on last ':'
        let (name_part, tag) = if let Some(colon_pos) = spec.rfind(':') {
            // Make sure the colon is not inside the registry (e.g., "localhost:5000/name")
            let after_colon = &spec[colon_pos + 1..];
            let before_colon = &spec[..colon_pos];

            // If after_colon contains '/' it's part of a path, not a tag
            if after_colon.contains('/') {
                (spec, "latest")
            } else {
                (before_colon, after_colon)
            }
        } else {
            (spec, "latest")
        };

        if tag.is_empty() {
            return Err(ImageResolveError::InvalidSpec {
                spec: spec.to_string(),
                reason: "empty tag".to_string(),
            });
        }

        let (registry, name) = self.split_registry_name(name_part)?;

        Ok(ImageSpec {
            registry,
            name,
            reference: tag.to_string(),
            is_digest: false,
        })
    }

    /// Split a name portion (without tag/digest) into registry and image name.
    ///
    /// A component is considered a registry if it contains a '.' or ':' (port),
    /// otherwise the default registry is used.
    fn split_registry_name(&self, input: &str) -> Result<(String, String), ImageResolveError> {
        if let Some(slash_pos) = input.find('/') {
            let first = &input[..slash_pos];
            let rest = &input[slash_pos + 1..];

            // Heuristic: if the first component has a dot or colon, it's a registry.
            if first.contains('.') || first.contains(':') {
                if rest.is_empty() {
                    return Err(ImageResolveError::InvalidSpec {
                        spec: input.to_string(),
                        reason: "empty image name".to_string(),
                    });
                }
                return Ok((first.to_string(), rest.to_string()));
            }

            // Otherwise treat the whole thing as the name under the default registry.
            Ok((self.default_registry.clone(), input.to_string()))
        } else {
            // No slash at all — just a name.
            Ok((self.default_registry.clone(), input.to_string()))
        }
    }

    /// Build the manifest URL for the given spec.
    fn manifest_url(registry: &str, name: &str, reference: &str) -> String {
        // Ensure registry has a scheme.
        let base = if registry.starts_with("http://") || registry.starts_with("https://") {
            registry.to_string()
        } else {
            format!("https://{registry}")
        };
        format!("{base}/v2/{name}/manifests/{reference}")
    }
}

#[async_trait]
impl ImageResolver for OciRegistryResolver {
    async fn resolve(
        &self,
        spec: &str,
        image_type: ImageType,
    ) -> Result<Option<ImageRef>, ImageResolveError> {
        let parsed = self.parse_spec(spec)?;

        let url = Self::manifest_url(&parsed.registry, &parsed.name, &parsed.reference);

        let response = self
            .client
            .get(&url)
            .header("Accept", OCI_ACCEPT_HEADER)
            .send()
            .await
            .map_err(|e| ImageResolveError::RegistryUnavailable {
                url: url.clone(),
                reason: e.to_string(),
            })?;

        match response.status().as_u16() {
            200 => {}
            404 => return Ok(None),
            401 | 403 => {
                return Err(ImageResolveError::RegistryUnavailable {
                    url,
                    reason: "unauthorized".to_string(),
                });
            }
            status => {
                return Err(ImageResolveError::RegistryUnavailable {
                    url,
                    reason: format!("unexpected status {status}"),
                });
            }
        }

        // Extract digest from Docker-Content-Digest header.
        let digest = response
            .headers()
            .get("Docker-Content-Digest")
            .and_then(|v| v.to_str().ok())
            .unwrap_or("")
            .to_string();

        let sha256 = digest
            .strip_prefix("sha256:")
            .unwrap_or(&digest)
            .to_string();

        let content_length = response
            .headers()
            .get("Content-Length")
            .and_then(|v| v.to_str().ok())
            .and_then(|v| v.parse::<u64>().ok())
            .unwrap_or(0);

        Ok(Some(ImageRef {
            spec: spec.to_string(),
            image_type,
            registry: parsed.registry,
            name: parsed.name.clone(),
            version: parsed.reference.clone(),
            original_tag: if parsed.is_digest {
                String::new()
            } else {
                parsed.reference
            },
            sha256,
            size_bytes: content_length,
            mount_point: String::new(),
            resolve_on_schedule: false,
        }))
    }

    async fn metadata(&self, image: &ImageRef) -> Result<ImageMetadata, ImageResolveError> {
        // For OCI images, views come from EDF, not env.json.
        // For uenv images, reading env.json requires mounting the SquashFS,
        // which is done by the node agent or a sidecar. We return empty
        // metadata here; callers should use uenv_metadata::parse_uenv_metadata
        // when they have the env.json content.
        Ok(ImageMetadata {
            name: image.name.clone(),
            description: String::new(),
            mount_point: String::new(),
            views: Vec::new(),
            default_view: None,
        })
    }
}

// ─── Tests ─────────────────────────────────────────────────

#[cfg(test)]
mod tests {
    use super::*;
    use wiremock::matchers::{method, path};
    use wiremock::{Mock, MockServer, ResponseTemplate};

    fn resolver(default_registry: &str) -> OciRegistryResolver {
        OciRegistryResolver::new(default_registry)
    }

    // ── parse_spec tests ──

    #[test]
    fn parse_spec_full_registry() {
        let r = resolver("default.io");
        let s = r.parse_spec("registry.io/myimage:v1").unwrap();
        assert_eq!(s.registry, "registry.io");
        assert_eq!(s.name, "myimage");
        assert_eq!(s.reference, "v1");
        assert!(!s.is_digest);
    }

    #[test]
    fn parse_spec_with_org() {
        let r = resolver("default.io");
        let s = r.parse_spec("registry.io/org/myimage:v2").unwrap();
        assert_eq!(s.registry, "registry.io");
        assert_eq!(s.name, "org/myimage");
        assert_eq!(s.reference, "v2");
    }

    #[test]
    fn parse_spec_default_registry() {
        let r = resolver("default.io");
        let s = r.parse_spec("myimage:latest").unwrap();
        assert_eq!(s.registry, "default.io");
        assert_eq!(s.name, "myimage");
        assert_eq!(s.reference, "latest");
    }

    #[test]
    fn parse_spec_no_tag_defaults_to_latest() {
        let r = resolver("default.io");
        let s = r.parse_spec("myimage").unwrap();
        assert_eq!(s.reference, "latest");
    }

    #[test]
    fn parse_spec_digest_reference() {
        let r = resolver("default.io");
        let s = r.parse_spec("myimage@sha256:abcdef1234567890").unwrap();
        assert_eq!(s.registry, "default.io");
        assert_eq!(s.name, "myimage");
        assert_eq!(s.reference, "sha256:abcdef1234567890");
        assert!(s.is_digest);
    }

    #[test]
    fn parse_spec_registry_with_digest() {
        let r = resolver("default.io");
        let s = r.parse_spec("registry.io/name@sha256:abc123").unwrap();
        assert_eq!(s.registry, "registry.io");
        assert_eq!(s.name, "name");
        assert_eq!(s.reference, "sha256:abc123");
        assert!(s.is_digest);
    }

    #[test]
    fn parse_spec_empty_errors() {
        let r = resolver("default.io");
        assert!(r.parse_spec("").is_err());
    }

    #[test]
    fn parse_spec_registry_with_port() {
        let r = resolver("default.io");
        let s = r.parse_spec("localhost:5000/myimage:v1").unwrap();
        assert_eq!(s.registry, "localhost:5000");
        assert_eq!(s.name, "myimage");
        assert_eq!(s.reference, "v1");
    }

    // ── resolve integration tests with wiremock ──

    #[tokio::test]
    async fn resolve_returns_image_ref_on_200() {
        let server = MockServer::start().await;

        // Wiremock sets Content-Length from body size, so we provide a body
        // to get a meaningful size_bytes value.
        let body = "x".repeat(4096);
        Mock::given(method("GET"))
            .and(path("/v2/myimage/manifests/v1"))
            .respond_with(
                ResponseTemplate::new(200)
                    .insert_header("Docker-Content-Digest", "sha256:deadbeef")
                    .set_body_string(body),
            )
            .expect(1)
            .mount(&server)
            .await;

        let uri = server.uri();
        let r = OciRegistryResolver::with_client(reqwest::Client::new(), &uri);

        let result = r.resolve("myimage:v1", ImageType::Oci).await.unwrap();
        let img = result.expect("should resolve");
        assert_eq!(img.sha256, "deadbeef");
        assert_eq!(img.size_bytes, 4096);
        assert_eq!(img.name, "myimage");
        assert_eq!(img.original_tag, "v1");
    }

    #[tokio::test]
    async fn resolve_returns_none_on_404() {
        let server = MockServer::start().await;

        Mock::given(method("GET"))
            .and(path("/v2/missing/manifests/latest"))
            .respond_with(ResponseTemplate::new(404))
            .mount(&server)
            .await;

        let r = OciRegistryResolver::with_client(reqwest::Client::new(), &server.uri());

        let result = r.resolve("missing", ImageType::Oci).await.unwrap();
        assert!(result.is_none());
    }

    #[tokio::test]
    async fn resolve_returns_error_on_401() {
        let server = MockServer::start().await;

        Mock::given(method("GET"))
            .and(path("/v2/private/manifests/latest"))
            .respond_with(ResponseTemplate::new(401))
            .mount(&server)
            .await;

        let r = OciRegistryResolver::with_client(reqwest::Client::new(), &server.uri());

        let result = r.resolve("private", ImageType::Oci).await;
        assert!(result.is_err());
        let err = result.unwrap_err();
        assert!(
            matches!(err, ImageResolveError::RegistryUnavailable { .. }),
            "expected RegistryUnavailable, got: {err:?}"
        );
    }

    #[tokio::test]
    async fn resolve_network_error() {
        // Connect to a port that's not listening.
        let r = OciRegistryResolver::with_client(
            reqwest::Client::builder()
                .timeout(Duration::from_millis(100))
                .build()
                .unwrap(),
            "http://127.0.0.1:1",
        );

        let result = r.resolve("anything:v1", ImageType::Uenv).await;
        assert!(result.is_err());
    }

    #[tokio::test]
    async fn metadata_returns_empty_for_oci() {
        let r = resolver("default.io");
        let img = ImageRef {
            name: "test".to_string(),
            ..Default::default()
        };
        let meta = r.metadata(&img).await.unwrap();
        assert!(meta.views.is_empty());
        assert_eq!(meta.name, "test");
    }
}