T8205 Ensure the vyos_user module works when user properties are defined in… by gideon-kuijt-northwave · Pull Request #445 · vyos/vyos.vyos

gideon-kuijt-northwave · 2026-01-16T16:00:34Z

Ensure the vyos_user module works when user properties are defined in aggregate. Previously the value variable is not filled when a property is configured as a property of a user. This gives a python error when the value variable is called.

Change Summary

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Code style update (formatting, renaming)
Refactoring (no functional changes)
Migration from an old Vyatta component to vyos-1x, please link to related PR inside obsoleted component
Other (please describe):

Related Task(s)

https://vyos.dev/T8205

Related PR(s)

Component(s) name

vyos_user

Proposed changes

Ensuring that the value variable will always be defined in the get_param_value function regardless of whether it is created inside or outside the aggregate of the vyos_user module.

How to test

Version information:

$ ansible-playbook --version
ansible-playbook [core 2.20.1]
  config file = None
  configured module search path = ['$HOME/.ansible/plugins/modules', '/usr/share/ansible/plugins/modules']
  ansible python module location = /opt/homebrew/Cellar/ansible/13.2.0_1/libexec/lib/python3.14/site-packages/ansible
  ansible collection location = $HOME/.ansible/collections:/usr/share/ansible/collections
  executable location = /opt/homebrew/bin/ansible-playbook
  python version = 3.14.2 (main, Dec  5 2025, 16:49:16) [Clang 17.0.0 (clang-1700.4.4.1)] (/opt/homebrew/Cellar/ansible/13.2.0_1/libexec/bin/python)
  jinja version = 3.1.6
  pyyaml version = 6.0.3 (with libyaml v0.2.5)

Ran a playbook with the following configuration:

- vyos_user:
    aggregate:
      - name: user1
        configured_password: "password"
      - name: user2
        configured_password: "password"

This results in the following error:
"msg": "Task failed: cannot access local variable 'value' where it is not associated with a value"

Test results

Sanity tests passed
(had to create an ignore file for ansible 2.20 for action-plugin-docs)

$ ansible-test sanity                                         
Running sanity test "action-plugin-docs"
Running sanity test "ansible-doc"
Running sanity test "changelog"
WARNING: Skipping sanity test "compile" on Python 3.9 because it could not be found.
WARNING: Skipping sanity test "compile" on Python 3.10 because it could not be found.
Running sanity test "compile" on Python 3.11
Running sanity test "compile" on Python 3.12
Running sanity test "compile" on Python 3.13
Running sanity test "compile" on Python 3.14
Running sanity test "empty-init"
Running sanity test "ignores"
WARNING: Skipping sanity test "import" on Python 3.9 because it could not be found.
WARNING: Skipping sanity test "import" on Python 3.10 because it could not be found.
Running sanity test "import" on Python 3.11
Running sanity test "import" on Python 3.12
Running sanity test "import" on Python 3.13
Running sanity test "import" on Python 3.14
Running sanity test "line-endings"
Running sanity test "no-assert"
Running sanity test "no-get-exception"
Running sanity test "no-illegal-filenames"
Running sanity test "no-smart-quotes"
Running sanity test "pep8"
Running sanity test "pslint"
Running sanity test "pylint"
Running sanity test "replace-urlopen"
Running sanity test "runtime-metadata"
Running sanity test "shebang"
Running sanity test "shellcheck"
Running sanity test "symlinks"
Running sanity test "use-argspec-type-path"
Running sanity test "use-compat-six"
Running sanity test "validate-modules"
Running sanity test "yamllint"
WARNING: Reviewing previous 4 warning(s):
WARNING: Skipping sanity test "compile" on Python 3.9 because it could not be found.
WARNING: Skipping sanity test "compile" on Python 3.10 because it could not be found.
WARNING: Skipping sanity test "import" on Python 3.9 because it could not be found.
WARNING: Skipping sanity test "import" on Python 3.10 because it could not be found.

Unit tests passed

$ ansible-test units --venv
WARNING: Skipping unit tests on Python 3.11 because it is only supported by module/module_utils unit tests. No module/module_utils unit tests were selected.
WARNING: Skipping unit tests on Python 3.11 because it is only supported by module/module_utils unit tests. No module/module_utils unit tests were selected.
Installing requirements for Python 3.12 [venv]
Installing requirements for Python 3.13 [venv]
Installing requirements for Python 3.14 [venv]
Unit test controller with Python 3.12
============================= test session starts ==============================
platform darwin -- Python 3.12.12, pytest-9.0.2, pluggy-1.6.0
rootdir: $HOME/.ansible/collections/ansible_collections/vyos/vyos
configfile: ../../../../../../../var/folders/8m/jwqbrn6n6z7gnd66ml9jg7wc0000gn/T/ansible-test-shcyl9q6/ansible_test/_data/pytest/config/default.ini
plugins: mock-3.15.1, xdist-3.8.0
created: 14/14 workers
14 workers [374 items]

........................................................................ [ 19%]
........................................................................ [ 38%]
........................................................................ [ 57%]
........................................................................ [ 77%]
........................................................................ [ 96%]
..............                                                           [100%]
- generated xml file: $HOME/.ansible/collections/ansible_collections/vyos/vyos/tests/output/junit/python3.12-controller-units.xml -
============================= 374 passed in 3.64s ==============================
Unit test controller with Python 3.13
============================= test session starts ==============================
platform darwin -- Python 3.13.11, pytest-9.0.2, pluggy-1.6.0
rootdir: /$HOME/.ansible/collections/ansible_collections/vyos/vyos
configfile: ../../../../../../../var/folders/8m/jwqbrn6n6z7gnd66ml9jg7wc0000gn/T/ansible-test-shcyl9q6/ansible_test/_data/pytest/config/default.ini
plugins: mock-3.15.1, xdist-3.8.0
created: 14/14 workers
14 workers [374 items]

........................................................................ [ 19%]
........................................................................ [ 38%]
........................................................................ [ 57%]
........................................................................ [ 77%]
........................................................................ [ 96%]
..............                                                           [100%]
- generated xml file: $HOME/.ansible/collections/ansible_collections/vyos/vyos/tests/output/junit/python3.13-controller-units.xml -
============================= 374 passed in 3.54s ==============================
Unit test controller with Python 3.14
============================= test session starts ==============================
platform darwin -- Python 3.14.2, pytest-9.0.2, pluggy-1.6.0
rootdir: $HOME/.ansible/collections/ansible_collections/vyos/vyos
configfile: ../../../../../../../var/folders/8m/jwqbrn6n6z7gnd66ml9jg7wc0000gn/T/ansible-test-shcyl9q6/ansible_test/_data/pytest/config/default.ini
plugins: mock-3.15.1, xdist-3.8.0
created: 14/14 workers
14 workers [374 items]

........................................................................ [ 19%]
........................................................................ [ 38%]
........................................................................ [ 57%]
........................................................................ [ 77%]
........................................................................ [ 96%]
..............                                                           [100%]
- generated xml file: $HOME/.ansible/collections/ansible_collections/vyos/vyos/tests/output/junit/python3.14-controller-units.xml -
============================= 374 passed in 3.58s ==============================
WARNING: Reviewing previous 1 warning(s):
WARNING: Skipping unit tests on Python 3.11 because it is only supported by module/module_utils unit tests. No module/module_utils unit tests were selected.
WARNING: Reviewing previous 1 warning(s):
WARNING: Skipping unit tests on Python 3.11 because it is only supported by module/module_utils unit tests. No module/module_utils unit tests were selected.

Tested against VyOS versions:

1.4.3

It seems that currently there are no unit tests for aggregate scenario's hence this error slipped through.

Checklist:

I have read the CONTRIBUTING document
I have linked this PR to one or more Phabricator Task(s)
I have run the ansible sanity and unit tests
My commit headlines contain a valid Task id
[] My change requires a change to the documentation
I have updated the documentation accordingly
I have added unit tests to cover my changes
I have added a file to changelogs/fragments to describe the changes

… aggregate Ensure the vyos_user module works when user properties are defined in aggregate. Previously the value variable is not filled when a property is configured as a property of a user. This gives a python error when the value variable is called.

github-actions · 2026-01-16T16:00:45Z

All contributors have signed the CLA ✍️ ✅
_{Posted by the CLA Assistant Lite bot.}

omnom62 · 2026-01-20T21:39:27Z

@gideon-kuijt-northwave thanks for your contribution!
Can you please sign CLA? Just simply create a comment with wording "I have read the CLA Document and I hereby sign the CLA", then I should be able to review and kick-off tests.
Thanks again!

omnom62

@gideon-kuijt-northwave thanks!
is it possible to sign CIA, add changelog and possibly - unit and/or integration test to demo the fix?

gideon-kuijt-northwave · 2026-01-22T11:53:50Z

I have read the CLA Document and I hereby sign the CLA

Create changelog for vyos_user aggregate bugfix

gideon-kuijt-northwave · 2026-01-22T12:05:05Z

@omnom62 I've signed the CLA, and added a changelog fragment. Also added a unit test for the aggregate function, this generates the same error as before my change.

gaige · 2026-01-25T15:39:03Z

I added a task for this: T8205. @gideon-kuijt-northwave please prepend to the title and internal references and then check the box for the task ID.

gaige

Good to go once we have the task information updated.

gideon-kuijt-northwave · 2026-01-26T09:42:56Z

@gaige Thanks for the review. I've updated the title, change log file and checkboxes.

gaige · 2026-01-26T10:01:53Z

@gaige Thanks for the review. I've updated the title, change log file and checkboxes.

Sorry for the lack of clarity, I meant the ones in the PR, so you should be good as soon as Ansible Galaxy is back up and running and a re-test is forced as long as @omnom62 is good with the changes.

omnom62

LGTM

dmbaturin

I see no issues here as far as my knowledge allows, and I trust @omnom62's judgement.

As I understand, this change request no longer applies

…_fix.yml Remove unintended whitespace in changelog fragment: T8205_vyos_user_aggregate_fix.yml

c-po

Requested changes adressed

gideon-kuijt-northwave requested a review from a team as a code owner January 16, 2026 16:00

gideon-kuijt-northwave requested review from dmbaturin, gaige and omnom62 January 16, 2026 16:00

omnom62 requested changes Jan 21, 2026

View reviewed changes

vyosbot added a commit to vyos/vyos-cla-signatures that referenced this pull request Jan 22, 2026

@gideon-kuijt-northwave has signed the CLA in vyos/vyos.vyos#445

fd6d259

gideon-kuijt-northwave added 2 commits January 22, 2026 12:55

Add unit test for aggregate vyos_user module

7b23197

Create vyos_user_aggregate_fix.yml

b046d8d

Create changelog for vyos_user aggregate bugfix

gaige previously requested changes Jan 25, 2026

View reviewed changes

Merge branch 'main' into patch-1

99781e3

gideon-kuijt-northwave changed the title ~~Ensure the vyos_user module works when user properties are defined in…~~ T8205: Ensure the vyos_user module works when user properties are defined in… Jan 26, 2026

gideon-kuijt-northwave changed the title ~~T8205: Ensure the vyos_user module works when user properties are defined in…~~ T8205 Ensure the vyos_user module works when user properties are defined in… Jan 26, 2026

Rename vyos_user_aggregate_fix.yml to T8205_vyos_user_aggregate_fix.yml

e7cf700

omnom62 approved these changes Jan 27, 2026

View reviewed changes

Merge branch 'main' into patch-1

84b31ac

omnom62 requested a review from gaige February 28, 2026 20:21

dmbaturin approved these changes Mar 5, 2026

View reviewed changes

Merge branch 'main' into patch-1

31950bd

c-po requested changes Mar 5, 2026

View reviewed changes

Comment thread changelogs/fragments/T8205_vyos_user_aggregate_fix.yml

Rename T8205_vyos_user_aggregate_fix.yml to T8205_vyos_user_aggregate…

8fc99eb

…_fix.yml Remove unintended whitespace in changelog fragment: T8205_vyos_user_aggregate_fix.yml

c-po approved these changes Mar 5, 2026

View reviewed changes

c-po enabled auto-merge (squash) March 5, 2026 15:33

gaige approved these changes Mar 7, 2026

View reviewed changes

Merge branch 'main' into patch-1

ec99433

c-po disabled auto-merge April 2, 2026 14:21

Merge branch 'main' into patch-1

3068714

dmbaturin merged commit 16e6f21 into vyos:main Apr 7, 2026
45 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

T8205 Ensure the vyos_user module works when user properties are defined in…#445

T8205 Ensure the vyos_user module works when user properties are defined in…#445
dmbaturin merged 10 commits intovyos:mainfrom
gideon-kuijt-northwave:patch-1

gideon-kuijt-northwave commented Jan 16, 2026 •

edited by omnom62

Loading

Uh oh!

github-actions bot commented Jan 16, 2026 •

edited

Loading

Uh oh!

omnom62 commented Jan 20, 2026

Uh oh!

omnom62 left a comment

Uh oh!

gideon-kuijt-northwave commented Jan 22, 2026

Uh oh!

gideon-kuijt-northwave commented Jan 22, 2026

Uh oh!

gaige commented Jan 25, 2026

Uh oh!

gaige left a comment

Uh oh!

gideon-kuijt-northwave commented Jan 26, 2026 •

edited

Loading

Uh oh!

gaige commented Jan 26, 2026

Uh oh!

omnom62 left a comment

Uh oh!

dmbaturin left a comment

Uh oh!

Uh oh!

c-po left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

5 participants

Conversation

gideon-kuijt-northwave commented Jan 16, 2026 • edited by omnom62 Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Change Summary

Types of changes

Related Task(s)

Related PR(s)

Component(s) name

Proposed changes

How to test

Test results

Checklist:

Uh oh!

github-actions bot commented Jan 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

omnom62 commented Jan 20, 2026

Uh oh!

omnom62 left a comment

Choose a reason for hiding this comment

Uh oh!

gideon-kuijt-northwave commented Jan 22, 2026

Uh oh!

gideon-kuijt-northwave commented Jan 22, 2026

Uh oh!

gaige commented Jan 25, 2026

Uh oh!

gaige left a comment

Choose a reason for hiding this comment

Uh oh!

gideon-kuijt-northwave commented Jan 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gaige commented Jan 26, 2026

Uh oh!

omnom62 left a comment

Choose a reason for hiding this comment

Uh oh!

dmbaturin left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

c-po left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

5 participants

gideon-kuijt-northwave commented Jan 16, 2026 •

edited by omnom62

Loading

github-actions bot commented Jan 16, 2026 •

edited

Loading

gideon-kuijt-northwave commented Jan 26, 2026 •

edited

Loading