[innogysmarthome] VariableActuators are now recognized again (#11741) (#12008)

Signed-off-by: Sven Strohschein <sven.strohschein@gmail.com>

diff --git a/bundles/org.openhab.binding.innogysmarthome/src/main/java/org/openhab/binding/innogysmarthome/internal/client/InnogyClient.java b/bundles/org.openhab.binding.innogysmarthome/src/main/java/org/openhab/binding/innogysmarthome/internal/client/InnogyClient.java
index 08ca9101a9867697d4bf76d9e52e9a15874b9579..fee8e37998825ba665787d38b41e91b1f6029f6b 100644 (file)
--- a/bundles/org.openhab.binding.innogysmarthome/src/main/java/org/openhab/binding/innogysmarthome/internal/client/InnogyClient.java
+++ b/bundles/org.openhab.binding.innogysmarthome/src/main/java/org/openhab/binding/innogysmarthome/internal/client/InnogyClient.java
@@ -33,6 +33,7 @@ import org.eclipse.jetty.client.util.StringContentProvider;
 import org.eclipse.jetty.http.HttpHeader;
 import org.eclipse.jetty.http.HttpMethod;
 import org.eclipse.jetty.http.HttpStatus;
+import org.openhab.binding.innogysmarthome.internal.InnogyBindingConstants;
 import org.openhab.binding.innogysmarthome.internal.client.entity.StatusResponse;
 import org.openhab.binding.innogysmarthome.internal.client.entity.action.Action;
 import org.openhab.binding.innogysmarthome.internal.client.entity.action.ShutterAction;
@@ -318,6 +319,8 @@ public class InnogyClient {
 
     /**
      * Load the device and returns a {@link List} of {@link Device}s..
+     * VariableActuators are returned additionally (independent from the device ids),
+     * because VariableActuators are everytime available and never have a device state.
      *
      * @param deviceIds Ids of the devices to return
      * @return List of Devices
@@ -326,7 +329,7 @@ public class InnogyClient {
             throws IOException, ApiException, AuthenticationException {
         logger.debug("Loading innogy devices...");
         List<Device> devices = executeGetList(API_URL_DEVICE, Device[].class);
-        return devices.stream().filter(d -> deviceIds.contains(d.getId())).collect(Collectors.toList());
+        return devices.stream().filter(d -> isDeviceUsable(d, deviceIds)).collect(Collectors.toList());
     }
 
     /**
@@ -406,4 +409,16 @@ public class InnogyClient {
     public String getConfigVersion() {
         return configVersion;
     }
+
+    /**
+     * Decides if a (discovered) device is usable (available and supported).
+     * 
+     * @param device device to check
+     * @param activeDeviceIds active device id (devices with an according available device state)
+     * @return true when usable, otherwise false
+     */
+    private static boolean isDeviceUsable(Device device, Collection<String> activeDeviceIds) {
+        return activeDeviceIds.contains(device.getId())
+                || InnogyBindingConstants.DEVICE_VARIABLE_ACTUATOR.equals(device.getType());
+    }
 }

diff --git a/bundles/org.openhab.binding.innogysmarthome/src/test/java/org/openhab/binding/innogysmarthome/internal/client/InnogyClientTest.java b/bundles/org.openhab.binding.innogysmarthome/src/test/java/org/openhab/binding/innogysmarthome/internal/client/InnogyClientTest.java
new file mode 100644 (file)
index 0000000..0ca7d5e
--- /dev/null
+++ b/bundles/org.openhab.binding.innogysmarthome/src/test/java/org/openhab/binding/innogysmarthome/internal/client/InnogyClientTest.java
@@ -0,0 +1,101 @@
+/**
+ * Copyright (c) 2010-2022 Contributors to the openHAB project
+ *
+ * See the NOTICE file(s) distributed with this work for additional
+ * information.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
+package org.openhab.binding.innogysmarthome.internal.client;
+
+import static org.junit.jupiter.api.Assertions.*;
+import static org.mockito.Mockito.*;
+
+import java.util.Arrays;
+import java.util.Collections;
+
+import org.eclipse.jetty.client.HttpClient;
+import org.eclipse.jetty.client.api.ContentResponse;
+import org.eclipse.jetty.client.api.Request;
+import org.eclipse.jetty.http.HttpHeader;
+import org.eclipse.jetty.http.HttpMethod;
+import org.eclipse.jetty.http.HttpStatus;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.mockito.Mock;
+import org.mockito.junit.jupiter.MockitoExtension;
+import org.openhab.core.auth.client.oauth2.AccessTokenResponse;
+import org.openhab.core.auth.client.oauth2.OAuthClientService;
+
+/**
+ * @author Sven Strohschein - Initial contribution
+ */
+@ExtendWith(MockitoExtension.class)
+public class InnogyClientTest {
+
+    private static final String DEVICES_URL = "https://api.services-smarthome.de/API/1.1/device";
+
+    private InnogyClient client;
+    @Mock
+    private OAuthClientService oAuthClient;
+    @Mock
+    private HttpClient httpClient;
+
+    @BeforeEach
+    public void before() throws Exception {
+        AccessTokenResponse accessTokenResponse = new AccessTokenResponse();
+        accessTokenResponse.setAccessToken("accessToken");
+        when(oAuthClient.getAccessTokenResponse()).thenReturn(accessTokenResponse);
+
+        client = new InnogyClient(oAuthClient, httpClient);
+    }
+
+    @Test
+    public void testGetDevices() throws Exception {
+        mockRequest(DEVICES_URL, "[ { id: 123 }, { id: 789, type: 'VariableActuator' } ]");
+        assertEquals(2, client.getDevices(Arrays.asList("123", "456")).size());
+    }
+
+    @Test
+    public void testGetDevicesNoDeviceIds() throws Exception {
+        mockRequest(DEVICES_URL, "[ { id: 123 } ]");
+        assertEquals(0, client.getDevices(Collections.emptyList()).size());
+    }
+
+    @Test
+    public void testGetDevicesFalseDeviceIds() throws Exception {
+        mockRequest(DEVICES_URL, "[ { id: 789 }]");
+        assertEquals(0, client.getDevices(Arrays.asList("123", "456")).size());
+    }
+
+    @Test
+    public void testGetDevicesNoDevicesNoDeviceIds() throws Exception {
+        mockRequest(DEVICES_URL, "[]");
+        assertEquals(0, client.getDevices(Collections.emptyList()).size());
+    }
+
+    @Test
+    public void testGetDevicesNoDevicesDeviceIds() throws Exception {
+        mockRequest(DEVICES_URL, "[]");
+        assertEquals(0, client.getDevices(Arrays.asList("123", "456")).size());
+    }
+
+    private void mockRequest(String url, String responseContent) throws Exception {
+        ContentResponse response = mock(ContentResponse.class);
+        when(response.getStatus()).thenReturn(HttpStatus.OK_200);
+        when(response.getContentAsString()).thenReturn(responseContent);
+
+        Request requestMock = mock(Request.class);
+        when(httpClient.newRequest(url)).thenReturn(requestMock);
+        when(requestMock.method(any(HttpMethod.class))).thenReturn(requestMock);
+        when(requestMock.header(any(HttpHeader.class), any())).thenReturn(requestMock);
+        when(requestMock.idleTimeout(anyLong(), any())).thenReturn(requestMock);
+        when(requestMock.timeout(anyLong(), any())).thenReturn(requestMock);
+        when(requestMock.send()).thenReturn(response);
+    }
+}