Merge pull request #39 from aykhans/feat/add-proxy-check

Add 'no-proxy-check' parameter

.github/workflows/publish-docker-image.yml

@@ -0,0 +1,86 @@
+name: publish-docker-image
+
+on:
+  push:
+    tags:
+      # Match stable and pre versions, such as 'v1.0.0', 'v0.23.0-a', 'v0.23.0-a.2', 'v0.23.0-b', 'v0.23.0-b.3'
+      - "v*.*.*"
+      - "v*.*.*-a"
+      - "v*.*.*-a.*"
+      - "v*.*.*-b"
+      - "v*.*.*-b.*"
+
+jobs:
+  build-and-push-stable-image:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+
+      - name: Extract build args
+        # Extract version number and check if it's an pre version
+        run: |
+          if [[ "${GITHUB_REF_NAME}" =~ ^v[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
+              echo "PRE_RELEASE=false" >> $GITHUB_ENV
+          else
+              echo "PRE_RELEASE=true" >> $GITHUB_ENV
+          fi
+          echo "VERSION=${GITHUB_REF_NAME#v}" >> $GITHUB_ENV
+
+      - name: Login to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          username: aykhans
+          password: ${{ secrets.DOCKER_TOKEN }}
+
+      - name: Set up Docker Buildx
+        id: buildx
+        uses: docker/setup-buildx-action@v3
+        with:
+          install: true
+          version: v0.9.1
+
+      # Metadata for stable versions
+      - name: Docker meta for stable
+        id: meta-stable
+        if: env.PRE_RELEASE == 'false'
+        uses: docker/metadata-action@v5
+        with:
+          images: |
+            aykhans/dodo
+          tags: |
+            type=semver,pattern={{version}},value=${{ env.VERSION }}
+            type=raw,value=stable
+          flavor: |
+            latest=true
+          labels: |
+            org.opencontainers.image.version=${{ env.VERSION }}
+
+      # Metadata for pre versions
+      - name: Docker meta for pre
+        id: meta-pre
+        if: env.PRE_RELEASE == 'true'
+        uses: docker/metadata-action@v5
+        with:
+          images: |
+            aykhans/dodo
+          tags: |
+            type=raw,value=${{ env.VERSION }}
+          labels: |
+            org.opencontainers.image.version=${{ env.VERSION }}
+
+      - name: Build and Push
+        id: docker_build
+        uses: docker/build-push-action@v6
+        with:
+          context: ./
+          file: ./Dockerfile
+          platforms: linux/amd64,linux/arm64
+          push: true
+          tags: ${{ steps.meta-stable.outputs.tags || steps.meta-pre.outputs.tags }}
+          labels: ${{ steps.meta-stable.outputs.labels || steps.meta-pre.outputs.labels }}

Dockerfile

@@ -1,4 +1,4 @@
-FROM golang:1.22.6-alpine AS builder
+FROM golang:1.23.2-alpine AS builder
 
 WORKDIR /dodo
 

README.md

@@ -1,6 +1,6 @@
 <h1 align="center">Dodo is a simple and easy-to-use HTTP benchmarking tool.</h1>
 <p align="center">
-<img width="30%" height="30%" src="https://raw.githubusercontent.com/aykhans/dodo/main/assets/dodo.png">
+<img width="30%" height="30%" src="https://ftp.aykhans.me/web/client/pubshares/hB6VSdCnBCr8gFPeiMuCji/browse?path=%2Fdodo.png">
 </p>
 
 ## Installation

config.json

@@ -1,7 +1,7 @@
 {
     "method": "GET",
     "url": "https://example.com",
-    "no_proxy_check": false,
+    "no_proxy_check": true,
     "timeout": 10000,
     "dodos_count": 50,
     "request_count": 1000,

config/config.go

@@ -21,10 +21,6 @@ const (
 	MaxDodosCountForProxies uint   = 20 // Max dodos count for proxy check
 )
 
-type IConfig interface {
-	MergeConfigs(newConfig IConfig) IConfig
-}
-
 type RequestConfig struct {
 	Method       string
 	URL          *url.URL
@@ -48,6 +44,12 @@ func (config *RequestConfig) Print() {
 		{Number: 2, WidthMax: 50},
 	})
 
+	newHeaders := make(map[string][]string)
+	newHeaders["User-Agent"] = []string{DefaultUserAgent}
+	for k, v := range config.Headers {
+		newHeaders[k] = v
+	}
+
 	t.AppendHeader(table.Row{"Request Configuration"})
 	t.AppendRow(table.Row{"Method", config.Method})
 	t.AppendSeparator()
@@ -57,11 +59,11 @@ func (config *RequestConfig) Print() {
 	t.AppendSeparator()
 	t.AppendRow(table.Row{"Dodos", config.DodosCount})
 	t.AppendSeparator()
-	t.AppendRow(table.Row{"Request", config.RequestCount})
+	t.AppendRow(table.Row{"Requests", config.RequestCount})
 	t.AppendSeparator()
 	t.AppendRow(table.Row{"Params", utils.MarshalJSON(config.Params, 3)})
 	t.AppendSeparator()
-	t.AppendRow(table.Row{"Headers", utils.MarshalJSON(config.Headers, 3)})
+	t.AppendRow(table.Row{"Headers", utils.MarshalJSON(newHeaders, 3)})
 	t.AppendSeparator()
 	t.AppendRow(table.Row{"Cookies", utils.MarshalJSON(config.Cookies, 3)})
 	t.AppendSeparator()
@@ -90,12 +92,32 @@ func (config *RequestConfig) GetMaxConns(minConns uint) uint {
 }
 
 type Config struct {
-	Method       string              `json:"method" validate:"http_method"` // custom validations: http_method
-	URL          string              `json:"url" validate:"http_url,required"`
-	Timeout      uint32              `json:"timeout" validate:"gte=1,lte=100000"`
-	DodosCount   uint                `json:"dodos_count" validate:"gte=1"`
-	RequestCount uint                `json:"request_count" validation_name:"request-count" validate:"gte=1"`
-	NoProxyCheck utils.IOption[bool] `json:"no_proxy_check"`
+	Method       string             `json:"method" validate:"http_method"` // custom validations: http_method
+	URL          string             `json:"url" validate:"http_url,required"`
+	Timeout      uint32             `json:"timeout" validate:"gte=1,lte=100000"`
+	DodosCount   uint               `json:"dodos_count" validate:"gte=1"`
+	RequestCount uint               `json:"request_count" validation_name:"request-count" validate:"gte=1"`
+	NoProxyCheck utils.Option[bool] `json:"no_proxy_check"`
+}
+
+func NewConfig(
+	method string,
+	timeout uint32,
+	dodosCount uint,
+	requestCount uint,
+	noProxyCheck utils.Option[bool],
+) *Config {
+	if noProxyCheck == nil {
+		noProxyCheck = utils.NewNoneOption[bool]()
+	}
+
+	return &Config{
+		Method:       method,
+		Timeout:      timeout,
+		DodosCount:   dodosCount,
+		RequestCount: requestCount,
+		NoProxyCheck: noProxyCheck,
+	}
 }
 
 func (config *Config) MergeConfigs(newConfig *Config) {
@@ -144,7 +166,7 @@ type Proxy struct {
 }
 
 type JSONConfig struct {
-	Config
+	*Config
 	Params  map[string][]string `json:"params"`
 	Headers map[string][]string `json:"headers"`
 	Cookies map[string][]string `json:"cookies"`
@@ -152,8 +174,21 @@ type JSONConfig struct {
 	Body    []string            `json:"body"`
 }
 
+func NewJSONConfig(
+	config *Config,
+	params map[string][]string,
+	headers map[string][]string,
+	cookies map[string][]string,
+	proxies []Proxy,
+	body []string,
+) *JSONConfig {
+	return &JSONConfig{
+		config, params, headers, cookies, proxies, body,
+	}
+}
+
 func (config *JSONConfig) MergeConfigs(newConfig *JSONConfig) {
-	config.Config.MergeConfigs(&newConfig.Config)
+	config.Config.MergeConfigs(newConfig.Config)
 	if len(newConfig.Params) != 0 {
 		config.Params = newConfig.Params
 	}
@@ -172,13 +207,23 @@ func (config *JSONConfig) MergeConfigs(newConfig *JSONConfig) {
 }
 
 type CLIConfig struct {
-	Config
+	*Config
 	Yes        bool   `json:"yes" validate:"omitempty"`
 	ConfigFile string `validation_name:"config-file" validate:"omitempty,filepath"`
 }
 
+func NewCLIConfig(
+	config *Config,
+	yes bool,
+	configFile string,
+) *CLIConfig {
+	return &CLIConfig{
+		config, yes, configFile,
+	}
+}
+
 func (config *CLIConfig) MergeConfigs(newConfig *CLIConfig) {
-	config.Config.MergeConfigs(&newConfig.Config)
+	config.Config.MergeConfigs(newConfig.Config)
 	if newConfig.ConfigFile != "" {
 		config.ConfigFile = newConfig.ConfigFile
 	}

go.mod

@@ -1,6 +1,6 @@
 module github.com/aykhans/dodo
 
-go 1.22.6
+go 1.23.2
 
 require (
 	github.com/go-playground/validator/v10 v10.23.0

main.go

@@ -21,8 +21,10 @@ import (
 
 func main() {
 	validator := validation.NewValidator()
-	conf := config.Config{}
-	jsonConf := config.JSONConfig{}
+	conf := config.NewConfig("", 0, 0, 0, nil)
+	jsonConf := config.NewJSONConfig(
+		config.NewConfig("", 0, 0, 0, nil), nil, nil, nil, nil, nil,
+	)
 
 	cliConf, err := readers.CLIConfigReader()
 	if err != nil || cliConf == nil {
@@ -51,11 +53,11 @@ func main() {
 				),
 			)
 		}
-		jsonConf = *jsonConfNew
-		conf.MergeConfigs(&jsonConf.Config)
+		jsonConf = jsonConfNew
+		conf.MergeConfigs(jsonConf.Config)
 	}
 
-	conf.MergeConfigs(&cliConf.Config)
+	conf.MergeConfigs(cliConf.Config)
 	conf.SetDefaults()
 	if err := validator.Struct(conf); err != nil {
 		utils.PrintErrAndExit(
@@ -81,7 +83,7 @@ func main() {
 		Proxies:      jsonConf.Proxies,
 		Body:         jsonConf.Body,
 		Yes:          cliConf.Yes,
-		NoProxyCheck: *conf.NoProxyCheck.ValueOrPanic(),
+		NoProxyCheck: conf.NoProxyCheck.ValueOrPanic(),
 	}
 	requestConf.Print()
 	if !cliConf.Yes {

readers/cli.go

@@ -12,12 +12,8 @@ import (
 
 func CLIConfigReader() (*config.CLIConfig, error) {
 	var (
-		returnNil = false
-		cliConfig = &config.CLIConfig{
-			Config: config.Config{
-				NoProxyCheck: utils.NewNoneOption[bool](),
-			},
-		}
+		returnNil    = false
+		cliConfig    = config.NewCLIConfig(config.NewConfig("", 0, 0, 0, nil), false, "")
 		dodosCount   uint
 		requestCount uint
 		timeout      uint32

readers/json.go

@@ -6,7 +6,6 @@ import (
 
 	"github.com/aykhans/dodo/config"
 	customerrors "github.com/aykhans/dodo/custom_errors"
-	"github.com/aykhans/dodo/utils"
 )
 
 func JSONConfigReader(filePath string) (*config.JSONConfig, error) {
@@ -14,11 +13,10 @@ func JSONConfigReader(filePath string) (*config.JSONConfig, error) {
 	if err != nil {
 		return nil, customerrors.OSErrorFormater(err)
 	}
-	jsonConf := &config.JSONConfig{
-		Config: config.Config{
-			NoProxyCheck: utils.NewNoneOption[bool](),
-		},
-	}
+	jsonConf := config.NewJSONConfig(
+		config.NewConfig("", 0, 0, 0, nil),
+		nil, nil, nil, nil, nil,
+	)
 	err = json.Unmarshal(data, &jsonConf)
 
 	if err != nil {

utils/types.go

@@ -5,20 +5,20 @@ import (
 	"errors"
 )
 
-type NonNilConcrete interface {
-    ~int | ~float64 | ~string | ~bool
+type NonNilT interface {
+	~int | ~float64 | ~string | ~bool
 }
 
-type IOption[T NonNilConcrete] interface {
+type Option[T NonNilT] interface {
 	IsNone() bool
-	ValueOrErr() (*T, error)
-	ValueOr(def *T) *T
-	ValueOrPanic() *T
+	ValueOrErr() (T, error)
+	ValueOr(def T) T
+	ValueOrPanic() T
 	UnmarshalJSON(data []byte) error
 }
 
 // Don't call this struct directly, use NewOption[T] or NewNoneOption[T] instead.
-type option[T NonNilConcrete] struct {
+type option[T NonNilT] struct {
 	// value holds the actual value of the Option if it is not None.
 	value T
 	// none indicates whether the Option is None (i.e., has no value).
@@ -29,43 +29,59 @@ func (o *option[T]) IsNone() bool {
 	return o.none
 }
 
-// The returned value can be nil, if the Option is None, it will return nil and an error.
-func (o *option[T]) ValueOrErr() (*T, error) {
+// If the Option is None, it will return zero value of the type and an error.
+func (o *option[T]) ValueOrErr() (T, error) {
 	if o.IsNone() {
-		return nil, errors.New("Option is None")
+		return o.value, errors.New("Option is None")
 	}
-	return &o.value, nil
+	return o.value, nil
 }
 
-// The returned value can't be nil, if the Option is None, it will return the default value.
-func (o *option[T]) ValueOr(def *T) *T {
+// If the Option is None, it will return the default value.
+func (o *option[T]) ValueOr(def T) T {
 	if o.IsNone() {
 		return def
 	}
-	return &o.value
+	return o.value
 }
 
-// The returned value can't be nil, if the Option is None, it will panic.
-func (o *option[T]) ValueOrPanic() *T {
+// If the Option is None, it will panic.
+func (o *option[T]) ValueOrPanic() T {
 	if o.IsNone() {
 		panic("Option is None")
 	}
-	return &o.value
+	return o.value
+}
+
+func (o *option[T]) SetValue(value T) {
+	o.value = value
+	o.none = false
+}
+
+func (o *option[T]) SetNone() {
+	var zeroValue T
+	o.value = zeroValue
+	o.none = true
 }
 
 func (o *option[T]) UnmarshalJSON(data []byte) error {
-	if string(data) == "null" {
-		o.none = true
+	if string(data) == "null" || len(data) == 0 {
+		o.SetNone()
 		return nil
 	}
+
+	if err := json.Unmarshal(data, &o.value); err != nil {
+		o.SetNone()
+		return err
+	}
 	o.none = false
-	return json.Unmarshal(data, &o.value)
+	return nil
 }
 
-func NewOption[T NonNilConcrete](value T) *option[T] {
+func NewOption[T NonNilT](value T) *option[T] {
 	return &option[T]{value: value}
 }
 
-func NewNoneOption[T NonNilConcrete]() *option[T] {
+func NewNoneOption[T NonNilT]() *option[T] {
 	return &option[T]{none: true}
 }