Skip to content
This repository has been archived by the owner on May 7, 2020. It is now read-only.

Fix OneWire bridge handler test #6160

Merged
merged 3 commits into from
Sep 6, 2018
Merged

Fix OneWire bridge handler test #6160

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3163190
Fix OneWire bridge handler test
Sep 6, 2018
c8b0a6e
Adopt archetype test
Sep 6, 2018
bd3b757
fix typo
Sep 6, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 22 additions & 7 deletions ...c/test/java/org/eclipse/smarthome/binding/onewire/internal/OwserverBridgeHandlerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,11 @@
package org.eclipse.smarthome.binding.onewire.internal;

import static org.eclipse.smarthome.binding.onewire.internal.OwBindingConstants.*;
import static org.hamcrest.CoreMatchers.is;
import static org.junit.Assert.*;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.timeout;
import static org.mockito.ArgumentMatchers.*;
import static org.mockito.Mockito.*;
import static org.mockito.MockitoAnnotations.initMocks;

import java.util.HashMap;
import java.util.Map;
Expand All @@ -27,15 +29,16 @@
import org.eclipse.smarthome.core.thing.Bridge;
import org.eclipse.smarthome.core.thing.Thing;
import org.eclipse.smarthome.core.thing.ThingStatus;
import org.eclipse.smarthome.core.thing.ThingStatusInfo;
import org.eclipse.smarthome.core.thing.binding.ThingHandlerCallback;
import org.eclipse.smarthome.core.thing.binding.builder.BridgeBuilder;
import org.eclipse.smarthome.test.java.JavaTest;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import org.mockito.ArgumentCaptor;
import org.mockito.Mock;
import org.mockito.Mockito;
import org.mockito.MockitoAnnotations;

/**
* Tests cases for {@link OwserverBridgeHandler}.
Expand Down Expand Up @@ -63,12 +66,12 @@ public void setup() {
bridgeProperties.put(CONFIG_ADDRESS, TEST_HOST);
bridgeProperties.put(CONFIG_PORT, TEST_PORT);

MockitoAnnotations.initMocks(this);
initMocks(this);

bridge = BridgeBuilder.create(THING_TYPE_OWSERVER, "owserver").withLabel("owserver")
.withConfiguration(new Configuration(bridgeProperties)).build();

Mockito.doAnswer(answer -> {
doAnswer(answer -> {
((Thing) answer.getArgument(0)).setStatusInfo(answer.getArgument(1));
return null;
}).when(thingHandlerCallback).statusUpdated(any(), any());
Expand Down Expand Up @@ -102,8 +105,14 @@ public void testInitializationReportsRefreshableOnSuccessfullConnection() {

bridgeHandler.initialize();

ArgumentCaptor<ThingStatusInfo> statusCaptor = ArgumentCaptor.forClass(ThingStatusInfo.class);
waitForAssert(() -> {
verify(thingHandlerCallback, times(2)).statusUpdated(eq(bridge), statusCaptor.capture());
});
assertThat(statusCaptor.getAllValues().get(0).getStatus(), is(ThingStatus.UNKNOWN));
assertThat(statusCaptor.getAllValues().get(1).getStatus(), is(ThingStatus.ONLINE));

waitForAssert(() -> assertTrue(bridgeHandler.isRefreshable()));
waitForAssert(() -> assertEquals(ThingStatus.ONLINE, bridge.getStatusInfo().getStatus()));
}

@Test
Expand All @@ -115,8 +124,14 @@ public void testInitializationReportsNotRefreshableOnFailedConnection() {

bridgeHandler.initialize();

ArgumentCaptor<ThingStatusInfo> statusCaptor = ArgumentCaptor.forClass(ThingStatusInfo.class);
waitForAssert(() -> {
verify(thingHandlerCallback, times(2)).statusUpdated(eq(bridge), statusCaptor.capture());
});
assertThat(statusCaptor.getAllValues().get(0).getStatus(), is(ThingStatus.UNKNOWN));
assertThat(statusCaptor.getAllValues().get(1).getStatus(), is(ThingStatus.OFFLINE));

waitForAssert(() -> assertFalse(bridgeHandler.isRefreshable()));
waitForAssert(() -> assertEquals(ThingStatus.OFFLINE, bridge.getStatusInfo().getStatus()));
}

}
6 changes: 4 additions & 2 deletions ...in/java/org/eclipse/smarthome/binding/onewire/internal/handler/OwserverBridgeHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,11 +77,13 @@ public void initialize() {
owserverConnection.setPort(((BigDecimal) configuration.get(CONFIG_PORT)).intValue());
}

// makes it possible for unit tests to differentiate direct update and
// postponed update through the owserverConnection:
updateStatus(ThingStatus.UNKNOWN);

scheduler.execute(() -> {
owserverConnection.start();
});

updateStatus(ThingStatus.UNKNOWN);
}

@Override
Expand Down
21 changes: 14 additions & 7 deletions ...c/main/resources/archetype-resources/src/test/java/__bindingIdCamelCase__HandlerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@
*/
package ${package};

import static org.hamcrest.CoreMatchers.*;
import static org.junit.Assert.*;
import static org.hamcrest.CoreMatchers.is;
import static org.junit.Assert.assertThat;
import static org.mockito.ArgumentMatchers.eq;
import static org.mockito.Mockito.*;
import static org.mockito.MockitoAnnotations.initMocks;
Expand All @@ -32,6 +32,7 @@
import org.eclipse.smarthome.core.thing.ThingStatusInfo;
import org.eclipse.smarthome.core.thing.binding.ThingHandler;
import org.eclipse.smarthome.core.thing.binding.ThingHandlerCallback;
import org.eclipse.smarthome.test.java.JavaTest;
import org.junit.Before;
import org.junit.Test;
import org.mockito.ArgumentCaptor;
Expand All @@ -42,7 +43,7 @@
*
* @author ${author} - Initial contribution
*/
public class ${bindingIdCamelCase}HandlerTest {
public class ${bindingIdCamelCase}HandlerTest extends JavaTest {

private ThingHandler handler;

Expand Down Expand Up @@ -73,11 +74,17 @@ public void initializeShouldCallTheCallback() {
ArgumentCaptor<ThingStatusInfo> statusInfoCaptor = ArgumentCaptor.forClass(ThingStatusInfo.class);

// verify the interaction with the callback and capture the ThingStatusInfo argument:
verify(callback).statusUpdated(eq(thing), statusInfoCaptor.capture());
waitForAssert(() -> {
verify(callback, times(2)).statusUpdated(eq(thing), statusInfoCaptor.capture());
});

// assert that the ThingStatusInfo given to the callback was build with the (temporary) UNKNOWN status:
ThingStatusInfo thingStatusInfo = statusInfoCaptor.getValue();
assertThat(thingStatusInfo.getStatus(), is(equalTo(ThingStatus.UNKNOWN)));
// assert that the (temporary) UNKNOWN status was given first:
assertThat(statusInfoCaptor.getAllValues().get(0).getStatus(), is(ThingStatus.UNKNOWN));


// assert that ONLINE status was given later:
assertThat(statusInfoCaptor.getAllValues().get(1).getStatus(), is(ThingStatus.ONLINE));


// See the documentation at
// https://www.eclipse.org/smarthome/documentation/development/testing.html#assertions
Expand Down
12 changes: 7 additions & 5 deletions ...n/resources/archetype-resources/src/main/java/internal/__bindingIdCamelCase__Handler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,20 +80,22 @@ public void initialize() {
// access or similar) you should set status UNKNOWN here and then decide the real status asynchronously in the
// background.

// set the thing status to UNKNOWN temporarily and let the background task decide for the real status.
// the framework is then able to reuse the resources from the thing handler initialization.
// we set this upfront to reliably check status updste sin unit tests.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Besides this "updste sin" typo the PR looks good! 👍

updateStatus(ThingStatus.UNKNOWN);

// Example for background initialization:
scheduler.execute(() -> {
boolean thingReachable = true; // <background task with long running initialization here>
// when done do:
if (thingReachable) {
// updateStatus(ThingStatus.ONLINE); // commented for stable test execution
updateStatus(ThingStatus.ONLINE);
} else {
// updateStatus(ThingStatus.OFFLINE);
updateStatus(ThingStatus.OFFLINE);
}
});

// set the thing status to UNKNOWN temporarily and let the background task decide for the real status.
// the framework is then able to reuse the resources from the thing handler initialization.
updateStatus(ThingStatus.UNKNOWN);
// logger.debug("Finished initializing!");

// Note: When initialization can NOT be done set the status with more details for further
Expand Down