more documentation and one more example

nitram509 · nitram509 · commit 8c3a403a7076 · 2020-11-25T14:37:30.000+01:00
diff --git a/README.md b/README.md
@@ -1 +1,33 @@
-# clean-test-code-showcase
+# golang-clean-test-code-showcase
+
+A showcase, of how unit test can be written.
+No claim to be complete here.
+
+### Business requirement - for this demo purpose
+
+This showcase/demo library has some acceptance criteria
+
+* as a developer I would like to extract meaningful information from a condensed firmware string literal
+* the information extraction must work on a single line string
+* the information extraction must work on multi-line strings, separated by newline (\\n) 
+* these fields must be available in the meaningful extracted information (struct)
+   * FirmwareName,TargetName,TargetDetail,Version,ReleaseDateStr,GitHash,ReleaseTime
+
+Example firmware String: \
+```Betaflight / SPRACINGF3EVO (SPEV) 3.4.0 Apr 17 2018 / 14:00:13 (b2c247d34) MSP API: 1.39```
+
+### Implementations
+
+1. Using native/vanilla GO language and library
+2. Using famous [stretchr/testify](https://github.com/stretchr/testify) library
+3. Using broken and outdated [rdrdr/hamcrest](https://github.com/corbym/gocrest) library
+4. Using almost unknown [corbym/gocrest](https://github.com/corbym/gocrest) library
+
+### What is / Why "HAMCREST"?
+
+[Hamcrest](http://hamcrest.org/) is a famous Java Library, that was developed to make
+unit tests in Java more readable and follow [Clean Code principles](https://de.wikipedia.org/wiki/Clean_Code)
+
+Cite from hamcrest.org ... \
+*Matchers that can be combined to create flexible expressions of intent* \
+*Born in Java, Hamcrest now has implementations in a number of languages*
diff --git a/go.mod b/go.mod
@@ -4,5 +4,6 @@ go 1.14
 
 require (
 	github.com/corbym/gocrest v1.0.3
+	github.com/rdrdr/hamcrest v0.0.0-20110214224206-601bfe136b59
 	github.com/stretchr/testify v1.6.1
 )
diff --git a/go.sum b/go.sum
@@ -4,6 +4,8 @@ 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/rdrdr/hamcrest v0.0.0-20110214224206-601bfe136b59 h1:89mA0FGOUc6g/K1lNBI50bm73w2YQY0jtWEpF4BSj4c=
+github.com/rdrdr/hamcrest v0.0.0-20110214224206-601bfe136b59/go.mod h1:/KOFTlW27+voCV5Icl9s18JDpulqhqVBu2iIIAK50ps=
 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=
diff --git a/parser_1_golang_test.go b/parser_1_golang_test.go
@@ -5,6 +5,7 @@ import (
 )
 
 // See https://golang.org/pkg/testing/
+// The quasi standard ;)
 
 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")
diff --git a/parser_2_testify_test.go b/parser_2_testify_test.go
@@ -5,6 +5,9 @@ import (
 	"testing"
 )
 
+// See https://github.com/stretchr/testify
+// (ca. 12k Stars on Github)
+
 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")
 
diff --git a/parser_3_hamcrest_test.go b/parser_3_hamcrest_test.go
@@ -0,0 +1,37 @@
+package parser
+
+import (
+	"github.com/rdrdr/hamcrest/asserter"
+	"github.com/rdrdr/hamcrest/core"
+	"testing"
+)
+
+// See https://github.com/corbym/gocrest
+// (exactly 27 Stars on Github)
+
+// BROKEN ?!?! Last Release from 2011?
+
+func Test_betaflight_message_can_be_parsed__with_HAMCREST(t *testing.T) {
+	info := ParseFirmwareInformation("# Betaflight / SPRACINGF3EVO (SPEV) 3.4.0 Apr 17 2018 / 14:00:13 (b2c247d34) MSP API: 1.39")
+
+	we := asserter.Using(t)
+	we.AssertThat(info.FirmwareName, core.EqualTo("Betaflight").Comment("FirmwareName field"))
+	we.AssertThat(info.TargetName, core.EqualTo("SPRACINGF3EVO"))
+	we.AssertThat(info.TargetDetail, core.EqualTo("SPEV"))
+	we.AssertThat(info.Version, core.GreaterThanOrEqualTo(int64(3)))
+	we.AssertThat(info.ReleaseDateStr, core.EqualTo("Apr 17 2018"))
+	we.AssertThat(info.ReleaseTime, core.EqualTo("14:00:13"))
+	we.AssertThat(info.GitHash, core.EqualTo("b2c247d34"))
+}
+
+func Test_parsing_multiple_lines_returns_first_hit__with_HAMCREST(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",
+	)
+
+	we := asserter.Using(t)
+	we.AssertThat(info.FirmwareName, core.EqualTo("Betaflight1").Comment("FirmwareName"))
+	we.AssertThat(info.TargetName, core.EqualTo("SPRACINGF3EVO1"))
+}
diff --git a/parser_4_gocrest_test.go b/parser_4_gocrest_test.go
@@ -6,6 +6,9 @@ import (
 	"testing"
 )
 
+// See https://github.com/corbym/gocrest
+// (exactly 11 Stars on Github)
+
 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")
 
diff --git a/parser_test.go b/parser_test.go
@@ -5,6 +5,9 @@ import (
 	"testing"
 )
 
+// AUTO GENERATED code by IntelliJ
+// TODO implement ;)
+
 func TestParseFirmwareInformation(t *testing.T) {
 	type args struct {
 		text string

Original file line number	Diff line number	Diff line change
`@@ -4,5 +4,6 @@ go 1.14`
`4`	`4`
`5`	`5`	`require (`
`6`	`6`	`github.com/corbym/gocrest v1.0.3`
	`7`	`+ github.com/rdrdr/hamcrest v0.0.0-20110214224206-601bfe136b59`
`7`	`8`	`github.com/stretchr/testify v1.6.1`
`8`	`9`	`)`
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@ import (`
`5`	`5`	`)`
`6`	`6`
`7`	`7`	`// See https://golang.org/pkg/testing/`
	`8`	`+// The quasi standard ;)`
`8`	`9`
`9`	`10`	`func Test_betaflight_message_can_be_parsed__with_GOLANG(t *testing.T) {`
`10`	`11`	`info := ParseFirmwareInformation("# Betaflight / SPRACINGF3EVO (SPEV) 3.4.0 Apr 17 2018 / 14:00:13 (b2c247d34) MSP API: 1.39")`
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,9 @@ import (`
`5`	`5`	`"testing"`
`6`	`6`	`)`
`7`	`7`
	`8`	`+// See https://github.com/stretchr/testify`
	`9`	`+// (ca. 12k Stars on Github)`
	`10`	`+`
`8`	`11`	`func Test_betaflight_message_can_be_parsed__with_TESTIFY(t *testing.T) {`
`9`	`12`	`info := ParseFirmwareInformation("# Betaflight / SPRACINGF3EVO (SPEV) 3.4.0 Apr 17 2018 / 14:00:13 (b2c247d34) MSP API: 1.39")`
`10`	`13`
Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,9 @@ import (`
`6`	`6`	`"testing"`
`7`	`7`	`)`
`8`	`8`
	`9`	`+// See https://github.com/corbym/gocrest`
	`10`	`+// (exactly 11 Stars on Github)`
	`11`	`+`
`9`	`12`	`func Test_betaflight_message_can_be_parsed__with_GOCREST(t *testing.T) {`
`10`	`13`	`info := ParseFirmwareInformation("# Betaflight / SPRACINGF3EVO (SPEV) 3.4.0 Apr 17 2018 / 14:00:13 (b2c247d34) MSP API: 1.39")`
`11`	`14`
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,9 @@ import (`
`5`	`5`	`"testing"`
`6`	`6`	`)`
`7`	`7`
	`8`	`+// AUTO GENERATED code by IntelliJ`
	`9`	`+// TODO implement ;)`
	`10`	`+`
`8`	`11`	`func TestParseFirmwareInformation(t *testing.T) {`
`9`	`12`	`type args struct {`
`10`	`13`	`text string`