aboutsummaryrefslogtreecommitdiffstats
path: root/kubernetes/cds/templates
diff options
context:
space:
mode:
authorSylvain Desbureaux <sylvain.desbureaux@orange.com>2021-07-13 07:39:49 +0000
committerGerrit Code Review <gerrit@onap.org>2021-07-13 07:39:49 +0000
commit589670d8f917f1b60700a0875675bebb3a0269d2 (patch)
tree11de41756b70389af6f8368e206505d2a9fbd856 /kubernetes/cds/templates
parent155862c8f3a2f5e6791c7d2cf0ee382491e3d652 (diff)
parent15ca512b7835534aafb584eecc3ef81e3954fc09 (diff)
Merge "[DCAEGEN2] Deploy DCAE PM-Mapper Microservices via Helm"
Diffstat (limited to 'kubernetes/cds/templates')
0 files changed, 0 insertions, 0 deletions
a id='n82' href='#n82'>82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 
/*-
 * ============LICENSE_START=======================================================
 * ONAP
 * ================================================================================
 * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
   Modifications Copyright (C) 2019 Nordix Foundation.
 * ================================================================================
 * 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.xacml.pdp.application.optimization;

import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;

import com.att.research.xacml.api.Response;
import com.google.common.collect.Lists;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
import java.util.Collection;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Properties;
import java.util.ServiceLoader;
import org.apache.commons.lang3.tuple.Pair;
import org.assertj.core.api.Condition;
import org.junit.BeforeClass;
import org.junit.ClassRule;
import org.junit.FixMethodOrder;
import org.junit.Test;
import org.junit.rules.TemporaryFolder;
import org.junit.runners.MethodSorters;
import org.onap.policy.common.endpoints.parameters.RestServerParameters;
import org.onap.policy.common.utils.coder.CoderException;
import org.onap.policy.common.utils.coder.StandardCoder;
import org.onap.policy.common.utils.resources.ResourceUtils;
import org.onap.policy.common.utils.resources.TextFileUtils;
import org.onap.policy.models.decisions.concepts.DecisionRequest;
import org.onap.policy.models.decisions.concepts.DecisionResponse;
import org.onap.policy.models.tosca.authorative.concepts.ToscaPolicyTypeIdentifier;
import org.onap.policy.pdp.xacml.application.common.XacmlApplicationException;
import org.onap.policy.pdp.xacml.application.common.XacmlApplicationServiceProvider;
import org.onap.policy.pdp.xacml.application.common.XacmlPolicyUtils;
import org.onap.policy.pdp.xacml.xacmltest.TestUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

@FixMethodOrder(MethodSorters.NAME_ASCENDING)
public class OptimizationPdpApplicationTest {

    private static final Logger LOGGER = LoggerFactory.getLogger(OptimizationPdpApplicationTest.class);
    private static Properties properties = new Properties();
    private static File propertiesFile;
    private static XacmlApplicationServiceProvider service;
    private static StandardCoder gson = new StandardCoder();
    private static DecisionRequest baseRequest;
    private static RestServerParameters clientParams;
    private static String[] listPolicyTypeFiles = {
        "onap.policies.Optimization",
        "onap.policies.optimization.Resource",
        "onap.policies.optimization.Service",
        "onap.policies.optimization.resource.AffinityPolicy",
        "onap.policies.optimization.resource.DistancePolicy",
        "onap.policies.optimization.resource.HpaPolicy",
        "onap.policies.optimization.resource.OptimizationPolicy",
        "onap.policies.optimization.resource.PciPolicy",
        "onap.policies.optimization.service.QueryPolicy",
        "onap.policies.optimization.service.SubscriberPolicy",
        "onap.policies.optimization.resource.Vim_fit",
        "onap.policies.optimization.resource.VnfPolicy"};

    @ClassRule
    public static final TemporaryFolder policyFolder = new TemporaryFolder();

    /**
     * Copies the xacml.properties and policies files into
     * temporary folder and loads the service provider saving
     * instance of provider off for other tests to use.
     */
    @BeforeClass
    public static void setUp() throws Exception {
        clientParams = mock(RestServerParameters.class);
        when(clientParams.getHost()).thenReturn("localhost");
        when(clientParams.getPort()).thenReturn(6969);
        //
        // Load Single Decision Request
        //
        baseRequest = gson.decode(
                TextFileUtils
                    .getTextFileAsString(
                            "src/test/resources/decision.optimization.input.json"),
                    DecisionRequest.class);
        //
        // Setup our temporary folder
        //
        XacmlPolicyUtils.FileCreator myCreator = (String filename) -> policyFolder.newFile(filename);
        propertiesFile = XacmlPolicyUtils.copyXacmlPropertiesContents("src/test/resources/xacml.properties",
                properties, myCreator);
        //
        // Copy the test policy types into data area
        //
        for (String policy : listPolicyTypeFiles) {
            String policyType = ResourceUtils.getResourceAsString("policytypes/" + policy + ".yaml");
            LOGGER.info("Copying {}", policyType);
            Files.write(Paths.get(policyFolder.getRoot().getAbsolutePath(), policy + "-1.0.0.yaml"),
                    policyType.getBytes());
        }
        //
        // Load service
        //
        ServiceLoader<XacmlApplicationServiceProvider> applicationLoader =
                ServiceLoader.load(XacmlApplicationServiceProvider.class);
        //
        // Iterate through Xacml application services and find
        // the optimization service. Save it for use throughout
        // all the Junit tests.
        //
        StringBuilder strDump = new StringBuilder("Loaded applications:" + XacmlPolicyUtils.LINE_SEPARATOR);
        Iterator<XacmlApplicationServiceProvider> iterator = applicationLoader.iterator();
        while (iterator.hasNext()) {
            XacmlApplicationServiceProvider application = iterator.next();
            //
            // Is it our service?
            //
            if (application instanceof OptimizationPdpApplication) {
                //
                // Should be the first and only one
                //
                assertThat(service).isNull();
                service = application;
            }
            strDump.append(application.applicationName());
            strDump.append(" supports ");
            strDump.append(application.supportedPolicyTypes());
            strDump.append(XacmlPolicyUtils.LINE_SEPARATOR);
        }
        LOGGER.debug("{}", strDump);
        assertThat(service).isNotNull();
        //
        // Tell it to initialize based on the properties file
        // we just built for it.
        //
        service.initialize(propertiesFile.toPath().getParent(), clientParams);
    }

    /**
     * Simply test some of the simple methods for the application.
     */
    @Test
    public void test01Basics() {
        //
        // Make sure there's an application name
        //
        assertThat(service.applicationName()).isNotEmpty();
        //
        // Does it return the correct decisions
        //
        assertThat(service.actionDecisionsSupported().size()).isEqualTo(1);
        assertThat(service.actionDecisionsSupported()).contains("optimize");
        //
        // Ensure it has the supported policy types and
        // can support the correct policy types.
        //
        assertThat(service.canSupportPolicyType(new ToscaPolicyTypeIdentifier(
                "onap.policies.optimization.resource.AffinityPolicy", "1.0.0"))).isTrue();
        assertThat(service.canSupportPolicyType(new ToscaPolicyTypeIdentifier(
                "onap.policies.optimization.service.SubscriberPolicy", "1.0.0"))).isTrue();
        assertThat(service.canSupportPolicyType(new ToscaPolicyTypeIdentifier(
                "onap.foobar", "1.0.0"))).isFalse();
    }

    /**
     * With no policies loaded, there should be 0 policies returned.
     *
     * @throws CoderException CoderException
     */
    @Test
    public void test02NoPolicies() throws CoderException {
        //
        // Ask for a decision when there are no policies loaded
        //
        LOGGER.info("Request {}", gson.encode(baseRequest));
        Pair<DecisionResponse, Response> decision = service.makeDecision(baseRequest, null);
        LOGGER.info("Decision {}", decision.getKey());

        assertThat(decision.getKey()).isNotNull();
        assertThat(decision.getKey().getPolicies().size()).isEqualTo(0);
    }

    /**
     * Should return ONLY default policies.
     *
     * @throws XacmlApplicationException could not load policies
     */
    @Test
    public void test03OptimizationDefault() throws XacmlApplicationException {
        //
        // Now load all the optimization policies
        //
        TestUtils.loadPolicies("src/test/resources/vCPE.policies.optimization.input.tosca.yaml", service);
        //
        // Ask for a decision for available default policies
        //
        DecisionResponse response = makeDecision();

        assertThat(response).isNotNull();
        assertThat(response.getPolicies().size()).isEqualTo(2);
        //
        // Validate it
        //
        validateDecision(response, baseRequest);
    }

    /**
     * Should only return default HPA policy type.
     */
    @SuppressWarnings("unchecked")
    @Test
    public void test04OptimizationDefaultHpa() {
        //
        // Add in policy type
        //
        List<String> policyTypes = Lists.newArrayList("onap.policies.optimization.resource.HpaPolicy");
        baseRequest.getResource().put("policy-type", policyTypes);
        //
        // Ask for a decision for default HPA policy
        //
        DecisionResponse response = makeDecision();

        assertThat(response).isNotNull();
        assertThat(response.getPolicies().size()).isEqualTo(1);
        response.getPolicies().forEach((key, value) -> {
            assertThat(((Map<String, Object>) value).get("type"))
                .isEqualTo(("onap.policies.optimization.resource.HpaPolicy"));
        });
        //
        // Validate it
        //
        validateDecision(response, baseRequest);
    }

    /**
     * Refine for US only policies.
     */
    @SuppressWarnings("unchecked")
    @Test
    public void test05OptimizationDefaultGeography() throws CoderException {
        //
        // Remove all the policy-type resources from the request
        //
        cleanOutResources();
        //
        // Add US to the geography list
        //
        ((List<String>)baseRequest.getResource().get("geography")).add("US");
        //
        // Ask for a decision for default US Policy
        //
        DecisionResponse response = makeDecision();
        assertThat(response).isNotNull();
        assertThat(response.getPolicies().size()).isEqualTo(2);
        //
        // Validate it
        //
        validateDecision(response, baseRequest);
    }

    /**
     * Add more refinement for service.
     */
    @SuppressWarnings("unchecked")
    @Test
    public void test06OptimizationDefaultGeographyAndService() {
        //
        // Add vCPE to the service list
        //
        ((List<String>)baseRequest.getResource().get("services")).add("vCPE");
        //
        // Ask for a decision for default US policy for vCPE service
        //
        DecisionResponse response = makeDecision();

        assertThat(response).isNotNull();
        assertThat(response.getPolicies().size()).isEqualTo(3);
        //
        // Validate it
        //
        validateDecision(response, baseRequest);
    }

    /**
     * Add more refinement for specific resource.
     */
    @SuppressWarnings("unchecked")
    @Test
    public void test07OptimizationDefaultGeographyAndServiceAndResource() {
        //
        // Add vG to the resource list
        //
        ((List<String>)baseRequest.getResource().get("resources")).add("vG");
        //
        // Ask for a decision for default US service vCPE resource vG policy
        //
        DecisionResponse response = makeDecision();

        assertThat(response).isNotNull();
        assertThat(response.getPolicies().size()).isEqualTo(6);
        //
        // Validate it
        //
        validateDecision(response, baseRequest);
    }

    /**
     * Now we need to add in subscriberName in order to get scope for gold.
     */
    @SuppressWarnings("unchecked")
    @Test
    public void test08OptimizationGeographyAndServiceAndResourceAndScopeIsGoldSubscriber() {
        //
        // Add gold as a scope
        //
        //((List<String>)baseRequest.getResource().get("scope")).add("gold");
        ((List<String>)baseRequest.getContext().get("subscriberName")).add("subscriber_a");
        //
        // Ask for a decision for specific US vCPE vG gold
        //
        DecisionResponse response = makeDecision();

        assertThat(response).isNotNull();
        assertThat(response.getPolicies().size()).isEqualTo(6);
        //
        // Validate it
        //
        validateDecision(response, baseRequest);
    }

    /**
     * Add a subscriber that should be platinum.
     */
    @SuppressWarnings("unchecked")
    @Test
    public void test09OptimizationGeographyAndServiceAndResourceAndScopeGoldOrPlatinumSubscriber() {
        //
        // Add platinum to the scope list: this is now gold OR platinum
        //
        ((List<String>)baseRequest.getResource().get("scope")).remove("gold");
        ((List<String>)baseRequest.getContext().get("subscriberName")).add("subscriber_x");
        //
        // Ask for a decision for specific US vCPE vG (gold or platinum)
        //
        DecisionResponse response = makeDecision();

        assertThat(response).isNotNull();
        assertThat(response.getPolicies().size()).isEqualTo(8);
        //
        // Validate it
        //
        validateDecision(response, baseRequest);
    }

    /**
     * Remove gold subscriber, keep the platinum one.
     */
    @SuppressWarnings("unchecked")
    @Test
    public void test10OptimizationGeographyAndServiceAndResourceAndScopeNotGoldStillPlatinum() {
        //
        // Add gold as a scope
        //
        ((List<String>)baseRequest.getResource().get("scope")).remove("gold");
        ((List<String>)baseRequest.getResource().get("scope")).remove("platinum");
        ((List<String>)baseRequest.getContext().get("subscriberName")).remove("subscriber_a");
        //
        // Ask for a decision for specific US vCPE vG gold
        //
        DecisionResponse response = makeDecision();

        assertThat(response).isNotNull();
        assertThat(response.getPolicies().size()).isEqualTo(7);
        //
        // Validate it
        //
        validateDecision(response, baseRequest);
    }

    /**
     * Filter by Affinity policy.
     */
    @Test
    public void test11OptimizationPolicyTypeDefault() {
        //
        // Add in policy type
        //
        List<String> policyTypes = Lists.newArrayList("onap.policies.optimization.resource.AffinityPolicy");
        baseRequest.getResource().put("policy-type", policyTypes);
        //
        // Ask for a decision for default
        //
        DecisionResponse response = makeDecision();

        assertThat(response).isNotNull();
        assertThat(response.getPolicies().size()).isEqualTo(1);
        //
        // Validate it
        //
        validateDecision(response, baseRequest);
    }

    /**
     * Now filter by HPA policy type.
     */
    @SuppressWarnings("unchecked")
    @Test
    public void test12OptimizationPolicyTypeDefault() {
        //
        // Add in another policy type
        //
        ((List<String>) baseRequest.getResource().get("policy-type"))
            .add("onap.policies.optimization.resource.HpaPolicy");
        //
        // Ask for a decision for default
        //
        DecisionResponse response = makeDecision();

        assertThat(response).isNotNull();
        assertThat(response.getPolicies().size()).isEqualTo(2);
        //
        // Validate it
        //
        validateDecision(response, baseRequest);
    }

    private DecisionResponse makeDecision() {
        Pair<DecisionResponse, Response> decision = service.makeDecision(baseRequest, null);
        LOGGER.info("Request Resources {}", baseRequest.getResource());
        LOGGER.info("Decision {}", decision.getKey());
        for (Entry<String, Object> entrySet : decision.getKey().getPolicies().entrySet()) {
            LOGGER.info("Policy {}", entrySet.getKey());
        }
        return decision.getKey();
    }

    @SuppressWarnings("unchecked")
    private void validateDecision(DecisionResponse decision, DecisionRequest request) {
        for (Entry<String, Object> entrySet : decision.getPolicies().entrySet()) {
            LOGGER.info("Decision Returned Policy {}", entrySet.getKey());
            assertThat(entrySet.getValue()).isInstanceOf(Map.class);
            Map<String, Object> policyContents = (Map<String, Object>) entrySet.getValue();
            assertThat(policyContents.containsKey("properties")).isTrue();
            assertThat(policyContents.get("properties")).isInstanceOf(Map.class);
            Map<String, Object> policyProperties = (Map<String, Object>) policyContents.get("properties");

            validateMatchable((Collection<String>) request.getResource().get("scope"),
                    (Collection<String>) policyProperties.get("scope"));

            validateMatchable((Collection<String>) request.getResource().get("services"),
                    (Collection<String>) policyProperties.get("services"));

            validateMatchable((Collection<String>) request.getResource().get("resources"),
                    (Collection<String>) policyProperties.get("resources"));

            validateMatchable((Collection<String>) request.getResource().get("geography"),
                    (Collection<String>) policyProperties.get("geography"));
        }
    }

    private void validateMatchable(Collection<String> requestList, Collection<String> policyProperties) {
        LOGGER.info("Validating matchable: {} with {}", policyProperties, requestList);
        //
        // Null or empty implies '*' - that is any value is acceptable
        // for this policy.
        //
        if (policyProperties == null || policyProperties.isEmpty()) {
            return;
        }
        Condition<String> condition = new Condition<>(
                requestList::contains,
                "Request list is contained");
        assertThat(policyProperties).haveAtLeast(1, condition);

    }

    @SuppressWarnings("unchecked")
    private void cleanOutResources() {
        ((List<String>)baseRequest.getResource().get("scope")).clear();
        ((List<String>)baseRequest.getResource().get("services")).clear();
        ((List<String>)baseRequest.getResource().get("resources")).clear();
        ((List<String>)baseRequest.getResource().get("geography")).clear();
        if (((List<String>)baseRequest.getResource().get("policy-type")) != null) {
            baseRequest.getResource().remove("policy-type");
        }
    }
}