Refactoring runComment in mod.go

internal/mcheck/mod.go

@@ -47,49 +47,74 @@ func main() {
 	)
 }
 
-// run parses all the comments in ast.File
+// iterateOverLines iterates over the lines of a comment and
+// checks if the line is too long or contains a prefix
+// that should be ignored
+func iterateOverLines(pass *analysis.Pass, lines []string, c *ast.Comment) {
+	for j := 0; j < len(lines); j++ {
+		line := lines[j]
+		if checkPrefixes(line) {
+			continue
+		}
+		ifTooLong(line, pass, c)
+		if strings.HasPrefix(line, NoLint) {
+			// Skip next comment for block comment.
+			j++
+		}
+	}
+}
+
+// checkPrefixes checks if the line starts with any of the following
+// prefixes:
+//
+// - `//go:generate`
+// - `// http://`
+// - `// https://`
+//
+// If it does, it returns `true`. Otherwise, it returns `false`
+func checkPrefixes(line string) bool {
+	return strings.HasPrefix(line, "//go:generate") ||
+		strings.HasPrefix(line, "// http://") ||
+		strings.HasPrefix(line, "// https://")
+}
+
+// ifTooLong reports a comment if it's too long
+func ifTooLong(line string, pass *analysis.Pass, c *ast.Comment) {
+	if len(line) > MaxLen {
+		pass.Reportf( // `c` is a comment.
+			c.Pos(), "Comment too long: %s (%d)",
+			line, len(line))
+	}
+}
+
+// It loops over all the files in the package, and for each file it loops
+// over all the comments in the file, and for each comment it loops over
+// all the lines in the comment, and for each line it checks
+// if the line is too long
 func runComment(pass *analysis.Pass) (interface{}, error) {
 fileLoop:
 	for _, file := range pass.Files {
 		isFirst := true
 		for _, cg := range file.Comments {
 			for i := 0; i < len(cg.List); i++ {
 				c := cg.List[i]
-
+				// Checking if the first comment starts with "// Code generated"
+				//and if it does, it continues the
+				// fileLoop and changes the file
 				if isFirst && strings.HasPrefix(c.Text, "// Code generated") {
 					continue fileLoop
 				}
 				// in case of /* */ comment there might be multiple lines
 				lines := strings.Split(c.Text, "\n")
-				for j := 0; j < len(lines); j++ {
-					line := lines[j]
-
-					if strings.HasPrefix(line, "//go:generate") {
-						continue
-					}
-					if strings.HasPrefix(line, "// http://") || strings.HasPrefix(line, "// https://") {
-						continue
-					}
-					if len(line) > MaxLen {
-						pass.Reportf(c.Pos(), "Comment too long: %s (%d)",
-							line, len(line))
-					}
-					if strings.HasPrefix(line, NoLint) {
-						// Skip next comment for block comment.
-						j++
-					}
-				}
-
+				iterateOverLines(pass, lines, c)
 				isFirst = false
-
 				if strings.HasPrefix(c.Text, NoLint) {
-					// Skip next comment for one-line comment.
+					// Skip next comment for block comment.
 					i++
 				}
 			}
 		}
 	}
-
 	return nil, nil
 }
 

services/dkg/pedersen/handler_test.go

@@ -13,6 +13,7 @@ import (
 	"go.dedis.ch/dela/serde/json"
 
 	"github.com/dedis/d-voting/internal/testing/fake"
+	"github.com/dedis/d-voting/services/dkg"
 	"github.com/dedis/d-voting/services/dkg/pedersen/types"
 	"github.com/stretchr/testify/require"
 	"go.dedis.ch/dela/mino"
@@ -107,6 +108,7 @@ func TestHandler_Start(t *testing.T) {
 	h := Handler{
 		startRes: &state{},
 		privKey:  privKey,
+		status: &dkg.Status{},
 	}
 	start := types.NewStart(
 		[]mino.Address{fake.NewAddress(0)},

services/dkg/pedersen/mod_test.go

@@ -338,6 +338,7 @@ func TestPedersen_Setup(t *testing.T) {
 		},
 		context: serdecontext,
 		formFac: formFac,
+		status:  &dkg.Status{},
 	}
 
 	// Wrong formID