Salt-nornir

CHANGES

1. Removed ``cli`` argument support from ``nr.test`` execution module function as it was not used in the code anyway, instead can supply extra arguments using ``**kwargs``
2. Updated and tested dependencies:

- PyYaml 5.4.1 -> 6.0.1
- napalm 4.0.0 -> 4.1.0
- pydantic 1.10.2 -> 2.0.3
- nornir-netmiko 0.2.0 -> 1.0.0
- nornir-napalm 0.3.0 -> 0.4.0
- nornir-scrapli 2022.07.30 -> 2023.7.30
- scrapli 2022.07.30 -> 2023.7.30
- scrapli-community 2022.07.30 -> 2023.7.30
- scrapli-netconf 2022.07.30 -> 2023.7.30
- pyats 22.1 -> 23.7
- genie 22.1 -> 23.7
- pygnmi 0.8.9 -> 0.8.12
- pynetbox 7.0.0 -> 7.0.1
- lxml 4.9.2 -> 4.9.3
- rich 12.6.0 -> 13.5.2
- robotframework 6.0.2 -> 6.1.1
- dnspython 2.3.0 -> 2.4.2
- saltstack 3006.0 -> 3006.2

3. Added Pydantic 2.0 support, pydantic 1.x will be deprecated in 0.21 release
4. Changes to install extras:

- `prodmax` replaced with `prodmaxminion` and `prodmaxmaster` to optimize set of installed packages
- `prodmin` replaced with `prodminminion` and `prodminmaster` to optimize set of installed packages

FEATURES

1. nr.test added support for ``salt`` argument for test items, which allows to control salt-nornir execution module function and parameters to use to run the test
2. stare nr.workflow module added support for step `stop_if_fail` argument to stop workflow execution for given host if step fail this is to address 35 feature request
3. Added new nr.netbox execution module function `get_circuits` to retrive devices' circuit details from netbox

BUGS

1. Improoved nr.netbox get_interface handling for cases when remote connection terminates on provider network
2. Fix nr.cli handling multiline commands file downloaded from master making sure file content splitted into multiple lines and each line sent to device one by one when `split_lines` set to True

ENHANCEMENTS

1. nr.test added support to specify `worker` to render and run tests with 31
2. nr.test added support for `job_data` argument for tests rendering 32

FEATURES

1. nr.netbox execution module `get_interfaces` added support to cache data received from Netbox using diskcache module
2. Salt-Nornir robot nr.test added overall tests counter for robot framework outputted logs
3. Salt-Nornir robot nr.test added support to wrap commands output per device per-command instead of just per device on robot log output
4. Salt-Nornir robot nr.test added CSV results section to robot report to contain results in CSV format

CHANGES

ENHANCEMENTS

1. Done testing with Salt 3006

CHANGES

1. Enhanced Robot nr.test keyword logging and reporting - now reports have success/failure highlighting, full test suite results returned with collected device output for each test suite.
2. Netbox pillar main function enveloped in try/except loop making sure unexpected pillar etrieval failure handled more gracefully.
3. Updated dependencies to comply with Salt 3006 static requirements:

- pyyaml from 6.0 to 5.4.1
- requests from 2.28.1 to 2.25.1
- psutil from `>=5.8.*,<=5.9.*` to `>=5.8.*,<6.*`

4. Changes to development environment itself:

- Use `python:3.9-slim-bullseye` as a base image for testing
- Updated ceos instances to 4.30.0F
- A number of tests being fixed following above changes

5. Changes to install extras:

- 'prodmax' replaced with prodmaxminion and prodmaxmaster
- 'prodmin' replaced with prodminminion and prodminmaster

BUGS

1. Updated refresh behavior to preserve worker stats across Nornir refresh, where previously those stats have been set to 0 on each refresh

FEATURES

1. nr.netbox `get_interfaces` and `get_connetions` added sync argument to store retrieved data in host's inventory
2. nr.netbox `get_interfaces` and `get_connetions` added support to retrieve data for hosts matched by Fx filters
3. nr.nornir inventory added support for `update_defaults`` function to update in-memory defaults inventory data, 28

CHANGES

1. nr.netbox `get_interfaces` and `get_connetions` now return dictionary keyd by hostnames
2. nr.netbox `get_interfaces` and `get_connetions` removed device_name argument, instead need to use Fx filters
3. Updated netbox_utils to support sourcing Netbox URL and Token directly from proxy minion pillar in addition to sourcing it from master's ext_pillar configuration

BUGS

1. Fixed Netbox `get_interfaces` inventory items handling when inventory item not assigned to any component

BUGS:

1. NETBOX secrets - If uses `secret_name_map: {password: username}` and `fetch_password: True`, secret name does not end up in username value, updated code to check `secret_name_map` for `username` and `password` keys to store secret names accordingly for `fetch_username` and `fetch_password` cases.
2. NETBOX secrets - if no plugins defined under secrets section, KeyError raised - updated code to improve error handling by raising RuntimeError with useful message instead of key error
3. nr.test suite validation was not working

FEATURES:

1. NETBOX secrets - added support to match secret role by secret role slug in addition to secret role name
2. Netbox pillar - added `host_primary_ip` parameter to control which primary IP (ip4 or ip6) to use as host's hostname
3. Netbox pillar - when `host_add_netbox_data` configured, sites now has list of tags retrieved
4. nr.netbox execution module added `rest` function to retrieve data from Netbox over REST API
5. Netbox pillar - added support for `netbox_secrets` plugin
6. Runner - added experimental nr.shell runner function to start interactive shell (using PICLE) based on salt nornir pydantic models
7. Execution module nr.test suite argument can now be a string which is either a YAML blob or a Jinja2 template to render to produce YAML blob of tests
8. Execution module nr.nornir connect added support for ``via`` attribute
9. Execution module nr.nornir connect added support to redipatch connection via terminal server using Netmiko
10. Execution module nr.nornir got new read_host_data function to read portions of host inventory data
11. Execution modeule nr.test added ``tests`` argument to support retrieving tests from host's inventory data. also added ``strict`` argument to control behavior if tests data not present in host's inventory
12. Added integration with Robot framework for nr.test function
13. Added integration with Robot framework for nr.cli function
14. Added new execution module function `nr.network` to implement network related utilites, so far added `resolve_dns` utility.

CHANGES

1. Netbox pillar - when `host_add_netbox_data` configured, device tags transformed into a list of tag names instead of list of tags dictionaries
2. nr.netbox `get_connections` and `get_interfaces` fully compatible with Netbox 3.4 only, this is due to changes introduced to GraphQL API on Netbox side
3. Runner nr.diagram set to increase netmiko read_timeout timer to 120 seconds by default
4. Netbox pillar no longer raises KeyError if no platform found for host in Netbox

DOCS

1. Converted Netbox Pillar tables to lists of items, as tables did not fit read the docs screen entirely.