Updating project structure

Author: LostLaser

Diff for: server/bullyElection.go renamed to bullyElection.go

@@ -1,10 +1,11 @@
-package server
+package election
 
 // BullyElection implements the bully election algorithm
 type BullyElection struct {
 }
 
-func (b *BullyElection) startElection(s *Server) {
+// StartElection runs the bully election algorithm on the provided server
+func (b BullyElection) StartElection(s *Server) {
 	s.emitter.Write(s.id, "", "ELECTION_STARTED")
 	if isHighest(s) {
 		notifyLow(s)
@@ -14,9 +15,15 @@ func (b *BullyElection) startElection(s *Server) {
 	s.emitter.Write(s.id, "", "ELECTION_ENDED")
 }
 
-func (b *BullyElection) connectServers(s map[string]*Server) map[string]*Server {
-
-	return nil
+// ConnectServers links the input servers in accordance with the bully algorithm
+func (b BullyElection) ConnectServers(s map[string]*Server) {
+	for currKey, currserver := range s {
+		for key, server := range s {
+			if currKey != key {
+				currserver.NeighborServers[key] = server
+			}
+		}
+	}
 }
 
 func isHighest(s *Server) bool {

Diff for: cluster.go

@@ -3,35 +3,30 @@ package election
 import (
 	"errors"
 	"time"
-
-	"github.com/LostLaser/election/emitter"
-	"github.com/LostLaser/election/server"
 )
 
 // Cluster is a linked collection of servers
 type Cluster struct {
-	linkedServers     map[string]*server.Server
-	emitter           *emitter.Emitter
-	electionAlgorithm server.Election
+	linkedServers     map[string]*Server
+	emitter           *Emitter
+	electionAlgorithm Election
 }
 
 // New will create a cluster with the specified number of servers
-func New(serverCount int, heartbeatPause time.Duration) *Cluster {
+func New(serverCount int, heartbeatPause time.Duration, algorithm Election) *Cluster {
 	c := new(Cluster)
-	c.linkedServers = make(map[string]*server.Server)
-	c.emitter = emitter.New(serverCount * 10)
-	c.electionAlgorithm = &server.BullyElection{}
+	c.linkedServers = make(map[string]*Server)
+	c.emitter = NewEmitter(serverCount * 10)
+	c.electionAlgorithm = algorithm
 
 	for i := 0; i < serverCount; i++ {
-		s := server.New(c.emitter, heartbeatPause, c.electionAlgorithm)
+		s := NewServer(c.emitter, heartbeatPause, c.electionAlgorithm)
 		c.linkedServers[s.GetID()] = s
 	}
-	for currKey, currserver := range c.linkedServers {
-		for key, server := range c.linkedServers {
-			if currKey != key {
-				currserver.NeighborServers[key] = server
-			}
-		}
+
+	c.electionAlgorithm.ConnectServers(c.linkedServers)
+
+	for _, currserver := range c.linkedServers {
 		go currserver.Initialize()
 	}
 
@@ -78,7 +73,7 @@ func (c Cluster) ReadEvent() map[string]string {
 	return c.emitter.Read()
 }
 
-func (c Cluster) getServerByID(id string) (*server.Server, error) {
+func (c Cluster) getServerByID(id string) (*Server, error) {
 	for key, s := range c.linkedServers {
 		if id == key {
 			return s, nil

Diff for: cluster_test.go

@@ -8,8 +8,9 @@ import (
 func TestNew(t *testing.T) {
 	expectedServerCount := 3
 	cycleTime := time.Second
+	algorithm := &BullyElection{}
 
-	cluster := New(expectedServerCount, cycleTime)
+	cluster := New(expectedServerCount, cycleTime, algorithm)
 
 	actualServerCount := len(cluster.linkedServers)
 	if actualServerCount != expectedServerCount {
@@ -18,11 +19,12 @@ func TestNew(t *testing.T) {
 }
 
 func TestNeighbors(t *testing.T) {
-	expectedServerCount := 3
+	expectedServerCount := 5
 	expectedNeighborCount := expectedServerCount - 1
 	cycleTime := time.Second
+	algorithm := &BullyElection{}
 
-	cluster := New(expectedServerCount, cycleTime)
+	cluster := New(expectedServerCount, cycleTime, algorithm)
 	for _, server := range cluster.linkedServers {
 		neighborCount := len(server.NeighborServers)
 		if neighborCount != expectedNeighborCount {
@@ -34,8 +36,9 @@ func TestNeighbors(t *testing.T) {
 func TestServerListingCount(t *testing.T) {
 	expectedServerCount := 3
 	cycleTime := time.Second
+	algorithm := &BullyElection{}
 
-	cluster := New(expectedServerCount, cycleTime)
+	cluster := New(expectedServerCount, cycleTime, algorithm)
 
 	actualServerCount := len(cluster.ServerIds())
 	if actualServerCount != expectedServerCount {
@@ -46,8 +49,9 @@ func TestServerListingCount(t *testing.T) {
 func TestServerListingConsistency(t *testing.T) {
 	serverCount := 3
 	cycleTime := time.Second
+	algorithm := &BullyElection{}
 
-	cluster := New(serverCount, cycleTime)
+	cluster := New(serverCount, cycleTime, algorithm)
 
 	for _, i := range cluster.ServerIds() {
 		found := false
@@ -66,8 +70,9 @@ func TestServerListingConsistency(t *testing.T) {
 func TestReadEvent(t *testing.T) {
 	expectedServerCount := 3
 	cycleTime := time.Second
+	algorithm := &BullyElection{}
 
-	cluster := New(expectedServerCount, cycleTime)
+	cluster := New(expectedServerCount, cycleTime, algorithm)
 	c := make(chan (int))
 
 	go func() {
@@ -88,8 +93,9 @@ func TestReadEvent(t *testing.T) {
 func TestStop(t *testing.T) {
 	expectedServerCount := 3
 	cycleTime := time.Second
+	algorithm := &BullyElection{}
 
-	cluster := New(expectedServerCount, cycleTime)
+	cluster := New(expectedServerCount, cycleTime, algorithm)
 	serverIds := cluster.ServerIds()
 
 	if len(cluster.ServerIds()) == 0 {
@@ -107,9 +113,10 @@ func TestStop(t *testing.T) {
 func TestStopInvl(t *testing.T) {
 	expectedServerCount := 3
 	cycleTime := time.Second
+	algorithm := &BullyElection{}
 	id := "invl"
 
-	cluster := New(expectedServerCount, cycleTime)
+	cluster := New(expectedServerCount, cycleTime, algorithm)
 	err := cluster.StopServer("invl")
 	if err == nil {
 		t.Errorf("No error recieved for invalid id: %s", id)

Diff for: electionType.go

@@ -0,0 +1,7 @@
+package election
+
+// Election is an interface for all supported election types
+type Election interface {
+	StartElection(*Server)
+	ConnectServers(map[string]*Server)
+}

Diff for: emitter/emitter.go renamed to emitter.go

@@ -1,12 +1,12 @@
-package emitter
+package election
 
 //Emitter is a specialized queue for messaging
 type Emitter struct {
 	messages chan map[string]string
 }
 
-//New creates an instance of an emitter
-func New(bufferSize int) *Emitter {
+//NewEmitter creates an instance of an emitter
+func NewEmitter(bufferSize int) *Emitter {
 	e := new(Emitter)
 	e.messages = make(chan map[string]string, bufferSize)
 

Diff for: server/process.go renamed to process.go

@@ -1,4 +1,4 @@
-package server
+package election
 
 import (
 	"time"
@@ -8,7 +8,7 @@ func (s *Server) run() {
 	for {
 		if s.state == running {
 			if !s.pingMaster() || s.triggerElection {
-				s.electionAlgorithm.startElection(s)
+				s.electionAlgorithm.StartElection(s)
 				s.triggerElection = false
 			}
 		}

Diff for: ringElection.go

@@ -0,0 +1,21 @@
+package election
+
+// RingElection implements the ring election algorithm
+type RingElection struct {
+}
+
+// StartElection runs the ring election algorithm on the provided server
+func (r *RingElection) StartElection(s *Server) {
+	return
+}
+
+// ConnectServers links the input servers in accordance with the ring election algorithm
+func (r *RingElection) ConnectServers(s map[string]*Server) {
+	for currKey, currserver := range s {
+		for key, server := range s {
+			if currKey != key {
+				currserver.NeighborServers[key] = server
+			}
+		}
+	}
+}

Diff for: server/server.go renamed to server.go

@@ -1,13 +1,11 @@
-package server
+package election
 
 import (
 	"crypto/rand"
 	"fmt"
 	"log"
 	"sync"
 	"time"
-
-	"github.com/LostLaser/election/emitter"
 )
 
 // Server is a single entity
@@ -19,7 +17,7 @@ type Server struct {
 	electionAlgorithm Election
 	electionLock      sync.Mutex
 	triggerElection   bool
-	emitter           *emitter.Emitter
+	emitter           *Emitter
 	heartbeatPause    time.Duration
 }
 
@@ -28,8 +26,8 @@ const (
 	stopped = "stopped"
 )
 
-// New will create a cluster with the specified number of servers
-func New(e *emitter.Emitter, heartbeatPause time.Duration, electionAlgorithm Election) *Server {
+// NewServer will create a cluster with the specified number of servers
+func NewServer(e *Emitter, heartbeatPause time.Duration, electionAlgorithm Election) *Server {
 	s := new(Server)
 	s.id = generateUniqueID()
 	s.state = running