YAML clc directive spec/compilation to XACML

Created java definition of CoordinationDirective class.
Initial library supports one coordination directive FirstBlocksSecond,
prototype for this directive added as firstBlocksSecond.xml.
Functions for compiling example yaml directive are in SupportUtil.

Change-Id: If7c22402729670403510f1fa2f7f43de6a4a522c
Issue-ID: POLICY-1173
Signed-off-by: Joshua Reich <jreich@research.att.com>

7 files changed, 399 insertions, 4 deletions

diff --git a/controlloop/common/coordination/pom.xml b/controlloop/common/coordination/pom.xml
new file mode 100644
index 000000000..1c6e44d41
--- /dev/null
+++ b/controlloop/common/coordination/pom.xml
@@ -0,0 +1,89 @@
+<!--
+  ============LICENSE_START=======================================================
+  drools-applications
+  ================================================================================
+  Copyright (C) 2019 AT&T Intellectual Property. 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.
+  ============LICENSE_END=========================================================
+  -->
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+
+  <parent>
+    <groupId>org.onap.policy.drools-applications.controlloop.common</groupId>
+    <artifactId>common</artifactId>
+    <version>1.4.0-SNAPSHOT</version>
+  </parent>
+
+  <artifactId>coordination</artifactId>
+
+  <dependencies>
+    <dependency>
+      <groupId>junit</groupId>
+      <artifactId>junit</artifactId>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.onap.policy.drools-pdp</groupId>
+      <artifactId>policy-management</artifactId>
+      <version>${version.policy.drools-pdp}</version>
+      <scope>provided</scope>
+    </dependency>
+    <dependency>
+    <groupId>org.assertj</groupId>
+    <artifactId>assertj-core</artifactId>
+    <scope>test</scope>
+</dependency>
+  </dependencies>
+    <build>
+        <plugins>
+            <plugin>
+                <artifactId>maven-checkstyle-plugin</artifactId>
+                <executions>
+                    <execution>
+                        <id>onap-java-style</id>
+                        <goals>
+                            <goal>check</goal>
+                        </goals>
+                        <phase>process-sources</phase>
+                        <configuration>
+                            <!-- Use Google Java Style Guide:
+                            https://github.com/checkstyle/checkstyle/blob/master/src/main/resources/google_checks.xml
+                            with minor changes -->
+                            <configLocation>onap-checkstyle/onap-java-style.xml</configLocation>
+                            <!-- <sourceDirectory> is needed so that checkstyle ignores the generated sources directory -->
+                            <sourceDirectory>${project.build.sourceDirectory}</sourceDirectory>
+                            <includeResources>true</includeResources>
+                            <includeTestSourceDirectory>true</includeTestSourceDirectory>
+                            <includeTestResources>true</includeTestResources>
+                            <excludes>
+                            </excludes>
+                            <consoleOutput>true</consoleOutput>
+                            <failsOnViolation>true</failsOnViolation>
+                            <violationSeverity>warning</violationSeverity>
+                        </configuration>
+                    </execution>
+                </executions>
+                <dependencies>
+                    <dependency>
+                        <groupId>org.onap.oparent</groupId>
+                        <artifactId>checkstyle</artifactId>
+                        <version>${oparent.version}</version>
+                        <scope>compile</scope>
+                    </dependency>
+                </dependencies>
+            </plugin>
+        </plugins>
+    </build>
+</project>
diff --git a/controlloop/common/coordination/src/main/java/org/onap/policy/coordination/CoordinationDirective.java b/controlloop/common/coordination/src/main/java/org/onap/policy/coordination/CoordinationDirective.java
new file mode 100644
index 000000000..6ba4ca478
--- /dev/null
+++ b/controlloop/common/coordination/src/main/java/org/onap/policy/coordination/CoordinationDirective.java
@@ -0,0 +1,67 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * guard
+ * ================================================================================
+ * Copyright (C) 2019 AT&T Intellectual Property. 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.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.coordination;
+
+import java.util.List;
+
+public class CoordinationDirective {
+
+    private List<String> controlLoop;
+    private String coordinationFunction;
+
+    public List<String> getControlLoop() {
+        return controlLoop;
+    }
+
+    /**
+     * gets the ith control loop.
+     *
+     * @param index the control loop's index
+     * @return the CoordinationDirective's string representation
+     */
+    public String getControlLoop(int index) {
+        return controlLoop.get(index);
+    }
+
+    public void setControlLoop(List<String> controlLoop) {
+        this.controlLoop = controlLoop;
+    }
+
+    public String getCoordinationFunction() {
+        return coordinationFunction;
+    }
+
+    public void setCoordinationFunction(String coordinationFunction) {
+        this.coordinationFunction = coordinationFunction;
+    }
+
+    /**
+     * toString.
+     *
+     * @return the CoordinationDirective's string representation
+     */
+    public String toString() {
+        return "CoordinationDirective[ "
+            + String.join(" / ", controlLoop)
+            + " / " + coordinationFunction + "]";
+    }
+
+}
diff --git a/controlloop/common/coordination/src/main/java/org/onap/policy/coordination/Util.java b/controlloop/common/coordination/src/main/java/org/onap/policy/coordination/Util.java
new file mode 100644
index 000000000..d76684093
--- /dev/null
+++ b/controlloop/common/coordination/src/main/java/org/onap/policy/coordination/Util.java
@@ -0,0 +1,104 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * controlloop
+ * ================================================================================
+ * Copyright (C) 2019 AT&T Intellectual Property. 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.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.coordination;
+
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.nio.charset.StandardCharsets;
+import java.nio.file.Files;
+import java.nio.file.Paths;
+import java.util.UUID;
+import java.util.stream.Collectors;
+import java.util.stream.Stream;
+
+import org.apache.commons.io.IOUtils;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.yaml.snakeyaml.Yaml;
+import org.yaml.snakeyaml.constructor.Constructor;
+
+
+public final class Util {
+
+    private static final Logger logger = LoggerFactory.getLogger(Util.class);
+
+    /**
+     * Load YAML coordination directive.
+     *
+     * @param directiveFilename yaml directive file to load
+     * @return the CoordinationDirective
+     */
+    public static CoordinationDirective loadCoordinationDirectiveFromFile(String directiveFilename) {
+        try (InputStream is = new FileInputStream(new File(directiveFilename))) {
+            String contents = IOUtils.toString(is, StandardCharsets.UTF_8);
+            //
+            // Read the yaml into our Java Object
+            //
+            Yaml yaml = new Yaml(new Constructor(CoordinationDirective.class));
+            Object obj = yaml.load(contents);
+
+            logger.debug(contents);
+
+            return (CoordinationDirective) obj;
+        } catch (IOException e) {
+            logger.error("Error while loading YAML coordination directive", e);
+        }
+        return null;
+    }
+
+    /**
+     * Generate Xacml rule implementing specified CoordinationDirective.
+     *
+     * @param cd the CoordinationDirective
+     * @param protoDir the directory containing Xacml implementation prototypes
+     * @return the generated Xacml policy
+     */
+    public static String generateXacmlFromCoordinationDirective(CoordinationDirective cd,
+                                                                String protoDir) {
+        /*
+         * Determine file names
+         */
+        String xacmlProtoFilename = protoDir + File.separator + cd.getCoordinationFunction() + ".xml";
+        logger.debug("xacmlProtoFilename={}", xacmlProtoFilename);
+        /*
+         * Values to be used for placeholders
+         */
+        final String uniqueId = UUID.randomUUID().toString();
+        final String cLOne = cd.getControlLoop(0);
+        final String cLTwo = cd.getControlLoop(1);
+        /*
+         * Replace prototype placeholders with appropriate values
+         */
+        String xacmlPolicy = null;
+        try (Stream<String> stream = Files.lines(Paths.get(xacmlProtoFilename))) {
+            xacmlPolicy = stream.map(s -> s.replaceAll("UNIQUE_ID", uniqueId))
+                .map(s -> s.replaceAll("CONTROL_LOOP_ONE", cLOne))
+                .map(s -> s.replaceAll("CONTROL_LOOP_TWO", cLTwo))
+                .collect(Collectors.joining(System.lineSeparator()));
+        } catch (IOException e) {
+            logger.error("Error while generating XACML policy for coordination directive", e);
+        }
+        return xacmlPolicy;
+    }
+
+}
diff --git a/controlloop/common/coordination/src/test/java/org/onap/policy/coordination/CoordinationDirectiveTest.java b/controlloop/common/coordination/src/test/java/org/onap/policy/coordination/CoordinationDirectiveTest.java
new file mode 100644
index 000000000..30606d1fd
--- /dev/null
+++ b/controlloop/common/coordination/src/test/java/org/onap/policy/coordination/CoordinationDirectiveTest.java
@@ -0,0 +1,55 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * controlloop
+ * ================================================================================
+ * Copyright (C) 2019 AT&T Intellectual Property. 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.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.coordination;
+
+import static org.assertj.core.api.Assertions.assertThatThrownBy;
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.assertNull;
+
+import java.util.Arrays;
+import org.assertj.core.api.Assertions;
+import org.junit.Test;
+
+public class CoordinationDirectiveTest {
+
+    @Test
+    public void test() {
+
+        CoordinationDirective cd1 = new CoordinationDirective();
+
+        assertNotNull(cd1);
+
+        assertNull(cd1.getControlLoop());
+        assertNull(cd1.getCoordinationFunction());
+
+        cd1.setControlLoop(Arrays.asList("cl1", "cl2"));
+        cd1.setCoordinationFunction("firstBlocksSecond");
+
+        assertNotNull(cd1.getControlLoop());
+        assertNotNull(cd1.getControlLoop(0));
+        assertNotNull(cd1.getControlLoop(1));
+        assertThatThrownBy(() -> {
+            cd1.getControlLoop(2);
+        }).isInstanceOf(IndexOutOfBoundsException.class);
+        assertNotNull(cd1.getCoordinationFunction());
+    }
+}
diff --git a/controlloop/common/coordination/src/test/java/org/onap/policy/coordination/UtilTest.java b/controlloop/common/coordination/src/test/java/org/onap/policy/coordination/UtilTest.java
new file mode 100644
index 000000000..76ae3b41c
--- /dev/null
+++ b/controlloop/common/coordination/src/test/java/org/onap/policy/coordination/UtilTest.java
@@ -0,0 +1,59 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * controlloop
+ * ================================================================================
+ * Copyright (C) 2019 AT&T Intellectual Property. 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.
+ * ============LICENSE_END=========================================================
+ */
+
+package org.onap.policy.coordination;
+
+import static org.assertj.core.api.Assertions.assertThatNullPointerException;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.assertNull;
+import static org.junit.Assert.fail;
+
+import org.junit.Test;
+
+public class UtilTest {
+
+    @Test
+    public void test() {
+
+        String filename = "src/test/resources/test_coordination_directive.yaml";
+        CoordinationDirective cd1 = Util.loadCoordinationDirectiveFromFile(filename);
+
+        assertNotNull(cd1);
+
+        assertNotNull(cd1.getControlLoop(0));
+        assertNotNull(cd1.getControlLoop(1));
+        assertNotNull(cd1.getCoordinationFunction());
+
+        assertEquals("cl1", cd1.getControlLoop(0));
+        assertEquals("cl2", cd1.getControlLoop(1));
+        assertEquals("cf", cd1.getCoordinationFunction());
+
+        filename = "src/test/resources/non_existent_coordination_directive.yaml";
+        CoordinationDirective cd2 = Util.loadCoordinationDirectiveFromFile(filename);
+
+        assertNull(cd2);
+
+        assertThatNullPointerException().isThrownBy(() -> {
+            Util.generateXacmlFromCoordinationDirective(cd2, "");
+        });
+    }
+}
diff --git a/controlloop/common/coordination/src/test/resources/test_coordination_directive.yaml b/controlloop/common/coordination/src/test/resources/test_coordination_directive.yaml
new file mode 100644
index 000000000..ede643c90
--- /dev/null
+++ b/controlloop/common/coordination/src/test/resources/test_coordination_directive.yaml
@@ -0,0 +1,20 @@
+# Copyright 2019 AT&T Intellectual Property. 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.
+
+!!org.onap.policy.coordination.CoordinationDirective
+
+controlLoop:
+- cl1
+- cl2
+coordinationFunction: cf
\ No newline at end of file
diff --git a/controlloop/common/pom.xml b/controlloop/common/pom.xml
index a0d003c9f..bab8de9d5 100644
--- a/controlloop/common/pom.xml
+++ b/controlloop/common/pom.xml
@@ -2,14 +2,14 @@
     ============LICENSE_START=======================================================
     Drools PDP Application Common Models
     ================================================================================
-    Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
+    Copyright (C) 2017, 2019 AT&T Intellectual Property. 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.
@@ -21,7 +21,7 @@
 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
   <modelVersion>4.0.0</modelVersion>
   <packaging>pom</packaging>
-  
+
   <parent>
     <groupId>org.onap.policy.drools-applications.controlloop</groupId>
     <artifactId>controlloop</artifactId>
@@ -34,6 +34,7 @@
   <modules>
     <module>actors</module>
     <module>guard</module>
+    <module>coordination</module>
     <module>eventmanager</module>
     <module>model-impl</module>
     <module>policy-yaml</module>