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 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.time.Instant;
  26 import java.util.ArrayList;
  27 import java.util.Collection;
  28 import java.util.List;
  29 import java.util.Map;
  30 import javax.ws.rs.core.Response;
  31 import lombok.NonNull;
  32 import org.onap.policy.common.utils.coder.StandardCoder;
  33 import org.onap.policy.common.utils.resources.ResourceUtils;
  34 import org.onap.policy.models.base.PfConceptKey;
  35 import org.onap.policy.models.base.PfModelException;
  36 import org.onap.policy.models.base.PfModelRuntimeException;
  37 import org.onap.policy.models.pap.concepts.PolicyAudit;
  38 import org.onap.policy.models.pap.persistence.provider.PolicyAuditProvider.AuditFilter;
  39 import org.onap.policy.models.pdp.concepts.Pdp;
  40 import org.onap.policy.models.pdp.concepts.PdpGroup;
  41 import org.onap.policy.models.pdp.concepts.PdpGroupFilter;
  42 import org.onap.policy.models.pdp.concepts.PdpPolicyStatus;
  43 import org.onap.policy.models.pdp.concepts.PdpStatistics;
  44 import org.onap.policy.models.pdp.concepts.PdpSubGroup;
  45 import org.onap.policy.models.pdp.persistence.provider.PdpFilterParameters;
  46 import org.onap.policy.models.provider.PolicyModelsProvider;
  47 import org.onap.policy.models.provider.PolicyModelsProviderParameters;
  48 import org.onap.policy.models.tosca.authorative.concepts.ToscaConceptIdentifierOptVersion;
  49 import org.onap.policy.models.tosca.authorative.concepts.ToscaEntityFilter;
  50 import org.onap.policy.models.tosca.authorative.concepts.ToscaEntityKey;
  51 import org.onap.policy.models.tosca.authorative.concepts.ToscaNodeTemplate;
  52 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicy;
  53 import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyType;
  54 import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
  55 import org.onap.policy.models.tosca.authorative.concepts.ToscaTypedEntityFilter;
  56
  57 /**
  58  * This class provides a dummy implementation of the Policy Models Provider for the ONAP Policy Framework.
  59  *
  60  * @author Liam Fallon (liam.fallon@est.tech)
  61  * @author Chenfei Gao (cgao@research.att.com)
  62  */
  63 public class DummyPolicyModelsProviderImpl implements PolicyModelsProvider {
  64     /**
  65      * Constructor that takes the parameters.
  66      *
  67      * @param parameters the parameters for the provider
  68      */
  69     public DummyPolicyModelsProviderImpl(final PolicyModelsProviderParameters parameters) {
  70         // Default constructor
  71     }
  72
  73     @Override
  74     public void init() throws PfModelException {
  75         // Not required on the dummy provider
  76     }
  77
  78     @Override
  79     public void close() {
  80         // Not required on the dummy provider
  81     }
  82
  83
  84     @Override
  85     public List<ToscaServiceTemplate> getServiceTemplateList(String name, String version) throws PfModelException {
  86         return new ArrayList<>();
  87     }
  88
  89     @Override
  90     public List<ToscaServiceTemplate> getFilteredServiceTemplateList(
  91             @NonNull ToscaEntityFilter<ToscaServiceTemplate> filter) throws PfModelException {
  92         return new ArrayList<>();
  93     }
  94
  95     @Override
  96     public ToscaServiceTemplate createServiceTemplate(@NonNull ToscaServiceTemplate serviceTemplate)
  97             throws PfModelException {
  98         return serviceTemplate;
  99     }
 100
 101     @Override
 102     public ToscaServiceTemplate updateServiceTemplate(@NonNull ToscaServiceTemplate serviceTemplate)
 103             throws PfModelException {
 104         return serviceTemplate;
 105     }
 106
 107     @Override
 108     public ToscaServiceTemplate deleteServiceTemplate(@NonNull String name, @NonNull String version)
 109             throws PfModelException {
 110         return getDummyResponse("dummyimpl/DummyToscaServiceTemplateDeleteResponse.json");
 111     }
 112
 113     @Override
 114     public ToscaServiceTemplate getPolicyTypes(final String name, final String version) throws PfModelException {
 115         return getDummyResponse("dummyimpl/DummyToscaPolicyTypeGetResponse.json");
 116     }
 117
 118     @Override
 119     public List<ToscaPolicyType> getPolicyTypeList(final String name, final String version) throws PfModelException {
 120         return new ArrayList<>();
 121     }
 122
 123     @Override
 124     public ToscaServiceTemplate getFilteredPolicyTypes(ToscaEntityFilter<ToscaPolicyType> filter)
 125             throws PfModelException {
 126         return getDummyResponse("dummyimpl/DummyToscaPolicyTypeGetResponse.json");
 127     }
 128
 129     @Override
 130     public List<ToscaPolicyType> getFilteredPolicyTypeList(ToscaEntityFilter<ToscaPolicyType> filter) {
 131         return new ArrayList<>();
 132     }
 133
 134     @Override
 135     public ToscaServiceTemplate createPolicyTypes(final ToscaServiceTemplate serviceTemplate) throws PfModelException {
 136         return serviceTemplate;
 137     }
 138
 139     @Override
 140     public ToscaServiceTemplate updatePolicyTypes(final ToscaServiceTemplate serviceTemplate) throws PfModelException {
 141         return serviceTemplate;
 142     }
 143
 144     @Override
 145     public ToscaServiceTemplate deletePolicyType(final String name, final String version) throws PfModelException {
 146         return getDummyResponse("dummyimpl/DummyToscaPolicyTypeDeleteResponse.json");
 147     }
 148
 149     @Override
 150     public ToscaServiceTemplate getPolicies(final String name, final String version) throws PfModelException {
 151         return getDummyResponse("dummyimpl/DummyToscaPolicyGetResponse.json");
 152     }
 153
 154     @Override
 155     public List<ToscaPolicy> getPolicyList(final String name, final String version) throws PfModelException {
 156         return new ArrayList<>();
 157     }
 158
 159     @Override
 160     public ToscaServiceTemplate getFilteredPolicies(ToscaTypedEntityFilter<ToscaPolicy> filter)
 161             throws PfModelException {
 162         return getDummyResponse("dummyimpl/DummyToscaPolicyGetResponse.json");
 163     }
 164
 165     @Override
 166     public List<ToscaPolicy> getFilteredPolicyList(ToscaTypedEntityFilter<ToscaPolicy> filter) throws PfModelException {
 167         return new ArrayList<>();
 168     }
 169
 170     @Override
 171     public ToscaServiceTemplate createPolicies(final ToscaServiceTemplate serviceTemplate) throws PfModelException {
 172         return serviceTemplate;
 173     }
 174
 175     @Override
 176     public ToscaServiceTemplate updatePolicies(final ToscaServiceTemplate serviceTemplate) throws PfModelException {
 177         return serviceTemplate;
 178     }
 179
 180     @Override
 181     public ToscaServiceTemplate deletePolicy(final String name, final String version) throws PfModelException {
 182         return getDummyResponse("dummyimpl/DummyToscaPolicyDeleteResponse.json");
 183     }
 184
 185     @Override
 186     public ToscaServiceTemplate createToscaNodeTemplates(@NonNull ToscaServiceTemplate serviceTemplate)
 187         throws PfModelException {
 188         return getDummyNodeTemplateResponse("dummyimpl/DummyToscaNodeTemplateResponse.json");
 189     }
 190
 191     @Override
 192     public ToscaServiceTemplate updateToscaNodeTemplates(@NonNull ToscaServiceTemplate serviceTemplate)
 193         throws PfModelRuntimeException, PfModelException {
 194         return getDummyNodeTemplateResponse("dummyimpl/DummyToscaNodeTemplateResponse.json");
 195     }
 196
 197     @Override
 198     public ToscaServiceTemplate deleteToscaNodeTemplate(@NonNull String name, @NonNull String version)
 199         throws PfModelException {
 200         return getDummyNodeTemplateResponse("dummyimpl/DummyToscaNodeTemplateResponse.json");
 201     }
 202
 203     @Override
 204     public List<Map<ToscaEntityKey, Map<String, Object>>> getNodeTemplateMetadataSets(@NonNull String name,
 205                                                                                       @NonNull String version)
 206         throws PfModelException {
 207         return new ArrayList<>();
 208     }
 209
 210     @Override
 211     public List<Map<PfConceptKey, ToscaNodeTemplate>> getToscaNodeTemplate(final String name,
 212                                                                            final String version)
 213         throws PfModelException {
 214         return new ArrayList<>();
 215     }
 216
 217     @Override
 218     public List<PdpGroup> getPdpGroups(final String name) throws PfModelException {
 219         return new ArrayList<>();
 220     }
 221
 222     @Override
 223     public List<PdpGroup> getFilteredPdpGroups(PdpGroupFilter filter) throws PfModelException {
 224         return new ArrayList<>();
 225     }
 226
 227     @Override
 228     public List<PdpGroup> createPdpGroups(final List<PdpGroup> pdpGroups) throws PfModelException {
 229         return new ArrayList<>();
 230     }
 231
 232     @Override
 233     public List<PdpGroup> updatePdpGroups(final List<PdpGroup> pdpGroups) throws PfModelException {
 234         return new ArrayList<>();
 235     }
 236
 237     @Override
 238     public void updatePdpSubGroup(final String pdpGroupName, final PdpSubGroup pdpSubGroup) throws PfModelException {
 239         // Not implemented
 240     }
 241
 242     @Override
 243     public void updatePdp(String pdpGroupName, String pdpSubGroup, Pdp pdp) throws PfModelException {
 244         // Not implemented
 245     }
 246
 247     @Override
 248     public PdpGroup deletePdpGroup(final String name) throws PfModelException {
 249         return null;
 250     }
 251
 252     @Override
 253     public List<PdpStatistics> getFilteredPdpStatistics(PdpFilterParameters filterParams) throws PfModelException {
 254         // Not implemented
 255         return new ArrayList<>();
 256     }
 257
 258     @Override
 259     public List<PdpStatistics> createPdpStatistics(final List<PdpStatistics> pdpStatisticsList)
 260             throws PfModelException {
 261         // Not implemented
 262         return new ArrayList<>();
 263     }
 264
 265     @Override
 266     public List<PdpStatistics> updatePdpStatistics(final List<PdpStatistics> pdpStatisticsList)
 267             throws PfModelException {
 268         // Not implemented
 269         return new ArrayList<>();
 270     }
 271
 272     @Override
 273     public List<PdpStatistics> deletePdpStatistics(final String name, final Instant timestamp) {
 274         // Not implemented
 275         return new ArrayList<>();
 276     }
 277
 278     @Override
 279     public List<PdpPolicyStatus> getAllPolicyStatus() throws PfModelException {
 280         // Not implemented
 281         return new ArrayList<>();
 282     }
 283
 284     @Override
 285     public List<PdpPolicyStatus> getAllPolicyStatus(@NonNull ToscaConceptIdentifierOptVersion policy)
 286             throws PfModelException {
 287         // Not implemented
 288         return new ArrayList<>();
 289     }
 290
 291     @Override
 292     public List<PdpPolicyStatus> getGroupPolicyStatus(String groupName) throws PfModelException {
 293         // Not implemented
 294         return new ArrayList<>();
 295     }
 296
 297     @Override
 298     public void cudPolicyStatus(Collection<PdpPolicyStatus> createObjs, Collection<PdpPolicyStatus> updateObjs,
 299             Collection<PdpPolicyStatus> deleteObjs) {
 300         // Not implemented
 301     }
 302
 303     @Override
 304     public void createAuditRecords(List<PolicyAudit> auditRecords) {
 305         // Not implemented
 306     }
 307
 308     @Override
 309     public List<PolicyAudit> getAuditRecords(AuditFilter auditFilter) {
 310         // Not implemented
 311         return new ArrayList<>();
 312     }
 313
 314     /**
 315      * Return a ToscaServicetemplate dummy response.
 316      *
 317      * @param fileName the file name containing the dummy response
 318      * @return the ToscaServiceTemplate with the dummy response
 319      */
 320     protected ToscaServiceTemplate getDummyResponse(final String fileName) {
 321         var standardCoder = new StandardCoder();
 322         ToscaServiceTemplate serviceTemplate;
 323
 324         try {
 325             serviceTemplate =
 326                     standardCoder.decode(ResourceUtils.getResourceAsString(fileName), ToscaServiceTemplate.class);
 327             if (serviceTemplate == null) {
 328                 throw new PfModelException(Response.Status.INTERNAL_SERVER_ERROR, "error reading specified file");
 329             }
 330         } catch (Exception exc) {
 331             throw new PfModelRuntimeException(Response.Status.INTERNAL_SERVER_ERROR, "error serializing object", exc);
 332         }
 333
 334         return serviceTemplate;
 335     }
 336
 337     /**
 338      * Return a tosca node template dummy response.
 339      *
 340      * @param fileName the file name containing the dummy response
 341      * @return the service template with the dummy response
 342      */
 343     protected ToscaServiceTemplate getDummyNodeTemplateResponse(final String fileName) {
 344         var standardCoder = new StandardCoder();
 345         ToscaServiceTemplate serviceTemplate;
 346
 347         try {
 348             serviceTemplate =
 349                 standardCoder.decode(ResourceUtils.getResourceAsString(fileName), ToscaServiceTemplate.class);
 350             if (serviceTemplate == null) {
 351                 throw new PfModelException(Response.Status.INTERNAL_SERVER_ERROR, "error reading specified file");
 352             }
 353         } catch (Exception exc) {
 354             throw new PfModelRuntimeException(Response.Status.INTERNAL_SERVER_ERROR, "error serializing object", exc);
 355         }
 356
 357         return serviceTemplate;
 358     }
 359 }