Update default validation interval (#24)

* Adjust interval to 5 sec

* Rephrase log messages

* Fix test cases

Author: rytswd

action.yml

@@ -12,9 +12,9 @@ inputs:
     required: false
     default: "merge-gatekeeper"
   interval:
-    description: "set validate interval second (default 30)"
+    description: "set validate interval second (default 5)"
     required: false
-    default: "30"
+    default: "5"
   timeout:
     description: "set validate timeout second (default 600)"
     required: false

internal/cli/validate.go

@@ -86,9 +86,9 @@ func ownerAndRepository(str string) (owner string, repo string) {
 }
 
 func debug(logger logger, name string) func() {
-	logger.Printf("start %s processing....\n", name)
+	logger.Printf("Start processing %s....\n", name)
 	return func() {
-		logger.Printf("finish %s processing\n", name)
+		logger.Printf("Finish %s processing.\n", name)
 	}
 }
 
@@ -99,8 +99,6 @@ func doValidateCmd(ctx context.Context, logger logger, vs ...validators.Validato
 	invalT := ticker.NewInstantTicker(time.Duration(validateInvalSecond) * time.Second)
 	defer invalT.Stop()
 
-	defer debug(logger, "validation loop")()
-
 	for {
 		select {
 		case <-ctx.Done():
@@ -117,11 +115,13 @@ func doValidateCmd(ctx context.Context, logger logger, vs ...validators.Validato
 				}
 			}
 			if successCnt != len(vs) {
-				logger.PrintErrln("validation failed, waiting for next run")
+				logger.PrintErrln("")
+				logger.PrintErrln("  WARNING: Validation is yet to be completed. This is most likely due to some other jobs still running.")
+				logger.PrintErrf("           Waiting for %d seconds before retrying.\n\n", validateInvalSecond)
 				break
 			}
 
-			logger.Println("all validations successful")
+			logger.Println("All validations were successful!")
 			return nil
 		}
 	}
@@ -132,7 +132,7 @@ func validate(ctx context.Context, v validators.Validator, logger logger) (bool,
 
 	st, err := v.Validate(ctx)
 	if err != nil {
-		return false, fmt.Errorf("error occurs\tvalidator: %s, err: %v", v.Name(), err)
+		return false, fmt.Errorf("validation failed, err: %v", err)
 	}
 
 	logger.Println(st.Detail())

internal/validators/status/status.go

@@ -13,12 +13,13 @@ func (s *status) Detail() string {
 	return fmt.Sprintf(
 		`%d out of %d
 
-  total job count: %d
+  Total job count:     %d
     jobs: %+q
-  completed job count: %d
+  Completed job count: %d
     jobs: %+q
-  failed job count: %d
-    jobs: %+q`,
+  Failed job count:    %d
+    jobs: %+q
+`,
 		len(s.completeJobs), len(s.totalJobs),
 		len(s.totalJobs), s.totalJobs,
 		len(s.completeJobs), s.completeJobs,

internal/validators/status/status_test.go

@@ -25,12 +25,13 @@ func Test_status_Detail(t *testing.T) {
 			},
 			want: `1 out of 3
 
-  total job count: 3
+  Total job count:     3
     jobs: ["job-1" "job-2" "job-3"]
-  completed job count: 1
+  Completed job count: 1
     jobs: ["job-2"]
-  failed job count: 1
-    jobs: ["job-3"]`,
+  Failed job count:    1
+    jobs: ["job-3"]
+`,
 		},
 		"return detail when totalJobs and completeJobs is empty": {
 			s: &status{
@@ -39,12 +40,13 @@ func Test_status_Detail(t *testing.T) {
 			},
 			want: `0 out of 0
 
-  total job count: 0
+  Total job count:     0
     jobs: []
-  completed job count: 0
+  Completed job count: 0
     jobs: []
-  failed job count: 0
-    jobs: []`,
+  Failed job count:    0
+    jobs: []
+`,
 		},
 	}