e2e: add prometheus flag to Generator CLI (cometbft#563)

* Add prometheus flag to CLI * Fix CLI help message * Enable prometheus in nightly tests
ssrivatsan97 · Mar 23, 2023 · 01c0188 · 01c0188
1 parent 23389e7
commit 01c0188
Show file tree

Hide file tree

Showing 7 changed files with 18 additions and 10 deletions.
diff --git a/.github/workflows/e2e-manual-multiversion.yml b/.github/workflows/e2e-manual-multiversion.yml
@@ -31,7 +31,7 @@ jobs:
  # When changing -g, also change the matrix groups above
  # Generate multi-version tests with double the quantity of E2E nodes
  # based on the current branch as compared to the latest version.
- run: ./build/generator -g 5 -m "latest:1,local:2" -d networks/nightly/
+ run: ./build/generator -g 5 -m "latest:1,local:2" -d networks/nightly/ -p
 
  - name: Run ${{ matrix.p2p }} p2p testnets
  working-directory: test/e2e

diff --git a/.github/workflows/e2e-manual.yml b/.github/workflows/e2e-manual.yml
@@ -29,7 +29,7 @@ jobs:
  - name: Generate testnets
  working-directory: test/e2e
  # When changing -g, also change the matrix groups above
- run: ./build/generator -g 5 -d networks/nightly/
+ run: ./build/generator -g 5 -d networks/nightly/ -p
 
  - name: Run ${{ matrix.p2p }} p2p testnets
  working-directory: test/e2e

diff --git a/.github/workflows/e2e-nightly-34x.yml b/.github/workflows/e2e-nightly-34x.yml
@@ -40,7 +40,7 @@ jobs:
  - name: Generate testnets
  working-directory: test/e2e
  # When changing -g, also change the matrix groups above
- run: ./build/generator -g 2 -d networks/nightly
+ run: ./build/generator -g 2 -d networks/nightly -p
 
  - name: Run testnets in group ${{ matrix.group }}
  working-directory: test/e2e

diff --git a/.github/workflows/e2e-nightly-37x.yml b/.github/workflows/e2e-nightly-37x.yml
@@ -40,7 +40,7 @@ jobs:
  - name: Generate testnets
  working-directory: test/e2e
  # When changing -g, also change the matrix groups above
- run: ./build/generator -g 5 -d networks/nightly/
+ run: ./build/generator -g 5 -d networks/nightly/ -p
 
  - name: Run ${{ matrix.p2p }} p2p testnets
  working-directory: test/e2e

diff --git a/.github/workflows/e2e-nightly-main.yml b/.github/workflows/e2e-nightly-main.yml
@@ -34,7 +34,7 @@ jobs:
  - name: Generate testnets
  working-directory: test/e2e
  # When changing -g, also change the matrix groups above
- run: ./build/generator -g 5 -d networks/nightly/
+ run: ./build/generator -g 5 -d networks/nightly/ -p
 
  - name: Run ${{ matrix.p2p }} p2p testnets
  working-directory: test/e2e

diff --git a/test/e2e/generator/generate.go b/test/e2e/generator/generate.go
@@ -65,6 +65,7 @@ type generateConfig struct {
  randSource *rand.Rand
  outputDir string
  multiVersion string
+ prometheus bool
 }
 
 // Generate generates random testnets using the given RNG.
@@ -106,7 +107,7 @@ func Generate(cfg *generateConfig) ([]e2e.Manifest, error) {
  }
  manifests := []e2e.Manifest{}
  for _, opt := range combinations(testnetCombinations) {
- manifest, err := generateTestnet(cfg.randSource, opt, upgradeVersion)
+ manifest, err := generateTestnet(cfg.randSource, opt, upgradeVersion, cfg.prometheus)
  if err != nil {
  return nil, err
  }
@@ -116,7 +117,7 @@ func Generate(cfg *generateConfig) ([]e2e.Manifest, error) {
 }
 
 // generateTestnet generates a single testnet with the given options.
-func generateTestnet(r *rand.Rand, opt map[string]interface{}, upgradeVersion string) (e2e.Manifest, error) {
+func generateTestnet(r *rand.Rand, opt map[string]interface{}, upgradeVersion string, prometheus bool) (e2e.Manifest, error) {
  manifest := e2e.Manifest{
  IPv6: ipv6.Choose(r).(bool),
  ABCIProtocol: nodeABCIProtocols.Choose(r).(string),
@@ -127,6 +128,7 @@ func generateTestnet(r *rand.Rand, opt map[string]interface{}, upgradeVersion st
  Evidence: evidence.Choose(r).(int),
  Nodes: map[string]*e2e.ManifestNode{},
  UpgradeVersion: upgradeVersion,
+ Prometheus: prometheus,
  }
 
  switch abciDelays.Choose(r).(string) {

diff --git a/test/e2e/generator/main.go b/test/e2e/generator/main.go
@@ -31,7 +31,7 @@ type CLI struct {
 func NewCLI() *CLI {
  cli := &CLI{}
  cli.root = &cobra.Command{
- Use: "generator -d dir [-g int] [-m version_weight_csv]",
+ Use: "generator -d dir [-g int] [-m version_weight_csv] [-p]",
  Short: "End-to-end testnet generator",
  SilenceUsage: true,
  SilenceErrors: true, // we'll output them ourselves in Run()
@@ -48,7 +48,11 @@ func NewCLI() *CLI {
  if err != nil {
  return err
  }
- return cli.generate(dir, groups, multiVersion)
+ prometheus, err := cmd.Flags().GetBool("prometheus")
+ if err != nil {
+ return err
+ }
+ return cli.generate(dir, groups, multiVersion, prometheus)
  },
  }
 
@@ -57,12 +61,13 @@ func NewCLI() *CLI {
  cli.root.PersistentFlags().StringP("multi-version", "m", "", "Comma-separated list of versions of CometBFT to test in the generated testnets, "+
  "or empty to only use this branch's version")
  cli.root.PersistentFlags().IntP("groups", "g", 0, "Number of groups")
+ cli.root.PersistentFlags().BoolP("prometheus", "p", false, "Enable generation of Prometheus metrics on all manifests")
 
  return cli
 }
 
 // generate generates manifests in a directory.
-func (cli *CLI) generate(dir string, groups int, multiVersion string) error {
+func (cli *CLI) generate(dir string, groups int, multiVersion string, prometheus bool) error {
  err := os.MkdirAll(dir, 0o755)
  if err != nil {
  return err
@@ -71,6 +76,7 @@ func (cli *CLI) generate(dir string, groups int, multiVersion string) error {
  cfg := &generateConfig{
  randSource: rand.New(rand.NewSource(randomSeed)), //nolint:gosec
  multiVersion: multiVersion,
+ prometheus: prometheus,
  }
  manifests, err := Generate(cfg)
  if err != nil {