Implemented get-data

senderic · senderic · commit 15e840a3ff5e · 2021-11-01T15:56:46.000-07:00
- Per discussion on github, using Datastore enum: Juniper#54 (comment) - Using enum pass to function call too
diff --git a/Jenkinsfile b/Jenkinsfile
@@ -0,0 +1,107 @@
+import hudson.model.*
+
+pipeline {
+
+    agent any
+
+    options {
+        timestamps()
+        timeout(time: 1, unit: "HOURS")
+    }
+
+    environment {
+        TMPDIR = "target"
+        ARTIFACTID = readMavenPom().getArtifactId()
+        GROUPID = readMavenPom().getGroupId()
+        VERSION = readMavenPom().getVersion()
+        BRANCH = "${GIT_BRANCH}".replaceAll("/", "-")
+        MVN_OPTS = "--fail-at-end --threads 4"
+    }
+
+    tools {
+        maven "Maven 3.6.3"
+        jdk "OpenJDK 11 (Latest)"
+    }
+
+    stages {
+        stage("Initialize") {
+            steps {
+                chuckNorris()
+                echo sh(returnStdout: true, script: "env")
+                notifyBitbucket0()
+            }
+        }
+
+        stage("Build & Install") {
+            steps {
+                // sh "cat ~/.m2/settings.xml" // For checking the default settings to ensure my mvn-settings-di2e-jenkins.xml is set right for DI2E.
+                sh "mvn clean jacoco:prepare-agent install jacoco:report ${MVN_OPTS}"
+                jacoco()
+            }
+        }
+
+        stage("Scan") {
+            steps {
+                script {
+                    try {
+                        withSonarQubeDI2E()
+                    } catch (err) {
+                        echo "Error in sonarqube upload:"
+                        echo err.getMessage()
+                    }
+                }
+            }
+        }
+    }
+    post {
+        always {
+            junit "**/target/surefire-reports/*.xml"
+            archiveArtifacts artifacts: "**/target/*.jar",
+                             fingerprint: true
+            notifyBitbucket0()
+        }
+        success {
+            script {
+                nexusArtifactUploader0()
+            }
+        }
+    }
+}
+
+def withSonarQubeDI2E() {
+    withSonarQubeEnv('Sonarqube Di2e Server') {
+        script {
+            def sonarScanner = tool name: 'SonarQube Scanner', type: 'hudson.plugins.sonar.SonarRunnerInstallation'
+            // Sonarqube token 8d28335e817bb96f7dc2a1b3f56dcf1d2c03bb6a
+            sh "mvn sonar:sonar --activate-profiles sonarqube,site-reports -D sonar.branch.name=${BRANCH} -D sonar.projectKey=RMBN-NETCONF-Java ${MVN_OPTS}"
+        }
+    }
+}
+
+def nexusArtifactUploader0() {
+    nexusArtifactUploader artifacts: [
+            [artifactId: "${ARTIFACTID}", file: "pom.xml", type: "pom"],
+            [artifactId: "${ARTIFACTID}", file: "target/${ARTIFACTID}-${VERSION}.jar", type: "jar"],
+            [artifactId: "${ARTIFACTID}", classifier: "sources", file: "target/${ARTIFACTID}-${VERSION}-sources.jar", type: "jar"],
+            [artifactId: "${ARTIFACTID}", classifier: "javadoc", file: "target/${ARTIFACTID}-${VERSION}-javadoc.jar", type: "jar"]
+    ],
+            credentialsId: "687110ca-29bc-48c6-b35a-50b6040f1260",
+            groupId: "${GROUPID}",
+            nexusUrl: "nexus.di2e.net/nexus3",
+            nexusVersion: "nexus3",
+            protocol: "https",
+            repository: "Public_DI2E_Maven",
+            version: "${VERSION}"
+}
+
+def notifyBitbucket0() {
+    notifyBitbucket commitSha1: "${GIT_COMMIT}",
+            considerUnstableAsSuccess: false,
+            credentialsId: "b901ff19-3484-442d-bc11-f6b3f2be7d26",
+            disableInprogressNotification: false,
+            ignoreUnverifiedSSLPeer: false,
+            includeBuildNumberInKey: false,
+            prependParentProjectKey: false,
+            projectKey: "",
+            stashServerBaseUrl: "https://bitbucket.di2e.net"
+}
diff --git a/pom.xml b/pom.xml
@@ -7,7 +7,7 @@
 
     <groupId>net.juniper.netconf</groupId>
     <artifactId>netconf-java</artifactId>
-    <version>2.1.1.6-SNAPSHOT</version>
+    <version>2.1.1.6.7</version>
     <packaging>jar</packaging>
 
     <properties>
@@ -143,9 +143,89 @@
                     </execution>
                 </executions>
             </plugin>
+            <plugin>
+                <groupId>org.sonarsource.scanner.maven</groupId>
+                <artifactId>sonar-maven-plugin</artifactId>
+                <version>3.7.0.1746</version>
+            </plugin>
+            <plugin>
+                <groupId>org.jacoco</groupId>
+                <artifactId>jacoco-maven-plugin</artifactId>
+                <version>0.8.7</version>
+                <executions>
+                    <execution>
+                        <goals>
+                            <goal>prepare-agent</goal>
+                        </goals>
+                    </execution>
+                    <execution>
+                        <id>report</id>
+                        <phase>prepare-package</phase>
+                        <goals>
+                            <goal>report</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+            <plugin>
+                <groupId>pl.project13.maven</groupId>
+                <artifactId>git-commit-id-plugin</artifactId>
+                <version>4.0.3</version>
+                <executions>
+                    <execution>
+                        <id>get-the-git-infos</id>
+                        <goals>
+                            <goal>revision</goal>
+                        </goals>
+                        <phase>initialize</phase>
+                    </execution>
+                </executions>
+                <configuration>
+                    <generateGitPropertiesFile>true</generateGitPropertiesFile>
+                    <generateGitPropertiesFilename>${project.build.outputDirectory}/git.properties</generateGitPropertiesFilename>
+                    <includeOnlyProperties>
+                        <includeOnlyProperty>^git.build.(time|version)$</includeOnlyProperty>
+                        <includeOnlyProperty>^git.branch$</includeOnlyProperty>
+                        <includeOnlyProperty>^git.remote.origin.url$</includeOnlyProperty>
+                        <IncludeOnlyProperty>^git.commit.time$</IncludeOnlyProperty>
+                        <includeOnlyProperty>^git.commit.message.(short|full)$</includeOnlyProperty>
+                        <includeOnlyProperty>^git.commit.user.(name|email)$</includeOnlyProperty>
+                        <includeOnlyProperty>^git.tags$</includeOnlyProperty>
+                        <includeOnlyProperty>^git.commit.id.(abbrev|full)$</includeOnlyProperty>
+                    </includeOnlyProperties>
+                    <verbose>true</verbose> <!-- Also using maven-antrun to output info so it appears after install -->
+                    <commitIdGenerationMode>full</commitIdGenerationMode>
+                    <injectAllReactorProjects>true</injectAllReactorProjects>
+                </configuration>
+            </plugin>
         </plugins>
     </build>
 
+    <profiles>
+        <profile>
+            <id>sonarqube</id>
+            <properties>
+                <!--suppress UnresolvedMavenProperty -->
+                <sonar.host.url>${sonar.server.host.url}</sonar.host.url>
+                <!--suppress UnresolvedMavenProperty -->
+                <sonar.login>${sonar.server.login}</sonar.login>
+            </properties>
+        </profile>
+        <profile>
+            <id>site-reports</id>
+            <activation>
+                <property>
+                    <name>testmode</name>
+                    <value>all</value>
+                </property>
+            </activation>
+            <properties>
+                <exclude.tests>org.junit.Ignore</exclude.tests>
+                <ignoreFailtest>true</ignoreFailtest>
+            </properties>
+        </profile>
+    </profiles>
+
     <reporting>
         <plugins>
             <plugin>
diff --git a/src/it/java/net/juniper/netconf/IntegrationTest.java b/src/it/java/net/juniper/netconf/IntegrationTest.java
@@ -0,0 +1,4 @@
+package net.juniper.netconf;
+
+public interface IntegrationTest {
+}
diff --git a/src/it/java/net/juniper/netconf/NetconfSessionIT.java b/src/it/java/net/juniper/netconf/NetconfSessionIT.java
@@ -0,0 +1,29 @@
+package net.juniper.netconf;
+
+import lombok.extern.slf4j.Slf4j;
+import org.junit.Test;
+import org.junit.experimental.categories.Category;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+@Slf4j
+@Category(IntegrationTest.class)
+public class NetconfSessionIT {
+
+    @Test //Expectation is no exception thrown.
+    public void testNetconfSessionWithKey() throws Exception {
+        try (Device device = Device.builder()
+                .hostName("localhost")
+                .userName(System.getProperty("user.name"))
+                .keyBasedAuthentication(true)
+                .pemKeyFile("/home/vagrant/.ssh/netconf_rsa")
+                .strictHostKeyChecking(false)
+                .build()) {
+            device.connect();
+            XML xml = device.getRunningConfig();
+            assertThat(xml).isNotNull();
+            assertThat(String.valueOf(xml).trim()).isNotBlank();
+            log.debug("XML:\n{}", xml);
+        }
+    }
+}
diff --git a/src/main/java/net/juniper/netconf/Device.java b/src/main/java/net/juniper/netconf/Device.java
@@ -17,6 +17,7 @@
 import lombok.NonNull;
 import lombok.ToString;
 import lombok.extern.slf4j.Slf4j;
+import net.juniper.netconf.element.Datastore;
 import net.juniper.netconf.element.Hello;
 import org.w3c.dom.Document;
 import org.xml.sax.SAXException;
@@ -838,14 +839,41 @@ public XML getRunningConfig(String configTree) throws SAXException,
         return this.netconfSession.getRunningConfig(configTree);
     }
 
-    public XML getRunningConfigAndState(String filter) throws IOException, SAXException {
+    /**
+     * Retrieve the running configuration, or part of the configuration.
+     *
+     * @param xpathFilter example <code><filter xmlns:model='urn:path:for:my:model' select='/model:*'></filter></code>
+     * @return configuration data as XML object.
+     * @throws java.io.IOException      If there are errors communicating with the netconf server.
+     * @throws org.xml.sax.SAXException If there are errors parsing the XML reply.
+     */
+    public XML getRunningConfigAndState(String xpathFilter) throws IOException, SAXException {
         if (netconfSession == null) {
             throw new IllegalStateException("Cannot execute RPC, you need to " +
                     "establish a connection first.");
         }
-        return this.netconfSession.getRunningConfigAndState(filter);
+        return this.netconfSession.getRunningConfigAndState(xpathFilter);
     }
 
+
+    /**
+     * Run the <get-data> call to netconf server and retrieve data as an XML.
+     *
+     * @param xpathFilter example <code><filter xmlns:model='urn:path:for:my:model' select='/model:*'></filter></code>
+     * @param datastore running, startup, candidate, or operational
+     * @return configuration data as XML object.
+     * @throws java.io.IOException      If there are errors communicating with the netconf server.
+     * @throws org.xml.sax.SAXException If there are errors parsing the XML reply.
+     */
+    public XML getData(String xpathFilter, @NonNull Datastore datastore) throws IOException, SAXException {
+        if (netconfSession == null) {
+            throw new IllegalStateException("Cannot execute RPC, you need to " +
+                    "establish a connection first.");
+        }
+       return this.netconfSession.getData(xpathFilter, datastore);
+    }
+
+
     /**
      * Retrieve the whole candidate configuration.
      *
diff --git a/src/main/java/net/juniper/netconf/NetconfSession.java b/src/main/java/net/juniper/netconf/NetconfSession.java
@@ -14,6 +14,7 @@
 import com.jcraft.jsch.JSchException;
 import lombok.NonNull;
 import lombok.extern.slf4j.Slf4j;
+import net.juniper.netconf.element.Datastore;
 import net.juniper.netconf.element.Hello;
 import net.juniper.netconf.element.RpcReply;
 import org.w3c.dom.Document;
@@ -159,6 +160,8 @@ private void sendRpcRequest(String rpc) throws IOException {
         // RFC conformance for XML type, namespaces and message ids for RPCs
         messageId++;
         rpc = rpc.replace("<rpc>", "<rpc" + getRpcAttributes() + " message-id=\"" + messageId + "\">").trim();
+        rpc = rpc.replace("<datastore>", "<datastore xmlns:ds=\"urn:ietf:params:xml:ns:yang:ietf-datastores\">");
+        rpc = rpc.replace("<get-data>", "<get-data xmlns=\"urn:ietf:params:xml:ns:yang:ietf-netconf-nmda\">");
         if (!rpc.contains(NetconfConstants.XML_VERSION)) {
             rpc = NetconfConstants.XML_VERSION + rpc;
         }
@@ -301,17 +304,31 @@ private String getConfig(String configTree) throws IOException {
         return lastRpcReply;
     }
 
-    public XML getRunningConfigAndState(String filter) throws IOException, SAXException {
+    public XML getRunningConfigAndState(String xpathFilter) throws IOException, SAXException {
         String rpc = "<rpc>" +
                 "<get>" +
-                (filter == null ? "" : filter) +
+                (xpathFilter == null ? "" : xpathFilter) +
                 "</get>" +
                 "</rpc>" +
                 NetconfConstants.DEVICE_PROMPT;
         setLastRpcReply(getRpcReply(rpc));
         return convertToXML(lastRpcReply);
     }
 
+    public XML getData(String xpathFilter, @NonNull Datastore datastore)
+            throws IOException, SAXException {
+
+        String rpc = "<rpc>" +
+                "<get-data>" +
+                "<datastore>ds:" + datastore.getTag() + "</datastore>" +
+                (xpathFilter == null ? "" : xpathFilter) +
+                "</get-data>" +
+                "</rpc>" +
+                NetconfConstants.DEVICE_PROMPT;
+        lastRpcReply = getRpcReply(rpc);
+        return convertToXML(lastRpcReply);
+    }
+
     private String getConfig(String target, String configTree)
             throws IOException {
 
diff --git a/src/main/java/net/juniper/netconf/element/Datastore.java b/src/main/java/net/juniper/netconf/element/Datastore.java
@@ -0,0 +1,24 @@
+package net.juniper.netconf.element;
+
+import lombok.Getter;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+
+/**
+ * Datastore
+ * <p>
+ * As defined by RFC-8342.
+ * See https://datatracker.ietf.org/doc/html/rfc8342#section-5
+ */
+@Slf4j
+@Getter
+@RequiredArgsConstructor
+public enum Datastore {
+    RUNNING("running"),
+    CANDIDATE("candidate"),
+    STARTUP("startup"),
+    INTENDED("intended"),
+    OPERATIONAL("operational");
+
+    public final String tag;
+}

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +package net.juniper.netconf;
++
 +public interface IntegrationTest {
 +}