test(config): add tests for backwards compatibility

orhun · Apr 15, 2024 · a483d71 · a483d71
1 parent bd225f3
commit a483d71
Show file tree

Hide file tree

Showing 15 changed files with 188 additions and 99 deletions.
diff --git a/.github/fixtures/test-configure-from-cargo-toml/Cargo.toml b/.github/fixtures/test-configure-from-cargo-toml/Cargo.toml
@@ -4,14 +4,13 @@ version = "0.1.0"
 edition = "2021"
 
 [package.metadata.git-cliff.changelog]
-# changelog header
+# A static header for the changelog.
 header = """
 # Changelog\n
 All notable changes to this project will be documented in this file.\n
 """
-# template for the changelog body
-# https://keats.github.io/tera/docs/#introduction
-body = """
+# A Tera template to be rendered for each release in the changelog (see https://keats.github.io/tera/docs/#introduction).
+body_template = """
 {% if version %}\
     ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
 {% else %}\
@@ -24,15 +23,16 @@ body = """
     {% endfor %}
 {% endfor %}\n
 """
-# template for the changelog footer
-footer = """
+# A Tera template to be rendered as the changelog's footer (see https://keats.github.io/tera/docs/#introduction).
+footer_template = """
 <!-- generated by git-cliff -->
 """
-# remove the leading and trailing whitespace from the templates
-trim = true
+# Whether to remove leading and trailing whitespaces from all lines of the changelog's body.
+trim_body_whitespace = true
 
-[package.metadata.git-cliff.git]
-# regex for parsing and grouping commits
+[package.metadata.git-cliff.commit]
+# A list of parsers using regex for extracting data from the commit message.
+# Sets the commits' `group` and `scope` and can decide to exclude commits from further processing.
 commit_parsers = [
     { message = "^feat", group = "Features", default_scope = "app" },
     { message = "^fix", group = "Bug Fixes", scope = "cli" },

diff --git a/.github/fixtures/test-v1-config-arg/cliff.toml b/.github/fixtures/test-v1-config-arg/cliff.toml
@@ -0,0 +1,34 @@
+[changelog]
+# changelog header
+header = """
+# Changelog\n
+All notable changes to this project will be documented in this file.\n
+"""
+# template for the changelog body
+# https://keats.github.io/tera/docs/#introduction
+body = """
+{% if version %}\
+    ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
+{% else %}\
+    ## [unreleased]
+{% endif %}\
+{% for group, commits in commits | group_by(attribute="group") %}
+    ### {{ group | upper_first }}
+    {% for commit in commits %}
+        - {{ commit.message | upper_first }}\
+    {% endfor %}
+{% endfor %}\n
+"""
+# template for the changelog footer
+footer = """
+<!-- generated by git-cliff -->
+"""
+# remove the leading and trailing whitespace from the templates
+trim = true
+
+[git]
+# regex for parsing and grouping commits
+commit_parsers = [
+    { message = "^feat", group = "Features", default_scope = "app" },
+    { message = "^fix", group = "Bug Fixes", scope = "cli" },
+]
diff --git a/.github/fixtures/test-v1-config-arg/commit.sh b/.github/fixtures/test-v1-config-arg/commit.sh
@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+set -e
+
+GIT_COMMITTER_DATE="2022-04-06 01:25:08" git commit --allow-empty -m "Initial commit"
+GIT_COMMITTER_DATE="2022-04-06 01:25:09" git commit --allow-empty -m "feat: add feature 1"
+GIT_COMMITTER_DATE="2022-04-06 01:25:10" git commit --allow-empty -m "fix: fix feature 1"
+git tag v0.1.0
+GIT_COMMITTER_DATE="2022-04-06 01:25:11" git commit --allow-empty -m "feat(gui): add feature 2"
+GIT_COMMITTER_DATE="2022-04-06 01:25:12" git commit --allow-empty -m "fix(gui): fix feature 2"
+git tag v0.2.0
+GIT_COMMITTER_DATE="2022-04-06 01:25:13" git commit --allow-empty -m "test: add tests"
diff --git a/.github/fixtures/test-v1-config-arg/expected.md b/.github/fixtures/test-v1-config-arg/expected.md
@@ -0,0 +1,31 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [unreleased]
+
+### Test
+
+- Add tests
+
+## [0.2.0] - 2022-04-06
+
+### Bug Fixes
+
+- Fix feature 2
+
+### Features
+
+- Add feature 2
+
+## [0.1.0] - 2022-04-06
+
+### Bug Fixes
+
+- Fix feature 1
+
+### Features
+
+- Add feature 1
+
+<!-- generated by git-cliff -->
diff --git a/.github/fixtures/test-v1-config-meta/cliff.toml b/.github/fixtures/test-v1-config-meta/cliff.toml
@@ -0,0 +1,38 @@
+[meta]
+# The version of the config schema.
+version = 1
+
+[changelog]
+# changelog header
+header = """
+# Changelog\n
+All notable changes to this project will be documented in this file.\n
+"""
+# template for the changelog body
+# https://keats.github.io/tera/docs/#introduction
+body = """
+{% if version %}\
+    ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
+{% else %}\
+    ## [unreleased]
+{% endif %}\
+{% for group, commits in commits | group_by(attribute="group") %}
+    ### {{ group | upper_first }}
+    {% for commit in commits %}
+        - {{ commit.message | upper_first }}\
+    {% endfor %}
+{% endfor %}\n
+"""
+# template for the changelog footer
+footer = """
+<!-- generated by git-cliff -->
+"""
+# remove the leading and trailing whitespace from the templates
+trim = true
+
+[git]
+# regex for parsing and grouping commits
+commit_parsers = [
+    { message = "^feat", group = "Features", default_scope = "app" },
+    { message = "^fix", group = "Bug Fixes", scope = "cli" },
+]
diff --git a/.github/fixtures/test-v1-config-meta/commit.sh b/.github/fixtures/test-v1-config-meta/commit.sh
@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+set -e
+
+GIT_COMMITTER_DATE="2022-04-06 01:25:08" git commit --allow-empty -m "Initial commit"
+GIT_COMMITTER_DATE="2022-04-06 01:25:09" git commit --allow-empty -m "feat: add feature 1"
+GIT_COMMITTER_DATE="2022-04-06 01:25:10" git commit --allow-empty -m "fix: fix feature 1"
+git tag v0.1.0
+GIT_COMMITTER_DATE="2022-04-06 01:25:11" git commit --allow-empty -m "feat(gui): add feature 2"
+GIT_COMMITTER_DATE="2022-04-06 01:25:12" git commit --allow-empty -m "fix(gui): fix feature 2"
+git tag v0.2.0
+GIT_COMMITTER_DATE="2022-04-06 01:25:13" git commit --allow-empty -m "test: add tests"
diff --git a/.github/fixtures/test-v1-config-meta/expected.md b/.github/fixtures/test-v1-config-meta/expected.md
@@ -0,0 +1,31 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [unreleased]
+
+### Test
+
+- Add tests
+
+## [0.2.0] - 2022-04-06
+
+### Bug Fixes
+
+- Fix feature 2
+
+### Features
+
+- Add feature 2
+
+## [0.1.0] - 2022-04-06
+
+### Bug Fixes
+
+- Fix feature 1
+
+### Features
+
+- Add feature 1
+
+<!-- generated by git-cliff -->
diff --git a/.github/workflows/test-fixtures.yml b/.github/workflows/test-fixtures.yml
@@ -68,6 +68,9 @@ jobs:
           - fixtures-name: test-custom-tag-pattern
             command: --release-tags-pattern "alpha.*"
           - fixtures-name: test-configure-from-cargo-toml
+          - fixtures-name: test-v1-config-meta
+          - fixtures-name: test-v1-config-arg
+            command: --config-version 1
     steps:
       - name: Checkout
         uses: actions/checkout@v4

diff --git a/__TODO.toml b/__TODO.toml
diff --git a/git-cliff-core/src/changelog.rs b/git-cliff-core/src/changelog.rs
@@ -356,8 +356,6 @@ mod test {
 	use super::*;
 	use crate::config::models_v2::{
 		Bump,
-		ChangelogConfig,
-		CommitConfig,
 		CommitParser,
 		CommitSortOrder,
 		ReleaseConfig,

diff --git a/git-cliff-core/src/config/embed.rs b/git-cliff-core/src/config/embed.rs
@@ -53,11 +53,14 @@ pub fn read_from_manifest() -> Result<Option<String>> {
 		if info.path.exists() {
 			let contents = fs::read_to_string(&info.path)?;
 			if info.regex.is_match(&contents) {
+				info!("Using configuration from manifest in {:?}.", info.path);
 				return Ok(Some(info.regex.replace_all(&contents, "[").to_string()));
 			}
 		}
 	}
-	Ok(None)
+	Err(Error::EmbeddedError(String::from(
+		"Could not read config from manifest.",
+	)))
 }
 
 /// Default configuration file embedder/extractor.

diff --git a/git-cliff-core/src/config/migrate.rs b/git-cliff-core/src/config/migrate.rs
@@ -27,7 +27,10 @@ pub fn run(args: &MigrateArgs) -> Result<()> {
 	if !args.in_path.exists() {
 		return Err(Error::ArgumentError(format!(
 			"File {0} does not exist.",
-			&args.in_path.to_str().unwrap()
+			&args
+				.in_path
+				.to_str()
+				.expect("could not unwrap argument 'in_path'")
 		)));
 	}
 
@@ -36,7 +39,8 @@ pub fn run(args: &MigrateArgs) -> Result<()> {
 
 	// convert to the new config format
 	let new_config = super::models_v2::Config::from(old_config);
-	let new_toml = toml::to_string(&new_config).unwrap();
+	let new_toml = toml::to_string(&new_config)
+		.expect("could not serialize migrated config into toml");
 
 	// write the new config file
 	let mut new_config_file = fs::OpenOptions::new()

diff --git a/git-cliff-core/src/config/models_v2.rs b/git-cliff-core/src/config/models_v2.rs
@@ -277,8 +277,10 @@ impl Config {
 				tags_pattern:      config_v1.git.tag_pattern,
 				skip_tags_pattern: config_v1.git.ignore_tags,
 				order_by:          Some(
-					if config_v1.git.topo_order.is_some() &&
-						config_v1.git.topo_order.unwrap()
+					if config_v1
+						.git
+						.topo_order
+						.is_some_and(|topo_order| topo_order)
 					{
 						TagsOrderBy::Topology
 					} else {

diff --git a/git-cliff/src/config.rs b/git-cliff/src/config.rs
@@ -65,7 +65,7 @@ pub fn load_config(args: &Opt) -> Result<Config_v2> {
 	// If `--config` denotes an existing file, load it from there.
 	else if config_arg.is_file() {
 		info!(
-			"Loading configuration from {}",
+			"Loading configuration from {}.",
 			config_arg.to_string_lossy()
 		);
 		fs::read_to_string(config_arg)?
@@ -74,6 +74,7 @@ pub fn load_config(args: &Opt) -> Result<Config_v2> {
 	else if let Some(contents) =
 		git_cliff_core::config::embed::read_from_manifest()?
 	{
+		info!("Loading configuration from manifest.");
 		contents
 	}
 	// Otherwise fall back to using the embedded configuration from
@@ -90,7 +91,7 @@ pub fn load_config(args: &Opt) -> Result<Config_v2> {
 	// `--config-version` and the option `meta.version`.
 	let raw_config = config_str.parse::<toml::Table>()?;
 	let config_version = determine_config_version(args, raw_config);
-	info!("Loading config version {config_version}.");
+	info!("Loading configuration version {config_version}.");
 
 	// load the file using https://docs.rs/config
 	let raw_config = config::Config::builder()
@@ -109,7 +110,7 @@ pub fn load_config(args: &Opt) -> Result<Config_v2> {
 		return Ok(raw_config.try_deserialize::<Config_v2>()?);
 	} else {
 		return Err(Error::ArgumentError(format!(
-			"Config version {} is not supported.",
+			"Configuration version {} is not supported.",
 			config_version
 		)));
 	}

diff --git a/website/docs/configuration/migration.md b/website/docs/configuration/migration.md
@@ -7,7 +7,7 @@ Example:
 
 - `git-cliff migrate-config --in cliff.toml --out cliff-new.toml`
 
-## Backwards compatability
+## Backwards compatibility
 While configuration version 1 is deprecated, the cli argument `--config-version` can be used to make git-cliff use old configuration files. Keep in mind that new features might not be supported when using the old configuration format.
 
 Example: