Sarthak | Makes PayloadGenerator an interface

main.go

@@ -216,7 +216,7 @@ func setUpBlast(url string) blast.Blast {
 		*concurrency,
 		*connections,
 		*numberOfRequests,
-		payloadGenerator.Generate,
+		payloadGenerator,
 		url,
 		*requestsPerSecond,
 		*connectTimeout,

payload/payload_generator.go

@@ -1,5 +1,10 @@
 package payload
 
+// PayloadGenerator defines a function for generating the request payload
+type PayloadGenerator interface {
+	Generate(requestId uint) []byte
+}
+
 // ConstantPayloadGenerator provides a constant payload to all the workers for sending the payload.
 type ConstantPayloadGenerator struct {
 	payload []byte

tests/blast_integration_test.go

@@ -28,7 +28,7 @@ func TestBlastWithLoadGeneration(t *testing.T) {
 	groupOptions := workers.NewGroupOptions(
 		concurrency,
 		totalRequests,
-		payload.NewConstantPayloadGenerator([]byte("HelloWorld")).Generate,
+		payload.NewConstantPayloadGenerator([]byte("HelloWorld")),
 		"localhost:10001",
 	)
 	buffer := &bytes.Buffer{}
@@ -60,7 +60,7 @@ func TestBlastWithLoadGenerationForMaximumDuration(t *testing.T) {
 		concurrency,
 		10,
 		totalRequests,
-		payload.NewConstantPayloadGenerator([]byte("HelloWorld")).Generate,
+		payload.NewConstantPayloadGenerator([]byte("HelloWorld")),
 		"localhost:10002",
 	)
 	buffer := &bytes.Buffer{}
@@ -96,7 +96,7 @@ func TestBlastWithLoadGenerationAndResponseReading(t *testing.T) {
 	groupOptions := workers.NewGroupOptions(
 		concurrency,
 		totalRequests,
-		payload.NewConstantPayloadGenerator([]byte("HelloWorld")).Generate,
+		payload.NewConstantPayloadGenerator([]byte("HelloWorld")),
 		"localhost:10003",
 	)
 	responseOptions := blast.ResponseOptions{
@@ -135,7 +135,7 @@ func TestBlastWithLoadGenerationAndResponseReadingForMaximumDuration(t *testing.
 		concurrency,
 		10,
 		totalRequests,
-		payload.NewConstantPayloadGenerator([]byte("HelloWorld")).Generate,
+		payload.NewConstantPayloadGenerator([]byte("HelloWorld")),
 		"localhost:10004",
 	)
 	responseOptions := blast.ResponseOptions{
@@ -178,7 +178,7 @@ func TestBlastWithResponseReadingGivenTheTargetServerFailsInSendingResponses(t *
 	groupOptions := workers.NewGroupOptions(
 		concurrency,
 		totalRequests,
-		payload.NewConstantPayloadGenerator([]byte("HelloWorld")).Generate,
+		payload.NewConstantPayloadGenerator([]byte("HelloWorld")),
 		"localhost:10005",
 	)
 	responseOptions := blast.ResponseOptions{
@@ -216,7 +216,7 @@ func TestBlastWithLoadGenerationAndAStopSignal(t *testing.T) {
 	groupOptions := workers.NewGroupOptions(
 		concurrency,
 		totalRequests,
-		payload.NewConstantPayloadGenerator([]byte("HelloWorld")).Generate,
+		payload.NewConstantPayloadGenerator([]byte("HelloWorld")),
 		"localhost:10006",
 	)
 	buffer := &bytes.Buffer{}
@@ -257,7 +257,7 @@ func TestBlastWithLoadGenerationAndResponseReadingWithStopSignal(t *testing.T) {
 		concurrency,
 		10,
 		totalRequests,
-		payload.NewConstantPayloadGenerator([]byte("HelloWorld")).Generate,
+		payload.NewConstantPayloadGenerator([]byte("HelloWorld")),
 		"localhost:10007",
 	)
 	responseOptions := blast.ResponseOptions{

tests/worker_group_integration_test.go

@@ -25,7 +25,7 @@ func TestSendsRequestsWithSingleConnection(t *testing.T) {
 	workerGroup := workers.NewWorkerGroup(workers.NewGroupOptions(
 		concurrency,
 		totalRequests,
-		payload.NewConstantPayloadGenerator([]byte("HelloWorld")).Generate,
+		payload.NewConstantPayloadGenerator([]byte("HelloWorld")),
 		"localhost:8080",
 	))
 	loadGenerationResponseChannel := workerGroup.Run()
@@ -55,7 +55,7 @@ func TestSendsRequestsWithMultipleConnections(t *testing.T) {
 		concurrency,
 		connections,
 		totalRequests,
-		payload.NewConstantPayloadGenerator([]byte("HelloWorld")).Generate,
+		payload.NewConstantPayloadGenerator([]byte("HelloWorld")),
 		"localhost:8081",
 	))
 	loadGenerationResponseChannel := workerGroup.Run()
@@ -98,7 +98,7 @@ func TestSendsARequestAndReadsResponseWithSingleConnection(t *testing.T) {
 		workers.NewGroupOptions(
 			concurrency,
 			totalRequests,
-			payload.NewConstantPayloadGenerator([]byte("HelloWorld")).Generate,
+			payload.NewConstantPayloadGenerator([]byte("HelloWorld")),
 			"localhost:8082",
 		), report.NewResponseReader(responseSizeBytes, 100*time.Millisecond, responseChannel),
 	)
@@ -132,7 +132,7 @@ func TestSendsAdditionalRequestsThanConfiguredWithSingleConnection(t *testing.T)
 	workerGroup := workers.NewWorkerGroup(workers.NewGroupOptions(
 		concurrency,
 		totalRequests,
-		payload.NewConstantPayloadGenerator([]byte("HelloWorld")).Generate,
+		payload.NewConstantPayloadGenerator([]byte("HelloWorld")),
 		"localhost:8083",
 	))
 	loadGenerationResponseChannel := workerGroup.Run()
@@ -155,7 +155,7 @@ func TestSendsRequestsOnANonRunningServer(t *testing.T) {
 	workerGroup := workers.NewWorkerGroup(workers.NewGroupOptions(
 		concurrency,
 		totalRequests,
-		payload.NewConstantPayloadGenerator([]byte("HelloWorld")).Generate,
+		payload.NewConstantPayloadGenerator([]byte("HelloWorld")),
 		"localhost:8090",
 	))
 	loadGenerationResponseChannel := workerGroup.Run()
@@ -183,7 +183,7 @@ func TestSendsRequestsWithDialTimeout(t *testing.T) {
 		concurrency,
 		1,
 		totalRequests,
-		payload.NewConstantPayloadGenerator([]byte("HelloWorld")).Generate,
+		payload.NewConstantPayloadGenerator([]byte("HelloWorld")),
 		"localhost:8098",
 		0.0,
 		1*time.Nanosecond,

workers/options.go

@@ -1,31 +1,29 @@
 package workers
 
 import (
+	"blast/payload"
 	"time"
 
 	"blast/report"
 )
 
 const dialTimeout = 3 * time.Second
 
-// PayloadGenerator defines a function for generating the request payload
-type PayloadGenerator = func(requestId uint) []byte
-
 // GroupOptions defines the configuration options for the WorkerGroup.
 type GroupOptions struct {
-	concurrency         uint
-	connections         uint
-	totalRequests       uint
-	payloadGenerationFn PayloadGenerator
-	targetAddress       string
-	requestsPerSecond   float64
-	dialTimeout         time.Duration
+	concurrency       uint
+	connections       uint
+	totalRequests     uint
+	payloadGenerator  payload.PayloadGenerator
+	targetAddress     string
+	requestsPerSecond float64
+	dialTimeout       time.Duration
 }
 
 // WorkerOptions defines the configuration options for a running Worker.
 type WorkerOptions struct {
 	totalRequests          uint
-	payloadGenerationFn    PayloadGenerator
+	payloadGenerator       payload.PayloadGenerator
 	targetAddress          string
 	requestsPerSecond      float64
 	stopChannel            chan struct{}
@@ -36,14 +34,14 @@ type WorkerOptions struct {
 func NewGroupOptions(
 	concurrency uint,
 	totalRequests uint,
-	payloadGenerationFn PayloadGenerator,
+	payloadGenerator payload.PayloadGenerator,
 	targetAddress string,
 ) GroupOptions {
 	return NewGroupOptionsFullyLoaded(
 		concurrency,
 		1,
 		totalRequests,
-		payloadGenerationFn,
+		payloadGenerator,
 		targetAddress,
 		0.0,
 		dialTimeout,
@@ -55,14 +53,14 @@ func NewGroupOptionsWithConnections(
 	concurrency uint,
 	connections uint,
 	totalRequests uint,
-	payloadGenerationFn PayloadGenerator,
+	payloadGenerator payload.PayloadGenerator,
 	targetAddress string,
 ) GroupOptions {
 	return NewGroupOptionsFullyLoaded(
 		concurrency,
 		connections,
 		totalRequests,
-		payloadGenerationFn,
+		payloadGenerator,
 		targetAddress,
 		0.0,
 		dialTimeout,
@@ -74,19 +72,19 @@ func NewGroupOptionsFullyLoaded(
 	concurrency uint,
 	connections uint,
 	totalRequests uint,
-	payloadGenerationFn PayloadGenerator,
+	payloadGenerator payload.PayloadGenerator,
 	targetAddress string,
 	requestsPerSecond float64,
 	dialTimeout time.Duration,
 ) GroupOptions {
 	return GroupOptions{
-		concurrency:         concurrency,
-		connections:         connections,
-		totalRequests:       totalRequests,
-		payloadGenerationFn: payloadGenerationFn,
-		targetAddress:       targetAddress,
-		requestsPerSecond:   requestsPerSecond,
-		dialTimeout:         dialTimeout,
+		concurrency:       concurrency,
+		connections:       connections,
+		totalRequests:     totalRequests,
+		payloadGenerator:  payloadGenerator,
+		targetAddress:     targetAddress,
+		requestsPerSecond: requestsPerSecond,
+		dialTimeout:       dialTimeout,
 	}
 }
 

workers/worker.go

@@ -63,7 +63,7 @@ func (worker Worker) sendRequest() {
 		_ = recover()
 	}()
 	if worker.connection != nil {
-		payload := worker.options.payloadGenerationFn(1) //TODO: Generate request id
+		payload := worker.options.payloadGenerator.Generate(1) //TODO: Generate request id
 		_, err := worker.connection.Write(payload)
 
 		worker.options.loadGenerationResponse <- report.LoadGenerationResponse{

workers/worker_group.go

@@ -146,7 +146,7 @@ func (group *WorkerGroup) runWorker(
 		connectionId: connectionId,
 		options: WorkerOptions{
 			totalRequests:          totalRequests / group.options.concurrency,
-			payloadGenerationFn:    group.options.payloadGenerationFn,
+			payloadGenerator:       group.options.payloadGenerator,
 			targetAddress:          group.options.targetAddress,
 			requestsPerSecond:      group.options.requestsPerSecond,
 			stopChannel:            group.stopChannel,

workers/worker_test.go

@@ -29,7 +29,7 @@ func TestWritesPayloadByWorker(t *testing.T) {
 		connection: &BytesWriteCloser{bufio.NewWriter(&buffer)},
 		options: WorkerOptions{
 			totalRequests:          uint(1),
-			payloadGenerationFn:    payload.NewConstantPayloadGenerator([]byte("payload")).Generate,
+			payloadGenerator:       payload.NewConstantPayloadGenerator([]byte("payload")),
 			loadGenerationResponse: loadGenerationResponse,
 		},
 	}
@@ -55,7 +55,7 @@ func TestWritesMultiplePayloadsByWorker(t *testing.T) {
 		connection: &BytesWriteCloser{bufio.NewWriter(&buffer)},
 		options: WorkerOptions{
 			totalRequests:          totalRequests,
-			payloadGenerationFn:    payload.NewConstantPayloadGenerator([]byte("payload")).Generate,
+			payloadGenerator:       payload.NewConstantPayloadGenerator([]byte("payload")),
 			loadGenerationResponse: loadGenerationResponse,
 		},
 	}
@@ -82,7 +82,7 @@ func TestWritesMultiplePayloadsByWorkerWithThrottle(t *testing.T) {
 		connection: &BytesWriteCloser{bufio.NewWriter(&buffer)},
 		options: WorkerOptions{
 			totalRequests:          totalRequests,
-			payloadGenerationFn:    payload.NewConstantPayloadGenerator([]byte("payload")).Generate,
+			payloadGenerator:       payload.NewConstantPayloadGenerator([]byte("payload")),
 			loadGenerationResponse: loadGenerationResponse,
 			requestsPerSecond:      float64(3),
 		},
@@ -109,7 +109,7 @@ func TestWritesOnANilConnectionWithConnectionId(t *testing.T) {
 		connection: nil,
 		options: WorkerOptions{
 			totalRequests:          totalRequests,
-			payloadGenerationFn:    payload.NewConstantPayloadGenerator([]byte("payload")).Generate,
+			payloadGenerator:       payload.NewConstantPayloadGenerator([]byte("payload")),
 			loadGenerationResponse: loadGenerationResponse,
 		},
 	}
@@ -137,7 +137,7 @@ func TestWritesPayloadByWorkerWithConnectionId(t *testing.T) {
 		connectionId: 10,
 		options: WorkerOptions{
 			totalRequests:          uint(1),
-			payloadGenerationFn:    payload.NewConstantPayloadGenerator([]byte("payload")).Generate,
+			payloadGenerator:       payload.NewConstantPayloadGenerator([]byte("payload")),
 			loadGenerationResponse: loadGenerationResponse,
 		},
 	}