[GO] Go Server: Adds ordered routes to go-server router (#21280)

* Adds ordered routes to go-server router

* Generate and fix test

* Newline

* Readd escaping

* Fixes go router unit test

* Updates tests, one more time

Author: spencercornish-wk

modules/openapi-generator/src/main/resources/go-server/controller-api.mustache

@@ -66,14 +66,33 @@ func (c *{{classname}}Controller) Routes() Routes {
 {{#operations}}
 	{{#operation}}
 		"{{operationId}}": Route{
+			"{{{operationId}}}",
 			strings.ToUpper("{{httpMethod}}"),
 			"{{{basePathWithoutHost}}}{{{path}}}",
 			c.{{operationId}},
 		},
 	{{/operation}}
 {{/operations}}
 	}
-}{{#operations}}{{#operation}}
+}
+
+// OrderedRoutes returns all the api routes in a deterministic order for the {{classname}}Controller
+func (c *{{classname}}Controller) OrderedRoutes() []Route {
+	return []Route{
+{{#operations}}
+	{{#operation}}
+		Route{
+			"{{{operationId}}}",
+			strings.ToUpper("{{httpMethod}}"),
+			"{{{basePathWithoutHost}}}{{{path}}}",
+			c.{{operationId}},
+		},
+	{{/operation}}
+{{/operations}}
+	}
+}
+
+{{#operations}}{{#operation}}
 
 // {{nickname}} - {{{summary}}}
 {{#isDeprecated}}

modules/openapi-generator/src/main/resources/go-server/routers.mustache

@@ -21,8 +21,9 @@ import (
 
 // A Route defines the parameters for an api endpoint
 type Route struct {
-	Method	  string
-	Pattern	 string
+	Name        string
+	Method	    string
+	Pattern	    string
 	HandlerFunc http.HandlerFunc
 }
 
@@ -32,6 +33,7 @@ type Routes map[string]Route
 // Router defines the required methods for retrieving api routes
 type Router interface {
 	Routes() Routes
+	OrderedRoutes() []Route
 }
 
 // NewRouter creates a new router for any number of api routers
@@ -49,19 +51,19 @@ func NewRouter(routers ...Router) {{#routers}}{{#mux}}*mux.Router{{/mux}}{{#chi}
 	{{/chi}}
 {{/routers}}
 	for _, api := range routers {
-		for {{#routers}}{{#mux}}name{{/mux}}{{#chi}}_{{/chi}}{{/routers}}, route := range api.Routes() {
+		for _, route := range api.OrderedRoutes() {
 			var handler http.Handler = route.HandlerFunc
 {{#routers}}
 	{{#mux}}
-			handler = Logger(handler, name)
+			handler = Logger(handler, route.Name)
 			{{#featureCORS}}
 			handler = handlers.CORS()(handler)
 			{{/featureCORS}}
 
 			router.
 				Methods(route.Method).
 				Path(route.Pattern).
-				Name(name).
+				Name(route.Name).
 				Handler(handler)
 	{{/mux}}
 	{{#chi}}

modules/openapi-generator/src/test/java/org/openapitools/codegen/goserver/GoServerCodegenTest.java

@@ -70,7 +70,7 @@ public void verifyOrder() throws IOException {
         // verify /getPath/latest is first route
         Assert.assertEquals(Files.readAllLines(Paths.get(output + "/go/api_dev.go")).get(52), "\t\t\"GetLatest\": Route{");
         // verify /getPath/{id} is second route
-        Assert.assertEquals(Files.readAllLines(Paths.get(output + "/go/api_dev.go")).get(57), "\t\t\"GetById\": Route{");
+        Assert.assertEquals(Files.readAllLines(Paths.get(output + "/go/api_dev.go")).get(58), "\t\t\"GetById\": Route{");
 
     }