StackStorm / StackStorm/st2

remove kwarg_op from remote-shell-cmd runner?

Open
#5,479 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

stale
Dominant language
Python
Stars
6.5k
Forks
787
PR merge metrics
No merged PRs in 30d

Description

SUMMARY

Documentation shows that remote-shell-cmd accepts the kwarg_op parameter leading one to believe that its supposed to work like remote-shell-script runners. After some time of fighting this I finally dug into source and noticed that remote-shell-cmd doesn't even attempt to build an args list like the shell runner does.

I dont know if this is a bug or if it was never intended to build an args list. Either way, code needs to fix it or the docs should be updated to not support kwarg_op since its not even used.

https://docs.stackstorm.com/reference/runners.html?remote-command-runner-remote-shell-cmd#remote-command-runner-remote-shell-cmd

STACKSTORM VERSION

Paste the output of st2 --version: st2 3.6.0, on Python 3.6.8

Steps to reproduce the problem

Create a remote-shell-cmd action with extra params other than the default ones and execute the action.

Expected Results

The action to build on the command and add all left over action params as args

Actual Results

Extra params are ignored.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the remote-shell-cmd runner documentation linked in the issue, then inspect its implementation and compare it with the shell runner's argument-list behavior. Done means the project either supports extra action parameters as documented or removes and corrects the kwarg_op documentation, with the behavior verified against the reproduction case.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
devops
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.