2023-02-05 23:44:06 +01:00
|
|
|
use crate::querybuilder::Selection;
|
2023-03-19 01:01:24 +01:00
|
|
|
use dagger_core::graphql_client::DynGraphQLClient;
|
2023-02-19 17:21:40 +01:00
|
|
|
use derive_builder::Builder;
|
2023-02-17 12:33:16 +01:00
|
|
|
use serde::{Deserialize, Serialize};
|
|
|
|
use std::sync::Arc;
|
2023-02-20 11:42:03 +01:00
|
|
|
use tokio::process::Child;
|
2023-02-05 23:44:06 +01:00
|
|
|
|
2023-02-19 17:21:40 +01:00
|
|
|
#[derive(Serialize, Deserialize, PartialEq, Debug, Clone)]
|
2023-03-13 20:26:13 +01:00
|
|
|
pub struct CacheId(pub String);
|
|
|
|
|
|
|
|
impl Into<CacheId> for &str {
|
|
|
|
fn into(self) -> CacheId {
|
|
|
|
CacheId(self.to_string())
|
|
|
|
}
|
|
|
|
}
|
2023-03-13 20:33:24 +01:00
|
|
|
|
|
|
|
impl Into<CacheId> for String {
|
|
|
|
fn into(self) -> CacheId {
|
|
|
|
CacheId(self.clone())
|
|
|
|
}
|
|
|
|
}
|
2023-02-19 17:21:40 +01:00
|
|
|
#[derive(Serialize, Deserialize, PartialEq, Debug, Clone)]
|
2023-03-13 20:26:13 +01:00
|
|
|
pub struct ContainerId(pub String);
|
|
|
|
|
|
|
|
impl Into<ContainerId> for &str {
|
|
|
|
fn into(self) -> ContainerId {
|
|
|
|
ContainerId(self.to_string())
|
|
|
|
}
|
|
|
|
}
|
2023-03-13 20:33:24 +01:00
|
|
|
|
|
|
|
impl Into<ContainerId> for String {
|
|
|
|
fn into(self) -> ContainerId {
|
|
|
|
ContainerId(self.clone())
|
|
|
|
}
|
|
|
|
}
|
2023-02-19 17:21:40 +01:00
|
|
|
#[derive(Serialize, Deserialize, PartialEq, Debug, Clone)]
|
2023-03-13 20:26:13 +01:00
|
|
|
pub struct DirectoryId(pub String);
|
|
|
|
|
|
|
|
impl Into<DirectoryId> for &str {
|
|
|
|
fn into(self) -> DirectoryId {
|
|
|
|
DirectoryId(self.to_string())
|
|
|
|
}
|
|
|
|
}
|
2023-03-13 20:33:24 +01:00
|
|
|
|
|
|
|
impl Into<DirectoryId> for String {
|
|
|
|
fn into(self) -> DirectoryId {
|
|
|
|
DirectoryId(self.clone())
|
|
|
|
}
|
|
|
|
}
|
2023-02-19 17:21:40 +01:00
|
|
|
#[derive(Serialize, Deserialize, PartialEq, Debug, Clone)]
|
2023-03-13 20:26:13 +01:00
|
|
|
pub struct FileId(pub String);
|
|
|
|
|
|
|
|
impl Into<FileId> for &str {
|
|
|
|
fn into(self) -> FileId {
|
|
|
|
FileId(self.to_string())
|
|
|
|
}
|
|
|
|
}
|
2023-03-13 20:33:24 +01:00
|
|
|
|
|
|
|
impl Into<FileId> for String {
|
|
|
|
fn into(self) -> FileId {
|
|
|
|
FileId(self.clone())
|
|
|
|
}
|
|
|
|
}
|
2023-02-19 17:21:40 +01:00
|
|
|
#[derive(Serialize, Deserialize, PartialEq, Debug, Clone)]
|
2023-03-13 20:26:13 +01:00
|
|
|
pub struct Platform(pub String);
|
|
|
|
|
|
|
|
impl Into<Platform> for &str {
|
|
|
|
fn into(self) -> Platform {
|
|
|
|
Platform(self.to_string())
|
|
|
|
}
|
|
|
|
}
|
2023-03-13 20:33:24 +01:00
|
|
|
|
|
|
|
impl Into<Platform> for String {
|
|
|
|
fn into(self) -> Platform {
|
|
|
|
Platform(self.clone())
|
|
|
|
}
|
|
|
|
}
|
2023-02-19 17:21:40 +01:00
|
|
|
#[derive(Serialize, Deserialize, PartialEq, Debug, Clone)]
|
2023-03-13 20:26:13 +01:00
|
|
|
pub struct SecretId(pub String);
|
|
|
|
|
|
|
|
impl Into<SecretId> for &str {
|
|
|
|
fn into(self) -> SecretId {
|
|
|
|
SecretId(self.to_string())
|
|
|
|
}
|
|
|
|
}
|
2023-03-13 20:33:24 +01:00
|
|
|
|
|
|
|
impl Into<SecretId> for String {
|
|
|
|
fn into(self) -> SecretId {
|
|
|
|
SecretId(self.clone())
|
|
|
|
}
|
|
|
|
}
|
2023-02-19 17:21:40 +01:00
|
|
|
#[derive(Serialize, Deserialize, PartialEq, Debug, Clone)]
|
2023-03-13 20:26:13 +01:00
|
|
|
pub struct SocketId(pub String);
|
|
|
|
|
|
|
|
impl Into<SocketId> for &str {
|
|
|
|
fn into(self) -> SocketId {
|
|
|
|
SocketId(self.to_string())
|
|
|
|
}
|
|
|
|
}
|
2023-03-13 20:33:24 +01:00
|
|
|
|
|
|
|
impl Into<SocketId> for String {
|
|
|
|
fn into(self) -> SocketId {
|
|
|
|
SocketId(self.clone())
|
|
|
|
}
|
|
|
|
}
|
2023-02-19 17:21:40 +01:00
|
|
|
#[derive(Serialize, Deserialize, Debug, PartialEq, Clone)]
|
2023-01-30 20:44:48 +01:00
|
|
|
pub struct BuildArg {
|
2023-03-14 22:01:01 +01:00
|
|
|
pub name: String,
|
2023-03-14 22:09:04 +01:00
|
|
|
pub value: String,
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-03-10 23:16:35 +01:00
|
|
|
#[derive(Serialize, Deserialize, Debug, PartialEq, Clone)]
|
|
|
|
pub struct PipelineLabel {
|
2023-03-13 20:26:13 +01:00
|
|
|
pub name: String,
|
2023-03-14 21:49:30 +01:00
|
|
|
pub value: String,
|
2023-03-10 23:16:35 +01:00
|
|
|
}
|
2023-03-19 01:01:24 +01:00
|
|
|
#[derive(Clone)]
|
2023-02-17 12:33:16 +01:00
|
|
|
pub struct CacheVolume {
|
|
|
|
pub proc: Arc<Child>,
|
|
|
|
pub selection: Selection,
|
2023-03-19 01:01:24 +01:00
|
|
|
pub graphql_client: DynGraphQLClient,
|
2023-01-30 20:44:48 +01:00
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-01 16:34:59 +01:00
|
|
|
impl CacheVolume {
|
2023-03-14 22:01:49 +01:00
|
|
|
pub async fn id(&self) -> eyre::Result<CacheId> {
|
|
|
|
let query = self.selection.select("id");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-03-19 01:01:24 +01:00
|
|
|
query.execute(self.graphql_client.clone()).await
|
2023-02-01 15:32:38 +01:00
|
|
|
}
|
2023-02-01 16:34:59 +01:00
|
|
|
}
|
2023-03-19 01:01:24 +01:00
|
|
|
#[derive(Clone)]
|
2023-02-05 23:44:06 +01:00
|
|
|
pub struct Container {
|
|
|
|
pub proc: Arc<Child>,
|
|
|
|
pub selection: Selection,
|
2023-03-19 01:01:24 +01:00
|
|
|
pub graphql_client: DynGraphQLClient,
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:21:40 +01:00
|
|
|
#[derive(Builder, Debug, PartialEq)]
|
|
|
|
pub struct ContainerBuildOpts<'a> {
|
2023-03-14 22:09:04 +01:00
|
|
|
/// Additional build arguments.
|
|
|
|
#[builder(setter(into, strip_option), default)]
|
|
|
|
pub build_args: Option<Vec<BuildArg>>,
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Path to the Dockerfile to use.
|
2023-02-25 00:01:18 +01:00
|
|
|
/// Default: './Dockerfile'.
|
2023-02-25 01:03:24 +01:00
|
|
|
#[builder(setter(into, strip_option), default)]
|
2023-02-19 17:21:40 +01:00
|
|
|
pub dockerfile: Option<&'a str>,
|
2023-04-29 23:36:53 +02:00
|
|
|
/// Secrets to pass to the build.
|
|
|
|
/// They will be mounted at /run/secrets/[secret-name].
|
|
|
|
#[builder(setter(into, strip_option), default)]
|
|
|
|
pub secrets: Option<Vec<SecretId>>,
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Target build stage to build.
|
2023-02-25 01:03:24 +01:00
|
|
|
#[builder(setter(into, strip_option), default)]
|
2023-02-19 17:21:40 +01:00
|
|
|
pub target: Option<&'a str>,
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-02-19 17:21:40 +01:00
|
|
|
#[derive(Builder, Debug, PartialEq)]
|
2023-02-25 00:01:18 +01:00
|
|
|
pub struct ContainerEndpointOpts<'a> {
|
|
|
|
/// The exposed port number for the endpoint
|
2023-02-25 01:03:24 +01:00
|
|
|
#[builder(setter(into, strip_option), default)]
|
2023-02-25 00:01:18 +01:00
|
|
|
pub port: Option<isize>,
|
|
|
|
/// Return a URL with the given scheme, eg. http for http://
|
2023-02-25 01:03:24 +01:00
|
|
|
#[builder(setter(into, strip_option), default)]
|
2023-02-25 00:01:18 +01:00
|
|
|
pub scheme: Option<&'a str>,
|
|
|
|
}
|
|
|
|
#[derive(Builder, Debug, PartialEq)]
|
2023-02-19 17:21:40 +01:00
|
|
|
pub struct ContainerExecOpts<'a> {
|
2023-02-25 00:01:18 +01:00
|
|
|
/// Command to run instead of the container's default command (e.g., ["run", "main.go"]).
|
2023-02-25 01:03:24 +01:00
|
|
|
#[builder(setter(into, strip_option), default)]
|
2023-02-19 17:21:40 +01:00
|
|
|
pub args: Option<Vec<&'a str>>,
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Provide dagger access to the executed command.
|
|
|
|
/// Do not use this option unless you trust the command being executed.
|
|
|
|
/// The command being executed WILL BE GRANTED FULL ACCESS TO YOUR HOST FILESYSTEM.
|
2023-02-25 01:03:24 +01:00
|
|
|
#[builder(setter(into, strip_option), default)]
|
2023-02-17 12:33:16 +01:00
|
|
|
pub experimental_privileged_nesting: Option<bool>,
|
2023-03-14 22:09:04 +01:00
|
|
|
/// Redirect the command's standard error to a file in the container (e.g., "/tmp/stderr").
|
|
|
|
#[builder(setter(into, strip_option), default)]
|
|
|
|
pub redirect_stderr: Option<&'a str>,
|
|
|
|
/// Redirect the command's standard output to a file in the container (e.g., "/tmp/stdout").
|
|
|
|
#[builder(setter(into, strip_option), default)]
|
|
|
|
pub redirect_stdout: Option<&'a str>,
|
|
|
|
/// Content to write to the command's standard input before closing (e.g., "Hello world").
|
|
|
|
#[builder(setter(into, strip_option), default)]
|
|
|
|
pub stdin: Option<&'a str>,
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-02-19 17:21:40 +01:00
|
|
|
#[derive(Builder, Debug, PartialEq)]
|
2023-02-19 17:29:59 +01:00
|
|
|
pub struct ContainerExportOpts {
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Identifiers for other platform specific containers.
|
|
|
|
/// Used for multi-platform image.
|
2023-02-25 01:03:24 +01:00
|
|
|
#[builder(setter(into, strip_option), default)]
|
2023-02-17 12:33:16 +01:00
|
|
|
pub platform_variants: Option<Vec<ContainerId>>,
|
|
|
|
}
|
2023-02-19 17:21:40 +01:00
|
|
|
#[derive(Builder, Debug, PartialEq)]
|
2023-04-29 23:36:53 +02:00
|
|
|
pub struct ContainerImportOpts<'a> {
|
|
|
|
/// Identifies the tag to import from the archive, if the archive bundles
|
|
|
|
/// multiple tags.
|
|
|
|
#[builder(setter(into, strip_option), default)]
|
|
|
|
pub tag: Option<&'a str>,
|
|
|
|
}
|
|
|
|
#[derive(Builder, Debug, PartialEq)]
|
2023-02-19 17:21:40 +01:00
|
|
|
pub struct ContainerPipelineOpts<'a> {
|
2023-03-10 23:16:35 +01:00
|
|
|
/// Pipeline description.
|
2023-02-25 01:03:24 +01:00
|
|
|
#[builder(setter(into, strip_option), default)]
|
2023-02-19 17:21:40 +01:00
|
|
|
pub description: Option<&'a str>,
|
2023-03-10 23:16:35 +01:00
|
|
|
/// Pipeline labels.
|
|
|
|
#[builder(setter(into, strip_option), default)]
|
|
|
|
pub labels: Option<Vec<PipelineLabel>>,
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-02-19 17:21:40 +01:00
|
|
|
#[derive(Builder, Debug, PartialEq)]
|
2023-02-19 17:29:59 +01:00
|
|
|
pub struct ContainerPublishOpts {
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Identifiers for other platform specific containers.
|
|
|
|
/// Used for multi-platform image.
|
2023-02-25 01:03:24 +01:00
|
|
|
#[builder(setter(into, strip_option), default)]
|
2023-02-17 12:33:16 +01:00
|
|
|
pub platform_variants: Option<Vec<ContainerId>>,
|
|
|
|
}
|
2023-02-19 17:21:40 +01:00
|
|
|
#[derive(Builder, Debug, PartialEq)]
|
|
|
|
pub struct ContainerWithDefaultArgsOpts<'a> {
|
2023-02-25 00:01:18 +01:00
|
|
|
/// Arguments to prepend to future executions (e.g., ["-v", "--no-cache"]).
|
2023-02-25 01:03:24 +01:00
|
|
|
#[builder(setter(into, strip_option), default)]
|
2023-02-19 17:21:40 +01:00
|
|
|
pub args: Option<Vec<&'a str>>,
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-02-19 17:21:40 +01:00
|
|
|
#[derive(Builder, Debug, PartialEq)]
|
|
|
|
pub struct ContainerWithDirectoryOpts<'a> {
|
2023-02-25 00:01:18 +01:00
|
|
|
/// Patterns to exclude in the written directory (e.g., ["node_modules/**", ".gitignore", ".git/"]).
|
2023-02-25 01:03:24 +01:00
|
|
|
#[builder(setter(into, strip_option), default)]
|
2023-02-19 17:21:40 +01:00
|
|
|
pub exclude: Option<Vec<&'a str>>,
|
2023-02-25 00:01:18 +01:00
|
|
|
/// Patterns to include in the written directory (e.g., ["*.go", "go.mod", "go.sum"]).
|
2023-02-25 01:03:24 +01:00
|
|
|
#[builder(setter(into, strip_option), default)]
|
2023-02-19 17:21:40 +01:00
|
|
|
pub include: Option<Vec<&'a str>>,
|
2023-04-29 23:36:53 +02:00
|
|
|
/// A user:group to set for the directory and its contents.
|
|
|
|
/// The user and group can either be an ID (1000:1000) or a name (foo:bar).
|
|
|
|
/// If the group is omitted, it defaults to the same as the user.
|
|
|
|
#[builder(setter(into, strip_option), default)]
|
|
|
|
pub owner: Option<&'a str>,
|
2023-02-19 12:19:43 +01:00
|
|
|
}
|
2023-02-19 17:21:40 +01:00
|
|
|
#[derive(Builder, Debug, PartialEq)]
|
|
|
|
pub struct ContainerWithExecOpts<'a> {
|
2023-02-25 00:01:18 +01:00
|
|
|
/// Provides dagger access to the executed command.
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Do not use this option unless you trust the command being executed.
|
|
|
|
/// The command being executed WILL BE GRANTED FULL ACCESS TO YOUR HOST FILESYSTEM.
|
2023-02-25 01:03:24 +01:00
|
|
|
#[builder(setter(into, strip_option), default)]
|
2023-02-17 12:33:16 +01:00
|
|
|
pub experimental_privileged_nesting: Option<bool>,
|
2023-03-10 23:16:35 +01:00
|
|
|
/// Execute the command with all root capabilities. This is similar to running a command
|
|
|
|
/// with "sudo" or executing `docker run` with the `--privileged` flag. Containerization
|
|
|
|
/// does not provide any security guarantees when using this option. It should only be used
|
|
|
|
/// when absolutely necessary and only with trusted commands.
|
|
|
|
#[builder(setter(into, strip_option), default)]
|
|
|
|
pub insecure_root_capabilities: Option<bool>,
|
2023-03-14 22:09:04 +01:00
|
|
|
/// Redirect the command's standard error to a file in the container (e.g., "/tmp/stderr").
|
|
|
|
#[builder(setter(into, strip_option), default)]
|
|
|
|
pub redirect_stderr: Option<&'a str>,
|
|
|
|
/// Redirect the command's standard output to a file in the container (e.g., "/tmp/stdout").
|
|
|
|
#[builder(setter(into, strip_option), default)]
|
|
|
|
pub redirect_stdout: Option<&'a str>,
|
2023-04-29 23:36:53 +02:00
|
|
|
/// If the container has an entrypoint, ignore it for args rather than using it to wrap them.
|
|
|
|
#[builder(setter(into, strip_option), default)]
|
|
|
|
pub skip_entrypoint: Option<bool>,
|
2023-03-14 22:09:04 +01:00
|
|
|
/// Content to write to the command's standard input before closing (e.g., "Hello world").
|
|
|
|
#[builder(setter(into, strip_option), default)]
|
|
|
|
pub stdin: Option<&'a str>,
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-02-19 17:21:40 +01:00
|
|
|
#[derive(Builder, Debug, PartialEq)]
|
2023-02-25 00:01:18 +01:00
|
|
|
pub struct ContainerWithExposedPortOpts<'a> {
|
|
|
|
/// Optional port description
|
2023-02-25 01:03:24 +01:00
|
|
|
#[builder(setter(into, strip_option), default)]
|
2023-02-25 00:01:18 +01:00
|
|
|
pub description: Option<&'a str>,
|
2023-03-14 22:09:04 +01:00
|
|
|
/// Transport layer network protocol
|
|
|
|
#[builder(setter(into, strip_option), default)]
|
|
|
|
pub protocol: Option<NetworkProtocol>,
|
2023-02-25 00:01:18 +01:00
|
|
|
}
|
|
|
|
#[derive(Builder, Debug, PartialEq)]
|
2023-04-29 23:36:53 +02:00
|
|
|
pub struct ContainerWithFileOpts<'a> {
|
|
|
|
/// A user:group to set for the file.
|
|
|
|
/// The user and group can either be an ID (1000:1000) or a name (foo:bar).
|
|
|
|
/// If the group is omitted, it defaults to the same as the user.
|
|
|
|
#[builder(setter(into, strip_option), default)]
|
|
|
|
pub owner: Option<&'a str>,
|
2023-02-25 00:01:18 +01:00
|
|
|
/// Permission given to the copied file (e.g., 0600).
|
|
|
|
/// Default: 0644.
|
2023-02-25 01:03:24 +01:00
|
|
|
#[builder(setter(into, strip_option), default)]
|
2023-02-17 12:33:16 +01:00
|
|
|
pub permissions: Option<isize>,
|
|
|
|
}
|
2023-02-19 17:21:40 +01:00
|
|
|
#[derive(Builder, Debug, PartialEq)]
|
2023-04-29 23:36:53 +02:00
|
|
|
pub struct ContainerWithMountedCacheOpts<'a> {
|
|
|
|
/// A user:group to set for the mounted cache directory.
|
|
|
|
/// Note that this changes the ownership of the specified mount along with the
|
|
|
|
/// initial filesystem provided by source (if any). It does not have any effect
|
|
|
|
/// if/when the cache has already been created.
|
|
|
|
/// The user and group can either be an ID (1000:1000) or a name (foo:bar).
|
|
|
|
/// If the group is omitted, it defaults to the same as the user.
|
|
|
|
#[builder(setter(into, strip_option), default)]
|
|
|
|
pub owner: Option<&'a str>,
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Sharing mode of the cache volume.
|
2023-02-25 01:03:24 +01:00
|
|
|
#[builder(setter(into, strip_option), default)]
|
2023-02-19 12:16:48 +01:00
|
|
|
pub sharing: Option<CacheSharingMode>,
|
2023-03-14 22:09:04 +01:00
|
|
|
/// Identifier of the directory to use as the cache volume's root.
|
|
|
|
#[builder(setter(into, strip_option), default)]
|
|
|
|
pub source: Option<DirectoryId>,
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-02-19 17:21:40 +01:00
|
|
|
#[derive(Builder, Debug, PartialEq)]
|
2023-04-29 23:36:53 +02:00
|
|
|
pub struct ContainerWithMountedDirectoryOpts<'a> {
|
|
|
|
/// A user:group to set for the mounted directory and its contents.
|
|
|
|
/// The user and group can either be an ID (1000:1000) or a name (foo:bar).
|
|
|
|
/// If the group is omitted, it defaults to the same as the user.
|
|
|
|
#[builder(setter(into, strip_option), default)]
|
|
|
|
pub owner: Option<&'a str>,
|
|
|
|
}
|
|
|
|
#[derive(Builder, Debug, PartialEq)]
|
|
|
|
pub struct ContainerWithMountedFileOpts<'a> {
|
|
|
|
/// A user or user:group to set for the mounted file.
|
|
|
|
/// The user and group can either be an ID (1000:1000) or a name (foo:bar).
|
|
|
|
/// If the group is omitted, it defaults to the same as the user.
|
|
|
|
#[builder(setter(into, strip_option), default)]
|
|
|
|
pub owner: Option<&'a str>,
|
|
|
|
}
|
|
|
|
#[derive(Builder, Debug, PartialEq)]
|
|
|
|
pub struct ContainerWithMountedSecretOpts<'a> {
|
|
|
|
/// A user:group to set for the mounted secret.
|
|
|
|
/// The user and group can either be an ID (1000:1000) or a name (foo:bar).
|
|
|
|
/// If the group is omitted, it defaults to the same as the user.
|
|
|
|
#[builder(setter(into, strip_option), default)]
|
|
|
|
pub owner: Option<&'a str>,
|
|
|
|
}
|
|
|
|
#[derive(Builder, Debug, PartialEq)]
|
2023-02-19 17:21:40 +01:00
|
|
|
pub struct ContainerWithNewFileOpts<'a> {
|
2023-02-25 00:01:18 +01:00
|
|
|
/// Content of the file to write (e.g., "Hello world!").
|
2023-02-25 01:03:24 +01:00
|
|
|
#[builder(setter(into, strip_option), default)]
|
2023-02-19 17:21:40 +01:00
|
|
|
pub contents: Option<&'a str>,
|
2023-04-29 23:36:53 +02:00
|
|
|
/// A user:group to set for the file.
|
|
|
|
/// The user and group can either be an ID (1000:1000) or a name (foo:bar).
|
|
|
|
/// If the group is omitted, it defaults to the same as the user.
|
|
|
|
#[builder(setter(into, strip_option), default)]
|
|
|
|
pub owner: Option<&'a str>,
|
2023-02-25 00:01:18 +01:00
|
|
|
/// Permission given to the written file (e.g., 0600).
|
|
|
|
/// Default: 0644.
|
2023-02-25 01:03:24 +01:00
|
|
|
#[builder(setter(into, strip_option), default)]
|
2023-02-17 12:33:16 +01:00
|
|
|
pub permissions: Option<isize>,
|
2023-02-05 23:44:06 +01:00
|
|
|
}
|
2023-02-25 00:01:18 +01:00
|
|
|
#[derive(Builder, Debug, PartialEq)]
|
2023-04-29 23:36:53 +02:00
|
|
|
pub struct ContainerWithUnixSocketOpts<'a> {
|
|
|
|
/// A user:group to set for the mounted socket.
|
|
|
|
/// The user and group can either be an ID (1000:1000) or a name (foo:bar).
|
|
|
|
/// If the group is omitted, it defaults to the same as the user.
|
|
|
|
#[builder(setter(into, strip_option), default)]
|
|
|
|
pub owner: Option<&'a str>,
|
|
|
|
}
|
|
|
|
#[derive(Builder, Debug, PartialEq)]
|
2023-02-25 00:01:18 +01:00
|
|
|
pub struct ContainerWithoutExposedPortOpts {
|
|
|
|
/// Port protocol to unexpose
|
2023-02-25 01:03:24 +01:00
|
|
|
#[builder(setter(into, strip_option), default)]
|
2023-02-25 00:01:18 +01:00
|
|
|
pub protocol: Option<NetworkProtocol>,
|
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-01 16:34:59 +01:00
|
|
|
impl Container {
|
2023-02-25 00:01:18 +01:00
|
|
|
/// Initializes this container from a Dockerfile build.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// * `context` - Directory context used by the Dockerfile.
|
2023-02-19 22:38:36 +01:00
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn build(&self, context: DirectoryId) -> Container {
|
2023-02-19 17:43:12 +01:00
|
|
|
let mut query = self.selection.select("build");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:43:12 +01:00
|
|
|
query = query.arg("context", context);
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:43:12 +01:00
|
|
|
return Container {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-19 17:43:12 +01:00
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-25 00:01:18 +01:00
|
|
|
/// Initializes this container from a Dockerfile build.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// * `context` - Directory context used by the Dockerfile.
|
2023-02-19 22:38:36 +01:00
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn build_opts<'a>(&self, context: DirectoryId, opts: ContainerBuildOpts<'a>) -> Container {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("build");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 15:00:00 +01:00
|
|
|
query = query.arg("context", context);
|
2023-02-19 17:49:22 +01:00
|
|
|
if let Some(dockerfile) = opts.dockerfile {
|
|
|
|
query = query.arg("dockerfile", dockerfile);
|
|
|
|
}
|
|
|
|
if let Some(build_args) = opts.build_args {
|
|
|
|
query = query.arg("buildArgs", build_args);
|
|
|
|
}
|
|
|
|
if let Some(target) = opts.target {
|
|
|
|
query = query.arg("target", target);
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-04-29 23:36:53 +02:00
|
|
|
if let Some(secrets) = opts.secrets {
|
|
|
|
query = query.arg("secrets", secrets);
|
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return Container {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-01 15:32:38 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Retrieves default arguments for future commands.
|
2023-03-14 22:01:49 +01:00
|
|
|
pub async fn default_args(&self) -> eyre::Result<Vec<String>> {
|
|
|
|
let query = self.selection.select("defaultArgs");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-03-19 01:01:24 +01:00
|
|
|
query.execute(self.graphql_client.clone()).await
|
2023-02-01 15:32:38 +01:00
|
|
|
}
|
2023-02-25 00:01:18 +01:00
|
|
|
/// Retrieves a directory at the given path.
|
|
|
|
/// Mounts are included.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// * `path` - The path of the directory to retrieve (e.g., "./src").
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn directory(&self, path: impl Into<String>) -> Directory {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("directory");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:21:40 +01:00
|
|
|
query = query.arg("path", path.into());
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return Directory {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-01-30 20:53:53 +01:00
|
|
|
}
|
2023-02-25 00:01:18 +01:00
|
|
|
/// Retrieves an endpoint that clients can use to reach this container.
|
|
|
|
/// If no port is specified, the first exposed port is used. If none exist an error is returned.
|
|
|
|
/// If a scheme is specified, a URL is returned. Otherwise, a host:port pair is returned.
|
2023-03-10 23:16:35 +01:00
|
|
|
/// Currently experimental; set _EXPERIMENTAL_DAGGER_SERVICES_DNS=0 to disable.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
2023-03-14 22:01:49 +01:00
|
|
|
pub async fn endpoint(&self) -> eyre::Result<String> {
|
|
|
|
let query = self.selection.select("endpoint");
|
2023-02-25 00:01:18 +01:00
|
|
|
|
2023-03-19 01:01:24 +01:00
|
|
|
query.execute(self.graphql_client.clone()).await
|
2023-02-25 00:01:18 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
/// Retrieves an endpoint that clients can use to reach this container.
|
|
|
|
/// If no port is specified, the first exposed port is used. If none exist an error is returned.
|
|
|
|
/// If a scheme is specified, a URL is returned. Otherwise, a host:port pair is returned.
|
2023-03-10 23:16:35 +01:00
|
|
|
/// Currently experimental; set _EXPERIMENTAL_DAGGER_SERVICES_DNS=0 to disable.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
2023-03-14 22:01:49 +01:00
|
|
|
pub async fn endpoint_opts<'a>(&self, opts: ContainerEndpointOpts<'a>) -> eyre::Result<String> {
|
2023-02-25 00:01:18 +01:00
|
|
|
let mut query = self.selection.select("endpoint");
|
|
|
|
|
|
|
|
if let Some(port) = opts.port {
|
|
|
|
query = query.arg("port", port);
|
|
|
|
}
|
|
|
|
if let Some(scheme) = opts.scheme {
|
|
|
|
query = query.arg("scheme", scheme);
|
|
|
|
}
|
|
|
|
|
2023-03-19 01:01:24 +01:00
|
|
|
query.execute(self.graphql_client.clone()).await
|
2023-02-25 00:01:18 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Retrieves entrypoint to be prepended to the arguments of all commands.
|
2023-03-14 22:01:49 +01:00
|
|
|
pub async fn entrypoint(&self) -> eyre::Result<Vec<String>> {
|
|
|
|
let query = self.selection.select("entrypoint");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-03-19 01:01:24 +01:00
|
|
|
query.execute(self.graphql_client.clone()).await
|
2023-01-30 20:53:53 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Retrieves the value of the specified environment variable.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// * `name` - The name of the environment variable to retrieve (e.g., "PATH").
|
2023-03-14 22:01:49 +01:00
|
|
|
pub async fn env_variable(&self, name: impl Into<String>) -> eyre::Result<String> {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("envVariable");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:21:40 +01:00
|
|
|
query = query.arg("name", name.into());
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-03-19 01:01:24 +01:00
|
|
|
query.execute(self.graphql_client.clone()).await
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Retrieves the list of environment variables passed to commands.
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn env_variables(&self) -> Vec<EnvVariable> {
|
|
|
|
let query = self.selection.select("envVariables");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return vec![EnvVariable {
|
2023-02-05 23:44:06 +01:00
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
}];
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Retrieves this container after executing the specified command inside it.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn exec(&self) -> Container {
|
|
|
|
let query = self.selection.select("exec");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:43:12 +01:00
|
|
|
return Container {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-19 17:43:12 +01:00
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Retrieves this container after executing the specified command inside it.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn exec_opts<'a>(&self, opts: ContainerExecOpts<'a>) -> Container {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("exec");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:49:22 +01:00
|
|
|
if let Some(args) = opts.args {
|
|
|
|
query = query.arg("args", args);
|
|
|
|
}
|
|
|
|
if let Some(stdin) = opts.stdin {
|
|
|
|
query = query.arg("stdin", stdin);
|
|
|
|
}
|
|
|
|
if let Some(redirect_stdout) = opts.redirect_stdout {
|
|
|
|
query = query.arg("redirectStdout", redirect_stdout);
|
|
|
|
}
|
|
|
|
if let Some(redirect_stderr) = opts.redirect_stderr {
|
|
|
|
query = query.arg("redirectStderr", redirect_stderr);
|
|
|
|
}
|
|
|
|
if let Some(experimental_privileged_nesting) = opts.experimental_privileged_nesting {
|
2023-03-14 22:01:49 +01:00
|
|
|
query = query.arg(
|
|
|
|
"experimentalPrivilegedNesting",
|
|
|
|
experimental_privileged_nesting,
|
|
|
|
);
|
2023-02-05 23:44:06 +01:00
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return Container {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-01-30 20:44:48 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Exit code of the last executed command. Zero means success.
|
2023-04-29 23:36:53 +02:00
|
|
|
/// Will execute default command if none is set, or error if there's no default.
|
2023-03-14 22:01:49 +01:00
|
|
|
pub async fn exit_code(&self) -> eyre::Result<isize> {
|
|
|
|
let query = self.selection.select("exitCode");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-03-19 01:01:24 +01:00
|
|
|
query.execute(self.graphql_client.clone()).await
|
2023-02-01 15:27:44 +01:00
|
|
|
}
|
2023-02-25 00:01:18 +01:00
|
|
|
/// Writes the container as an OCI tarball to the destination file path on the host for the specified platform variants.
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Return true on success.
|
2023-02-25 00:01:18 +01:00
|
|
|
/// It can also publishes platform variants.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// * `path` - Host's destination path (e.g., "./tarball").
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Path can be relative to the engine's workdir or absolute.
|
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
2023-03-14 22:01:49 +01:00
|
|
|
pub async fn export(&self, path: impl Into<String>) -> eyre::Result<bool> {
|
2023-02-19 17:43:12 +01:00
|
|
|
let mut query = self.selection.select("export");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:43:12 +01:00
|
|
|
query = query.arg("path", path.into());
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-03-19 01:01:24 +01:00
|
|
|
query.execute(self.graphql_client.clone()).await
|
2023-02-19 17:43:12 +01:00
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-25 00:01:18 +01:00
|
|
|
/// Writes the container as an OCI tarball to the destination file path on the host for the specified platform variants.
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Return true on success.
|
2023-02-25 00:01:18 +01:00
|
|
|
/// It can also publishes platform variants.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// * `path` - Host's destination path (e.g., "./tarball").
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Path can be relative to the engine's workdir or absolute.
|
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
2023-02-19 21:37:54 +01:00
|
|
|
pub async fn export_opts(
|
2023-02-19 17:21:40 +01:00
|
|
|
&self,
|
|
|
|
path: impl Into<String>,
|
2023-03-14 22:01:49 +01:00
|
|
|
opts: ContainerExportOpts,
|
2023-02-19 17:21:40 +01:00
|
|
|
) -> eyre::Result<bool> {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("export");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:21:40 +01:00
|
|
|
query = query.arg("path", path.into());
|
2023-02-19 17:49:22 +01:00
|
|
|
if let Some(platform_variants) = opts.platform_variants {
|
|
|
|
query = query.arg("platformVariants", platform_variants);
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-03-19 01:01:24 +01:00
|
|
|
query.execute(self.graphql_client.clone()).await
|
2023-02-01 15:27:44 +01:00
|
|
|
}
|
2023-03-10 23:16:35 +01:00
|
|
|
/// Retrieves the list of exposed ports.
|
|
|
|
/// Currently experimental; set _EXPERIMENTAL_DAGGER_SERVICES_DNS=0 to disable.
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn exposed_ports(&self) -> Vec<Port> {
|
|
|
|
let query = self.selection.select("exposedPorts");
|
2023-02-25 00:01:18 +01:00
|
|
|
|
|
|
|
return vec![Port {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
}];
|
2023-02-25 00:01:18 +01:00
|
|
|
}
|
|
|
|
/// Retrieves a file at the given path.
|
|
|
|
/// Mounts are included.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// * `path` - The path of the file to retrieve (e.g., "./README.md").
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn file(&self, path: impl Into<String>) -> File {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("file");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:21:40 +01:00
|
|
|
query = query.arg("path", path.into());
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return File {
|
2023-02-05 23:44:06 +01:00
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-01 15:27:44 +01:00
|
|
|
}
|
2023-02-25 00:01:18 +01:00
|
|
|
/// Initializes this container from a pulled base image.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// * `address` - Image's address from its registry.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// Formatted as [host]/[user]/[repo]:[tag] (e.g., "docker.io/dagger/dagger:main").
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn from(&self, address: impl Into<String>) -> Container {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("from");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:21:40 +01:00
|
|
|
query = query.arg("address", address.into());
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return Container {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-01-30 20:44:48 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Retrieves this container's root filesystem. Mounts are not included.
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn fs(&self) -> Directory {
|
|
|
|
let query = self.selection.select("fs");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return Directory {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-01 15:32:38 +01:00
|
|
|
}
|
2023-02-25 00:01:18 +01:00
|
|
|
/// Retrieves a hostname which can be used by clients to reach this container.
|
2023-03-10 23:16:35 +01:00
|
|
|
/// Currently experimental; set _EXPERIMENTAL_DAGGER_SERVICES_DNS=0 to disable.
|
2023-03-14 22:01:49 +01:00
|
|
|
pub async fn hostname(&self) -> eyre::Result<String> {
|
|
|
|
let query = self.selection.select("hostname");
|
2023-02-25 00:01:18 +01:00
|
|
|
|
2023-03-19 01:01:24 +01:00
|
|
|
query.execute(self.graphql_client.clone()).await
|
2023-02-25 00:01:18 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// A unique identifier for this container.
|
2023-03-14 22:01:49 +01:00
|
|
|
pub async fn id(&self) -> eyre::Result<ContainerId> {
|
|
|
|
let query = self.selection.select("id");
|
2023-02-25 00:01:18 +01:00
|
|
|
|
2023-03-19 01:01:24 +01:00
|
|
|
query.execute(self.graphql_client.clone()).await
|
2023-02-25 00:01:18 +01:00
|
|
|
}
|
|
|
|
/// The unique image reference which can only be retrieved immediately after the 'Container.From' call.
|
2023-03-14 22:01:49 +01:00
|
|
|
pub async fn image_ref(&self) -> eyre::Result<String> {
|
|
|
|
let query = self.selection.select("imageRef");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-03-19 01:01:24 +01:00
|
|
|
query.execute(self.graphql_client.clone()).await
|
2023-01-30 20:53:53 +01:00
|
|
|
}
|
2023-04-29 23:36:53 +02:00
|
|
|
/// Reads the container from an OCI tarball.
|
|
|
|
/// NOTE: this involves unpacking the tarball to an OCI store on the host at
|
|
|
|
/// $XDG_CACHE_DIR/dagger/oci. This directory can be removed whenever you like.
|
|
|
|
///
|
|
|
|
/// # Arguments
|
|
|
|
///
|
|
|
|
/// * `source` - File to read the container from.
|
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
|
|
|
pub fn import(&self, source: FileId) -> Container {
|
|
|
|
let mut query = self.selection.select("import");
|
|
|
|
|
|
|
|
query = query.arg("source", source);
|
|
|
|
|
|
|
|
return Container {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
|
|
|
graphql_client: self.graphql_client.clone(),
|
|
|
|
};
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Reads the container from an OCI tarball.
|
|
|
|
/// NOTE: this involves unpacking the tarball to an OCI store on the host at
|
|
|
|
/// $XDG_CACHE_DIR/dagger/oci. This directory can be removed whenever you like.
|
|
|
|
///
|
|
|
|
/// # Arguments
|
|
|
|
///
|
|
|
|
/// * `source` - File to read the container from.
|
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
|
|
|
pub fn import_opts<'a>(&self, source: FileId, opts: ContainerImportOpts<'a>) -> Container {
|
|
|
|
let mut query = self.selection.select("import");
|
|
|
|
|
|
|
|
query = query.arg("source", source);
|
|
|
|
if let Some(tag) = opts.tag {
|
|
|
|
query = query.arg("tag", tag);
|
|
|
|
}
|
|
|
|
|
|
|
|
return Container {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
|
|
|
graphql_client: self.graphql_client.clone(),
|
|
|
|
};
|
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Retrieves the value of the specified label.
|
2023-03-14 22:01:49 +01:00
|
|
|
pub async fn label(&self, name: impl Into<String>) -> eyre::Result<String> {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("label");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:21:40 +01:00
|
|
|
query = query.arg("name", name.into());
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-03-19 01:01:24 +01:00
|
|
|
query.execute(self.graphql_client.clone()).await
|
2023-01-30 20:53:53 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Retrieves the list of labels passed to container.
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn labels(&self) -> Vec<Label> {
|
|
|
|
let query = self.selection.select("labels");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return vec![Label {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
}];
|
2023-01-30 20:53:53 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Retrieves the list of paths where a directory is mounted.
|
2023-03-14 22:01:49 +01:00
|
|
|
pub async fn mounts(&self) -> eyre::Result<Vec<String>> {
|
|
|
|
let query = self.selection.select("mounts");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-03-19 01:01:24 +01:00
|
|
|
query.execute(self.graphql_client.clone()).await
|
2023-02-01 15:27:44 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Creates a named sub-pipeline
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-03-10 23:16:35 +01:00
|
|
|
/// * `name` - Pipeline name.
|
2023-02-22 23:09:20 +01:00
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn pipeline(&self, name: impl Into<String>) -> Container {
|
2023-02-19 17:43:12 +01:00
|
|
|
let mut query = self.selection.select("pipeline");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:43:12 +01:00
|
|
|
query = query.arg("name", name.into());
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:43:12 +01:00
|
|
|
return Container {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-19 17:43:12 +01:00
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Creates a named sub-pipeline
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-03-10 23:16:35 +01:00
|
|
|
/// * `name` - Pipeline name.
|
2023-02-22 23:09:20 +01:00
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
2023-02-19 21:37:54 +01:00
|
|
|
pub fn pipeline_opts<'a>(
|
|
|
|
&self,
|
|
|
|
name: impl Into<String>,
|
2023-03-14 22:01:49 +01:00
|
|
|
opts: ContainerPipelineOpts<'a>,
|
2023-02-19 21:37:54 +01:00
|
|
|
) -> Container {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("pipeline");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:21:40 +01:00
|
|
|
query = query.arg("name", name.into());
|
2023-02-19 17:49:22 +01:00
|
|
|
if let Some(description) = opts.description {
|
|
|
|
query = query.arg("description", description);
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-03-10 23:16:35 +01:00
|
|
|
if let Some(labels) = opts.labels {
|
|
|
|
query = query.arg("labels", labels);
|
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return Container {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-01 15:27:44 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// The platform this container executes and publishes as.
|
2023-03-14 22:01:49 +01:00
|
|
|
pub async fn platform(&self) -> eyre::Result<Platform> {
|
|
|
|
let query = self.selection.select("platform");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-03-19 01:01:24 +01:00
|
|
|
query.execute(self.graphql_client.clone()).await
|
2023-01-30 20:53:53 +01:00
|
|
|
}
|
2023-02-25 00:01:18 +01:00
|
|
|
/// Publishes this container as a new image to the specified address.
|
|
|
|
/// Publish returns a fully qualified ref.
|
|
|
|
/// It can also publish platform variants.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// * `address` - Registry's address to publish the image to.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// Formatted as [host]/[user]/[repo]:[tag] (e.g. "docker.io/dagger/dagger:main").
|
2023-02-19 22:38:36 +01:00
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
2023-03-14 22:01:49 +01:00
|
|
|
pub async fn publish(&self, address: impl Into<String>) -> eyre::Result<String> {
|
2023-02-19 17:43:12 +01:00
|
|
|
let mut query = self.selection.select("publish");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:43:12 +01:00
|
|
|
query = query.arg("address", address.into());
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-03-19 01:01:24 +01:00
|
|
|
query.execute(self.graphql_client.clone()).await
|
2023-02-19 17:43:12 +01:00
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-25 00:01:18 +01:00
|
|
|
/// Publishes this container as a new image to the specified address.
|
|
|
|
/// Publish returns a fully qualified ref.
|
|
|
|
/// It can also publish platform variants.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// * `address` - Registry's address to publish the image to.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// Formatted as [host]/[user]/[repo]:[tag] (e.g. "docker.io/dagger/dagger:main").
|
2023-02-19 22:38:36 +01:00
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
2023-02-19 21:37:54 +01:00
|
|
|
pub async fn publish_opts(
|
2023-02-19 15:18:25 +01:00
|
|
|
&self,
|
2023-02-19 17:21:40 +01:00
|
|
|
address: impl Into<String>,
|
2023-03-14 22:01:49 +01:00
|
|
|
opts: ContainerPublishOpts,
|
2023-02-19 15:18:25 +01:00
|
|
|
) -> eyre::Result<String> {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("publish");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:21:40 +01:00
|
|
|
query = query.arg("address", address.into());
|
2023-02-19 17:49:22 +01:00
|
|
|
if let Some(platform_variants) = opts.platform_variants {
|
|
|
|
query = query.arg("platformVariants", platform_variants);
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-03-19 01:01:24 +01:00
|
|
|
query.execute(self.graphql_client.clone()).await
|
2023-01-30 20:44:48 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Retrieves this container's root filesystem. Mounts are not included.
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn rootfs(&self) -> Directory {
|
|
|
|
let query = self.selection.select("rootfs");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return Directory {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// The error stream of the last executed command.
|
2023-04-29 23:36:53 +02:00
|
|
|
/// Will execute default command if none is set, or error if there's no default.
|
2023-03-14 22:01:49 +01:00
|
|
|
pub async fn stderr(&self) -> eyre::Result<String> {
|
|
|
|
let query = self.selection.select("stderr");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-03-19 01:01:24 +01:00
|
|
|
query.execute(self.graphql_client.clone()).await
|
2023-02-01 15:06:28 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// The output stream of the last executed command.
|
2023-04-29 23:36:53 +02:00
|
|
|
/// Will execute default command if none is set, or error if there's no default.
|
2023-03-14 22:01:49 +01:00
|
|
|
pub async fn stdout(&self) -> eyre::Result<String> {
|
|
|
|
let query = self.selection.select("stdout");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-03-19 01:01:24 +01:00
|
|
|
query.execute(self.graphql_client.clone()).await
|
2023-02-01 15:06:28 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Retrieves the user to be set for all commands.
|
2023-03-14 22:01:49 +01:00
|
|
|
pub async fn user(&self) -> eyre::Result<String> {
|
|
|
|
let query = self.selection.select("user");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-03-19 01:01:24 +01:00
|
|
|
query.execute(self.graphql_client.clone()).await
|
2023-02-01 15:27:44 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Configures default arguments for future commands.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn with_default_args(&self) -> Container {
|
|
|
|
let query = self.selection.select("withDefaultArgs");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:43:12 +01:00
|
|
|
return Container {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-19 17:43:12 +01:00
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Configures default arguments for future commands.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn with_default_args_opts<'a>(&self, opts: ContainerWithDefaultArgsOpts<'a>) -> Container {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("withDefaultArgs");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:49:22 +01:00
|
|
|
if let Some(args) = opts.args {
|
|
|
|
query = query.arg("args", args);
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return Container {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Retrieves this container plus a directory written at the given path.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// * `path` - Location of the written directory (e.g., "/tmp/directory").
|
|
|
|
/// * `directory` - Identifier of the directory to write
|
2023-02-22 23:09:20 +01:00
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn with_directory(&self, path: impl Into<String>, directory: DirectoryId) -> Container {
|
2023-02-19 17:43:12 +01:00
|
|
|
let mut query = self.selection.select("withDirectory");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:43:12 +01:00
|
|
|
query = query.arg("path", path.into());
|
|
|
|
query = query.arg("directory", directory);
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:43:12 +01:00
|
|
|
return Container {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-19 17:43:12 +01:00
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Retrieves this container plus a directory written at the given path.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// * `path` - Location of the written directory (e.g., "/tmp/directory").
|
|
|
|
/// * `directory` - Identifier of the directory to write
|
2023-02-22 23:09:20 +01:00
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
2023-02-19 21:37:54 +01:00
|
|
|
pub fn with_directory_opts<'a>(
|
2023-02-01 16:34:59 +01:00
|
|
|
&self,
|
2023-02-19 17:21:40 +01:00
|
|
|
path: impl Into<String>,
|
2023-02-17 12:33:16 +01:00
|
|
|
directory: DirectoryId,
|
2023-03-14 22:01:49 +01:00
|
|
|
opts: ContainerWithDirectoryOpts<'a>,
|
2023-02-01 16:34:59 +01:00
|
|
|
) -> Container {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("withDirectory");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:21:40 +01:00
|
|
|
query = query.arg("path", path.into());
|
2023-02-19 15:00:00 +01:00
|
|
|
query = query.arg("directory", directory);
|
2023-02-19 17:49:22 +01:00
|
|
|
if let Some(exclude) = opts.exclude {
|
|
|
|
query = query.arg("exclude", exclude);
|
|
|
|
}
|
|
|
|
if let Some(include) = opts.include {
|
|
|
|
query = query.arg("include", include);
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-04-29 23:36:53 +02:00
|
|
|
if let Some(owner) = opts.owner {
|
|
|
|
query = query.arg("owner", owner);
|
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return Container {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-01-30 20:53:53 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Retrieves this container but with a different command entrypoint.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// * `args` - Entrypoint to use for future executions (e.g., ["go", "run"]).
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn with_entrypoint(&self, args: Vec<impl Into<String>>) -> Container {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("withEntrypoint");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-03-14 22:01:49 +01:00
|
|
|
query = query.arg(
|
|
|
|
"args",
|
|
|
|
args.into_iter().map(|i| i.into()).collect::<Vec<String>>(),
|
|
|
|
);
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return Container {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-01-30 20:53:53 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Retrieves this container plus the given environment variable.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// * `name` - The name of the environment variable (e.g., "HOST").
|
|
|
|
/// * `value` - The value of the environment variable. (e.g., "localhost").
|
2023-02-19 17:21:40 +01:00
|
|
|
pub fn with_env_variable(
|
|
|
|
&self,
|
|
|
|
name: impl Into<String>,
|
|
|
|
value: impl Into<String>,
|
|
|
|
) -> Container {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("withEnvVariable");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:21:40 +01:00
|
|
|
query = query.arg("name", name.into());
|
|
|
|
query = query.arg("value", value.into());
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return Container {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-01 15:06:28 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Retrieves this container after executing the specified command inside it.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// * `args` - Command to run instead of the container's default command (e.g., ["run", "main.go"]).
|
2023-04-29 23:36:53 +02:00
|
|
|
///
|
|
|
|
/// If empty, the container's default command is used.
|
2023-02-19 22:38:36 +01:00
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn with_exec(&self, args: Vec<impl Into<String>>) -> Container {
|
2023-02-19 17:43:12 +01:00
|
|
|
let mut query = self.selection.select("withExec");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-03-14 22:01:49 +01:00
|
|
|
query = query.arg(
|
|
|
|
"args",
|
|
|
|
args.into_iter().map(|i| i.into()).collect::<Vec<String>>(),
|
|
|
|
);
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:43:12 +01:00
|
|
|
return Container {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-19 17:43:12 +01:00
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Retrieves this container after executing the specified command inside it.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// * `args` - Command to run instead of the container's default command (e.g., ["run", "main.go"]).
|
2023-04-29 23:36:53 +02:00
|
|
|
///
|
|
|
|
/// If empty, the container's default command is used.
|
2023-02-19 22:38:36 +01:00
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
2023-02-19 21:37:54 +01:00
|
|
|
pub fn with_exec_opts<'a>(
|
2023-02-19 17:21:40 +01:00
|
|
|
&self,
|
|
|
|
args: Vec<impl Into<String>>,
|
2023-03-14 22:01:49 +01:00
|
|
|
opts: ContainerWithExecOpts<'a>,
|
2023-02-19 17:21:40 +01:00
|
|
|
) -> Container {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("withExec");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-03-14 22:01:49 +01:00
|
|
|
query = query.arg(
|
|
|
|
"args",
|
|
|
|
args.into_iter().map(|i| i.into()).collect::<Vec<String>>(),
|
|
|
|
);
|
2023-04-29 23:36:53 +02:00
|
|
|
if let Some(skip_entrypoint) = opts.skip_entrypoint {
|
|
|
|
query = query.arg("skipEntrypoint", skip_entrypoint);
|
|
|
|
}
|
2023-02-19 17:49:22 +01:00
|
|
|
if let Some(stdin) = opts.stdin {
|
|
|
|
query = query.arg("stdin", stdin);
|
|
|
|
}
|
|
|
|
if let Some(redirect_stdout) = opts.redirect_stdout {
|
|
|
|
query = query.arg("redirectStdout", redirect_stdout);
|
|
|
|
}
|
|
|
|
if let Some(redirect_stderr) = opts.redirect_stderr {
|
|
|
|
query = query.arg("redirectStderr", redirect_stderr);
|
|
|
|
}
|
|
|
|
if let Some(experimental_privileged_nesting) = opts.experimental_privileged_nesting {
|
2023-03-14 22:01:49 +01:00
|
|
|
query = query.arg(
|
|
|
|
"experimentalPrivilegedNesting",
|
|
|
|
experimental_privileged_nesting,
|
|
|
|
);
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-03-10 23:16:35 +01:00
|
|
|
if let Some(insecure_root_capabilities) = opts.insecure_root_capabilities {
|
|
|
|
query = query.arg("insecureRootCapabilities", insecure_root_capabilities);
|
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return Container {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-01-30 20:44:48 +01:00
|
|
|
}
|
2023-02-25 00:01:18 +01:00
|
|
|
/// Expose a network port.
|
|
|
|
/// Exposed ports serve two purposes:
|
|
|
|
/// - For health checks and introspection, when running services
|
|
|
|
/// - For setting the EXPOSE OCI field when publishing the container
|
2023-03-10 23:16:35 +01:00
|
|
|
/// Currently experimental; set _EXPERIMENTAL_DAGGER_SERVICES_DNS=0 to disable.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// * `port` - Port number to expose
|
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn with_exposed_port(&self, port: isize) -> Container {
|
2023-02-25 00:01:18 +01:00
|
|
|
let mut query = self.selection.select("withExposedPort");
|
|
|
|
|
|
|
|
query = query.arg("port", port);
|
|
|
|
|
|
|
|
return Container {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-25 00:01:18 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
/// Expose a network port.
|
|
|
|
/// Exposed ports serve two purposes:
|
|
|
|
/// - For health checks and introspection, when running services
|
|
|
|
/// - For setting the EXPOSE OCI field when publishing the container
|
2023-03-10 23:16:35 +01:00
|
|
|
/// Currently experimental; set _EXPERIMENTAL_DAGGER_SERVICES_DNS=0 to disable.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// * `port` - Port number to expose
|
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
|
|
|
pub fn with_exposed_port_opts<'a>(
|
|
|
|
&self,
|
|
|
|
port: isize,
|
2023-03-14 22:01:49 +01:00
|
|
|
opts: ContainerWithExposedPortOpts<'a>,
|
2023-02-25 00:01:18 +01:00
|
|
|
) -> Container {
|
|
|
|
let mut query = self.selection.select("withExposedPort");
|
|
|
|
|
|
|
|
query = query.arg("port", port);
|
|
|
|
if let Some(protocol) = opts.protocol {
|
2023-03-14 14:56:49 +01:00
|
|
|
query = query.arg_enum("protocol", protocol);
|
2023-02-25 00:01:18 +01:00
|
|
|
}
|
|
|
|
if let Some(description) = opts.description {
|
|
|
|
query = query.arg("description", description);
|
|
|
|
}
|
|
|
|
|
|
|
|
return Container {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-25 00:01:18 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Initializes this container from this DirectoryID.
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn with_fs(&self, id: DirectoryId) -> Container {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("withFS");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 15:00:00 +01:00
|
|
|
query = query.arg("id", id);
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return Container {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Retrieves this container plus the contents of the given file copied to the given path.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// * `path` - Location of the copied file (e.g., "/tmp/file.txt").
|
|
|
|
/// * `source` - Identifier of the file to copy.
|
2023-02-22 23:09:20 +01:00
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn with_file(&self, path: impl Into<String>, source: FileId) -> Container {
|
2023-02-19 17:43:12 +01:00
|
|
|
let mut query = self.selection.select("withFile");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:43:12 +01:00
|
|
|
query = query.arg("path", path.into());
|
|
|
|
query = query.arg("source", source);
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:43:12 +01:00
|
|
|
return Container {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-19 17:43:12 +01:00
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Retrieves this container plus the contents of the given file copied to the given path.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// * `path` - Location of the copied file (e.g., "/tmp/file.txt").
|
|
|
|
/// * `source` - Identifier of the file to copy.
|
2023-02-22 23:09:20 +01:00
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
2023-04-29 23:36:53 +02:00
|
|
|
pub fn with_file_opts<'a>(
|
2023-02-05 23:44:06 +01:00
|
|
|
&self,
|
2023-02-19 17:21:40 +01:00
|
|
|
path: impl Into<String>,
|
2023-02-17 12:33:16 +01:00
|
|
|
source: FileId,
|
2023-04-29 23:36:53 +02:00
|
|
|
opts: ContainerWithFileOpts<'a>,
|
2023-02-05 23:44:06 +01:00
|
|
|
) -> Container {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("withFile");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:21:40 +01:00
|
|
|
query = query.arg("path", path.into());
|
2023-02-19 15:00:00 +01:00
|
|
|
query = query.arg("source", source);
|
2023-02-19 17:49:22 +01:00
|
|
|
if let Some(permissions) = opts.permissions {
|
|
|
|
query = query.arg("permissions", permissions);
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-04-29 23:36:53 +02:00
|
|
|
if let Some(owner) = opts.owner {
|
|
|
|
query = query.arg("owner", owner);
|
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return Container {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-01-30 20:44:48 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Retrieves this container plus the given label.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// * `name` - The name of the label (e.g., "org.opencontainers.artifact.created").
|
|
|
|
/// * `value` - The value of the label (e.g., "2023-01-01T00:00:00Z").
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn with_label(&self, name: impl Into<String>, value: impl Into<String>) -> Container {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("withLabel");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:21:40 +01:00
|
|
|
query = query.arg("name", name.into());
|
|
|
|
query = query.arg("value", value.into());
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return Container {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Retrieves this container plus a cache volume mounted at the given path.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// * `path` - Location of the cache directory (e.g., "/cache/node_modules").
|
|
|
|
/// * `cache` - Identifier of the cache volume to mount.
|
2023-02-19 22:38:36 +01:00
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn with_mounted_cache(&self, path: impl Into<String>, cache: CacheId) -> Container {
|
2023-02-19 17:43:12 +01:00
|
|
|
let mut query = self.selection.select("withMountedCache");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:43:12 +01:00
|
|
|
query = query.arg("path", path.into());
|
|
|
|
query = query.arg("cache", cache);
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:43:12 +01:00
|
|
|
return Container {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-19 17:43:12 +01:00
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Retrieves this container plus a cache volume mounted at the given path.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// * `path` - Location of the cache directory (e.g., "/cache/node_modules").
|
|
|
|
/// * `cache` - Identifier of the cache volume to mount.
|
2023-02-19 22:38:36 +01:00
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
2023-04-29 23:36:53 +02:00
|
|
|
pub fn with_mounted_cache_opts<'a>(
|
2023-02-01 16:34:59 +01:00
|
|
|
&self,
|
2023-02-19 17:21:40 +01:00
|
|
|
path: impl Into<String>,
|
2023-02-17 12:33:16 +01:00
|
|
|
cache: CacheId,
|
2023-04-29 23:36:53 +02:00
|
|
|
opts: ContainerWithMountedCacheOpts<'a>,
|
2023-02-01 16:34:59 +01:00
|
|
|
) -> Container {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("withMountedCache");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:21:40 +01:00
|
|
|
query = query.arg("path", path.into());
|
2023-02-19 15:00:00 +01:00
|
|
|
query = query.arg("cache", cache);
|
2023-02-19 17:49:22 +01:00
|
|
|
if let Some(source) = opts.source {
|
|
|
|
query = query.arg("source", source);
|
|
|
|
}
|
|
|
|
if let Some(sharing) = opts.sharing {
|
2023-03-14 14:56:49 +01:00
|
|
|
query = query.arg_enum("sharing", sharing);
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-04-29 23:36:53 +02:00
|
|
|
if let Some(owner) = opts.owner {
|
|
|
|
query = query.arg("owner", owner);
|
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return Container {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-01-30 20:44:48 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Retrieves this container plus a directory mounted at the given path.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// * `path` - Location of the mounted directory (e.g., "/mnt/directory").
|
|
|
|
/// * `source` - Identifier of the mounted directory.
|
2023-04-29 23:36:53 +02:00
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
2023-02-19 17:21:40 +01:00
|
|
|
pub fn with_mounted_directory(
|
|
|
|
&self,
|
|
|
|
path: impl Into<String>,
|
|
|
|
source: DirectoryId,
|
|
|
|
) -> Container {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("withMountedDirectory");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:21:40 +01:00
|
|
|
query = query.arg("path", path.into());
|
2023-02-19 15:00:00 +01:00
|
|
|
query = query.arg("source", source);
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return Container {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-01-30 20:44:48 +01:00
|
|
|
}
|
2023-04-29 23:36:53 +02:00
|
|
|
|
|
|
|
/// Retrieves this container plus a directory mounted at the given path.
|
|
|
|
///
|
|
|
|
/// # Arguments
|
|
|
|
///
|
|
|
|
/// * `path` - Location of the mounted directory (e.g., "/mnt/directory").
|
|
|
|
/// * `source` - Identifier of the mounted directory.
|
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
|
|
|
pub fn with_mounted_directory_opts<'a>(
|
|
|
|
&self,
|
|
|
|
path: impl Into<String>,
|
|
|
|
source: DirectoryId,
|
|
|
|
opts: ContainerWithMountedDirectoryOpts<'a>,
|
|
|
|
) -> Container {
|
|
|
|
let mut query = self.selection.select("withMountedDirectory");
|
|
|
|
|
|
|
|
query = query.arg("path", path.into());
|
|
|
|
query = query.arg("source", source);
|
|
|
|
if let Some(owner) = opts.owner {
|
|
|
|
query = query.arg("owner", owner);
|
|
|
|
}
|
|
|
|
|
|
|
|
return Container {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
|
|
|
graphql_client: self.graphql_client.clone(),
|
|
|
|
};
|
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Retrieves this container plus a file mounted at the given path.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// * `path` - Location of the mounted file (e.g., "/tmp/file.txt").
|
|
|
|
/// * `source` - Identifier of the mounted file.
|
2023-04-29 23:36:53 +02:00
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn with_mounted_file(&self, path: impl Into<String>, source: FileId) -> Container {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("withMountedFile");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:21:40 +01:00
|
|
|
query = query.arg("path", path.into());
|
2023-02-19 15:00:00 +01:00
|
|
|
query = query.arg("source", source);
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return Container {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-01-30 20:44:48 +01:00
|
|
|
}
|
2023-04-29 23:36:53 +02:00
|
|
|
|
|
|
|
/// Retrieves this container plus a file mounted at the given path.
|
|
|
|
///
|
|
|
|
/// # Arguments
|
|
|
|
///
|
|
|
|
/// * `path` - Location of the mounted file (e.g., "/tmp/file.txt").
|
|
|
|
/// * `source` - Identifier of the mounted file.
|
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
|
|
|
pub fn with_mounted_file_opts<'a>(
|
|
|
|
&self,
|
|
|
|
path: impl Into<String>,
|
|
|
|
source: FileId,
|
|
|
|
opts: ContainerWithMountedFileOpts<'a>,
|
|
|
|
) -> Container {
|
|
|
|
let mut query = self.selection.select("withMountedFile");
|
|
|
|
|
|
|
|
query = query.arg("path", path.into());
|
|
|
|
query = query.arg("source", source);
|
|
|
|
if let Some(owner) = opts.owner {
|
|
|
|
query = query.arg("owner", owner);
|
|
|
|
}
|
|
|
|
|
|
|
|
return Container {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
|
|
|
graphql_client: self.graphql_client.clone(),
|
|
|
|
};
|
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Retrieves this container plus a secret mounted into a file at the given path.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// * `path` - Location of the secret file (e.g., "/tmp/secret.txt").
|
|
|
|
/// * `source` - Identifier of the secret to mount.
|
2023-04-29 23:36:53 +02:00
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn with_mounted_secret(&self, path: impl Into<String>, source: SecretId) -> Container {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("withMountedSecret");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:21:40 +01:00
|
|
|
query = query.arg("path", path.into());
|
2023-02-19 15:00:00 +01:00
|
|
|
query = query.arg("source", source);
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return Container {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-01-30 20:44:48 +01:00
|
|
|
}
|
2023-04-29 23:36:53 +02:00
|
|
|
|
|
|
|
/// Retrieves this container plus a secret mounted into a file at the given path.
|
|
|
|
///
|
|
|
|
/// # Arguments
|
|
|
|
///
|
|
|
|
/// * `path` - Location of the secret file (e.g., "/tmp/secret.txt").
|
|
|
|
/// * `source` - Identifier of the secret to mount.
|
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
|
|
|
pub fn with_mounted_secret_opts<'a>(
|
|
|
|
&self,
|
|
|
|
path: impl Into<String>,
|
|
|
|
source: SecretId,
|
|
|
|
opts: ContainerWithMountedSecretOpts<'a>,
|
|
|
|
) -> Container {
|
|
|
|
let mut query = self.selection.select("withMountedSecret");
|
|
|
|
|
|
|
|
query = query.arg("path", path.into());
|
|
|
|
query = query.arg("source", source);
|
|
|
|
if let Some(owner) = opts.owner {
|
|
|
|
query = query.arg("owner", owner);
|
|
|
|
}
|
|
|
|
|
|
|
|
return Container {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
|
|
|
graphql_client: self.graphql_client.clone(),
|
|
|
|
};
|
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Retrieves this container plus a temporary directory mounted at the given path.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// * `path` - Location of the temporary directory (e.g., "/tmp/temp_dir").
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn with_mounted_temp(&self, path: impl Into<String>) -> Container {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("withMountedTemp");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:21:40 +01:00
|
|
|
query = query.arg("path", path.into());
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return Container {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-01-30 20:44:48 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Retrieves this container plus a new file written at the given path.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// * `path` - Location of the written file (e.g., "/tmp/file.txt").
|
2023-02-22 23:09:20 +01:00
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn with_new_file(&self, path: impl Into<String>) -> Container {
|
2023-02-19 17:43:12 +01:00
|
|
|
let mut query = self.selection.select("withNewFile");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:43:12 +01:00
|
|
|
query = query.arg("path", path.into());
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:43:12 +01:00
|
|
|
return Container {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-19 17:43:12 +01:00
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Retrieves this container plus a new file written at the given path.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// * `path` - Location of the written file (e.g., "/tmp/file.txt").
|
2023-02-22 23:09:20 +01:00
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
2023-02-19 21:37:54 +01:00
|
|
|
pub fn with_new_file_opts<'a>(
|
2023-02-19 17:21:40 +01:00
|
|
|
&self,
|
|
|
|
path: impl Into<String>,
|
2023-03-14 22:01:49 +01:00
|
|
|
opts: ContainerWithNewFileOpts<'a>,
|
2023-02-19 17:21:40 +01:00
|
|
|
) -> Container {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("withNewFile");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:21:40 +01:00
|
|
|
query = query.arg("path", path.into());
|
2023-02-19 17:49:22 +01:00
|
|
|
if let Some(contents) = opts.contents {
|
|
|
|
query = query.arg("contents", contents);
|
|
|
|
}
|
|
|
|
if let Some(permissions) = opts.permissions {
|
|
|
|
query = query.arg("permissions", permissions);
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-04-29 23:36:53 +02:00
|
|
|
if let Some(owner) = opts.owner {
|
|
|
|
query = query.arg("owner", owner);
|
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return Container {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-01-30 20:44:48 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Retrieves this container with a registry authentication for a given address.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// * `address` - Registry's address to bind the authentication to.
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Formatted as [host]/[user]/[repo]:[tag] (e.g. docker.io/dagger/dagger:main).
|
|
|
|
/// * `username` - The username of the registry's account (e.g., "Dagger").
|
|
|
|
/// * `secret` - The API key, password or token to authenticate to this registry.
|
2023-02-19 12:16:48 +01:00
|
|
|
pub fn with_registry_auth(
|
|
|
|
&self,
|
2023-02-19 17:21:40 +01:00
|
|
|
address: impl Into<String>,
|
|
|
|
username: impl Into<String>,
|
2023-02-19 12:16:48 +01:00
|
|
|
secret: SecretId,
|
|
|
|
) -> Container {
|
|
|
|
let mut query = self.selection.select("withRegistryAuth");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:21:40 +01:00
|
|
|
query = query.arg("address", address.into());
|
|
|
|
query = query.arg("username", username.into());
|
2023-02-19 15:00:00 +01:00
|
|
|
query = query.arg("secret", secret);
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 12:16:48 +01:00
|
|
|
return Container {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-19 12:16:48 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Initializes this container from this DirectoryID.
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn with_rootfs(&self, id: DirectoryId) -> Container {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("withRootfs");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 15:00:00 +01:00
|
|
|
query = query.arg("id", id);
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return Container {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-01 16:42:50 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Retrieves this container plus an env variable containing the given secret.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// * `name` - The name of the secret variable (e.g., "API_SECRET").
|
|
|
|
/// * `secret` - The identifier of the secret value.
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn with_secret_variable(&self, name: impl Into<String>, secret: SecretId) -> Container {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("withSecretVariable");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:21:40 +01:00
|
|
|
query = query.arg("name", name.into());
|
2023-02-19 15:00:00 +01:00
|
|
|
query = query.arg("secret", secret);
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return Container {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-01 16:42:50 +01:00
|
|
|
}
|
2023-04-29 23:36:53 +02:00
|
|
|
/// Establish a runtime dependency on a service.
|
|
|
|
/// The service will be started automatically when needed and detached when it is
|
|
|
|
/// no longer needed, executing the default command if none is set.
|
2023-02-25 00:01:18 +01:00
|
|
|
/// The service will be reachable from the container via the provided hostname alias.
|
|
|
|
/// The service dependency will also convey to any files or directories produced by the container.
|
2023-03-10 23:16:35 +01:00
|
|
|
/// Currently experimental; set _EXPERIMENTAL_DAGGER_SERVICES_DNS=0 to disable.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// * `alias` - A name that can be used to reach the service from the container
|
|
|
|
/// * `service` - Identifier of the service container
|
|
|
|
pub fn with_service_binding(
|
|
|
|
&self,
|
|
|
|
alias: impl Into<String>,
|
|
|
|
service: ContainerId,
|
|
|
|
) -> Container {
|
|
|
|
let mut query = self.selection.select("withServiceBinding");
|
|
|
|
|
|
|
|
query = query.arg("alias", alias.into());
|
|
|
|
query = query.arg("service", service);
|
|
|
|
|
|
|
|
return Container {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-25 00:01:18 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Retrieves this container plus a socket forwarded to the given Unix socket path.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// * `path` - Location of the forwarded Unix socket (e.g., "/tmp/socket").
|
|
|
|
/// * `source` - Identifier of the socket to forward.
|
2023-04-29 23:36:53 +02:00
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn with_unix_socket(&self, path: impl Into<String>, source: SocketId) -> Container {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("withUnixSocket");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:21:40 +01:00
|
|
|
query = query.arg("path", path.into());
|
2023-02-19 15:00:00 +01:00
|
|
|
query = query.arg("source", source);
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return Container {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-01 16:42:50 +01:00
|
|
|
}
|
2023-04-29 23:36:53 +02:00
|
|
|
|
|
|
|
/// Retrieves this container plus a socket forwarded to the given Unix socket path.
|
|
|
|
///
|
|
|
|
/// # Arguments
|
|
|
|
///
|
|
|
|
/// * `path` - Location of the forwarded Unix socket (e.g., "/tmp/socket").
|
|
|
|
/// * `source` - Identifier of the socket to forward.
|
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
|
|
|
pub fn with_unix_socket_opts<'a>(
|
|
|
|
&self,
|
|
|
|
path: impl Into<String>,
|
|
|
|
source: SocketId,
|
|
|
|
opts: ContainerWithUnixSocketOpts<'a>,
|
|
|
|
) -> Container {
|
|
|
|
let mut query = self.selection.select("withUnixSocket");
|
|
|
|
|
|
|
|
query = query.arg("path", path.into());
|
|
|
|
query = query.arg("source", source);
|
|
|
|
if let Some(owner) = opts.owner {
|
|
|
|
query = query.arg("owner", owner);
|
|
|
|
}
|
|
|
|
|
|
|
|
return Container {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
|
|
|
graphql_client: self.graphql_client.clone(),
|
|
|
|
};
|
|
|
|
}
|
2023-02-25 00:01:18 +01:00
|
|
|
/// Retrieves this container with a different command user.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// * `name` - The user to set (e.g., "root").
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn with_user(&self, name: impl Into<String>) -> Container {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("withUser");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:21:40 +01:00
|
|
|
query = query.arg("name", name.into());
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return Container {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-01 16:42:50 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Retrieves this container with a different working directory.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// * `path` - The path to set as the working directory (e.g., "/app").
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn with_workdir(&self, path: impl Into<String>) -> Container {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("withWorkdir");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:21:40 +01:00
|
|
|
query = query.arg("path", path.into());
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return Container {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-01 16:42:50 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Retrieves this container minus the given environment variable.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// * `name` - The name of the environment variable (e.g., "HOST").
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn without_env_variable(&self, name: impl Into<String>) -> Container {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("withoutEnvVariable");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:21:40 +01:00
|
|
|
query = query.arg("name", name.into());
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return Container {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-01 16:42:50 +01:00
|
|
|
}
|
2023-02-25 00:01:18 +01:00
|
|
|
/// Unexpose a previously exposed port.
|
2023-03-10 23:16:35 +01:00
|
|
|
/// Currently experimental; set _EXPERIMENTAL_DAGGER_SERVICES_DNS=0 to disable.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// * `port` - Port number to unexpose
|
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn without_exposed_port(&self, port: isize) -> Container {
|
2023-02-25 00:01:18 +01:00
|
|
|
let mut query = self.selection.select("withoutExposedPort");
|
|
|
|
|
|
|
|
query = query.arg("port", port);
|
|
|
|
|
|
|
|
return Container {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-25 00:01:18 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
/// Unexpose a previously exposed port.
|
2023-03-10 23:16:35 +01:00
|
|
|
/// Currently experimental; set _EXPERIMENTAL_DAGGER_SERVICES_DNS=0 to disable.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// * `port` - Port number to unexpose
|
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
|
|
|
pub fn without_exposed_port_opts(
|
|
|
|
&self,
|
|
|
|
port: isize,
|
2023-03-14 22:01:49 +01:00
|
|
|
opts: ContainerWithoutExposedPortOpts,
|
2023-02-25 00:01:18 +01:00
|
|
|
) -> Container {
|
|
|
|
let mut query = self.selection.select("withoutExposedPort");
|
|
|
|
|
|
|
|
query = query.arg("port", port);
|
|
|
|
if let Some(protocol) = opts.protocol {
|
2023-03-14 14:56:49 +01:00
|
|
|
query = query.arg_enum("protocol", protocol);
|
2023-02-25 00:01:18 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
return Container {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-25 00:01:18 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Retrieves this container minus the given environment label.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// * `name` - The name of the label to remove (e.g., "org.opencontainers.artifact.created").
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn without_label(&self, name: impl Into<String>) -> Container {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("withoutLabel");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:21:40 +01:00
|
|
|
query = query.arg("name", name.into());
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return Container {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-01 16:42:50 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Retrieves this container after unmounting everything at the given path.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// * `path` - Location of the cache directory (e.g., "/cache/node_modules").
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn without_mount(&self, path: impl Into<String>) -> Container {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("withoutMount");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:21:40 +01:00
|
|
|
query = query.arg("path", path.into());
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return Container {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-01 16:42:50 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Retrieves this container without the registry authentication of a given address.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// * `address` - Registry's address to remove the authentication from.
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Formatted as [host]/[user]/[repo]:[tag] (e.g. docker.io/dagger/dagger:main).
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn without_registry_auth(&self, address: impl Into<String>) -> Container {
|
2023-02-19 12:16:48 +01:00
|
|
|
let mut query = self.selection.select("withoutRegistryAuth");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:21:40 +01:00
|
|
|
query = query.arg("address", address.into());
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 12:16:48 +01:00
|
|
|
return Container {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-19 12:16:48 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Retrieves this container with a previously added Unix socket removed.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// * `path` - Location of the socket to remove (e.g., "/tmp/socket").
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn without_unix_socket(&self, path: impl Into<String>) -> Container {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("withoutUnixSocket");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:21:40 +01:00
|
|
|
query = query.arg("path", path.into());
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return Container {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-01 16:42:50 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Retrieves the working directory for all commands.
|
2023-03-14 22:01:49 +01:00
|
|
|
pub async fn workdir(&self) -> eyre::Result<String> {
|
|
|
|
let query = self.selection.select("workdir");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-03-19 01:01:24 +01:00
|
|
|
query.execute(self.graphql_client.clone()).await
|
2023-02-01 16:42:50 +01:00
|
|
|
}
|
|
|
|
}
|
2023-03-19 01:01:24 +01:00
|
|
|
#[derive(Clone)]
|
2023-02-17 12:33:16 +01:00
|
|
|
pub struct Directory {
|
|
|
|
pub proc: Arc<Child>,
|
|
|
|
pub selection: Selection,
|
2023-03-19 01:01:24 +01:00
|
|
|
pub graphql_client: DynGraphQLClient,
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:21:40 +01:00
|
|
|
#[derive(Builder, Debug, PartialEq)]
|
|
|
|
pub struct DirectoryDockerBuildOpts<'a> {
|
2023-03-14 22:09:04 +01:00
|
|
|
/// Build arguments to use in the build.
|
|
|
|
#[builder(setter(into, strip_option), default)]
|
|
|
|
pub build_args: Option<Vec<BuildArg>>,
|
2023-02-25 00:01:18 +01:00
|
|
|
/// Path to the Dockerfile to use (e.g., "frontend.Dockerfile").
|
|
|
|
/// Defaults: './Dockerfile'.
|
2023-02-25 01:03:24 +01:00
|
|
|
#[builder(setter(into, strip_option), default)]
|
2023-02-19 17:21:40 +01:00
|
|
|
pub dockerfile: Option<&'a str>,
|
2023-02-19 22:38:36 +01:00
|
|
|
/// The platform to build.
|
2023-02-25 01:03:24 +01:00
|
|
|
#[builder(setter(into, strip_option), default)]
|
2023-02-17 12:33:16 +01:00
|
|
|
pub platform: Option<Platform>,
|
2023-04-29 23:36:53 +02:00
|
|
|
/// Secrets to pass to the build.
|
|
|
|
/// They will be mounted at /run/secrets/[secret-name].
|
|
|
|
#[builder(setter(into, strip_option), default)]
|
|
|
|
pub secrets: Option<Vec<SecretId>>,
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Target build stage to build.
|
2023-02-25 01:03:24 +01:00
|
|
|
#[builder(setter(into, strip_option), default)]
|
2023-02-19 17:21:40 +01:00
|
|
|
pub target: Option<&'a str>,
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-02-19 17:21:40 +01:00
|
|
|
#[derive(Builder, Debug, PartialEq)]
|
|
|
|
pub struct DirectoryEntriesOpts<'a> {
|
2023-02-25 00:01:18 +01:00
|
|
|
/// Location of the directory to look at (e.g., "/src").
|
2023-02-25 01:03:24 +01:00
|
|
|
#[builder(setter(into, strip_option), default)]
|
2023-02-19 17:21:40 +01:00
|
|
|
pub path: Option<&'a str>,
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-02-19 17:21:40 +01:00
|
|
|
#[derive(Builder, Debug, PartialEq)]
|
|
|
|
pub struct DirectoryPipelineOpts<'a> {
|
2023-03-10 23:16:35 +01:00
|
|
|
/// Pipeline description.
|
2023-02-25 01:03:24 +01:00
|
|
|
#[builder(setter(into, strip_option), default)]
|
2023-02-19 17:21:40 +01:00
|
|
|
pub description: Option<&'a str>,
|
2023-03-10 23:16:35 +01:00
|
|
|
/// Pipeline labels.
|
|
|
|
#[builder(setter(into, strip_option), default)]
|
|
|
|
pub labels: Option<Vec<PipelineLabel>>,
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-02-19 17:21:40 +01:00
|
|
|
#[derive(Builder, Debug, PartialEq)]
|
|
|
|
pub struct DirectoryWithDirectoryOpts<'a> {
|
2023-02-25 00:01:18 +01:00
|
|
|
/// Exclude artifacts that match the given pattern (e.g., ["node_modules/", ".git*"]).
|
2023-02-25 01:03:24 +01:00
|
|
|
#[builder(setter(into, strip_option), default)]
|
2023-02-19 17:21:40 +01:00
|
|
|
pub exclude: Option<Vec<&'a str>>,
|
2023-02-25 00:01:18 +01:00
|
|
|
/// Include only artifacts that match the given pattern (e.g., ["app/", "package.*"]).
|
2023-02-25 01:03:24 +01:00
|
|
|
#[builder(setter(into, strip_option), default)]
|
2023-02-19 17:21:40 +01:00
|
|
|
pub include: Option<Vec<&'a str>>,
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-02-19 17:21:40 +01:00
|
|
|
#[derive(Builder, Debug, PartialEq)]
|
2023-02-19 17:29:59 +01:00
|
|
|
pub struct DirectoryWithFileOpts {
|
2023-02-25 00:01:18 +01:00
|
|
|
/// Permission given to the copied file (e.g., 0600).
|
|
|
|
/// Default: 0644.
|
2023-02-25 01:03:24 +01:00
|
|
|
#[builder(setter(into, strip_option), default)]
|
2023-02-17 12:33:16 +01:00
|
|
|
pub permissions: Option<isize>,
|
|
|
|
}
|
2023-02-19 17:21:40 +01:00
|
|
|
#[derive(Builder, Debug, PartialEq)]
|
2023-02-19 17:29:59 +01:00
|
|
|
pub struct DirectoryWithNewDirectoryOpts {
|
2023-02-25 00:01:18 +01:00
|
|
|
/// Permission granted to the created directory (e.g., 0777).
|
|
|
|
/// Default: 0755.
|
2023-02-25 01:03:24 +01:00
|
|
|
#[builder(setter(into, strip_option), default)]
|
2023-02-17 12:33:16 +01:00
|
|
|
pub permissions: Option<isize>,
|
|
|
|
}
|
2023-02-19 17:21:40 +01:00
|
|
|
#[derive(Builder, Debug, PartialEq)]
|
2023-02-19 17:29:59 +01:00
|
|
|
pub struct DirectoryWithNewFileOpts {
|
2023-02-25 00:01:18 +01:00
|
|
|
/// Permission given to the copied file (e.g., 0600).
|
|
|
|
/// Default: 0644.
|
2023-02-25 01:03:24 +01:00
|
|
|
#[builder(setter(into, strip_option), default)]
|
2023-02-17 12:33:16 +01:00
|
|
|
pub permissions: Option<isize>,
|
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-01 16:42:50 +01:00
|
|
|
impl Directory {
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Gets the difference between this directory and an another directory.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// * `other` - Identifier of the directory to compare.
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn diff(&self, other: DirectoryId) -> Directory {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("diff");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 15:00:00 +01:00
|
|
|
query = query.arg("other", other);
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return Directory {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-01 16:42:50 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Retrieves a directory at the given path.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// * `path` - Location of the directory to retrieve (e.g., "/src").
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn directory(&self, path: impl Into<String>) -> Directory {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("directory");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:21:40 +01:00
|
|
|
query = query.arg("path", path.into());
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return Directory {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-01 16:42:50 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Builds a new Docker container from this directory.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn docker_build(&self) -> Container {
|
|
|
|
let query = self.selection.select("dockerBuild");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:43:12 +01:00
|
|
|
return Container {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-19 17:43:12 +01:00
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Builds a new Docker container from this directory.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn docker_build_opts<'a>(&self, opts: DirectoryDockerBuildOpts<'a>) -> Container {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("dockerBuild");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:49:22 +01:00
|
|
|
if let Some(dockerfile) = opts.dockerfile {
|
|
|
|
query = query.arg("dockerfile", dockerfile);
|
|
|
|
}
|
|
|
|
if let Some(platform) = opts.platform {
|
|
|
|
query = query.arg("platform", platform);
|
|
|
|
}
|
|
|
|
if let Some(build_args) = opts.build_args {
|
|
|
|
query = query.arg("buildArgs", build_args);
|
|
|
|
}
|
|
|
|
if let Some(target) = opts.target {
|
|
|
|
query = query.arg("target", target);
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-04-29 23:36:53 +02:00
|
|
|
if let Some(secrets) = opts.secrets {
|
|
|
|
query = query.arg("secrets", secrets);
|
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return Container {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-01 16:42:50 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Returns a list of files and directories at the given path.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
2023-03-14 22:01:49 +01:00
|
|
|
pub async fn entries(&self) -> eyre::Result<Vec<String>> {
|
|
|
|
let query = self.selection.select("entries");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-03-19 01:01:24 +01:00
|
|
|
query.execute(self.graphql_client.clone()).await
|
2023-02-19 17:43:12 +01:00
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Returns a list of files and directories at the given path.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
2023-02-19 21:37:54 +01:00
|
|
|
pub async fn entries_opts<'a>(
|
|
|
|
&self,
|
2023-03-14 22:01:49 +01:00
|
|
|
opts: DirectoryEntriesOpts<'a>,
|
2023-02-19 21:37:54 +01:00
|
|
|
) -> eyre::Result<Vec<String>> {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("entries");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:49:22 +01:00
|
|
|
if let Some(path) = opts.path {
|
|
|
|
query = query.arg("path", path);
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-03-19 01:01:24 +01:00
|
|
|
query.execute(self.graphql_client.clone()).await
|
2023-02-01 16:42:50 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Writes the contents of the directory to a path on the host.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// * `path` - Location of the copied directory (e.g., "logs/").
|
2023-03-14 22:01:49 +01:00
|
|
|
pub async fn export(&self, path: impl Into<String>) -> eyre::Result<bool> {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("export");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:21:40 +01:00
|
|
|
query = query.arg("path", path.into());
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-03-19 01:01:24 +01:00
|
|
|
query.execute(self.graphql_client.clone()).await
|
2023-02-01 16:42:50 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Retrieves a file at the given path.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// * `path` - Location of the file to retrieve (e.g., "README.md").
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn file(&self, path: impl Into<String>) -> File {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("file");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:21:40 +01:00
|
|
|
query = query.arg("path", path.into());
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return File {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-01 16:42:50 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// The content-addressed identifier of the directory.
|
2023-03-14 22:01:49 +01:00
|
|
|
pub async fn id(&self) -> eyre::Result<DirectoryId> {
|
|
|
|
let query = self.selection.select("id");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-03-19 01:01:24 +01:00
|
|
|
query.execute(self.graphql_client.clone()).await
|
2023-02-01 16:42:50 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// load a project's metadata
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn load_project(&self, config_path: impl Into<String>) -> Project {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("loadProject");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:21:40 +01:00
|
|
|
query = query.arg("configPath", config_path.into());
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return Project {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-01 16:42:50 +01:00
|
|
|
}
|
2023-03-10 23:16:35 +01:00
|
|
|
/// Creates a named sub-pipeline
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-03-10 23:16:35 +01:00
|
|
|
/// * `name` - Pipeline name.
|
2023-02-22 23:09:20 +01:00
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn pipeline(&self, name: impl Into<String>) -> Directory {
|
2023-02-19 17:43:12 +01:00
|
|
|
let mut query = self.selection.select("pipeline");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:43:12 +01:00
|
|
|
query = query.arg("name", name.into());
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:43:12 +01:00
|
|
|
return Directory {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-19 17:43:12 +01:00
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-03-10 23:16:35 +01:00
|
|
|
/// Creates a named sub-pipeline
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-03-10 23:16:35 +01:00
|
|
|
/// * `name` - Pipeline name.
|
2023-02-22 23:09:20 +01:00
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
2023-02-19 21:37:54 +01:00
|
|
|
pub fn pipeline_opts<'a>(
|
|
|
|
&self,
|
|
|
|
name: impl Into<String>,
|
2023-03-14 22:01:49 +01:00
|
|
|
opts: DirectoryPipelineOpts<'a>,
|
2023-02-19 21:37:54 +01:00
|
|
|
) -> Directory {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("pipeline");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:21:40 +01:00
|
|
|
query = query.arg("name", name.into());
|
2023-02-19 17:49:22 +01:00
|
|
|
if let Some(description) = opts.description {
|
|
|
|
query = query.arg("description", description);
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-03-10 23:16:35 +01:00
|
|
|
if let Some(labels) = opts.labels {
|
|
|
|
query = query.arg("labels", labels);
|
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return Directory {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Retrieves this directory plus a directory written at the given path.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// * `path` - Location of the written directory (e.g., "/src/").
|
|
|
|
/// * `directory` - Identifier of the directory to copy.
|
2023-02-22 23:09:20 +01:00
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn with_directory(&self, path: impl Into<String>, directory: DirectoryId) -> Directory {
|
2023-02-19 17:43:12 +01:00
|
|
|
let mut query = self.selection.select("withDirectory");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:43:12 +01:00
|
|
|
query = query.arg("path", path.into());
|
|
|
|
query = query.arg("directory", directory);
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:43:12 +01:00
|
|
|
return Directory {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-19 17:43:12 +01:00
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Retrieves this directory plus a directory written at the given path.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// * `path` - Location of the written directory (e.g., "/src/").
|
|
|
|
/// * `directory` - Identifier of the directory to copy.
|
2023-02-22 23:09:20 +01:00
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
2023-02-19 21:37:54 +01:00
|
|
|
pub fn with_directory_opts<'a>(
|
2023-02-01 16:42:50 +01:00
|
|
|
&self,
|
2023-02-19 17:21:40 +01:00
|
|
|
path: impl Into<String>,
|
2023-02-17 12:33:16 +01:00
|
|
|
directory: DirectoryId,
|
2023-03-14 22:01:49 +01:00
|
|
|
opts: DirectoryWithDirectoryOpts<'a>,
|
2023-02-01 16:42:50 +01:00
|
|
|
) -> Directory {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("withDirectory");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:21:40 +01:00
|
|
|
query = query.arg("path", path.into());
|
2023-02-19 15:00:00 +01:00
|
|
|
query = query.arg("directory", directory);
|
2023-02-19 17:49:22 +01:00
|
|
|
if let Some(exclude) = opts.exclude {
|
|
|
|
query = query.arg("exclude", exclude);
|
|
|
|
}
|
|
|
|
if let Some(include) = opts.include {
|
|
|
|
query = query.arg("include", include);
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return Directory {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Retrieves this directory plus the contents of the given file copied to the given path.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// * `path` - Location of the copied file (e.g., "/file.txt").
|
|
|
|
/// * `source` - Identifier of the file to copy.
|
2023-02-22 23:09:20 +01:00
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn with_file(&self, path: impl Into<String>, source: FileId) -> Directory {
|
2023-02-19 17:43:12 +01:00
|
|
|
let mut query = self.selection.select("withFile");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:43:12 +01:00
|
|
|
query = query.arg("path", path.into());
|
|
|
|
query = query.arg("source", source);
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:43:12 +01:00
|
|
|
return Directory {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-19 17:43:12 +01:00
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Retrieves this directory plus the contents of the given file copied to the given path.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// * `path` - Location of the copied file (e.g., "/file.txt").
|
|
|
|
/// * `source` - Identifier of the file to copy.
|
2023-02-22 23:09:20 +01:00
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
2023-02-19 17:43:12 +01:00
|
|
|
pub fn with_file_opts(
|
2023-02-05 23:44:06 +01:00
|
|
|
&self,
|
2023-02-19 17:21:40 +01:00
|
|
|
path: impl Into<String>,
|
2023-02-17 12:33:16 +01:00
|
|
|
source: FileId,
|
2023-03-14 22:01:49 +01:00
|
|
|
opts: DirectoryWithFileOpts,
|
2023-02-05 23:44:06 +01:00
|
|
|
) -> Directory {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("withFile");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:21:40 +01:00
|
|
|
query = query.arg("path", path.into());
|
2023-02-19 15:00:00 +01:00
|
|
|
query = query.arg("source", source);
|
2023-02-19 17:49:22 +01:00
|
|
|
if let Some(permissions) = opts.permissions {
|
|
|
|
query = query.arg("permissions", permissions);
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return Directory {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-01 16:42:50 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Retrieves this directory plus a new directory created at the given path.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// * `path` - Location of the directory created (e.g., "/logs").
|
2023-02-22 23:09:20 +01:00
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn with_new_directory(&self, path: impl Into<String>) -> Directory {
|
2023-02-19 17:43:12 +01:00
|
|
|
let mut query = self.selection.select("withNewDirectory");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:43:12 +01:00
|
|
|
query = query.arg("path", path.into());
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:43:12 +01:00
|
|
|
return Directory {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-19 17:43:12 +01:00
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Retrieves this directory plus a new directory created at the given path.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// * `path` - Location of the directory created (e.g., "/logs").
|
2023-02-22 23:09:20 +01:00
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
2023-02-19 17:43:12 +01:00
|
|
|
pub fn with_new_directory_opts(
|
2023-02-17 12:33:16 +01:00
|
|
|
&self,
|
2023-02-19 17:21:40 +01:00
|
|
|
path: impl Into<String>,
|
2023-03-14 22:01:49 +01:00
|
|
|
opts: DirectoryWithNewDirectoryOpts,
|
2023-02-17 12:33:16 +01:00
|
|
|
) -> Directory {
|
|
|
|
let mut query = self.selection.select("withNewDirectory");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:21:40 +01:00
|
|
|
query = query.arg("path", path.into());
|
2023-02-19 17:49:22 +01:00
|
|
|
if let Some(permissions) = opts.permissions {
|
|
|
|
query = query.arg("permissions", permissions);
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return Directory {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Retrieves this directory plus a new file written at the given path.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// * `path` - Location of the written file (e.g., "/file.txt").
|
|
|
|
/// * `contents` - Content of the written file (e.g., "Hello world!").
|
2023-02-22 23:09:20 +01:00
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn with_new_file(&self, path: impl Into<String>, contents: impl Into<String>) -> Directory {
|
2023-02-19 17:43:12 +01:00
|
|
|
let mut query = self.selection.select("withNewFile");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:43:12 +01:00
|
|
|
query = query.arg("path", path.into());
|
|
|
|
query = query.arg("contents", contents.into());
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:43:12 +01:00
|
|
|
return Directory {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-19 17:43:12 +01:00
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Retrieves this directory plus a new file written at the given path.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// * `path` - Location of the written file (e.g., "/file.txt").
|
|
|
|
/// * `contents` - Content of the written file (e.g., "Hello world!").
|
2023-02-22 23:09:20 +01:00
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
2023-02-19 17:43:12 +01:00
|
|
|
pub fn with_new_file_opts(
|
2023-02-01 16:42:50 +01:00
|
|
|
&self,
|
2023-02-19 17:21:40 +01:00
|
|
|
path: impl Into<String>,
|
|
|
|
contents: impl Into<String>,
|
2023-03-14 22:01:49 +01:00
|
|
|
opts: DirectoryWithNewFileOpts,
|
2023-02-01 16:42:50 +01:00
|
|
|
) -> Directory {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("withNewFile");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:21:40 +01:00
|
|
|
query = query.arg("path", path.into());
|
|
|
|
query = query.arg("contents", contents.into());
|
2023-02-19 17:49:22 +01:00
|
|
|
if let Some(permissions) = opts.permissions {
|
|
|
|
query = query.arg("permissions", permissions);
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return Directory {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-01 16:42:50 +01:00
|
|
|
}
|
2023-02-25 00:01:18 +01:00
|
|
|
/// Retrieves this directory with all file/dir timestamps set to the given time.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// * `timestamp` - Timestamp to set dir/files in.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// Formatted in seconds following Unix epoch (e.g., 1672531199).
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn with_timestamps(&self, timestamp: isize) -> Directory {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("withTimestamps");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 15:00:00 +01:00
|
|
|
query = query.arg("timestamp", timestamp);
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return Directory {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-01-30 20:44:48 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Retrieves this directory with the directory at the given path removed.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// * `path` - Location of the directory to remove (e.g., ".github/").
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn without_directory(&self, path: impl Into<String>) -> Directory {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("withoutDirectory");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:21:40 +01:00
|
|
|
query = query.arg("path", path.into());
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return Directory {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-01-30 20:44:48 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Retrieves this directory with the file at the given path removed.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// * `path` - Location of the file to remove (e.g., "/file.txt").
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn without_file(&self, path: impl Into<String>) -> Directory {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("withoutFile");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:21:40 +01:00
|
|
|
query = query.arg("path", path.into());
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return Directory {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
|
|
|
}
|
2023-03-19 01:01:24 +01:00
|
|
|
#[derive(Clone)]
|
2023-02-17 12:33:16 +01:00
|
|
|
pub struct EnvVariable {
|
|
|
|
pub proc: Arc<Child>,
|
|
|
|
pub selection: Selection,
|
2023-03-19 01:01:24 +01:00
|
|
|
pub graphql_client: DynGraphQLClient,
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-01 16:42:50 +01:00
|
|
|
impl EnvVariable {
|
2023-02-19 22:38:36 +01:00
|
|
|
/// The environment variable name.
|
2023-03-14 22:01:49 +01:00
|
|
|
pub async fn name(&self) -> eyre::Result<String> {
|
|
|
|
let query = self.selection.select("name");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-03-19 01:01:24 +01:00
|
|
|
query.execute(self.graphql_client.clone()).await
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// The environment variable value.
|
2023-03-14 22:01:49 +01:00
|
|
|
pub async fn value(&self) -> eyre::Result<String> {
|
|
|
|
let query = self.selection.select("value");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-03-19 01:01:24 +01:00
|
|
|
query.execute(self.graphql_client.clone()).await
|
2023-01-30 20:44:48 +01:00
|
|
|
}
|
2023-02-01 16:42:50 +01:00
|
|
|
}
|
2023-03-19 01:01:24 +01:00
|
|
|
#[derive(Clone)]
|
2023-02-17 12:33:16 +01:00
|
|
|
pub struct File {
|
|
|
|
pub proc: Arc<Child>,
|
|
|
|
pub selection: Selection,
|
2023-03-19 01:01:24 +01:00
|
|
|
pub graphql_client: DynGraphQLClient,
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-01 16:42:50 +01:00
|
|
|
impl File {
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Retrieves the contents of the file.
|
2023-03-14 22:01:49 +01:00
|
|
|
pub async fn contents(&self) -> eyre::Result<String> {
|
|
|
|
let query = self.selection.select("contents");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-03-19 01:01:24 +01:00
|
|
|
query.execute(self.graphql_client.clone()).await
|
2023-01-30 20:44:48 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Writes the file to a file path on the host.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// * `path` - Location of the written directory (e.g., "output.txt").
|
2023-03-14 22:01:49 +01:00
|
|
|
pub async fn export(&self, path: impl Into<String>) -> eyre::Result<bool> {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("export");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:21:40 +01:00
|
|
|
query = query.arg("path", path.into());
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-03-19 01:01:24 +01:00
|
|
|
query.execute(self.graphql_client.clone()).await
|
2023-01-30 20:44:48 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Retrieves the content-addressed identifier of the file.
|
2023-03-14 22:01:49 +01:00
|
|
|
pub async fn id(&self) -> eyre::Result<FileId> {
|
|
|
|
let query = self.selection.select("id");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-03-19 01:01:24 +01:00
|
|
|
query.execute(self.graphql_client.clone()).await
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Retrieves a secret referencing the contents of this file.
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn secret(&self) -> Secret {
|
|
|
|
let query = self.selection.select("secret");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return Secret {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-01 16:34:59 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Gets the size of the file, in bytes.
|
2023-03-14 22:01:49 +01:00
|
|
|
pub async fn size(&self) -> eyre::Result<isize> {
|
|
|
|
let query = self.selection.select("size");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-03-19 01:01:24 +01:00
|
|
|
query.execute(self.graphql_client.clone()).await
|
2023-01-30 20:44:48 +01:00
|
|
|
}
|
2023-02-25 00:01:18 +01:00
|
|
|
/// Retrieves this file with its created/modified timestamps set to the given time.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// * `timestamp` - Timestamp to set dir/files in.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// Formatted in seconds following Unix epoch (e.g., 1672531199).
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn with_timestamps(&self, timestamp: isize) -> File {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("withTimestamps");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 15:00:00 +01:00
|
|
|
query = query.arg("timestamp", timestamp);
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return File {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-01-30 20:44:48 +01:00
|
|
|
}
|
2023-02-01 15:32:38 +01:00
|
|
|
}
|
2023-03-19 01:01:24 +01:00
|
|
|
#[derive(Clone)]
|
2023-02-17 12:33:16 +01:00
|
|
|
pub struct GitRef {
|
|
|
|
pub proc: Arc<Child>,
|
|
|
|
pub selection: Selection,
|
2023-03-19 01:01:24 +01:00
|
|
|
pub graphql_client: DynGraphQLClient,
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:21:40 +01:00
|
|
|
#[derive(Builder, Debug, PartialEq)]
|
|
|
|
pub struct GitRefTreeOpts<'a> {
|
2023-02-25 01:03:24 +01:00
|
|
|
#[builder(setter(into, strip_option), default)]
|
2023-02-17 12:33:16 +01:00
|
|
|
pub ssh_auth_socket: Option<SocketId>,
|
2023-03-14 22:09:04 +01:00
|
|
|
#[builder(setter(into, strip_option), default)]
|
|
|
|
pub ssh_known_hosts: Option<&'a str>,
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-01 16:34:59 +01:00
|
|
|
impl GitRef {
|
2023-02-19 22:38:36 +01:00
|
|
|
/// The digest of the current value of this ref.
|
2023-03-14 22:01:49 +01:00
|
|
|
pub async fn digest(&self) -> eyre::Result<String> {
|
|
|
|
let query = self.selection.select("digest");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-03-19 01:01:24 +01:00
|
|
|
query.execute(self.graphql_client.clone()).await
|
2023-01-30 20:44:48 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// The filesystem tree at this ref.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn tree(&self) -> Directory {
|
|
|
|
let query = self.selection.select("tree");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:43:12 +01:00
|
|
|
return Directory {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-19 17:43:12 +01:00
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 22:38:36 +01:00
|
|
|
/// The filesystem tree at this ref.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn tree_opts<'a>(&self, opts: GitRefTreeOpts<'a>) -> Directory {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("tree");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:49:22 +01:00
|
|
|
if let Some(ssh_known_hosts) = opts.ssh_known_hosts {
|
|
|
|
query = query.arg("sshKnownHosts", ssh_known_hosts);
|
|
|
|
}
|
|
|
|
if let Some(ssh_auth_socket) = opts.ssh_auth_socket {
|
|
|
|
query = query.arg("sshAuthSocket", ssh_auth_socket);
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return Directory {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-01-30 20:44:48 +01:00
|
|
|
}
|
2023-02-01 16:34:59 +01:00
|
|
|
}
|
2023-03-19 01:01:24 +01:00
|
|
|
#[derive(Clone)]
|
2023-02-17 12:33:16 +01:00
|
|
|
pub struct GitRepository {
|
|
|
|
pub proc: Arc<Child>,
|
|
|
|
pub selection: Selection,
|
2023-03-19 01:01:24 +01:00
|
|
|
pub graphql_client: DynGraphQLClient,
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
impl GitRepository {
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Returns details on one branch.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// * `name` - Branch's name (e.g., "main").
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn branch(&self, name: impl Into<String>) -> GitRef {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("branch");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:21:40 +01:00
|
|
|
query = query.arg("name", name.into());
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return GitRef {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-01-30 20:44:48 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Lists of branches on the repository.
|
2023-03-14 22:01:49 +01:00
|
|
|
pub async fn branches(&self) -> eyre::Result<Vec<String>> {
|
|
|
|
let query = self.selection.select("branches");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-03-19 01:01:24 +01:00
|
|
|
query.execute(self.graphql_client.clone()).await
|
2023-02-01 16:42:50 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Returns details on one commit.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// * `id` - Identifier of the commit (e.g., "b6315d8f2810962c601af73f86831f6866ea798b").
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn commit(&self, id: impl Into<String>) -> GitRef {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("commit");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:21:40 +01:00
|
|
|
query = query.arg("id", id.into());
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return GitRef {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-01 16:42:50 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Returns details on one tag.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// * `name` - Tag's name (e.g., "v0.3.9").
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn tag(&self, name: impl Into<String>) -> GitRef {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("tag");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:21:40 +01:00
|
|
|
query = query.arg("name", name.into());
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return GitRef {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Lists of tags on the repository.
|
2023-03-14 22:01:49 +01:00
|
|
|
pub async fn tags(&self) -> eyre::Result<Vec<String>> {
|
|
|
|
let query = self.selection.select("tags");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-03-19 01:01:24 +01:00
|
|
|
query.execute(self.graphql_client.clone()).await
|
2023-01-30 20:44:48 +01:00
|
|
|
}
|
2023-02-01 16:34:59 +01:00
|
|
|
}
|
2023-03-19 01:01:24 +01:00
|
|
|
#[derive(Clone)]
|
2023-02-17 12:33:16 +01:00
|
|
|
pub struct Host {
|
|
|
|
pub proc: Arc<Child>,
|
|
|
|
pub selection: Selection,
|
2023-03-19 01:01:24 +01:00
|
|
|
pub graphql_client: DynGraphQLClient,
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:21:40 +01:00
|
|
|
#[derive(Builder, Debug, PartialEq)]
|
|
|
|
pub struct HostDirectoryOpts<'a> {
|
2023-02-25 00:01:18 +01:00
|
|
|
/// Exclude artifacts that match the given pattern (e.g., ["node_modules/", ".git*"]).
|
2023-02-25 01:03:24 +01:00
|
|
|
#[builder(setter(into, strip_option), default)]
|
2023-02-19 17:21:40 +01:00
|
|
|
pub exclude: Option<Vec<&'a str>>,
|
2023-02-25 00:01:18 +01:00
|
|
|
/// Include only artifacts that match the given pattern (e.g., ["app/", "package.*"]).
|
2023-02-25 01:03:24 +01:00
|
|
|
#[builder(setter(into, strip_option), default)]
|
2023-02-19 17:21:40 +01:00
|
|
|
pub include: Option<Vec<&'a str>>,
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-02-19 17:21:40 +01:00
|
|
|
#[derive(Builder, Debug, PartialEq)]
|
|
|
|
pub struct HostWorkdirOpts<'a> {
|
2023-02-25 00:01:18 +01:00
|
|
|
/// Exclude artifacts that match the given pattern (e.g., ["node_modules/", ".git*"]).
|
2023-02-25 01:03:24 +01:00
|
|
|
#[builder(setter(into, strip_option), default)]
|
2023-02-19 17:21:40 +01:00
|
|
|
pub exclude: Option<Vec<&'a str>>,
|
2023-02-25 00:01:18 +01:00
|
|
|
/// Include only artifacts that match the given pattern (e.g., ["app/", "package.*"]).
|
2023-02-25 01:03:24 +01:00
|
|
|
#[builder(setter(into, strip_option), default)]
|
2023-02-19 17:21:40 +01:00
|
|
|
pub include: Option<Vec<&'a str>>,
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-01 16:34:59 +01:00
|
|
|
impl Host {
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Accesses a directory on the host.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// * `path` - Location of the directory to access (e.g., ".").
|
2023-02-22 23:09:20 +01:00
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn directory(&self, path: impl Into<String>) -> Directory {
|
2023-02-19 17:43:12 +01:00
|
|
|
let mut query = self.selection.select("directory");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:43:12 +01:00
|
|
|
query = query.arg("path", path.into());
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:43:12 +01:00
|
|
|
return Directory {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-19 17:43:12 +01:00
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Accesses a directory on the host.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// * `path` - Location of the directory to access (e.g., ".").
|
2023-02-22 23:09:20 +01:00
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
2023-02-19 21:37:54 +01:00
|
|
|
pub fn directory_opts<'a>(
|
|
|
|
&self,
|
|
|
|
path: impl Into<String>,
|
2023-03-14 22:01:49 +01:00
|
|
|
opts: HostDirectoryOpts<'a>,
|
2023-02-19 21:37:54 +01:00
|
|
|
) -> Directory {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("directory");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:21:40 +01:00
|
|
|
query = query.arg("path", path.into());
|
2023-02-19 17:49:22 +01:00
|
|
|
if let Some(exclude) = opts.exclude {
|
|
|
|
query = query.arg("exclude", exclude);
|
|
|
|
}
|
|
|
|
if let Some(include) = opts.include {
|
|
|
|
query = query.arg("include", include);
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return Directory {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-01-30 20:44:48 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Accesses an environment variable on the host.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// * `name` - Name of the environment variable (e.g., "PATH").
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn env_variable(&self, name: impl Into<String>) -> HostVariable {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("envVariable");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:21:40 +01:00
|
|
|
query = query.arg("name", name.into());
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return HostVariable {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-01-30 20:44:48 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Accesses a Unix socket on the host.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// * `path` - Location of the Unix socket (e.g., "/var/run/docker.sock").
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn unix_socket(&self, path: impl Into<String>) -> Socket {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("unixSocket");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:21:40 +01:00
|
|
|
query = query.arg("path", path.into());
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return Socket {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-01-30 20:44:48 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Retrieves the current working directory on the host.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn workdir(&self) -> Directory {
|
|
|
|
let query = self.selection.select("workdir");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:43:12 +01:00
|
|
|
return Directory {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-19 17:43:12 +01:00
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Retrieves the current working directory on the host.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn workdir_opts<'a>(&self, opts: HostWorkdirOpts<'a>) -> Directory {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("workdir");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:49:22 +01:00
|
|
|
if let Some(exclude) = opts.exclude {
|
|
|
|
query = query.arg("exclude", exclude);
|
|
|
|
}
|
|
|
|
if let Some(include) = opts.include {
|
|
|
|
query = query.arg("include", include);
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return Directory {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
|
|
|
}
|
2023-03-19 01:01:24 +01:00
|
|
|
#[derive(Clone)]
|
2023-02-17 12:33:16 +01:00
|
|
|
pub struct HostVariable {
|
|
|
|
pub proc: Arc<Child>,
|
|
|
|
pub selection: Selection,
|
2023-03-19 01:01:24 +01:00
|
|
|
pub graphql_client: DynGraphQLClient,
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-01 16:42:50 +01:00
|
|
|
impl HostVariable {
|
2023-02-19 22:38:36 +01:00
|
|
|
/// A secret referencing the value of this variable.
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn secret(&self) -> Secret {
|
|
|
|
let query = self.selection.select("secret");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return Secret {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// The value of this variable.
|
2023-03-14 22:01:49 +01:00
|
|
|
pub async fn value(&self) -> eyre::Result<String> {
|
|
|
|
let query = self.selection.select("value");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-03-19 01:01:24 +01:00
|
|
|
query.execute(self.graphql_client.clone()).await
|
2023-01-30 20:44:48 +01:00
|
|
|
}
|
2023-02-01 15:32:38 +01:00
|
|
|
}
|
2023-03-19 01:01:24 +01:00
|
|
|
#[derive(Clone)]
|
2023-02-17 12:33:16 +01:00
|
|
|
pub struct Label {
|
|
|
|
pub proc: Arc<Child>,
|
|
|
|
pub selection: Selection,
|
2023-03-19 01:01:24 +01:00
|
|
|
pub graphql_client: DynGraphQLClient,
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-01 16:42:50 +01:00
|
|
|
impl Label {
|
2023-02-19 22:38:36 +01:00
|
|
|
/// The label name.
|
2023-03-14 22:01:49 +01:00
|
|
|
pub async fn name(&self) -> eyre::Result<String> {
|
|
|
|
let query = self.selection.select("name");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-03-19 01:01:24 +01:00
|
|
|
query.execute(self.graphql_client.clone()).await
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// The label value.
|
2023-03-14 22:01:49 +01:00
|
|
|
pub async fn value(&self) -> eyre::Result<String> {
|
|
|
|
let query = self.selection.select("value");
|
2023-02-25 00:01:18 +01:00
|
|
|
|
2023-03-19 01:01:24 +01:00
|
|
|
query.execute(self.graphql_client.clone()).await
|
2023-02-25 00:01:18 +01:00
|
|
|
}
|
|
|
|
}
|
2023-03-19 01:01:24 +01:00
|
|
|
#[derive(Clone)]
|
2023-02-25 00:01:18 +01:00
|
|
|
pub struct Port {
|
|
|
|
pub proc: Arc<Child>,
|
|
|
|
pub selection: Selection,
|
2023-03-19 01:01:24 +01:00
|
|
|
pub graphql_client: DynGraphQLClient,
|
2023-02-25 00:01:18 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
impl Port {
|
|
|
|
/// The port description.
|
2023-03-14 22:01:49 +01:00
|
|
|
pub async fn description(&self) -> eyre::Result<String> {
|
|
|
|
let query = self.selection.select("description");
|
2023-02-25 00:01:18 +01:00
|
|
|
|
2023-03-19 01:01:24 +01:00
|
|
|
query.execute(self.graphql_client.clone()).await
|
2023-02-25 00:01:18 +01:00
|
|
|
}
|
|
|
|
/// The port number.
|
2023-03-14 22:01:49 +01:00
|
|
|
pub async fn port(&self) -> eyre::Result<isize> {
|
|
|
|
let query = self.selection.select("port");
|
2023-02-25 00:01:18 +01:00
|
|
|
|
2023-03-19 01:01:24 +01:00
|
|
|
query.execute(self.graphql_client.clone()).await
|
2023-02-25 00:01:18 +01:00
|
|
|
}
|
|
|
|
/// The transport layer network protocol.
|
2023-03-14 22:01:49 +01:00
|
|
|
pub async fn protocol(&self) -> eyre::Result<NetworkProtocol> {
|
|
|
|
let query = self.selection.select("protocol");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-03-19 01:01:24 +01:00
|
|
|
query.execute(self.graphql_client.clone()).await
|
2023-01-30 20:44:48 +01:00
|
|
|
}
|
2023-02-01 16:42:50 +01:00
|
|
|
}
|
2023-03-19 01:01:24 +01:00
|
|
|
#[derive(Clone)]
|
2023-02-17 12:33:16 +01:00
|
|
|
pub struct Project {
|
|
|
|
pub proc: Arc<Child>,
|
|
|
|
pub selection: Selection,
|
2023-03-19 01:01:24 +01:00
|
|
|
pub graphql_client: DynGraphQLClient,
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-01 16:42:50 +01:00
|
|
|
impl Project {
|
2023-02-19 22:38:36 +01:00
|
|
|
/// extensions in this project
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn extensions(&self) -> Vec<Project> {
|
|
|
|
let query = self.selection.select("extensions");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return vec![Project {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
}];
|
2023-02-01 16:34:59 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Code files generated by the SDKs in the project
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn generated_code(&self) -> Directory {
|
|
|
|
let query = self.selection.select("generatedCode");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return Directory {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-01 16:42:50 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// install the project's schema
|
2023-03-14 22:01:49 +01:00
|
|
|
pub async fn install(&self) -> eyre::Result<bool> {
|
|
|
|
let query = self.selection.select("install");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-03-19 01:01:24 +01:00
|
|
|
query.execute(self.graphql_client.clone()).await
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// name of the project
|
2023-03-14 22:01:49 +01:00
|
|
|
pub async fn name(&self) -> eyre::Result<String> {
|
|
|
|
let query = self.selection.select("name");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-03-19 01:01:24 +01:00
|
|
|
query.execute(self.graphql_client.clone()).await
|
2023-02-01 16:42:50 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// schema provided by the project
|
2023-03-14 22:01:49 +01:00
|
|
|
pub async fn schema(&self) -> eyre::Result<String> {
|
|
|
|
let query = self.selection.select("schema");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-03-19 01:01:24 +01:00
|
|
|
query.execute(self.graphql_client.clone()).await
|
2023-02-01 16:42:50 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// sdk used to generate code for and/or execute this project
|
2023-03-14 22:01:49 +01:00
|
|
|
pub async fn sdk(&self) -> eyre::Result<String> {
|
|
|
|
let query = self.selection.select("sdk");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-03-19 01:01:24 +01:00
|
|
|
query.execute(self.graphql_client.clone()).await
|
2023-01-30 20:44:48 +01:00
|
|
|
}
|
|
|
|
}
|
2023-03-19 01:01:24 +01:00
|
|
|
#[derive(Clone)]
|
2023-02-05 23:44:06 +01:00
|
|
|
pub struct Query {
|
|
|
|
pub proc: Arc<Child>,
|
|
|
|
pub selection: Selection,
|
2023-03-19 01:01:24 +01:00
|
|
|
pub graphql_client: DynGraphQLClient,
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:21:40 +01:00
|
|
|
#[derive(Builder, Debug, PartialEq)]
|
2023-02-19 17:29:59 +01:00
|
|
|
pub struct QueryContainerOpts {
|
2023-02-25 01:03:24 +01:00
|
|
|
#[builder(setter(into, strip_option), default)]
|
2023-02-17 12:33:16 +01:00
|
|
|
pub id: Option<ContainerId>,
|
2023-02-25 01:03:24 +01:00
|
|
|
#[builder(setter(into, strip_option), default)]
|
2023-02-17 12:33:16 +01:00
|
|
|
pub platform: Option<Platform>,
|
|
|
|
}
|
2023-02-19 17:21:40 +01:00
|
|
|
#[derive(Builder, Debug, PartialEq)]
|
2023-02-19 17:29:59 +01:00
|
|
|
pub struct QueryDirectoryOpts {
|
2023-02-25 01:03:24 +01:00
|
|
|
#[builder(setter(into, strip_option), default)]
|
2023-02-17 12:33:16 +01:00
|
|
|
pub id: Option<DirectoryId>,
|
|
|
|
}
|
2023-02-19 17:21:40 +01:00
|
|
|
#[derive(Builder, Debug, PartialEq)]
|
2023-02-19 17:29:59 +01:00
|
|
|
pub struct QueryGitOpts {
|
2023-02-25 00:01:18 +01:00
|
|
|
/// A service which must be started before the repo is fetched.
|
2023-02-25 01:03:24 +01:00
|
|
|
#[builder(setter(into, strip_option), default)]
|
2023-02-25 00:01:18 +01:00
|
|
|
pub experimental_service_host: Option<ContainerId>,
|
2023-03-14 22:09:04 +01:00
|
|
|
/// Set to true to keep .git directory.
|
|
|
|
#[builder(setter(into, strip_option), default)]
|
|
|
|
pub keep_git_dir: Option<bool>,
|
2023-02-25 00:01:18 +01:00
|
|
|
}
|
|
|
|
#[derive(Builder, Debug, PartialEq)]
|
|
|
|
pub struct QueryHttpOpts {
|
|
|
|
/// A service which must be started before the URL is fetched.
|
2023-02-25 01:03:24 +01:00
|
|
|
#[builder(setter(into, strip_option), default)]
|
2023-02-25 00:01:18 +01:00
|
|
|
pub experimental_service_host: Option<ContainerId>,
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-02-19 17:21:40 +01:00
|
|
|
#[derive(Builder, Debug, PartialEq)]
|
|
|
|
pub struct QueryPipelineOpts<'a> {
|
2023-03-10 23:16:35 +01:00
|
|
|
/// Pipeline description.
|
2023-02-25 01:03:24 +01:00
|
|
|
#[builder(setter(into, strip_option), default)]
|
2023-02-19 17:21:40 +01:00
|
|
|
pub description: Option<&'a str>,
|
2023-03-10 23:16:35 +01:00
|
|
|
/// Pipeline labels.
|
|
|
|
#[builder(setter(into, strip_option), default)]
|
|
|
|
pub labels: Option<Vec<PipelineLabel>>,
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-02-19 17:21:40 +01:00
|
|
|
#[derive(Builder, Debug, PartialEq)]
|
2023-02-19 17:29:59 +01:00
|
|
|
pub struct QuerySocketOpts {
|
2023-02-25 01:03:24 +01:00
|
|
|
#[builder(setter(into, strip_option), default)]
|
2023-02-17 12:33:16 +01:00
|
|
|
pub id: Option<SocketId>,
|
2023-02-05 23:44:06 +01:00
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-01 16:42:50 +01:00
|
|
|
impl Query {
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Constructs a cache volume for a given cache key.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// * `key` - A string identifier to target this cache volume (e.g., "modules-cache").
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn cache_volume(&self, key: impl Into<String>) -> CacheVolume {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("cacheVolume");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:21:40 +01:00
|
|
|
query = query.arg("key", key.into());
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return CacheVolume {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-01 16:42:50 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Loads a container from ID.
|
|
|
|
/// Null ID returns an empty container (scratch).
|
2023-02-25 00:01:18 +01:00
|
|
|
/// Optional platform argument initializes new containers to execute and publish as that platform.
|
|
|
|
/// Platform defaults to that of the builder's host.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn container(&self) -> Container {
|
|
|
|
let query = self.selection.select("container");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:43:12 +01:00
|
|
|
return Container {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-19 17:43:12 +01:00
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Loads a container from ID.
|
|
|
|
/// Null ID returns an empty container (scratch).
|
2023-02-25 00:01:18 +01:00
|
|
|
/// Optional platform argument initializes new containers to execute and publish as that platform.
|
|
|
|
/// Platform defaults to that of the builder's host.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn container_opts(&self, opts: QueryContainerOpts) -> Container {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("container");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:49:22 +01:00
|
|
|
if let Some(id) = opts.id {
|
|
|
|
query = query.arg("id", id);
|
|
|
|
}
|
|
|
|
if let Some(platform) = opts.platform {
|
|
|
|
query = query.arg("platform", platform);
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-05 23:44:06 +01:00
|
|
|
return Container {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-01 16:42:50 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// The default platform of the builder.
|
2023-03-14 22:01:49 +01:00
|
|
|
pub async fn default_platform(&self) -> eyre::Result<Platform> {
|
|
|
|
let query = self.selection.select("defaultPlatform");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-03-19 01:01:24 +01:00
|
|
|
query.execute(self.graphql_client.clone()).await
|
2023-02-01 16:42:50 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Load a directory by ID. No argument produces an empty directory.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn directory(&self) -> Directory {
|
|
|
|
let query = self.selection.select("directory");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:43:12 +01:00
|
|
|
return Directory {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-19 17:43:12 +01:00
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Load a directory by ID. No argument produces an empty directory.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn directory_opts(&self, opts: QueryDirectoryOpts) -> Directory {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("directory");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:49:22 +01:00
|
|
|
if let Some(id) = opts.id {
|
|
|
|
query = query.arg("id", id);
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return Directory {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-01 16:42:50 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Loads a file by ID.
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn file(&self, id: FileId) -> File {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("file");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 15:00:00 +01:00
|
|
|
query = query.arg("id", id);
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return File {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-01 16:42:50 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Queries a git repository.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// * `url` - Url of the git repository.
|
|
|
|
/// Can be formatted as https://{host}/{owner}/{repo}, git@{host}/{owner}/{repo}
|
|
|
|
/// Suffix ".git" is optional.
|
2023-02-22 23:09:20 +01:00
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn git(&self, url: impl Into<String>) -> GitRepository {
|
2023-02-19 17:43:12 +01:00
|
|
|
let mut query = self.selection.select("git");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:43:12 +01:00
|
|
|
query = query.arg("url", url.into());
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:43:12 +01:00
|
|
|
return GitRepository {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-19 17:43:12 +01:00
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Queries a git repository.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// * `url` - Url of the git repository.
|
|
|
|
/// Can be formatted as https://{host}/{owner}/{repo}, git@{host}/{owner}/{repo}
|
|
|
|
/// Suffix ".git" is optional.
|
2023-02-22 23:09:20 +01:00
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn git_opts(&self, url: impl Into<String>, opts: QueryGitOpts) -> GitRepository {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("git");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:21:40 +01:00
|
|
|
query = query.arg("url", url.into());
|
2023-02-19 17:49:22 +01:00
|
|
|
if let Some(keep_git_dir) = opts.keep_git_dir {
|
|
|
|
query = query.arg("keepGitDir", keep_git_dir);
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-02-25 00:01:18 +01:00
|
|
|
if let Some(experimental_service_host) = opts.experimental_service_host {
|
|
|
|
query = query.arg("experimentalServiceHost", experimental_service_host);
|
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return GitRepository {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-01 16:42:50 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Queries the host environment.
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn host(&self) -> Host {
|
|
|
|
let query = self.selection.select("host");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return Host {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-01 16:42:50 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Returns a file containing an http remote url content.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// * `url` - HTTP url to get the content from (e.g., "https://docs.dagger.io").
|
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn http(&self, url: impl Into<String>) -> File {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("http");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:21:40 +01:00
|
|
|
query = query.arg("url", url.into());
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return File {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-01 16:42:50 +01:00
|
|
|
}
|
2023-02-25 00:01:18 +01:00
|
|
|
|
|
|
|
/// Returns a file containing an http remote url content.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-25 00:01:18 +01:00
|
|
|
/// * `url` - HTTP url to get the content from (e.g., "https://docs.dagger.io").
|
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn http_opts(&self, url: impl Into<String>, opts: QueryHttpOpts) -> File {
|
2023-02-25 00:01:18 +01:00
|
|
|
let mut query = self.selection.select("http");
|
|
|
|
|
|
|
|
query = query.arg("url", url.into());
|
|
|
|
if let Some(experimental_service_host) = opts.experimental_service_host {
|
|
|
|
query = query.arg("experimentalServiceHost", experimental_service_host);
|
|
|
|
}
|
|
|
|
|
|
|
|
return File {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-25 00:01:18 +01:00
|
|
|
}
|
2023-03-10 23:16:35 +01:00
|
|
|
/// Creates a named sub-pipeline.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-03-10 23:16:35 +01:00
|
|
|
/// * `name` - Pipeline name.
|
2023-02-22 23:09:20 +01:00
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn pipeline(&self, name: impl Into<String>) -> Query {
|
2023-02-19 17:43:12 +01:00
|
|
|
let mut query = self.selection.select("pipeline");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:43:12 +01:00
|
|
|
query = query.arg("name", name.into());
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:43:12 +01:00
|
|
|
return Query {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-19 17:43:12 +01:00
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-03-10 23:16:35 +01:00
|
|
|
/// Creates a named sub-pipeline.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-03-10 23:16:35 +01:00
|
|
|
/// * `name` - Pipeline name.
|
2023-02-22 23:09:20 +01:00
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn pipeline_opts<'a>(&self, name: impl Into<String>, opts: QueryPipelineOpts<'a>) -> Query {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("pipeline");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:21:40 +01:00
|
|
|
query = query.arg("name", name.into());
|
2023-02-19 17:49:22 +01:00
|
|
|
if let Some(description) = opts.description {
|
|
|
|
query = query.arg("description", description);
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-03-10 23:16:35 +01:00
|
|
|
if let Some(labels) = opts.labels {
|
|
|
|
query = query.arg("labels", labels);
|
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return Query {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-01 16:42:50 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Look up a project by name
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn project(&self, name: impl Into<String>) -> Project {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("project");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:21:40 +01:00
|
|
|
query = query.arg("name", name.into());
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return Project {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-01 16:42:50 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Loads a secret from its ID.
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn secret(&self, id: SecretId) -> Secret {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("secret");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 15:00:00 +01:00
|
|
|
query = query.arg("id", id);
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return Secret {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-01 16:42:50 +01:00
|
|
|
}
|
2023-04-03 16:39:58 +02:00
|
|
|
/// Sets a secret given a user defined name to its plaintext and returns the secret.
|
|
|
|
///
|
|
|
|
/// # Arguments
|
|
|
|
///
|
|
|
|
/// * `name` - The user defined name for this secret
|
|
|
|
/// * `plaintext` - The plaintext of the secret
|
|
|
|
pub fn set_secret(&self, name: impl Into<String>, plaintext: impl Into<String>) -> Secret {
|
|
|
|
let mut query = self.selection.select("setSecret");
|
|
|
|
|
|
|
|
query = query.arg("name", name.into());
|
|
|
|
query = query.arg("plaintext", plaintext.into());
|
|
|
|
|
|
|
|
return Secret {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
|
|
|
graphql_client: self.graphql_client.clone(),
|
|
|
|
};
|
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Loads a socket by its ID.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn socket(&self) -> Socket {
|
|
|
|
let query = self.selection.select("socket");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:43:12 +01:00
|
|
|
return Socket {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-19 17:43:12 +01:00
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 22:38:36 +01:00
|
|
|
/// Loads a socket by its ID.
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// # Arguments
|
2023-03-14 22:01:49 +01:00
|
|
|
///
|
2023-02-22 23:09:20 +01:00
|
|
|
/// * `opt` - optional argument, see inner type for documentation, use <func>_opts to use
|
2023-03-14 22:01:49 +01:00
|
|
|
pub fn socket_opts(&self, opts: QuerySocketOpts) -> Socket {
|
2023-02-17 12:33:16 +01:00
|
|
|
let mut query = self.selection.select("socket");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-19 17:49:22 +01:00
|
|
|
if let Some(id) = opts.id {
|
|
|
|
query = query.arg("id", id);
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-17 12:33:16 +01:00
|
|
|
return Socket {
|
|
|
|
proc: self.proc.clone(),
|
|
|
|
selection: query,
|
2023-03-19 01:01:24 +01:00
|
|
|
graphql_client: self.graphql_client.clone(),
|
2023-03-14 22:01:49 +01:00
|
|
|
};
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
|
|
|
}
|
2023-03-19 01:01:24 +01:00
|
|
|
#[derive(Clone)]
|
2023-02-17 12:33:16 +01:00
|
|
|
pub struct Secret {
|
|
|
|
pub proc: Arc<Child>,
|
|
|
|
pub selection: Selection,
|
2023-03-19 01:01:24 +01:00
|
|
|
pub graphql_client: DynGraphQLClient,
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-01 16:42:50 +01:00
|
|
|
impl Secret {
|
2023-02-19 22:38:36 +01:00
|
|
|
/// The identifier for this secret.
|
2023-03-14 22:01:49 +01:00
|
|
|
pub async fn id(&self) -> eyre::Result<SecretId> {
|
|
|
|
let query = self.selection.select("id");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-03-19 01:01:24 +01:00
|
|
|
query.execute(self.graphql_client.clone()).await
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-02-19 22:38:36 +01:00
|
|
|
/// The value of this secret.
|
2023-03-14 22:01:49 +01:00
|
|
|
pub async fn plaintext(&self) -> eyre::Result<String> {
|
|
|
|
let query = self.selection.select("plaintext");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-03-19 01:01:24 +01:00
|
|
|
query.execute(self.graphql_client.clone()).await
|
2023-02-01 16:42:50 +01:00
|
|
|
}
|
|
|
|
}
|
2023-03-19 01:01:24 +01:00
|
|
|
#[derive(Clone)]
|
2023-02-17 12:33:16 +01:00
|
|
|
pub struct Socket {
|
|
|
|
pub proc: Arc<Child>,
|
|
|
|
pub selection: Selection,
|
2023-03-19 01:01:24 +01:00
|
|
|
pub graphql_client: DynGraphQLClient,
|
2023-02-17 12:33:16 +01:00
|
|
|
}
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-02-01 16:42:50 +01:00
|
|
|
impl Socket {
|
2023-02-19 22:38:36 +01:00
|
|
|
/// The content-addressed identifier of the socket.
|
2023-03-14 22:01:49 +01:00
|
|
|
pub async fn id(&self) -> eyre::Result<SocketId> {
|
|
|
|
let query = self.selection.select("id");
|
2023-02-22 23:09:20 +01:00
|
|
|
|
2023-03-19 01:01:24 +01:00
|
|
|
query.execute(self.graphql_client.clone()).await
|
2023-02-01 16:42:50 +01:00
|
|
|
}
|
|
|
|
}
|
2023-02-25 00:05:46 +01:00
|
|
|
#[derive(Serialize, Deserialize, Clone, PartialEq, Debug)]
|
2023-02-19 12:16:48 +01:00
|
|
|
pub enum CacheSharingMode {
|
2023-03-14 21:49:30 +01:00
|
|
|
LOCKED,
|
2023-03-14 22:01:01 +01:00
|
|
|
PRIVATE,
|
|
|
|
SHARED,
|
2023-02-25 00:01:18 +01:00
|
|
|
}
|
2023-02-25 00:05:46 +01:00
|
|
|
#[derive(Serialize, Deserialize, Clone, PartialEq, Debug)]
|
2023-02-25 00:01:18 +01:00
|
|
|
pub enum NetworkProtocol {
|
2023-03-10 23:39:23 +01:00
|
|
|
TCP,
|
2023-03-13 20:26:13 +01:00
|
|
|
UDP,
|
2023-02-19 12:16:48 +01:00
|
|
|
}
|