From 32c6ed6b8cc4ba7b884508b68e376621fb763f65 Mon Sep 17 00:00:00 2001 From: liamfallon Date: Tue, 24 Jul 2018 12:38:24 +0100 Subject: Add common parameter handling This common module is proposed to handle all parameters and properties for the ONAP Policy Framework in a common way. Parameters and Properties: - are validated once when they are loaded and need not be checked again in classes that use them - are available for lookup in a parameter service, they need not be passed in constructors and method arguments - are input using a single implementiation of input method only (JSON/YAML/Java properties/REST) - are defined in a schema and the schema is used for validation as much as possible Issue-ID: POLICY-922 Change-Id: I1fac88b9e952b6b5fcbea04319cb4294a9653327 Signed-off-by: liamfallon --- .../policy/common/parameters/ExceptionTest.java | 57 +++++++++++++++ .../policy/common/parameters/LegalParameters.java | 31 +++++++++ .../common/parameters/TestAbstractParameters.java | 35 ++++++++++ .../common/parameters/TestParameterService.java | 80 ++++++++++++++++++++++ 4 files changed, 203 insertions(+) create mode 100644 common-parameters/src/test/java/org/onap/policy/common/parameters/ExceptionTest.java create mode 100644 common-parameters/src/test/java/org/onap/policy/common/parameters/LegalParameters.java create mode 100644 common-parameters/src/test/java/org/onap/policy/common/parameters/TestAbstractParameters.java create mode 100644 common-parameters/src/test/java/org/onap/policy/common/parameters/TestParameterService.java (limited to 'common-parameters/src/test/java/org') diff --git a/common-parameters/src/test/java/org/onap/policy/common/parameters/ExceptionTest.java b/common-parameters/src/test/java/org/onap/policy/common/parameters/ExceptionTest.java new file mode 100644 index 00000000..510b6e36 --- /dev/null +++ b/common-parameters/src/test/java/org/onap/policy/common/parameters/ExceptionTest.java @@ -0,0 +1,57 @@ +/* + * ============LICENSE_START======================================================= + * Copyright (C) 2018 Ericsson. 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. + * + * SPDX-License-Identifier: Apache-2.0 + * ============LICENSE_END========================================================= + */ +package org.onap.policy.common.parameters; + +import static org.junit.Assert.assertEquals; + +import java.io.IOException; + +import org.junit.Test; + +public class ExceptionTest { + + @Test + public void testParameterException() { + assertEquals("Parameter Exception", new ParameterException("Parameter Exception").getMessage()); + + String exceptionObject = "Exception Object"; + assertEquals("Exception Object", + new ParameterException("Parameter Exception", exceptionObject).getObject().toString()); + + Exception testException = new IOException("IO Exception"); + assertEquals("Parameter Exception\ncaused by: Parameter Exception\ncaused by: IO Exception", + new ParameterException("Parameter Exception", testException, exceptionObject) + .getCascadedMessage()); + } + + @Test + public void testParameterRuntimeException() { + assertEquals("Parameter Exception", new ParameterRuntimeException("Parameter Exception").getMessage()); + + String exceptionObject = "Exception Object"; + assertEquals("Exception Object", + new ParameterRuntimeException("Parameter Exception", exceptionObject).getObject().toString()); + + Exception testException = new IOException("IO Exception"); + assertEquals("Parameter Exception\ncaused by: Parameter Exception\ncaused by: IO Exception", + new ParameterRuntimeException("Parameter Exception", testException, exceptionObject) + .getCascadedMessage()); + } +} diff --git a/common-parameters/src/test/java/org/onap/policy/common/parameters/LegalParameters.java b/common-parameters/src/test/java/org/onap/policy/common/parameters/LegalParameters.java new file mode 100644 index 00000000..fb1bd478 --- /dev/null +++ b/common-parameters/src/test/java/org/onap/policy/common/parameters/LegalParameters.java @@ -0,0 +1,31 @@ +/* + * ============LICENSE_START======================================================= + * Copyright (C) 2018 Ericsson. 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. + * + * SPDX-License-Identifier: Apache-2.0 + * ============LICENSE_END========================================================= + */ + +package org.onap.policy.common.parameters; + +import org.onap.policy.common.parameters.AbstractParameters; + +/** + * @author Liam Fallon (liam.fallon@ericsson.com) + */ +public class LegalParameters implements AbstractParameters { + public LegalParameters() { + } +} diff --git a/common-parameters/src/test/java/org/onap/policy/common/parameters/TestAbstractParameters.java b/common-parameters/src/test/java/org/onap/policy/common/parameters/TestAbstractParameters.java new file mode 100644 index 00000000..f8003cfe --- /dev/null +++ b/common-parameters/src/test/java/org/onap/policy/common/parameters/TestAbstractParameters.java @@ -0,0 +1,35 @@ +/*- + * ============LICENSE_START======================================================= + * Copyright (C) 2018 Ericsson. 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. + * + * SPDX-License-Identifier: Apache-2.0 + * ============LICENSE_END========================================================= + */ + +package org.onap.policy.common.parameters; + +import static org.junit.Assert.assertEquals; + +import org.junit.Test; + +public class TestAbstractParameters { + + @Test + public void testAbstractParameters() { + final LegalParameters parameters = new LegalParameters(); + assertEquals(LegalParameters.class, parameters.getParameterClass()); + assertEquals("org.onap.policy.common.parameters.LegalParameters", parameters.getParameterClassName()); + } +} diff --git a/common-parameters/src/test/java/org/onap/policy/common/parameters/TestParameterService.java b/common-parameters/src/test/java/org/onap/policy/common/parameters/TestParameterService.java new file mode 100644 index 00000000..efd3e304 --- /dev/null +++ b/common-parameters/src/test/java/org/onap/policy/common/parameters/TestParameterService.java @@ -0,0 +1,80 @@ +/*- + * ============LICENSE_START======================================================= + * Copyright (C) 2018 Ericsson. 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. + * + * SPDX-License-Identifier: Apache-2.0 + * ============LICENSE_END========================================================= + */ + +package org.onap.policy.common.parameters; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertNotNull; +import static org.junit.Assert.assertTrue; +import static org.junit.Assert.fail; + +import org.junit.Test; + +public class TestParameterService { + + @Test + public void testParameterService() { + ParameterService.clear(); + + assertFalse(ParameterService.existsParameters(LegalParameters.class)); + try { + ParameterService.getParameters(LegalParameters.class); + fail("Test should throw an exception here"); + } catch (final Exception e) { + assertEquals( + "Parameters for org.onap.policy.common.parameters.LegalParameters not found in parameter service", + e.getMessage()); + } + + ParameterService.registerParameters(new LegalParameters()); + assertTrue(ParameterService.existsParameters(LegalParameters.class)); + assertNotNull(ParameterService.getParameters(LegalParameters.class)); + + ParameterService.deregisterParameters(LegalParameters.class); + + assertFalse(ParameterService.existsParameters(LegalParameters.class)); + try { + ParameterService.getParameters(LegalParameters.class); + fail("Test should throw an exception here"); + } catch (final Exception e) { + assertEquals( + "Parameters for org.onap.policy.common.parameters.LegalParameters not found in parameter service", + e.getMessage()); + } + + ParameterService.registerParameters(new LegalParameters()); + assertTrue(ParameterService.existsParameters(LegalParameters.class)); + assertNotNull(ParameterService.getParameters(LegalParameters.class)); + + assertEquals(1, ParameterService.getAll().size()); + ParameterService.clear(); + assertEquals(0, ParameterService.getAll().size()); + assertFalse(ParameterService.existsParameters(LegalParameters.class)); + try { + ParameterService.getParameters(LegalParameters.class); + fail("Test should throw an exception here"); + } catch (final Exception e) { + assertEquals( + "Parameters for org.onap.policy.common.parameters.LegalParameters not found in parameter service", + e.getMessage()); + } + } +} -- cgit 1.2.3-korg