Skip to content

feat: init product command for patchable #1112

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
May 15, 2025
Merged

feat: init product command for patchable #1112

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
618159c
feat: init product command for patchable
dervoeti May 9, 2025
ad6a1ad
Update rust/patchable/src/main.rs
dervoeti May 14, 2025
c623c31
chore: un-nest match blocks
dervoeti May 14, 2025
74ff55d
chore: rename InitType to InitCmd
dervoeti May 14, 2025
06e6acd
feat: allow explicitly empty mirror URLs
dervoeti May 14, 2025
2d25ab7
Merge branch 'main' into feat/patchable-init-product-command
dervoeti May 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions rust/patchable/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,21 +48,21 @@ The version-level config contains:

### Template

If you're adding a completely new product, you need to create the product-level config once:
If you're adding a completely new product, you need to initialize the product-level config once using patchable:

```toml
# docker-images/druid/stackable/patches/patchable.toml
upstream = "https://github.com/apache/druid.git"
mirror = "https://github.com/stackabletech/druid.git"
```sh
cargo patchable init product druid --upstream https://github.com/apache/druid.git --default-mirror https://github.com/stackabletech/druid.git
```

This will create the product-level configuration in `docker-images/druid/stackable/patches/patchable.toml`.

If you just want to add a new version, initialize the version-level config with patchable:

```sh
cargo patchable init druid 28.0.0 --base=druid-28.0.0 --mirror
cargo patchable init version druid 28.0.0 --base druid-28.0.0 --mirror
```

This will initialize the version-level config with the base commit hash and the default mirror URL from the product-level config.
This will initialize the version-level config in `docker-images/druid/stackable/patches/28.0.0/patchable.toml` with the base commit hash and the default mirror URL from the product-level config.
You can optionally provide the `--ssh` flag to use SSH instead of HTTPS for Git operations.

## Glossary
Expand Down
301 changes: 187 additions & 114 deletions rust/patchable/src/main.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ struct ProductConfig {
///
/// This value is _not_ used by `checkout`, that uses [`ProductVersionConfig::mirror`] instead.
/// `init --mirror` copies this value into [`ProductVersionConfig::mirror`].
#[serde(skip_serializing_if = "Option::is_none")]
default_mirror: Option<String>,
}

Expand Down Expand Up @@ -180,24 +181,10 @@ enum Cmd {
pv: ProductVersion,
},

/// Creates a patchable.toml for a given product version
/// Creates patchable.toml configuration files
Init {
#[clap(flatten)]
pv: ProductVersion,

/// The upstream commit-ish (such as druid-28.0.0) that the patch series applies to
///
/// Refs (such as tags and branches) will be resolved to commit IDs.
#[clap(long)]
base: String,

/// Mirror the product version to the default mirror repository
#[clap(long)]
mirror: bool,

/// Use SSH for git operations
#[clap(long)]
ssh: bool,
#[clap(subcommand)]
init_type: InitType,
},

/// Shows the patch directory for a given product version
Expand All @@ -218,6 +205,41 @@ enum Cmd {
ImagesDir,
}

#[derive(clap::Parser)]
enum InitType {
/// Creates a patchable.toml for a given product
Product {
/// The product name slug (such as druid)
product: String,
/// The upstream repository URL (e.g. https://github.com/apache/druid.git)
#[clap(long)]
upstream: String,
/// The default mirror repository URL (e.g. https://github.com/stackabletech/druid.git)
#[clap(long)]
default_mirror: Option<String>,
},

/// Creates a patchable.toml for a given product version
Version {
#[clap(flatten)]
pv: ProductVersion,

/// The upstream commit-ish (such as druid-28.0.0) that the patch series applies to
///
/// Refs (such as tags and branches) will be resolved to commit IDs.
#[clap(long)]
base: String,

/// Mirror the product version to the default mirror repository
#[clap(long)]
mirror: bool,

/// Use SSH for git operations
#[clap(long)]
ssh: bool,
},
}

#[derive(Debug, Snafu)]
pub enum Error {
#[snafu(display("failed to configure git logging"))]
Expand Down Expand Up @@ -474,116 +496,167 @@ fn main() -> Result<()> {
);
}

Cmd::Init {
pv,
base,
mirror,
ssh,
} => {
let ctx = ProductVersionContext {
pv,
images_repo_root,
};
Cmd::Init { init_type } => match init_type {
InitType::Product {
product,
upstream,
default_mirror,
} => {
let product_config_path = ProductVersionContext {
pv: ProductVersion {
product: product.clone(),
version: "".to_string(),
},
images_repo_root,
}
.product_config_path();

let product_repo_root = ctx.product_repo();
let product_repo = tracing::info_span!(
"finding product repository",
product.repository = ?product_repo_root,
)
.in_scope(|| repo::ensure_bare_repo(&product_repo_root))
.context(OpenProductRepoForCheckoutSnafu)?;
tracing::info!(
path = ?product_config_path,
"creating product configuration directory and file"
);

let config = ctx.load_product_config()?;
let upstream = if ssh {
utils::rewrite_git_https_url_to_ssh(&config.upstream).context(UrlRewriteSnafu)?
} else {
config.upstream
};
let product_config_dir = product_config_path
.parent()
.expect("product config should have a hard-coded parent");

std::fs::create_dir_all(product_config_dir).context(CreatePatchDirSnafu {
path: product_config_dir,
})?;

// --base can be a reference, but patchable.toml should always have a resolved commit id,
// so that it cannot be changed under our feet (without us knowing so, anyway...).
tracing::info!(?base, "resolving base commit-ish");
let base_commit = repo::resolve_and_fetch_commitish(&product_repo, &base, &upstream)
.context(FetchBaseCommitSnafu)?;
tracing::info!(?base, base.commit = ?base_commit, "resolved base commit");

let mirror_url = if mirror {
let mut mirror_url = config
.default_mirror
.context(InitMirrorNotConfiguredSnafu)?;
if ssh {
mirror_url =
utils::rewrite_git_https_url_to_ssh(&mirror_url).context(UrlRewriteSnafu)?
let product_config = ProductConfig {
upstream,
default_mirror,
};
// Add mirror remote
let mut mirror_remote =
product_repo
.remote_anonymous(&mirror_url)
.context(AddMirrorRemoteSnafu {
url: mirror_url.clone(),
})?;

// Push the base commit to the mirror
tracing::info!(commit = %base_commit, base = base, url = mirror_url, "pushing commit to mirror");
let mut callbacks = setup_git_credentials();
let config_toml =
toml::to_string_pretty(&product_config).context(SerializeConfigSnafu)?;
File::create_new(&product_config_path)
.and_then(|mut f| f.write_all(config_toml.as_bytes()))
.context(SaveConfigSnafu {
path: &product_config_path,
})?;

tracing::info!(
config.path = ?product_config_path,
product = product,
"created configuration for product"
);
}

// Add progress tracking for push operation
let (span_push, mut quant_push) =
utils::setup_progress_tracking(tracing::info_span!("pushing"));
let _ = span_push.enter();
InitType::Version {
pv,
base,
mirror,
ssh,
} => {
let ctx = ProductVersionContext {
pv,
images_repo_root,
};

callbacks.push_transfer_progress(move |current, total, _| {
if total > 0 {
quant_push.update_span_progress(current, total, &span_push);
}
});
let product_repo_root = ctx.product_repo();
let product_repo = tracing::info_span!(
"finding product repository",
product.repository = ?product_repo_root,
)
.in_scope(|| repo::ensure_bare_repo(&product_repo_root))
.context(OpenProductRepoForCheckoutSnafu)?;

let mut push_options = git2::PushOptions::new();
push_options.remote_callbacks(callbacks);
let config = ctx.load_product_config()?;
let upstream = if ssh {
utils::rewrite_git_https_url_to_ssh(&config.upstream)
.context(UrlRewriteSnafu)?
} else {
config.upstream
};

// Always push the commit as a Git tag named like the value of `base`
let refspec = format!("{base_commit}:refs/tags/{base}");
tracing::info!(refspec, "constructed push refspec");
// --base can be a reference, but patchable.toml should always have a resolved commit id,
// so that it cannot be changed under our feet (without us knowing so, anyway...).
tracing::info!(?base, "resolving base commit-ish");
let base_commit =
repo::resolve_and_fetch_commitish(&product_repo, &base, &upstream)
.context(FetchBaseCommitSnafu)?;
tracing::info!(?base, base.commit = ?base_commit, "resolved base commit");

let mirror_url = if mirror {
let mut mirror_url = config
.default_mirror
.context(InitMirrorNotConfiguredSnafu)?;
if ssh {
mirror_url = utils::rewrite_git_https_url_to_ssh(&mirror_url)
.context(UrlRewriteSnafu)?
};
// Add mirror remote
let mut mirror_remote = product_repo.remote_anonymous(&mirror_url).context(
AddMirrorRemoteSnafu {
url: mirror_url.clone(),
},
)?;

// Push the base commit to the mirror
tracing::info!(commit = %base_commit, base = base, url = mirror_url, "pushing commit to mirror");
let mut callbacks = setup_git_credentials();

// Add progress tracking for push operation
let (span_push, mut quant_push) =
utils::setup_progress_tracking(tracing::info_span!("pushing"));
let _ = span_push.enter();

callbacks.push_transfer_progress(move |current, total, _| {
if total > 0 {
quant_push.update_span_progress(current, total, &span_push);
}
});

let mut push_options = git2::PushOptions::new();
push_options.remote_callbacks(callbacks);

// Always push the commit as a Git tag named like the value of `base`
let refspec = format!("{base_commit}:refs/tags/{base}");
tracing::info!(refspec, "constructed push refspec");

mirror_remote
.push(&[&refspec], Some(&mut push_options))
.context(PushToMirrorSnafu {
url: &mirror_url,
refspec: &refspec,
commit: base_commit,
})?;

mirror_remote
.push(&[&refspec], Some(&mut push_options))
.context(PushToMirrorSnafu {
url: &mirror_url,
refspec: &refspec,
commit: base_commit,
})?;
tracing::info!("successfully pushed base ref to mirror");
Some(mirror_url)
} else {
tracing::warn!(
"this version is not mirrored, re-run with --mirror before merging into main"
);
None
};

tracing::info!("successfully pushed base ref to mirror");
Some(mirror_url)
} else {
tracing::warn!(
"this version is not mirrored, re-run with --mirror before merging into main"
);
None
};
tracing::info!("saving version-level configuration");
let config = ProductVersionConfig {
base: base_commit,
mirror: mirror_url,
};
let config_path = ctx.version_config_path();
if let Some(config_dir) = config_path.parent() {
std::fs::create_dir_all(config_dir)
.context(CreatePatchDirSnafu { path: config_dir })?;
}

tracing::info!("saving version-level configuration");
let config = ProductVersionConfig {
base: base_commit,
mirror: mirror_url,
};
let config_path = ctx.version_config_path();
if let Some(config_dir) = config_path.parent() {
std::fs::create_dir_all(config_dir)
.context(CreatePatchDirSnafu { path: config_dir })?;
}
let config_toml = toml::to_string_pretty(&config).context(SerializeConfigSnafu)?;
File::create_new(&config_path)
.and_then(|mut f| f.write_all(config_toml.as_bytes()))
.context(SaveConfigSnafu { path: &config_path })?;
let config_toml = toml::to_string_pretty(&config).context(SerializeConfigSnafu)?;
File::create_new(&config_path)
.and_then(|mut f| f.write_all(config_toml.as_bytes()))
.context(SaveConfigSnafu { path: &config_path })?;

tracing::info!(
config.path = ?config_path,
product = ctx.pv.product,
version = ctx.pv.version,
"created configuration for product version"
);
}
tracing::info!(
config.path = ?config_path,
product = ctx.pv.product,
version = ctx.pv.version,
"created configuration for product version"
);
}
},

Cmd::PatchDir { pv } => {
let ctx = ProductVersionContext {
Expand Down