Fix HTTPAPIEX_ExecuteRequest failing with HTTPAPI_REQUEST_HEAD (#528)

The HTTPAPI_REQUEST_TYPE enum is defined using the MU_DEFINE_ENUM
macro, which implicitely adds HTTPAPI_REQUEST_TYPE_INVALID as the first
value. This makes checking the validity of requestType with MU_COUNT_ARG
incorrect: HTTPAPI_REQUEST_TYPE_INVALID is accepted and
HTTPAPI_REQUEST_HEAD is rejected.

Unit tests:
- Change all uses of HTTPAPI_REQUEST_PATCH (the previous last value in the
  enum) to HTTPAPI_REQUEST_HEAD (the current last value in the enum) to test
  that it is accepted.
- Change HTTPAPIEX_ExecuteRequest_fails_with_invalid_request_type to use
  a request type outside of the enum.
- Add HTTPAPIEX_ExecuteRequest_fails_with_invalid_request_type_2, which
  explicitely tests that HTTPAPIEX_INVALID_ARG is rejected.

Co-authored-by: Pierrick Arsenault <[email protected]>
Co-authored-by: Eric Wolz <[email protected]>

Author: 3 people

src/httpapiex.c

@@ -336,6 +336,27 @@ static int buildAllRequests(HTTPAPIEX_HANDLE_DATA* handle, HTTPAPI_REQUEST_TYPE
     return result;
 }
 
+static bool validRequestType(HTTPAPI_REQUEST_TYPE requestType)
+{
+    bool result;
+
+    if ((requestType == HTTPAPI_REQUEST_GET) ||
+        (requestType == HTTPAPI_REQUEST_POST) ||
+        (requestType == HTTPAPI_REQUEST_PUT) ||
+        (requestType == HTTPAPI_REQUEST_DELETE) ||
+        (requestType == HTTPAPI_REQUEST_PATCH) ||
+        (requestType == HTTPAPI_REQUEST_HEAD))
+    {
+        result = true;
+    }
+    else
+    {
+        result = false;
+    }
+
+    return result;
+}
+
 HTTPAPIEX_RESULT HTTPAPIEX_ExecuteRequest(HTTPAPIEX_HANDLE handle, HTTPAPI_REQUEST_TYPE requestType, const char* relativePath,
     HTTP_HEADERS_HANDLE requestHttpHeadersHandle, BUFFER_HANDLE requestContent, unsigned int* statusCode,
     HTTP_HEADERS_HANDLE responseHttpHeadersHandle, BUFFER_HANDLE responseContent)
@@ -350,7 +371,7 @@ HTTPAPIEX_RESULT HTTPAPIEX_ExecuteRequest(HTTPAPIEX_HANDLE handle, HTTPAPI_REQUE
     else
     {
         /*Codes_SRS_HTTPAPIEX_02_007: [If parameter requestType does not indicate a valid request, HTTPAPIEX_ExecuteRequest shall fail and return HTTPAPIEX_INVALID_ARG.] */
-        if (requestType >= MU_COUNT_ARG(HTTPAPI_REQUEST_TYPE_VALUES))
+        if (!validRequestType(requestType))
         {
             result = HTTPAPIEX_INVALID_ARG;
             LOG_HTTAPIEX_ERROR();