Skip to content
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

fix: sanitize helm version string by removing leading 'v' characters #25

Merged
merged 5 commits into from
Sep 4, 2024
Merged

fix: sanitize helm version string by removing leading 'v' characters #25

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4d33d9d
fix: sanitize helm version string by removing leading 'v' characters
Sep 4, 2024
df4d2ce
fix: trim white spaces first, then leading v's
Sep 4, 2024
085bace
satisfy rustfmt
Sep 4, 2024
a1fbd2e
satisfy clippy
Sep 4, 2024
0986eba
satisfy rustfmt again
Sep 4, 2024
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
66 changes: 44 additions & 22 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,29 +77,29 @@ impl InstallArg {

pub fn install(&self) -> Command {
let mut command = Command::new("helm");
command.args(&["install", &self.name, &self.chart]);
command.args(["install", &self.name, &self.chart]);
self.apply_args(&mut command);
command
}

pub fn upgrade(&self) -> Command {
let mut command = Command::new("helm");
command.args(&["upgrade", "--install", &self.name, &self.chart]);
command.args(["upgrade", "--install", &self.name, &self.chart]);
self.apply_args(&mut command);
command
}

fn apply_args(&self, command: &mut Command) {
if let Some(namespace) = &self.namespace {
command.args(&["--namespace", namespace]);
command.args(["--namespace", namespace]);
}

if self.develop {
command.arg("--devel");
}

if let Some(version) = &self.version {
command.args(&["--version", version]);
command.args(["--version", version]);
}

for value_path in &self.values {
Expand All @@ -115,18 +115,18 @@ impl InstallArg {
impl From<InstallArg> for Command {
fn from(arg: InstallArg) -> Self {
let mut command = Command::new("helm");
command.args(&["install", &arg.name, &arg.chart]);
command.args(["install", &arg.name, &arg.chart]);

if let Some(namespace) = &arg.namespace {
command.args(&["--namespace", namespace]);
command.args(["--namespace", namespace]);
}

if arg.develop {
command.arg("--devel");
}

if let Some(version) = &arg.version {
command.args(&["--version", version]);
command.args(["--version", version]);
}

for value_path in &arg.values {
Expand Down Expand Up @@ -190,17 +190,17 @@ impl UninstallArg {
impl From<UninstallArg> for Command {
fn from(arg: UninstallArg) -> Self {
let mut command = Command::new("helm");
command.args(&["uninstall", &arg.release]);
command.args(["uninstall", &arg.release]);

if let Some(namespace) = &arg.namespace {
command.args(&["--namespace", namespace]);
command.args(["--namespace", namespace]);
}

if arg.dry_run {
command.arg("--dry-run");
}

for timeout in &arg.timeout {
if let Some(timeout) = arg.timeout {
command.arg("--timeout").arg(timeout);
}

Expand Down Expand Up @@ -270,15 +270,15 @@ impl HelmClient {
#[instrument(skip(self))]
pub fn repo_add(&self, chart: &str, location: &str) -> Result<(), HelmError> {
Command::new("helm")
.args(&["repo", "add", chart, location])
.args(["repo", "add", chart, location])
.result()?;
Ok(())
}

/// Updates the local helm repository
#[instrument(skip(self))]
pub fn repo_update(&self) -> Result<(), HelmError> {
Command::new("helm").args(&["repo", "update"]).result()?;
Command::new("helm").args(["repo", "update"]).result()?;
Ok(())
}

Expand All @@ -287,9 +287,9 @@ impl HelmClient {
pub fn search_repo(&self, chart: &str, version: &str) -> Result<Vec<Chart>, HelmError> {
let mut command = Command::new("helm");
command
.args(&["search", "repo", chart])
.args(&["--version", version])
.args(&["--output", "json"]);
.args(["search", "repo", chart])
.args(["--version", version])
.args(["--output", "json"]);

let output = command.result()?;

Expand All @@ -302,9 +302,9 @@ impl HelmClient {
pub fn versions(&self, chart: &str) -> Result<Vec<Chart>, HelmError> {
let mut command = Command::new("helm");
command
.args(&["search", "repo"])
.args(&["--versions", chart])
.args(&["--output", "json", "--devel"]);
.args(["search", "repo"])
.args(["--versions", chart])
.args(["--output", "json", "--devel"]);
let output = command.result()?;

check_helm_stderr(output.stderr)?;
Expand Down Expand Up @@ -340,11 +340,11 @@ impl HelmClient {

match namespace {
Some(ns) => {
command.args(&["--namespace", ns]);
command.args(["--namespace", ns]);
}
None => {
// Search all namespaces
command.args(&["-A"]);
command.args(["-A"]);
}
}

Expand All @@ -362,10 +362,18 @@ impl HelmClient {
.output()
.map_err(HelmError::HelmNotInstalled)?;
let version_text = String::from_utf8(helm_version.stdout).map_err(HelmError::Utf8Error)?;
Ok(version_text[1..].trim().to_string())
Ok(sanitize_helm_version_string(&version_text))
}
}

/// Sanitize the version string returned by helm
///
/// Returns a sanitized version text parseable by the semver crate
fn sanitize_helm_version_string(version_text: &str) -> String {
// Helm version strings may come with leading 'v' or without. Strip it, if it exists.
version_text.trim().trim_start_matches('v').to_string()
}

/// Check for errors in Helm's stderr output
///
/// Returns `Ok(())` if everything is fine, or `HelmError` if something is wrong
Expand Down Expand Up @@ -426,9 +434,23 @@ mod tests {
serde_json::from_slice(JSON_RESPONSE.as_bytes()).expect("can not parse json");
assert_eq!(installed_charts.len(), 1);
let test_chart = installed_charts
.get(0)
.first()
.expect("can not grab the first result");
assert_eq!(test_chart.name, "test_chart");
assert_eq!(test_chart.chart, "test_chart-1.2.32-rc2");
}

#[test]
fn test_sanitize_version_string() {
// As reported by most (?) helm versions
assert_eq!(
&sanitize_helm_version_string("v3.15.4+gfa9efb0"),
"3.15.4+gfa9efb0"
);
// As reported by helm on Fedora 40
assert_eq!(
&sanitize_helm_version_string("3.15.4+gfa9efb0"),
"3.15.4+gfa9efb0"
);
}
}
Loading