models-provider/src/test/java/org/onap/policy/models/provider/impl/DummyPolicyModelsProviderImpl.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2019-2022 Nordix Foundation.
   4  *  Copyright (C) 2019, 2021 AT&T Intellectual Property. All rights reserved.
   5  *  Modifications Copyright (C) 2020, 2022 Bell Canada. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  * SPDX-License-Identifier: Apache-2.0
  20  * ============LICENSE_END=========================================================
  21  */
  22
  23 package org.onap.policy.models.provider.impl;
  24
  25 import java.util.ArrayList;
  26 import java.util.Collection;
  27 import java.util.List;
  28 import java.util.Map;
  29 import javax.ws.rs.core.Response;
  30 import lombok.NonNull;
  31 import org.onap.policy.common.utils.coder.StandardCoder;
  32 import org.onap.policy.common.utils.resources.ResourceUtils;
  33 import org.onap.policy.models.base.PfConceptKey;
  34 import org.onap.policy.models.base.PfModelException;
  35 import org.onap.policy.models.base.PfModelRuntimeException;
  36 import org.onap.policy.models.pdp.concepts.Pdp;
  37 import org.onap.policy.models.pdp.concepts.PdpGroup;
  38 import org.onap.policy.models.pdp.concepts.PdpGroupFilter;
  39 import org.onap.policy.models.pdp.concepts.PdpPolicyStatus;
  40 import org.onap.policy.models.pdp.concepts.PdpSubGroup;
  41 import org.onap.policy.models.provider.PolicyModelsProvider;
  42 import org.onap.policy.models.provider.PolicyModelsProviderParameters;
  43 import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifierOptVersion;
  44 import org.onap.policy.models.tosca.authorative.concepts.ToscaEntityFilter;
  45 import org.onap.policy.models.tosca.authorative.concepts.ToscaEntityKey;
  46 import org.onap.policy.models.tosca.authorative.concepts.ToscaNodeTemplate;
  47 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicy;
  48 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyType;
  49 import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
  50 import org.onap.policy.models.tosca.authorative.concepts.ToscaTypedEntityFilter;
  51
  52 /**
  53  * This class provides a dummy implementation of the Policy Models Provider for the ONAP Policy Framework.
  54  *
  55  * @author Liam Fallon (liam.fallon@est.tech)
  56  * @author Chenfei Gao (cgao@research.att.com)
  57  */
  58 public class DummyPolicyModelsProviderImpl implements PolicyModelsProvider {
  59     /**
  60      * Constructor that takes the parameters.
  61      *
  62      * @param parameters the parameters for the provider
  63      */
  64     public DummyPolicyModelsProviderImpl(final PolicyModelsProviderParameters parameters) {
  65         // Default constructor
  66     }
  67
  68     @Override
  69     public void init() throws PfModelException {
  70         // Not required on the dummy provider
  71     }
  72
  73     @Override
  74     public void close() {
  75         // Not required on the dummy provider
  76     }
  77
  78
  79     @Override
  80     public List<ToscaServiceTemplate> getServiceTemplateList(String name, String version) throws PfModelException {
  81         return new ArrayList<>();
  82     }
  83
  84     @Override
  85     public List<ToscaServiceTemplate> getFilteredServiceTemplateList(
  86             @NonNull ToscaEntityFilter<ToscaServiceTemplate> filter) throws PfModelException {
  87         return new ArrayList<>();
  88     }
  89
  90     @Override
  91     public ToscaServiceTemplate createServiceTemplate(@NonNull ToscaServiceTemplate serviceTemplate)
  92             throws PfModelException {
  93         return serviceTemplate;
  94     }
  95
  96     @Override
  97     public ToscaServiceTemplate updateServiceTemplate(@NonNull ToscaServiceTemplate serviceTemplate)
  98             throws PfModelException {
  99         return serviceTemplate;
 100     }
 101
 102     @Override
 103     public ToscaServiceTemplate deleteServiceTemplate(@NonNull String name, @NonNull String version)
 104             throws PfModelException {
 105         return getDummyResponse("dummyimpl/DummyToscaServiceTemplateDeleteResponse.json");
 106     }
 107
 108     @Override
 109     public ToscaServiceTemplate getPolicyTypes(final String name, final String version) throws PfModelException {
 110         return getDummyResponse("dummyimpl/DummyToscaPolicyTypeGetResponse.json");
 111     }
 112
 113     @Override
 114     public List<ToscaPolicyType> getPolicyTypeList(final String name, final String version) throws PfModelException {
 115         return new ArrayList<>();
 116     }
 117
 118     @Override
 119     public ToscaServiceTemplate getFilteredPolicyTypes(ToscaEntityFilter<ToscaPolicyType> filter)
 120             throws PfModelException {
 121         return getDummyResponse("dummyimpl/DummyToscaPolicyTypeGetResponse.json");
 122     }
 123
 124     @Override
 125     public List<ToscaPolicyType> getFilteredPolicyTypeList(ToscaEntityFilter<ToscaPolicyType> filter) {
 126         return new ArrayList<>();
 127     }
 128
 129     @Override
 130     public ToscaServiceTemplate createPolicyTypes(final ToscaServiceTemplate serviceTemplate) throws PfModelException {
 131         return serviceTemplate;
 132     }
 133
 134     @Override
 135     public ToscaServiceTemplate updatePolicyTypes(final ToscaServiceTemplate serviceTemplate) throws PfModelException {
 136         return serviceTemplate;
 137     }
 138
 139     @Override
 140     public ToscaServiceTemplate deletePolicyType(final String name, final String version) throws PfModelException {
 141         return getDummyResponse("dummyimpl/DummyToscaPolicyTypeDeleteResponse.json");
 142     }
 143
 144     @Override
 145     public ToscaServiceTemplate getPolicies(final String name, final String version) throws PfModelException {
 146         return getDummyResponse("dummyimpl/DummyToscaPolicyGetResponse.json");
 147     }
 148
 149     @Override
 150     public List<ToscaPolicy> getPolicyList(final String name, final String version) throws PfModelException {
 151         return new ArrayList<>();
 152     }
 153
 154     @Override
 155     public ToscaServiceTemplate getFilteredPolicies(ToscaTypedEntityFilter<ToscaPolicy> filter)
 156             throws PfModelException {
 157         return getDummyResponse("dummyimpl/DummyToscaPolicyGetResponse.json");
 158     }
 159
 160     @Override
 161     public List<ToscaPolicy> getFilteredPolicyList(ToscaTypedEntityFilter<ToscaPolicy> filter) throws PfModelException {
 162         return new ArrayList<>();
 163     }
 164
 165     @Override
 166     public ToscaServiceTemplate createPolicies(final ToscaServiceTemplate serviceTemplate) throws PfModelException {
 167         return serviceTemplate;
 168     }
 169
 170     @Override
 171     public ToscaServiceTemplate updatePolicies(final ToscaServiceTemplate serviceTemplate) throws PfModelException {
 172         return serviceTemplate;
 173     }
 174
 175     @Override
 176     public ToscaServiceTemplate deletePolicy(final String name, final String version) throws PfModelException {
 177         return getDummyResponse("dummyimpl/DummyToscaPolicyDeleteResponse.json");
 178     }
 179
 180     @Override
 181     public ToscaServiceTemplate createToscaNodeTemplates(@NonNull ToscaServiceTemplate serviceTemplate)
 182         throws PfModelException {
 183         return getDummyNodeTemplateResponse("dummyimpl/DummyToscaNodeTemplateResponse.json");
 184     }
 185
 186     @Override
 187     public ToscaServiceTemplate updateToscaNodeTemplates(@NonNull ToscaServiceTemplate serviceTemplate)
 188         throws PfModelRuntimeException, PfModelException {
 189         return getDummyNodeTemplateResponse("dummyimpl/DummyToscaNodeTemplateResponse.json");
 190     }
 191
 192     @Override
 193     public ToscaServiceTemplate deleteToscaNodeTemplate(@NonNull String name, @NonNull String version)
 194         throws PfModelException {
 195         return getDummyNodeTemplateResponse("dummyimpl/DummyToscaNodeTemplateResponse.json");
 196     }
 197
 198     @Override
 199     public List<Map<ToscaEntityKey, Map<String, Object>>> getNodeTemplateMetadataSets(@NonNull String name,
 200                                                                                       @NonNull String version)
 201         throws PfModelException {
 202         return new ArrayList<>();
 203     }
 204
 205     @Override
 206     public List<ToscaNodeTemplate> getToscaNodeTemplate(final String name, final String version)
 207         throws PfModelException {
 208         return new ArrayList<>();
 209     }
 210
 211     @Override
 212     public List<PdpGroup> getPdpGroups(final String name) throws PfModelException {
 213         return new ArrayList<>();
 214     }
 215
 216     @Override
 217     public List<PdpGroup> getFilteredPdpGroups(PdpGroupFilter filter) throws PfModelException {
 218         return new ArrayList<>();
 219     }
 220
 221     @Override
 222     public List<PdpGroup> createPdpGroups(final List<PdpGroup> pdpGroups) throws PfModelException {
 223         return new ArrayList<>();
 224     }
 225
 226     @Override
 227     public List<PdpGroup> updatePdpGroups(final List<PdpGroup> pdpGroups) throws PfModelException {
 228         return new ArrayList<>();
 229     }
 230
 231     @Override
 232     public void updatePdpSubGroup(final String pdpGroupName, final PdpSubGroup pdpSubGroup) throws PfModelException {
 233         // Not implemented
 234     }
 235
 236     @Override
 237     public void updatePdp(String pdpGroupName, String pdpSubGroup, Pdp pdp) throws PfModelException {
 238         // Not implemented
 239     }
 240
 241     @Override
 242     public PdpGroup deletePdpGroup(final String name) throws PfModelException {
 243         return null;
 244     }
 245
 246     @Override
 247     public List<PdpPolicyStatus> getAllPolicyStatus() throws PfModelException {
 248         // Not implemented
 249         return new ArrayList<>();
 250     }
 251
 252     @Override
 253     public List<PdpPolicyStatus> getAllPolicyStatus(@NonNull ToscaConceptIdentifierOptVersion policy)
 254             throws PfModelException {
 255         // Not implemented
 256         return new ArrayList<>();
 257     }
 258
 259     @Override
 260     public List<PdpPolicyStatus> getGroupPolicyStatus(String groupName) throws PfModelException {
 261         // Not implemented
 262         return new ArrayList<>();
 263     }
 264
 265     @Override
 266     public void cudPolicyStatus(Collection<PdpPolicyStatus> createObjs, Collection<PdpPolicyStatus> updateObjs,
 267             Collection<PdpPolicyStatus> deleteObjs) {
 268         // Not implemented
 269     }
 270
 271     /**
 272      * Return a ToscaServicetemplate dummy response.
 273      *
 274      * @param fileName the file name containing the dummy response
 275      * @return the ToscaServiceTemplate with the dummy response
 276      */
 277     protected ToscaServiceTemplate getDummyResponse(final String fileName) {
 278         var standardCoder = new StandardCoder();
 279         ToscaServiceTemplate serviceTemplate;
 280
 281         try {
 282             serviceTemplate =
 283                     standardCoder.decode(ResourceUtils.getResourceAsString(fileName), ToscaServiceTemplate.class);
 284             if (serviceTemplate == null) {
 285                 throw new PfModelException(Response.Status.INTERNAL_SERVER_ERROR, "error reading specified file");
 286             }
 287         } catch (Exception exc) {
 288             throw new PfModelRuntimeException(Response.Status.INTERNAL_SERVER_ERROR, "error serializing object", exc);
 289         }
 290
 291         return serviceTemplate;
 292     }
 293
 294     /**
 295      * Return a tosca node template dummy response.
 296      *
 297      * @param fileName the file name containing the dummy response
 298      * @return the service template with the dummy response
 299      */
 300     protected ToscaServiceTemplate getDummyNodeTemplateResponse(final String fileName) {
 301         var standardCoder = new StandardCoder();
 302         ToscaServiceTemplate serviceTemplate;
 303
 304         try {
 305             serviceTemplate =
 306                 standardCoder.decode(ResourceUtils.getResourceAsString(fileName), ToscaServiceTemplate.class);
 307             if (serviceTemplate == null) {
 308                 throw new PfModelException(Response.Status.INTERNAL_SERVER_ERROR, "error reading specified file");
 309             }
 310         } catch (Exception exc) {
 311             throw new PfModelRuntimeException(Response.Status.INTERNAL_SERVER_ERROR, "error serializing object", exc);
 312         }
 313
 314         return serviceTemplate;
 315     }
 316 }