add test showcases

Author: nitram509

.gitignore

@@ -0,0 +1,2 @@
+.idea
+*.iml

go.mod

@@ -0,0 +1,8 @@
+module github.com/nitram509/golang-clean-test-code-showcase
+
+go 1.14
+
+require (
+	github.com/corbym/gocrest v1.0.3
+	github.com/stretchr/testify v1.6.1
+)

go.sum

@@ -0,0 +1,13 @@
+github.com/corbym/gocrest v1.0.3 h1:gwEdq6RkTmq+09CTuM29DfKOCtZ7G7bcyxs3IZ6EVdU=
+github.com/corbym/gocrest v1.0.3/go.mod h1:maVFL5lbdS2PgfOQgGRWDYTeunSWQeiEgoNdTABShCs=
+github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8=
+github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
+github.com/stretchr/testify v1.6.1 h1:hDPOHmpOpP40lSULcqw7IrRb/u7w6RpDC9399XyoNd0=
+github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

parser.go

@@ -1,20 +1,19 @@
-package configurations
+package parser
 
 import (
 	"regexp"
+	"strconv"
 	"strings"
 )
 
 type FirmwareInformation struct {
 	FirmwareName   string
 	TargetName     string
 	TargetDetail   string
-	Version        string
+	Version        int64
 	ReleaseDateStr string
 	GitHash        string
 	ReleaseTime    string
-	// extended
-	ReleaseNotesUrl string
 }
 
 func ParseFirmwareInformation(text string) *FirmwareInformation {
@@ -34,7 +33,7 @@ func createSearchExpression() (*regexp.Regexp, error) {
 		"(\\w+)?\\s/\\s" +
 		"(\\w+)?\\s" +
 		"\\((\\w+)\\)\\s" +
-		"(\\d+\\.\\d+\\.\\d+)?\\s" +
+		"(\\d+)\\.\\d+\\.\\d+\\s" +
 		"(\\w+\\s\\d+\\s\\d{4})?\\s/\\s" +
 		"(\\d+:\\d+:\\d+)?\\s" +
 		"\\((\\w+)\\)?")
@@ -52,7 +51,7 @@ func parseLine(regex *regexp.Regexp, text string) *FirmwareInformation {
 			info.TargetDetail = string(submatch[3])
 		}
 		if len(submatch) > 4 {
-			info.Version = string(submatch[4])
+			info.Version, _ = strconv.ParseInt(string(submatch[4]), 10, 64)
 		}
 		if len(submatch) > 5 {
 			info.ReleaseDateStr = string(submatch[5])

parser_1_golang_test.go

@@ -0,0 +1,48 @@
+package parser
+
+import (
+	"testing"
+)
+
+// See https://golang.org/pkg/testing/
+
+func Test_betaflight_message_can_be_parsed__with_GOLANG(t *testing.T) {
+	info := ParseFirmwareInformation("# Betaflight / SPRACINGF3EVO (SPEV) 3.4.0 Apr 17 2018 / 14:00:13 (b2c247d34) MSP API: 1.39")
+
+	if info.FirmwareName != "Betaflight" {
+		t.Errorf("FirmwareName = %s; want Betaflight", info.FirmwareName)
+	}
+	if info.TargetName != "SPRACINGF3EVO" {
+		t.Errorf("TargetName = %s; want SPRACINGF3EVO", info.TargetName)
+	}
+	if info.TargetDetail != "SPEV" {
+		t.Errorf("TargetDetail = %s; want SPEV", info.TargetDetail)
+	}
+	if !(info.Version >= int64(3)) {
+		t.Errorf("Version = %d; want less than 3", info.Version)
+	}
+	if info.ReleaseDateStr != "Apr 17 2018" {
+		t.Errorf("ReleaseDateStr = %s; want Apr 17 2018", info.ReleaseDateStr)
+	}
+	if info.ReleaseTime != "14:00:13" {
+		t.Errorf("ReleaseTime = %s; want 14:00:13", info.ReleaseTime)
+	}
+	if info.GitHash != "b2c247d34" {
+		t.Errorf("GitHash = %s; want b2c247d34", info.GitHash)
+	}
+}
+
+func Test_xparsing_multiple_lines_returns_first_hit__with_GOLANG(t *testing.T) {
+	info := ParseFirmwareInformation(
+		"# bla blubber\n" +
+			"# Betaflight1 / SPRACINGF3EVO1 (SPEV) 3.4.0 Apr 17 2018 / 14:00:13 (b2c247d34) MSP API: 1.39\n" +
+			"# Betaflight2 / SPRACINGF3EVO2 (SPEV) 3.4.0 Apr 17 2018 / 14:00:13 (b2c247d34) MSP API: 1.39",
+	)
+
+	if info.FirmwareName != "Betaflight1" {
+		t.Errorf("FirmwareName = %s; want Betaflight1", info.FirmwareName)
+	}
+	if info.TargetName != "SPRACINGF3EVO1" {
+		t.Errorf("TargetName = %s; want SPRACINGF3EVO1", info.TargetName)
+	}
+}

parser_2_testify_test.go

@@ -0,0 +1,29 @@
+package parser
+
+import (
+	"github.com/stretchr/testify/assert"
+	"testing"
+)
+
+func Test_betaflight_message_can_be_parsed__with_TESTIFY(t *testing.T) {
+	info := ParseFirmwareInformation("# Betaflight / SPRACINGF3EVO (SPEV) 3.4.0 Apr 17 2018 / 14:00:13 (b2c247d34) MSP API: 1.39")
+
+	assert.Equal(t, info.FirmwareName, "Betaflight")
+	assert.Equal(t, info.TargetName, "SPRACINGF3EVO")
+	assert.Contains(t, info.TargetName, "RACING")
+	assert.GreaterOrEqualf(t, info.Version, int64(3), "error message %s")
+	assert.Equal(t, info.ReleaseDateStr, "Apr 17 2018")
+	assert.Equal(t, info.ReleaseTime, "14:00:13")
+	assert.Equal(t, info.GitHash, "b2c247d34")
+}
+
+func Test_parsing_multiple_lines_returns_first_hit__with_TESTIFY(t *testing.T) {
+	info := ParseFirmwareInformation(
+		"# bla blubber\n" +
+			"# Betaflight1 / SPRACINGF3EVO1 (SPEV) 3.4.0 Apr 17 2018 / 14:00:13 (b2c247d34) MSP API: 1.39\n" +
+			"# Betaflight2 / SPRACINGF3EVO2 (SPEV) 3.4.0 Apr 17 2018 / 14:00:13 (b2c247d34) MSP API: 1.39",
+	)
+
+	assert.Equal(t, "Betaflight1", info.FirmwareName)
+	assert.Equal(t, "SPRACINGF3EVO1", info.TargetName)
+}

parser_3_gocrest_test.go

@@ -0,0 +1,30 @@
+package parser
+
+import (
+	"github.com/corbym/gocrest/is"
+	"github.com/corbym/gocrest/then"
+	"testing"
+)
+
+func Test_betaflight_message_can_be_parsed__with_GOCREST(t *testing.T) {
+	info := ParseFirmwareInformation("# Betaflight / SPRACINGF3EVO (SPEV) 3.4.0 Apr 17 2018 / 14:00:13 (b2c247d34) MSP API: 1.39")
+
+	then.AssertThat(t, info.FirmwareName, is.EqualTo("Betaflight"))
+	then.AssertThat(t, info.TargetName, is.EqualTo("SPRACINGF3EVO"))
+	then.AssertThat(t, info.TargetDetail, is.EqualTo("SPEV"))
+	then.AssertThat(t, info.Version, is.GreaterThanOrEqualTo(int64(3)))
+	then.AssertThat(t, info.ReleaseDateStr, is.EqualTo("Apr 17 2018"))
+	then.AssertThat(t, info.ReleaseTime, is.EqualTo("14:00:13"))
+	then.AssertThat(t, info.GitHash, is.EqualTo("b2c247d34"))
+}
+
+func Test_parsing_multiple_lines_returns_first_hit__with_GOCREST(t *testing.T) {
+	info := ParseFirmwareInformation(
+		"# bla blubber\n" +
+			"# Betaflight1 / SPRACINGF3EVO1 (SPEV) 3.4.0 Apr 17 2018 / 14:00:13 (b2c247d34) MSP API: 1.39\n" +
+			"# Betaflight2 / SPRACINGF3EVO2 (SPEV) 3.4.0 Apr 17 2018 / 14:00:13 (b2c247d34) MSP API: 1.39",
+	)
+
+	then.AssertThat(t, info.FirmwareName, is.EqualTo("Betaflight1"))
+	then.AssertThat(t, info.TargetName, is.EqualTo("SPRACINGF3EVO1"))
+}

parser_test.go

@@ -1,29 +1,26 @@
-package configurations
+package parser
 
 import (
-	"github.com/corbym/gocrest/is"
-	"github.com/corbym/gocrest/then"
+	"reflect"
 	"testing"
 )
 
-func Test_betaflight_message_can_be_parsed(t *testing.T) {
-	info := ParseFirmwareInformation("# Betaflight / SPRACINGF3EVO (SPEV) 3.4.0 Apr 17 2018 / 14:00:13 (b2c247d34) MSP API: 1.39")
-	then.AssertThat(t, info.FirmwareName, is.EqualTo("Betaflight"))
-	then.AssertThat(t, info.TargetName, is.EqualTo("SPRACINGF3EVO"))
-	then.AssertThat(t, info.TargetDetail, is.EqualTo("SPEV"))
-	then.AssertThat(t, info.Version, is.EqualTo("3.4.0"))
-	then.AssertThat(t, info.ReleaseDateStr, is.EqualTo("Apr 17 2018"))
-	then.AssertThat(t, info.ReleaseTime, is.EqualTo("14:00:13"))
-	then.AssertThat(t, info.GitHash, is.EqualTo("b2c247d34"))
-}
-
-func Test_parsing_multiple_lines_returns_first_hit(t *testing.T) {
-	info := ParseFirmwareInformation(
-		"# bla blubber\n" +
-			"# Betaflight1 / SPRACINGF3EVO1 (SPEV) 3.4.0 Apr 17 2018 / 14:00:13 (b2c247d34) MSP API: 1.39\n" +
-			"# Betaflight2 / SPRACINGF3EVO2 (SPEV) 3.4.0 Apr 17 2018 / 14:00:13 (b2c247d34) MSP API: 1.39",
-	)
-
-	then.AssertThat(t, info.FirmwareName, is.EqualTo("Betaflight1"))
-	then.AssertThat(t, info.TargetName, is.EqualTo("SPRACINGF3EVO1"))
+func TestParseFirmwareInformation(t *testing.T) {
+	type args struct {
+		text string
+	}
+	tests := []struct {
+		name string
+		args args
+		want *FirmwareInformation
+	}{
+		// TODO: Add test cases.
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			if got := ParseFirmwareInformation(tt.args.text); !reflect.DeepEqual(got, tt.want) {
+				t.Errorf("ParseFirmwareInformation() = %v, want %v", got, tt.want)
+			}
+		})
+	}
 }