Merge pull request #67 from ddosify/default_values

Default values

.github/workflows/coverage.yml

@@ -16,7 +16,7 @@ jobs:
     - name: Set up Go
       uses: actions/setup-go@v2
       with:
-        go-version: 1.17.x
+        go-version: 1.18.x
 
     - name: Test
       run: go test -coverpkg=./... -coverprofile=coverage.txt -parallel 1 -covermode=atomic -short ./... && go tool cover -func coverage.txt

.github/workflows/release.yml

@@ -29,7 +29,7 @@ jobs:
         name: Set up Go
         uses: actions/setup-go@v2
         with:
-          go-version: 1.17
+          go-version: 1.18
       -
         name: Docker Hub Login
         uses: docker/login-action@v1

.github/workflows/test.yml

@@ -11,7 +11,7 @@ jobs:
   test:
     strategy:
       matrix:
-        go-version: [1.15.x, 1.16.x, 1.17.x]
+        go-version: [1.15.x, 1.16.x, 1.17.x, 1.18.x]
         os: [ubuntu-latest, macos-latest, windows-latest]
     runs-on: ${{ matrix.os }}
     steps:

Dockerfile

@@ -1,4 +1,4 @@
-FROM golang:1.17-alpine as builder
+FROM golang:1.18.1-alpine as builder
 WORKDIR /app
 COPY . ./
 RUN go mod download

Dockerfile.dev

@@ -1,20 +1,19 @@
-FROM golang:1.17.1
+FROM golang:1.18.1
 
-RUN apt update && apt install -y git gcc musl-dev curl iputils-ping telnet && rm -rf /var/lib/apt/lists/*
+RUN apt update && apt install -y git gcc musl-dev curl iputils-ping telnet graphviz && rm -rf /var/lib/apt/lists/*
 
 ENV GOPATH /go
 ENV GOBIN /go/bin
 
 WORKDIR /workspace
 
-RUN curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin v1.42.0
+RUN curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin v1.45.2
 
-RUN go get -v golang.org/x/tools/[email protected]
-RUN go get -v github.com/rogpeppe/[email protected]
-RUN go get -v github.com/rakyll/[email protected]
-RUN go get -v github.com/cweill/[email protected]
-RUN go get -v github.com/ramya-rao-a/[email protected]
-RUN go get -v github.com/go-delve/delve/cmd/[email protected]
+RUN go install -v golang.org/x/tools/[email protected]
+RUN go install -v github.com/rogpeppe/[email protected]
+RUN go install -v github.com/rakyll/[email protected]
+RUN go install -v github.com/ramya-rao-a/[email protected]
+RUN go install -v github.com/go-delve/delve/cmd/[email protected]
 
 COPY go.mod ./
 COPY go.sum ./

README.md

@@ -388,7 +388,7 @@ There is an example config file at [config_examples/config.json](/config_example
 
         ```json
         "others": {
-            "keep-alive": true,              // Default false
+            "keep-alive": true,              // Default true
             "disable-compression": false,    // Default true
             "h2": true,                      // Enables HTTP/2. Default false.
             "disable-redirect": true         // Default false

core/engine.go

@@ -181,6 +181,7 @@ func (e *engine) stop() {
 	<-e.reportService.DoneChan()
 	e.reportService.Report()
 	e.proxyService.Done()
+	e.scenarioService.Done()
 }
 
 func (e *engine) initReqCountArr() {

core/scenario/requester/base.go

@@ -34,6 +34,7 @@ import (
 type Requester interface {
 	Init(context.Context, types.ScenarioItem, *url.URL) error
 	Send() *types.ResponseItem
+	Done()
 }
 
 // NewRequester is the factory method of the Requester.

core/scenario/requester/http.go

@@ -78,6 +78,14 @@ func (h *HttpRequester) Init(ctx context.Context, s types.ScenarioItem, proxyAdd
 	return
 }
 
+func (h *HttpRequester) Done() {
+	// MaxIdleConnsPerHost and MaxIdleConns at Transport layer configuration
+	// let us reuse the connections when keep-alive enabled(default)
+	// When the Job is finished, we have to Close idle connections to prevent sockets to lock in at the TIME_WAIT state.
+	// Otherwise, the next job can't use these sockets because they are reserved for the current target host.
+	h.client.CloseIdleConnections()
+}
+
 func (h *HttpRequester) Send() (res *types.ResponseItem) {
 	var statusCode int
 	var contentLength int64
@@ -105,10 +113,12 @@ func (h *HttpRequester) Send() (res *types.ResponseItem) {
 	} else {
 		contentLength = httpRes.ContentLength
 		statusCode = httpRes.StatusCode
+	}
 
-		// From the DOC: If the Body is not both read to EOF and closed,
-		// the Client's underlying RoundTripper (typically Transport)
-		// may not be able to re-use a persistent TCP connection to the server for a subsequent "keep-alive" request.
+	// From the DOC: If the Body is not both read to EOF and closed,
+	// the Client's underlying RoundTripper (typically Transport)
+	// may not be able to re-use a persistent TCP connection to the server for a subsequent "keep-alive" request.
+	if httpRes != nil {
 		io.Copy(ioutil.Discard, httpRes.Body)
 		httpRes.Body.Close()
 	}
@@ -178,12 +188,13 @@ func fetchErrType(err string) types.RequestError {
 
 func (h *HttpRequester) initTransport(tlsConfig *tls.Config) *http.Transport {
 	tr := &http.Transport{
-		TLSClientConfig: tlsConfig,
-		Proxy:           http.ProxyURL(h.proxyAddr),
-		// MaxIdleConnsPerHost: 100, TODO: Let's think about this.
+		TLSClientConfig:     tlsConfig,
+		Proxy:               http.ProxyURL(h.proxyAddr),
+		MaxIdleConnsPerHost: 60000,
+		MaxIdleConns:        0,
 	}
 
-	tr.DisableKeepAlives = true
+	tr.DisableKeepAlives = false
 	if val, ok := h.packet.Custom["keep-alive"]; ok {
 		tr.DisableKeepAlives = !val.(bool)
 	}
@@ -233,11 +244,9 @@ func (h *HttpRequester) initRequestInstance() (err error) {
 	}
 
 	// If keep-alive is false, prevent the reuse of the previous TCP connection at the request layer also.
-	h.request.Close = true
+	h.request.Close = false
 	if val, ok := h.packet.Custom["keep-alive"]; ok {
-		if val.(bool) {
-			h.request.Close = false
-		}
+		h.request.Close = !val.(bool)
 	}
 	return
 }

core/scenario/requester/http_test.go

@@ -77,7 +77,7 @@ func TestInitClient(t *testing.T) {
 	expectedTr := &http.Transport{
 		TLSClientConfig:   expectedTLS,
 		Proxy:             http.ProxyURL(p),
-		DisableKeepAlives: true,
+		DisableKeepAlives: false,
 	}
 	expectedClient := &http.Client{
 		Transport: expectedTr,
@@ -93,7 +93,7 @@ func TestInitClient(t *testing.T) {
 		Timeout:  types.DefaultTimeout,
 		Custom: map[string]interface{}{
 			"disable-redirect":    true,
-			"keep-alive":          true,
+			"keep-alive":          false,
 			"disable-compression": true,
 			"hostname":            "dummy.com",
 		},
@@ -105,7 +105,7 @@ func TestInitClient(t *testing.T) {
 	expectedTrCustomData := &http.Transport{
 		TLSClientConfig:    expectedTLSCustomData,
 		Proxy:              http.ProxyURL(p),
-		DisableKeepAlives:  false,
+		DisableKeepAlives:  true,
 		DisableCompression: true,
 	}
 	expectedClientWithCustomData := &http.Client{
@@ -133,7 +133,7 @@ func TestInitClient(t *testing.T) {
 	expectedTrHTTP2 := &http.Transport{
 		TLSClientConfig:   expectedTLSHTTP2,
 		Proxy:             http.ProxyURL(p),
-		DisableKeepAlives: true,
+		DisableKeepAlives: false,
 	}
 	http2.ConfigureTransport(expectedTrHTTP2)
 	expectedClientHTTP2 := &http.Client{
@@ -226,7 +226,7 @@ func TestInitRequest(t *testing.T) {
 		Payload:  "payloadtest",
 	}
 	expected, _ := http.NewRequest(s.Method, s.URL, bytes.NewBufferString(s.Payload))
-	expected.Close = true
+	expected.Close = false
 	expected.Header = make(http.Header)
 
 	// Request with auth
@@ -242,7 +242,7 @@ func TestInitRequest(t *testing.T) {
 		},
 	}
 	expectedWithAuth, _ := http.NewRequest(sWithAuth.Method, sWithAuth.URL, bytes.NewBufferString(sWithAuth.Payload))
-	expectedWithAuth.Close = true
+	expectedWithAuth.Close = false
 	expectedWithAuth.Header = make(http.Header)
 	expectedWithAuth.SetBasicAuth(sWithAuth.Auth.Username, sWithAuth.Auth.Password)
 
@@ -266,7 +266,7 @@ func TestInitRequest(t *testing.T) {
 	}
 	expectedWithHeaders, _ := http.NewRequest(sWithHeaders.Method,
 		sWithHeaders.URL, bytes.NewBufferString(sWithHeaders.Payload))
-	expectedWithHeaders.Close = true
+	expectedWithHeaders.Close = false
 	expectedWithHeaders.Header = make(http.Header)
 	expectedWithHeaders.Header.Set("Header1", "Value1")
 	expectedWithHeaders.Header.Set("Header2", "Value2")
@@ -275,7 +275,7 @@ func TestInitRequest(t *testing.T) {
 	expectedWithHeaders.SetBasicAuth(sWithHeaders.Auth.Username, sWithHeaders.Auth.Password)
 
 	// Request keep-alive condition
-	sWithKeepAlive := types.ScenarioItem{
+	sWithoutKeepAlive := types.ScenarioItem{
 		ID:       1,
 		Protocol: types.ProtocolHTTPS,
 		Method:   http.MethodGet,
@@ -290,16 +290,16 @@ func TestInitRequest(t *testing.T) {
 			"Header2": "Value2",
 		},
 		Custom: map[string]interface{}{
-			"keep-alive": true,
+			"keep-alive": false,
 		},
 	}
-	expectedWithKeepAlive, _ := http.NewRequest(sWithKeepAlive.Method,
-		sWithKeepAlive.URL, bytes.NewBufferString(sWithKeepAlive.Payload))
-	expectedWithKeepAlive.Close = false
-	expectedWithKeepAlive.Header = make(http.Header)
-	expectedWithKeepAlive.Header.Set("Header1", "Value1")
-	expectedWithKeepAlive.Header.Set("Header2", "Value2")
-	expectedWithKeepAlive.SetBasicAuth(sWithKeepAlive.Auth.Username, sWithKeepAlive.Auth.Password)
+	expectedWithoutKeepAlive, _ := http.NewRequest(sWithoutKeepAlive.Method,
+		sWithoutKeepAlive.URL, bytes.NewBufferString(sWithoutKeepAlive.Payload))
+	expectedWithoutKeepAlive.Close = true
+	expectedWithoutKeepAlive.Header = make(http.Header)
+	expectedWithoutKeepAlive.Header.Set("Header1", "Value1")
+	expectedWithoutKeepAlive.Header.Set("Header2", "Value2")
+	expectedWithoutKeepAlive.SetBasicAuth(sWithoutKeepAlive.Auth.Username, sWithoutKeepAlive.Auth.Password)
 
 	// Sub Tests
 	tests := []struct {
@@ -312,7 +312,7 @@ func TestInitRequest(t *testing.T) {
 		{"Basic", s, false, expected},
 		{"WithAuth", sWithAuth, false, expectedWithAuth},
 		{"WithHeaders", sWithHeaders, false, expectedWithHeaders},
-		{"WithKeepAlive", sWithKeepAlive, false, expectedWithKeepAlive},
+		{"WithoutKeepAlive", sWithoutKeepAlive, false, expectedWithoutKeepAlive},
 	}
 
 	for _, test := range tests {

core/scenario/service.go

@@ -98,6 +98,14 @@ func (s *ScenarioService) Do(proxy *url.URL, startTime time.Time) (response *typ
 	return
 }
 
+func (s *ScenarioService) Done() {
+	for _, v := range s.clients {
+		for _, r := range v {
+			r.requester.Done()
+		}
+	}
+}
+
 func (s *ScenarioService) getOrCreateRequesters(proxy *url.URL) (requesters []scenarioItemRequester, err error) {
 	s.clientMutex.Lock()
 	defer s.clientMutex.Unlock()

core/scenario/service_test.go

@@ -35,6 +35,7 @@ import (
 type MockRequester struct {
 	InitCalled bool
 	SendCalled bool
+	DoneCalled bool
 
 	FailInit    bool
 	FailInitMsg string
@@ -55,6 +56,10 @@ func (m *MockRequester) Send() (res *types.ResponseItem) {
 	return m.ReturnSend
 }
 
+func (m *MockRequester) Done() {
+	m.DoneCalled = true
+}
+
 type MockSleep struct {
 	SleepCalled    bool
 	SleepCallCount int
@@ -409,6 +414,74 @@ func TestDoErrorOnNewRequester(t *testing.T) {
 	}
 }
 
+func TestDone(t *testing.T) {
+	t.Parallel()
+
+	// Arrange
+	scenario := types.Scenario{
+		Scenario: []types.ScenarioItem{
+			{
+				ID:       1,
+				Protocol: types.DefaultProtocol,
+				Method:   types.DefaultMethod,
+				URL:      "test.com",
+				Timeout:  types.DefaultDuration,
+			},
+		},
+	}
+	p1, _ := url.Parse("http://proxy_server.com:80")
+	p2, _ := url.Parse("http://proxy_server.com:8080")
+	ctx := context.TODO()
+
+	requester1 := &MockRequester{ReturnSend: &types.ResponseItem{ScenarioItemID: 1}}
+	requester2 := &MockRequester{ReturnSend: &types.ResponseItem{ScenarioItemID: 2}}
+	requester3 := &MockRequester{ReturnSend: &types.ResponseItem{ScenarioItemID: 1}}
+	requester4 := &MockRequester{ReturnSend: &types.ResponseItem{ScenarioItemID: 2}}
+	service := ScenarioService{
+		clients: map[*url.URL][]scenarioItemRequester{
+			p1: {
+				{
+					scenarioItemID: 1,
+					requester:      requester1,
+				},
+				{
+					scenarioItemID: 2,
+					requester:      requester2,
+				},
+			},
+			p2: {
+				{
+					scenarioItemID: 1,
+					requester:      requester3,
+				},
+				{
+					scenarioItemID: 2,
+					requester:      requester4,
+				},
+			},
+		},
+		scenario: scenario,
+		ctx:      ctx,
+	}
+
+	// Act
+	service.Done()
+
+	// Assert
+	if !requester1.DoneCalled {
+		t.Fatalf("Requester1 Done should be called")
+	}
+	if !requester2.DoneCalled {
+		t.Fatalf("Requester2 Done should be called")
+	}
+	if !requester3.DoneCalled {
+		t.Fatalf("Requester3 Done should be called")
+	}
+	if !requester4.DoneCalled {
+		t.Fatalf("Requester4 Done should be called")
+	}
+}
+
 func TestGetOrCreateRequesters(t *testing.T) {
 	t.Parallel()