Update documentation file & sonar plugin 15/31615/1
authorSripad <sg481n@att.com>
Tue, 13 Feb 2018 16:53:35 +0000 (16:53 +0000)
committerSripad <sg481n@att.com>
Tue, 13 Feb 2018 16:53:41 +0000 (16:53 +0000)
Issue-ID: DMAAP-109
Change-Id: Ifb68600de75622791eba4fb3e9b472b39850afec
Signed-off-by: Sai Gandham <sg481n@att.com>
datarouter-node/pom.xml
datarouter-prov/pom.xml
docs/index.rst
pom.xml

index d8c2be3..1db177f 100644 (file)
                <maven.compiler.source>1.8</maven.compiler.source>\r
                <maven.compiler.target>1.8</maven.compiler.target>\r
                <dockerLocation>${basedir}/target/</dockerLocation>\r
+               <sonar.language>java</sonar.language>\r
+                       <sonar.skip>false</sonar.skip>\r
+               <sonar.java.coveragePlugin>jacoco</sonar.java.coveragePlugin>\r
+               <sonar.surefire.reportsPath>${project.build.directory}/surefire-reports</sonar.surefire.reportsPath>\r
+               <sonar.jacoco.reportPath>${project.build.directory}/coverage-reports/jacoco.exec</sonar.jacoco.reportPath>\r
+               <sonar.jacoco.itReportPath>${project.build.directory}/coverage-reports/jacoco-it.exec</sonar.jacoco.itReportPath>\r
+               <sonar.jacoco.reportMissing.force.zero>true</sonar.jacoco.reportMissing.force.zero>\r
+               <sonar.projectVersion>${project.version}</sonar.projectVersion>\r
                <nexusproxy>https://nexus.onap.org</nexusproxy>\r
                <snapshotNexusPath>/content/repositories/snapshots/</snapshotNexusPath>\r
                <releaseNexusPath>/content/repositories/releases/</releaseNexusPath>\r
                                  </formats>\r
                                </configuration>\r
                        </plugin>\r
+<plugin>\r
+                               <groupId>org.sonatype.plugins</groupId>\r
+                               <artifactId>nexus-staging-maven-plugin</artifactId>\r
+                               <version>1.6.7</version>\r
+                               <extensions>true</extensions>\r
+                               <configuration>\r
+                                       <nexusUrl>${nexusproxy}</nexusUrl>\r
+                                       <stagingProfileId>176c31dfe190a</stagingProfileId>\r
+                                       <serverId>ecomp-staging</serverId>\r
+                               </configuration>\r
+                       </plugin>\r
+                       \r
+                       <plugin>\r
+          <groupId>org.jacoco</groupId>\r
+          <artifactId>jacoco-maven-plugin</artifactId>\r
+          <version>${jacoco.version}</version>\r
+          <configuration>\r
+            <excludes>\r
+              <exclude>**/gen/**</exclude>\r
+              <exclude>**/generated-sources/**</exclude>\r
+              <exclude>**/yang-gen/**</exclude>\r
+              <exclude>**/pax/**</exclude>\r
+            </excludes>\r
+          </configuration>\r
+          <executions>\r
+\r
+            <execution>\r
+              <id>pre-unit-test</id>\r
+              <goals>\r
+                <goal>prepare-agent</goal>\r
+              </goals>\r
+              <configuration>\r
+                <destFile>${project.build.directory}/code-coverage/jacoco-ut.exec</destFile>\r
+                <propertyName>surefireArgLine</propertyName>\r
+              </configuration>\r
+            </execution>\r
+            \r
+       \r
+            <execution>\r
+              <id>post-unit-test</id>\r
+              <phase>test</phase>\r
+              <goals>\r
+                <goal>report</goal>\r
+              </goals>\r
+              <configuration>\r
+                <dataFile>${project.build.directory}/code-coverage/jacoco-ut.exec</dataFile>\r
+                <outputDirectory>${project.reporting.outputDirectory}/jacoco-ut</outputDirectory>\r
+              </configuration>\r
+            </execution>\r
+            <execution>\r
+              <id>pre-integration-test</id>\r
+              <phase>pre-integration-test</phase>\r
+              <goals>\r
+                <goal>prepare-agent</goal>\r
+              </goals>\r
+              <configuration>\r
+                <destFile>${project.build.directory}/code-coverage/jacoco-it.exec</destFile>\r
+\r
+                <propertyName>failsafeArgLine</propertyName>\r
+              </configuration>\r
+            </execution>\r
 \r
+       \r
+            <execution>\r
+              <id>post-integration-test</id>\r
+              <phase>post-integration-test</phase>\r
+              <goals>\r
+                <goal>report</goal>\r
+              </goals>\r
+              <configuration>\r
+                <dataFile>${project.build.directory}/code-coverage/jacoco-it.exec</dataFile>\r
+                <outputDirectory>${project.reporting.outputDirectory}/jacoco-it</outputDirectory>\r
+              </configuration>\r
+            </execution>\r
+          </executions>\r
+        </plugin>\r
                </plugins>\r
        </build>\r
 <distributionManagement>\r
                <repository>\r
                        <id>ecomp-releases</id>\r
-                       <name>AAF Release Repository</name>\r
+                       <name>DR Release Repository</name>\r
                        <url>${nexusproxy}${releaseNexusPath}</url>\r
                </repository>\r
                <snapshotRepository>\r
                        <id>ecomp-snapshots</id>\r
-                       <name>AAF Snapshot Repository</name>\r
+                       <name>DR Snapshot Repository</name>\r
                        <url>${nexusproxy}${snapshotNexusPath}</url>\r
                </snapshotRepository>\r
                <site>\r
             <url>https://nexus.onap.org/content/repositories/snapshots/</url>\r
         </pluginRepository>\r
     </pluginRepositories>\r
-       <repositories>\r
-               <repository>\r
-                       <id>central</id>\r
-                       <name>Maven 2 repository 2</name>\r
-                       <url>http://repo2.maven.org/maven2/</url>\r
-               </repository>\r
-               <repository>\r
-            <id>onap-jar-snapshots</id>\r
-            <url>https://nexus.onap.org/content/repositories/snapshots</url>\r
-        </repository>\r
-               <repository>\r
-                       <id>spring-repo</id>\r
-                       <name>Spring repo</name>\r
-                       <url>https://artifacts.alfresco.com/nexus/content/repositories/public/</url>\r
-               </repository>\r
-               <repository>\r
-                       <id>repository.jboss.org-public</id>\r
-                       <name>JBoss.org Maven repository</name>\r
-                       <url>https://repository.jboss.org/nexus/content/groups/public</url>\r
-               </repository>\r
-       </repositories>\r
        \r
 \r
        \r
index 2f574f1..a9e7e67 100644 (file)
                <maven.compiler.source>1.8</maven.compiler.source>\r
                <maven.compiler.target>1.8</maven.compiler.target>\r
                <dockerLocation>${basedir}/target/</dockerLocation>\r
+               <sonar.language>java</sonar.language>\r
+                       <sonar.skip>false</sonar.skip>\r
+               <sonar.java.coveragePlugin>jacoco</sonar.java.coveragePlugin>\r
+               <sonar.surefire.reportsPath>${project.build.directory}/surefire-reports</sonar.surefire.reportsPath>\r
+               <sonar.jacoco.reportPath>${project.build.directory}/coverage-reports/jacoco.exec</sonar.jacoco.reportPath>\r
+               <sonar.jacoco.itReportPath>${project.build.directory}/coverage-reports/jacoco-it.exec</sonar.jacoco.itReportPath>\r
+               <sonar.jacoco.reportMissing.force.zero>true</sonar.jacoco.reportMissing.force.zero>\r
+               <sonar.projectVersion>${project.version}</sonar.projectVersion>\r
                <nexusproxy>https://nexus.onap.org</nexusproxy>\r
                <snapshotNexusPath>/content/repositories/snapshots/</snapshotNexusPath>\r
                <releaseNexusPath>/content/repositories/releases/</releaseNexusPath>\r
                                  </formats>\r
                                </configuration>\r
                        </plugin>\r
+                       \r
+                       \r
+               <plugin>\r
+                               <groupId>org.sonatype.plugins</groupId>\r
+                               <artifactId>nexus-staging-maven-plugin</artifactId>\r
+                               <version>1.6.7</version>\r
+                               <extensions>true</extensions>\r
+                               <configuration>\r
+                                       <nexusUrl>${nexusproxy}</nexusUrl>\r
+                                       <stagingProfileId>176c31dfe190a</stagingProfileId>\r
+                                       <serverId>ecomp-staging</serverId>\r
+                               </configuration>\r
+                       </plugin>\r
+                       \r
+                       <plugin>\r
+          <groupId>org.jacoco</groupId>\r
+          <artifactId>jacoco-maven-plugin</artifactId>\r
+          <version>${jacoco.version}</version>\r
+          <configuration>\r
+            <excludes>\r
+              <exclude>**/gen/**</exclude>\r
+              <exclude>**/generated-sources/**</exclude>\r
+              <exclude>**/yang-gen/**</exclude>\r
+              <exclude>**/pax/**</exclude>\r
+            </excludes>\r
+          </configuration>\r
+          <executions>\r
+\r
+            <execution>\r
+              <id>pre-unit-test</id>\r
+              <goals>\r
+                <goal>prepare-agent</goal>\r
+              </goals>\r
+              <configuration>\r
+                <destFile>${project.build.directory}/code-coverage/jacoco-ut.exec</destFile>\r
+                <propertyName>surefireArgLine</propertyName>\r
+              </configuration>\r
+            </execution>\r
+            \r
+       \r
+            <execution>\r
+              <id>post-unit-test</id>\r
+              <phase>test</phase>\r
+              <goals>\r
+                <goal>report</goal>\r
+              </goals>\r
+              <configuration>\r
+                <dataFile>${project.build.directory}/code-coverage/jacoco-ut.exec</dataFile>\r
+                <outputDirectory>${project.reporting.outputDirectory}/jacoco-ut</outputDirectory>\r
+              </configuration>\r
+            </execution>\r
+            <execution>\r
+              <id>pre-integration-test</id>\r
+              <phase>pre-integration-test</phase>\r
+              <goals>\r
+                <goal>prepare-agent</goal>\r
+              </goals>\r
+              <configuration>\r
+                <destFile>${project.build.directory}/code-coverage/jacoco-it.exec</destFile>\r
+\r
+                <propertyName>failsafeArgLine</propertyName>\r
+              </configuration>\r
+            </execution>\r
+\r
+       \r
+            <execution>\r
+              <id>post-integration-test</id>\r
+              <phase>post-integration-test</phase>\r
+              <goals>\r
+                <goal>report</goal>\r
+              </goals>\r
+              <configuration>\r
+                <dataFile>${project.build.directory}/code-coverage/jacoco-it.exec</dataFile>\r
+                <outputDirectory>${project.reporting.outputDirectory}/jacoco-it</outputDirectory>\r
+              </configuration>\r
+            </execution>\r
+          </executions>\r
+        </plugin>      \r
                </plugins>\r
        </build>\r
 <distributionManagement>\r
                <repository>\r
                        <id>ecomp-releases</id>\r
-                       <name>AAF Release Repository</name>\r
+                       <name>DR Release Repository</name>\r
                        <url>${nexusproxy}${releaseNexusPath}</url>\r
                </repository>\r
                <snapshotRepository>\r
                        <id>ecomp-snapshots</id>\r
-                       <name>AAF Snapshot Repository</name>\r
+                       <name>DR Snapshot Repository</name>\r
                        <url>${nexusproxy}${snapshotNexusPath}</url>\r
                </snapshotRepository>\r
                <site>\r
         </pluginRepository>\r
     </pluginRepositories>\r
 \r
-       <repositories>\r
-               <repository>\r
-                       <id>central</id>\r
-                       <name>Maven 2 repository 2</name>\r
-                       <url>http://repo2.maven.org/maven2/</url>\r
-               </repository>\r
-               <repository>\r
-            <id>onap-jar-snapshots</id>\r
-            <url>https://nexus.onap.org/content/repositories/snapshots</url>\r
-        </repository>\r
-               <repository>\r
-                       <id>spring-repo</id>\r
-                       <name>Spring repo</name>\r
-                       <url>https://artifacts.alfresco.com/nexus/content/repositories/public/</url>\r
-               </repository>\r
-               <repository>\r
-                       <id>repository.jboss.org-public</id>\r
-                       <name>JBoss.org Maven repository</name>\r
-                       <url>https://repository.jboss.org/nexus/content/groups/public</url>\r
-               </repository>\r
-       </repositories>\r
        \r
 </project>\r
index 77b53fb..f7dae49 100644 (file)
@@ -2,13 +2,26 @@
 .. http://creativecommons.org/licenses/by/4.0\r
 .. Copyright © 2017 AT&T Intellectual Property. All rights reserved.\r
 \r
-Message Router (MR)\r
-====================\r
+============================================\r
+Data Router (DR) API Guide\r
+============================================\r
+Introduction\r
+------------------\r
+\r
+The DataRouter(DR)provisioning API is an HTTPS-based,REST-like API for creating and managing DR feeds and subscriptions. The Data Routing System project is intended to provide a common framework by which data producers can make data available to data consumers and a way for potential consumers to find feeds with the data they require.\r
+\r
+\r
+HTTP Service APIs\r
+------------------\r
+\r
+DMaaP Message Router utilizes an HTTP REST API to service all transactions. HTTP and REST standards are followed so\r
+clients as varied as CURL, Java applications and even Web Browsers will\r
+work to interact with the Data Router.\r
 \r
 \r
 \r
 .. toctree::\r
-   :maxdepth: 2\r
+   :maxdepth: 3\r
    \r
    data-router/data-router\r
 \r
diff --git a/pom.xml b/pom.xml
index d655282..edb9754 100644 (file)
--- a/pom.xml
+++ b/pom.xml
   <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>\r
                <maven.compiler.source>1.8</maven.compiler.source>\r
                <maven.compiler.target>1.8</maven.compiler.target>\r
+               <sonar.language>java</sonar.language>\r
+                       <sonar.skip>false</sonar.skip>\r
+               <sonar.java.coveragePlugin>jacoco</sonar.java.coveragePlugin>\r
+               <sonar.surefire.reportsPath>${project.build.directory}/surefire-reports</sonar.surefire.reportsPath>\r
+               <sonar.jacoco.reportPath>${project.build.directory}/coverage-reports/jacoco.exec</sonar.jacoco.reportPath>\r
+               <sonar.jacoco.itReportPath>${project.build.directory}/coverage-reports/jacoco-it.exec</sonar.jacoco.itReportPath>\r
+               <sonar.jacoco.reportMissing.force.zero>true</sonar.jacoco.reportMissing.force.zero>\r
+               <sonar.projectVersion>${project.version}</sonar.projectVersion>\r
                <nexusproxy>https://nexus.onap.org</nexusproxy>\r
                <snapshotNexusPath>/content/repositories/snapshots/</snapshotNexusPath>\r
                <releaseNexusPath>/content/repositories/releases/</releaseNexusPath>\r
                                <serverId>ecomp-staging</serverId>\r
                        </configuration>\r
        </plugin>\r
+       \r
+       <plugin>\r
+                               <groupId>org.sonatype.plugins</groupId>\r
+                               <artifactId>nexus-staging-maven-plugin</artifactId>\r
+                               <version>1.6.7</version>\r
+                               <extensions>true</extensions>\r
+                               <configuration>\r
+                                       <nexusUrl>${nexusproxy}</nexusUrl>\r
+                                       <stagingProfileId>176c31dfe190a</stagingProfileId>\r
+                                       <serverId>ecomp-staging</serverId>\r
+                               </configuration>\r
+                       </plugin>\r
+                       \r
+                       <plugin>\r
+          <groupId>org.jacoco</groupId>\r
+          <artifactId>jacoco-maven-plugin</artifactId>\r
+          <version>${jacoco.version}</version>\r
+          <configuration>\r
+            <excludes>\r
+              <exclude>**/gen/**</exclude>\r
+              <exclude>**/generated-sources/**</exclude>\r
+              <exclude>**/yang-gen/**</exclude>\r
+              <exclude>**/pax/**</exclude>\r
+            </excludes>\r
+          </configuration>\r
+          <executions>\r
+\r
+            <execution>\r
+              <id>pre-unit-test</id>\r
+              <goals>\r
+                <goal>prepare-agent</goal>\r
+              </goals>\r
+              <configuration>\r
+                <destFile>${project.build.directory}/code-coverage/jacoco-ut.exec</destFile>\r
+                <propertyName>surefireArgLine</propertyName>\r
+              </configuration>\r
+            </execution>\r
+            \r
+       \r
+            <execution>\r
+              <id>post-unit-test</id>\r
+              <phase>test</phase>\r
+              <goals>\r
+                <goal>report</goal>\r
+              </goals>\r
+              <configuration>\r
+                <dataFile>${project.build.directory}/code-coverage/jacoco-ut.exec</dataFile>\r
+                <outputDirectory>${project.reporting.outputDirectory}/jacoco-ut</outputDirectory>\r
+              </configuration>\r
+            </execution>\r
+            <execution>\r
+              <id>pre-integration-test</id>\r
+              <phase>pre-integration-test</phase>\r
+              <goals>\r
+                <goal>prepare-agent</goal>\r
+              </goals>\r
+              <configuration>\r
+                <destFile>${project.build.directory}/code-coverage/jacoco-it.exec</destFile>\r
+\r
+                <propertyName>failsafeArgLine</propertyName>\r
+              </configuration>\r
+            </execution>\r
+\r
+       \r
+            <execution>\r
+              <id>post-integration-test</id>\r
+              <phase>post-integration-test</phase>\r
+              <goals>\r
+                <goal>report</goal>\r
+              </goals>\r
+              <configuration>\r
+                <dataFile>${project.build.directory}/code-coverage/jacoco-it.exec</dataFile>\r
+                <outputDirectory>${project.reporting.outputDirectory}/jacoco-it</outputDirectory>\r
+              </configuration>\r
+            </execution>\r
+          </executions>\r
+        </plugin>\r
        </plugins>\r
   </build>\r
  <distributionManagement>\r
                <repository>\r
                        <id>ecomp-releases</id>\r
-                       <name>AAF Release Repository</name>\r
+                       <name>DR Release Repository</name>\r
                        <url>${nexusproxy}${releaseNexusPath}</url>\r
                </repository>\r
                <snapshotRepository>\r
                        <id>ecomp-snapshots</id>\r
-                       <name>AAF Snapshot Repository</name>\r
+                       <name>DR Snapshot Repository</name>\r
                        <url>${nexusproxy}${snapshotNexusPath}</url>\r
                </snapshotRepository>\r
                <site>\r
             <url>https://nexus.onap.org/content/repositories/snapshots/</url>\r
         </pluginRepository>\r
     </pluginRepositories>\r
-       \r
-<repositories>\r
-               <repository>\r
-                       <id>central</id>\r
-                       <name>Maven 2 repository 2</name>\r
-                       <url>http://repo2.maven.org/maven2/</url>\r
-               </repository>\r
-               <repository>\r
-            <id>onap-jar-snapshots</id>\r
-            <url>https://nexus.onap.org/content/repositories/snapshots</url>\r
-        </repository>\r
-               <repository>\r
-                       <id>spring-repo</id>\r
-                       <name>Spring repo</name>\r
-                       <url>https://artifacts.alfresco.com/nexus/content/repositories/public/</url>\r
-               </repository>\r
-               <repository>\r
-                       <id>repository.jboss.org-public</id>\r
-                       <name>JBoss.org Maven repository</name>\r
-                       <url>https://repository.jboss.org/nexus/content/groups/public</url>\r
-               </repository>\r
-       </repositories>  \r
+  \r
 </project>\r