Unlock 30% off on Manual Testing Annual Plans this Holiday Season.

Copied to Clipboard!

How to use PickleStepArgument class

Best Cucumber Common Library code snippet using PickleStepArgument

PickleCompiler.php

Source:PickleCompiler.php

...8use Cucumber\Messages\Id\IdGenerator;9use Cucumber\Messages\Pickle;10use Cucumber\Messages\PickleDocString;11use Cucumber\Messages\PickleStep;12use Cucumber\Messages\PickleStepArgument;13use Cucumber\Messages\PickleTable;14use Cucumber\Messages\PickleTableCell;15use Cucumber\Messages\PickleTableRow;16use Cucumber\Messages\PickleTag;17use Cucumber\Messages\Rule;18use Cucumber\Messages\Scenario;19use Cucumber\Messages\Step;20use Cucumber\Messages\TableCell;21use Cucumber\Messages\TableRow;22use Cucumber\Messages\Tag;23use Generator;24final class PickleCompiler25{26    /** @var array<string, PickleStep\Type|null> */27    private array $pickleStepTypeFromKeyword = [];28    private Step\KeywordType $lastKeywordType = Step\KeywordType::UNKNOWN;29    public function __construct(30        private readonly IdGenerator $idGenerator,31    ) {32        $this->pickleStepTypeFromKeyword[Step\KeywordType::UNKNOWN->name] = PickleStep\Type::UNKNOWN;33        $this->pickleStepTypeFromKeyword[Step\KeywordType::CONTEXT->name] = PickleStep\Type::CONTEXT;34        $this->pickleStepTypeFromKeyword[Step\KeywordType::ACTION->name] = PickleStep\Type::ACTION;35        $this->pickleStepTypeFromKeyword[Step\KeywordType::OUTCOME->name] = PickleStep\Type::OUTCOME;36        $this->pickleStepTypeFromKeyword[Step\KeywordType::CONJUNCTION->name] = null;37    }38    /**39     * @return Generator<Pickle>40     */41    public function compile(GherkinDocument $gherkinDocument, string $uri): Generator42    {43        if (!$gherkinDocument->feature) {44            return;45        }46        $feature = $gherkinDocument->feature;47        $language = $feature->language;48        yield from $this->compileFeature($feature, $language, $uri);49    }50    /**51     * @return Generator<Pickle>52     */53    private function compileFeature(Feature $feature, string $language, string $uri): Generator54    {55        $tags = $feature->tags;56        $featureBackgroundSteps = [];57        foreach ($feature->children as $featureChild) {58            if ($featureChild->background) {59                $featureBackgroundSteps = [...$featureBackgroundSteps, ...$featureChild->background->steps];60            } elseif ($featureChild->rule) {61                yield from $this->compileRule($featureChild->rule, $tags, $featureBackgroundSteps, $language, $uri);62            } elseif ($featureChild->scenario) {63                if (!$featureChild->scenario->examples) {64                    yield from $this->compileScenario($featureChild->scenario, $tags, $featureBackgroundSteps, $language, $uri);65                } else {66                    yield from $this->compileScenarioOutline($featureChild->scenario, $tags, $featureBackgroundSteps, $language, $uri);67                }68            }69        }70    }71    /**72     * @param list<Tag> $parentTags73     * @param list<Step> $featureBackgroundSteps74     *75     * @return Generator<Pickle>76     */77    private function compileRule(Rule $rule, array $parentTags, array $featureBackgroundSteps, string $language, string $uri): Generator78    {79        $ruleBackgroundSteps = $featureBackgroundSteps;80        $ruleTags = [...$parentTags, ...$rule->tags];81        foreach ($rule->children as $ruleChild) {82            if ($ruleChild->background) {83                $ruleBackgroundSteps = [...$ruleBackgroundSteps, ...$ruleChild->background->steps];84            } elseif ($ruleChild->scenario && $ruleChild->scenario->examples) {85                yield from $this->compileScenarioOutline($ruleChild->scenario, $ruleTags, $ruleBackgroundSteps, $language, $uri);86            } elseif ($ruleChild->scenario) {87                yield from $this->compileScenario($ruleChild->scenario, $ruleTags, $ruleBackgroundSteps, $language, $uri);88            }89        }90    }91    /**92     * @param list<Tag> $parentTags93     * @param list<Step> $backgroundSteps94     *95     * @return Generator<Pickle>96     */97    private function compileScenario(Scenario $scenario, array $parentTags, array $backgroundSteps, string $language, string $uri): Generator98    {99        $steps = [100            ...($scenario->steps ? $this->pickleSteps($backgroundSteps) : []),101            ...array_map(fn ($s) => $this->pickleStep($s), $scenario->steps),102        ];103        $tags = [...$parentTags, ...$scenario->tags];104        $this->lastKeywordType = Step\KeywordType::UNKNOWN;105        yield new Pickle(106            id: $this->idGenerator->newId(),107            uri: $uri,108            name: $scenario->name,109            language: $language,110            steps: $steps,111            tags: $this->pickleTags($tags),112            astNodeIds: [$scenario->id],113        );114    }115    /**116     * @param list<Tag> $featureTags117     * @param list<Step> $backgroundSteps118     *119     * @return Generator<Pickle>120     */121    private function compileScenarioOutline(Scenario $scenario, array $featureTags, array $backgroundSteps, string $language, string $uri): Generator122    {123        foreach ($scenario->examples as $examples) {124            if (!$examples->tableHeader) {125                continue;126            }127            $variableCells = $examples->tableHeader->cells;128            foreach ($examples->tableBody as $valuesRow) {129                $valueCells = $valuesRow->cells;130                $steps = [131                    ...($scenario->steps ? $this->pickleSteps($backgroundSteps) : []),132                    ...array_map(fn ($s) => $this->pickleStep($s, $variableCells, $valuesRow), $scenario->steps),133                ];134                $tags = [...$featureTags, ...$scenario->tags, ...$examples->tags];135                $sourceIds = [$scenario->id, $valuesRow->id];136                yield new Pickle(137                    id: $this->idGenerator->newId(),138                    uri: $uri,139                    name: $this->interpolate($scenario->name, $variableCells, $valueCells),140                    language: $language,141                    steps: $steps,142                    tags: $this->pickleTags($tags),143                    astNodeIds: $sourceIds,144                );145            }146        }147    }148    /**149     * @param list<Step> $steps150     * @return list<PickleStep>151     */152    private function pickleSteps(array $steps): array153    {154        return array_map(fn ($s) => $this->pickleStep($s), $steps);155    }156    /**157     * @param list<TableCell> $variableCells158     */159    private function pickleStep(Step $step, array $variableCells = [], ?TableRow $valuesRow = null): PickleStep160    {161        $valueCells = $valuesRow?->cells ?? [];162        $stepText = $this->interpolate($step->text, $variableCells, $valueCells);163        $astNodeIds = $valuesRow ? [$step->id, $valuesRow->id] : [$step->id];164        if ($step->dataTable) {165            $argument = new PickleStepArgument(dataTable: $this->pickleDataTable($step->dataTable, $variableCells, $valueCells));166        } elseif ($step->docString) {167            $argument = new PickleStepArgument(docString: $this->pickleDocString($step->docString, $variableCells, $valueCells));168        } else {169            $argument = null;170        }171        $this->lastKeywordType =172            $step->keywordType === Step\KeywordType::CONJUNCTION173            ? $this->lastKeywordType174            : ($step->keywordType ?? Step\KeywordType::UNKNOWN)175        ;176        return new PickleStep(177            argument: $argument,178            astNodeIds: $astNodeIds,179            id: $this->idGenerator->newId(),180            type: $this->pickleStepTypeFromKeyword[$this->lastKeywordType->name],181            text: $stepText,...

PickleStepArgument.php

Source:PickleStepArgument.php

...6namespace Cucumber\Messages;7use JsonSerializable;8use Cucumber\Messages\DecodingException\SchemaViolationException;9/**10 * Represents the PickleStepArgument message in Cucumber's message protocol11 * @see https://github.com/cucumber/common/tree/main/messages#readme12 *13 * An optional argument */14final class PickleStepArgument implements JsonSerializable15{16    use JsonEncodingTrait;17    /**18     * Construct the PickleStepArgument with all properties19     *20     */21    public function __construct(22        public readonly ?PickleDocString $docString = null,23        public readonly ?PickleTable $dataTable = null,24    ) {25    }26    /**27     * @throws SchemaViolationException28     *29     * @internal30     */31    public static function fromArray(array $arr): self32    {...

PickleStepArgument

Using AI Code Generation

1use Cucumber\Common\StepArgument\PickleStepArgument;2use Cucumber\Common\StepArgument\PickleTableNode;3use Cucumber\Common\StepArgument\PickleDocString;4use Cucumber\Common\StepArgument\PickleStepArgument;5use Cucumber\Common\StepArgument\PickleTableNode;6use Cucumber\Common\StepArgument\PickleDocString;7use Cucumber\Common\StepArgument\PickleStepArgument;8use Cucumber\Common\StepArgument\PickleTableNode;9use Cucumber\Common\StepArgument\PickleDocString;10use Cucumber\Common\StepArgument\PickleStepArgument;11use Cucumber\Common\StepArgument\PickleTableNode;12use Cucumber\Common\StepArgument\PickleDocString;13use Cucumber\Common\StepArgument\PickleStepArgument;14use Cucumber\Common\StepArgument\PickleTableNode;15use Cucumber\Common\StepArgument\PickleDocString;16use Cucumber\Common\StepArgument\PickleStepArgument;17use Cucumber\Common\StepArgument\PickleTableNode;18use Cucumber\Common\StepArgument\PickleDocString;19use Cucumber\Common\StepArgument\PickleStepArgument;20use Cucumber\Common\StepArgument\PickleTableNode;21use Cucumber\Common\StepArgument\PickleDocString;22use Cucumber\Common\StepArgument\PickleStepArgument;23use Cucumber\Common\StepArgument\PickleTableNode;24use Cucumber\Common\StepArgument\PickleDocString;

PickleStepArgument

Using AI Code Generation

1$stepArgument = new PickleStepArgument();2$stepArgument->setStepArgument($argument);3$stepArgument->setStepArgumentType($argumentType);4$stepArgument->setStepArgumentName($argumentName);5$stepArgument->setStepArgumentValue($argumentValue);6$stepArgument->setStepArgumentValue($argumentValue);7$step = new PickleStep();8$step->setStep($stepName);9$step->setStepType($stepType);10$step->setStepArgument($stepArgument);11$step->setStepStatus($stepStatus);12$step->setStepTime($stepTime);13$step->setStepLine($stepLine);14$step->setStepKeyword($stepKeyword);15$step->setStepMatch($stepMatch);16$step->setStepResult($stepResult);17$step->setStepMatchLocation($stepMatchLocation);18$scenario = new PickleScenario();19$scenario->setScenarioName($scenarioName);20$scenario->setScenarioStatus($scenarioStatus);21$scenario->setScenarioTime($scenarioTime);22$scenario->setScenarioLine($scenarioLine);23$scenario->setScenarioKeyword($scenarioKeyword);24$scenario->setScenarioSteps($step);25$scenario->setScenarioTags($scenarioTags);26$feature = new PickleFeature();27$feature->setFeatureName($featureName);28$feature->setFeatureStatus($featureStatus);29$feature->setFeatureTime($featureTime);30$feature->setFeatureLine($featureLine);31$feature->setFeatureKeyword($featureKeyword);32$feature->setFeatureScenarios($scenario);33$feature->setFeatureTags($featureTags);34$environment = new PickleEnvironment();35$environment->setEnvironmentName($environmentName);36$environment->setEnvironmentStatus($environmentStatus);37$environment->setEnvironmentTime($environmentTime);38$environment->setEnvironmentLine($environmentLine);39$environment->setEnvironmentKeyword($environmentKeyword);40$environment->setEnvironmentSteps($step);41$environment->setEnvironmentTags($environmentTags);42$result = new PickleResult();43$result->setResultName($resultName);

PickleStepArgument

Using AI Code Generation

1$step = new PickleStepArgument();2$step->setStepArgument($argument);3$step->setStepArgumentType($argumentType);4$step->setStepArgumentValue($argumentValue);5$step->setStepArgumentPosition($argumentPosition);6$step->setStepArgumentText($argumentText);7$step->setStepArgumentFile($argumentFile);8$step->setStepArgumentLine($argumentLine);9$step->setStepArgumentCol($argumentCol);10$step = new PickleStep();11$step->setStepText($stepText);12$step->setStepFile($stepFile);13$step->setStepLine($stepLine);14$step->setStepCol($stepCol);15$step->setStepKeyword($stepKeyword);16$step->setStepName($stepName);17$step->setStepArgument($stepArgument);18$step->setStepArgumentType($stepArgumentType);19$step->setStepArgumentValue($stepArgumentValue);20$step->setStepArgumentPosition($stepArgumentPosition);21$step->setStepArgumentText($stepArgumentText);22$step->setStepArgumentFile($stepArgumentFile);23$step->setStepArgumentLine($stepArgumentLine);24$step->setStepArgumentCol($stepArgumentCol);25$feature = new PickleFeature();26$feature->setFeatureName($featureName);27$feature->setFeatureDescription($featureDescription);28$feature->setFeatureFile($featureFile);29$feature->setFeatureLine($featureLine);30$feature->setFeatureCol($featureCol);31$feature->setFeatureKeyword($featureKeyword);32$feature->setFeatureTags($featureTags);33$feature->setFeatureBackground($featureBackground);34$feature->setFeatureBackgroundName($featureBackgroundName);35$feature->setFeatureBackgroundDescription($featureBackgroundDescription);36$feature->setFeatureBackgroundFile($featureBackgroundFile);37$feature->setFeatureBackgroundLine($featureBackgroundLine);38$feature->setFeatureBackgroundCol($featureBackgroundCol);39$feature->setFeatureBackgroundKeyword($featureBackgroundKeyword);40$feature->setFeatureBackgroundSteps($featureBackgroundSteps);41$feature->setFeatureBackgroundStepsText($featureBackgroundStepsText);42$feature->setFeatureBackgroundStepsFile($featureBackgroundStepsFile);43$feature->setFeatureBackgroundStepsLine($featureBackgroundStepsLine);

PickleStepArgument

Using AI Code Generation

1$stepArgument = new PickleStepArgument();2$stepArgument->setArgument("Some text");3$stepArgument->setArgumentType("string");4$stepArgument->setArgumentPosition("1");5$stepArgument->setArgumentIndex("1");6$step = new PickleStep();7$step->setStepName("I have a step");8$step->setStepType("Given");9$step->setStepArgument($stepArgument);10$step->setStepLine("1");11$scenario = new PickleScenario();12$scenario->setScenarioName("I have a scenario");13$scenario->setScenarioType("Scenario");14$scenario->setScenarioLine("1");15$scenario->setScenarioSteps(array($step));16$feature = new PickleFeature();17$feature->setFeatureName("I have a feature");18$feature->setFeatureDescription("I have a feature");19$feature->setFeatureLine("1");20$feature->setFeatureScenarios(array($scenario));21$testResult = new PickleTestResult();22$testResult->setFeature($feature);23$testResult->setTestResult("passed");24$testResult->setTestResultDuration(1.0);25$testResult->setTestResultErrorMessage("No error");26$testResult->setTestResultErrorType("No error type");27$testRunResult = new PickleTestRunResult();28$testRunResult->setTestRunResult(array($testResult));29$testRun = new PickleTestRun();30$testRun->setTestRunResult($testRunResult);31$testRun->setTestRunDuration(1.0);32$testRun->setTestRunStartTime(1.0);33$testRun->setTestRunEndTime(1.0);34$testRun->setTestRunStatus("passed");35$testRunManager = new PickleTestRunManager();36$testRunManager->setTestRun($testRun);

PickleStepArgument

Using AI Code Generation

1$step_argument = new PickleStepArgument($step);2$argument = $step_argument->getArgument();3$type = $step_argument->getType();4$step_argument = new PickleStepArgument($step);5$argument = $step_argument->getArgument();6$type = $step_argument->getType();7$step_argument = new PickleStepArgument($step);8$argument = $step_argument->getArgument();9$type = $step_argument->getType();10$step_argument = new PickleStepArgument($step);11$argument = $step_argument->getArgument();12$type = $step_argument->getType();13$step_argument = new PickleStepArgument($step);14$argument = $step_argument->getArgument();15$type = $step_argument->getType();16$step_argument = new PickleStepArgument($step);17$argument = $step_argument->getArgument();18$type = $step_argument->getType();19$step_argument = new PickleStepArgument($step);20$argument = $step_argument->getArgument();21$type = $step_argument->getType();22$step_argument = new PickleStepArgument($step);23$argument = $step_argument->getArgument();24$type = $step_argument->getType();25$step_argument = new PickleStepArgument($step);26$argument = $step_argument->getArgument();27$type = $step_argument->getType();28$step_argument = new PickleStepArgument($step);29$argument = $step_argument->getArgument();30$type = $step_argument->getType();31$step_argument = new PickleStepArgument($step);

Automation Testing Tutorials

Learn to execute automation testing from scratch with LambdaTest Learning Hub. Right from setting up the prerequisites to run your first automation test, to following best practices and diving deeper into advanced test scenarios. LambdaTest Learning Hubs compile a list of step-by-step guides to help you be proficient with different test automation frameworks i.e. Selenium, Cypress, TestNG etc.