entityownership/mdsal-eos-binding-adapter/src/test/java/org/opendaylight/mdsal/eos/binding/dom/adapter/DefaultEntityOwnershipServiceTest.java

   1 /*
   2  * Copyright (c) 2015 Brocade Communications Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.mdsal.eos.binding.dom.adapter;
   9
  10 import static org.junit.Assert.assertEquals;
  11 import static org.junit.Assert.assertNotNull;
  12 import static org.junit.Assert.assertSame;
  13 import static org.junit.Assert.assertThrows;
  14 import static org.mockito.ArgumentMatchers.any;
  15 import static org.mockito.ArgumentMatchers.eq;
  16 import static org.mockito.Mockito.doReturn;
  17 import static org.mockito.Mockito.doThrow;
  18 import static org.mockito.Mockito.mock;
  19 import static org.mockito.Mockito.verify;
  20
  21 import java.util.Optional;
  22 import org.junit.Before;
  23 import org.junit.Test;
  24 import org.junit.runner.RunWith;
  25 import org.mockito.ArgumentCaptor;
  26 import org.mockito.Mock;
  27 import org.mockito.junit.MockitoJUnitRunner;
  28 import org.opendaylight.mdsal.binding.dom.adapter.ConstantAdapterContext;
  29 import org.opendaylight.mdsal.binding.dom.codec.spi.BindingDOMCodecServices;
  30 import org.opendaylight.mdsal.eos.binding.api.Entity;
  31 import org.opendaylight.mdsal.eos.binding.api.EntityOwnershipChange;
  32 import org.opendaylight.mdsal.eos.binding.api.EntityOwnershipListener;
  33 import org.opendaylight.mdsal.eos.binding.api.EntityOwnershipListenerRegistration;
  34 import org.opendaylight.mdsal.eos.common.api.CandidateAlreadyRegisteredException;
  35 import org.opendaylight.mdsal.eos.common.api.EntityOwnershipChangeState;
  36 import org.opendaylight.mdsal.eos.common.api.EntityOwnershipState;
  37 import org.opendaylight.mdsal.eos.dom.api.DOMEntity;
  38 import org.opendaylight.mdsal.eos.dom.api.DOMEntityOwnershipChange;
  39 import org.opendaylight.mdsal.eos.dom.api.DOMEntityOwnershipListener;
  40 import org.opendaylight.mdsal.eos.dom.api.DOMEntityOwnershipListenerRegistration;
  41 import org.opendaylight.mdsal.eos.dom.api.DOMEntityOwnershipService;
  42 import org.opendaylight.yangtools.concepts.Registration;
  43
  44 /**
  45  * Unit tests for BindingDOMEntityOwnershipServiceAdapter.
  46  *
  47  * @author Thomas Pantelis
  48  */
  49 @RunWith(MockitoJUnitRunner.StrictStubs.class)
  50 public class DefaultEntityOwnershipServiceTest {
  51     static final Entity BINDING_ENTITY = new Entity("foo", "bar");
  52     static final DOMEntity DOM_ENTITY = new DOMEntity("foo", "bar");
  53
  54     @Mock
  55     private BindingDOMCodecServices mockCodecRegistry;
  56
  57     @Mock
  58     private DOMEntityOwnershipService mockDOMService;
  59
  60     private DefaultEntityOwnershipService adapter;
  61
  62     @Before
  63     public void setup() {
  64         doReturn(DOM_ENTITY.getIdentifier()).when(mockCodecRegistry).toYangInstanceIdentifier(
  65                 BINDING_ENTITY.getIdentifier());
  66         doReturn(BINDING_ENTITY.getIdentifier()).when(mockCodecRegistry).fromYangInstanceIdentifier(
  67                 DOM_ENTITY.getIdentifier());
  68
  69         adapter = new DefaultEntityOwnershipService(mockDOMService,
  70             new ConstantAdapterContext(mockCodecRegistry));
  71     }
  72
  73     @Test
  74     public void testRegisterCandidate() throws CandidateAlreadyRegisteredException {
  75         final var mockDOMReg = mock(Registration.class);
  76         doReturn(mockDOMReg).when(mockDOMService).registerCandidate(DOM_ENTITY);
  77
  78         try (var reg = adapter.registerCandidate(BINDING_ENTITY)) {
  79             assertNotNull("registerCandidate returned null", reg);
  80         }
  81         verify(mockDOMReg).close();
  82     }
  83
  84     @Test
  85     public void testRegisterListener() {
  86         final DOMEntityOwnershipListenerRegistration mockDOMReg = mock(DOMEntityOwnershipListenerRegistration.class);
  87         doReturn(mockDOMReg).when(mockDOMService).registerListener(eq(DOM_ENTITY.getType()),
  88                 any(DOMEntityOwnershipListener.class));
  89         final EntityOwnershipListener mockListener = mock(EntityOwnershipListener.class);
  90
  91         final EntityOwnershipListenerRegistration reg = adapter.registerListener(
  92                 BINDING_ENTITY.getType(), mockListener);
  93
  94         assertNotNull("registerListener returned null", reg);
  95         assertEquals("getInstance", mockListener, reg.getInstance());
  96         assertEquals("getEntityType", BINDING_ENTITY.getType(), reg.getEntityType());
  97
  98         final ArgumentCaptor<DOMEntityOwnershipListener> domListenerCaptor = ArgumentCaptor.forClass(
  99                 DOMEntityOwnershipListener.class);
 100         verify(mockDOMService).registerListener(eq(DOM_ENTITY.getType()),  domListenerCaptor.capture());
 101
 102         final DOMEntityOwnershipChange domOwnershipChange = new DOMEntityOwnershipChange(DOM_ENTITY,
 103                 EntityOwnershipChangeState.LOCAL_OWNERSHIP_GRANTED, true);
 104         domListenerCaptor.getValue().ownershipChanged(domOwnershipChange);
 105
 106         final ArgumentCaptor<EntityOwnershipChange> ownershipChangeCaptor = ArgumentCaptor.forClass(
 107                 EntityOwnershipChange.class);
 108         verify(mockListener).ownershipChanged(ownershipChangeCaptor.capture());
 109
 110         final EntityOwnershipChange change = ownershipChangeCaptor.getValue();
 111         assertEquals("getEntity", BINDING_ENTITY, change.getEntity());
 112         assertEquals("getState", EntityOwnershipChangeState.LOCAL_OWNERSHIP_GRANTED, change.getState());
 113
 114         reg.close();
 115         verify(mockDOMReg).close();
 116     }
 117
 118     @Test
 119     public void testGetOwnershipState() {
 120         final var expectedState = Optional.of(EntityOwnershipState.IS_OWNER);
 121         doReturn(expectedState).when(mockDOMService).getOwnershipState(DOM_ENTITY);
 122
 123         final var actualState = adapter.getOwnershipState(BINDING_ENTITY);
 124         assertSame("getOwnershipState", expectedState, actualState);
 125     }
 126
 127     @Test
 128     public void testIsCandidateRegistered() {
 129         doReturn(true).when(mockDOMService).isCandidateRegistered(DOM_ENTITY);
 130         assertEquals("isCandidateRegistered", true, adapter.isCandidateRegistered(BINDING_ENTITY));
 131     }
 132
 133     public void testOwnershipChangeWithException() {
 134         final var domEntityOwnershipListenerAdapter =
 135             new DOMEntityOwnershipListenerAdapter(mock(EntityOwnershipListener.class),
 136                 new ConstantAdapterContext(mockCodecRegistry));
 137         final var domOwnershipChange = mock(DOMEntityOwnershipChange.class);
 138         doThrow(IllegalStateException.class).when(domOwnershipChange).getEntity();
 139         assertThrows(IllegalStateException.class,
 140             () -> domEntityOwnershipListenerAdapter.ownershipChanged(domOwnershipChange));
 141     }
 142 }