[Refactor] Refactor common code between all benchmark commands #1611
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||
|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,119 @@ | ||||||||
| // Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||||||||
| // or more contributor license agreements. Licensed under the Elastic License; | ||||||||
| // you may not use this file except in compliance with the Elastic License. | ||||||||
|
|
||||||||
| package common | ||||||||
|
|
||||||||
| import ( | ||||||||
| "errors" | ||||||||
| "fmt" | ||||||||
| "os" | ||||||||
| "path/filepath" | ||||||||
| "strings" | ||||||||
|
|
||||||||
| "github.com/elastic/go-ucfg/yaml" | ||||||||
| ) | ||||||||
|
|
||||||||
| // Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||||||||
| // or more contributor license agreements. Licensed under the Elastic License; | ||||||||
| // you may not use this file except in compliance with the Elastic License. | ||||||||
|
|
||||||||
| const DevPath = "_dev/benchmark/rally" | ||||||||
|
|
||||||||
| type Scenario struct { | ||||||||
| Package string `config:"package" json:"package"` | ||||||||
| Description string `config:"description" json:"description"` | ||||||||
| Version string `config:"version" json:"version"` | ||||||||
| DataStream DataStream `config:"data_stream" json:"data_stream"` | ||||||||
| Corpora Corpora `config:"corpora" json:"corpora"` | ||||||||
| } | ||||||||
|
|
||||||||
| type DataStream struct { | ||||||||
| Name string `config:"name" json:"name"` | ||||||||
| } | ||||||||
|
|
||||||||
| type Corpora struct { | ||||||||
| Generator *Generator `config:"generator" json:"generator"` | ||||||||
| } | ||||||||
|
|
||||||||
| type Generator struct { | ||||||||
| TotalEvents uint64 `config:"total_events" json:"total_events"` | ||||||||
| Template CorporaTemplate `config:"template" json:"template"` | ||||||||
| Config CorporaAsset `config:"config" json:"config"` | ||||||||
| Fields CorporaAsset `config:"fields" json:"fields"` | ||||||||
| } | ||||||||
|
|
||||||||
| type CorporaAsset struct { | ||||||||
| Raw map[string]interface{} `config:"raw" json:"raw"` | ||||||||
| Path string `config:"path" json:"path"` | ||||||||
| } | ||||||||
| type CorporaTemplate struct { | ||||||||
| Raw string `config:"raw" json:"raw"` | ||||||||
| Path string `config:"path" json:"path"` | ||||||||
| Type string `config:"type" json:"type"` | ||||||||
| } | ||||||||
|
|
||||||||
| func DefaultConfig() *Scenario { | ||||||||
| return &Scenario{} | ||||||||
| } | ||||||||
|
|
||||||||
| func ReadConfig(path, scenario, packageName, packageVersion string) (*Scenario, error) { | ||||||||
| configPath := filepath.Join(path, DevPath, fmt.Sprintf("%s.yml", scenario)) | ||||||||
| c := DefaultConfig() | ||||||||
| cfg, err := yaml.NewConfigWithFile(configPath) | ||||||||
| if err != nil { | ||||||||
| return nil, fmt.Errorf("can't load benchmark configuration: %s: %w", configPath, err) | ||||||||
| } | ||||||||
|
|
||||||||
| if err == nil { | ||||||||
| if err := cfg.Unpack(c); err != nil { | ||||||||
| return nil, fmt.Errorf("can't unpack benchmark configuration: %s: %w", configPath, err) | ||||||||
| } | ||||||||
| } | ||||||||
|
|
||||||||
| c.Package = packageName | ||||||||
| c.Version = packageVersion | ||||||||
|
|
||||||||
| if c.DataStream.Name == "" { | ||||||||
| return nil, errors.New("can't read data stream name from benchmark configuration: empty") | ||||||||
| } | ||||||||
|
|
||||||||
| return c, nil | ||||||||
| } | ||||||||
|
|
||||||||
| func ReadScenarios(path, scenarioName, packageName, packageVersion string) (map[string]*Scenario, error) { | ||||||||
|
There was a problem hiding this comment. Nit. Do we have any benefit on returning scenarios as a map? Returning a list would help controlling the order of execution and results.
Suggested change
There was a problem hiding this comment. @jsoriano I would prefer to delay code changes to a different PR. The reason is for this PR I only moved code around, not type / logic change to make sure the refactoring does not affect any of the logic. |
||||||||
| scenarios := make(map[string]*Scenario) | ||||||||
| if len(scenarioName) > 0 { | ||||||||
| scenario, err := ReadConfig(path, scenarioName, packageName, packageVersion) | ||||||||
| if err != nil { | ||||||||
| return nil, fmt.Errorf("error loading scenario: %w", err) | ||||||||
| } | ||||||||
| scenarios[scenarioName] = scenario | ||||||||
| } else { | ||||||||
|
There was a problem hiding this comment. Nit. I think we can remove the else to have one less nesting level.
Suggested change
There was a problem hiding this comment. See my comment above, happy to follow up further code changes but now trying to focus on only moving things around, no logical changes. |
||||||||
| err := filepath.Walk(filepath.Join(path, DevPath), func(_ string, info os.FileInfo, err error) error { | ||||||||
| if err != nil { | ||||||||
| return err | ||||||||
| } | ||||||||
|
|
||||||||
| if info.IsDir() { | ||||||||
| return nil | ||||||||
| } | ||||||||
|
|
||||||||
| if strings.HasSuffix(info.Name(), "-benchmark.yml") { | ||||||||
| scenarioName = strings.TrimSuffix(info.Name(), ".yml") | ||||||||
| scenario, err := ReadConfig(path, scenarioName, packageName, packageVersion) | ||||||||
| if err != nil { | ||||||||
| return err | ||||||||
| } | ||||||||
| scenarios[scenarioName] = scenario | ||||||||
| } | ||||||||
|
|
||||||||
| return nil | ||||||||
| }) | ||||||||
| if err != nil { | ||||||||
| return nil, fmt.Errorf("error loading scenario: %w", err) | ||||||||
| } | ||||||||
| } | ||||||||
|
|
||||||||
| return scenarios, nil | ||||||||
| } | ||||||||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,74 +3,3 @@ | |
| // you may not use this file except in compliance with the Elastic License. | ||
|
|
||
| package rally | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit.
commonseems too generic, could this go directly in theinternal/benchrunner/runnerspackage? Or to aninternal/benchrunner/scenariopackage?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@aspacca Any thoughts?