Release 1.0.3

Author: predix-adoption-bot

README.md

@@ -1,7 +1,7 @@
-<a href="../../../../pages/adoption/audit-sdk/javadocs/index.html" target="_blank" >
+<a href="../../../../pages/adoption/audit-sdk/javadocs/index.html" target="\_blank" >
 	<img height="50px" width="100px" src="images/javadoc.png" alt="view javadoc"></a>
-&nbsp;
-<a href="../../../../pages/adoption/audit-sdk" target="_blank">
+
+<a href="../../../../pages/adoption/audit-sdk" target="\_blank">
 	<img height="50px" width="100px" src="images/pages.jpg" alt="view github pages">
 </a>
 
@@ -19,7 +19,7 @@ Use the SDK to publish audit messages using the Audit client.
     <dependency>
       <groupId>com.ge.predix</groupId>
       <artifactId>audit-sdk</artifactId>
-      <version>1.0.0</version>
+      <version>1.0.1</version>
     </dependency>
 ```
 
@@ -175,7 +175,7 @@ Here is an example:
 #### Additional API
 
 ##### Reconnect option
- Occasionally, audit client can be disconnected. In such a case, you receive an ```onFailure``` callback with ```FailReport.STREAM_IS_CLOSE``` 
+ Occasionally, audit client can be disconnected. In such a case, you receive an ```onFailure``` callback with ```FailReport.STREAM_IS_CLOSE```
  **This notification is currently available only for ASYNC mode**.
 
  There are two ways to handle reconnection:
@@ -192,10 +192,10 @@ AuditConfiguration.builder()
 The sdk supports two modes of authentication:
  - Using a UAA user and pass. Use the `AuditConfiguration.builder()` to obtain a regular, UAA based configuration.
  - Using an authentication token. Use the `AuditConfiguration.builderWithAuthToken()` to obtain an auth token based configuration.
- 
+
  Once a client was created, its authentication mode cannot be changed.
  When working with authentication token, you might need to refresh the token. This can be achieved by running the `auditClient.setAuthToken(token)` API.
- 
+
  Please note that this API throws IllegalStateException if executed on a client configured with UAA authentication mode.
 
 ----
@@ -221,12 +221,11 @@ AuditConfiguration.builder()
 If APPLICATION_NAME variable was set in the environment, it will be added to each message and there is no need to explicitly provide it when building the message.
 
 #### For more information about the api: https://docs.predix.io/en-US/content/service/security/audit/using-predix-audit-service
-   
+
 ----
-# Example Projects: 
+# Example Projects:
 - https://github.com/PredixDev/samplePublisherApp
 - https://github.com/PredixDev/samplePub-POJO
 
 
 [![Analytics](https://ga-beacon.appspot.com/UA-82773213-1/audit-sdk/readme?pixel)](https://github.com/PredixDev)
-

pom.xml

@@ -1,10 +1,11 @@
+
 <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>
 
     <groupId>com.ge.predix.audit</groupId>
     <artifactId>audit-sdk</artifactId>
-    <version>1.0.0</version>
+    <version>1.0.3</version>
     <packaging>jar</packaging>
 
     <name>audit-sdk</name>
@@ -15,8 +16,21 @@
         <maven.compiler.source>1.8</maven.compiler.source>
         <maven.compiler.target>1.8</maven.compiler.target>
         <powermock.version>1.7.1</powermock.version>
+        <jackson.version>2.9.4</jackson.version>
+        <eventhub.sdk.version>1.2.11</eventhub.sdk.version>
     </properties>
     <dependencies>
+        <dependency>
+            <groupId>org.projectlombok</groupId>
+            <artifactId>lombok</artifactId>
+            <version>1.18.0</version>
+            <scope>provided</scope>
+        </dependency>
+        <dependency>
+            <groupId>commons-logging</groupId>
+            <artifactId>commons-logging</artifactId>
+            <version>1.2</version>
+        </dependency>
         <dependency>
             <groupId>javax.validation</groupId>
             <artifactId>validation-api</artifactId>
@@ -30,19 +44,40 @@
         <dependency>
             <groupId>com.ge.predix.eventhub</groupId>
             <artifactId>predix-event-hub-sdk</artifactId>
-            <version>1.2.11</version>
+            <version>${eventhub.sdk.version}</version>
             <exclusions>
                 <exclusion>
                     <groupId>org.apache.httpcomponents</groupId>
                     <artifactId>httpclient</artifactId>
                 </exclusion>
+                <exclusion>
+                    <groupId>com.fasterxml.jackson.core</groupId>
+                    <artifactId>jackson-core</artifactId>
+                </exclusion>
+                <exclusion>
+                    <groupId>com.fasterxml.jackson.core</groupId>
+                    <artifactId>jackson-databind</artifactId>
+                </exclusion>
+                <exclusion>
+                    <groupId>com.fasterxml.jackson.core</groupId>
+                    <artifactId>jackson-annotations</artifactId>
+                </exclusion>
             </exclusions>
         </dependency>
         <dependency>
-            <groupId>org.projectlombok</groupId>
-            <artifactId>lombok</artifactId>
-            <version>1.16.10</version>
-            <scope>provided</scope>
+            <groupId>com.fasterxml.jackson.core</groupId>
+            <artifactId>jackson-core</artifactId>
+            <version>${jackson.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>com.fasterxml.jackson.core</groupId>
+            <artifactId>jackson-databind</artifactId>
+            <version>${jackson.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>com.fasterxml.jackson.core</groupId>
+            <artifactId>jackson-annotations</artifactId>
+            <version>${jackson.version}</version>
         </dependency>
         <dependency>
             <groupId>org.mockito</groupId>
@@ -55,12 +90,6 @@
                 </exclusion>
             </exclusions>
         </dependency>
-        <dependency>
-            <groupId>junit</groupId>
-            <artifactId>junit</artifactId>
-            <version>4.12</version>
-            <scope>test</scope>
-        </dependency>
         <dependency>
             <groupId>org.mortbay.jetty.alpn</groupId>
             <artifactId>alpn-boot</artifactId>
@@ -103,9 +132,8 @@
             <version>${powermock.version}</version>
             <scope>test</scope>
         </dependency>
-
-
     </dependencies>
+
     <build>
         <resources>
             <resource>
@@ -117,6 +145,15 @@
             </resource>
         </resources>
         <plugins>
+            <plugin>
+              <groupId>org.apache.maven.plugins</groupId>
+              <artifactId>maven-surefire-plugin</artifactId>
+              <configuration>
+                <systemPropertyVariables>
+                  <java.util.logging.config.file>logging.properties</java.util.logging.config.file>
+                </systemPropertyVariables>
+              </configuration>
+            </plugin>
             <plugin>
                 <groupId>org.codehaus.mojo</groupId>
                 <artifactId>build-helper-maven-plugin</artifactId>

src/main/java/com/ge/predix/audit/sdk/AbstractAuditClientImpl.java

@@ -83,7 +83,7 @@ public AbstractAuditClientImpl(AuditConfiguration configuration, TracingHandler
 
 	/**
 	 * Reconnect audit client manually
-	 * @throws EventHubClientException
+	 * @throws EventHubClientException in case of EventHub failure
 	 */
 	@Override
 	public synchronized void reconnect() throws EventHubClientException {

src/main/java/com/ge/predix/audit/sdk/AuditClient.java

@@ -103,6 +103,8 @@ public void shutdown() throws EventHubClientException {
 
     /**
      * Returns the state of this client.
+     *
+     * @return state of Audit Client
      */
     public AuditClientState getState(){
         return auditClientAsyncImpl.getAuditClientState();

src/main/java/com/ge/predix/audit/sdk/AuditClientAsyncImpl.java

@@ -147,7 +147,7 @@ protected void addToEventhubCache(Collection<AuditEvent> events) {
 		});
 	}
 
-	private  void innerReconnect(){
+	private  synchronized void innerReconnect(){
 		try {
 			reconnect();
 		} catch (EventHubClientException e) {

src/main/java/com/ge/predix/audit/sdk/AuditClientSync.java

@@ -97,6 +97,8 @@ public void shutdown() throws EventHubClientException {
 
     /**
      * Returns the state of this client.
+     *
+     * @return state of Audit Client
      */
     public AuditClientState getState(){
         return auditClientSyncImpl.getAuditClientState();

src/main/java/com/ge/predix/audit/sdk/ExponentialReconnectStrategy.java

@@ -25,6 +25,7 @@ public class ExponentialReconnectStrategy implements ReconnectStrategy {
     private volatile AtomicInteger curIndex;
     private volatile AtomicBoolean isBetweenIntervals;
     private volatile AtomicBoolean shouldReconnectNextInterval;
+    private volatile AuditCommonClientState auditCommonClientState;
 
     public ExponentialReconnectStrategy(Runnable actionToPerform) {
         threadExecutor = Executors.newSingleThreadScheduledExecutor();
@@ -36,6 +37,7 @@ public ExponentialReconnectStrategy(Runnable actionToPerform) {
 
     @Override
     public synchronized void notifyStateChanged(AuditCommonClientState auditCommonClientState)  {
+        this.auditCommonClientState = auditCommonClientState;
         switch (auditCommonClientState){
             case DISCONNECTED:{
                 if (!isBetweenIntervals.get()) {
@@ -53,25 +55,32 @@ public synchronized void notifyStateChanged(AuditCommonClientState auditCommonCl
                 shouldReconnectNextInterval.set(false);
                 shutdown();
             }
+            case CONNECTING:{
+                shouldReconnectNextInterval.set(true);
+            }
+            case CONNECTED:{
+                shouldReconnectNextInterval.set(false);
+            }
             default:
                 break;
         }
     }
 
     synchronized void handleInterval()  {
          log.info("Running reconnect algo: shouldReconnect: "+shouldReconnectNextInterval+" index: "+curIndex);
-        if (shouldReconnectNextInterval.get()) {
+         if (shouldReconnectNextInterval.get()) {
             try {
                 if(actionToPerform != null) {
                     actionToPerform.run();
                 }
+               // if (!)
             } catch (Exception e) {
                 log.warn("failed to perform reconnect: "+e.getMessage());
             }
             if (curIndex.get() < reconnectIntervalsMillis.length) {
                 curIndex.incrementAndGet();
             }
-            shouldReconnectNextInterval.set(false);
+            //shouldReconnectNextInterval.set(false);
             threadExecutor.schedule(this::handleInterval, reconnectIntervalsMillis[curIndex.get()], TimeUnit.MILLISECONDS);
         } else {
             curIndex.set(0);

src/main/java/com/ge/predix/audit/sdk/TracingHandler.java

@@ -14,7 +14,7 @@
 public interface TracingHandler {
 
     /**
-     * @returns AuditTracingEvent optional.
+     * @return AuditTracingEvent optional.
      * it will return the sent message or null if no message was sent
      */
     Optional<AuditTracingEvent> sendInitialCheckpoint();
@@ -26,4 +26,4 @@ public interface TracingHandler {
     boolean isTracingAck(Ack ack);
 
     boolean isTracingEvent(AuditEvent event);
-}
+}

src/test/java/com/ge/predix/audit/sdk/ExponentialReconnectStrategyTest.java

@@ -11,27 +11,44 @@
 /**
  * Created by 212582776 on 2/15/2018.
  */
+
 public class ExponentialReconnectStrategyTest {
 
-    public static class DoNothingRunnable implements Runnable{
+
+    public  class NotifyConnectedRunnable implements Runnable{
+
+
 
         @Override
         public void run() {
-
+            exponentialReconnectStrategy.notifyStateChanged(AuditCommonClientState.CONNECTED);
         }
     }
 
-    public static class ThrowsRuntimeExceptionRunnable implements Runnable{
+    public  class ThrowsRuntimeExceptionRunnable implements Runnable{
 
         @Override
         public void run() {
+            exponentialReconnectStrategy.notifyStateChanged(AuditCommonClientState.CONNECTING);
             throw new RuntimeException("exception");
+
+        }
+    }
+
+    public  class ReconnectFailureRunnable implements Runnable{
+
+        @Override
+        public void run() {
+            exponentialReconnectStrategy.notifyStateChanged(AuditCommonClientState.CONNECTING);
+            exponentialReconnectStrategy.notifyStateChanged(AuditCommonClientState.DISCONNECTED);
         }
     }
 
-    private DoNothingRunnable doNothingRunnable = spy(new DoNothingRunnable());
+    private NotifyConnectedRunnable doNothingRunnable = spy(new NotifyConnectedRunnable());
+    private ReconnectFailureRunnable reconnectFailureRunnable = spy(new ReconnectFailureRunnable());
     private ThrowsRuntimeExceptionRunnable throwsRuntimeExceptionRunnable = spy(new ThrowsRuntimeExceptionRunnable());
 
+
     @Spy
     ExponentialReconnectStrategy exponentialReconnectStrategy;
     private static final int[] backoffIntervals = new int[]{100,200,300,400};
@@ -114,11 +131,22 @@ public void notifyStateChange_clientShutdown_reconnectIsNotAttempted() throws Ex
 
     @Test
     public void notifyStateChange_actionThrowsException_reconnectContinues() throws Exception {
-        exponentialReconnectStrategy = spy(new ExponentialReconnectStrategy(throwsRuntimeExceptionRunnable));
+        exponentialReconnectStrategy = spy(new ExponentialReconnectStrategy(reconnectFailureRunnable));
         setBackoff();
         exponentialReconnectStrategy.notifyStateChanged(AuditCommonClientState.DISCONNECTED);
-        Thread.sleep(500);
+        Thread.sleep(150);
+        verify(exponentialReconnectStrategy,times(1)).handleInterval();
+        verify(reconnectFailureRunnable,times(1)).run();
+        Thread.sleep(200);
         verify(exponentialReconnectStrategy,times(2)).handleInterval();
-        verify(throwsRuntimeExceptionRunnable,times(1)).run();
+        verify(reconnectFailureRunnable,times(2)).run();
+
+        doAnswer(invocation -> {
+            exponentialReconnectStrategy.notifyStateChanged(AuditCommonClientState.CONNECTED); return null;}).when(reconnectFailureRunnable).run();
+
+        Thread.sleep(1000);
+        verify(exponentialReconnectStrategy,times(4)).handleInterval();
+        verify(reconnectFailureRunnable,times(3)).run();
+
     }
 }

src/test/resources/logging.properties

@@ -0,0 +1 @@
+java.util.logging.ConsoleHandler.level=WARNING