From 6218327fd2b131f3ae8c71c6c32aee81ba4c06d6 Mon Sep 17 00:00:00 2001
From: xdrm-brackets <xdrm.brackets.dev@gmail.com>
Date: Thu, 21 Nov 2019 22:18:00 +0100
Subject: [PATCH] expand internal/config test coverage

- make parameter type "?" invalid as it marks it as optional only
- check optional vs. required parameters
- test subservice in method description error check
---
 internal/config/config_test.go | 85 +++++++++++++++++++++++++++++++++-
 internal/config/method.go      |  2 +-
 2 files changed, 85 insertions(+), 2 deletions(-)

diff --git a/internal/config/config_test.go b/internal/config/config_test.go
index 08e183c..3d0c19c 100644
--- a/internal/config/config_test.go
+++ b/internal/config/config_test.go
@@ -146,6 +146,18 @@ func TestParseMissingMethodDescription(t *testing.T) {
 			}`,
 			ErrFormat.Wrap(ErrMissingMethodDesc.WrapString("GET /")),
 		},
+		{ // missing description
+			`{
+				"/": {
+					"subservice": {
+						"GET": {
+
+						}
+					}
+				}
+			}`,
+			ErrFormat.Wrap(ErrMissingMethodDesc.WrapString("GET subservice")),
+		},
 		{ // empty description
 			`{
 				"GET": {
@@ -197,6 +209,46 @@ func TestParseMissingMethodDescription(t *testing.T) {
 
 }
 
+func TestOptionalParam(t *testing.T) {
+	reader := strings.NewReader(`{
+		"GET": {
+			"info": "info",
+			"in": {
+				"optional": { "info": "valid-desc", "type": "?optional-type" },
+				"required": { "info": "valid-desc", "type": "required-type" },
+				"required2": { "info": "valid-desc", "type": "a" },
+				"optional2": { "info": "valid-desc", "type": "?a" }
+			}
+		}
+	}`)
+	srv, err := Parse(reader)
+	if err != nil {
+		t.Errorf("unexpected error: '%s'", err)
+		t.FailNow()
+	}
+
+	method := srv.Method(http.MethodGet)
+	if method == nil {
+		t.Errorf("expected GET method not to be nil")
+		t.FailNow()
+	}
+	for pName, param := range method.Parameters {
+
+		if pName == "optional" || pName == "optional2" {
+			if !param.Optional {
+				t.Errorf("expected parameter '%s' to be optional", pName)
+				t.Failed()
+			}
+		}
+		if pName == "required" || pName == "required2" {
+			if param.Optional {
+				t.Errorf("expected parameter '%s' to be required", pName)
+				t.Failed()
+			}
+		}
+	}
+
+}
 func TestParseParameters(t *testing.T) {
 	tests := []struct {
 		Raw              string
@@ -284,6 +336,22 @@ func TestParseParameters(t *testing.T) {
 			ErrFormat.Wrap(ErrMissingParamType.WrapString("GET / {param1}")),
 			nil,
 		},
+		{ // invalid type (optional mark only)
+			`{
+				"GET": {
+					"info": "info",
+					"in": {
+						"param1": {
+							"info": "valid",
+							"type": "?"
+						}
+					}
+				}
+			}`,
+
+			ErrFormat.Wrap(ErrMissingParamType.WrapString("GET / {param1}")),
+			ErrFormat.Wrap(ErrMissingParamType.WrapString("GET / {param1}")),
+		},
 		{ // valid description + valid type
 			`{
 				"GET": {
@@ -291,7 +359,22 @@ func TestParseParameters(t *testing.T) {
 					"in": {
 						"param1": {
 							"info": "valid",
-							"type": "valid"
+							"type": "a"
+						}
+					}
+				}
+			}`,
+			nil,
+			nil,
+		},
+		{ // valid description + valid OPTIONAL type
+			`{
+				"GET": {
+					"info": "info",
+					"in": {
+						"param1": {
+							"info": "valid",
+							"type": "?valid"
 						}
 					}
 				}
diff --git a/internal/config/method.go b/internal/config/method.go
index 5131fdc..a17df24 100644
--- a/internal/config/method.go
+++ b/internal/config/method.go
@@ -61,7 +61,7 @@ func (methodDef *Method) checkAndFormat(servicePath string, httpMethod string) e
 		}
 
 		// 3.4. Manage invalid type
-		if len(pData.Type) < 1 {
+		if len(pData.Type) < 1 || pData.Type == "?" {
 			return ErrMissingParamType.WrapString(httpMethod + " " + servicePath + " {" + pName + "}")
 		}