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 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516
//! Main entrypoint for interacting with the Docker API.
//!
//! API Reference: <https://docs.docker.com/engine/api/v1.42/>
use crate::{
conn::{get_http_connector, Headers, Payload, Transport},
errors::{Error, Result},
ApiVersion, Containers, Images, Networks, Volumes,
};
use containers_api::conn::RequestClient;
#[cfg(feature = "swarm")]
use crate::{Configs, Nodes, Plugins, Secrets, Services, Swarm, Tasks};
#[cfg(feature = "tls")]
use crate::conn::get_https_connector;
#[cfg(unix)]
use crate::conn::get_unix_connector;
use futures_util::{
io::{AsyncRead, AsyncWrite},
stream::Stream,
};
use hyper::{body::Bytes, Body, Client, Response};
use serde::de::DeserializeOwned;
use std::future::Future;
use std::path::{Path, PathBuf};
use std::pin::Pin;
/// Entrypoint interface for communicating with docker daemon
#[derive(Debug, Clone)]
pub struct Docker {
version: Option<ApiVersion>,
client: RequestClient<Error>,
}
impl Docker {
/// Creates a new Docker instance by automatically choosing appropriate connection type based
/// on provided `uri`.
///
/// Supported schemes are:
/// - `unix://` only works when build target is `unix`, otherwise returns an Error
/// - `tcp://`
/// - `http://`
///
/// To create a Docker instance utilizing TLS use explicit [Docker::tls](Docker::tls)
/// constructor (this requires `tls` feature enabled).
///
/// This creates an unversioned connector that'll use the latest server version, to use a specific version see
/// [`Docker::unix_versioned`](Docker::unix_versioned).
pub fn new(uri: impl AsRef<str>) -> Result<Self> {
Self::new_impl(uri.as_ref(), None)
}
/// Same as [`Docker::new`](Docker::new) but the API version can be explicitly specified.
pub fn new_versioned(uri: impl AsRef<str>, version: impl Into<ApiVersion>) -> Result<Self> {
Self::new_impl(uri.as_ref(), Some(version.into()))
}
fn new_impl(uri: &str, version: Option<ApiVersion>) -> Result<Self> {
let mut it = uri.split("://");
match it.next() {
#[cfg(unix)]
Some("unix") => {
if let Some(path) = it.next() {
Ok(Self::new_unix_impl(path, version))
} else {
Err(Error::MissingAuthority)
}
}
#[cfg(not(unix))]
Some("unix") => Err(Error::UnsupportedScheme("unix".to_string())),
Some("tcp") | Some("http") => {
if let Some(host) = it.next() {
Self::new_tcp_impl(host, version)
} else {
Err(Error::MissingAuthority)
}
}
Some(scheme) => Err(Error::UnsupportedScheme(scheme.to_string())),
None => unreachable!(), // This is never possible because calling split on an empty string
// always returns at least one element
}
}
#[cfg(unix)]
#[cfg_attr(docsrs, doc(cfg(unix)))]
/// Creates a new docker instance for a docker host listening on a given Unix socket.
///
/// `socket_path` is the part of URI that comes after the `unix://`. For example a URI `unix:///run/docker.sock` has a
/// `socket_path` == "/run/docker.sock".
///
/// This creates an unversioned connector that'll use the latest server version, to use a specific version see
/// [`Docker::unix_versioned`](Docker::unix_versioned).
pub fn unix(socket_path: impl AsRef<Path>) -> Self {
Self::new_unix_impl(socket_path.as_ref(), None)
}
#[cfg(unix)]
#[cfg_attr(docsrs, doc(cfg(unix)))]
/// Same as [`Docker::unix`](Docker::unix) but the API version can be explicitly specified.
pub fn unix_versioned(socket_path: impl AsRef<Path>, version: impl Into<ApiVersion>) -> Self {
Self::new_unix_impl(socket_path.as_ref(), Some(version.into()))
}
#[cfg(unix)]
fn new_unix_impl(socket_path: impl Into<PathBuf>, version: Option<ApiVersion>) -> Self {
Docker {
version,
client: RequestClient::new(
Transport::Unix {
client: Client::builder()
.pool_max_idle_per_host(0)
.build(get_unix_connector()),
path: socket_path.into(),
},
Box::new(validate_response),
),
}
}
#[cfg(feature = "tls")]
#[cfg_attr(docsrs, doc(cfg(feature = "tls")))]
/// Creates a new docker instance for a docker host listening on a given TCP socket `host`.
/// `host` is the part of URI that comes after `tcp://` or `http://` or `https://` schemes,
/// also known as authority part.
///
/// `cert_path` specifies the base path in the filesystem containing a certificate (`cert.pem`)
/// and a key (`key.pem`) that will be used by the client. If verify is `true` a CA file will be
/// added (`ca.pem`) to the connector.
///
/// Returns an error if the provided host will fail to parse as URL or reading the certificate
/// files will fail.
///
/// This creates an unversioned connector that'll use the latest server version, to use a specific version see
/// [`Docker::unix_versioned`](Docker::unix_versioned).
pub fn tls(host: impl AsRef<str>, cert_path: impl AsRef<Path>, verify: bool) -> Result<Self> {
Self::new_tls_impl(host.as_ref(), None, cert_path.as_ref(), verify)
}
#[cfg(feature = "tls")]
#[cfg_attr(docsrs, doc(cfg(feature = "tls")))]
/// Same as [`Docker::tls`](Docker::tls) but the API version can be explicitly specified.
pub fn tls_versioned(
host: impl AsRef<str>,
version: impl Into<ApiVersion>,
cert_path: impl AsRef<Path>,
verify: bool,
) -> Result<Self> {
Self::new_tls_impl(
host.as_ref(),
Some(version.into()),
cert_path.as_ref(),
verify,
)
}
#[cfg(feature = "tls")]
fn new_tls_impl(
host: &str,
version: Option<ApiVersion>,
cert_path: &Path,
verify: bool,
) -> Result<Self> {
Ok(Self {
version,
client: RequestClient::new(
Transport::EncryptedTcp {
client: Client::builder().build(get_https_connector(cert_path, verify)?),
host: url::Url::parse(&format!("https://{host}")).map_err(Error::InvalidUrl)?,
},
Box::new(validate_response),
),
})
}
/// Creates a new docker instance for a docker host listening on a given TCP socket `host`.
/// `host` is the part of URI that comes after `tcp://` or `http://` schemes, also known as
/// authority part.
///
/// TLS is supported with feature `tls` enabled through [Docker::tls](Docker::tls) constructor.
///
/// Returns an error if the provided host will fail to parse as URL.
///
/// This creates an unversioned connector that'll use the latest server version, to use a specific version see
/// [`Docker::unix_versioned`](Docker::unix_versioned).
pub fn tcp(host: impl AsRef<str>) -> Result<Self> {
Self::new_tcp_impl(host.as_ref(), None)
}
/// Same as [`Docker::tcp`](Docker::tcp) but the API version can be explicitly specified.
pub fn tcp_versioned(host: impl AsRef<str>, version: impl Into<ApiVersion>) -> Result<Self> {
Self::new_tcp_impl(host.as_ref(), Some(version.into()))
}
fn new_tcp_impl(host: &str, version: Option<ApiVersion>) -> Result<Self> {
Ok(Self {
version,
client: RequestClient::new(
Transport::Tcp {
client: Client::builder().build(get_http_connector()),
host: url::Url::parse(&format!("tcp://{host}")).map_err(Error::InvalidUrl)?,
},
Box::new(validate_response),
),
})
}
/// Exports an interface for interacting with Docker images
pub fn images(&'_ self) -> Images {
Images::new(self.clone())
}
/// Exports an interface for interacting with Docker containers
pub fn containers(&'_ self) -> Containers {
Containers::new(self.clone())
}
/// Exports an interface for interacting with Docker networks
pub fn networks(&'_ self) -> Networks {
Networks::new(self.clone())
}
/// Exports an interface for interacting with Docker volumes
pub fn volumes(&'_ self) -> Volumes {
Volumes::new(self.clone())
}
/// Verifies the API version returned by the server and adjusts the version used by this client
/// in future requests.
pub async fn adjust_api_version(&mut self) -> Result<()> {
let server_version: ApiVersion = self.version().await.and_then(|v| {
v.api_version
.unwrap_or_default()
.parse::<ApiVersion>()
.map_err(Error::MalformedVersion)
})?;
self.version = Some(server_version);
Ok(())
}
//####################################################################################################
//
// Utility functions to make requests
//
//####################################################################################################
fn make_endpoint(&self, endpoint: impl AsRef<str>) -> String {
if let Some(version) = self.version {
version.make_endpoint(endpoint)
} else {
endpoint.as_ref().to_owned()
}
}
pub(crate) async fn get(&self, endpoint: &str) -> Result<Response<Body>> {
self.client.get(self.make_endpoint(endpoint)).await
}
pub(crate) async fn get_json<T: DeserializeOwned>(&self, endpoint: &str) -> Result<T> {
self.client.get_json(self.make_endpoint(endpoint)).await
}
#[allow(dead_code)]
pub(crate) async fn post<B>(
&self,
endpoint: &str,
body: Payload<B>,
headers: Option<Headers>,
) -> Result<Response<Body>>
where
B: Into<Body>,
{
self.client
.post(self.make_endpoint(endpoint), body, headers)
.await
}
pub(crate) async fn post_string<B>(
&self,
endpoint: &str,
body: Payload<B>,
headers: Option<Headers>,
) -> Result<String>
where
B: Into<Body>,
{
self.client
.post_string(self.make_endpoint(endpoint), body, headers)
.await
}
pub(crate) async fn post_json<B, T>(
&self,
endpoint: impl AsRef<str>,
body: Payload<B>,
headers: Option<Headers>,
) -> Result<T>
where
T: DeserializeOwned,
B: Into<Body>,
{
self.client
.post_json(self.make_endpoint(endpoint), body, headers)
.await
}
pub(crate) async fn put<B>(&self, endpoint: &str, body: Payload<B>) -> Result<String>
where
B: Into<Body>,
{
self.client
.put_string(self.make_endpoint(endpoint), body)
.await
}
pub(crate) async fn delete(&self, endpoint: &str) -> Result<String> {
self.client
.delete_string(self.make_endpoint(endpoint))
.await
}
pub(crate) async fn delete_json<T: DeserializeOwned>(&self, endpoint: &str) -> Result<T> {
self.client.delete_json(self.make_endpoint(endpoint)).await
}
pub(crate) async fn head(&self, endpoint: &str) -> Result<Response<Body>> {
self.client.head(self.make_endpoint(endpoint)).await
}
#[allow(dead_code)]
/// Send a streaming post request.
///
/// Use stream_post_into_values if the endpoint returns JSON values
pub(crate) fn post_stream<'a, B>(
&'a self,
endpoint: impl AsRef<str> + 'a,
body: Payload<B>,
headers: Option<Headers>,
) -> impl Stream<Item = Result<Bytes>> + 'a
where
B: Into<Body> + 'a,
{
self.client
.post_stream(self.make_endpoint(endpoint), body, headers)
}
/// Send a streaming post request that returns a stream of JSON values
///
/// When a received chunk does not contain a full JSON reads more chunks from the stream
pub(crate) fn post_into_stream<'a, B, T>(
&'a self,
endpoint: impl AsRef<str> + 'a,
body: Payload<B>,
headers: Option<Headers>,
) -> impl Stream<Item = Result<T>> + 'a
where
B: Into<Body> + 'a,
T: DeserializeOwned + 'a,
{
self.client
.post_into_stream(self.make_endpoint(endpoint), body, headers)
}
pub(crate) fn get_stream<'a>(
&'a self,
endpoint: impl AsRef<str> + Unpin + 'a,
) -> impl Stream<Item = Result<Bytes>> + 'a {
self.client.get_stream(self.make_endpoint(endpoint))
}
pub(crate) async fn post_upgrade_stream<B>(
self,
endpoint: impl AsRef<str>,
body: Payload<B>,
) -> Result<impl AsyncRead + AsyncWrite>
where
B: Into<Body>,
{
let ep = self.make_endpoint(endpoint);
self.client.post_upgrade_stream(ep, body).await
}
}
fn validate_response(
response: Response<Body>,
) -> Pin<Box<dyn Future<Output = Result<Response<Body>>> + Send + Sync>> {
use serde::{Deserialize, Serialize};
#[derive(Serialize, Deserialize)]
struct ErrorResponse {
message: String,
}
Box::pin(async move {
log::trace!(
"got response {} {:?}",
response.status(),
response.headers()
);
let status = response.status();
use crate::conn::{self, hyper::StatusCode};
match status {
// Success case: pass on the response
StatusCode::OK
| StatusCode::CREATED
| StatusCode::SWITCHING_PROTOCOLS
| StatusCode::NO_CONTENT => Ok(response),
// Error case: try to deserialize error message
_ => {
let body = response.into_body();
let bytes = hyper::body::to_bytes(body)
.await
.map_err(conn::Error::from)?;
let message_body = String::from_utf8(bytes.to_vec()).map_err(conn::Error::from)?;
log::trace!("{message_body:#?}");
let message = serde_json::from_str::<ErrorResponse>(&message_body)
.map(|e| e.message)
.unwrap_or_else(|_| {
status
.canonical_reason()
.unwrap_or("unknown error code")
.to_owned()
});
Err(Error::Fault {
code: status,
message,
})
}
}
})
}
#[cfg(feature = "swarm")]
impl Docker {
/// Exports an interface for interacting with Docker services.
pub fn services(&'_ self) -> Services {
Services::new(self.clone())
}
/// Exports an interface for interacting with Docker configs.
pub fn configs(&'_ self) -> Configs {
Configs::new(self.clone())
}
/// Exports an interface for interacting with Docker tasks.
pub fn tasks(&'_ self) -> Tasks {
Tasks::new(self.clone())
}
/// Exports an interface for interacting with Docker secrets.
pub fn secrets(&'_ self) -> Secrets {
Secrets::new(self.clone())
}
/// Exports an interface for interacting with Docker swarm.
pub fn swarm(&'_ self) -> Swarm {
Swarm::new(self.clone())
}
/// Exports an interface for interacting with Docker nodes.
pub fn nodes(&'_ self) -> Nodes {
Nodes::new(self.clone())
}
/// Exports an interface for interacting with Docker plugins.
pub fn plugins(&'_ self) -> Plugins {
Plugins::new(self.clone())
}
}
#[cfg(test)]
mod tests {
use super::{Docker, Error};
#[test]
fn creates_correct_docker() {
let d = Docker::new("tcp://127.0.0.1:80");
d.unwrap();
let d = Docker::new("http://127.0.0.1:80");
d.unwrap();
#[cfg(unix)]
{
let d = Docker::new("unix://127.0.0.1:80");
d.unwrap();
}
#[cfg(not(unix))]
{
let d = Docker::new("unix://127.0.0.1:80");
assert!(d.is_err());
match d.unwrap_err() {
Error::UnsupportedScheme(scheme) if &scheme == "unix" => {}
e => panic!(r#"Expected Error::UnsupportedScheme("unix"), got {}"#, e),
}
}
let d = Docker::new("rand://127.0.0.1:80");
match d.unwrap_err() {
Error::UnsupportedScheme(scheme) if &scheme == "rand" => {}
e => panic!(r#"Expected Error::UnsupportedScheme("rand"), got {e}"#),
}
let d = Docker::new("invalid_uri");
match d.unwrap_err() {
Error::UnsupportedScheme(scheme) if &scheme == "invalid_uri" => {}
e => panic!(r#"Expected Error::UnsupportedScheme("invalid_uri"), got {e}"#),
}
let d = Docker::new("");
match d.unwrap_err() {
Error::UnsupportedScheme(scheme) if scheme.is_empty() => {}
e => panic!(r#"Expected Error::UnsupportedScheme(""), got {e}"#),
}
}
}