chore(validator): add an option to allow temporary commits

Author: sebastien-boulle

README.md

@@ -200,6 +200,7 @@ in `.git/hooks` directory of your repository.
 ### OPTIONS
 
 - if `COMMIT_VALIDATOR_NO_JIRA` environment variable is set, no validation is done on JIRA refs.
+- if `COMMIT_VALIDATOR_ALLOW_TEMP` environment variable is set, no validation is done on `fixup!` and `squash!` commits.
 
 <!-- ROADMAP -->
 
@@ -219,7 +220,7 @@ See the [open issues](https://github.com/lumapps/commit-msg-validator/issues) fo
 - [x] enforce the BROKEN part length
 - [x] avoid trailing space
 - [x] allow automated revert commit
-- [ ] allow fixup! and squash! commit with an option
+- [x] allow fixup! and squash! commit with an option
 - [x] allow to not check JIRA reference with an option
 - [ ] enforce subject length (3 words at least)
 

validator.bats

@@ -264,6 +264,26 @@ BROKEN:
   [ "$status" -eq $ERROR_HEADER ]
 }
 
+@test "header overall should allow fixup if env set" {
+  COMMIT_VALIDATOR_ALLOW_TEMP= validate_header "fixup! plopezrr"
+  [[ $GLOBAL_TYPE == "temp" ]]
+}
+
+@test "header overall should allow squash if env set" {
+  COMMIT_VALIDATOR_ALLOW_TEMP= validate_header "squash! plopezrr"
+  [[ $GLOBAL_TYPE == "temp" ]]
+}
+
+@test "header overall should reject fixup if env not set" {
+  run validate_header "fixup! plopezrr"
+  [[ "$status" -eq $ERROR_HEADER ]]
+}
+
+@test "header overall should reject squash if env not set" {
+  run validate_header "squash! plopezrr"
+  [[ "$status" -eq $ERROR_HEADER ]]
+}
+
 @test "header overall should allow 'revert: type(scope): message'" {
   validate_header "revert: type(scope): message"
   [[ $GLOBAL_TYPE == "revert" ]]
@@ -631,3 +651,37 @@ BROKEN:
   run validate "$MESSAGE"
   [[ "$status" -eq 0 ]]
 }
+
+@test "overall fixup! validation" {
+  MESSAGE='fixup! plepozkfopezr
+
+Commit about stuff\"plop \" dezd
+
+12345678901234567890123456789012345678901234567890
+12345678901234567890123456789012345678901234567890
+
+LUM-2345
+BROKEN:
+- plop
+- plop'
+
+  COMMIT_VALIDATOR_ALLOW_TEMP= run validate "$MESSAGE"
+  [[ "$status" -eq 0 ]]
+}
+
+@test "overall fixup! rejection" {
+  MESSAGE='fixup! plepozkfopezr
+
+Commit about stuff\"plop \" dezd
+
+12345678901234567890123456789012345678901234567890
+12345678901234567890123456789012345678901234567890
+
+LUM-2345
+BROKEN:
+- plop
+- plop'
+
+  run validate "$MESSAGE"
+  [[ "$status" -eq $ERROR_HEADER ]]
+}

validator.sh

@@ -13,6 +13,7 @@ readonly BROKE_PATTERN="^BROKEN:$"
 readonly TRAILING_SPACE_PATTERN=" +$"
 readonly REVERT_HEADER_PATTERN="^[R|r]evert[: ].*$"
 readonly REVERT_COMMIT_PATTERN="^This reverts commit ([a-f0-9]+)"
+readonly TEMP_HEADER_PATTERN="^(fixup!|squash!).*$"
 
 readonly ERROR_STRUCTURE=1
 readonly ERROR_HEADER=2
@@ -124,7 +125,9 @@ validate_overall_structure() {
 validate_header() {
   local HEADER="$1"
 
-  if [[ $HEADER =~ $REVERT_HEADER_PATTERN ]]; then
+  if [[ -v COMMIT_VALIDATOR_ALLOW_TEMP && $HEADER =~ $TEMP_HEADER_PATTERN ]]; then
+     GLOBAL_TYPE="temp"
+  elif [[ $HEADER =~ $REVERT_HEADER_PATTERN ]]; then
      GLOBAL_TYPE="revert"
   elif [[ $HEADER =~ $HEADER_PATTERN ]]; then
      GLOBAL_TYPE=${BASH_REMATCH[1]}
@@ -268,7 +271,9 @@ validate() {
    local SCOPE="$GLOBAL_SCOPE"
    local SUBJECT="$GLOBAL_SUBJECT"
 
-   if [[ $TYPE = "revert" ]]; then
+   if [[ $TYPE = "temp" ]]; then
+     echo "ignoring temporary commit"
+   elif [[ $TYPE = "revert" ]]; then
      validate_revert "$BODY"
    else
      validate_header_length "$HEADER"