New checkstyle profile flagged some minor issues in policy models.
Issue-ID: POLICY-2165
Change-Id: I17ed070a3d55601ad31e48fdfd29fff01d29fa42
Signed-off-by: liamfallon <liam.fallon@est.tech>
import lombok.NonNull;
/**
- * This class is the base class for all Policy Framework concept classes. It enforces implementation
- * of abstract methods and interfaces on all concepts that are sub-classes of this class.
+ * This class is the base class for all Policy Framework concept classes. It enforces implementation of abstract methods
+ * and interfaces on all concepts that are sub-classes of this class.
*/
public abstract class PfConcept implements Serializable, Comparable<PfConcept> {
/**
* Default constructor.
*/
- public PfConcept() {}
+ public PfConcept() {
+ // Default Constructor
+ }
/**
* Copy constructor.
public abstract PfKey getKey();
/**
- * Gets a list of all keys for this concept and all concepts that are defined or referenced by
- * this concept and its sub-concepts.
+ * Gets a list of all keys for this concept and all concepts that are defined or referenced by this concept and its
+ * sub-concepts.
*
* @return the keys used by this concept and its contained concepts
*/
* Validate that this concept is structurally correct.
*
* @param result the parameter in which the result of the validation will be returned
- * @return the validation result that was passed in in the @{link result} field with the result
- * of this validation added
+ * @return the validation result that was passed in in the @{link result} field with the result of this validation
+ * added
*/
public abstract PfValidationResult validate(@NonNull final PfValidationResult result);
/**
- * Clean this concept, tidy up any superfluous information such as leading and trailing white
- * space.
+ * Clean this concept, tidy up any superfluous information such as leading and trailing white space.
*/
public abstract void clean();
/**
* The model service makes Policy Framework models available to all classes in a JVM.
*
- * <p>The reason for having a model service is to avoid having to pass concept and model definitions
- * down long call chains in modules such as the Policy Framework engine and editor. The model
- * service makes the model and concept definitions available statically.
+ * <p>The reason for having a model service is to avoid having to pass concept and model definitions down long call
+ * chains in modules such as the Policy Framework engine and editor. The model service makes the model and concept
+ * definitions available statically.
*
- * <p>Note that the use of the model service means that only a single Policy Framework model of a
- * particular type may exist in Policy Framework (particularly the engine) at any time. Of course
- * the model in a JVM can be changed at any time provided all users of the model are stopped and
- * restarted in an orderly manner.
+ * <p>Note that the use of the model service means that only a single Policy Framework model of a particular type may
+ * exist in Policy Framework (particularly the engine) at any time. Of course the model in a JVM can be changed at any
+ * time provided all users of the model are stopped and restarted in an orderly manner.
*/
public abstract class PfModelService {
// The map holding the models
/**
* This class is an abstract static class that cannot be extended.
*/
- private PfModelService() {}
+ private PfModelService() {
+ // Default constructor
+ }
/**
* Register a model with the model service.
* @author Liam Fallon (liam.fallon@est.tech)
*/
public class PfModelExceptionInfoTest {
+
@Test
- public void exceptionInfoTest() {
+ public void testExceptionInfo() {
try {
throw new PfModelException(Response.Status.ACCEPTED, "HELLO");
- } catch (PfModelException pfme) {
+ } catch (PfModelException pfme) {
String errorMessage = getErrorMessage(pfme);
assertEquals("Server returned: Accepted", errorMessage.substring(0, 25));
}
public class DummyPfKey extends PfKey {
private static final long serialVersionUID = 1L;
- public DummyPfKey() { }
+ public DummyPfKey() {
+ // Default constructor
+ }
public DummyPfKey(DummyPfKey source) {
super(source);
/**
* Private constructor used to prevent sub class instantiation.
*/
- private ErrorResponseUtils() {}
+ private ErrorResponseUtils() {
+ // Default constructor
+ }
/**
* Store the cascaded messages from an exception and all its nested exceptions in an ErrorResponse object.
}
}
}
-
import java.time.Instant;
import java.util.HashMap;
import java.util.UUID;
+
import org.junit.AfterClass;
import org.junit.BeforeClass;
import org.junit.Test;
static {
/*
- * Construct an onset with an AAI subtag containing generic-vnf.vnf-id and a target type of
- * VM.
+ * Construct an onset with an AAI subtag containing generic-vnf.vnf-id and a target type of VM.
*/
onsetEvent = new VirtualControlLoopEvent();
onsetEvent.setClosedLoopControlName("closedLoopControlName-Test");
/**
* Set up before test class.
+ *
* @throws Exception if the A&AI simulator cannot be started
*/
@BeforeClass
}
@Test
- public void constructModifyConfigRequestTest() {
+ public void testConstructModifyConfigRequest() {
policy.setPayload(new HashMap<>());
policy.getPayload().put(KEY1, VALUE1);
policy.getPayload().put(KEY2, VALUE2);
}
@Test
- public void constructModifyConfigRequestTest_NullPayload() {
+ public void testConstructModifyConfigRequest_NullPayload() {
Request appcRequest;
appcRequest = AppcActorServiceProvider.constructRequest(onsetEvent, operation, policy, "vnf01");
import java.util.AbstractMap;
import java.util.HashMap;
import java.util.UUID;
+
import org.junit.AfterClass;
import org.junit.BeforeClass;
import org.junit.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
-
public class AppcLcmActorServiceProviderTest {
private static final String VNF01 = "vnf01";
static {
/*
- * Construct an onset with an AAI subtag containing generic-vnf.vnf-id and a target type of
- * VM.
+ * Construct an onset with an AAI subtag containing generic-vnf.vnf-id and a target type of VM.
*/
onsetEvent = new VirtualControlLoopEvent();
onsetEvent.setClosedLoopControlName("closedLoopControlName-Test");
/**
* Set up before test class.
+ *
* @throws Exception if an error occurs
*/
@BeforeClass
}
/**
- * A test to assert that a null pointer exception is thrown if
- * the APPC response body is null.
+ * A test to assert that a null pointer exception is thrown if the APPC response body is null.
*/
@Test(expected = NullPointerException.class)
public void processNullBodyResponseTest() {
}
/**
- * A test to assert that a null pointer exception is thrown if
- * the APPC response output is null.
+ * A test to assert that a null pointer exception is thrown if the APPC response output is null.
*/
@Test(expected = NullPointerException.class)
public void processNullOutputResponseTest() {
}
@Test
- public void payloadNotPassedWhenNotSupportedByRecipe() {
- //given
+ public void testPayloadNotPassedWhenNotSupportedByRecipe() {
+ // given
Policy migratePolicy = constructPolicyWithRecipe(RECIPE_MIGRATE);
Policy rebuildPolicy = constructPolicyWithRecipe(RECIPE_REBUILD);
Policy restartPolicy = constructPolicyWithRecipe(RECIPE_RESTART);
// when
AppcLcmDmaapWrapper migrateRequest =
- AppcLcmActorServiceProvider.constructRequest(onsetEvent, operation, migratePolicy, VNF01);
+ AppcLcmActorServiceProvider.constructRequest(onsetEvent, operation, migratePolicy, VNF01);
AppcLcmDmaapWrapper rebuildRequest =
- AppcLcmActorServiceProvider.constructRequest(onsetEvent, operation, rebuildPolicy, VNF01);
+ AppcLcmActorServiceProvider.constructRequest(onsetEvent, operation, rebuildPolicy, VNF01);
AppcLcmDmaapWrapper restartRequest =
- AppcLcmActorServiceProvider.constructRequest(onsetEvent, operation, restartPolicy, VNF01);
+ AppcLcmActorServiceProvider.constructRequest(onsetEvent, operation, restartPolicy, VNF01);
// then
assertNull(migrateRequest.getBody().getInput().getPayload());
}
@Test
- public void payloadNotPassedWhenNotSuppliedOrEmpty() {
- //given
+ public void testPayloadNotPassedWhenNotSuppliedOrEmpty() {
+ // given
Policy noPayloadPolicy = constructHealthCheckPolicyWithPayload(null);
Policy emptyPayloadPolicy = constructHealthCheckPolicyWithPayload(new HashMap<>());
// when
AppcLcmDmaapWrapper noPayloadRequest =
- AppcLcmActorServiceProvider.constructRequest(onsetEvent, operation, noPayloadPolicy, VNF01);
+ AppcLcmActorServiceProvider.constructRequest(onsetEvent, operation, noPayloadPolicy, VNF01);
AppcLcmDmaapWrapper emptyPayloadRequest =
- AppcLcmActorServiceProvider.constructRequest(onsetEvent, operation, emptyPayloadPolicy, VNF01);
-
+ AppcLcmActorServiceProvider.constructRequest(onsetEvent, operation, emptyPayloadPolicy, VNF01);
// then
assertNull(noPayloadRequest.getBody().getInput().getPayload());
}
@Test
- public void payloadParsedProperlyForSinglePayloadParameter() {
+ public void testPayloadParsedProperlyForSinglePayloadParameter() {
// given
HashMap<String, String> payload = new HashMap<>();
payload.put("requestParameters", "{\"host-ip-address\":\"10.183.37.25\"}");
// when
AppcLcmDmaapWrapper dmaapRequest =
- AppcLcmActorServiceProvider.constructRequest(onsetEvent, operation, otherPolicy, VNF01);
+ AppcLcmActorServiceProvider.constructRequest(onsetEvent, operation, otherPolicy, VNF01);
// then
- assertEquals(dmaapRequest.getBody().getInput().getPayload(),
- "{\"requestParameters\": {\"host-ip-address\":\"10.183.37.25\"}}");
+ assertEquals("{\"requestParameters\": {\"host-ip-address\":\"10.183.37.25\"}}",
+ dmaapRequest.getBody().getInput().getPayload());
}
-
@Test
- public void payloadParsedProperlyForMultiplePayloadParameters() {
+ public void testPayloadParsedProperlyForMultiplePayloadParameters() {
// given
HashMap<String, String> payload = new HashMap<>();
payload.put("requestParameters", "{\"host-ip-address\":\"10.183.37.25\"}");
- payload.put("configurationParameters", "[{\"ip-addr\":\"$.vf-module-topology.vf-module-parameters.param[9]\","
- + "\"oam-ip-addr\":\"$.vf-module-topology.vf-module-parameters.param[16]\","
- + "\"enabled\":\"$.vf-module-topology.vf-module-parameters.param[23]\"}]");
+ payload.put("configurationParameters",
+ "[{\"ip-addr\":\"$.vf-module-topology.vf-module-parameters.param[9]\","
+ + "\"oam-ip-addr\":\"$.vf-module-topology.vf-module-parameters.param[16]\","
+ + "\"enabled\":\"$.vf-module-topology.vf-module-parameters.param[23]\"}]");
Policy otherPolicy = constructHealthCheckPolicyWithPayload(payload);
// when
AppcLcmDmaapWrapper dmaapRequest =
- AppcLcmActorServiceProvider.constructRequest(onsetEvent, operation, otherPolicy, VNF01);
+ AppcLcmActorServiceProvider.constructRequest(onsetEvent, operation, otherPolicy, VNF01);
// then
assertEquals(dmaapRequest.getBody().getInput().getPayload(),
- "{\"requestParameters\": "
- + "{\"host-ip-address\":\"10.183.37.25\"},"
- + "\"configurationParameters\": "
- + "[{\"ip-addr\":\"$.vf-module-topology.vf-module-parameters.param[9]\","
- + "\"oam-ip-addr\":\"$.vf-module-topology.vf-module-parameters.param[16]\","
- + "\"enabled\":\"$.vf-module-topology.vf-module-parameters.param[23]\"}]"
- + "}");
+ "{\"requestParameters\": " + "{\"host-ip-address\":\"10.183.37.25\"}," + "\"configurationParameters\": "
+ + "[{\"ip-addr\":\"$.vf-module-topology.vf-module-parameters.param[9]\","
+ + "\"oam-ip-addr\":\"$.vf-module-topology.vf-module-parameters.param[16]\","
+ + "\"enabled\":\"$.vf-module-topology.vf-module-parameters.param[23]\"}]" + "}");
}
private Policy constructHealthCheckPolicyWithPayload(HashMap<String, String> payload) {
import org.junit.Test;
-
-
public class AppcLcmRecipeFormatterTest {
@Test
- public void shouldCorrectlyFormatRestartRequestWhenRestartGiven() {
- //given
+ public void testShouldCorrectlyFormatRestartRequestWhenRestartGiven() {
+ // given
AppcLcmRecipeFormatter recipeFormatter = new AppcLcmRecipeFormatter("Restart");
String expectedUrlRecipe = "restart";
String expectedBodyRecipe = "Restart";
- //when
+ // when
String actualUrlRecipe = recipeFormatter.getUrlRecipe();
String actualBodyRecipe = recipeFormatter.getBodyRecipe();
- //then
+ // then
assertEquals(expectedUrlRecipe, actualUrlRecipe);
assertEquals(expectedBodyRecipe, actualBodyRecipe);
}
@Test
- public void shouldReturnCapitalizedBodySingleWordRecipe() {
- //given
+ public void testShouldReturnCapitalizedBodySingleWordRecipe() {
+ // given
AppcLcmRecipeFormatter recipeFormatter = new AppcLcmRecipeFormatter("moDify");
String expectedRecipe = "Modify";
- //when
+ // when
String actualRecipe = recipeFormatter.getBodyRecipe();
- //then
+ // then
assertEquals(expectedRecipe, actualRecipe);
}
@Test
- public void shouldReturnCapitalizeAndJoinedBodyMultiWordRecipe() {
- //given
+ public void testShouldReturnCapitalizeAndJoinedBodyMultiWordRecipe() {
+ // given
AppcLcmRecipeFormatter recipeFormatter = new AppcLcmRecipeFormatter("coNfig-moDify");
String expectedRecipe = "ConfigModify";
- //when
+ // when
String actualRecipe = recipeFormatter.getBodyRecipe();
- //then
+ // then
assertEquals(expectedRecipe, actualRecipe);
}
@Test
- public void shouldReturnLowercasedUrlSingleWordRecipe() {
- //given
+ public void testShouldReturnLowercasedUrlSingleWordRecipe() {
+ // given
AppcLcmRecipeFormatter recipeFormatter = new AppcLcmRecipeFormatter("ModIfy");
String expectedRecipe = "modify";
- //when
+ // when
String actualRecipe = recipeFormatter.getUrlRecipe();
- //then
+ // then
assertEquals(expectedRecipe, actualRecipe);
}
@Test
- public void shouldReturnLowercasedDashJoinedUrlMultiWordRecipe() {
- //given
+ public void testShouldReturnLowercasedDashJoinedUrlMultiWordRecipe() {
+ // given
AppcLcmRecipeFormatter recipeFormatter = new AppcLcmRecipeFormatter("Config-MoDify");
String expectedRecipe = "config-modify";
- //when
+ // when
String actualRecipe = recipeFormatter.getUrlRecipe();
- //then
+ // then
assertEquals(expectedRecipe, actualRecipe);
}
}
\ No newline at end of file
static {
/*
- * Construct an onset. Using dummy AAI details since the code mandates AAI
- * details.
+ * Construct an onset. Using dummy AAI details since the code mandates AAI details.
*/
onsetEvent = new VirtualControlLoopEvent();
onsetEvent.setClosedLoopControlName("closedLoopControlName-Test");
}
@Test
- public void getControlLoopResponseTest() {
+ public void testGetControlLoopResponse() {
PciRequest sdnrRequest;
sdnrRequest = SdnrActorServiceProvider.constructRequest(onsetEvent, operation, policy).getBody();
PciResponse sdnrResponse = new PciResponse(sdnrRequest);
assertEquals(clRsp.getPolicyName(), onsetEvent.getPolicyName());
assertEquals(clRsp.getPolicyVersion(), onsetEvent.getPolicyVersion());
assertEquals(clRsp.getVersion(), onsetEvent.getVersion());
- assertEquals(clRsp.getFrom(), "SDNR");
- assertEquals(clRsp.getTarget(), "DCAE");
+ assertEquals("SDNR", clRsp.getFrom());
+ assertEquals("DCAE", clRsp.getTarget());
assertEquals(clRsp.getPayload(), sdnrResponse.getPayload());
}
@Test
- public void constructModifyConfigRequestTest() {
+ public void testConstructModifyConfigRequest() {
PciRequest sdnrRequest;
sdnrRequest = SdnrActorServiceProvider.constructRequest(onsetEvent, operation, policy).getBody();
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
+
import java.util.Collections;
import java.util.List;
+
import org.onap.policy.aai.AaiCqResponse;
import org.onap.policy.controlloop.ControlLoopOperation;
import org.onap.policy.controlloop.VirtualControlLoopEvent;
import org.onap.policy.vfc.VfcHealAdditionalParams;
import org.onap.policy.vfc.VfcHealRequest;
import org.onap.policy.vfc.VfcRequest;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
public class VfcActorServiceProvider implements Actor {
private static final String GENERIC_VNF_ID = "generic-vnf.vnf-id";
- private static final Logger logger = LoggerFactory.getLogger(VfcActorServiceProvider.class);
-
// Strings for VFC Actor
private static final String VFC_ACTOR = "VFC";
public final class Serialization {
- public static final Gson gsonPretty = new GsonBuilder().disableHtmlEscaping().setPrettyPrinting()
- .create();
-
- private Serialization() {}
+ public static final Gson gsonPretty = new GsonBuilder().disableHtmlEscaping().setPrettyPrinting().create();
+ private Serialization() {
+ // Private constructor to prevent subclassing
+ }
}
import java.util.Collection;
import java.util.Map;
import java.util.UUID;
+
import lombok.Getter;
import lombok.Setter;
@SerializedName("Flags")
private Collection<Map<String, String>> flags = new ArrayList<>();
- public CommonHeader() {}
+ public CommonHeader() {
+ // Default constructor
+ }
/**
* Construct an instance from an existing instance.
// .registerTypeAdapter(ResponseStatus1607.class, new gsonResponseStatus())
.create();
- private Serialization() {}
+ private Serialization() {
+ // Private constructor to prevent subclassing
+ }
public static class GsonUtcAdapter implements JsonSerializer<ZonedDateTime>, JsonDeserializer<ZonedDateTime> {
private static final Logger logger = LoggerFactory.getLogger(GsonUtcAdapter.class);
package org.onap.policy.appc;
import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotEquals;
import static org.junit.Assert.assertNotNull;
-import static org.junit.Assert.assertTrue;
import java.util.HashMap;
import java.util.Map;
public static final Gson gsonPretty = new GsonBuilder().disableHtmlEscaping().setPrettyPrinting()
.registerTypeAdapter(Instant.class, new InstantAdapter()).create();
- public static final Gson gson = new GsonBuilder().disableHtmlEscaping()
- .registerTypeAdapter(Instant.class, new InstantAdapter()).create();
+ public static final Gson gson =
+ new GsonBuilder().disableHtmlEscaping().registerTypeAdapter(Instant.class, new InstantAdapter()).create();
public static final Gson gsonJunit = new GsonBuilder().disableHtmlEscaping().setPrettyPrinting()
.registerTypeAdapter(Instant.class, new InstantJunitAdapter()).create();
- private Serialization() {}
+ private Serialization() {
+ // Private constructor to prevent subclassing
+ }
public static class InstantAdapter implements JsonSerializer<Instant>, JsonDeserializer<Instant> {
public class PhysicalControlLoopEvent extends ControlLoopEvent {
private static final long serialVersionUID = -7282930271094849487L;
- public PhysicalControlLoopEvent() {}
+ public PhysicalControlLoopEvent() {
+ // Default constructor
+ }
/**
* Construct an instance from an existing instance.
public class PhysicalControlLoopNotification extends ControlLoopNotification {
private static final long serialVersionUID = 8105197217140032892L;
- public PhysicalControlLoopNotification() {}
+ public PhysicalControlLoopNotification() {
+ // Default constructor
+ }
/**
* Construct an instance from an existing instance.
public static final Gson gson =
new GsonBuilder().disableHtmlEscaping().registerTypeAdapter(ZonedDateTime.class, new GsonUtcAdapter())
.registerTypeAdapter(Instant.class, new GsonInstantAdapter())
- .registerTypeAdapter(ControlLoopNotificationType.class, new NotificationTypeAdapter())
- .create();
-
+ .registerTypeAdapter(ControlLoopNotificationType.class, new NotificationTypeAdapter()).create();
public static final Gson gsonPretty = new GsonBuilder().disableHtmlEscaping().setPrettyPrinting()
.registerTypeAdapter(ZonedDateTime.class, new GsonUtcAdapter())
.registerTypeAdapter(Instant.class, new GsonInstantAdapter())
- .registerTypeAdapter(ControlLoopNotificationType.class, new NotificationTypeAdapter())
- .create();
+ .registerTypeAdapter(ControlLoopNotificationType.class, new NotificationTypeAdapter()).create();
public static final Gson gsonJunit = new GsonBuilder().disableHtmlEscaping().setPrettyPrinting()
.registerTypeAdapter(ZonedDateTime.class, new GsonUtcAdapter())
- .registerTypeAdapter(Instant.class, new GsonInstantAdapter())
- .create();
+ .registerTypeAdapter(Instant.class, new GsonInstantAdapter()).create();
- private Serialization() {}
+ private Serialization() {
+ // Private constructor to prevent subclassing
+ }
public static class NotificationTypeAdapter
implements JsonSerializer<ControlLoopNotificationType>, JsonDeserializer<ControlLoopNotificationType> {
private static final String NO_URI = "BlahBlah";
@Test
- public void getMethod() {
+ public void testGetMethod() {
HttpDeleteWithBody deleteWithBody = new HttpDeleteWithBody(NO_URI);
assertEquals("DELETE", deleteWithBody.getMethod());
assertEquals(NO_URI, deleteWithBody.getURI().toString());
import org.onap.policy.sdnr.PciRequest;
import org.onap.policy.sdnr.PciResponse;
-
public final class Serialization {
public static final Gson gsonPretty = new GsonBuilder().disableHtmlEscaping().setPrettyPrinting()
.registerTypeAdapter(Instant.class, new InstantAdapter()).create();
public static final Gson gsonJunit = new GsonBuilder().disableHtmlEscaping().setPrettyPrinting()
.registerTypeAdapter(Instant.class, new InstantJunitAdapter()).create();
- private Serialization() {}
+ private Serialization() {
+ // Private constructor to prevent subclassing
+ }
public static class RequestAdapter implements JsonSerializer<PciRequest>, JsonDeserializer<PciRequest> {
package org.onap.policy.vfc;
-import com.google.gson.annotations.SerializedName;
-
import java.io.Serializable;
+
import lombok.Getter;
import lombok.Setter;
*
* @param parameters the parameters for the provider
*/
- public DummyPolicyModelsProviderImpl(final PolicyModelsProviderParameters parameters) {}
+ public DummyPolicyModelsProviderImpl(final PolicyModelsProviderParameters parameters) {
+ // Default constructor
+ }
@Override
public void init() throws PfModelException {
*/
/**
- * This package includes all TOSCA concept POJOs that can be parsed correctly by swagger-core and rendered
- * as expected in swagger-ui.
- */
-/**
+ * This package includes all TOSCA concept POJOs that can be parsed correctly by swagger-core and rendered as expected
+ * in swagger-ui.
+ *
* @author Chenfei Gao (cgao@research.att.com)
*
*/
/**
* Private constructor to prevent subclassing.
*/
- private ToscaUtils() {}
+ private ToscaUtils() {
+ // Private constructor to prevent subclassing
+ }
/**
* Check if policy types have been specified is initialized.
Code Review / policy / models.git / commitdiff