Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update semantic metadata of group members when groups are added/removed #2884

Merged
merged 2 commits into from Apr 3, 2022
Merged

Update semantic metadata of group members when groups are added/removed #2884

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8d050eb
Update semantic metadata of group members when groups are added/removed
wborn Mar 30, 2022
1317e6b
Revert addRegistryChangeListener change
wborn Apr 3, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
12 changes: 12 additions & 0 deletions ...emantics/src/main/java/org/openhab/core/semantics/internal/SemanticsMetadataProvider.java
View file
Open in desktop
Expand Up @@ -124,6 +124,12 @@ private void processItem(Item item) {
notifyListenersAboutRemovedElement(removedMd);
}
}

if (item instanceof GroupItem) {
for (Item memberItem : ((GroupItem) item).getMembers()) {
processItem(memberItem);
}
}
}

/**
Expand Down Expand Up @@ -251,6 +257,12 @@ public void removed(Item item) {
Metadata removedMd = semantics.remove(item.getName());
if (removedMd != null) {
notifyListenersAboutRemovedElement(removedMd);

if (item instanceof GroupItem) {
for (Item memberItem : ((GroupItem) item).getMembers()) {
processItem(memberItem);
}
}
}
}

Expand Down
132 changes: 98 additions & 34 deletions ...tics/src/test/java/org/openhab/core/semantics/internal/SemanticsMetadataProviderTest.java
View file
Open in desktop
Expand Up @@ -16,8 +16,7 @@
import static org.mockito.ArgumentMatchers.eq;
import static org.mockito.Mockito.*;

import java.util.Collection;
import java.util.Optional;
import java.util.Objects;

import org.eclipse.jdt.annotation.NonNull;
import org.eclipse.jdt.annotation.NonNullByDefault;
Expand All @@ -32,6 +31,7 @@
import org.mockito.quality.Strictness;
import org.openhab.core.common.registry.ProviderChangeListener;
import org.openhab.core.items.GenericItem;
import org.openhab.core.items.GroupItem;
import org.openhab.core.items.Item;
import org.openhab.core.items.ItemRegistry;
import org.openhab.core.items.Metadata;
Expand All @@ -47,6 +47,8 @@ public class SemanticsMetadataProviderTest {

private static final String ITEM_NAME = "switchItem";

private static final String GROUP_ITEM_NAME = "groupItem";

private @NonNullByDefault({}) @Mock ItemRegistry itemRegistry;
private @NonNullByDefault({}) @Mock ProviderChangeListener<@NonNull Metadata> changeListener;

Expand All @@ -59,6 +61,8 @@ public void beforeEach() throws Exception {
addProviderChangeListener(changeListener);
}
};

semanticsMetadataProvider.activate();
}

private void assertCorrectAddedEvents(Metadata expected) {
Expand Down Expand Up @@ -92,12 +96,10 @@ public void testItemAdded() {
item.addTag("Door");
semanticsMetadataProvider.added(item);

Metadata metadata = getMetadata(item);
assertNotNull(metadata);
if (metadata != null) {
assertEquals("Equipment_Door", metadata.getValue());
assertCorrectAddedEvents(metadata);
}
Metadata metadata = Objects.requireNonNull(getMetadata(item));
assertEquals("Equipment_Door", metadata.getValue());

assertCorrectAddedEvents(metadata);
}

@Test
Expand All @@ -106,19 +108,16 @@ public void testItemUpdatedToAnotherTag() {
oldItem.addTag("Door");
semanticsMetadataProvider.added(oldItem);

Metadata oldMetadata = getMetadata(oldItem);
assertNotNull(oldMetadata);
Metadata oldMetadata = Objects.requireNonNull(getMetadata(oldItem));

GenericItem newItem = new SwitchItem(ITEM_NAME);
newItem.addTag("Indoor");
semanticsMetadataProvider.updated(oldItem, newItem);

Metadata metadata = getMetadata(newItem);
assertNotNull(metadata);
if (oldMetadata != null && metadata != null) {
assertEquals("Location_Indoor", metadata.getValue());
assertCorrectUpdatedEvents(oldMetadata, metadata);
}
Metadata metadata = Objects.requireNonNull(getMetadata(newItem));
assertEquals("Location_Indoor", metadata.getValue());

assertCorrectUpdatedEvents(oldMetadata, metadata);
}

@Test
Expand All @@ -127,17 +126,15 @@ public void testItemUpdatedToNoTag() {
oldItem.addTag("Door");
semanticsMetadataProvider.added(oldItem);

Metadata oldMetadata = getMetadata(oldItem);
assertNotNull(oldMetadata);
Metadata oldMetadata = Objects.requireNonNull(getMetadata(oldItem));

GenericItem newItem = new SwitchItem(ITEM_NAME);
semanticsMetadataProvider.updated(oldItem, newItem);

Metadata metadata = getMetadata(newItem);
assertNull(metadata);
if (oldMetadata != null) {
assertCorrectRemoveEvents(oldMetadata);
}

assertCorrectRemoveEvents(oldMetadata);
}

@Test
Expand All @@ -146,26 +143,93 @@ public void testItemRemoved() {
item.addTag("Door");
semanticsMetadataProvider.added(item);

Metadata oldMetadata = getMetadata(item);
assertNotNull(oldMetadata);
Metadata oldMetadata = Objects.requireNonNull(getMetadata(item));

semanticsMetadataProvider.removed(item);

Metadata metadata = getMetadata(item);
assertNull(metadata);
if (oldMetadata != null) {
assertCorrectRemoveEvents(oldMetadata);
}

assertCorrectRemoveEvents(oldMetadata);
}

@Test
public void testGroupItemAddedBeforeMemberItemAdded() {
GenericItem item = new SwitchItem(ITEM_NAME);
item.addTag("Door");
item.addGroupName(GROUP_ITEM_NAME);

GroupItem groupItem = new GroupItem(GROUP_ITEM_NAME);
groupItem.addMember(item);
groupItem.addTag("LivingRoom");

when(itemRegistry.get(GROUP_ITEM_NAME)).thenReturn(groupItem);

semanticsMetadataProvider.added(groupItem);
semanticsMetadataProvider.added(item);

Metadata metadata = Objects.requireNonNull(getMetadata(item));
assertEquals("Equipment_Door", metadata.getValue());
assertEquals(metadata.getConfiguration().get("hasLocation"), GROUP_ITEM_NAME);
}

@Test
public void testGroupItemAddedAfterMemberItemAdded() {
GenericItem item = new SwitchItem(ITEM_NAME);
item.addTag("Door");
item.addGroupName(GROUP_ITEM_NAME);

GroupItem groupItem = new GroupItem(GROUP_ITEM_NAME);
groupItem.addMember(item);
groupItem.addTag("LivingRoom");

semanticsMetadataProvider.added(item);

Metadata oldMetadata = Objects.requireNonNull(getMetadata(item));
assertEquals("Equipment_Door", oldMetadata.getValue());
assertNull(oldMetadata.getConfiguration().get("hasLocation"));

when(itemRegistry.get(GROUP_ITEM_NAME)).thenReturn(groupItem);

semanticsMetadataProvider.added(groupItem);

Metadata metadata = Objects.requireNonNull(getMetadata(item));
assertEquals("Equipment_Door", oldMetadata.getValue());
assertEquals(metadata.getConfiguration().get("hasLocation"), GROUP_ITEM_NAME);
}

@Test
public void testGroupItemRemovedAfterMemberItemAdded() {
GenericItem item = new SwitchItem(ITEM_NAME);
item.addTag("Door");
item.addGroupName(GROUP_ITEM_NAME);

GroupItem groupItem = new GroupItem(GROUP_ITEM_NAME);
groupItem.addMember(item);
groupItem.addTag("LivingRoom");

when(itemRegistry.get(GROUP_ITEM_NAME)).thenReturn(groupItem);

semanticsMetadataProvider.added(groupItem);
semanticsMetadataProvider.added(item);

Metadata oldMetadata = Objects.requireNonNull(getMetadata(item));
assertEquals("Equipment_Door", oldMetadata.getValue());
assertEquals(oldMetadata.getConfiguration().get("hasLocation"), GROUP_ITEM_NAME);

when(itemRegistry.get(GROUP_ITEM_NAME)).thenReturn(null);

semanticsMetadataProvider.removed(groupItem);

Metadata metadata = Objects.requireNonNull(getMetadata(item));
assertEquals("Equipment_Door", metadata.getValue());
assertNull(metadata.getConfiguration().get("hasLocation"));
}

private @Nullable Metadata getMetadata(Item item) {
Collection<Metadata> metadataCollection = semanticsMetadataProvider.getAll();
Optional<Metadata> foundMetadata = metadataCollection.stream()
.filter(metadata -> metadata.getUID().getItemName().equals(item.getName())).findFirst();
if (foundMetadata.isPresent()) {
return foundMetadata.get();
} else {
return null;
}
return semanticsMetadataProvider.getAll().stream() //
.filter(metadata -> metadata.getUID().getItemName().equals(item.getName())) //
.findFirst() //
.orElse(null);
}
}