feat!: adding git history mode

DeveloperC286 · DeveloperC286 · commit b52927e7f1ba · 2022-02-22T17:39:33.000Z
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/conventional_commits_linter/Cargo.toml b/conventional_commits_linter/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "conventional_commits_linter"
-version = "0.10.0"
+version = "0.11.0"
 description = "A tooling and language agnostic utility to lint Git commits against the Conventional Commits specification."
 authors = ["C <DeveloperC@protonmail.com>"]
 edition = "2021"
@@ -26,7 +26,7 @@ git2 = { version = "0.13.25", default-features = false, features=[] }
 strum = "0.23.0"
 strum_macros = "0.23.1"
 
-conventional_commits_linter_lib = "0.2.0"
+conventional_commits_linter_lib = "0.3.0"
 
 
 [dev-dependencies]
diff --git a/conventional_commits_linter/end-to-end-tests/features/git-history-all-parents-mode.feature b/conventional_commits_linter/end-to-end-tests/features/git-history-all-parents-mode.feature
@@ -0,0 +1,15 @@
+Feature: Only the first parent of merge commit's are parsed for their Git commit messages.
+
+
+  Scenario Outline:
+    Given the repository "<repository>" is cloned and checked out at the commit "<checkout_commit>".
+    When the argument --from-commit-hash is provided as "<from_commit_hash>".
+    And the argument --output is set as "JSON".
+    Then their are "<default_number_of_commits>" commits failing linting.
+    When the argument --git-history-mode is provided as "AllParents".
+    Then their are "<all_parent_number_of_commits>" commits failing linting.
+
+
+    Examples:
+      | repository                              | checkout_commit                          | from_commit_hash                         | default_number_of_commits | all_parent_number_of_commits |
+      | https://github.com/lambci/awslambda.nim | 0fa0f62bec56eb7e09d8fd3e2a4c31798baba89f | 9c9583952ce709fbc6af3b85200c78bf417e5a11 | 5                         | 6                            |
diff --git a/conventional_commits_linter/end-to-end-tests/features/git-history-first-parent-mode.feature b/conventional_commits_linter/end-to-end-tests/features/git-history-first-parent-mode.feature
@@ -0,0 +1,13 @@
+Feature: Only the first parent of merge commit's are parsed for their Git commit messages.
+
+
+  Scenario Outline:
+    Given the repository "<repository>" is cloned and checked out at the commit "<checkout_commit>".
+    When the argument --from-commit-hash is provided as "<from_commit_hash>".
+    And the argument --output is set as "JSON".
+    Then their are "<number_of_commits>" commits failing linting.
+
+
+    Examples:
+      | repository                      | checkout_commit                          | from_commit_hash                         | number_of_commits |
+      | https://github.com/dcyou/resume | bbf42bd631b3ee85de650f46891619833c920bef | 0a74203f382e06b6f39f5143da1eee0be77d3acb | 4                 |
diff --git a/conventional_commits_linter/end-to-end-tests/features/steps/then-violations.py b/conventional_commits_linter/end-to-end-tests/features/steps/then-violations.py
@@ -5,6 +5,17 @@
 from then import then_linting_fails
 
 
+@then('their are "{number_of_commits}" commits failing linting.')
+def then_number_of_commits_failing_linting(context, number_of_commits):
+    # When/Then
+    then_linting_fails(context)
+
+    # Then
+    assert is_json(context.stdout)
+    output = json.loads(context.stdout)
+    assert len(output) == int(number_of_commits)
+
+
 @then('a preceding whitespace before the type violation is detected.')
 def then_preceding_whitespace_before_type_violation(context):
     # When/Then
diff --git a/conventional_commits_linter/end-to-end-tests/features/steps/then.py b/conventional_commits_linter/end-to-end-tests/features/steps/then.py
@@ -55,7 +55,7 @@ def then_missing_from_argument_error(context):
                                   "    <--from-stdin|--from-reference <from-reference>|--from-commit-hash <from-commit-hash>>\n" + \
                                   "\n" + \
                                   "USAGE:\n" + \
-                                  "    conventional_commits_linter --output <output> <--from-stdin|--from-reference <from-reference>|--from-commit-hash <from-commit-hash>>\n" + \
+                                  "    conventional_commits_linter --git-history-mode <git-history-mode> --output <output> <--from-stdin|--from-reference <from-reference>|--from-commit-hash <from-commit-hash>>\n" + \
                                   "\n" + \
                                   "For more information try --help\n"
 
@@ -71,7 +71,7 @@ def then_conflicting_from_arguments_error(context):
     # Given
     conflicting_arguments_end = "\n" + \
         "USAGE:\n" + \
-        "    conventional_commits_linter --output <output> <--from-stdin|--from-reference <from-reference>|--from-commit-hash <from-commit-hash>>\n" + \
+        "    conventional_commits_linter --git-history-mode <git-history-mode> --output <output> <--from-stdin|--from-reference <from-reference>|--from-commit-hash <from-commit-hash>>\n" + \
         "\n" + \
         "For more information try --help\n"
 
diff --git a/conventional_commits_linter/end-to-end-tests/features/steps/when.py b/conventional_commits_linter/end-to-end-tests/features/steps/when.py
@@ -1,22 +1,27 @@
 from behave import *
 
 
-@when('the argument --from-commit-hash is provided as "{from_commit_hash}".')
-def set_from_commit_hash(context, from_commit_hash):
-    context.arguments += " --from-commit-hash " + from_commit_hash + " "
+@when(
+    'the flag --from-stdin is set and the standard input is "{standard_input}".')
+def set_from_stdin(context, standard_input):
+    context.standard_input = standard_input.strip()
+    context.pre_command = "echo " + context.standard_input + " | "
+    context.arguments += " --from-stdin "
 
 
 @when('the argument --from-reference is provided as "{from_reference}".')
 def set_from_reference(context, from_reference):
     context.arguments += " --from-reference " + from_reference + " "
 
 
-@when(
-    'the flag --from-stdin is set and the standard input is "{standard_input}".')
-def set_from_stdin(context, standard_input):
-    context.standard_input = standard_input.strip()
-    context.pre_command = "echo " + context.standard_input + " | "
-    context.arguments += " --from-stdin "
+@when('the argument --from-commit-hash is provided as "{from_commit_hash}".')
+def set_from_commit_hash(context, from_commit_hash):
+    context.arguments += " --from-commit-hash " + from_commit_hash + " "
+
+
+@when('the argument --git-history-mode is provided as "AllParents".')
+def set_batch_commits_flag(context):
+    context.arguments += " --git-history-mode \"AllParents\" "
 
 
 @when('the flag --allow-angular-type-only is set.')
diff --git a/conventional_commits_linter/src/cli/mod.rs b/conventional_commits_linter/src/cli/mod.rs
@@ -28,6 +28,13 @@ pub(crate) struct Arguments {
     )]
     pub(crate) from_commit_hash: Option<String>,
 
+    #[structopt(
+        long,
+        default_value = "FirstParent",
+        help = "The mode to use when transversing the Git commit history of the Git commit range, to collect the Git commit messages to use in calculating the next semantic version."
+    )]
+    pub(crate) git_history_mode: conventional_commits_linter_lib::GitHistoryMode,
+
     #[structopt(
         long,
         help = "Allow the Conventional Commits type to only be (`build`, `ci`, `docs`, `feat`, `fix`, `perf`, `refactor`, `style`, `test`, `revert`), otherwise linting for the commit will fail."
diff --git a/conventional_commits_linter/src/main.rs b/conventional_commits_linter/src/main.rs
@@ -41,10 +41,10 @@ fn run(arguments: Arguments) -> Result<(), git2::Error> {
             Ok(Commits::from_commit_message(commit_message))
         }
         (false, Some(from_commit_hash), None) => {
-            Commits::from_commit_hash(&repository, &from_commit_hash)
+            Commits::from_commit_hash(&repository, &from_commit_hash, arguments.git_history_mode)
         }
         (false, None, Some(from_reference)) => {
-            Commits::from_reference(&repository, &from_reference)
+            Commits::from_reference(&repository, &from_reference, arguments.git_history_mode)
         }
         (_, _, _) => {
             unreachable!(
diff --git a/conventional_commits_linter_lib/Cargo.toml b/conventional_commits_linter_lib/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "conventional_commits_linter_lib"
-version = "0.2.0"
+version = "0.3.0"
 description = "A tooling and language agnostic library to lint Git commits against the Conventional Commits specification."
 authors = ["C <DeveloperC@protonmail.com>"]
 edition = "2021"
@@ -29,6 +29,10 @@ serde_json = "1.0.79"
 # For fancy output.
 ansi_term = "0.12.1"
 
+# For enum from _str etc for CLI usage.
+strum = "0.23.0"
+strum_macros = "0.23.1"
+
 
 [dev-dependencies]
 # For parameterized testing.
diff --git a/conventional_commits_linter_lib/src/commits/mod.rs b/conventional_commits_linter_lib/src/commits/mod.rs
@@ -3,9 +3,10 @@ use std::collections::{HashMap, VecDeque};
 use git2::{Oid, Repository, Revwalk};
 
 use crate::commits::commit::Commit;
+use crate::git_history_mode::GitHistoryMode;
+use crate::linting_error::LintingError;
+use crate::linting_errors::LintingErrors;
 use crate::source::Source;
-use crate::LintingError;
-use crate::LintingErrors;
 
 pub mod commit;
 
@@ -47,28 +48,29 @@ impl Commits {
     /// E.g. short name.
     ///
     /// ```
-    /// use conventional_commits_linter_lib::Commits;
+    /// use conventional_commits_linter_lib::{Commits, GitHistoryMode};
     /// use git2::Repository;
     ///
     /// let repository = Repository::open_from_env().unwrap();
-    /// let commits = Commits::from_reference(&repository, "0.9.0").unwrap();
+    /// let commits = Commits::from_reference(&repository, "0.9.0", GitHistoryMode::FirstParent).unwrap();
     /// ```
     ///
     /// E.g. full name.
     ///
     /// ```
-    /// use conventional_commits_linter_lib::Commits;
+    /// use conventional_commits_linter_lib::{Commits, GitHistoryMode};
     /// use git2::Repository;
     ///
     /// let repository = Repository::open_from_env().unwrap();
-    /// let commits = Commits::from_reference(&repository, "refs/tags/0.9.0").unwrap();
+    /// let commits = Commits::from_reference(&repository, "refs/tags/0.9.0", GitHistoryMode::FirstParent).unwrap();
     /// ```
     pub fn from_reference<T: AsRef<str>>(
         repository: &Repository,
         reference: T,
+        git_history_mode: GitHistoryMode,
     ) -> Result<Commits, git2::Error> {
         let reference_oid = get_reference_oid(repository, reference.as_ref())?;
-        let commits = get_commits_till_head_from_oid(repository, reference_oid)?;
+        let commits = get_commits_till_head_from_oid(repository, reference_oid, git_history_mode)?;
         Ok(Commits {
             commits,
             source: Source::Git,
@@ -82,28 +84,29 @@ impl Commits {
     /// E.g. shortened commit hash.
     ///
     /// ```
-    /// use conventional_commits_linter_lib::Commits;
+    /// use conventional_commits_linter_lib::{Commits, GitHistoryMode};
     /// use git2::Repository;
     ///
     /// let repository = Repository::open_from_env().unwrap();
-    /// let commits = Commits::from_commit_hash(&repository, "0d12672").unwrap();
+    /// let commits = Commits::from_commit_hash(&repository, "0d12672", GitHistoryMode::FirstParent).unwrap();
     /// ```
     ///
     /// E.g. full commit hash.
     ///
     /// ```
-    /// use conventional_commits_linter_lib::Commits;
+    /// use conventional_commits_linter_lib::{Commits, GitHistoryMode};
     /// use git2::Repository;
     ///
     /// let repository = Repository::open_from_env().unwrap();
-    /// let commits = Commits::from_commit_hash(&repository, "0d126721af479dfd9ed2a5960c4202a87cfd4932").unwrap();
+    /// let commits = Commits::from_commit_hash(&repository, "0d126721af479dfd9ed2a5960c4202a87cfd4932", GitHistoryMode::FirstParent).unwrap();
     /// ```
     pub fn from_commit_hash<T: AsRef<str>>(
         repository: &Repository,
         commit_hash: T,
+        git_history_mode: GitHistoryMode,
     ) -> Result<Commits, git2::Error> {
         let commit_oid = parse_to_oid(repository, commit_hash.as_ref())?;
-        let commits = get_commits_till_head_from_oid(repository, commit_oid)?;
+        let commits = get_commits_till_head_from_oid(repository, commit_oid, git_history_mode)?;
         Ok(Commits {
             commits,
             source: Source::Git,
@@ -142,12 +145,17 @@ impl Commits {
 fn get_commits_till_head_from_oid(
     repository: &Repository,
     from_commit_hash: Oid,
+    git_history_mode: GitHistoryMode,
 ) -> Result<VecDeque<Commit>, git2::Error> {
     fn get_revwalker(
         repository: &Repository,
         from_commit_hash: Oid,
+        git_history_mode: GitHistoryMode,
     ) -> Result<Revwalk, git2::Error> {
         let mut commits = repository.revwalk()?;
+        if git_history_mode == GitHistoryMode::FirstParent {
+            commits.simplify_first_parent()?;
+        }
         commits.push_head()?;
 
         match commits.hide(from_commit_hash) {
@@ -159,7 +167,7 @@ fn get_commits_till_head_from_oid(
         }
     }
 
-    let revwalker = get_revwalker(repository, from_commit_hash)?;
+    let revwalker = get_revwalker(repository, from_commit_hash, git_history_mode)?;
     let mut commits = VecDeque::new();
 
     for oid in revwalker {
diff --git a/conventional_commits_linter_lib/src/git_history_mode/mod.rs b/conventional_commits_linter_lib/src/git_history_mode/mod.rs
@@ -0,0 +1,13 @@
+use strum_macros::{Display, EnumString};
+
+/// The mode to use when transversing the Git commit history of the Git commit range, to collect
+/// the Git commit messages to use in calculating the next semantic version.
+#[derive(Debug, PartialEq, Eq, Clone, Copy, Display, EnumString)]
+pub enum GitHistoryMode {
+    /// In FirstParent mode only the first parent of merge commit's are parsed for their Git commit
+    /// messages.
+    FirstParent,
+    /// In AllParents mode all the parents of merge commit's are parsed for their Git commit
+    /// messages.
+    AllParents,
+}
diff --git a/conventional_commits_linter_lib/src/lib.rs b/conventional_commits_linter_lib/src/lib.rs
@@ -8,11 +8,13 @@ extern crate log;
 extern crate regex;
 
 mod commits;
+mod git_history_mode;
 mod linter;
 mod linting_error;
 mod linting_errors;
 mod source;
 
 pub use crate::commits::Commits;
+pub use crate::git_history_mode::GitHistoryMode;
 pub use crate::linting_error::LintingError;
 pub use crate::linting_errors::LintingErrors;

Original file line number	Diff line number	Diff line change
`@@ -41,10 +41,10 @@ fn run(arguments: Arguments) -> Result<(), git2::Error> {`
`41`	`41`	`Ok(Commits::from_commit_message(commit_message))`
`42`	`42`	`}`
`43`	`43`	`(false, Some(from_commit_hash), None) => {`
`44`		`- Commits::from_commit_hash(&repository, &from_commit_hash)`
	`44`	`+ Commits::from_commit_hash(&repository, &from_commit_hash, arguments.git_history_mode)`
`45`	`45`	`}`
`46`	`46`	`(false, None, Some(from_reference)) => {`
`47`		`- Commits::from_reference(&repository, &from_reference)`
	`47`	`+ Commits::from_reference(&repository, &from_reference, arguments.git_history_mode)`
`48`	`48`	`}`
`49`	`49`	`(_, _, _) => {`
`50`	`50`	`unreachable!(`