reflect metadata simpler format and docs

e32c147aa6e274c81a60a9bd344a947d3c907c2b

.mapping.json

@@ -1,8 +1,6 @@
 {
   ".changes/header.tpl.md":"load/projects/pandora/.changes/header.tpl.md",
   ".changes/unreleased/.gitkeep":"load/projects/pandora/.changes/unreleased/.gitkeep",
-  ".changes/unreleased/Added-20240517-144818.yaml":"load/projects/pandora/.changes/unreleased/Added-20240517-144818.yaml",
-  ".changes/unreleased/Added-20240517-144851.yaml":"load/projects/pandora/.changes/unreleased/Added-20240517-144851.yaml",
   ".changes/v0.5.04.md":"load/projects/pandora/.changes/v0.5.04.md",
   ".changes/v0.5.05.md":"load/projects/pandora/.changes/v0.5.05.md",
   ".changes/v0.5.06.md":"load/projects/pandora/.changes/v0.5.06.md",

CHANGELOG.md

@@ -6,6 +6,13 @@ adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html),
 and is generated by [Changie](https://github.com/miniscruff/changie).
 
 
+## v0.5.26 - 2024-05-21
+### Added
+* scenario config local block in yaml
+* scenario config local block documentation
+### Changed
+* reflect metadata simpler format and docs
+
 ## v0.5.25 - 2024-05-16
 ### Fixed
 * randInt function without args in preprocessor

cli/cli.go

@@ -25,7 +25,7 @@ import (
 	"go.uber.org/zap/zapcore"
 )
 
-const Version = "0.5.25"
+const Version = "0.5.26"
 const defaultConfigFile = "load"
 const stdinConfigSelector = "-"
 

components/guns/grpc/core.go

@@ -43,13 +43,13 @@ type GrpcDialOptions struct {
 }
 
 type GunConfig struct {
-	Target          string          `validate:"required"`
-	ReflectPort     int64           `config:"reflect_port"`
-	ReflectMetadata metadata.MD     `config:"reflect_metadata"`
-	Timeout         time.Duration   `config:"timeout"` // grpc request timeout
-	TLS             bool            `config:"tls"`
-	DialOptions     GrpcDialOptions `config:"dial_options"`
-	AnswLog         AnswLogConfig   `config:"answlog"`
+	Target          string            `validate:"required"`
+	ReflectPort     int64             `config:"reflect_port"`
+	ReflectMetadata map[string]string `config:"reflect_metadata"`
+	Timeout         time.Duration     `config:"timeout"` // grpc request timeout
+	TLS             bool              `config:"tls"`
+	DialOptions     GrpcDialOptions   `config:"dial_options"`
+	AnswLog         AnswLogConfig     `config:"answlog"`
 	SharedClient    struct {
 		ClientNumber int  `config:"client-number,omitempty"`
 		Enabled      bool `config:"enabled"`
@@ -111,7 +111,7 @@ func (g *Gun) prepareMethodList(opts *warmup.Options) (map[string]desc.MethodDes
 	}
 	defer conn.Close()
 
-	refCtx := metadata.NewOutgoingContext(context.Background(), g.Conf.ReflectMetadata)
+	refCtx := metadata.NewOutgoingContext(context.Background(), metadata.New(g.Conf.ReflectMetadata))
 	refClient := grpcreflect.NewClientAuto(refCtx, conn)
 	listServices, err := refClient.ListServices()
 	if err != nil {

components/guns/grpc/scenario/core.go

@@ -21,13 +21,13 @@ import (
 const defaultTimeout = time.Second * 15
 
 type GunConfig struct {
-	Target          string          `validate:"required"`
-	ReflectPort     int64           `config:"reflect_port"`
-	ReflectMetadata metadata.MD     `config:"reflect_metadata"`
-	Timeout         time.Duration   `config:"timeout"` // grpc request timeout
-	TLS             bool            `config:"tls"`
-	DialOptions     GrpcDialOptions `config:"dial_options"`
-	AnswLog         AnswLogConfig   `config:"answlog"`
+	Target          string            `validate:"required"`
+	ReflectPort     int64             `config:"reflect_port"`
+	ReflectMetadata map[string]string `config:"reflect_metadata"`
+	Timeout         time.Duration     `config:"timeout"` // grpc request timeout
+	TLS             bool              `config:"tls"`
+	DialOptions     GrpcDialOptions   `config:"dial_options"`
+	AnswLog         AnswLogConfig     `config:"answlog"`
 }
 
 type GrpcDialOptions struct {

docs/eng/grpc-generator.md

@@ -12,6 +12,9 @@ gun:
   target: '[hostname]:443'
   timeout: 15s              # Grpc request timeout. Default: 15s
   tls: false                # If true, Pandora accepts any certificate presented by the server and any host name in that certificate. Default: false
+  reflect_port: 8000        # If your reflection service is located on a port other than the main server
+  reflect_metadata:         # Separate metadata data for reflection service
+    auth: Token
   shared-client:
     enabled: false          # If TRUE, the generator will use a common transport client for all instances
     client-number: 1        # The number of shared clients can be increased. The default is 1
@@ -53,6 +56,7 @@ But to unify reports it converts them into HTTP codes.
 
 # References
 
+- [Scenario generator / gRPC](scenario-grpc-generator.md)
 - Best practices
   - [RPS per instance](best_practices/rps-per-instance.md)
   - [Shared client](best_practices/shared-client.md)

docs/rus/grpc-generator.md

@@ -12,6 +12,9 @@ gun:
   target: '[hostname]:443'
   timeout: 15s              # Таймаут для запросов gRPC. По умолчанию: 15s
   tls: false                # Если true, Pandora принимает любой сертификат, представленный сервером, и любое имя хоста в этом сертификате. По умолчанию: false
+  reflect_port: 8000        # Если ваш рефлекшн сервис находится на отличном от основного сервера порту
+  reflect_metadata:         # Отдельные metadata данные для рефлекшн сервис
+    auth: Token
   shared-client:
     enabled: true           # Если TRUE, генератор будет использовать общий транспортный клиент для всех инстансов
     client-number: 1        # Количество общих клиентов можно увеличить. По умолчанию 1
@@ -53,6 +56,7 @@ gun:
 
 # Смотри так же
 
+- [Сценарный генератор / gRPC](scenario-grpc-generator.md)
 - Практики использования
   - [RPS на инстанс](best_practices/rps-per-instance.md)
   - [Общий транспорт](best_practices/shared-client.md)

tests/acceptance/config_model.go

@@ -1,7 +1,5 @@
 package acceptance
 
-import "google.golang.org/grpc/metadata"
-
 type PandoraConfigLog struct {
 	Level string `yaml:"level"`
 }
@@ -13,11 +11,11 @@ type PandoraConfigMonitoring struct {
 	ExpVar PandoraConfigMonitoringExpVar `yaml:"expvar"`
 }
 type PandoraConfigGRPCGun struct {
-	Type            string       `yaml:"type"`
-	Target          string       `yaml:"target"`
-	TLS             bool         `yaml:"tls"`
-	ReflectPort     *int64       `yaml:"reflect_port,omitempty"`
-	ReflectMetadata *metadata.MD `yaml:"reflect_metadata,omitempty"`
+	Type            string            `yaml:"type"`
+	Target          string            `yaml:"target"`
+	TLS             bool              `yaml:"tls"`
+	ReflectPort     *int64            `yaml:"reflect_port,omitempty"`
+	ReflectMetadata map[string]string `yaml:"reflect_metadata,omitempty"`
 	SharedClient    struct {
 		ClientNumber int  `yaml:"client-number,omitempty"`
 		Enabled      bool `yaml:"enabled"`

tests/acceptance/grpc_test.go

@@ -165,8 +165,7 @@ func TestCheckGRPCReflectServer(t *testing.T) {
 			{
 				name: "success",
 				conf: parseFileContentToCliConfig(t, baseFile, func(c *PandoraConfigGRPC) {
-					md := metadata.New(map[string]string{metadataKey: metadataValue})
-					c.Pools[0].Gun.ReflectMetadata = &md
+					c.Pools[0].Gun.ReflectMetadata = map[string]string{metadataKey: metadataValue}
 				}),
 			},
 			{
@@ -177,8 +176,7 @@ func TestCheckGRPCReflectServer(t *testing.T) {
 			{
 				name: "wrong metadata value",
 				conf: parseFileContentToCliConfig(t, baseFile, func(c *PandoraConfigGRPC) {
-					md := metadata.New(map[string]string{metadataKey: "wrong-value"})
-					c.Pools[0].Gun.ReflectMetadata = &md
+					c.Pools[0].Gun.ReflectMetadata = map[string]string{metadataKey: "wrong-value"}
 				}),
 				err: wrongMDValueError,
 			},

tests/acceptance/testdata/grpc/base.yaml

@@ -5,6 +5,8 @@ pools:
       target: localhost:18888
       tls: false
       use-shared-client: false
+      reflect_metadata:
+        auth: Token
     ammo:
       type: grpc/json
       file: testdata/grpc/grpc.payload