Added testutils package

v2/internal/testutils/testutils.go

@@ -0,0 +1,118 @@
+package testutils
+
+import (
+	"github.com/logrusorgru/aurora"
+	"github.com/projectdiscovery/nuclei/v2/internal/progress"
+	"github.com/projectdiscovery/nuclei/v2/pkg/catalogue"
+	"github.com/projectdiscovery/nuclei/v2/pkg/output"
+	"github.com/projectdiscovery/nuclei/v2/pkg/protocols"
+	"github.com/projectdiscovery/nuclei/v2/pkg/protocols/common/protocolinit"
+	"github.com/projectdiscovery/nuclei/v2/pkg/types"
+	"go.uber.org/ratelimit"
+)
+
+// Init initializes the protocols and their configurations
+func Init(options *types.Options) {
+	protocolinit.Init(options)
+}
+
+// DefaultOptions is the default options structure for nuclei during mocking.
+var DefaultOptions = &types.Options{
+	RandomAgent:          false,
+	Metrics:              false,
+	Debug:                false,
+	DebugRequests:        false,
+	DebugResponse:        false,
+	Silent:               false,
+	Version:              false,
+	Verbose:              false,
+	NoColor:              true,
+	UpdateTemplates:      false,
+	JSON:                 false,
+	JSONRequests:         false,
+	EnableProgressBar:    false,
+	TemplatesVersion:     false,
+	TemplateList:         false,
+	Stdin:                false,
+	StopAtFirstMatch:     false,
+	NoMeta:               false,
+	Project:              false,
+	MetricsPort:          0,
+	BulkSize:             25,
+	TemplateThreads:      10,
+	Timeout:              5,
+	Retries:              1,
+	RateLimit:            150,
+	BurpCollaboratorBiid: "",
+	ProjectPath:          "",
+	Severity:             []string{},
+	Target:               "",
+	Targets:              "",
+	Output:               "",
+	ProxyURL:             "",
+	ProxySocksURL:        "",
+	TemplatesDirectory:   "",
+	TraceLogFile:         "",
+	Templates:            []string{},
+	ExcludedTemplates:    []string{},
+	CustomHeaders:        []string{},
+}
+
+// MockOutputWriter is a mocked output writer.
+type MockOutputWriter struct {
+	aurora          aurora.Aurora
+	RequestCallback func(templateID, url, requestType string, err error)
+	WriteCallback   func(o *output.ResultEvent)
+}
+
+// NewMockOutputWriter creates a new mock output writer
+func NewMockOutputWriter() *MockOutputWriter {
+	return &MockOutputWriter{aurora: aurora.NewAurora(false)}
+}
+
+// Close closes the output writer interface
+func (m *MockOutputWriter) Close() {}
+
+// Colorizer returns the colorizer instance for writer
+func (m *MockOutputWriter) Colorizer() aurora.Aurora {
+	return m.aurora
+}
+
+// Write writes the event to file and/or screen.
+func (m *MockOutputWriter) Write(result *output.ResultEvent) error {
+	if m.WriteCallback != nil {
+		m.WriteCallback(result)
+	}
+	return nil
+}
+
+// Request writes a log the requests trace log
+func (m *MockOutputWriter) Request(templateID, url, requestType string, err error) {
+	if m.RequestCallback != nil {
+		m.RequestCallback(templateID, url, requestType, err)
+	}
+}
+
+// TemplateInfo contains info for a mock executed template.
+type TemplateInfo struct {
+	ID   string
+	Info map[string]string
+	Path string
+}
+
+// NewMockExecuterOptions creates a new mock executeroptions struct
+func NewMockExecuterOptions(options *types.Options, info *TemplateInfo) *protocols.ExecuterOptions {
+	progress, _ := progress.NewProgress(false, false, 0)
+	executerOpts := &protocols.ExecuterOptions{
+		TemplateID:   info.ID,
+		TemplateInfo: info.Info,
+		TemplatePath: info.Path,
+		Output:       NewMockOutputWriter(),
+		Options:      options,
+		Progress:     progress,
+		ProjectFile:  nil,
+		Catalogue:    catalogue.New(options.TemplatesDirectory),
+		RateLimiter:  ratelimit.New(options.RateLimit),
+	}
+	return executerOpts
+}