Page MenuHomeVyOS Platform
Create Task
Maniphest T2097

Problems when using <path> as completion helper in op-mode
Closed, ResolvedPublicBUG
Actions

Description

Using a completion helper in op mode like:

<completionHelp>
  <path>vrf name</path>
</completionHelp>

will generate the following node.def file:

cat /opt/vyatta/share/vyatta-op/templates/show/vrf/node.tag/node.def
help: Show information on specific VRF instance
allowed: /bin/cli-shell-api listActiveNodes vrf name
run: ${vyos_op_scripts_dir}/show_vrf.py -e "$3"

The problem here is a call to /bin/cli-shell-api listNodes vrf name will return: 'bar' 'foo' see the ' quotes. The old node.def implementations got rid if the '' by using shell code like:

allowed:
  local -a bnodes
  local -a nnodes
  eval "bnodes=($(cli-shell-api listActiveNodes protocols bgp))"
  for b in "${bnodes[@]}"; do
    eval "nnodes=($(cli-shell-api listActiveNodes protocols bgp $b neighbor))"
    echo -n "${nnodes[@]}" ' '
  done

Which removes the ' quotes.

This can easily be done using | sed -e "s/'//g"

Question: Why is this of no issue in configuration mode?

Details

Difficulty level
Unknown (require assessment)
Version
1.2.5
Why the issue appeared?
Will be filled on close
Is it a breaking change?
Unspecified (possibly destroys the router)
Issue type
Internal change (not visible to end users)

Event Timeline

c-po created this task.Mar 4 2020, 7:28 PM
c-po updated the task description. (Show Details)Mar 4 2020, 7:35 PM
c-po added subscribers: dmbaturin, jestabro.
dmbaturin added a comment.Jun 25 2020, 7:48 AM

Turns out it's because the conf mode "allowed: " is escaped and eval'd when it's passed to the shell: https://github.com/vyos/vyatta-cfg/blob/current/src/cstore/cstore.cpp#L756-L762

However, op mode "allowed:" is a different story altogether . Op mode template "parsing" seems to be done in shell with sed! https://github.com/vyos/vyatta-op/blob/current/functions/interpreter/vyatta-op-run#L45-L64

I couldn't locate where exactly the "allowed:" field is processed yet.

Viacheslav added a subscriber: Viacheslav.Jul 24 2020, 5:36 AM

VyOS 1.3-rolling-202007240117

vyos@r1-roll:~$ show vrf 
Possible completions:
  <Enter>       Execute the current command
  bar           Show information on specific VRF instance
  FOO
  LAN

@c-po Can we close it?

c-po added a comment.Jul 24 2020, 11:50 AM

A workaround is in place for this

c-po closed this task as Resolved.Jul 24 2020, 11:50 AM
c-po claimed this task.
pasik added a subscriber: pasik.Jul 24 2020, 4:52 PM
c-po moved this task from Need Triage to Finished on the VyOS 1.3 Equuleus board.Aug 3 2020, 3:30 PM
erkin set Issue type to Internal change (not visible to end users).Aug 31 2021, 5:26 PM
syncer edited projects, added VyOS 1.3 Equuleus (1.3.0); removed VyOS 1.3 Equuleus.Aug 29 2022, 7:13 PM
syncer moved this task from Need Triage to Finished on the VyOS 1.3 Equuleus (1.3.0) board.