1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312
#![forbid(missing_docs)]
//! Binary `hc-dna` command executable.
use holochain_types::prelude::{AppManifest, DnaManifest, ValidatedDnaManifest};
use holochain_types::web_app::WebAppManifest;
use holochain_util::ffs;
use mr_bundle::Manifest;
use std::path::Path;
use std::path::PathBuf;
use structopt::StructOpt;
use crate::error::HcBundleResult;
/// The file extension to use for DNA bundles
pub const DNA_BUNDLE_EXT: &str = "dna";
/// The file extension to use for hApp bundles
pub const APP_BUNDLE_EXT: &str = "happ";
/// The file extension to use for Web-hApp bundles
pub const WEB_APP_BUNDLE_EXT: &str = "webhapp";
/// Work with Holochain DNA bundles
#[derive(Debug, StructOpt)]
pub enum HcDnaBundle {
/// Create a new, empty Holochain DNA bundle working directory and create a new
/// sample `dna.yaml` manifest inside.
/// .
Init {
/// The path to create the working directory
path: PathBuf,
},
/// Pack into the `[name].dna` bundle according to the `dna.yaml` manifest,
/// found inside the working directory. The `[name]` is taken from the `name`
/// property of the manifest file.
///
/// e.g.:
///
/// $ hc dna pack ./some/directory/foo
///
/// creates a file `./some/directory/foo/[name].dna`, based on
/// `./some/directory/foo/dna.yaml`
Pack {
/// The path to the working directory containing a `dna.yaml` manifest
path: std::path::PathBuf,
/// Specify the output path for the packed bundle file
///
/// If not specified, the `[name].dna` bundle will be placed inside the
/// provided working directory.
#[structopt(short = "o", long)]
output: Option<PathBuf>,
},
/// Unpack parts of the `.dna` bundle file into a specific directory.
///
/// e.g.:
///
/// $ hc dna unpack ./some/dir/my-dna.dna
///
/// creates a new directory `./some/dir/my-dna`, containining a new `dna.yaml`
/// manifest
// #[structopt(short = "u", long)]
Unpack {
/// The path to the bundle to unpack
path: std::path::PathBuf,
/// Specify the directory for the unpacked content
///
/// If not specified, the directory will be placed alongside the
/// bundle file, with the same name as the bundle file name.
#[structopt(short = "o", long)]
output: Option<PathBuf>,
/// Overwrite an existing directory, if one exists
#[structopt(short = "f", long)]
force: bool,
},
}
/// Work with Holochain hApp bundles
#[derive(Debug, StructOpt)]
pub enum HcAppBundle {
/// Create a new, empty Holochain app (hApp) working directory and create a new
/// sample `happ.yaml` manifest inside.
Init {
/// The path to create the working directory
path: PathBuf,
},
/// Pack into the `[name].happ` bundle according to the `happ.yaml` manifest,
/// found inside the working directory. The `[name]` is taken from the `name`
/// property of the manifest file.
///
/// e.g.:
///
/// $ hc app pack ./some/directory/foo
///
/// creates a file `./some/directory/foo/[name].happ`, based on
/// `./some/directory/foo/happ.yaml`
Pack {
/// The path to the working directory containing a `happ.yaml` manifest
path: std::path::PathBuf,
/// Specify the output path for the packed bundle file
///
/// If not specified, the `[name].happ` bundle will be placed inside the
/// provided working directory.
#[structopt(short = "o", long)]
output: Option<PathBuf>,
},
/// Unpack parts of the `.happ` bundle file into a specific directory.
///
/// e.g.:
///
/// $ hc app unpack ./some/dir/my-app.happ
///
/// creates a new directory `./some/dir/my-app`, containining a new `happ.yaml`
/// manifest
// #[structopt(short = "u", long)]
Unpack {
/// The path to the bundle to unpack
path: std::path::PathBuf,
/// Specify the directory for the unpacked content
///
/// If not specified, the directory will be placed alongside the
/// bundle file, with the same name as the bundle file name.
#[structopt(short = "o", long)]
output: Option<PathBuf>,
/// Overwrite an existing directory, if one exists
#[structopt(short = "f", long)]
force: bool,
},
}
/// Work with Holochain Web-hApp bundles
#[derive(Debug, StructOpt)]
pub enum HcWebAppBundle {
/// Create a new, empty Holochain web app working directory and create a new
/// sample `web-happ.yaml` manifest inside.
Init {
/// The path to create the working directory
path: PathBuf,
},
/// Pack into the `[name].webhapp` bundle according to the `web-happ.yaml` manifest,
/// found inside the working directory. The `[name]` is taken from the `name`
/// property of the manifest file.
///
/// e.g.:
///
/// $ hc web-app pack ./some/directory/foo
///
/// creates a file `./some/directory/foo/[name].webhapp`, based on
/// `./some/directory/foo/web-happ.yaml`
Pack {
/// The path to the working directory containing a `web-happ.yaml` manifest
path: std::path::PathBuf,
/// Specify the output path for the packed bundle file
///
/// If not specified, the `[name].webhapp` bundle will be placed inside the
/// provided working directory.
#[structopt(short = "o", long)]
output: Option<PathBuf>,
},
/// Unpack parts of the `.webhapp` bundle file into a specific directory.
///
/// e.g.:
///
/// $ hc web-app unpack ./some/dir/my-app.webhapp
///
/// creates a new directory `./some/dir/my-app`, containining a new `web-happ.yaml`
/// manifest
// #[structopt(short = "u", long)]
Unpack {
/// The path to the bundle to unpack
path: std::path::PathBuf,
/// Specify the directory for the unpacked content
///
/// If not specified, the directory will be placed alongside the
/// bundle file, with the same name as the bundle file name.
#[structopt(short = "o", long)]
output: Option<PathBuf>,
/// Overwrite an existing directory, if one exists
#[structopt(short = "f", long)]
force: bool,
},
}
impl HcDnaBundle {
/// Run this command
pub async fn run(self) -> anyhow::Result<()> {
match self {
Self::Init { path } => {
crate::init::init_dna(path).await?;
}
Self::Pack { path, output } => {
let name = get_dna_name(&path).await?;
let (bundle_path, _) =
crate::packing::pack::<ValidatedDnaManifest>(&path, output, name).await?;
println!("Wrote bundle {}", bundle_path.to_string_lossy());
}
Self::Unpack {
path,
output,
force,
} => {
let dir_path = crate::packing::unpack::<ValidatedDnaManifest>(
DNA_BUNDLE_EXT,
&path,
output,
force,
)
.await?;
println!("Unpacked to directory {}", dir_path.to_string_lossy());
}
}
Ok(())
}
}
impl HcAppBundle {
/// Run this command
pub async fn run(self) -> anyhow::Result<()> {
match self {
Self::Init { path } => {
crate::init::init_app(path).await?;
}
Self::Pack { path, output } => {
let name = get_app_name(&path).await?;
let (bundle_path, _) =
crate::packing::pack::<AppManifest>(&path, output, name).await?;
println!("Wrote bundle {}", bundle_path.to_string_lossy());
}
Self::Unpack {
path,
output,
force,
} => {
let dir_path =
crate::packing::unpack::<AppManifest>(APP_BUNDLE_EXT, &path, output, force)
.await?;
println!("Unpacked to directory {}", dir_path.to_string_lossy());
}
}
Ok(())
}
}
impl HcWebAppBundle {
/// Run this command
pub async fn run(self) -> anyhow::Result<()> {
match self {
Self::Init { path } => {
crate::init::init_web_app(path).await?;
}
Self::Pack { path, output } => {
let name = get_web_app_name(&path).await?;
let (bundle_path, _) =
crate::packing::pack::<WebAppManifest>(&path, output, name).await?;
println!("Wrote bundle {}", bundle_path.to_string_lossy());
}
Self::Unpack {
path,
output,
force,
} => {
let dir_path = crate::packing::unpack::<WebAppManifest>(
WEB_APP_BUNDLE_EXT,
&path,
output,
force,
)
.await?;
println!("Unpacked to directory {}", dir_path.to_string_lossy());
}
}
Ok(())
}
}
async fn get_dna_name(manifest_path: &Path) -> HcBundleResult<String> {
let manifest_path = manifest_path.to_path_buf();
let manifest_path = manifest_path.join(&ValidatedDnaManifest::path());
let manifest_yaml = ffs::read_to_string(&manifest_path).await?;
let manifest: DnaManifest = serde_yaml::from_str(&manifest_yaml)?;
Ok(manifest.name())
}
async fn get_app_name(manifest_path: &Path) -> HcBundleResult<String> {
let manifest_path = manifest_path.to_path_buf();
let manifest_path = manifest_path.join(&AppManifest::path());
let manifest_yaml = ffs::read_to_string(&manifest_path).await?;
let manifest: AppManifest = serde_yaml::from_str(&manifest_yaml)?;
Ok(manifest.app_name().to_string())
}
async fn get_web_app_name(manifest_path: &Path) -> HcBundleResult<String> {
let manifest_path = manifest_path.to_path_buf();
let manifest_path = manifest_path.join(&WebAppManifest::path());
let manifest_yaml = ffs::read_to_string(&manifest_path).await?;
let manifest: WebAppManifest = serde_yaml::from_str(&manifest_yaml)?;
Ok(manifest.app_name().to_string())
}