Adding optimization application finish guard

Created Optimization application and created a translator
for it. The translator makes an assumption that OOF wants
to query on policyScope and policyType properties.

Rearranged some of the test code for re-usability.

Guard policies are now creating for frequency limiter
and min max. Probably could use some clean up.

Upgraded to xacml 2.0.1 to include a fix for handling
null attribute values.

Added some code to test missing values.

Issue-ID: POLICY-1273
Change-Id: Ia3dbfa992bbe0cbb5aa294c38aa2aff430a3230a
Signed-off-by: Pamela Dragosh <pdragosh@research.att.com>

5 files changed, 305 insertions, 120 deletions

diff --git a/applications/guard/src/test/java/org/onap/policy/xacml/pdp/application/guard/GuardPdpApplicationTest.java b/applications/guard/src/test/java/org/onap/policy/xacml/pdp/application/guard/GuardPdpApplicationTest.java
index ae4193d3..ff137e13 100644
--- a/applications/guard/src/test/java/org/onap/policy/xacml/pdp/application/guard/GuardPdpApplicationTest.java
+++ b/applications/guard/src/test/java/org/onap/policy/xacml/pdp/application/guard/GuardPdpApplicationTest.java
@@ -23,168 +23,300 @@
 package org.onap.policy.xacml.pdp.application.guard;
 
 import static org.assertj.core.api.Assertions.assertThat;
-import static org.assertj.core.api.Assertions.assertThatCode;
-
-import com.att.research.xacml.util.XACMLProperties;
-import com.google.common.io.Files;
-import com.google.gson.Gson;
 
 import java.io.File;
 import java.io.FileInputStream;
-import java.io.FileOutputStream;
+import java.io.FileNotFoundException;
+import java.io.IOException;
 import java.io.InputStream;
-import java.io.OutputStream;
-import java.nio.file.Path;
-import java.nio.file.Paths;
+import java.util.HashMap;
 import java.util.Iterator;
+import java.util.Map;
 import java.util.Properties;
 import java.util.ServiceLoader;
+import java.util.UUID;
 
-import org.junit.Before;
+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.utils.coder.CoderException;
+import org.onap.policy.common.utils.coder.StandardCoder;
 import org.onap.policy.common.utils.resources.TextFileUtils;
 import org.onap.policy.models.decisions.concepts.DecisionRequest;
-import org.onap.policy.models.decisions.serialization.DecisionRequestMessageBodyHandler;
-import org.onap.policy.models.decisions.serialization.DecisionResponseMessageBodyHandler;
+import org.onap.policy.models.decisions.concepts.DecisionResponse;
 import org.onap.policy.pdp.xacml.application.common.XacmlApplicationServiceProvider;
+import org.onap.policy.pdp.xacml.application.common.XacmlPolicyUtils;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
+import org.yaml.snakeyaml.Yaml;
 
+@FixMethodOrder(MethodSorters.NAME_ASCENDING)
 public class GuardPdpApplicationTest {
 
     private static final Logger LOGGER = LoggerFactory.getLogger(GuardPdpApplicationTest.class);
     private static Properties properties = new Properties();
     private static File propertiesFile;
     private static XacmlApplicationServiceProvider service;
-    private static DecisionRequest requestSinglePolicy;
-
-    private static Gson gsonDecisionRequest;
-    private static Gson gsonDecisionResponse;
+    private static DecisionRequest requestGuardPermit;
+    private static DecisionRequest requestGuardDeny;
+    private static DecisionRequest requestGuardDeny2;
+    private static StandardCoder gson = new StandardCoder();
 
     @ClassRule
     public static final TemporaryFolder policyFolder = new TemporaryFolder();
 
-    @Before
-    public void setUp() throws Exception {
+    /**
+     * 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 {
+        //
+        // Setup our temporary folder
+        //
+        XacmlPolicyUtils.FileCreator myCreator = (String filename) -> policyFolder.newFile(filename);
+        propertiesFile = XacmlPolicyUtils.copyXacmlPropertiesContents("src/test/resources/xacml.properties",
+                properties, myCreator);
+        //
+        // Load service
+        //
+        ServiceLoader<XacmlApplicationServiceProvider> applicationLoader =
+                ServiceLoader.load(XacmlApplicationServiceProvider.class);
+        //
+        // Find the guard service application and save for use in all the tests
+        //
+        StringBuilder strDump = new StringBuilder("Loaded applications:" + System.lineSeparator());
+        Iterator<XacmlApplicationServiceProvider> iterator = applicationLoader.iterator();
+        while (iterator.hasNext()) {
+            XacmlApplicationServiceProvider application = iterator.next();
+            //
+            // Is it our service?
+            //
+            if (application instanceof GuardPdpApplication) {
+                //
+                // 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(System.lineSeparator());
+        }
+        LOGGER.debug("{}", strDump);
+        //
+        // Tell it to initialize based on the properties file
+        // we just built for it.
+        //
+        service.initialize(propertiesFile.toPath().getParent());
+    }
 
+    @Test
+    public void test1Basics() throws CoderException, IOException {
+        //
+        // Load Single Decision Request
+        //
+        requestGuardPermit = gson.decode(
+                TextFileUtils.getTextFileAsString(
+                    "../../main/src/test/resources/decisions/decision.guard.shouldpermit.input.json"),
+                    DecisionRequest.class);
+        //
+        // Load Single Decision Request
+        //
+        requestGuardDeny = gson.decode(TextFileUtils.getTextFileAsString(
+                "../../main/src/test/resources/decisions/decision.guard.shoulddeny.input.json"),
+                DecisionRequest.class);
+        //
+        // Load Single Decision Request
+        //
+        requestGuardDeny2 = gson.decode(TextFileUtils.getTextFileAsString(
+                "../../main/src/test/resources/decisions/decision.guard.shoulddeny.input2.json"),
+                DecisionRequest.class);
+        //
+        // Make sure there's an application name
+        //
+        assertThat(service.applicationName()).isNotEmpty();
+        //
+        // Decisions
+        //
+        assertThat(service.actionDecisionsSupported().size()).isEqualTo(1);
+        assertThat(service.actionDecisionsSupported()).contains("guard");
+        //
+        // Ensure it has the supported policy types and
+        // can support the correct policy types.
+        //
+        assertThat(service.supportedPolicyTypes()).isNotEmpty();
+        assertThat(service.supportedPolicyTypes().size()).isEqualTo(2);
+        assertThat(service.canSupportPolicyType("onap.policies.controlloop.guard.FrequencyLimiter", "1.0.0"))
+            .isTrue();
+        assertThat(service.canSupportPolicyType("onap.policies.controlloop.guard.FrequencyLimiter", "1.0.1"))
+            .isFalse();
+        assertThat(service.canSupportPolicyType("onap.policies.controlloop.guard.MinMax", "1.0.0")).isTrue();
+        assertThat(service.canSupportPolicyType("onap.policies.controlloop.guard.MinMax", "1.0.1")).isFalse();
+        assertThat(service.canSupportPolicyType("onap.foo", "1.0.1")).isFalse();
     }
 
     @Test
-    public void testBasics() {
-        assertThatCode(() -> {
+    public void test2NoPolicies() {
+        //
+        // Ask for a decision
+        //
+        DecisionResponse response = service.makeDecision(requestGuardPermit);
+        LOGGER.info("Decision {}", response);
+
+        assertThat(response).isNotNull();
+        assertThat(response.getStatus()).isEqualTo("Permit");
+    }
+
+    @Test
+    public void test3FrequencyLimiter() throws CoderException, FileNotFoundException, IOException {
+        //
+        // Now load the vDNS frequency limiter Policy - make sure
+        // the pdp can support it and have it load
+        // into the PDP.
+        //
+        try (InputStream is = new FileInputStream("src/test/resources/vDNS.policy.guard.frequency.output.tosca.yaml")) {
             //
-            // Create our Gson builder
+            // Have yaml parse it
             //
-            gsonDecisionRequest = new DecisionRequestMessageBodyHandler().getGson();
-            gsonDecisionResponse = new DecisionResponseMessageBodyHandler().getGson();
+            Yaml yaml = new Yaml();
+            Map<String, Object> toscaObject = yaml.load(is);
             //
-            // Load Single Decision Request
+            // Load the policies
             //
-            requestSinglePolicy = gsonDecisionRequest.fromJson(
-                    TextFileUtils
-                        .getTextFileAsString("../../main/src/test/resources/decisions/decision.single.input.json"),
-                        DecisionRequest.class);
+            service.loadPolicies(toscaObject);
             //
-            // Copy all the properties and root policies to the temporary folder
+            // Ask for a decision - should get permit
             //
-            try (InputStream is = new FileInputStream("src/test/resources/xacml.properties")) {
-                //
-                // Load it in
-                //
-                properties.load(is);
-                propertiesFile = policyFolder.newFile("xacml.properties");
-                //
-                // Copy the root policies
-                //
-                for (String root : XACMLProperties.getRootPolicyIDs(properties)) {
-                    //
-                    // Get a file
-                    //
-                    Path rootPath = Paths.get(properties.getProperty(root + ".file"));
-                    LOGGER.debug("Root file {} {}", rootPath, rootPath.getFileName());
-                    //
-                    // Construct new file name
-                    //
-                    File newRootPath = policyFolder.newFile(rootPath.getFileName().toString());
-                    //
-                    // Copy it
-                    //
-                    Files.copy(rootPath.toFile(), newRootPath);
-                    assertThat(newRootPath).exists();
-                    //
-                    // Point to where the new policy is in the temp dir
-                    //
-                    properties.setProperty(root + ".file", newRootPath.getAbsolutePath());
-                }
-                try (OutputStream os = new FileOutputStream(propertiesFile.getAbsolutePath())) {
-                    properties.store(os, "");
-                    assertThat(propertiesFile).exists();
-                }
-            }
+            DecisionResponse response = service.makeDecision(requestGuardPermit);
+            LOGGER.info("Looking for Permit Decision {}", response);
+
+            assertThat(response).isNotNull();
+            assertThat(response.getStatus()).isNotNull();
+            assertThat(response.getStatus()).isEqualTo("Permit");
             //
-            // Load service
+            // Dump it out as Json
             //
-            ServiceLoader<XacmlApplicationServiceProvider> applicationLoader =
-                    ServiceLoader.load(XacmlApplicationServiceProvider.class);
+            LOGGER.info(gson.encode(response));
             //
-            // Iterate through them - I could store the object as
-            // XacmlApplicationServiceProvider pointer.
+            // Ask for a decision - should get deny
             //
-            // Try this later.
+            response = service.makeDecision(requestGuardDeny2);
+            LOGGER.info("Looking for Deny Decision {}", response);
+            assertThat(response).isNotNull();
+            assertThat(response.getStatus()).isNotNull();
+            assertThat(response.getStatus()).isEqualTo("Deny");
             //
-            StringBuilder strDump = new StringBuilder("Loaded applications:" + System.lineSeparator());
-            Iterator<XacmlApplicationServiceProvider> iterator = applicationLoader.iterator();
-            while (iterator.hasNext()) {
-                XacmlApplicationServiceProvider application = iterator.next();
-                //
-                // Is it our service?
-                //
-                if (application instanceof GuardPdpApplication) {
-                    //
-                    // 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(System.lineSeparator());
-            }
-            LOGGER.debug("{}", strDump);
+            // Dump it out as Json
+            //
+            LOGGER.info(gson.encode(response));
+        }
+    }
+
+    @Test
+    public void test4MinMax() throws CoderException, FileNotFoundException, IOException {
+        //
+        // Now load the vDNS min max Policy - make sure
+        // the pdp can support it and have it load
+        // into the PDP.
+        //
+        try (InputStream is = new FileInputStream("src/test/resources/vDNS.policy.guard.minmax.output.tosca.yaml")) {
+            //
+            // Have yaml parse it
+            //
+            Yaml yaml = new Yaml();
+            Map<String, Object> toscaObject = yaml.load(is);
+            //
+            // Load the policies
+            //
+            service.loadPolicies(toscaObject);
+            //
+            // Ask for a decision - should get permit
+            //
+            DecisionResponse response = service.makeDecision(requestGuardPermit);
+            LOGGER.info("Looking for Permit Decision {}", response);
+
+            assertThat(response).isNotNull();
+            assertThat(response.getStatus()).isNotNull();
+            assertThat(response.getStatus()).isEqualTo("Permit");
+            //
+            // Dump it out as Json
+            //
+            LOGGER.info(gson.encode(response));
+            //
+            // Ask for a decision - should get deny
+            //
+            response = service.makeDecision(requestGuardDeny);
+            LOGGER.info("Looking for Deny Decision {}", response);
+            assertThat(response).isNotNull();
+            assertThat(response.getStatus()).isNotNull();
+            assertThat(response.getStatus()).isEqualTo("Deny");
+            //
+            // Dump it out as Json
+            //
+            LOGGER.info(gson.encode(response));
+        }
+    }
+
+    @Test
+    public void test5MissingFields() throws FileNotFoundException, IOException {
+        LOGGER.debug("Running test5");
+        //
+        // Most likely we would not get a policy with missing fields passed to
+        // us from the API. But in case that happens, or we decide that some fields
+        // will be optional due to re-working of how the XACML policies are built,
+        // let's add support in for that.
+        //
+        try (InputStream is = new FileInputStream("src/test/resources/guard.policy-minmax-missing-fields1.yaml")) {
             //
-            // Tell it to initialize based on the properties file
-            // we just built for it.
+            // Have yaml parse it
             //
-            service.initialize(propertiesFile.toPath().getParent());
+            Yaml yaml = new Yaml();
+            Map<String, Object> toscaObject = yaml.load(is);
             //
-            // Make sure there's an application name
+            // Load the policies
             //
-            assertThat(service.applicationName()).isNotEmpty();
+            service.loadPolicies(toscaObject);
             //
-            // Decisions
+            // We can create a DecisionRequest on the fly - no need
+            // to have it in the .json files
             //
-            assertThat(service.actionDecisionsSupported().size()).isEqualTo(1);
-            assertThat(service.actionDecisionsSupported()).contains("guard");
+            DecisionRequest request = new DecisionRequest();
+            request.setOnapName("JUnit");
+            request.setOnapComponent("test5MissingFields");
+            request.setRequestId(UUID.randomUUID().toString());
+            request.setAction("guard");
+            Map<String, Object> guard = new HashMap<>();
+            guard.put("actor", "FOO");
+            guard.put("recipe", "bar");
+            guard.put("vfCount", "4");
+            Map<String, Object> resource = new HashMap<>();
+            resource.put("guard", guard);
+            request.setResource(resource);
             //
-            // Ensure it has the supported policy types and
-            // can support the correct policy types.
+            // Ask for a decision - should get permit
             //
-            assertThat(service.supportedPolicyTypes()).isNotEmpty();
-            assertThat(service.supportedPolicyTypes().size()).isEqualTo(2);
-            assertThat(service.canSupportPolicyType("onap.policies.controlloop.guard.FrequencyLimiter", "1.0.0"))
-                .isTrue();
-            assertThat(service.canSupportPolicyType("onap.policies.controlloop.guard.FrequencyLimiter", "1.0.1"))
-                .isFalse();
-            assertThat(service.canSupportPolicyType("onap.policies.controlloop.guard.MinMax", "1.0.0")).isTrue();
-            assertThat(service.canSupportPolicyType("onap.policies.controlloop.guard.MinMax", "1.0.1")).isFalse();
-            assertThat(service.canSupportPolicyType("onap.foo", "1.0.1")).isFalse();
+            DecisionResponse response = service.makeDecision(request);
+            LOGGER.info("Looking for Permit Decision {}", response);
+            assertThat(response).isNotNull();
+            assertThat(response.getStatus()).isNotNull();
+            assertThat(response.getStatus()).isEqualTo("Permit");
             //
-            // Ensure it supports decisions
+            // Try a deny
             //
-            assertThat(service.actionDecisionsSupported()).contains("guard");
-        }).doesNotThrowAnyException();
+            guard.put("vfCount", "10");
+            resource.put("guard", guard);
+            request.setResource(resource);
+            response = service.makeDecision(request);
+            LOGGER.info("Looking for Deny Decision {}", response);
+            assertThat(response).isNotNull();
+            assertThat(response.getStatus()).isNotNull();
+            assertThat(response.getStatus()).isEqualTo("Deny");
+        }
     }
 }
diff --git a/applications/guard/src/test/resources/guard.policy-minmax-missing-fields1.yaml b/applications/guard/src/test/resources/guard.policy-minmax-missing-fields1.yaml
new file mode 100644
index 00000000..6a441182
--- /dev/null
+++ b/applications/guard/src/test/resources/guard.policy-minmax-missing-fields1.yaml
@@ -0,0 +1,19 @@
+tosca_definitions_version: tosca_simple_yaml_1_0_0
+topology_template:
+  policies:
+    -
+      guard.minmax.missing1:
+        type: onap.policies.controlloop.guard.MinMax
+        version: 1.0.0
+        metadata:
+          policy-id : guard.minmax.scaleout
+          policy-version: 1
+        properties:
+          actor: FOO
+          recipe: bar
+#          targets: *.
+#          clname: ControlLoop-Foo-Bar
+          min: 1
+          max: 5
+#          guardActiveStart: 00:00:01-05:00
+#          guardActiveEnd: 23:59:59-05:00
diff --git a/applications/guard/src/test/resources/vDNS.policy.guard.frequency.output.tosca.yaml b/applications/guard/src/test/resources/vDNS.policy.guard.frequency.output.tosca.yaml
new file mode 100644
index 00000000..03afd5e2
--- /dev/null
+++ b/applications/guard/src/test/resources/vDNS.policy.guard.frequency.output.tosca.yaml
@@ -0,0 +1,20 @@
+tosca_definitions_version: tosca_simple_yaml_1_0_0
+topology_template:
+  policies:
+    -
+      guard.frequency.scaleout:
+        type: onap.policies.controlloop.guard.FrequencyLimiter
+        version: 1.0.0
+        metadata:
+          policy-id: guard.frequency.scaleout
+          policy-version: 1 
+        properties:
+          actor: SO
+          recipe: scaleOut
+          targets: .*
+          clname: ControlLoop-vDNS-6f37f56d-a87d-4b85-b6a9-cc953cf779b3
+          limit: 1
+          timeWindow: 10
+          timeUnits: minute
+          guardActiveStart: 00:00:01-05:00
+          guardActiveEnd: 23:59:59-05:00
diff --git a/applications/guard/src/test/resources/vDNS.policy.guard.minmax.output.tosca.yaml b/applications/guard/src/test/resources/vDNS.policy.guard.minmax.output.tosca.yaml
new file mode 100644
index 00000000..5ac76015
--- /dev/null
+++ b/applications/guard/src/test/resources/vDNS.policy.guard.minmax.output.tosca.yaml
@@ -0,0 +1,19 @@
+tosca_definitions_version: tosca_simple_yaml_1_0_0
+topology_template:
+  policies:
+    -
+      guard.minmax.scaleout:
+        type: onap.policies.controlloop.guard.MinMax
+        version: 1.0.0
+        metadata:
+          policy-id : guard.minmax.scaleout
+          policy-version: 1
+        properties:
+          actor: SO
+          recipe: scaleOut
+          targets: .*
+          clname: ControlLoop-vDNS-6f37f56d-a87d-4b85-b6a9-cc953cf779b3
+          min: 1
+          max: 5
+          guardActiveStart: 00:00:01-05:00
+          guardActiveEnd: 23:59:59-05:00
diff --git a/applications/guard/src/test/resources/xacml.properties b/applications/guard/src/test/resources/xacml.properties
index b32a936c..9bd7bfb8 100644
--- a/applications/guard/src/test/resources/xacml.properties
+++ b/applications/guard/src/test/resources/xacml.properties
@@ -20,18 +20,13 @@ xacml.att.functionDefinitionFactory=com.att.research.xacmlatt.pdp.std.StdFunctio
 xacml.att.policyFinderFactory=org.onap.policy.pdp.xacml.application.common.OnapPolicyFinderFactory
 
 #
-# ONAP Implementation Factories
+# Use a root combining algorithm
 #
-#xacml.att.policyFinderFactory=org.onap.policy.pdp.xacml.application.common.OnapApplicationPolicyFinder
+xacml.att.policyFinderFactory.combineRootPolicies=urn:oasis:names:tc:xacml:3.0:policy-combining-algorithm:permit-unless-deny
 
-#
-# NOTE: If you are testing against a RESTful PDP, then the PDP must be configured with the
-# policies and PIP configuration as defined below. Otherwise, this is the configuration that
-# the embedded PDP uses.
-#
 
 # Policies to load
 #
-xacml.rootPolicies=guard
-guard.file=src/main/resources/RootGuardPolicy.xml
+#xacml.rootPolicies=guard
+#guard.file=src/main/resources/RootGuardPolicy.xml