[golang] Issue aeron-io#435 References inside messageHeader not working

Generate the MessageHeader as though it was a composite as it's not compulsorarily standardized in the standard. Provide an optimized separate MessageHeader for use when people follow the recommended MessageHeader as most people will do just that. Fix <ref tags> to use the underlying type find token.acceptableTypeName() rather than token.name(). In golang references had previously been worked around for sets/choices/composites but not MessageHeaders. This makes them all work the same way and more properly but it does introduce some monor changes to generated types. Fix the tests, examples and benchmarks to reflect these changes, adding an issue435.xml for testing with test code to match. Fix the java interop test which used the sbe-samples example-schema which has now been modified. This also causes the bigendian test to be revised. Documentation updates to match.

Author: billsegall

.gitignore

@@ -78,6 +78,8 @@ gocode/src/mktdata/*.go
 !gocode/src/mktdata/*_test.go
 gocode/src/simple/*.go
 !gocode/src/simple/*_test.go
+gocode/src/issue*/*.go
+!gocode/src/issue*/*_test.go
 gocode/src/*/*/*.go
 !gocode/src/*/*/*_test.go
 gocode/src/example-schema/example-schema*

README.md

@@ -125,6 +125,6 @@ tests and containes some examples
 
 Users of golang generated code should see the [user
 documentation](https://github.com/real-logic/simple-binary-encoding/wiki/Golang-User-Guide). Developers
-wishing to enhance golang generator should see the [developer
+wishing to enhance the golang generator should see the [developer
 documentation](https://github.com/real-logic/simple-binary-encoding/blob/master/gocode/README.md)
 

build.gradle

@@ -508,6 +508,7 @@ task(generateGolangCodecsWithXSD, type:JavaExec) {
  'gocode/resources/example-extension-2-schema.xml',
  'gocode/resources/group-with-data-extension-schema.xml',
  'gocode/resources/simple.xml',
+ 'gocode/resources/issue435.xml',
  'sbe-samples/src/main/resources/example-schema.xml',
  'sbe-samples/src/main/resources/example-extension-schema.xml' ]
 }
@@ -566,4 +567,4 @@ task runBenchmarks(type: Exec) {
 task uploadToMavenCentral {
  dependsOn 'sbe-tool:uploadArchives', 'sbe-samples:uploadArchives', 'sbe-benchmarks:uploadArchives',
  'sbe-all:uploadArchives', 'sbe-all:uploadShadow'
-}
+}

gocode/Makefile

@@ -38,7 +38,7 @@ src/example-schema/example-schema: $(DEP)
 go fmt && \
 ./example-schema)
 
-bench: $(DEP) src/example-schema/example-schema.test
+bench: $(DEP)
 (export GOPATH=$(GOPATH) && \
  cd src/example-schema && \
 go test --bench . -cpuprofile=cpu.out && \
@@ -68,7 +68,7 @@ test: $(DEP)
 go install \
 ;done))
 (export GOPATH=$(GOPATH) && \
-(for t in mktdata group_with_data group_with_data_extension composite_element composite simple; do \
+(for t in mktdata group_with_data group_with_data_extension composite_elements composite simple issue435; do \
 cd $(GOPATH)/src/$$t && \
 go build && \
 go fmt && \

gocode/README.md

@@ -1,21 +1,21 @@
 Overview
 ========
 
-There is now a [user
-guide]https://github.com/real-logic/simple-binary-encoding/wiki/Golang-User-Guide
+There is now a
+[user guide](https://github.com/real-logic/simple-binary-encoding/wiki/Golang-User-Guide)
 and this document is for development of the SBE golang generator.
 
 Code Layout
 -----------
 The Java code that performs the generation of golang code is
-[here]https://github.com/real-logic/simple-binary-encoding/tree/master/sbe-tool/src/main/java/uk/co/real_logic/sbe/generation/golang.
+[here](https://github.com/real-logic/simple-binary-encoding/tree/master/sbe-tool/src/main/java/uk/co/real_logic/sbe/generation/golang).
 
-Golang code used for testing resides in the top-level [gocode
-directory]https://github.com/real-logic/simple-binary-encoding/tree/master/gocode
+Golang code used for testing resides in the top-level
+[gocode directory](https://github.com/real-logic/simple-binary-encoding/tree/master/gocode).
 
 Building and testing
 --------------------
-At some point teh golang build will be better integrated into
+At some point the golang build will be better integrated into
 gradle. For the time being some instructions/procedures are encoded
 into a gnu Makefile in the top level gocode directory
 
@@ -50,23 +50,15 @@ test code for them.
 Design choices
 --------------
 Most of the design choice rationale is contained in the user guide
-however, Some design decisions are based around the structure of
-sbe-tool itself. sbe-tool parses the XML into an internal
-representation (IR) and then passes this to the language specific
-generator. As a result some information on the xml structure has been
-lost.
+however, some design decisions are based around the structure of
+sbe-tool itself.
 
-The first example of this include the use of the `<ref>` tag which if
-used to the same underlying type in a composite will create two
-differently named definitions of the type in the IR.
-
-A second example occurs where a field references an aliased primitive
-type definition in which case we lose the aliased type name in the IR
-as it is unreferenced.
+sbe-tool parses the XML into an internal representation (IR) and then
+passes this to the language specific generator. It is this IR which a
+generator processes.
 
 Roadmap
 =======
  * Windows developer support (currently tested on Linux/MacOS)
- * Unnecessary code removal (e.g., GroupSizeEncoding)
  * Further Unicode support
  * Testing/Bug fixes

gocode/resources/example-bigendian.xml

@@ -27,6 +27,7 @@
  <type name="VehicleCode" primitiveType="char" length="6" characterEncoding="ASCII"/>
  <type name="Ron" primitiveType="uint8" minValue="90" maxValue="110"/>
  <type name="someNumbers" primitiveType="uint32" length="5"/>
+ <type name="Percentage" primitiveType="int8" minValue="0" maxValue="100"/>
  <composite name="Booster">
  <enum name="BoostType" encodingType="char">
  <validValue name="TURBO">T</validValue>
@@ -42,6 +43,8 @@
  <type name="maxRpm" primitiveType="uint16" presence="constant">9000</type>
  <type name="manufacturerCode" primitiveType="char" length="3"/>
  <type name="fuel" primitiveType="char" presence="constant">Petrol</type>
+ <ref name="efficiency" type="Percentage"/>
+ <ref name="boosterEnabled" type="BooleanType"/>
  <ref name="booster" type="Booster"/>
  </composite>
  <enum name="BooleanType" encodingType="uint8">

gocode/resources/example-extension-2-schema.xml

@@ -28,7 +28,8 @@
  <type name="VehicleCode" primitiveType="char" length="6" characterEncoding="ASCII"/>
  <type name="Ron" primitiveType="uint8" minValue="90" maxValue="110"/>
  <type name="someNumbers" primitiveType="uint32" length="5"/>
- <composite name="Booster">
+ <type name="Percentage" primitiveType="int8" minValue="0" maxValue="100"/>
+ <composite name="Booster">
  <enum name="BoostType" encodingType="char">
  <validValue name="TURBO">T</validValue>
  <validValue name="SUPERCHARGER">S</validValue>
@@ -43,6 +44,8 @@
  <type name="maxRpm" primitiveType="uint16" presence="constant">9000</type>
  <type name="manufacturerCode" primitiveType="char" length="3"/>
  <type name="fuel" primitiveType="char" presence="constant">Petrol</type>
+ <ref name="efficiency" type="Percentage"/>
+ <ref name="boosterEnabled" type="BooleanType"/>
  <ref name="booster" type="Booster"/>
  </composite>
  <enum name="BooleanType" encodingType="uint8">

gocode/resources/issue435.xml

@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<sbe:messageSchema xmlns:sbe="http://fixprotocol.io/2016/sbe"
+ package="issue435"
+ id="435"
+ version="0"
+ semanticVersion="1.0"
+ description="issue 435 test case"
+ byteOrder="bigEndian">
+ <types>
+ <set name="setRef" encodingType="uint8">
+ <choice name="One">0</choice>
+ <choice name="Two">1</choice>
+ </set>
+ <enum name="enumRef" encodingType="uint8">
+ <validValue name="One">0</validValue>
+ <validValue name="Two">1</validValue>
+ </enum>
+ <composite name="messageHeader" description="Message identifiers and length of message root">
+ <type name="blockLength" primitiveType="uint16"/>
+ <type name="templateId" primitiveType="uint16"/>
+ <type name="schemaId" primitiveType="uint16"/>
+ <type name="version" primitiveType="uint16"/>
+ <ref name="s" type="setRef"/>
+ </composite>
+ <composite name="exampleRef">
+ <ref name="e" type="enumRef"/>
+ </composite>
+ </types>
+ <sbe:message name="issue435" id="1" description="issue 435 test">
+<field name="example" type="exampleRef" id="10"/>
+ </sbe:message>
+</sbe:messageSchema>

gocode/src/baseline-bigendian/Car_test.go

@@ -117,7 +117,7 @@ func TestDecodeJavaBuffer(t *testing.T) {
 // made by editing example-schgema to be bigendian and running
 // with the example with -Dsbe.encoding.filename
 // and then decoded using od -tu1
-data := []byte{0, 47, 0, 1, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 4, 210, 7, 221, 1, 65, 0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0, 2, 0, 0, 0, 3, 0, 0, 0, 4, 97, 98, 99, 100, 101, 102, 6, 7, 208, 4, 49, 50, 51, 78, 200, 0, 6, 0, 3, 0, 30, 66, 15, 153, 154, 0, 0, 0, 11, 85, 114, 98, 97, 110, 32, 67, 121, 99, 108, 101, 0, 55, 66, 68, 0, 0, 0, 0, 0, 14, 67, 111, 109, 98, 105, 110, 101, 100, 32, 67, 121, 99, 108, 101, 0, 75, 66, 32, 0, 0, 0, 0, 0, 13, 72, 105, 103, 104, 119, 97, 121, 32, 67, 121, 99, 108, 101, 0, 1, 0, 2, 95, 0, 6, 0, 3, 0, 30, 64, 128, 0, 0, 0, 60, 64, 240, 0, 0, 0, 100, 65, 67, 51, 51, 99, 0, 6, 0, 3, 0, 30, 64, 115, 51, 51, 0, 60, 64, 227, 51, 51, 0, 100, 65, 60, 204, 205, 0, 0, 0, 5, 72, 111, 110, 100, 97, 0, 0, 0, 9, 67, 105, 118, 105, 99, 32, 86, 84, 105, 0, 0, 0, 6, 97, 98, 99, 100, 101, 102}
+data := []byte{0, 49, 0, 1, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 4, 210, 7, 221, 1, 65, 0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0, 2, 0, 0, 0, 3, 0, 0, 0, 4, 97, 98, 99, 100, 101, 102, 6, 7, 208, 4, 49, 50, 51, 35, 1, 78, 200, 0, 6, 0, 3, 0, 30, 66, 15, 153, 154, 0, 0, 0, 11, 85, 114, 98, 97, 110, 32, 67, 121, 99, 108, 101, 0, 55, 66, 68, 0, 0, 0, 0, 0, 14, 67, 111, 109, 98, 105, 110, 101, 100, 32, 67, 121, 99, 108, 101, 0, 75, 66, 32, 0, 0, 0, 0, 0, 13, 72, 105, 103, 104, 119, 97, 121, 32, 67, 121, 99, 108, 101, 0, 1, 0, 2, 95, 0, 6, 0, 3, 0, 30, 64, 128, 0, 0, 0, 60, 64, 240, 0, 0, 0, 100, 65, 67, 51, 51, 99, 0, 6, 0, 3, 0, 30, 64, 115, 51, 51, 0, 60, 64, 227, 51, 51, 0, 100, 65, 60, 204, 205, 0, 0, 0, 5, 72, 111, 110, 100, 97, 0, 0, 0, 9, 67, 105, 118, 105, 99, 32, 86, 84, 105, 0, 0, 0, 6, 97, 98, 99, 100, 101, 102}
 
 buf := bytes.NewBuffer(data)
 m := NewSbeGoMarshaller()

gocode/src/baseline/Car_test.go

@@ -20,7 +20,7 @@ func TestEncodeDecodeCar(t *testing.T) {
 optionalExtras[OptionalExtrasChoice.SportsPack] = true
 
 var engine Engine
-engine = Engine{2000, 4, 0, manufacturerCode, [6]byte{}, EngineBooster{BoostType.NITROUS, 200}}
+engine = Engine{2000, 4, 0, manufacturerCode, [6]byte{}, 42, BooleanType.T, EngineBooster{BoostType.NITROUS, 200}}
 
 manufacturer := []uint8("Honda")
 model := []uint8("Civic VTi")
@@ -115,12 +115,12 @@ func TestDecodeJavaBuffer(t *testing.T) {
 
 // The byte array is from the java example for interop test made by
 // running with -Dsbe.encoding.filename and then decoded using od -tu1
-data := []byte{47, 0, 1, 0, 1, 0, 0, 0, 210, 4, 0, 0, 0, 0, 0, 0, 221, 7, 1, 65, 0, 0, 0, 0, 1, 0, 0, 0, 2, 0, 0, 0, 3, 0, 0, 0, 4, 0, 0, 0, 97, 98, 99, 100, 101, 102, 6, 208, 7, 4, 49, 50, 51, 78, 200, 6, 0, 3, 0, 30, 0, 154, 153, 15, 66, 11, 0, 0, 0, 85, 114, 98, 97, 110, 32, 67, 121, 99, 108, 101, 55, 0, 0, 0, 68, 66, 14, 0, 0, 0, 67, 111, 109, 98, 105, 110, 101, 100, 32, 67, 121, 99, 108, 101, 75, 0, 0, 0, 32, 66, 13, 0, 0, 0, 72, 105, 103, 104, 119, 97, 121, 32, 67, 121, 99, 108, 101, 1, 0, 2, 0, 95, 6, 0, 3, 0, 30, 0, 0, 0, 128, 64, 60, 0, 0, 0, 240, 64, 100, 0, 51, 51, 67, 65, 99, 6, 0, 3, 0, 30, 0, 51, 51, 115, 64, 60, 0, 51, 51, 227, 64, 100, 0, 205, 204, 60, 65, 5, 0, 0, 0, 72, 111, 110, 100, 97, 9, 0, 0, 0, 67, 105, 118, 105, 99, 32, 86, 84, 105, 6, 0, 0, 0, 97, 98, 99, 100, 101, 102, 0, 0, 0, 0, 0, 0, 0, 0}
+data := []byte{49, 0, 1, 0, 1, 0, 0, 0, 210, 4, 0, 0, 0, 0, 0, 0, 221, 7, 1, 65, 0, 0, 0, 0, 1, 0, 0, 0, 2, 0, 0, 0, 3, 0, 0, 0, 4, 0, 0, 0, 97, 98, 99, 100, 101, 102, 6, 208, 7, 4, 49, 50, 51, 35, 1, 78, 200, 6, 0, 3, 0, 30, 0, 154, 153, 15, 66, 11, 0, 0, 0, 85, 114, 98, 97, 110, 32, 67, 121, 99, 108, 101, 55, 0, 0, 0, 68, 66, 14, 0, 0, 0, 67, 111, 109, 98, 105, 110, 101, 100, 32, 67, 121, 99, 108, 101, 75, 0, 0, 0, 32, 66, 13, 0, 0, 0, 72, 105, 103, 104, 119, 97, 121, 32, 67, 121, 99, 108, 101, 1, 0, 2, 0, 95, 6, 0, 3, 0, 30, 0, 0, 0, 128, 64, 60, 0, 0, 0, 240, 64, 100, 0, 51, 51, 67, 65, 99, 6, 0, 3, 0, 30, 0, 51, 51, 115, 64, 60, 0, 51, 51, 227, 64, 100, 0, 205, 204, 60, 65, 5, 0, 0, 0, 72, 111, 110, 100, 97, 9, 0, 0, 0, 67, 105, 118, 105, 99, 32, 86, 84, 105, 6, 0, 0, 0, 97, 98, 99, 100, 101, 102}
 
 buf := bytes.NewBuffer(data)
 m := NewSbeGoMarshaller()
 
-var hdr MessageHeader
+var hdr SbeGoMessageHeader
 if err := hdr.Decode(m, buf); err != nil {
 t.Logf("Failed to decode message header", err)
 t.Fail()