tidy, fixes, self-test

Author: divadiow

openBeken_win32_mvsc2017.vcxproj

@@ -854,6 +854,7 @@
     <ClCompile Include="src\selftest\selftest_util_mqtt.c" />
     <ClCompile Include="src\selftest\selftest_util_mqtt_json.c" />
     <ClCompile Include="src\selftest\selftest_waitFor.c" />
+    <ClCompile Include="src\selftest\selftest_wemo.c" />
     <ClCompile Include="src\selftest\selftest_ws2812b.c" />
     <ClCompile Include="src\sim\Circle.cpp" />
     <ClCompile Include="src\sim\Controller_BL0942.cpp" />

openBeken_win32_mvsc2017.vcxproj.filters

@@ -290,6 +290,7 @@
     <ClCompile Include="src\selftest\selftest_util_mqtt.c" />
     <ClCompile Include="src\selftest\selftest_util_mqtt_json.c" />
     <ClCompile Include="src\selftest\selftest_waitFor.c" />
+    <ClCompile Include="src\selftest\selftest_wemo.c" />
     <ClCompile Include="src\sim\Circle.cpp" />
     <ClCompile Include="src\sim\Controller_BL0942.cpp" />
     <ClCompile Include="src\sim\Controller_Bulb.cpp" />

src/driver/drv_ssdp.c

@@ -522,7 +522,8 @@ void DRV_SSDP_RunQuickTick() {
         addLogAdv(LOG_EXTRADEBUG, LOG_FEATURE_HTTP,"Is MSEARCH - responding");
 #if ENABLE_DRIVER_WEMO
 		if (DRV_IsRunning("WEMO")) {
-			if (strcasestr(udp_msgbuf, "urn:belkin:device:**")) {
+			if (strcasestr(udp_msgbuf, "urn:belkin:device:**")
+				|| strcasestr(udp_msgbuf, "urn:belkin:device:controllee:1")) {
 				DRV_WEMO_Send_Advert_To(1, &addr);
 				return;
 			}

src/driver/drv_wemo.c

@@ -1,13 +1,8 @@
 #include "../new_common.h"
 #include "../new_pins.h"
 #include "../new_cfg.h"
-// Commands register, execution API and cmd tokenizer
-#include "../cmnds/cmd_public.h"
-#include "../mqtt/new_mqtt.h"
 #include "../logging/logging.h"
-#include "../hal/hal_pins.h"
 #include "../hal/hal_wifi.h"
-#include "drv_public.h"
 #include "drv_local.h"
 #include "drv_ssdp.h"
 #include "../httpserver/new_http.h"
@@ -222,26 +217,6 @@ static const char *WEMO_FindHeader(http_request_t *request, const char *namePref
 	return 0;
 }
 
-static void WEMO_PostXMLSafe(http_request_t *request, const char *s) {
-	const char *p;
-	if (!s) return;
-	for (p = s; *p; p++) {
-		switch (*p) {
-			case '&': poststr(request, "&"); break;
-			case '<': poststr(request, "&lt;"); break;
-			case '>': poststr(request, "&gt;"); break;
-			case '"': poststr(request, "&quot;"); break;
-			case '\'': poststr(request, "&apos;"); break;
-			default: {
-				char c[2];
-				c[0] = *p;
-				c[1] = 0;
-				poststr(request, c);
-			} break;
-		}
-	}
-}
-
 static int WEMO_FindMainChannel(void) {
 	int i;
 	// Prefer a relay-type channel; fallback to toggle type.
@@ -341,17 +316,20 @@ void DRV_WEMO_Send_Advert_To(int mode, struct sockaddr_in *addr) {
 	}
 
 	stat_searchesReceived++;
+	if (buffer_out == 0) {
+		outBufferLen = (int)strlen(g_wemo_msearch) + 256;
+		buffer_out = (char*)malloc(outBufferLen);
+		if (buffer_out == 0) {
+			addLogAdv(LOG_ERROR, LOG_FEATURE_HTTP, "WEMO failed to allocate SSDP response buffer");
+			return;
+		}
+	}
 
 	// mode is decided by SSDP driver (historically: 1=Belkin device wildcard, 0=rootdevice).
 	// For compatibility, when asked for Belkin wildcard, also reply for explicit controllee.
 	if (mode == 1) {
 		// 1) urn:Belkin:device:**
 		useType = "urn:Belkin:device:**";
-
-		if (buffer_out == 0) {
-			outBufferLen = (int)strlen(g_wemo_msearch) + 256;
-			buffer_out = (char*)malloc(outBufferLen);
-		}
 		snprintf(buffer_out, outBufferLen, g_wemo_msearch, HAL_GetMyIPString(), useType, g_uid, useType);
 		DRV_SSDP_SendReply(addr, buffer_out);
 
@@ -362,11 +340,6 @@ void DRV_WEMO_Send_Advert_To(int mode, struct sockaddr_in *addr) {
 	}
 	else {
 		useType = "upnp:rootdevice";
-
-		if (buffer_out == 0) {
-			outBufferLen = (int)strlen(g_wemo_msearch) + 256;
-			buffer_out = (char*)malloc(outBufferLen);
-		}
 		snprintf(buffer_out, outBufferLen, g_wemo_msearch, HAL_GetMyIPString(), useType, g_uid, useType);
 		DRV_SSDP_SendReply(addr, buffer_out);
 	}
@@ -486,7 +459,7 @@ static int WEMO_Setup(http_request_t* request) {
 	}
 
 	poststr(request, g_wemo_setup_1);
-	WEMO_PostXMLSafe(request, fname);
+	poststr_escaped(request, (char*)fname);
 	poststr(request, g_wemo_setup_2);
 	poststr(request, g_uid);
 	poststr(request, g_wemo_setup_3);
@@ -502,18 +475,41 @@ static int WEMO_Setup(http_request_t* request) {
 }
 
 void WEMO_Init() {
-	// (Re)enable Wemo emulation.
-	g_wemo_enabled = 1;
 	char uid[64];
 	char serial[32];
 	unsigned char mac[8];
+	char *newSerial;
+	char *newUid;
 
 	WiFI_GetMacAddress((char*)mac);
 	snprintf(serial, sizeof(serial), "201612%02X%02X%02X%02X", mac[2], mac[3], mac[4], mac[5]);
 	snprintf(uid, sizeof(uid), "Socket-1_0-%s", serial);
 
-	g_serial = strdup(serial);
-	g_uid = strdup(uid);
+	newSerial = strdup(serial);
+	newUid = strdup(uid);
+	if (!newSerial || !newUid) {
+		addLogAdv(LOG_ERROR, LOG_FEATURE_HTTP, "WEMO_Init failed to allocate identity strings");
+		if (newSerial) {
+			free(newSerial);
+		}
+		if (newUid) {
+			free(newUid);
+		}
+		g_wemo_enabled = 0;
+		return;
+	}
+
+	if (g_serial) {
+		free(g_serial);
+		g_serial = 0;
+	}
+	if (g_uid) {
+		free(g_uid);
+		g_uid = 0;
+	}
+	g_serial = newSerial;
+	g_uid = newUid;
+	g_wemo_enabled = 1;
 
 	HTTP_RegisterCallback("/upnp/control/basicevent1", HTTP_POST, WEMO_BasicEvent1, 0);
 	HTTP_RegisterCallback("/upnp/control/metainfo1", HTTP_POST, WEMO_MetaInfo1, 0);
@@ -524,6 +520,19 @@ void WEMO_Init() {
 
 void WEMO_Shutdown(void) {
 	// OpenBeken cannot unregister HTTP callbacks at runtime.
-	// Disable responses/SSDP adverts without freeing identity strings (callbacks may still be hit).
+	// Disable responses/SSDP adverts and free runtime buffers.
 	g_wemo_enabled = 0;
+	if (g_serial) {
+		free(g_serial);
+		g_serial = 0;
+	}
+	if (g_uid) {
+		free(g_uid);
+		g_uid = 0;
+	}
+	if (buffer_out) {
+		free(buffer_out);
+		buffer_out = 0;
+		outBufferLen = 0;
+	}
 }

src/selftest/selftest_local.h

@@ -152,6 +152,7 @@ void Test_MAX72XX();
 void Test_OpenWeatherMap();
 void Test_Shutters();
 void Test_Pins();
+void Test_Wemo();
 
 void Test_GetJSONValue_Setup(const char *text);
 void Test_FakeHTTPClientPacket_GET(const char *tg);

src/selftest/selftest_wemo.c

@@ -0,0 +1,106 @@
+#ifdef WINDOWS
+
+#include "selftest_local.h"
+
+static const char *g_wemo_set_state_on =
+"<?xml version=\"1.0\" encoding=\"utf-8\"?>"
+"<s:Envelope xmlns:s=\"http://schemas.xmlsoap.org/soap/envelope/\">"
+"<s:Body>"
+"<u:SetBinaryState xmlns:u=\"urn:Belkin:service:basicevent:1\">"
+"<BinaryState>1</BinaryState>"
+"</u:SetBinaryState>"
+"</s:Body>"
+"</s:Envelope>";
+
+static const char *g_wemo_set_state_off =
+"<?xml version=\"1.0\" encoding=\"utf-8\"?>"
+"<s:Envelope xmlns:s=\"http://schemas.xmlsoap.org/soap/envelope/\">"
+"<s:Body>"
+"<u:SetBinaryState xmlns:u=\"urn:Belkin:service:basicevent:1\">"
+"<BinaryState>0</BinaryState>"
+"</u:SetBinaryState>"
+"</s:Body>"
+"</s:Envelope>";
+
+static const char *g_wemo_get_state =
+"<?xml version=\"1.0\" encoding=\"utf-8\"?>"
+"<s:Envelope xmlns:s=\"http://schemas.xmlsoap.org/soap/envelope/\">"
+"<s:Body>"
+"<u:GetBinaryState xmlns:u=\"urn:Belkin:service:basicevent:1\"/>"
+"</s:Body>"
+"</s:Envelope>";
+
+static void Test_Wemo_RelaySetupAndSoap(void) {
+	SIM_ClearOBK(0);
+
+	CFG_SetDeviceName("Fallback Device Name");
+	PIN_SetPinRoleForPinIndex(7, IOR_Relay);
+	PIN_SetPinChannelForPinIndex(7, 2);
+	CHANNEL_SetLabel(2, "Kitchen & <Plug> \"Main\"", 1);
+	CHANNEL_SetType(1, ChType_Toggle);
+	CHANNEL_SetLabel(1, "ShouldNotBeChosen", 1);
+	CMD_ExecuteCommand("startDriver Wemo", 0);
+
+	Test_FakeHTTPClientPacket_GET("setup.xml");
+	SELFTEST_ASSERT_HTML_REPLY_CONTAINS("Kitchen &amp; &lt;Plug&gt; &quot;Main&quot;");
+	SELFTEST_ASSERT_HTML_REPLY_NOT_CONTAINS("Fallback Device Name");
+	SELFTEST_ASSERT_HTML_REPLY_NOT_CONTAINS("ShouldNotBeChosen");
+	SELFTEST_ASSERT_HTML_REPLY_CONTAINS("<controlURL>/upnp/control/basicevent1</controlURL>");
+	SELFTEST_ASSERT_HTML_REPLY_CONTAINS("<serviceType>urn:Belkin:service:metainfo:1</serviceType>");
+
+	Test_FakeHTTPClientPacket_POST("upnp/control/basicevent1", g_wemo_set_state_on);
+	SELFTEST_ASSERT_CHANNEL(2, 1);
+	SELFTEST_ASSERT_CHANNEL(1, 0);
+	SELFTEST_ASSERT_HTML_REPLY_CONTAINS("<BinaryState>1</BinaryState>");
+
+	Test_FakeHTTPClientPacket_POST("upnp/control/basicevent1", g_wemo_get_state);
+	SELFTEST_ASSERT_HTML_REPLY_CONTAINS("<u:GetBinaryStateResponse");
+	SELFTEST_ASSERT_HTML_REPLY_CONTAINS("<BinaryState>1</BinaryState>");
+
+	Test_FakeHTTPClientPacket_POST("upnp/control/basicevent1", g_wemo_set_state_off);
+	SELFTEST_ASSERT_CHANNEL(2, 0);
+	SELFTEST_ASSERT_CHANNEL(1, 0);
+	SELFTEST_ASSERT_HTML_REPLY_CONTAINS("<BinaryState>0</BinaryState>");
+
+	Test_FakeHTTPClientPacket_POST("upnp/control/metainfo1", g_wemo_get_state);
+	SELFTEST_ASSERT_HTML_REPLY_CONTAINS("MetaInfoResponse");
+	Test_FakeHTTPClientPacket_GET("eventservice.xml");
+	SELFTEST_ASSERT_HTML_REPLY_CONTAINS("SetBinaryState");
+	Test_FakeHTTPClientPacket_GET("metainfoservice.xml");
+	SELFTEST_ASSERT_HTML_REPLY_CONTAINS("GetExtMetaInfo");
+}
+
+static void Test_Wemo_ToggleFallbackAndRestart(void) {
+	SIM_ClearOBK(0);
+
+	CFG_SetDeviceName("Toggle Device");
+	CHANNEL_SetType(5, ChType_Toggle);
+	CHANNEL_SetLabel(5, "Toggle Fallback", 1);
+	CMD_ExecuteCommand("startDriver Wemo", 0);
+
+	Test_FakeHTTPClientPacket_GET("setup.xml");
+	SELFTEST_ASSERT_HTML_REPLY_CONTAINS("Toggle Fallback");
+
+	Test_FakeHTTPClientPacket_POST("upnp/control/basicevent1", g_wemo_set_state_on);
+	SELFTEST_ASSERT_CHANNEL(5, 1);
+	SELFTEST_ASSERT_HTML_REPLY_CONTAINS("<BinaryState>1</BinaryState>");
+
+	CMD_ExecuteCommand("stopDriver Wemo", 0);
+	Test_FakeHTTPClientPacket_GET("setup.xml");
+	SELFTEST_ASSERT_HTML_REPLY_CONTAINS("\"error\":404");
+
+	CMD_ExecuteCommand("startDriver Wemo", 0);
+	Test_FakeHTTPClientPacket_GET("setup.xml");
+	SELFTEST_ASSERT_HTML_REPLY_CONTAINS("Toggle Fallback");
+
+	Test_FakeHTTPClientPacket_POST("upnp/control/basicevent1", g_wemo_set_state_off);
+	SELFTEST_ASSERT_CHANNEL(5, 0);
+	SELFTEST_ASSERT_HTML_REPLY_CONTAINS("<BinaryState>0</BinaryState>");
+}
+
+void Test_Wemo() {
+	Test_Wemo_RelaySetupAndSoap();
+	Test_Wemo_ToggleFallbackAndRestart();
+}
+
+#endif

src/win_main.c

@@ -301,6 +301,7 @@ void Win_DoUnitTests()
 	Test_Scripting();
 	Test_Tokenizer();
 	Test_Pins();
+	Test_Wemo();
 	Test_Http();
 	Test_Http_LED();
 	Test_DeviceGroups();