adding tests

README.md

@@ -45,6 +45,8 @@ The Symphony java client provides a real-time wrapper around the Symphony REST A
 ## Change log and notes
 
 ## V1.1.5 (SNAPSHOT)
+* Updated with latest 1.50 spec.  symphony-java-api v1.50.1
+* Implementation of signals
 
 ## V1.1.4
 * Major bug fix (1.50+) to accept real-time events that do not include event ids as this is now optional.

examples/pom.xml

@@ -29,7 +29,7 @@
   <modelVersion>4.0.0</modelVersion>
   <groupId>org.symphonyoss</groupId>
   <artifactId>symphony-client-examples</artifactId>
-  <version>1.1.4-SNAPSHOT</version>
+  <version>1.1.5-SNAPSHOT</version>
   <name>Symphony Client Examples</name>
   <description>Symphony Client Examples</description>
 
@@ -67,7 +67,7 @@
     <dependency>
       <groupId>org.symphonyoss.symphony</groupId>
       <artifactId>symphony-client</artifactId>
-      <version>1.1.3-SNAPSHOT</version>
+      <version>1.1.5-SNAPSHOT</version>
     </dependency>
     <dependency>
       <groupId>com.rometools</groupId>

examples/signals/SignalsExample.java

@@ -0,0 +1,139 @@
+/*
+ *
+ *
+ * Copyright 2018 The Symphony Software Foundation
+ *
+ * Licensed to The Symphony Software Foundation (SSF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ *
+ */
+
+package signals;
+
+import java.util.List;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.symphonyoss.client.SymphonyClient;
+import org.symphonyoss.client.SymphonyClientConfig;
+import org.symphonyoss.client.SymphonyClientFactory;
+import org.symphonyoss.client.SymphonyClientFactory.TYPE;
+import org.symphonyoss.client.exceptions.SignalsException;
+import org.symphonyoss.symphony.agent.invoker.ApiException;
+import org.symphonyoss.symphony.clients.model.SymSignal;
+
+/**
+ * Simple example to list signals
+ * <p>
+ * It will send a message to a call.home.user and listen/create new Chat
+ * sessions.
+ * <p>
+ * <p>
+ * <p>
+ * REQUIRED VM Arguments or System Properties:
+ * <p>
+ * -Dtruststore.file= -Dtruststore.password=password
+ * -Dsessionauth.url=https://(hostname)/sessionauth
+ * -Dkeyauth.url=https://(hostname)/keyauth
+ * -Duser.call.home=frank.tarsillo@markit.com -Duser.cert.password=password
+ * -Duser.cert.file=bot.user2.p12 -Duser.email=bot.user2@domain.com
+ * -Dpod.url=https://(pod host)/pod -Dagent.url=https://(agent server
+ * host)/agent -Dreceiver.email=bot.user2@markit.com or bot user email
+ *
+ * @author Dov Katz
+ */
+// NOSONAR
+public class SignalsExample {
+
+	private final Logger logger = LoggerFactory.getLogger(SignalsExample.class);
+	private SymphonyClient symClient;
+
+	public SignalsExample() {
+
+		init();
+
+	}
+
+	public static void main(String[] args) {
+
+		new SignalsExample();
+
+	}
+
+	public void init() {
+		logger.info("Signal Client example starting...");
+
+		try {
+
+			// Create an initialized client
+			symClient = SymphonyClientFactory.getClient(TYPE.V4);
+			symClient.init(new SymphonyClientConfig(true));
+			logger.info("My bot email is {}", symClient.getLocalUser().getEmailAddress());
+			logger.info("My bot' name is {}", symClient.getLocalUser().getDisplayName());
+
+			// List Signals
+			List<SymSignal> signals = symClient.getSignalsClient().listSignals(0, 10);
+			logger.info("Found (max 10) {} signals", signals.size());
+			signals.forEach(signal -> {
+				logger.info("Signal :{}", signal);
+			});
+
+			// Create Signal
+			SymSignal signal = new SymSignal();
+			signal.setVisibleOnProfile(false);
+			signal.setName("Test Signal " + System.currentTimeMillis());
+			signal.setQuery("HASHTAG:testSignal AND CASHTAG:money");
+			signal.setCompanyWide(false);
+			;
+			logger.info("Going to create a signal : Name {}, Query: {}", signal.getName(), signal.getQuery());
+			;
+			SymSignal result = symClient.getSignalsClient().createSignal(signal);
+			logger.info("Created Signal ID {}, Name {}", result.getId(), result.getName());
+			;
+
+			// Search for the one we just created
+			logger.info("Let's search for our new signal");
+			SymSignal found = symClient.getSignalsClient().getSignal(result.getId());
+			logger.info("Found signal we just created by ID {} --> {} ( {} )", result.getId(), found.getName(),
+					found.getQuery());
+
+			// Delete Signal
+			logger.info("Let's delete our signal");
+			symClient.getSignalsClient().deleteSignal(result.getId());
+			logger.info("Deleted Signal {},  Let's prove it", result.getId());
+
+			// Search for the one we just deleted
+			try {
+				found = symClient.getSignalsClient().getSignal(result.getId());
+				logger.info("We didn't delete the signal,  it seems this was found {}: ",found);
+			} catch (SignalsException sigExc) {
+				if (sigExc.getCause() instanceof ApiException && ((ApiException) sigExc.getCause()).getCode() == 404) {
+					logger.info(
+							"Successfully got a 404 when trying to search for a non-existent signal. Deletion succeeded");
+					;
+				}
+			}
+			logger.info("Client shutting down.");
+			symClient.shutdown();
+			System.exit(0);
+		} catch (Exception e) {
+			e.printStackTrace();
+		}
+
+	}
+
+}

examples/utils/CopyChatRoom.java

@@ -192,9 +192,9 @@ public void init() {
 
                     String userName = symClient.getUsersClient().getUserFromId(symMessage.getFromUserId()).getDisplayName();
 
-                    logger.debug("{}:{}:{}:{}", userName, new Date(Long.valueOf(symMessage.getTimestamp())).toString(), symMessage.getMessage(), symMessage.getAttachments().size());
+                    logger.debug("{}:{}:{}:{}", userName, new Date(Long.valueOf(symMessage.getTimestamp())).toString(), symMessage.getMessage());
 
-                    if (symMessage.getAttachments().size() > 0) {
+                    if (symMessage.getAttachments() != null && symMessage.getAttachments().size() > 0) {
                         symAttachmentInfos.addAll(symMessage.getAttachments());
 
 

pom.xml

@@ -150,6 +150,11 @@
             <artifactId>jackson-jaxrs-json-provider</artifactId>
             <version>${jackson.version}</version>
         </dependency>
+        <dependency>
+          <groupId>com.diffblue</groupId>
+          <artifactId>deeptestutils</artifactId>
+          <version>1.1.0</version>
+        </dependency>
     </dependencies>
 
     <build>

symphony-client/pom.xml

@@ -21,7 +21,8 @@
   ~ under the License.
   -->
 
-<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">
+<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">
     <parent>
         <artifactId>symphony-java-client</artifactId>
         <groupId>org.symphonyoss.symphony</groupId>
@@ -42,7 +43,7 @@
 
     <properties>
         <jsoup-version>1.11.2</jsoup-version>
-        <symphony-api-version>1.50.0</symphony-api-version>
+        <symphony-api-version>1.51.0-SNAPSHOT</symphony-api-version>
         <gson-version>2.8.2</gson-version>
         <org-javassist>3.22.0-GA</org-javassist>
         <failsafe.jvm.args>-Dlog4j.configurationFile=src/test/resources/log4j.properties -Xmx1024m
@@ -70,6 +71,16 @@
             <groupId>org.symphonyoss.symphony</groupId>
             <artifactId>symphony-authenticator-java-jersey2-client</artifactId>
             <version>${symphony-api-version}</version>
+            <exclusions>
+                <exclusion>
+                    <groupId>com.fasterxml.jackson.core</groupId>
+                    <artifactId>jackson-core</artifactId>
+                </exclusion>
+                <exclusion>
+                    <groupId>com.fasterxml.jackson.core</groupId>
+                    <artifactId>jackson-databind</artifactId>
+                </exclusion>
+            </exclusions>
         </dependency>
         <dependency>
             <groupId>org.symphonyoss.symphony</groupId>
@@ -152,18 +163,18 @@
 
 
             <!--<plugin>-->
-                <!--<groupId>org.apache.maven.plugins</groupId>-->
-                <!--<artifactId>maven-source-plugin</artifactId>-->
-                <!--<version>2.4</version>-->
-                <!--<executions>-->
-                    <!--<execution>-->
-                        <!--<id>attach-sources</id>-->
-                        <!--<phase>verify</phase>-->
-                        <!--<goals>-->
-                            <!--<goal>jar-no-fork</goal>-->
-                        <!--</goals>-->
-                    <!--</execution>-->
-                <!--</executions>-->
+            <!--<groupId>org.apache.maven.plugins</groupId>-->
+            <!--<artifactId>maven-source-plugin</artifactId>-->
+            <!--<version>2.4</version>-->
+            <!--<executions>-->
+            <!--<execution>-->
+            <!--<id>attach-sources</id>-->
+            <!--<phase>verify</phase>-->
+            <!--<goals>-->
+            <!--<goal>jar-no-fork</goal>-->
+            <!--</goals>-->
+            <!--</execution>-->
+            <!--</executions>-->
             <!--</plugin>-->
 
 

symphony-client/src/main/java/org/symphonyoss/client/SymphonyClient.java

@@ -241,6 +241,13 @@ public interface SymphonyClient {
      */
     ShareClient getShareClient();
 
+    /**
+     * Provides instance of the Signals client.  This client supports the management of signals.
+     *
+     * @return {@link SignalsClient}
+     */
+    SignalsClient getSignalsClient();
+
     /**
      * If set, returns the custom http client set during initialization.
      *

symphony-client/src/main/java/org/symphonyoss/client/SymphonyClientConfig.java

@@ -104,8 +104,28 @@ public void load() throws ProgramFault {
     }
 
 
+    /**
+     * This method is intended for use in unit tests that need to be able to treat this class as a DTO.
+     *
+     * @param id The configuration parameter to retrieve.
+     * @return The value of that configuration parameter, as stored in memory.
+     */
+    public String rawGet(SymphonyClientConfigID id)
+    {
+        return(config.getProperty(id.getPropName()));
+    }
+
+
+    /**
+     * This method does some unusual shenanigans that probably belong elsewhere, so that this class can be a true DTO.
+     * A refactoring task for another day...
+     *
+     * @param id The configuration parameter to retrieve.
+     * @return The value of that configuration parameter, as stored in memory, or one of several Java "system properties"
+     * or environment variables with names vaguely similar to <code>id</code>.  Basically non-deterministic, so YMMV.
+     */
     public String get(SymphonyClientConfigID id) {
-        String value = config.getProperty(id.getPropName());
+        String value = rawGet(id);
 
         if (value == null)
             value = System.getProperty(id.getPropName());

symphony-client/src/main/java/org/symphonyoss/client/SymphonyClientConfigBuilder.java

@@ -81,6 +81,7 @@ public static interface UserCredsStep
     public static interface BuildStep
     {
         BuildStep withReceiverEmail(String receiverEmail);
+        BuildStep withGetAllUsersTimeout(String getAllUsersTimeout);
         BuildStep withServices(boolean enabled);
         BuildStep withJMXHealthcheck(boolean enabled);
         SymphonyClientConfig build();
@@ -105,6 +106,7 @@ private static class Steps
         private String  userCertFilename      = null;
         private char[]  userCertPassword      = null;
         private String  receiverEmail         = null;
+        private String  getAllUsersTimeout    = null;
         private boolean servicesEnabled       = true;
         private boolean jmxHealthCheckEnabled = true;
 
@@ -160,6 +162,13 @@ public BuildStep withReceiverEmail(String receiverEmail)
             return (this);
         }
 
+        @Override
+        public BuildStep withGetAllUsersTimeout(String getAllUsersTimeout)
+        {
+            this.getAllUsersTimeout = getAllUsersTimeout;
+            return (this);
+        }
+
         @Override
         public BuildStep withServices(boolean enabled)
         {
@@ -179,16 +188,18 @@ public SymphonyClientConfig build()
         {
             SymphonyClientConfig result = new SymphonyClientConfig();
 
-            result.set(SymphonyClientConfigID.SESSIONAUTH_URL, this.sessionAuthUrl);
-            result.set(SymphonyClientConfigID.KEYAUTH_URL, this.keyAuthUrl);
-            result.set(SymphonyClientConfigID.POD_URL, this.podUrl);
-            result.set(SymphonyClientConfigID.AGENT_URL, this.agentUrl);
-            result.set(SymphonyClientConfigID.TRUSTSTORE_FILE, this.trustStoreFilename);
-            result.set(SymphonyClientConfigID.TRUSTSTORE_PASSWORD, new String(this.trustStorePassword));  // SECURITY HOLE DUE TO STRING INTERNING
-            result.set(SymphonyClientConfigID.USER_EMAIL, this.userEmail);
-            result.set(SymphonyClientConfigID.USER_CERT_FILE, this.userCertFilename);
-            result.set(SymphonyClientConfigID.USER_CERT_PASSWORD, new String(this.userCertPassword));    // SECURITY HOLE DUE TO STRING INTERNING
-            result.set(SymphonyClientConfigID.RECEIVER_EMAIL, this.receiverEmail);
+            if (this.sessionAuthUrl     != null) result.set(SymphonyClientConfigID.SESSIONAUTH_URL,       this.sessionAuthUrl);
+            if (this.keyAuthUrl         != null) result.set(SymphonyClientConfigID.KEYAUTH_URL,           this.keyAuthUrl);
+            if (this.podUrl             != null) result.set(SymphonyClientConfigID.POD_URL,               this.podUrl);
+            if (this.agentUrl           != null) result.set(SymphonyClientConfigID.AGENT_URL,             this.agentUrl);
+            if (this.trustStoreFilename != null) result.set(SymphonyClientConfigID.TRUSTSTORE_FILE,       this.trustStoreFilename);
+            if (this.trustStorePassword != null) result.set(SymphonyClientConfigID.TRUSTSTORE_PASSWORD,   new String(this.trustStorePassword));  // SECURITY HOLE DUE TO STRING INTERNING
+            if (this.userEmail          != null) result.set(SymphonyClientConfigID.USER_EMAIL,            this.userEmail);
+            if (this.userCertFilename   != null) result.set(SymphonyClientConfigID.USER_CERT_FILE,        this.userCertFilename);
+            if (this.userCertPassword   != null) result.set(SymphonyClientConfigID.USER_CERT_PASSWORD,    new String(this.userCertPassword));    // SECURITY HOLE DUE TO STRING INTERNING
+            if (this.receiverEmail      != null) result.set(SymphonyClientConfigID.RECEIVER_EMAIL,        this.receiverEmail);
+            if (this.getAllUsersTimeout != null) result.set(SymphonyClientConfigID.GET_ALL_USERS_TIMEOUT, this.getAllUsersTimeout);
+
             result.set(SymphonyClientConfigID.DISABLE_SERVICES, String.valueOf(!this.servicesEnabled));
             result.set(SymphonyClientConfigID.HEALTHCHECK_JMX_ENABLED, String.valueOf(this.jmxHealthCheckEnabled));
 

symphony-client/src/main/java/org/symphonyoss/client/SymphonyClientConfigID.java

@@ -28,6 +28,7 @@ public enum SymphonyClientConfigID {
     USER_CERT_PASSWORD("javax.net.ssl.keyStorePassword"),
     USER_EMAIL,
     RECEIVER_EMAIL(false),
+    GET_ALL_USERS_TIMEOUT(false),
     DISABLE_SERVICES(false),
     HEALTHCHECK_JMX_ENABLED(false);