Fix MVN build issues (#35)

1. Fix MVN build issue
Cause: Failed test case.
Fix: CRLF handling in XML transform is corrected to LF

2. Fix MVN package issue during rerun
Cause: lombok annotations were not resolved in test cases
Fix: lombok uses unnamed classes. So, the compiler flags are updated

- General code clean up
- Updated README.md for v2.1.1
- Updated .gitignore

Author: ydnath

.gitignore

@@ -19,4 +19,8 @@ libraries/
 gradlew
 gradlew.bat
 
-logs/
+logs/
+
+.DS_Store
+.factorypath
+settings.json

README.md

@@ -13,67 +13,87 @@ REQUIREMENTS
 ============
 
 [OpenJDK 8](http://openjdk.java.net/projects/jdk8/) or Java 8
+[Maven](https://maven.apache.org/download.cgi) if you want to build using `mvn` [Supported from v2.1.1].
 
 Releases
 ========
-Latest .jar file in release section contains netconf-java compiled from Java SE 8u65.
-If user wants to use some other java version, then download the source code and compile it with desired version.
+Releases contain source code only. Due to changing JDK licensing, jar files are not released.
+User may download the source code and compile it with desired JDK version.
+
+* Instructions to build
+  * Download Source Code for the required release
+  * Compile the code and build the jar using your chosen JDK version
+  * Use the jar file
+
+* Instructions to build using `mvn`
+  * Download Source Code for the required release
+  * Compile the code and build the jar using `mvn package`
+  * Use the jar file from (source to netconf-java)/netconf-java/target
+
+v2.1.1
+------
+
+* Fixed `mvn` build issues
 
 v2.0.0
 ------
+
 * Replaced the ssh library with [JSch](http://www.jcraft.com/jsch/)
-    * Adds support for new ssh crypto algorithms
-    * More modern ssh implementation
+  * Adds support for new ssh crypto algorithms
+  * More modern ssh implementation
 * Added support for importing and building the library with maven
 * Added FindBugs code testing to maven build
 
 This is a breaking change to the API. New Device objects are now created using a builder.
 Example:
-```
+
+```Java
 Device device = Device.builder().hostName("hostname")
     .userName("username")
     .password("password")
     .hostKeysFileName("hostKeysFileName")
-    .build();    
+    .build();
 ```
 
 SYNOPSIS
 ========
 
-    import java.io.IOException;
-    import javax.xml.parsers.ParserConfigurationException;
-    import net.juniper.netconf.NetconfException;
-    import org.xml.sax.SAXException;
-
-    import net.juniper.netconf.XML;
-    import net.juniper.netconf.Device;
-
-    public class ShowInterfaces {
-        public static void main(String args[]) throws NetconfException,
-                  ParserConfigurationException, SAXException, IOException {
-
-            //Create device
-            Device device = Device.builder()
-                                .hostName("hostname")
-                                .userName("username")
-                                .password("password")
-                                .hostKeysFileName("hostKeysFileName")
-                                .build(); 
-            device.connect();
-
-            //Send RPC and receive RPC Reply as XML
-            XML rpc_reply = device.executeRPC("get-interface-information");
-            /* OR
-             * device.executeRPC("<get-interface-information/>");
-             * OR
-             * device.executeRPC("<rpc><get-interface-information/></rpc>");
-             */
-
-            //Print the RPC-Reply and close the device.
-            System.out.println(rpc_reply);
-            device.close();
-        }
+```Java
+import java.io.IOException;
+import javax.xml.parsers.ParserConfigurationException;
+import net.juniper.netconf.NetconfException;
+import org.xml.sax.SAXException;
+
+import net.juniper.netconf.XML;
+import net.juniper.netconf.Device;
+
+public class ShowInterfaces {
+    public static void main(String args[]) throws NetconfException,
+                ParserConfigurationException, SAXException, IOException {
+
+        //Create device
+        Device device = Device.builder()
+                            .hostName("hostname")
+                            .userName("username")
+                            .password("password")
+                            .hostKeysFileName("hostKeysFileName")
+                            .build(); 
+        device.connect();
+
+        //Send RPC and receive RPC Reply as XML
+        XML rpc_reply = device.executeRPC("get-interface-information");
+        /* OR
+            * device.executeRPC("<get-interface-information/>");
+            * OR
+            * device.executeRPC("<rpc><get-interface-information/></rpc>");
+            */
+
+        //Print the RPC-Reply and close the device.
+        System.out.println(rpc_reply);
+        device.close();
     }
+}
+```
 
 LICENSE
 =======

pom.xml

@@ -7,7 +7,7 @@
 
     <groupId>net.juniper.netconf</groupId>
     <artifactId>netconf-java</artifactId>
-    <version>2.1</version>
+    <version>2.1.1</version>
     <packaging>jar</packaging>
 
     <properties>
@@ -29,9 +29,9 @@
 
     <developers>
         <developer>
-            <name>Juniper Staff</name>
+            <name>Juniper Networks</name>
             <email>[email protected]</email>
-            <organization>Juniper</organization>
+            <organization>Juniper Networks</organization>
             <organizationUrl>https://github.com/Juniper</organizationUrl>
         </developer>
     </developers>
@@ -81,11 +81,24 @@
                 <configuration>
                     <source>1.8</source>
                     <target>1.8</target>
+                    <compilerArgs>
+                        <arg>-J--add-opens=jdk.compiler/com.sun.tools.javac.code=ALL-UNNAMED</arg>
+                        <arg>-J--add-opens=jdk.compiler/com.sun.tools.javac.comp=ALL-UNNAMED</arg>
+                        <arg>-J--add-opens=jdk.compiler/com.sun.tools.javac.file=ALL-UNNAMED</arg>
+                        <arg>-J--add-opens=jdk.compiler/com.sun.tools.javac.main=ALL-UNNAMED</arg>
+                        <arg>-J--add-opens=jdk.compiler/com.sun.tools.javac.model=ALL-UNNAMED</arg>
+                        <arg>-J--add-opens=jdk.compiler/com.sun.tools.javac.parser=ALL-UNNAMED</arg>
+                        <arg>-J--add-opens=jdk.compiler/com.sun.tools.javac.processing=ALL-UNNAMED</arg>
+                        <arg>-J--add-opens=jdk.compiler/com.sun.tools.javac.tree=ALL-UNNAMED</arg>
+                        <arg>-J--add-opens=jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED</arg>
+                        <arg>-J--add-opens=jdk.compiler/com.sun.tools.javac.jvm=ALL-UNNAMED</arg>
+                    </compilerArgs>
                 </configuration>
             </plugin>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-source-plugin</artifactId>
+                <version>3.2.1</version>
                 <executions>
                     <execution>
                         <id>attach-sources</id>
@@ -98,13 +111,18 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-javadoc-plugin</artifactId>
+                <version>3.2.0</version>
                 <executions>
                     <execution>
                         <id>attach-javadocs</id>
                         <goals>
                             <goal>jar</goal>
                         </goals>
                         <configuration>
+                            <source>1.8</source>
+                            <additionalOptions>
+                                <additionalOption>-Xdoclint:none</additionalOption>
+                            </additionalOptions>
                             <stylesheet>java</stylesheet>
                             <bottom><![CDATA[Copyright 2018, <a href="https://www.juniper.net">Juniper Networks, Inc.<a>]]> </bottom>
                         </configuration>
@@ -158,7 +176,11 @@
             <artifactId>slf4j-log4j12</artifactId>
             <version>1.7.12</version>
         </dependency>
-
+        <dependency>
+            <groupId>xalan</groupId>
+            <artifactId>xalan</artifactId>
+            <version>2.7.1</version>
+        </dependency>
         <dependency>
             <groupId>org.hamcrest</groupId>
             <artifactId>hamcrest-all</artifactId>

src/main/java/net/juniper/netconf/XML.java

@@ -9,6 +9,7 @@
 package net.juniper.netconf;
 
 import com.google.common.base.Preconditions;
+import org.apache.xml.serializer.OutputPropertiesFactory;
 import org.w3c.dom.Document;
 import org.w3c.dom.Element;
 import org.w3c.dom.Node;
@@ -506,6 +507,7 @@ public String toString() {
             TransformerFactory transFactory = TransformerFactory.newInstance();
             Transformer transformer = transFactory.newTransformer();
             StringWriter buffer = new StringWriter();
+            transformer.setOutputProperty(OutputPropertiesFactory.S_KEY_LINE_SEPARATOR, "\n");
             transformer.setOutputProperty(OutputKeys.OMIT_XML_DECLARATION, "yes");
             transformer.setOutputProperty(OutputKeys.INDENT, "yes");
             transformer.setOutputProperty

src/test/java/net/juniper/netconf/NetconfSessionTest.java

@@ -1,6 +1,5 @@
 package net.juniper.netconf;
 
-
 import com.jcraft.jsch.Channel;
 import lombok.extern.slf4j.Slf4j;
 import org.junit.Before;
@@ -13,6 +12,7 @@
 import javax.xml.parsers.DocumentBuilderFactory;
 import javax.xml.parsers.ParserConfigurationException;
 import java.io.BufferedOutputStream;
+import java.io.ByteArrayOutputStream;
 import java.io.IOException;
 import java.io.PipedInputStream;
 import java.io.PipedOutputStream;
@@ -136,7 +136,7 @@ public void GIVEN_executeRPC_WHEN_lldpRequest_THEN_correctResponse() throws Exce
 
         Thread thread = new Thread(() -> {
             try {
-                outPipe.write("Go to HELL".getBytes());
+                outPipe.write(FAKE_RPC_REPLY.getBytes());
                 outPipe.write(DEVICE_PROMPT_BYTE);
                 outPipe.flush();
                 Thread.sleep(800);

src/test/java/net/juniper/netconf/TestHelper.java

@@ -1,18 +1,14 @@
 package net.juniper.netconf;
 
-import org.apache.commons.io.FileUtils;
-
 import java.io.File;
 import java.io.FileNotFoundException;
-import java.io.IOException;
 import java.net.URL;
 
 class TestHelper {
 
       static File getSampleFile(String fileName) throws FileNotFoundException {
         URL sampleFileUri = ClassLoader.getSystemClassLoader()
                 .getResource(fileName);
-        File sampleFile;
         if (sampleFileUri == null) {
             throw new FileNotFoundException(String.format("Could not find file %s", fileName));
         }