1 files changed, 332 insertions, 0 deletions
diff --git a/model/basic-model/src/main/java/org/onap/apex/model/basicmodel/test/TestApexModel.java b/model/basic-model/src/main/java/org/onap/apex/model/basicmodel/test/TestApexModel.java
new file mode 100644
index 000000000..e7e50677e
--- /dev/null
+++ b/model/basic-model/src/main/java/org/onap/apex/model/basicmodel/test/TestApexModel.java
@@ -0,0 +1,332 @@
+/*
+ * ============LICENSE_START=======================================================
+ *  Copyright (C) 2016-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.apex.model.basicmodel.test;
+
+import java.io.ByteArrayInputStream;
+import java.io.ByteArrayOutputStream;
+import java.io.File;
+import java.net.URL;
+
+import org.onap.apex.model.basicmodel.concepts.ApexException;
+import org.onap.apex.model.basicmodel.concepts.AxModel;
+import org.onap.apex.model.basicmodel.concepts.AxValidationResult;
+import org.onap.apex.model.basicmodel.dao.ApexDao;
+import org.onap.apex.model.basicmodel.dao.ApexDaoFactory;
+import org.onap.apex.model.basicmodel.dao.DAOParameters;
+import org.onap.apex.model.basicmodel.handling.ApexModelFileWriter;
+import org.onap.apex.model.basicmodel.handling.ApexModelReader;
+import org.onap.apex.model.basicmodel.handling.ApexModelWriter;
+import org.onap.policy.apex.model.utilities.ResourceUtils;
+import org.slf4j.ext.XLogger;
+import org.slf4j.ext.XLoggerFactory;
+
+/**
+ * This class tests reading and writing of Apex models to file and to a database using JPA. It also tests validation of Apex models. This class is designed for
+ * use in unit tests in modules that define Apex models.
+ *
+ * @author Liam Fallon (liam.fallon@ericsson.com)
+ * @param <M> the generic type
+ */
+public class TestApexModel<M extends AxModel> {
+    private static final String MODEL_IS_INVALID = "model is invalid ";
+	private static final String ERROR_PROCESSING_FILE = "error processing file ";
+	private static final String TEST_MODEL_DOES_NOT_EQUAL_MODEL_READ_FROM_XML_FILE = "test model does not equal model read from XML file ";
+	private static final String ERROR_CREATING_TEMPORARY_FILE_FOR_APEX_MODEL = "error creating temporary file for Apex model";
+
+	private static final XLogger LOGGER = XLoggerFactory.getXLogger(TestApexModel.class);
+
+    // The root model class that specifies the root to import and export from
+    private final Class<M> rootModelClass;
+
+    // The class that provides the model
+    private TestApexModelCreator<M> modelCreator = null;
+
+    /**
+     * Constructor, defines the subclass of {@link AxModel} that is being tested and the {@link TestApexModelCreator} object that is used to generate Apex
+     * models.
+     *
+     * @param rootModelClass the Apex model class, a sub class of {@link AxModel}
+     * @param modelCreator the @link TestApexModelCreator} that will generate Apex models of various types for testing
+     */
+    public TestApexModel(final Class<M> rootModelClass, final TestApexModelCreator<M> modelCreator) {
+        this.rootModelClass = rootModelClass;
+        this.modelCreator = modelCreator;
+    }
+
+    /**
+     * Get a test Apex model using the model creator.
+     *
+     * @return the test Apex model
+     */
+    public final M getModel() {
+        return modelCreator.getModel();
+    }
+
+    /**
+     * Test write and read in XML format.
+     *
+     * @throws ApexException on write/read errors
+     */
+    public final void testApexModelWriteReadXML() throws ApexException {
+        LOGGER.debug("running testApexModelWriteReadXML . . .");
+
+        final M model = modelCreator.getModel();
+
+        // Write the file to disk
+        File xmlFile;
+        
+        try {
+            xmlFile = File.createTempFile("ApexModel", ".xml");
+            xmlFile.deleteOnExit();
+        }
+        catch (final Exception e) {
+            LOGGER.warn(ERROR_CREATING_TEMPORARY_FILE_FOR_APEX_MODEL, e);
+            throw new ApexException(ERROR_CREATING_TEMPORARY_FILE_FOR_APEX_MODEL, e);
+        }
+        new ApexModelFileWriter<M>(true).apexModelWriteXMLFile(model, rootModelClass, xmlFile.getPath());
+
+        // Read the file from disk
+        final ApexModelReader<M> modelReader = new ApexModelReader<>(rootModelClass);
+
+        try {
+            final URL apexModelURL = ResourceUtils.getLocalFile(xmlFile.getAbsolutePath());
+            final M fileModel = modelReader.read(apexModelURL.openStream());
+            if (!model.equals(fileModel)) {
+                LOGGER.warn(TEST_MODEL_DOES_NOT_EQUAL_MODEL_READ_FROM_XML_FILE + xmlFile.getAbsolutePath());
+                throw new ApexException(TEST_MODEL_DOES_NOT_EQUAL_MODEL_READ_FROM_XML_FILE + xmlFile.getAbsolutePath());
+            }
+        }
+        catch (final Exception e) {
+            LOGGER.warn(ERROR_PROCESSING_FILE + xmlFile.getAbsolutePath(), e);
+            throw new ApexException(ERROR_PROCESSING_FILE + xmlFile.getAbsolutePath(), e);
+        }
+
+        final ApexModelWriter<M> modelWriter = new ApexModelWriter<>(rootModelClass);
+        modelWriter.getCDataFieldSet().add("description");
+        modelWriter.getCDataFieldSet().add("logic");
+        modelWriter.getCDataFieldSet().add("uiLogic");
+
+        final ByteArrayOutputStream baOutputStream = new ByteArrayOutputStream();
+        modelWriter.write(model, baOutputStream);
+        final ByteArrayInputStream baInputStream = new ByteArrayInputStream(baOutputStream.toByteArray());
+        final M byteArrayModel = modelReader.read(baInputStream);
+        if (!model.equals(byteArrayModel)) {
+            LOGGER.warn("test model does not equal XML marshalled and unmarshalled model");
+            throw new ApexException("test model does not equal XML marshalled and unmarshalled model");
+        }
+
+        LOGGER.debug("ran testApexModelWriteReadXML");
+    }
+
+    /**
+     * Test write and read in JSON format.
+     *
+     * @throws ApexException on write/read errors
+     */
+    public final void testApexModelWriteReadJSON() throws ApexException {
+        LOGGER.debug("running testApexModelWriteReadJSON . . .");
+
+        final M model = modelCreator.getModel();
+
+        // Write the file to disk
+        File jsonFile;
+        try {
+            jsonFile = File.createTempFile("ApexModel", ".xml");
+            jsonFile.deleteOnExit();
+        }
+        catch (final Exception e) {
+            LOGGER.warn(ERROR_CREATING_TEMPORARY_FILE_FOR_APEX_MODEL, e);
+            throw new ApexException(ERROR_CREATING_TEMPORARY_FILE_FOR_APEX_MODEL, e);
+        }
+        new ApexModelFileWriter<M>(true).apexModelWriteJSONFile(model, rootModelClass, jsonFile.getPath());
+
+        // Read the file from disk
+        final ApexModelReader<M> modelReader = new ApexModelReader<>(rootModelClass);
+
+        try {
+            final URL apexModelURL = ResourceUtils.getLocalFile(jsonFile.getAbsolutePath());
+            final M fileModel = modelReader.read(apexModelURL.openStream());
+            if (!model.equals(fileModel)) {
+                LOGGER.warn(TEST_MODEL_DOES_NOT_EQUAL_MODEL_READ_FROM_XML_FILE + jsonFile.getAbsolutePath());
+                throw new ApexException(TEST_MODEL_DOES_NOT_EQUAL_MODEL_READ_FROM_XML_FILE + jsonFile.getAbsolutePath());
+            }
+        }
+        catch (final Exception e) {
+            LOGGER.warn(ERROR_PROCESSING_FILE + jsonFile.getAbsolutePath(), e);
+            throw new ApexException(ERROR_PROCESSING_FILE + jsonFile.getAbsolutePath(), e);
+        }
+
+        final ApexModelWriter<M> modelWriter = new ApexModelWriter<>(rootModelClass);
+        modelWriter.setJsonOutput(true);
+
+        final ByteArrayOutputStream baOutputStream = new ByteArrayOutputStream();
+        modelWriter.write(model, baOutputStream);
+        final ByteArrayInputStream baInputStream = new ByteArrayInputStream(baOutputStream.toByteArray());
+        final M byteArrayModel = modelReader.read(baInputStream);
+        if (!model.equals(byteArrayModel)) {
+            LOGGER.warn("test model does not equal JSON marshalled and unmarshalled model");
+            throw new ApexException("test model does not equal JSON marshalled and unmarshalled model");
+        }
+
+        LOGGER.debug("ran testApexModelWriteReadJSON");
+    }
+
+    /**
+     * Test write and read of an Apex model to database using JPA.
+     *
+     * @param daoParameters the DAO parameters to use for JPA/JDBC
+     * @throws ApexException thrown on errors writing or reading the model to database
+     */
+    public final void testApexModelWriteReadJPA(final DAOParameters daoParameters) throws ApexException {
+        LOGGER.debug("running testApexModelWriteReadJPA . . .");
+
+        final M model = modelCreator.getModel();
+
+        final ApexDao apexDao = new ApexDaoFactory().createApexDao(daoParameters);
+        apexDao.init(daoParameters);
+
+        apexDao.create(model);
+        final M dbJPAModel = apexDao.get(rootModelClass, model.getKey());
+        apexDao.close();
+
+        if (!model.equals(dbJPAModel)) {
+            LOGGER.warn("test model does not equal model written and read using generic JPA");
+            throw new ApexException("test model does not equal model written and read using generic JPA");
+        }
+
+        LOGGER.debug("ran testApexModelWriteReadJPA");
+    }
+
+    /**
+     * Test that an Apex model is valid.
+     *
+     * @return the result of the validation
+     * @throws ApexException thrown on errors validating the Apex model
+     */
+    public final AxValidationResult testApexModelValid() throws ApexException {
+        LOGGER.debug("running testApexModelVaid . . .");
+
+        final M model = modelCreator.getModel();
+        final AxValidationResult result = model.validate(new AxValidationResult());
+
+        if (!result.isValid()) {
+            LOGGER.warn(MODEL_IS_INVALID + result.toString());
+            throw new ApexException(MODEL_IS_INVALID + result.toString());
+        }
+
+        LOGGER.debug("ran testApexModelVaid");
+        return result;
+    }
+
+    /**
+     * Test that an Apex model is structured incorrectly.
+     *
+     * @return the result of the validation
+     * @throws ApexException thrown on errors validating the Apex model
+     */
+    public final AxValidationResult testApexModelVaidateMalstructured() throws ApexException {
+        LOGGER.debug("running testApexModelVaidateMalstructured . . .");
+
+        final M model = modelCreator.getMalstructuredModel();
+        final AxValidationResult result = model.validate(new AxValidationResult());
+
+        if (result.isValid()) {
+            LOGGER.warn("model should not be valid " + result.toString());
+            throw new ApexException("should not be valid " + result.toString());
+        }
+
+        LOGGER.debug("ran testApexModelVaidateMalstructured");
+        return result;
+    }
+
+    /**
+     * Test that an Apex model has observations.
+     *
+     * @return the result of the validation
+     * @throws ApexException thrown on errors validating the Apex model
+     */
+    public final AxValidationResult testApexModelVaidateObservation() throws ApexException {
+        LOGGER.debug("running testApexModelVaidateObservation . . .");
+
+        final M model = modelCreator.getObservationModel();
+        final AxValidationResult result = model.validate(new AxValidationResult());
+
+        if (!result.isValid()) {
+            LOGGER.warn(MODEL_IS_INVALID + result.toString());
+            throw new ApexException(MODEL_IS_INVALID + result.toString());
+        }
+
+        if (!result.getValidationResult().equals(AxValidationResult.ValidationResult.OBSERVATION)) {
+            LOGGER.warn("model should have observations");
+            throw new ApexException("model should have observations");
+        }
+
+        LOGGER.debug("ran testApexModelVaidateObservation");
+        return result;
+    }
+
+    /**
+     * Test that an Apex model has warnings.
+     *
+     * @return the result of the validation
+     * @throws ApexException thrown on errors validating the Apex model
+     */
+    public final AxValidationResult testApexModelVaidateWarning() throws ApexException {
+        LOGGER.debug("running testApexModelVaidateWarning . . .");
+
+        final M model = modelCreator.getWarningModel();
+        final AxValidationResult result = model.validate(new AxValidationResult());
+
+        if (!result.isValid()) {
+            LOGGER.warn(MODEL_IS_INVALID + result.toString());
+            throw new ApexException(MODEL_IS_INVALID + result.toString());
+        }
+
+        if (!result.getValidationResult().equals(AxValidationResult.ValidationResult.WARNING)) {
+            LOGGER.warn("model should have warnings");
+            throw new ApexException("model should have warnings");
+        }
+
+        LOGGER.debug("ran testApexModelVaidateWarning");
+        return result;
+    }
+
+    /**
+     * Test that an Apex model is invalid.
+     *
+     * @return the result of the validation
+     * @throws ApexException thrown on errors validating the Apex model
+     */
+    public final AxValidationResult testApexModelVaidateInvalidModel() throws ApexException {
+        LOGGER.debug("running testApexModelVaidateInvalidModel . . .");
+
+        final M model = modelCreator.getInvalidModel();
+        final AxValidationResult result = model.validate(new AxValidationResult());
+
+        if (result.isValid()) {
+            LOGGER.warn("model should not be valid " + result.toString());
+            throw new ApexException("should not be valid " + result.toString());
+        }
+
+        LOGGER.debug("ran testApexModelVaidateInvalidModel");
+        return result;
+    }
+}