Add variants for acceptance tests and apply to Users, Topics, Roles, and Schemas #1127
Conversation
This file contains hidden or 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
andrewstucki
requested review from
RafalKorepta,
chrisseto and
gene-redpanda
as code owners
andrewstucki
commented
Oct 2, 2025
Comment on lines
+232
to
+252
| parsingSuite := &godog.TestSuite{ | ||
| Name: "acceptance", | ||
| Options: &opts, | ||
| } | ||
| features, err := parsingSuite.RetrieveFeatures() | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| for _, feature := range features { | ||
| if variantTag := featureVariant(feature.Feature.Tags); variantTag != "" { | ||
| content := bytes.ReplaceAll(feature.Content, []byte("Feature: "), []byte(fmt.Sprintf("Feature: %s - ", variantTag))) | ||
| content = bytes.ReplaceAll(content, []byte("Scenario: "), []byte(fmt.Sprintf("Scenario: %s - ", variantTag))) | ||
| content = bytes.ReplaceAll(content, []byte("Scenario Outline: "), []byte(fmt.Sprintf("Scenario Outline: %s - ", variantTag))) | ||
| content = bytes.ReplaceAll(content, []byte(fmt.Sprintf("@variant:%s", variantTag)), []byte(fmt.Sprintf("@injectVariant:%s", variantTag))) | ||
| opts.FeatureContents = append(opts.FeatureContents, godog.Feature{ | ||
| Name: path.Join(variantTag, feature.Uri), | ||
| Contents: content, | ||
| }) | ||
| } | ||
| } |
Contributor
Author
There was a problem hiding this comment.
This is the main hacky bit. We parse all the features twice, once here and then again when we run things. Basically what this is doing is:
- grabbing all the features
- seeing if any have a
varianttag - if it does, duping it and munging the
Scenario/Feature/Scenario Outlinedescriptions so the names of the generated tests are different - replacing the
varianttag with an internalinjectVarianttag that tracks the current variant and can be fetched witht.Variantat test runtime - synthetically adding this as an additional feature via
opts.FeatureContents
Contributor
There was a problem hiding this comment.
Hack yes but it's pretty nicely isolated from everything else.
Contributor
|
chrisseto
approved these changes
Oct 6, 2025
Comment on lines
+232
to
+252
| parsingSuite := &godog.TestSuite{ | ||
| Name: "acceptance", | ||
| Options: &opts, | ||
| } | ||
| features, err := parsingSuite.RetrieveFeatures() | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| for _, feature := range features { | ||
| if variantTag := featureVariant(feature.Feature.Tags); variantTag != "" { | ||
| content := bytes.ReplaceAll(feature.Content, []byte("Feature: "), []byte(fmt.Sprintf("Feature: %s - ", variantTag))) | ||
| content = bytes.ReplaceAll(content, []byte("Scenario: "), []byte(fmt.Sprintf("Scenario: %s - ", variantTag))) | ||
| content = bytes.ReplaceAll(content, []byte("Scenario Outline: "), []byte(fmt.Sprintf("Scenario Outline: %s - ", variantTag))) | ||
| content = bytes.ReplaceAll(content, []byte(fmt.Sprintf("@variant:%s", variantTag)), []byte(fmt.Sprintf("@injectVariant:%s", variantTag))) | ||
| opts.FeatureContents = append(opts.FeatureContents, godog.Feature{ | ||
| Name: path.Join(variantTag, feature.Uri), | ||
| Contents: content, | ||
| }) | ||
| } | ||
| } |
Contributor
There was a problem hiding this comment.
Hack yes but it's pretty nicely isolated from everything else.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This adds the new concept of "variant" handling in our acceptance tests. Essentially they, under the hood, hackily duplicate a feature and then fix it up with some step-specific handling that can introspect the given "variant" that's running via
t.Variant()this gives us the ability to just annotate a feature with something like@variant:vectorizedand keep the step definitions uniform. Because I wanted to allow us to, alternatively, just expand and dup all of the feature definitions, I kept the( vectorized)?bits for our step definitions. I'll create another PR that uses the expanded definitions rather than the variant annotation so we can decide how we want to maintain this.