kafka-chat

A CLI Chat Program Based on Apache Kafka

Requirements

• JDK >= 1.7
• Maven
• Apache Kafka 0.8.2.2 (with ZooKeeper included)

How to Build

1. Resolve maven dependency

   $ mvn dependency:copy-dependencies
   

2. Build jar using maven mvn

   $ mvn package
   

How to Run

1. Start ZooKeeper server on your machine

   $ bin/zookeeper-server-start.sh config/zookeeper.properties
   

2. Start Kafka server on your machine

   $ bin/kafka-server-start.sh config/server.properties
   

3. Run ChatServer from the generated jar in target folder

   $ java -cp target/dependency/*:target/kafka-chat-1.0.jar com.edmundophie.chat.ChatServer
   

4. Run ChatClient from the generated jar in target folder

   $ java -cp target/dependency/*:target/kafka-chat-1.0.jar com.edmundophie.chat.ChatClient
   

Chat Commands

• nick <nickname> : login as nickname. Leave nickname empty to login as a random user
• join <channelname> : join to a channel named channelname
• leave <channelname> : leave a channel named channelname
• @<channelname> <message> : send message to a channel named channelname
• <message> : send a message to all user joined channel
• logout : logout from current nickname
• exit : stop program

Testing

Conducted Testing:

• All basic commands (nick, join, leave, etc)
• Invalid command (e.g. @<channelname> without message)
• Send a message when no channel is joined
• Send a message to a channel that is not a member of
• Join a channel that already a member of
• Leave a channel that is not a member of
• Logout and relogin with the same nickname
• Login with existed nickname
• Multiclient chat

Testing Screenshoot:

Team Member

• Edmund Ophie 13512095
• Kevin 13512097

Github Link