Merge pull request #13 from MattSScott/server-rename-and-testing

Server package rename and testing

main.go

@@ -1,7 +1,7 @@
 package main
 
 import (
-	"github.com/MattSScott/basePlatformSOMAS/pkg/main/server"
+	baseserver "github.com/MattSScott/basePlatformSOMAS/pkg/main/BaseServer"
 	"github.com/MattSScott/basePlatformSOMAS/pkg/testing/testAgents/baseExtendedAgent"
 	helloagent "github.com/MattSScott/basePlatformSOMAS/pkg/testing/testAgents/helloAgent"
 	worldagent "github.com/MattSScott/basePlatformSOMAS/pkg/testing/testAgents/worldAgent"
@@ -10,10 +10,10 @@ import (
 
 func main() {
 
-	m := make([]server.AgentGeneratorCountPair[baseExtendedAgent.IExtendedAgent], 5)
+	m := make([]baseserver.AgentGeneratorCountPair[baseExtendedAgent.IExtendedAgent], 2)
 
-	m[0] = server.MakeAgentGeneratorCountPair[baseExtendedAgent.IExtendedAgent](helloagent.GetHelloAgent, 3)
-	m[1] = server.MakeAgentGeneratorCountPair[baseExtendedAgent.IExtendedAgent](worldagent.GetWorldAgent, 2)
+	m[0] = baseserver.MakeAgentGeneratorCountPair[baseExtendedAgent.IExtendedAgent](helloagent.GetHelloAgent, 3)
+	m[1] = baseserver.MakeAgentGeneratorCountPair[baseExtendedAgent.IExtendedAgent](worldagent.GetWorldAgent, 2)
 
 	iterations := 1
 	ts := testserver.New(m, iterations)

pkg/main/BaseAgent/agentInterface.go

@@ -9,8 +9,8 @@ import (
 type IAgent[T any] interface {
 	// composes messaging passing capabilities
 	message.IAgentMessenger[T]
-	// allows agent to update their internal state
-	UpdateAgentInternalState()
 	// returns the unique ID of an agent
 	GetID() uuid.UUID
+	// allows agent to update their internal state
+	UpdateAgentInternalState()
 }

pkg/main/BaseAgent/baseAgent.go

@@ -6,31 +6,22 @@ import (
 )
 
 type BaseAgent[T IAgent[T]] struct {
-	id      uuid.UUID
-	network []T
+	id uuid.UUID
 }
 
 func (ba *BaseAgent[T]) GetID() uuid.UUID {
 	return ba.id
 }
 
-func (ba *BaseAgent[T]) UpdateAgentInternalState() {
-}
+func (ba *BaseAgent[T]) UpdateAgentInternalState() {}
 
 func NewAgent[T IAgent[T]]() *BaseAgent[T] {
 	return &BaseAgent[T]{
 		id: uuid.New(),
 	}
 }
 
-func (ba *BaseAgent[T]) GetAllMessages() []message.IMessage[T] {
-	return []message.IMessage[T]{}
-}
-
-func (ba *BaseAgent[T]) GetNetwork() []T {
-	return ba.network
-}
+func (ba *BaseAgent[T]) GetAllMessages(listOfAgents []T) []message.IMessage[T] {
 
-func (ba *BaseAgent[T]) SetNetwork(newNetwork []T) {
-	ba.network = newNetwork
+	return []message.IMessage[T]{}
 }

pkg/main/BaseAgent/baseAgent_test.go

@@ -0,0 +1,58 @@
+package baseagent_test
+
+import (
+	"testing"
+
+	baseagent "github.com/MattSScott/basePlatformSOMAS/pkg/main/BaseAgent"
+	"github.com/google/uuid"
+)
+
+type IBaseAgent interface {
+	baseagent.IAgent[IBaseAgent]
+}
+
+func TestAgentIdOperations(t *testing.T) {
+	baseAgent := baseagent.NewAgent[IBaseAgent]()
+
+	if baseAgent.GetID() == uuid.Nil {
+		t.Error("Agent not instantiated with valid ID")
+	}
+}
+
+type AgentWithState struct {
+	*baseagent.BaseAgent[*AgentWithState]
+	state int
+}
+
+func (aws *AgentWithState) UpdateAgentInternalState() {
+	aws.state += 1
+}
+
+func TestUpdateAgentInternalState(t *testing.T) {
+	ag := AgentWithState{
+		baseagent.NewAgent[*AgentWithState](),
+		0,
+	}
+
+	if ag.state != 0 {
+		t.Error("Additional agent field not correctly instantiated")
+	}
+
+	ag.UpdateAgentInternalState()
+
+	if ag.state != 1 {
+		t.Error("Agent state not correctly updated")
+	}
+}
+
+func TestMessageRetrieval(t *testing.T) {
+
+	agent := baseagent.NewAgent[IBaseAgent]()
+
+	messages := agent.GetAllMessages([]IBaseAgent{agent})
+
+	if len(messages) > 0 {
+		t.Error("Agent erroneously constructed message")
+	}
+
+}

pkg/main/server/baseServer.go → pkg/main/BaseServer/baseServer.go

@@ -1,4 +1,4 @@
-package server
+package baseserver
 
 import (
 	"fmt"

pkg/main/BaseServer/baseServer_test.go

@@ -0,0 +1,91 @@
+package baseserver_test
+
+import (
+	"testing"
+
+	baseagent "github.com/MattSScott/basePlatformSOMAS/pkg/main/BaseAgent"
+	baseserver "github.com/MattSScott/basePlatformSOMAS/pkg/main/BaseServer"
+)
+
+type ITestBaseAgent interface {
+	baseagent.IAgent[ITestBaseAgent]
+}
+
+type TestBaseAgent struct {
+	*baseagent.BaseAgent[ITestBaseAgent]
+}
+
+func NewTestBaseAgent() ITestBaseAgent {
+	return &TestBaseAgent{
+		baseagent.NewAgent[ITestBaseAgent](),
+	}
+}
+
+func TestAgentsCorrectlyInstantiated(t *testing.T) {
+	m := make([]baseserver.AgentGeneratorCountPair[ITestBaseAgent], 1)
+	m[0] = baseserver.MakeAgentGeneratorCountPair[ITestBaseAgent](NewTestBaseAgent, 3)
+
+	server := baseserver.CreateServer[ITestBaseAgent](m, 1)
+
+	if len(server.GetAgents()) != 3 {
+		t.Error("Incorrect number of agents added to server")
+	}
+
+}
+
+func TestNumTurnsInServer(t *testing.T) {
+	m := make([]baseserver.AgentGeneratorCountPair[ITestBaseAgent], 1)
+	m[0] = baseserver.MakeAgentGeneratorCountPair[ITestBaseAgent](NewTestBaseAgent, 3)
+
+	server := baseserver.CreateServer[ITestBaseAgent](m, 1)
+
+	if server.GetNumTurns() != 1 {
+		t.Error("Incorrect number of turns instantiated")
+	}
+
+}
+
+type IExtendedTestServer interface {
+	baseserver.IServer[ITestBaseAgent]
+	GetAdditionalField() int
+}
+
+type ExtendedTestServer struct {
+	*baseserver.BaseServer[ITestBaseAgent]
+	testField int
+}
+
+func (ets *ExtendedTestServer) GetAdditionalField() int {
+	return ets.testField
+}
+
+func (ets *ExtendedTestServer) RunGameLoop() {
+
+	ets.BaseServer.RunGameLoop()
+	ets.testField += 1
+}
+
+func CreateTestServer(mapper []baseserver.AgentGeneratorCountPair[ITestBaseAgent], iters int) IExtendedTestServer {
+	return &ExtendedTestServer{
+		BaseServer: baseserver.CreateServer[ITestBaseAgent](mapper, iters),
+		testField:  0,
+	}
+}
+
+func TestServerGameLoop(t *testing.T) {
+	m := make([]baseserver.AgentGeneratorCountPair[ITestBaseAgent], 1)
+	m[0] = baseserver.MakeAgentGeneratorCountPair[ITestBaseAgent](NewTestBaseAgent, 3)
+
+	server := CreateTestServer(m, 1)
+
+	if server.GetAdditionalField() != 0 {
+		t.Error("Additional server parameter not correctly instantiated")
+	}
+
+	server.RunGameLoop()
+
+	if server.GetAdditionalField() != 1 {
+		t.Error("Run Game Loop method not successfully overridden")
+	}
+
+}

pkg/main/server/serverInterface.go → pkg/main/BaseServer/serverInterface.go

@@ -1,4 +1,4 @@
-package server
+package baseserver
 
 import baseagent "github.com/MattSScott/basePlatformSOMAS/pkg/main/BaseAgent"
 

pkg/main/messaging/agentMessenger.go

@@ -3,5 +3,5 @@ package messaging
 // // base interface structure used for message passing - can be composed for more complex message structures
 type IAgentMessenger[T any] interface {
 	// produces a list of messages (of any common interface) that an agent wishes to pass
-	GetAllMessages([]T) []IMessage[T]
+	GetAllMessages(listOfAgents []T) []IMessage[T]
 }

pkg/testing/testAgents/baseExtendedAgent/baseExtendedAgent.go

@@ -23,10 +23,20 @@ func (ag *BaseExtendedAgent) GetPhrase() string {
 	return ag.phrase
 }
 
+func (ag *BaseExtendedAgent) HandleGreetingMessage(GreetingMessage) {}
+
 func GetAgent(phrase string) *BaseExtendedAgent {
 	return &BaseExtendedAgent{
 		BaseAgent: baseAgent.NewAgent[IExtendedAgent](),
 		phrase:    phrase,
 	}
 
 }
+
+func GetDefaultAgent(phrase string) IExtendedAgent {
+	return &BaseExtendedAgent{
+		BaseAgent: baseAgent.NewAgent[IExtendedAgent](),
+		phrase:    phrase,
+	}
+
+}

pkg/testing/testServer/server_test.go

@@ -1,7 +1,7 @@
 package testserver_test
 
 import (
-	"github.com/MattSScott/basePlatformSOMAS/pkg/main/server"
+	baseserver "github.com/MattSScott/basePlatformSOMAS/pkg/main/BaseServer"
 	"github.com/MattSScott/basePlatformSOMAS/pkg/testing/testAgents/baseExtendedAgent"
 	helloagent "github.com/MattSScott/basePlatformSOMAS/pkg/testing/testAgents/helloAgent"
 	worldagent "github.com/MattSScott/basePlatformSOMAS/pkg/testing/testAgents/worldAgent"
@@ -13,10 +13,10 @@ import (
 
 func TestInheritedServer(t *testing.T) {
 
-	m := make([]server.AgentGeneratorCountPair[baseExtendedAgent.IExtendedAgent], 5)
+	m := make([]baseserver.AgentGeneratorCountPair[baseExtendedAgent.IExtendedAgent], 2)
 
-	m[0] = server.MakeAgentGeneratorCountPair[baseExtendedAgent.IExtendedAgent](helloagent.GetHelloAgent, 3)
-	m[1] = server.MakeAgentGeneratorCountPair[baseExtendedAgent.IExtendedAgent](worldagent.GetWorldAgent, 2)
+	m[0] = baseserver.MakeAgentGeneratorCountPair[baseExtendedAgent.IExtendedAgent](helloagent.GetHelloAgent, 3)
+	m[1] = baseserver.MakeAgentGeneratorCountPair[baseExtendedAgent.IExtendedAgent](worldagent.GetWorldAgent, 2)
 
 	floors := 3
 	ts := testserver.New(m, floors)
@@ -35,10 +35,10 @@ func TestInheritedServer(t *testing.T) {
 
 func TestServerInterfaceComposition(t *testing.T) {
 
-	m := make([]server.AgentGeneratorCountPair[baseExtendedAgent.IExtendedAgent], 2)
+	m := make([]baseserver.AgentGeneratorCountPair[baseExtendedAgent.IExtendedAgent], 2)
 
-	m[0] = server.MakeAgentGeneratorCountPair[baseExtendedAgent.IExtendedAgent](helloagent.GetHelloAgent, 1)
-	m[1] = server.MakeAgentGeneratorCountPair[baseExtendedAgent.IExtendedAgent](worldagent.GetWorldAgent, 1)
+	m[0] = baseserver.MakeAgentGeneratorCountPair[baseExtendedAgent.IExtendedAgent](helloagent.GetHelloAgent, 1)
+	m[1] = baseserver.MakeAgentGeneratorCountPair[baseExtendedAgent.IExtendedAgent](worldagent.GetWorldAgent, 1)
 
 	// server can also be declared as type interface
 	var server testserver.IExtendedServer = testserver.New(m, 1)
@@ -57,10 +57,10 @@ func TestServerInterfaceComposition(t *testing.T) {
 }
 
 func TestServerMessagePassing(t *testing.T) {
-	m := make([]server.AgentGeneratorCountPair[baseExtendedAgent.IExtendedAgent], 5)
+	m := make([]baseserver.AgentGeneratorCountPair[baseExtendedAgent.IExtendedAgent], 2)
 
-	m[0] = server.MakeAgentGeneratorCountPair[baseExtendedAgent.IExtendedAgent](helloagent.GetHelloAgent, 1)
-	m[1] = server.MakeAgentGeneratorCountPair[baseExtendedAgent.IExtendedAgent](worldagent.GetWorldAgent, 1)
+	m[0] = baseserver.MakeAgentGeneratorCountPair[baseExtendedAgent.IExtendedAgent](helloagent.GetHelloAgent, 1)
+	m[1] = baseserver.MakeAgentGeneratorCountPair[baseExtendedAgent.IExtendedAgent](worldagent.GetWorldAgent, 1)
 
 	floors := 3
 	ts := testserver.New(m, floors)

pkg/testing/testServer/testServer.go

@@ -1,26 +1,26 @@
 package testserver
 
 import (
-	baseServer "github.com/MattSScott/basePlatformSOMAS/pkg/main/server"
+	baseserver "github.com/MattSScott/basePlatformSOMAS/pkg/main/BaseServer"
 	"github.com/MattSScott/basePlatformSOMAS/pkg/testing/testAgents/baseExtendedAgent"
 )
 
 // the base server functionality can be extended with 'environment specific' functions
 type IExtendedServer interface {
-	baseServer.IServer[baseExtendedAgent.IExtendedAgent]
+	baseserver.IServer[baseExtendedAgent.IExtendedAgent]
 	RunAdditionalPhase()
 }
 
 // composing the 'base server' allows access to the pre-made interface implementations
 // new fields can be added to the extended server data structure
 type TestServer struct {
-	*baseServer.BaseServer[baseExtendedAgent.IExtendedAgent]
+	*baseserver.BaseServer[baseExtendedAgent.IExtendedAgent]
 	name string
 }
 
-func New(mapper []baseServer.AgentGeneratorCountPair[baseExtendedAgent.IExtendedAgent], iterations int) *TestServer {
+func New(mapper []baseserver.AgentGeneratorCountPair[baseExtendedAgent.IExtendedAgent], iterations int) *TestServer {
 	return &TestServer{
-		BaseServer: baseServer.CreateServer[baseExtendedAgent.IExtendedAgent](mapper, iterations),
+		BaseServer: baseserver.CreateServer[baseExtendedAgent.IExtendedAgent](mapper, iterations),
 		name:       "TestServer",
 	}
 }