Struct cage::Project

pub struct Project { /* fields omitted */ }

A cage project, which is represented as a directory containing a pods subdirectory.

Implementations

impl Project

pub fn from_current_dir() -> Result<Project>

Create a Project using the pre-existing project files in the current directory as input and the .cage subdirectory as output.

pub fn name(&self) -> &str

The name of this project. This defaults to the name of the current directory.

pub fn set_name(&mut self, name: &str) -> &mut Project

Set the name of this project. This should be done before calling output or any methods in cmd.

pub fn compose_name(&self) -> String

Get that name that docker_compose would use for this project.

pub fn root_dir(&self) -> &Path

The root directory of this project.

pub fn src_dir(&self) -> &Path

The source directory of this project, where we can put cloned git repositories, and where our local source trees are typically found.

pub fn output_dir(&self) -> &Path

The output directory of this project. Normally .cage inside the root_dir, but it may be targetn.

pub fn pods_dir(&self) -> PathBuf

The directory in which are pods are defined, and relative to which all docker-compose.yml paths should be interpreted.

pub fn output_pods_dir(&self) -> PathBuf

The path relative to which our pods will be output. This can be joined with Pod::rel_path to get an output path for a specific pod.

pub fn pods(&self) -> Pods<'_>

Iterate over all pods in this project.

pub fn pod(&self, name: &str) -> Option<&Pod>

Look up the named pod.

pub fn service<'a>(&self, name: &'a str) -> Option<(&Pod, &str)>

Look up the named service. Returns the pod containing the service and the name of the service within that pod.

pub fn service_or_err<'a>(&self, name: &'a str) -> Result<(&Pod, &str)>

Like service, but returns an error if the service is unknown.

pub fn pod_or_service<'a, 'b>(
    &'a self,
    name: &'b str
) -> Option<PodOrService<'a>>

Look for a name as a pod first, and if that fails, look for it as a service.

pub fn pod_or_service_or_err<'a, 'b>(
    &'a self,
    name: &'b str
) -> Result<PodOrService<'a>>

Like pod_or_service, but returns an error if no pod or service of that name can be found.

pub fn targets(&self) -> Targets<'_>

Iterate over all targets in this project.

pub fn target(&self, name: &str) -> Option<&Target>

Look up the named target. We name this function target instead of target to avoid a keyword clash.

pub fn target_or_err(&self, name: &str) -> Result<&Target>

Like target, but returns an error if no each target is found.

pub fn current_target(&self) -> &Target

Get the current target that we're using with this project.

pub fn set_current_target_name(&mut self, name: &str) -> Result<()>

Set the name of the target to use. This must be done before calling output or export.

pub fn sources(&self) -> &Sources

Return the collection of source trees associated with this project, including both extern git repositories and local source trees.

pub fn sources_mut(&mut self) -> &mut Sources

Return the collection of source trees associated with this project in mutable form.

pub fn hooks(&self) -> &HookManager

Get our available hooks.

pub fn default_tags(&self) -> Option<&DefaultTags>

Get the default tags associated with this project, if any.

pub fn set_default_tags(&mut self, tags: DefaultTags) -> &mut Project

Set the default tags associated with this project.

pub fn plugins(&self) -> &Manager

Our plugin manager.

pub fn save_settings(&mut self) -> Result<()>

Save persistent project settings to disk.

pub fn enabled_pods_that_are_not_running(&self) -> Result<Vec<&Pod>>

Find all enabled pods which do not appear to be running.

pub fn output(&self, subcommand: &str) -> Result<()>

Delete our existing output and replace it with a processed and expanded version of our pod definitions.

pub fn export(&self, export_dir: &Path) -> Result<()>

Export this project (with the specified target applied) as a set of standalone *.yml files with no environment variable interpolations and no external dependencies.

Trait Implementations

impl CommandCompose for Project

fn compose<CR>(
    &self,
    runner: &CR,
    command: &str,
    act_on: &ActOn,
    opts: &dyn ToArgs
) -> Result<()> where
    CR: CommandRunner, 

Pass simple commands directly through to docker-compose.

fn compose_pod<CR>(
    &self,
    runner: &CR,
    command: &str,
    pod: &Pod,
    opts: &dyn ToArgs
) -> Result<()> where
    CR: CommandRunner, 

Run a docker-compose command on a single pod. If the pod is disabled, this does nothing.

fn compose_service<CR>(
    &self,
    runner: &CR,
    command: &str,
    pod: &Pod,
    service_name: &str,
    opts: &dyn ToArgs
) -> Result<()> where
    CR: CommandRunner, 

Run a docker-compose command on a single service. If the pod is disabled, this does nothing.

impl CommandExec for Project

fn exec<CR>(
    &self,
    runner: &CR,
    service_name: &str,
    command: &Command,
    opts: &Exec
) -> Result<()> where
    CR: CommandRunner, 

Exectute a command inside a running container. Even though we package up most of our arguments into structs, we still have a ridiculous number of arguments.

fn shell<CR>(&self, runner: &CR, service_name: &str, opts: &Exec) -> Result<()> where
    CR: CommandRunner, 

Execute an interactive shell inside a running container.

impl CommandGenerate for Project

fn generate_new(parent_dir: &Path, name: &str) -> Result<PathBuf>

Create a new project skeleton, returning the path of the generated project.

fn generate_list(&self) -> Result<()>

Print our all available generators (excluding the generate_new generator).

fn generate(&self, name: &str) -> Result<()>

Run the specified generator.

impl CommandLogs for Project

fn logs<CR>(&self, runner: &CR, act_on: &ActOn, opts: &Logs) -> Result<()> where
    CR: CommandRunner, 

Display logs for a given service

impl CommandPull for Project

fn pull<CR>(&self, runner: &CR, act_on: &ActOn) -> Result<()> where
    CR: CommandRunner, 

Pull all the images associated with a project.

impl CommandRun for Project

fn run<CR>(
    &self,
    runner: &CR,
    service: &str,
    command: Option<&Command>,
    opts: &Run
) -> Result<()> where
    CR: CommandRunner, 

Run a specific pod as a one-shot task.

fn test<CR>(
    &self,
    runner: &CR,
    service_name: &str,
    command: Option<&Command>
) -> Result<()> where
    CR: CommandRunner, 

Execute tests inside a fresh container.

impl CommandRunScript for Project

fn run_script<CR>(
    &self,
    runner: &CR,
    act_on: &ActOn,
    script_name: &str,
    opts: &Run
) -> Result<()> where
    CR: CommandRunner, 

Run a named script on all matching services

impl CommandSource for Project

fn source_list<CR>(&self, _runner: &CR) -> Result<()> where
    CR: CommandRunner, 

List all the source trees associated with a project.

fn source_clone<CR>(&mut self, runner: &CR, alias: &str) -> Result<()> where
    CR: CommandRunner, 

Clone the specified source tree.

fn source_set_mounted<CR>(
    &mut self,
    runner: &CR,
    acts_on_sources: ActOnSources,
    mounted: bool
) -> Result<()> where
    CR: CommandRunner, 

Set the mounted flag on the specified source tree.

impl CommandStatus for Project

fn status<CR>(&self, _runner: &CR, act_on: &ActOn) -> Result<()> where
    CR: CommandRunner, 

Get the current status of the project. This is eventually intended to include a fair bit of detail.

impl CommandUp for Project

fn up<CR>(&self, runner: &CR, act_on: &ActOn, opts: &Up) -> Result<()> where
    CR: CommandRunner, 

Up all the images in the specified pods.

fn init_pod<CR>(&self, runner: &CR, pod: &Pod) -> Result<()> where
    CR: CommandRunner, 

Run the initialization functions for the specified pod.

impl Debug for Project

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Serialize for Project

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.