caisson 0.1.0-alpha

Offline Docker service updater for airgapped edge devices
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

//! Application layer wrappers around the package validation and image
//! import workflows.
//!
//! The CLI should not need to know how validation, staging, Docker import, and
//! persistence are stitched together.

use std::path::{Path, PathBuf};

use semver::Version;
use uuid::Uuid;

use crate::compose::{ComposeClient, ShellComposeClient};
use crate::docker::DockerServiceClient;
use crate::docker::{DockerImageClient, ImageImportError, ImageImportService};
use crate::domain::{ImageImportRecord, ServiceCatalog, UpdateAttemptRecord, ValidationRecord};
use crate::package::{PackageIntakeError, PackageIntakeService};
use crate::persistence::{FilesystemStore, StateStore};
use crate::update::{UpdateError, UpdateService};

/// Input for the package-validation use case.
#[derive(Debug, Clone)]
pub struct ValidatePackageRequest {
    pub package_path: PathBuf,
}

/// Input for the Docker image-import use case.
#[derive(Debug, Clone)]
pub struct ImportValidatedImageRequest {
    pub validation_record: ValidationRecord,
}

/// Input for the service-update use case.
#[derive(Debug, Clone)]
pub struct ApplyCandidateReleaseRequest {
    pub candidate_release_id: Uuid,
}

/// Application facade used by the CLI and tests for package validation.
#[derive(Debug)]
pub struct ValidationApp<S> {
    package_intake: PackageIntakeService<S>,
    staging_root: PathBuf,
}

impl ValidationApp<FilesystemStore> {
    /// Creates an app that uses the filesystem store.
    pub fn filesystem(
        catalog: ServiceCatalog,
        store: FilesystemStore,
        current_updater_version: Version,
    ) -> Self {
        let staging_root = store.root().join("staging");

        Self {
            package_intake: PackageIntakeService::new(catalog, store, current_updater_version),
            staging_root,
        }
    }
}

impl<S> ValidationApp<S>
where
    S: StateStore,
{
    /// Validates a package and persists the result locally.
    pub fn validate_package(
        &self,
        request: ValidatePackageRequest,
    ) -> Result<ValidationRecord, PackageIntakeError> {
        self.package_intake
            .validate_package(request.package_path, &self.staging_root)
    }

    /// Returns the staging root used by the app.
    #[must_use]
    pub fn staging_root(&self) -> &Path {
        &self.staging_root
    }
}

/// Application facade used by the CLI and tests for Docker image import.
#[derive(Debug)]
pub struct ImageImportApp<D, S> {
    image_import: ImageImportService<D, S>,
}

impl<D> ImageImportApp<D, FilesystemStore>
where
    D: DockerImageClient,
{
    /// Creates a filesystem-backed image-import app.
    pub fn filesystem(docker: D, store: FilesystemStore) -> Self {
        Self {
            image_import: ImageImportService::new(docker, store),
        }
    }
}

/// Application facade used by the CLI and tests for service updates.
#[derive(Debug)]
pub struct UpdateApp<D, C, S> {
    updates: UpdateService<D, C, S>,
}

impl<D> UpdateApp<D, ShellComposeClient, FilesystemStore>
where
    D: DockerServiceClient,
{
    /// Creates a filesystem-backed update app.
    pub fn filesystem(catalog: ServiceCatalog, docker: D, store: FilesystemStore) -> Self {
        Self {
            updates: UpdateService::new(catalog, docker, ShellComposeClient, store),
        }
    }
}

impl<D, S> ImageImportApp<D, S>
where
    D: DockerImageClient,
    S: StateStore,
{
    /// Imports a Docker image from a previously accepted validation record.
    pub fn import_validated_image(
        &self,
        request: ImportValidatedImageRequest,
    ) -> Result<ImageImportRecord, ImageImportError> {
        self.image_import
            .import_validated_package(&request.validation_record)
    }
}

impl<D, C, S> UpdateApp<D, C, S>
where
    D: DockerServiceClient,
    C: ComposeClient,
    S: StateStore,
{
    /// Creates an update app with explicit runtime dependencies.
    pub fn new(catalog: ServiceCatalog, docker: D, compose: C, store: S) -> Self {
        Self {
            updates: UpdateService::new(catalog, docker, compose, store),
        }
    }

    /// Applies a persisted candidate release to its target service.
    pub fn apply_candidate_release(
        &self,
        request: ApplyCandidateReleaseRequest,
    ) -> Result<UpdateAttemptRecord, UpdateError> {
        self.updates
            .apply_candidate_release(request.candidate_release_id)
    }
}