Page MenuHomeVyOS Platform
Create Task
Maniphest T2027

get_config_dict is failing when the configuration section is empty/missing
Closed, ResolvedPublicBUG
Actions

Description

in order to safely call get_config_dict, config.exists or config.exists_effective need to be called beforehand.

The reason is that the underlying command run will return "Configuration under specified path is empty\n" when the configuration does not exist.
Ideally, this "barrier" call should not be required and the code should be able to detect that failure.

it was suggested that cli-shell-api could provide an error code when the section is missing allowing to detect it occurred.

Details

Difficulty level
Easy (less than an hour)
Version
1.3-rolling-202002102200
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)

Related Objects

Mentioned In
T31: Add VRF support

Event Timeline

thomas-mangin created this task.Feb 10 2020, 10:09 PM
thomas-mangin added a comment.Feb 10 2020, 10:59 PM

suggesting https://github.com/vyos/vyos-1x/pull/217

pasik added a subscriber: pasik.Feb 12 2020, 10:33 AM
thomas-mangin mentioned this in T31: Add VRF support.Feb 12 2020, 12:28 PM
dmbaturin added a project: test.Jul 29 2021, 12:38 PM
dmbaturin added a project: VyOS 1.4 Sagitta.
c-po added a subscriber: c-po.EditedAug 8 2021, 4:47 PM
>>> from vyos.config import Config
>>> conf = Config()
>>> conf.get_config_dict(['service', 'ssh'])
{'ssh': {'disable-host-validation': {}, 'port': ['22']}}
>>> conf.get_config_dict(['service', 'non-existing'])
{}

get_config_dict() retuns an empty dict if path in CLI does not exist. Tested on 1.3.0-rc5 and current

c-po closed this task as Resolved.Aug 8 2021, 4:48 PM
c-po assigned this task to jestabro.
erkin set Issue type to Internal change (not visible to end users).Aug 31 2021, 5:43 PM
syncer edited projects, added VyOS 1.3 Equuleus (1.3.0-epa1); removed test, VyOS 1.3 Equuleus.Sep 5 2021, 7:06 AM
c-po moved this task from Need Triage to Finished on the VyOS 1.3 Equuleus (1.3.0-epa1) board.Sep 5 2021, 4:08 PM