From 0e6c41057abc93f76b75370b7a9a09443d7fc6ec Mon Sep 17 00:00:00 2001
From: Zhigang Ji <jizhigang@huawei.com>
Date: Fri, 20 Nov 2015 15:12:32 +0800
Subject: [PATCH] Add initial NEMO CLI renderer structure.

Change-Id: Ie511715b77aae700241f981206f15e888e392274
Signed-off-by: Zhigang Ji <jizhigang@huawei.com>
---
 nemo-artifacts/pom.xml                        |   5 +
 nemo-features/pom.xml                         |  12 ++
 nemo-features/src/main/features/features.xml  |   2 +
 nemo-renderers/cli-renderer/pom.xml           | 162 ++++++++++++++++++
 .../nemo/renderer/cli/CliRenderer.java        |  40 +++++
 .../impl/rev151119/CliRendererModule.java     |  33 ++++
 .../rev151119/CliRendererModuleFactory.java   |  13 ++
 .../etc/opendaylight/karaf/config.xml         |  33 ++++
 .../src/main/yang/cli-renderer-impl.yang      |  62 +++++++
 .../src/main/yang/cli-renderer.yang           |  22 +++
 nemo-renderers/pom.xml                        |   1 +
 pom.xml                                       |   2 +-
 12 files changed, 386 insertions(+), 1 deletion(-)
 create mode 100644 nemo-renderers/cli-renderer/pom.xml
 create mode 100644 nemo-renderers/cli-renderer/src/main/java/org/opendaylight/nemo/renderer/cli/CliRenderer.java
 create mode 100644 nemo-renderers/cli-renderer/src/main/java/org/opendaylight/yang/gen/v1/urn/opendaylight/params/xml/ns/yang/nemo/cli/renderer/impl/rev151119/CliRendererModule.java
 create mode 100644 nemo-renderers/cli-renderer/src/main/java/org/opendaylight/yang/gen/v1/urn/opendaylight/params/xml/ns/yang/nemo/cli/renderer/impl/rev151119/CliRendererModuleFactory.java
 create mode 100644 nemo-renderers/cli-renderer/src/main/resources/etc/opendaylight/karaf/config.xml
 create mode 100644 nemo-renderers/cli-renderer/src/main/yang/cli-renderer-impl.yang
 create mode 100644 nemo-renderers/cli-renderer/src/main/yang/cli-renderer.yang

diff --git a/nemo-artifacts/pom.xml b/nemo-artifacts/pom.xml
index a78d80d..522ac31 100644
--- a/nemo-artifacts/pom.xml
+++ b/nemo-artifacts/pom.xml
@@ -32,6 +32,11 @@ and is available at http://www.eclipse.org/legal/epl-v10.html
         <artifactId>openflow-renderer</artifactId>
         <version>${project.version}</version>
       </dependency>
+      <dependency>
+        <groupId>${project.groupId}</groupId>
+        <artifactId>cli-renderer</artifactId>
+        <version>${project.version}</version>
+      </dependency>
       <dependency>
         <groupId>${project.groupId}</groupId>
         <artifactId>nemo-ui</artifactId>
diff --git a/nemo-features/pom.xml b/nemo-features/pom.xml
index 8f32032..44bd72b 100644
--- a/nemo-features/pom.xml
+++ b/nemo-features/pom.xml
@@ -169,6 +169,18 @@ and is available at http://www.eclipse.org/legal/epl-v10.html
       <classifier>external-resource</classifier>
       <type>json</type>
     </dependency>
+    <dependency>
+      <groupId>${project.groupId}</groupId>
+      <artifactId>cli-renderer</artifactId>
+      <version>${project.version}</version>
+    </dependency>
+    <dependency>
+      <groupId>${project.groupId}</groupId>
+      <artifactId>cli-renderer</artifactId>
+      <version>${project.version}</version>
+      <classifier>config</classifier>
+      <type>xml</type>
+    </dependency>
     <dependency>
       <groupId>${project.groupId}</groupId>
       <artifactId>nemo-ui</artifactId>
diff --git a/nemo-features/src/main/features/features.xml b/nemo-features/src/main/features/features.xml
index 2cfb0c4..f28721a 100644
--- a/nemo-features/src/main/features/features.xml
+++ b/nemo-features/src/main/features/features.xml
@@ -43,6 +43,8 @@ and is available at http://www.eclipse.org/legal/epl-v10.html
   </feature>
   <feature name='odl-nemo-cli-renderer' version='${project.version}' description='OpenDaylight :: NEMO :: CLI Renderer'>
     <feature version='${project.version}'>odl-nemo-engine-rest</feature>
+    <bundle>mvn:org.opendaylight.nemo/cli-renderer/${project.version}</bundle>
+    <configfile finalname='etc/opendaylight/karaf/02-nemo-cli-renderer.xml'>mvn:org.opendaylight.nemo/cli-renderer/${project.version}/xml/config</configfile>
   </feature>
   <feature name='odl-nemo-engine-ui' version='${project.version}' description='OpenDaylight :: NEMO :: Engine :: UI'>
     <feature version='${dlux.version}'>odl-dlux-core</feature>
diff --git a/nemo-renderers/cli-renderer/pom.xml b/nemo-renderers/cli-renderer/pom.xml
new file mode 100644
index 0000000..9ec4d15
--- /dev/null
+++ b/nemo-renderers/cli-renderer/pom.xml
@@ -0,0 +1,162 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+Copyright (c) 2015 Huawei, Inc and others. All rights reserved.
+This program and the accompanying materials are made available under the
+terms of the Eclipse Public License v1.0 which accompanies this distribution,
+and is available at http://www.eclipse.org/legal/epl-v10.html
+-->
+<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.opendaylight.controller</groupId>
+    <artifactId>config-parent</artifactId>
+    <version>0.4.0-SNAPSHOT</version>
+    <relativePath />
+  </parent>
+
+  <groupId>org.opendaylight.nemo</groupId>
+  <artifactId>cli-renderer</artifactId>
+  <version>1.0.0-SNAPSHOT</version>
+  <packaging>bundle</packaging>
+  <name>${project.artifactId}</name>
+
+  <properties>
+    <jacoco.version>0.7.2.201409121644</jacoco.version>
+    <sonar.jacoco.reportPath>target/code-coverage/jacoco.exec</sonar.jacoco.reportPath>
+    <sonar.jacoco.itReportPath>target/code-coverage/jacoco-it.exec</sonar.jacoco.itReportPath>
+  </properties>
+
+  <dependencies>
+    <dependency>
+      <groupId>${project.groupId}</groupId>
+      <artifactId>nemo-api</artifactId>
+      <version>${project.version}</version>
+    </dependency>
+    <dependency>
+      <groupId>${project.groupId}</groupId>
+      <artifactId>nemo-impl</artifactId>
+      <version>${project.version}</version>
+    </dependency>
+    <dependency>
+      <groupId>junit</groupId>
+      <artifactId>junit</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>org.mockito</groupId>
+      <artifactId>mockito-all</artifactId>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.slf4j</groupId>
+      <artifactId>slf4j-simple</artifactId>
+      <scope>test</scope>
+    </dependency>
+  </dependencies>
+
+  <build>
+    <pluginManagement>
+      <plugins>
+        <plugin>
+          <groupId>org.jacoco</groupId>
+          <artifactId>jacoco-maven-plugin</artifactId>
+          <version>${jacoco.version}</version>
+        </plugin>
+      </plugins>
+    </pluginManagement>
+    <plugins>
+      <plugin>
+        <groupId>org.opendaylight.yangtools</groupId>
+        <artifactId>yang-maven-plugin</artifactId>
+        <executions>
+          <execution>
+            <goals>
+              <goal>generate-sources</goal>
+            </goals>
+            <configuration>
+              <yangFilesRootDir>src/main/yang</yangFilesRootDir>
+              <codeGenerators>
+                <generator>
+                  <codeGeneratorClass>
+                    org.opendaylight.yangtools.maven.sal.api.gen.plugin.CodeGeneratorImpl
+                  </codeGeneratorClass>
+                  <outputBaseDir>
+                    ${salGeneratorPath}
+                  </outputBaseDir>
+                </generator>
+              </codeGenerators>
+              <inspectDependencies>true</inspectDependencies>
+            </configuration>
+          </execution>
+        </executions>
+        <dependencies>
+          <dependency>
+            <groupId>org.opendaylight.mdsal</groupId>
+            <artifactId>maven-sal-api-gen-plugin</artifactId>
+            <version>${yangtools.version}</version>
+            <type>jar</type>
+          </dependency>
+        </dependencies>
+      </plugin>
+      <plugin>
+        <groupId>org.codehaus.mojo</groupId>
+        <artifactId>build-helper-maven-plugin</artifactId>
+        <executions>
+          <execution>
+            <id>attach-artifacts</id>
+            <goals>
+              <goal>attach-artifact</goal>
+            </goals>
+            <phase>package</phase>
+            <configuration>
+              <artifacts>
+                <artifact>
+                  <file>${project.build.directory}/classes/etc/opendaylight/karaf/config.xml</file>
+                  <type>xml</type>
+                  <classifier>config</classifier>
+                </artifact>
+              </artifacts>
+            </configuration>
+          </execution>
+        </executions>
+      </plugin>
+      <plugin>
+        <groupId>org.jacoco</groupId>
+        <artifactId>jacoco-maven-plugin</artifactId>
+        <configuration>
+          <includes>
+            <include>org.opendaylight.nemo.*</include>
+          </includes>
+        </configuration>
+        <executions>
+          <execution>
+            <id>pre-unit-test</id>
+            <goals>
+              <goal>prepare-agent</goal>
+            </goals>
+            <configuration>
+              <destFile>${sonar.jacoco.reportPath}</destFile>
+            </configuration>
+          </execution>
+          <execution>
+            <id>post-unit-test</id>
+            <goals>
+              <goal>report</goal>
+            </goals>
+            <configuration>
+              <dataFile>${sonar.jacoco.reportPath}</dataFile>
+            </configuration>
+          </execution>
+        </executions>
+      </plugin>
+    </plugins>
+  </build>
+
+  <scm>
+    <connection>scm:git:ssh://git.opendaylight.org:29418/nemo.git</connection>
+    <developerConnection>scm:git:ssh://git.opendaylight.org:29418/nemo.git</developerConnection>
+    <url>https://wiki.opendaylight.org/view/NEMO:Main</url>
+    <tag>HEAD</tag>
+  </scm>
+</project>
\ No newline at end of file
diff --git a/nemo-renderers/cli-renderer/src/main/java/org/opendaylight/nemo/renderer/cli/CliRenderer.java b/nemo-renderers/cli-renderer/src/main/java/org/opendaylight/nemo/renderer/cli/CliRenderer.java
new file mode 100644
index 0000000..5734b83
--- /dev/null
+++ b/nemo-renderers/cli-renderer/src/main/java/org/opendaylight/nemo/renderer/cli/CliRenderer.java
@@ -0,0 +1,40 @@
+/*
+ * Copyright (c) 2015 Huawei, Inc. and others. All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
+
+package org.opendaylight.nemo.renderer.cli;
+
+import org.opendaylight.controller.md.sal.binding.api.DataBroker;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * NEMO renderer that uses CLI to implement an overlay network
+ * using traditional network devices.
+ *
+ * @author Zhigang Ji
+ */
+public class CliRenderer implements AutoCloseable {
+    private static final Logger LOG = LoggerFactory.getLogger(CliRenderer.class);
+
+    private final DataBroker dataBroker;
+
+    public CliRenderer(DataBroker dataBroker) {
+        super();
+
+        this.dataBroker = dataBroker;
+
+        LOG.info("Initialized the NEMO CLI renderer.");
+
+        return;
+    }
+
+    @Override
+    public void close() throws Exception {
+        // TODO
+    }
+}
diff --git a/nemo-renderers/cli-renderer/src/main/java/org/opendaylight/yang/gen/v1/urn/opendaylight/params/xml/ns/yang/nemo/cli/renderer/impl/rev151119/CliRendererModule.java b/nemo-renderers/cli-renderer/src/main/java/org/opendaylight/yang/gen/v1/urn/opendaylight/params/xml/ns/yang/nemo/cli/renderer/impl/rev151119/CliRendererModule.java
new file mode 100644
index 0000000..9ebf945
--- /dev/null
+++ b/nemo-renderers/cli-renderer/src/main/java/org/opendaylight/yang/gen/v1/urn/opendaylight/params/xml/ns/yang/nemo/cli/renderer/impl/rev151119/CliRendererModule.java
@@ -0,0 +1,33 @@
+package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.nemo.cli.renderer.impl.rev151119;
+
+import org.opendaylight.controller.md.sal.binding.api.DataBroker;
+import org.opendaylight.nemo.renderer.cli.CliRenderer;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class CliRendererModule extends org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.nemo.cli.renderer.impl.rev151119.AbstractCliRendererModule {
+    private static final Logger LOG = LoggerFactory.getLogger(CliRendererModule.class);
+
+    public CliRendererModule(org.opendaylight.controller.config.api.ModuleIdentifier identifier, org.opendaylight.controller.config.api.DependencyResolver dependencyResolver) {
+        super(identifier, dependencyResolver);
+    }
+
+    public CliRendererModule(org.opendaylight.controller.config.api.ModuleIdentifier identifier, org.opendaylight.controller.config.api.DependencyResolver dependencyResolver, CliRendererModule oldModule, AutoCloseable oldInstance) {
+        super(identifier, dependencyResolver, oldModule, oldInstance);
+    }
+
+    @Override
+    public void customValidation() {
+        // add custom validation form module attributes here.
+    }
+
+    @Override
+    public AutoCloseable createInstance() {
+        DataBroker dataBroker = getDataBrokerDependency();
+
+        // TODO
+
+        return new CliRenderer(dataBroker);
+    }
+
+}
diff --git a/nemo-renderers/cli-renderer/src/main/java/org/opendaylight/yang/gen/v1/urn/opendaylight/params/xml/ns/yang/nemo/cli/renderer/impl/rev151119/CliRendererModuleFactory.java b/nemo-renderers/cli-renderer/src/main/java/org/opendaylight/yang/gen/v1/urn/opendaylight/params/xml/ns/yang/nemo/cli/renderer/impl/rev151119/CliRendererModuleFactory.java
new file mode 100644
index 0000000..5748d81
--- /dev/null
+++ b/nemo-renderers/cli-renderer/src/main/java/org/opendaylight/yang/gen/v1/urn/opendaylight/params/xml/ns/yang/nemo/cli/renderer/impl/rev151119/CliRendererModuleFactory.java
@@ -0,0 +1,13 @@
+/*
+* Generated file
+*
+* Generated from: yang module name: cli-renderer-impl yang module local name: cli-renderer-impl
+* Generated by: org.opendaylight.controller.config.yangjmxgenerator.plugin.JMXGenerator
+* Generated at: Fri Nov 20 01:24:34 CST 2015
+*
+* Do not modify this file unless it is present under src/main directory
+*/
+package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.nemo.cli.renderer.impl.rev151119;
+public class CliRendererModuleFactory extends org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.nemo.cli.renderer.impl.rev151119.AbstractCliRendererModuleFactory {
+
+}
diff --git a/nemo-renderers/cli-renderer/src/main/resources/etc/opendaylight/karaf/config.xml b/nemo-renderers/cli-renderer/src/main/resources/etc/opendaylight/karaf/config.xml
new file mode 100644
index 0000000..8a24c1f
--- /dev/null
+++ b/nemo-renderers/cli-renderer/src/main/resources/etc/opendaylight/karaf/config.xml
@@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+Copyright (c) 2015 Huawei, Inc and others. All rights reserved.
+This program and the accompanying materials are made available under the
+terms of the Eclipse Public License v1.0 which accompanies this distribution,
+and is available at http://www.eclipse.org/legal/epl-v10.html
+-->
+<snapshot>
+  <configuration>
+    <data xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
+      <modules xmlns="urn:opendaylight:params:xml:ns:yang:controller:config">
+        <module>
+          <type xmlns:prefix="urn:opendaylight:params:xml:ns:yang:nemo:cli:renderer:impl">prefix:cli-renderer-impl</type>
+          <name>cli-renderer-impl</name>
+          <data-broker>
+            <type xmlns:binding="urn:opendaylight:params:xml:ns:yang:controller:md:sal:binding">binding:binding-async-data-broker</type>
+            <name>binding-data-broker</name>
+          </data-broker>
+          <rpc-registry>
+            <type xmlns:binding="urn:opendaylight:params:xml:ns:yang:controller:md:sal:binding">binding:binding-rpc-registry</type>
+            <name>binding-rpc-broker</name>
+          </rpc-registry>
+          <notification-service>
+            <type xmlns:binding="urn:opendaylight:params:xml:ns:yang:controller:md:sal:binding">binding:binding-notification-service</type>
+            <name>binding-notification-broker</name>
+          </notification-service>
+        </module>
+      </modules>
+    </data>
+  </configuration>
+
+  <required-capabilities></required-capabilities>
+</snapshot>
\ No newline at end of file
diff --git a/nemo-renderers/cli-renderer/src/main/yang/cli-renderer-impl.yang b/nemo-renderers/cli-renderer/src/main/yang/cli-renderer-impl.yang
new file mode 100644
index 0000000..1599f97
--- /dev/null
+++ b/nemo-renderers/cli-renderer/src/main/yang/cli-renderer-impl.yang
@@ -0,0 +1,62 @@
+/*
+ * Copyright (c) 2015 Huawei, Inc. and others. All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
+
+module cli-renderer-impl {
+    yang-version 1;
+
+    namespace "urn:opendaylight:params:xml:ns:yang:nemo:cli:renderer:impl";
+    prefix "cli-renderer-impl";
+
+    import config { prefix config; revision-date 2013-04-05; }
+    import opendaylight-md-sal-binding { prefix mdsal; revision-date 2013-10-28; }
+
+    description
+        "This module contains the base YANG definitions for
+         NEMO CLI renderer implementation.";
+
+    revision "2015-11-19" {
+        description
+            "Initial revision.";
+    }
+
+    identity cli-renderer-impl {
+        base config:module-type;
+        config:java-name-prefix CliRenderer;
+    }
+
+    augment "/config:modules/config:module/config:configuration" {
+        case cli-renderer-impl {
+            when "/config:modules/config:module/config:type = 'cli-renderer-impl'";
+
+            container data-broker {
+                uses config:service-ref {
+                    refine type {
+                        mandatory false;
+                        config:required-identity mdsal:binding-async-data-broker;
+                    }
+                }
+            }
+            container rpc-registry {
+                uses config:service-ref {
+                    refine type {
+                        mandatory true;
+                        config:required-identity mdsal:binding-rpc-registry;
+                    }
+                }
+            }
+            container notification-service {
+                uses config:service-ref {
+                    refine type {
+                        mandatory true;
+                        config:required-identity mdsal:binding-notification-service;
+                    }
+                }
+            }
+        }
+    }
+}
diff --git a/nemo-renderers/cli-renderer/src/main/yang/cli-renderer.yang b/nemo-renderers/cli-renderer/src/main/yang/cli-renderer.yang
new file mode 100644
index 0000000..06b6918
--- /dev/null
+++ b/nemo-renderers/cli-renderer/src/main/yang/cli-renderer.yang
@@ -0,0 +1,22 @@
+/*
+ * Copyright (c) 2015 Huawei, Inc. and others. All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
+
+module cli-renderer {
+    yang-version 1;
+
+    namespace "urn:opendaylight:params:xml:ns:yang:nemo:cli:renderer";
+    prefix "cli-renderer";
+
+    description
+        "This module defines the NEMO CLI renderer model.";
+
+    revision "2015-11-19" {
+        description
+            "Initial revision.";
+    }
+}
diff --git a/nemo-renderers/pom.xml b/nemo-renderers/pom.xml
index 1024502..b5fd9cb 100644
--- a/nemo-renderers/pom.xml
+++ b/nemo-renderers/pom.xml
@@ -23,6 +23,7 @@ and is available at http://www.eclipse.org/legal/epl-v10.html
 
   <modules>
     <module>openflow-renderer</module>
+    <module>cli-renderer</module>
   </modules>
 
   <scm>
diff --git a/pom.xml b/pom.xml
index d898151..7d36a7e 100644
--- a/pom.xml
+++ b/pom.xml
@@ -31,10 +31,10 @@ and is available at http://www.eclipse.org/legal/epl-v10.html
     <module>nemo-artifacts</module>
     <module>nemo-api</module>
     <module>nemo-impl</module>
-    <module>nemo-renderers</module>
     <module>nemo-ui</module>
     <module>nemo-features</module>
     <module>nemo-karaf</module>
+    <module>nemo-renderers</module>
   </modules>
 
   <url>https://wiki.opendaylight.org/view/NEMO:Main</url>
-- 
2.36.6