Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add option to NewGocannon to support plugins in library integrations #83

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 19 additions & 3 deletions lib/gocannon.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,19 +15,35 @@ type Gocannon struct {
plugin common.GocannonPlugin
}

// Option updates a Gocannon
type Option func(*Gocannon)

// WithPlugin defines the plugin to be used by Gocannon
func WithPlugin(plugin common.GocannonPlugin) Option {
return func(gc *Gocannon) {
gc.plugin = plugin
}
}

// NewGocannon creates a new gocannon instance using a provided config.
func NewGocannon(cfg common.Config) (Gocannon, error) {
func NewGocannon(cfg common.Config, opts ...Option) (Gocannon, error) {
var err error

gocannon := Gocannon{cfg: cfg}

if *cfg.Plugin != "" {
for _, o := range opts {
o(&gocannon)
}

if gocannon.plugin == nil && *cfg.Plugin != "" {
gocannonPlugin, err := loadPlugin(*cfg.Plugin, *cfg.Format != "default")
if err != nil {
return gocannon, err
}
gocannon.plugin = gocannonPlugin
gocannonPlugin.Startup(cfg)
}
if gocannon.plugin != nil {
gocannon.plugin.Startup(cfg)
}

c, err := newHTTPClient(*cfg.Target, *cfg.Timeout, *cfg.Connections, *cfg.TrustAll, true)
Expand Down
87 changes: 87 additions & 0 deletions lib/integration_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,12 @@ func TestGocannonDefaultValues(t *testing.T) {

func TestGocanonWithPlugin(t *testing.T) {

if runtime.GOOS == "darwin" && runtime.GOARCH == "arm64" {
t.SkipNow()
} else if runtime.GOOS == "windows" {
t.SkipNow()
}

err := exec.Command("go", "build", "-race", "-buildmode=plugin", "-o", "../_example_plugin/plugin.so", "../_example_plugin/plugin.go").
Run()

Expand Down Expand Up @@ -204,3 +210,84 @@ func TestGocanonWithPlugin(t *testing.T) {
}

}

type TestLibraryPlugin struct {
cfg common.Config
StartupCalled bool
BeforeRequestCalled bool
GetNameCalled bool
}

func (p *TestLibraryPlugin) Startup(cfg common.Config) {
p.cfg = cfg
p.StartupCalled = true
}

func (p *TestLibraryPlugin) BeforeRequest(cid int) (target string, method string, body common.RawRequestBody, headers common.RequestHeaders) {
headers = *p.cfg.Headers
method = *p.cfg.Method
body = *p.cfg.Body
target = *p.cfg.Target
method = *p.cfg.Method
return
}

func (p *TestLibraryPlugin) GetName() string {
return "TestLibraryPlugin"
}

func TestGocanonWithLibraryPlugin(t *testing.T) {
duration := time.Second * 1
connections := 50
cpus := runtime.NumCPU()
timeout := time.Millisecond * 200
mode := "hist"
outputFile := ""
interval := time.Millisecond * 250
preallocate := 1000
method := "GET"
body := common.RawRequestBody{}
header := common.RequestHeaders{}
trustAll := true
format := "json"
plugin := ""
target := "http://localhost:3000/hello"

cfg := common.Config{
Duration: &duration,
Connections: &connections,
CPUs: &cpus,
Timeout: &timeout,
Mode: &mode,
OutputFile: &outputFile,
Interval: &interval,
Preallocate: &preallocate,
Method: &method,
Body: &body,
Headers: &header,
TrustAll: &trustAll,
Format: &format,
Plugin: &plugin,
Target: &target,
}

libplugin := &TestLibraryPlugin{}

g, creationErr := NewGocannon(cfg, WithPlugin(libplugin))

assert.Nil(t, creationErr, "gocannon instance with a plugin should be created without errors")

if creationErr == nil {
results, execErr := g.Run()

assert.Nil(t, execErr, "the load test should be completed without errors")

assert.Greater(
t,
results.GetReqPerSec(),
100.0,
"a throughput of at least 100 req/s should be achieved",
)
}

}