From 6a37af48d1db199a0f5a9e9c48f7c5f834a90d1b Mon Sep 17 00:00:00 2001 From: Jim Hahn Date: Thu, 30 Jul 2020 18:05:02 -0400 Subject: Add "special" Operation classes for new usecases Created place-holder for new "usecases" controller. Note: as of yet, this is still just a normal java project; it will be turned into a full-fledged kie-based controller in a later review. Added some Operation and a few other support classes that will be needed. Note: the detmTarget() method and it's various supporting methods, detmXxx(), found in GetTargetEntityOperation2 were cloned from the pre-existing ControlLoopOperationManager2 class, and modified to fit the strategy of the new controller. Likewise for the junit tests of those methods. Issue-ID: POLICY-2748 Change-Id: Idffa135a11a56bd6afdd2728706fd40168e80912 Signed-off-by: Jim Hahn --- .../usecases/GetTargetEntityOperation2Test.java | 348 +++++++++++++++++++++ .../controller/usecases/LockOperation2Test.java | 121 +++++++ 2 files changed, 469 insertions(+) create mode 100644 controlloop/common/controller-usecases/src/test/java/org/onap/policy/drools/apps/controller/usecases/GetTargetEntityOperation2Test.java create mode 100644 controlloop/common/controller-usecases/src/test/java/org/onap/policy/drools/apps/controller/usecases/LockOperation2Test.java (limited to 'controlloop/common/controller-usecases/src/test/java') diff --git a/controlloop/common/controller-usecases/src/test/java/org/onap/policy/drools/apps/controller/usecases/GetTargetEntityOperation2Test.java b/controlloop/common/controller-usecases/src/test/java/org/onap/policy/drools/apps/controller/usecases/GetTargetEntityOperation2Test.java new file mode 100644 index 000000000..238ac3d70 --- /dev/null +++ b/controlloop/common/controller-usecases/src/test/java/org/onap/policy/drools/apps/controller/usecases/GetTargetEntityOperation2Test.java @@ -0,0 +1,348 @@ +/*- + * ============LICENSE_START======================================================= + * ONAP + * ================================================================================ + * Copyright (C) 2020 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ============LICENSE_END========================================================= + */ + +package org.onap.policy.drools.apps.controller.usecases; + +import static org.assertj.core.api.Assertions.assertThat; +import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException; +import static org.assertj.core.api.Assertions.assertThatThrownBy; +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertFalse; +import static org.mockito.ArgumentMatchers.any; +import static org.mockito.Mockito.never; +import static org.mockito.Mockito.verify; +import static org.mockito.Mockito.when; + +import java.util.List; +import java.util.Map; +import org.junit.Before; +import org.junit.Test; +import org.mockito.Mock; +import org.mockito.MockitoAnnotations; +import org.onap.aai.domain.yang.GenericVnf; +import org.onap.policy.controlloop.VirtualControlLoopEvent; +import org.onap.policy.controlloop.actorserviceprovider.OperationProperties; +import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams; +import org.onap.policy.controlloop.eventmanager.StepContext; +import org.onap.policy.controlloop.policy.Target; +import org.onap.policy.controlloop.policy.TargetType; + +public class GetTargetEntityOperation2Test { + private static final String GENERIC_VNF_ID = "generic-vnf.vnf-id"; + private static final String VSERVER_NAME = "vserver.vserver-name"; + private static final String GENERIC_VNF_NAME = "generic-vnf.vnf-name"; + private static final String MY_PNF = "my-pnf"; + private static final String MY_VNF = "my-vnf"; + private static final String MY_ACTOR = "my-actor"; + private static final String MY_OPERATION = "my-operation"; + + @Mock + private StepContext stepContext; + @Mock + private ControlLoopOperationParams params; + + private VirtualControlLoopEvent event; + private Target target; + private GenericVnf vnf; + private GetTargetEntityOperation2 oper; + + /** + * Sets up. + */ + @Before + public void setUp() { + MockitoAnnotations.initMocks(this); + + event = new VirtualControlLoopEvent(); + event.setTarget("pnf.pnf-name"); + event.setAai(Map.of("pnf.pnf-name", MY_PNF)); + + target = new Target(); + target.setType(TargetType.PNF); + + vnf = new GenericVnf(); + vnf.setVnfId(MY_VNF); + + when(params.getTarget()).thenReturn(target); + when(params.getActor()).thenReturn(MY_ACTOR); + when(params.getOperation()).thenReturn(MY_OPERATION); + + oper = new GetTargetEntityOperation2(stepContext, event, params); + } + + @Test + public void testGetPropertyNames() { + // already have the data - no properties needed + assertThat(oper.getPropertyNames()).isEmpty(); + + // try an operation that needs data + remakeWithoutData(); + assertEquals(List.of(UsecasesConstants.AAI_DEFAULT_GENERIC_VNF), oper.getPropertyNames()); + + // tell it the entity is available + when(stepContext.contains(OperationProperties.AAI_TARGET_ENTITY)).thenReturn(true); + assertThat(oper.getPropertyNames()).isEmpty(); + } + + @Test + public void testStart() { + assertThatThrownBy(() -> oper.start()).isInstanceOf(UnsupportedOperationException.class) + .hasMessage("cannot start get-target-entity operation"); + } + + /** + * Tests detmTarget() when the target has already been determined. + */ + @Test + public void testDetmTargetRepeat() { + remakeWithoutData(); + assertFalse(oper.getPropertyNames().isEmpty()); + + // tell it the entity is available + when(stepContext.contains(OperationProperties.AAI_TARGET_ENTITY)).thenReturn(true); + assertThat(oper.getPropertyNames()).isEmpty(); + + // repeat + assertThat(oper.getPropertyNames()).isEmpty(); + } + + /** + * Tests detmTarget() when the target is {@code null}. + */ + @Test + public void testDetmTargetNull() { + remakeWithoutData(); + when(params.getTarget()).thenReturn(null); + + assertThatIllegalArgumentException().isThrownBy(() -> oper.getPropertyNames()) + .withMessage("The target is null"); + } + + /** + * Tests detmTarget() when the target type is {@code null}. + */ + @Test + public void testDetmTargetNullType() { + remakeWithoutData(); + target.setType(null); + + assertThatIllegalArgumentException().isThrownBy(() -> oper.getPropertyNames()) + .withMessage("The target type is null"); + } + + /** + * Tests detmTarget() when the target type is VM and enrichment data is provided. + */ + @Test + public void testDetmTargetVm() { + target.setType(TargetType.VM); + enrichTarget(VSERVER_NAME); + assertThat(oper.getPropertyNames()).isEmpty(); + verifyTarget(MY_VNF); + } + + /** + * Tests detmTarget() when the target type is VNF and enrichment data is provided. + */ + @Test + public void testDetmTargetVnf() { + target.setType(TargetType.VNF); + enrichTarget(VSERVER_NAME); + assertThat(oper.getPropertyNames()).isEmpty(); + verifyTarget(MY_VNF); + } + + /** + * Tests detmTarget() when the target type is VF Module and enrichment data is + * provided. + */ + @Test + public void testDetmTargetVfModule() { + target.setType(TargetType.VFMODULE); + enrichTarget(VSERVER_NAME); + assertThat(oper.getPropertyNames()).isEmpty(); + verifyTarget(MY_VNF); + } + + /** + * Tests detmTarget() when the target type is unknown. + */ + @Test + public void testDetmTargetUnknownType() { + target.setType(TargetType.VFC); + enrichTarget(VSERVER_NAME); + assertThatIllegalArgumentException().isThrownBy(() -> oper.getPropertyNames()) + .withMessage("The target type is not supported"); + } + + @Test + public void testDetmPnfTargetPnf() { + assertThat(oper.getPropertyNames()).isEmpty(); + verifyTarget(MY_PNF); + } + + /** + * Tests detmPnfTarget() when the target name is incorrect. + */ + @Test + public void testDetmPnfTargetInvalidName() { + event.setTarget("unknown-pnf"); + assertThatIllegalArgumentException().isThrownBy(() -> oper.getPropertyNames()) + .withMessage("Target does not match target type"); + } + + /** + * Tests detmPnfTarget() when the enrichment data is missing. + */ + @Test + public void testDetmPnfTargetPnfNoEnrichment() { + event.setAai(Map.of()); + assertThatIllegalArgumentException().isThrownBy(() -> oper.getPropertyNames()) + .withMessage("AAI section is missing pnf.pnf-name"); + } + + /** + * Tests detmVfModuleTarget() when the target is null. + */ + @Test + public void testDetmVfModuleTargetNullTarget() { + target.setType(TargetType.VM); + event.setTarget(null); + assertThatIllegalArgumentException().isThrownBy(() -> oper.getPropertyNames()).withMessage("Target is null"); + } + + /** + * Tests detmVfModuleTarget() when the target is the vserver name. + */ + @Test + public void testDetmVfModuleTargetVserverName() { + target.setType(TargetType.VM); + enrichTarget(VSERVER_NAME); + assertThat(oper.getPropertyNames()).isEmpty(); + verifyTarget(MY_VNF); + } + + /** + * Tests detmVfModuleTarget() when the target is the VNF ID. + */ + @Test + public void testDetmVfModuleTargetVnfId() { + target.setType(TargetType.VM); + enrichTarget(GENERIC_VNF_ID); + assertThat(oper.getPropertyNames()).isEmpty(); + verifyTarget(MY_VNF); + } + + /** + * Tests detmVfModuleTarget() when the target is the VNF name. Note: the enrichment + * data is actually stored in the VNF ID field. + */ + @Test + public void testDetmVfModuleTargetVnfName() { + target.setType(TargetType.VM); + enrichTarget(GENERIC_VNF_ID); + + // set this AFTER setting enrichment data + event.setTarget("generic-vnf.vnf-name"); + + assertThat(oper.getPropertyNames()).isEmpty(); + verifyTarget(MY_VNF); + } + + /** + * Tests detmVfModuleTarget() when the target is unknown. + */ + @Test + public void testDetmVfModuleTargetUnknown() { + target.setType(TargetType.VM); + enrichTarget(VSERVER_NAME); + event.setTarget("unknown-vnf"); + assertThatIllegalArgumentException().isThrownBy(() -> oper.getPropertyNames()) + .withMessage("Target does not match target type"); + } + + /** + * Tests detmVfModuleTarget() when the enrichment data is missing. + */ + @Test + public void testDetmVfModuleTargetMissingEnrichment() { + target.setType(TargetType.VM); + event.setTarget(VSERVER_NAME); + assertThatIllegalArgumentException().isThrownBy(() -> oper.getPropertyNames()) + .withMessage("Enrichment data is missing " + VSERVER_NAME); + } + + /** + * Tests detmVnfName() when enrichment data is available. + */ + @Test + public void testDetmVnfNameHaveData() { + target.setType(TargetType.VM); + event.setTarget(GENERIC_VNF_NAME); + event.setAai(Map.of(GENERIC_VNF_ID, MY_VNF)); + assertThat(oper.getPropertyNames()).isEmpty(); + verifyTarget(MY_VNF); + } + + /** + * Tests detmVnfName() when enrichment data is missing. + */ + @Test + public void testDetmVnfNameNoData() { + target.setType(TargetType.VM); + event.setTarget(GENERIC_VNF_NAME); + assertThat(oper.getPropertyNames()).isEqualTo(List.of(UsecasesConstants.AAI_DEFAULT_GENERIC_VNF)); + } + + @Test + public void testSetProperty() { + target.setType(TargetType.VM); + event.setTarget(GENERIC_VNF_NAME); + + // not a property of interest - should be ignored + oper.setProperty("unknown-property", vnf); + verify(stepContext, never()).setProperty(any(), any()); + + // now set the desired property and try again + oper.setProperty(UsecasesConstants.AAI_DEFAULT_GENERIC_VNF, vnf); + verifyTarget(MY_VNF); + } + + @Test + public void testGetActorName_testGetName() { + assertEquals(MY_ACTOR, oper.getActorName()); + assertEquals(MY_OPERATION, oper.getName()); + } + + private void verifyTarget(String targetEntity) { + verify(stepContext).setProperty(OperationProperties.AAI_TARGET_ENTITY, targetEntity); + } + + private void remakeWithoutData() { + target.setType(TargetType.VNF); + event.setTarget(GENERIC_VNF_NAME); + oper = new GetTargetEntityOperation2(stepContext, event, params); + } + + private void enrichTarget(String enrichmentTargetType) { + event.setTarget(enrichmentTargetType); + event.setAai(Map.of(enrichmentTargetType, MY_VNF)); + } +} diff --git a/controlloop/common/controller-usecases/src/test/java/org/onap/policy/drools/apps/controller/usecases/LockOperation2Test.java b/controlloop/common/controller-usecases/src/test/java/org/onap/policy/drools/apps/controller/usecases/LockOperation2Test.java new file mode 100644 index 000000000..dfbedc2c7 --- /dev/null +++ b/controlloop/common/controller-usecases/src/test/java/org/onap/policy/drools/apps/controller/usecases/LockOperation2Test.java @@ -0,0 +1,121 @@ +/*- + * ============LICENSE_START======================================================= + * ONAP + * ================================================================================ + * Copyright (C) 2020 AT&T Intellectual Property. All rights reserved. + * ================================================================================ + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * ============LICENSE_END========================================================= + */ + +package org.onap.policy.drools.apps.controller.usecases; + +import static org.assertj.core.api.Assertions.assertThat; +import static org.assertj.core.api.Assertions.assertThatIllegalStateException; +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertNull; +import static org.junit.Assert.assertSame; +import static org.mockito.ArgumentMatchers.anyString; +import static org.mockito.Mockito.when; + +import java.util.List; +import java.util.Map; +import java.util.concurrent.CompletableFuture; +import org.junit.Before; +import org.junit.Test; +import org.mockito.Mock; +import org.mockito.MockitoAnnotations; +import org.onap.aai.domain.yang.GenericVnf; +import org.onap.policy.controlloop.VirtualControlLoopEvent; +import org.onap.policy.controlloop.actorserviceprovider.OperationOutcome; +import org.onap.policy.controlloop.actorserviceprovider.OperationProperties; +import org.onap.policy.controlloop.actorserviceprovider.parameters.ControlLoopOperationParams; +import org.onap.policy.controlloop.eventmanager.StepContext; +import org.onap.policy.controlloop.policy.Target; +import org.onap.policy.controlloop.policy.TargetType; + +public class LockOperation2Test { + private static final String MY_PNF = "my-pnf"; + private static final String MY_VNF = "my-vnf"; + private static final String MY_ACTOR = "my-actor"; + private static final String MY_OPERATION = "my-operation"; + + @Mock + private StepContext stepContext; + @Mock + private ControlLoopOperationParams params; + + private VirtualControlLoopEvent event; + private Target target; + private CompletableFuture future; + private GenericVnf vnf; + private LockOperation2 oper; + + /** + * Sets up. + */ + @Before + public void setUp() { + MockitoAnnotations.initMocks(this); + + event = new VirtualControlLoopEvent(); + event.setTarget("pnf.pnf-name"); + event.setAai(Map.of("pnf.pnf-name", MY_PNF)); + + target = new Target(); + target.setType(TargetType.PNF); + + future = new CompletableFuture<>(); + + vnf = new GenericVnf(); + vnf.setVnfId(MY_VNF); + + when(stepContext.requestLock(anyString())).thenReturn(future); + + when(params.getTarget()).thenReturn(target); + when(params.getActor()).thenReturn(MY_ACTOR); + when(params.getOperation()).thenReturn(MY_OPERATION); + + oper = new LockOperation2(stepContext, params); + } + + @Test + public void testGetPropertyNames() { + assertThat(oper.getPropertyNames()).isEqualTo(List.of(OperationProperties.AAI_TARGET_ENTITY)); + } + + @Test + public void testStart() { + // missing data + assertThatIllegalStateException().isThrownBy(() -> oper.start()) + .withMessage("target lock entity has not been determined yet"); + + oper.setProperty(OperationProperties.AAI_TARGET_ENTITY, "some-target"); + assertSame(future, oper.start()); + } + + @Test + public void testSetProperty() { + oper.setProperty("unknown-property", "some data"); + assertNull(oper.getTargetEntity()); + + oper.setProperty(OperationProperties.AAI_TARGET_ENTITY, "other data"); + assertEquals("other data", oper.getTargetEntity()); + } + + @Test + public void testGetActorName_testGetName() { + assertEquals(MY_ACTOR, oper.getActorName()); + assertEquals(MY_OPERATION, oper.getName()); + } +} -- cgit 1.2.3-korg