Merged in SUMOK-8 (pull request #2)

SUMOK-8 SUMOK-9 Added unit tests and README file

Author: jpdiazvaz

README.md

@@ -0,0 +1,46 @@
+# Kinesis-Sumologic Connector
+
+The **Kinesis-Sumologic Connector** is a Java connector that acts as a pipeline between an [Amazon Kinesis] stream and a [Sumologic] Collection. Data gets fetched from the Kinesis Stream, transformed into a POJO and then sent to the Sumologic Collection as JSON.
+
+## Requirements
+
+ + [Java JDK 1.7]: This connector has been built with Java version 1.7.
+ + [Ant]: A build.xml script has been provided to build the connector with Ant.
+ + [AWS Kinesis Account]: An Amazon AWS Kinesis account to use as a source of data.
+ + [Sumologic Account]: A Sumologic account to use as a destination.
+
+## Overview
+
+Incoming records from one (or many) Shards of an AWS Kinesis Stream will be read using the [Kinesis Client Library]. Records will be:
+
+ + **Transformed**: Raw records will be transformed into a POJO using the KinesisMessageModel class and then serialized.
+ + **Filtered**: A filter may be applied to the records. Default filter will let all records pass.
+ + **Buffered**: A custom buffer may be used to define thresholds that, when crossed, will flush all records into the emitter.
+ + **Emitted**: The records will get send to the Sumologic Collector.
+
+## Configuration
+
+A sample properties file is provided, which should be modified to use your AWS Accounts (**accessKey** and **secretKey**), Kinesis Stream(**kinesisInputStream**), Sumologic HTTP source (**sumologicUrl**) and App Name (**appName**).
+
+## Running the Connector
+
+After modifying the .properties file, run the connector by executing the ant build script 
+To download the needed dependencies execute **ant setup**
+To build and execute the connector execute **ant run**
+
+
+## Related sources
+
+[Amazon Kinesis](http://aws.amazon.com/kinesis/)
+
+[Sumologic](https://www.sumologic.com/)
+
+[Java JDK 1.7](http://www.oracle.com/technetwork/java/javase/overview/index.html)
+
+[Ant](http://ant.apache.org/)
+
+[AWS Kinesis Account](http://aws.amazon.com/account/)
+
+[Sumologic Account](https://www.sumologic.com/pricing/)
+
+[Kinesis Client Library](https://github.com/awslabs/amazon-kinesis-client/)

build.xml

@@ -13,8 +13,6 @@
         <fileset dir="${external.dir}" includes="**/*.jar" />
         <pathelement location="${basedir}/build" />
         <pathelement location="." />
-        <pathelement location="${basedir}/samples" />
-        <pathelement location="${basedir}/samples/sumologic" />
     </path>
 
     <target name="clean">
@@ -44,10 +42,48 @@
         <antcall target="download"/>
         <antcall target="unzip"/>
     </target>
-
-    <target name="run">
+	
+	<target name="test">
+        <mkdir dir="${basedir}/build"/>
+		<javac srcdir="${src.dir}/main/java" 
+		               destdir="${basedir}/build" 
+		               classpathref="sumologic.classpath"
+		               includes="com/mcplusa/kinesis/*.java, com/mcplusa/kinesis/utils/*.java,
+		                         com/mcplusa/sumologic/*.java, com/mcplusa/sumologic/implementations/*.java"/>
+        <javac srcdir="${src.dir}/test/java" 
+               destdir="${basedir}/build" 
+               classpathref="sumologic.classpath"
+               includes="com/mcplusa/kinesis/*.java, com/mcplusa/kinesis/utils/*.java,
+                         com/mcplusa/sumologic/*.java, com/mcplusa/sumologic/implementations/*.java"/>
+		<junit haltonfailure="yes" 
+			   showoutput="yes" 
+			   fork="yes" 
+			   errorProperty="test.failed"
+			   failureProperty="test.failed">
+			<classpath refid="sumologic.classpath"/>			
+			<formatter
+			    type="brief"
+			    usefile="false"/>
+			
+			<batchtest fork="yes" todir="${reports.tests}">
+				<fileset dir="${src.dir}/test/java">
+			  		<include name="**/*Test*.java"/>
+				</fileset>
+			</batchtest>
+		</junit>
+	</target>
+	
+	<target name="main">
         <mkdir dir="${basedir}/build"/>
-        <javac srcdir="${src.dir}/" destdir="${basedir}/build" classpathref="sumologic.classpath" />
+        <javac srcdir="${src.dir}/main/java" 
+               destdir="${basedir}/build" 
+               classpathref="sumologic.classpath"
+               includes="com/mcplusa/kinesis/*.java, com/mcplusa/kinesis/utils/*.java,
+                         com/mcplusa/sumologic/*.java, com/mcplusa/sumologic/implementations/*.java"/>
         <java classname="com.mcplusa.sumologic.SumologicExecutor" classpathref="sumologic.classpath" fork="true" />
+	</target>
+
+    <target name="run">
+    	<antcall target="main"/>
     </target>
 </project>