test(commit): tests for commit message builder

Author: isokolovskii

cmd/commit.go

@@ -13,19 +13,19 @@ import (
 var ErrInvalidFlag = errors.New("invalid flag")
 
 func commit() *cli.Command {
-	commit := conventional.Commit{}
+	commitData := conventional.Commit{}
 
 	return &cli.Command{
 		Name:  "commit",
 		Usage: "Create Conventional Commit",
-		Flags: flags(&commit),
+		Flags: flags(&commitData),
 		Action: func(_ context.Context, _ *cli.Command) error {
-			commit, err := conventional.BuildCommitMessage(&commit)
+			message, err := conventional.BuildCommitMessage(&commitData)
 			if err != nil {
 				return fmt.Errorf("error building commit: %w", err)
 			}
 
-			_, err = fmt.Println(commit)
+			_, err = fmt.Println(message)
 			if err != nil {
 				return fmt.Errorf("error printing built commit message: %w", err)
 			}
@@ -35,47 +35,47 @@ func commit() *cli.Command {
 	}
 }
 
-func flags(commit *conventional.Commit) []cli.Flag {
+func flags(commitData *conventional.Commit) []cli.Flag {
 	return []cli.Flag{
 		&cli.StringFlag{
 			Name:        "type",
 			OnlyOnce:    true,
-			Destination: &commit.Type,
+			Destination: &commitData.Type,
 			Required:    true,
 			Usage:       "Type of change (e.g., feat, fix, docs)",
 		},
 		&cli.StringFlag{
 			Name:        "scope",
 			OnlyOnce:    true,
-			Destination: &commit.Scope,
+			Destination: &commitData.Scope,
 			Required:    false,
 			Usage:       "Optional context for the change (e.g., api, cli)",
 		},
 		&cli.StringFlag{
 			Name:        "title",
 			OnlyOnce:    true,
-			Destination: &commit.Title,
+			Destination: &commitData.Title,
 			Required:    true,
 			Usage:       "Short description of changes",
 		},
 		&cli.StringFlag{
 			Name:        "body",
 			OnlyOnce:    true,
-			Destination: &commit.Body,
+			Destination: &commitData.Body,
 			Required:    false,
 			Usage:       "Optional longer description of the change",
 		},
 		&cli.StringFlag{
 			Name:        "breaking",
 			OnlyOnce:    true,
-			Destination: &commit.BreakingChange,
+			Destination: &commitData.BreakingChange,
 			Required:    false,
 			Usage:       "Optional description of breaking changes introduced with commit",
 		},
 		&cli.StringFlag{
 			Name:        "issue",
 			OnlyOnce:    true,
-			Destination: &commit.Issue,
+			Destination: &commitData.Issue,
 			Required:    false,
 			Usage:       "Optional issue number",
 		},

internal/conventional/message_test.go

@@ -0,0 +1,110 @@
+package conventional
+
+import (
+	"strconv"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+type (
+	testCases struct {
+		commitData *Commit
+		err        error
+		result     string
+	}
+)
+
+var buildCommitMessageTestCases = []testCases{
+	{
+		result: "feat(api): some changes\n\nChanges description\n",
+		commitData: &Commit{
+			Title: "some changes",
+			Type:  "feat",
+			Scope: "api",
+			Body:  "Changes description",
+		},
+		err: nil,
+	},
+	{
+		result: "feat(api): some changes\n",
+		commitData: &Commit{
+			Title: "some changes",
+			Type:  "feat",
+			Scope: "api",
+		},
+		err: nil,
+	},
+	{
+		result: "feat: some changes\n\nChanges description\n",
+		commitData: &Commit{
+			Title: "some changes",
+			Type:  "feat",
+			Body:  "Changes description",
+		},
+		err: nil,
+	},
+	{
+		result: "feat(api): some changes\n\nChanges description\n\nIssue: TEST-1\n",
+		commitData: &Commit{
+			Title: "some changes",
+			Type:  "feat",
+			Scope: "api",
+			Body:  "Changes description",
+			Issue: "TEST-1",
+		},
+		err: nil,
+	},
+	{
+		result: "feat(api)!: some changes\n\nChanges description\n\nBREAKING CHANGE: Something breaking\nIssue: TEST-1\n",
+		commitData: &Commit{
+			Title:          "some changes",
+			Type:           "feat",
+			Scope:          "api",
+			Body:           "Changes description",
+			Issue:          "TEST-1",
+			BreakingChange: "Something breaking",
+		},
+		err: nil,
+	},
+	{
+		result: "feat!: some changes\n\nChanges description\n\nBREAKING CHANGE: Something breaking\n",
+		commitData: &Commit{
+			Title:          "some changes",
+			Type:           "feat",
+			Body:           "Changes description",
+			BreakingChange: "Something breaking",
+		},
+		err: nil,
+	},
+	{
+		result: "",
+		commitData: &Commit{
+			Type: "feat",
+			Body: "Changes description",
+		},
+		err: ErrRequiredPartNotPreset,
+	},
+	{
+		result: "",
+		commitData: &Commit{
+			Title: "some changes",
+			Body:  "Changes description",
+		},
+		err: ErrRequiredPartNotPreset,
+	},
+}
+
+func TestBuildCommitMessage(t *testing.T) {
+	t.Parallel()
+	for i, tt := range buildCommitMessageTestCases {
+		t.Run(strconv.Itoa(i), func(t *testing.T) {
+			t.Parallel()
+
+			message, err := BuildCommitMessage(tt.commitData)
+
+			assert.Equal(t, tt.result, message)
+			assert.ErrorIs(t, err, tt.err)
+		})
+	}
+}