use crate::{
config::package::GENERIC_VERSION_REGEX,
forge::request::FileChange,
result::Result,
updater::{
generic::updater::GenericUpdater, manager::UpdaterPackage,
traits::PackageUpdater,
},
};
pub struct SetupCfg {}
impl SetupCfg {
pub fn new() -> Self {
Self {}
}
}
impl Default for SetupCfg {
fn default() -> Self {
SetupCfg::new()
}
}
impl PackageUpdater for SetupCfg {
fn update(
&self,
package: &UpdaterPackage,
_workspace_packages: &[UpdaterPackage],
) -> Result<Option<Vec<FileChange>>> {
let mut file_changes: Vec<FileChange> = vec![];
for manifest in package.manifest_files.iter() {
if manifest.basename != "setup.cfg" {
continue;
}
if let Some(change) = GenericUpdater::update_manifest(
manifest,
&package.next_version.semver,
&GENERIC_VERSION_REGEX,
) {
file_changes.push(change);
}
}
if file_changes.is_empty() {
return Ok(None);
}
Ok(Some(file_changes))
}
}
#[cfg(test)]
mod tests {
use std::{path::Path, rc::Rc};
use crate::{
config::release_type::ReleaseType, forge::request::Tag,
packages::manifests::ManifestFile, updater::dispatch::Updater,
};
use super::*;
#[test]
fn updates_version_without_quotes() {
let setupcfg = SetupCfg::new();
let content = "[metadata]\nname = my-package\nversion = 1.0.0\n";
let manifest = ManifestFile {
path: Path::new("setup.cfg").to_path_buf(),
basename: "setup.cfg".to_string(),
content: content.to_string(),
};
let package = UpdaterPackage {
package_name: "my-package".to_string(),
manifest_files: vec![manifest.clone()],
next_version: Tag {
name: "v2.0.0".into(),
semver: semver::Version::parse("2.0.0").unwrap(),
sha: "abc".into(),
..Tag::default()
},
updater: Rc::new(Updater::new(ReleaseType::Python)),
};
let result = setupcfg.update(&package, &[]).unwrap();
let updated = result.unwrap()[0].content.clone();
assert!(updated.contains("version = 2.0.0"));
}
#[test]
fn updates_version_with_double_quotes() {
let setupcfg = SetupCfg::new();
let content = "[metadata]\nname = my-package\nversion = \"1.0.0\"\n";
let manifest = ManifestFile {
path: Path::new("setup.cfg").to_path_buf(),
basename: "setup.cfg".to_string(),
content: content.to_string(),
};
let package = UpdaterPackage {
package_name: "my-package".to_string(),
manifest_files: vec![manifest.clone()],
next_version: Tag {
name: "v2.0.0".into(),
semver: semver::Version::parse("2.0.0").unwrap(),
sha: "abc".into(),
..Tag::default()
},
updater: Rc::new(Updater::new(ReleaseType::Python)),
};
let result = setupcfg.update(&package, &[]).unwrap();
let updated = result.unwrap()[0].content.clone();
assert!(updated.contains("version = \"2.0.0\""));
}
#[test]
fn updates_version_with_single_quotes() {
let setupcfg = SetupCfg::new();
let content = "[metadata]\nname = my-package\nversion = '1.0.0'\n";
let manifest = ManifestFile {
path: Path::new("setup.cfg").to_path_buf(),
basename: "setup.cfg".to_string(),
content: content.to_string(),
};
let package = UpdaterPackage {
package_name: "my-package".to_string(),
manifest_files: vec![manifest.clone()],
next_version: Tag {
name: "v2.0.0".into(),
semver: semver::Version::parse("2.0.0").unwrap(),
sha: "abc".into(),
..Tag::default()
},
updater: Rc::new(Updater::new(ReleaseType::Python)),
};
let result = setupcfg.update(&package, &[]).unwrap();
let updated = result.unwrap()[0].content.clone();
assert!(updated.contains("version = '2.0.0'"));
}
#[test]
fn preserves_whitespace_formatting() {
let setupcfg = SetupCfg::new();
let content = "[metadata]\nname = my-package\nversion = 1.0.0\n";
let manifest = ManifestFile {
path: Path::new("setup.cfg").to_path_buf(),
basename: "setup.cfg".to_string(),
content: content.to_string(),
};
let package = UpdaterPackage {
package_name: "my-package".to_string(),
manifest_files: vec![manifest.clone()],
next_version: Tag {
name: "v2.0.0".into(),
semver: semver::Version::parse("2.0.0").unwrap(),
sha: "abc".into(),
..Tag::default()
},
updater: Rc::new(Updater::new(ReleaseType::Python)),
};
let result = setupcfg.update(&package, &[]).unwrap();
let updated = result.unwrap()[0].content.clone();
assert!(updated.contains("version = 2.0.0"));
}
#[test]
fn preserves_other_fields() {
let setupcfg = SetupCfg::new();
let content = r#"[metadata]
name = my-package
version = 1.0.0
description = A test package
author = Test Author
[options]
packages = find:
install_requires =
requests>=2.28.0
"#;
let manifest = ManifestFile {
path: Path::new("setup.cfg").to_path_buf(),
basename: "setup.cfg".to_string(),
content: content.to_string(),
};
let package = UpdaterPackage {
package_name: "my-package".to_string(),
manifest_files: vec![manifest.clone()],
next_version: Tag {
name: "v2.0.0".into(),
semver: semver::Version::parse("2.0.0").unwrap(),
sha: "abc".into(),
..Tag::default()
},
updater: Rc::new(Updater::new(ReleaseType::Python)),
};
let result = setupcfg.update(&package, &[]).unwrap();
let updated = result.unwrap()[0].content.clone();
assert!(updated.contains("version = 2.0.0"));
assert!(updated.contains("name = my-package"));
assert!(updated.contains("description = A test package"));
assert!(updated.contains("author = Test Author"));
assert!(updated.contains("packages = find:"));
assert!(updated.contains("requests>=2.28.0"));
}
#[test]
fn process_package_handles_multiple_setup_cfg_files() {
let setupcfg = SetupCfg::new();
let manifest1 = ManifestFile {
path: Path::new("packages/a/setup.cfg").to_path_buf(),
basename: "setup.cfg".to_string(),
content: "[metadata]\nversion = 1.0.0\n".to_string(),
};
let manifest2 = ManifestFile {
path: Path::new("packages/b/setup.cfg").to_path_buf(),
basename: "setup.cfg".to_string(),
content: "[metadata]\nversion = 1.0.0\n".to_string(),
};
let package = UpdaterPackage {
package_name: "test".to_string(),
manifest_files: vec![manifest1, manifest2],
next_version: Tag {
name: "v2.0.0".into(),
semver: semver::Version::parse("2.0.0").unwrap(),
sha: "abc".into(),
..Tag::default()
},
updater: Rc::new(Updater::new(ReleaseType::Python)),
};
let result = setupcfg.update(&package, &[]).unwrap();
let changes = result.unwrap();
assert_eq!(changes.len(), 2);
assert!(changes.iter().all(|c| c.content.contains("2.0.0")));
}
#[test]
fn process_package_returns_none_when_no_setup_cfg_files() {
let setupcfg = SetupCfg::new();
let manifest = ManifestFile {
path: Path::new("setup.py").to_path_buf(),
basename: "setup.py".to_string(),
content: "setup(name='my-package', version='1.0.0')".to_string(),
};
let package = UpdaterPackage {
package_name: "test".to_string(),
manifest_files: vec![manifest],
next_version: Tag {
name: "v2.0.0".into(),
semver: semver::Version::parse("2.0.0").unwrap(),
sha: "abc".into(),
..Tag::default()
},
updater: Rc::new(Updater::new(ReleaseType::Python)),
};
let result = setupcfg.update(&package, &[]).unwrap();
assert!(result.is_none());
}
}