using regex for path split

[eberna]

SUMMARY

Fixes #349

ISSUE TYPE

• Bugfix Pull Request

COMPONENT NAME

ansible.utils.update_fact

ADDITIONAL INFORMATION

If a key in the path contains a square bracket the module does not separate the path correctly and if fails. This request changes the parser part to use regular expressions.

ansible@lnx-controller:~/ansible_collections/ansible/utils$ ansible-playbook -vv  main.yaml
ansible-playbook [core 2.16.3]
  config file = /home/ansible/ansible_collections/ansible/utils/ansible.cfg
  configured module search path = ['/home/ansible/.ansible/plugins/modules', '/usr/share/ansible/plugins/modules']
  ansible python module location = /home/ansible/.local/pipx/venvs/ansible/lib/python3.11/site-packages/ansible
  ansible collection location = /home/ansible/ansible_collections
  executable location = /home/ansible/.local/bin/ansible-playbook
  python version = 3.11.2 (main, May  2 2024, 11:59:08) [GCC 12.2.0] (/home/ansible/.local/pipx/venvs/ansible/bin/python)
  jinja version = 3.1.2
  libyaml = True
Using /home/ansible/ansible_collections/ansible/utils/ansible.cfg as config file
[DEPRECATION WARNING]: [defaults]collections_paths option, does not fit var naming standard, use the singular form collections_path instead. This feature
 will be removed from ansible-core in version 2.19. Deprecation warnings can be disabled by setting deprecation_warnings=False in ansible.cfg.
[WARNING]: No inventory was parsed, only implicit localhost is available
[WARNING]: provided hosts list is empty, only localhost is available. Note that the implicit localhost does not match 'all'
running playbook inside collection ansible.utils
Skipping callback 'default', as we already have a stdout callback.
Skipping callback 'minimal', as we already have a stdout callback.
Skipping callback 'oneline', as we already have a stdout callback.

PLAYBOOK: main.yaml **************************************************************************************************************************************
1 plays in main.yaml

PLAY [127.0.0.1] *****************************************************************************************************************************************

TASK [Gathering Facts] ***********************************************************************************************************************************
task path: /home/ansible/ansible_collections/ansible/utils/main.yaml:1
ok: [127.0.0.1]

TASK [set fact] ******************************************************************************************************************************************
task path: /home/ansible/ansible_collections/ansible/utils/main.yaml:4
ok: [127.0.0.1] => {"ansible_facts": {"my_dict": {"[runners]": "old value"}}, "changed": false}

TASK [update fact] ***************************************************************************************************************************************
task path: /home/ansible/ansible_collections/ansible/utils/main.yaml:8
An exception occurred during task execution. To see the full traceback, use -vvv. The error was: KeyError: '[runners'
fatal: [127.0.0.1]: FAILED! => {"changed": false, "msg": "Error: the key '[runners' was not found in {'[runners]': 'old value'}."}

PLAY RECAP ***********************************************************************************************************************************************
127.0.0.1                  : ok=2    changed=0    unreachable=0    failed=1    skipped=0    rescued=0    ignored=0

ansible@lnx-controller:~/ansible_collections/ansible/utils$ ansible-playbook -vv  main.yaml
ansible-playbook [core 2.16.3]
  config file = /home/ansible/ansible_collections/ansible/utils/ansible.cfg
  configured module search path = ['/home/ansible/.ansible/plugins/modules', '/usr/share/ansible/plugins/modules']
  ansible python module location = /home/ansible/.local/pipx/venvs/ansible/lib/python3.11/site-packages/ansible
  ansible collection location = /home/ansible/ansible_collections
  executable location = /home/ansible/.local/bin/ansible-playbook
  python version = 3.11.2 (main, May  2 2024, 11:59:08) [GCC 12.2.0] (/home/ansible/.local/pipx/venvs/ansible/bin/python)
  jinja version = 3.1.2
  libyaml = True
Using /home/ansible/ansible_collections/ansible/utils/ansible.cfg as config file
[DEPRECATION WARNING]: [defaults]collections_paths option, does not fit var naming standard, use the singular form collections_path instead. This feature
 will be removed from ansible-core in version 2.19. Deprecation warnings can be disabled by setting deprecation_warnings=False in ansible.cfg.
[WARNING]: No inventory was parsed, only implicit localhost is available
[WARNING]: provided hosts list is empty, only localhost is available. Note that the implicit localhost does not match 'all'
running playbook inside collection ansible.utils
Skipping callback 'default', as we already have a stdout callback.
Skipping callback 'minimal', as we already have a stdout callback.
Skipping callback 'oneline', as we already have a stdout callback.

PLAYBOOK: main.yaml **************************************************************************************************************************************
1 plays in main.yaml

PLAY [127.0.0.1] *****************************************************************************************************************************************

TASK [Gathering Facts] ***********************************************************************************************************************************
task path: /home/ansible/ansible_collections/ansible/utils/main.yaml:1
ok: [127.0.0.1]

TASK [set fact] ******************************************************************************************************************************************
task path: /home/ansible/ansible_collections/ansible/utils/main.yaml:4
ok: [127.0.0.1] => {"ansible_facts": {"my_dict": {"[runners]": "old value"}}, "changed": false}

TASK [update fact] ***************************************************************************************************************************************
task path: /home/ansible/ansible_collections/ansible/utils/main.yaml:8
changed: [127.0.0.1] => {"changed": true, "my_dict": {"[runners]": "new value"}}

TASK [debug] *********************************************************************************************************************************************
task path: /home/ansible/ansible_collections/ansible/utils/main.yaml:15
ok: [127.0.0.1] => {
    "my_dict": {
        "[runners]": "old value"
    }
}

TASK [debug] *********************************************************************************************************************************************
task path: /home/ansible/ansible_collections/ansible/utils/main.yaml:16
ok: [127.0.0.1] => {
    "updated": {
        "changed": true,
        "failed": false,
        "my_dict": {
            "[runners]": "new value"
        }
    }
}

PLAY RECAP ***********************************************************************************************************************************************
127.0.0.1                  : ok=5    changed=1    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0

Hope this may help, thank you.

[softwarefactory-project-zuul]

Build succeeded.
https://ansible.softwarefactory-project.io/zuul/buildset/016fb106bc9e4529b14f76cc707eac33

✔️ ansible-galaxy-importer SUCCESS in 4m 05s
✔️ build-ansible-collection SUCCESS in 5m 44s

[softwarefactory-project-zuul]

Build succeeded.
https://ansible.softwarefactory-project.io/zuul/buildset/9d4ea7e0024e4e50b1bfc6a34065fe5c

✔️ ansible-galaxy-importer SUCCESS in 4m 44s
✔️ build-ansible-collection SUCCESS in 5m 47s

[Ruchip16]

@eberna can you please add specific tests as well to validate the change?

[eberna]

@eberna can you please add specific tests as well to validate the change?

Integration or unit test? or both?
thanks

[Ruchip16]

@eberna can you please add specific tests as well to validate the change?

Integration or unit test? or both? thanks

I am fine with both or anything that would validate this particular change.

[softwarefactory-project-zuul]

Build succeeded.
https://ansible.softwarefactory-project.io/zuul/buildset/ca66b3804f8444209b400099c423ad8c

✔️ ansible-galaxy-importer SUCCESS in 4m 13s
✔️ build-ansible-collection SUCCESS in 5m 49s

[eberna]

@eberna can you please add specific tests as well to validate the change?

Integration or unit test? or both? thanks

I am fine with both or anything that would validate this particular change.

done, I hope it's okay, in case let me know and I'll edit.

[softwarefactory-project-zuul]

Build succeeded.
https://ansible.softwarefactory-project.io/zuul/buildset/3f91d5020a5540779d3284cef53a5127

✔️ ansible-galaxy-importer SUCCESS in 4m 03s
✔️ build-ansible-collection SUCCESS in 6m 48s

[softwarefactory-project-zuul]

Build succeeded.
https://ansible.softwarefactory-project.io/zuul/buildset/dfd9d9fa14cf4c8ab5d9b40e0d28907d

✔️ ansible-galaxy-importer SUCCESS in 3m 53s
✔️ build-ansible-collection SUCCESS in 5m 48s

[softwarefactory-project-zuul]

Build succeeded.
https://ansible.softwarefactory-project.io/zuul/buildset/abfca5c510eb494996492476a0e802d3

✔️ ansible-galaxy-importer SUCCESS in 5m 30s
✔️ build-ansible-collection SUCCESS in 5m 48s