Merge branch 'main' into add_get_defaults_from_dict

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,70 @@
+## For most projects, this workflow file will not need changing; you simply need
+## to commit it to your repository.
+##
+## You may wish to alter this file to override the set of languages analyzed,
+## or to provide custom queries or build logic.
+##
+## ******** NOTE ********
+## We have attempted to detect the languages in your repository. Please check
+## the `language` matrix defined below to confirm you have the correct set of
+## supported CodeQL languages.
+##
+#name: "CodeQL"
+#
+#on:
+#  push:
+#    branches: [ develop ]
+#  pull_request:
+#    # The branches below must be a subset of the branches above
+#    branches: [ develop ]
+#  schedule:
+#    - cron: '45 5 * * 3'
+#
+#jobs:
+#  analyze:
+#    name: Analyze
+#    runs-on: ubuntu-latest
+#    permissions:
+#      actions: read
+#      contents: read
+#      security-events: write
+#
+#    strategy:
+#      fail-fast: false
+#      matrix:
+#        language: [ 'python' ]
+#        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+#        # Learn more about CodeQL language support at https://git.io/codeql-language-support
+#
+#    steps:
+#    - name: Checkout repository
+#      uses: actions/checkout@v2
+#
+#    # Initializes the CodeQL tools for scanning.
+#    - name: Initialize CodeQL
+#      uses: github/codeql-action/init@v1
+#      with:
+#        languages: ${{ matrix.language }}
+#        # If you wish to specify custom queries, you can do so here or in a config file.
+#        # By default, queries listed here will override any specified in a config file.
+#        # Prefix the list here with "+" to use these queries and those in the config file.
+#        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+#
+#    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+#    # If this step fails, then you should remove it and run the build manually (see below)
+#    - name: Autobuild
+#      uses: github/codeql-action/autobuild@v1
+#
+#    # ℹ️ Command-line programs to run using the OS shell.
+#    # 📚 https://git.io/JvXDl
+#
+#    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+#    #    and modify them (or add more) to build your code if your project
+#    #    uses a compiled language
+#
+#    #- run: |
+#    #   make bootstrap
+#    #   make release
+#
+#    - name: Perform CodeQL Analysis
+#      uses: github/codeql-action/analyze@v1

.github/workflows/main.yaml

@@ -21,6 +21,7 @@ jobs:
       - name: Install Poetry
         uses: snok/install-poetry@v1
         with:
+          version: 1.3.2
           virtualenvs-create: true
           virtualenvs-in-project: true
 
@@ -53,8 +54,8 @@ jobs:
         shell: bash
     strategy:
       matrix:
-        python-version: [ '3.6', '3.7', '3.8', '3.9' ]
-        platform: [ubuntu-latest, macOS-10.15, windows-latest]
+        python-version: [ '3.8', '3.9', '3.10', '3.11'  ]
+        platform: [ubuntu-latest, macOS-latest, windows-latest]
     runs-on: ${{ matrix.platform }}
     steps:
       - uses: actions/checkout@v2
@@ -67,6 +68,7 @@ jobs:
       - name: Install Poetry
         uses: snok/install-poetry@v1
         with:
+          version: 1.3.2
           virtualenvs-create: true
           virtualenvs-in-project: true
 
@@ -94,21 +96,21 @@ jobs:
         run: make nbval
         if: ${{ matrix.platform != 'windows-latest' }}
 
-  release:
-    name: Releasing to pypi
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@master
-      - name: Build
-        uses: abatilo/[email protected]
-        with:
-          python_version: 3.8.0
-          poetry_version: 1.0
-          working_directory: .
-          args: build
-      - name: Publish package
-        if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags')
-        uses: pypa/gh-action-pypi-publish@master
-        with:
-          user: __token__
-          password: ${{ secrets.pypi_password }}
+#  release:
+#    name: Releasing to pypi
+#    runs-on: ubuntu-latest
+#    steps:
+#      - uses: actions/checkout@master
+#      - name: Build
+#        uses: abatilo/[email protected]
+#        with:
+#          python_version: 3.8.0
+#          poetry_version: 1.3.2
+#          working_directory: .
+#          args: build
+#      - name: Publish package
+#        if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags')
+#        uses: pypa/gh-action-pypi-publish@master
+#        with:
+#          user: __token__
+#          password: ${{ secrets.pypi_password }}

.readthedocs.yml

@@ -1,11 +1,18 @@
 ---
+version: 2
+formats: []
 build:
-  image: latest
-
-python:
-  version: 3.6
-  pip_install: true
-  extra_requirements:
-    - docs
+  os: "ubuntu-22.04"
+  tools:
+    python: "3.11"
+  jobs:
+    post_create_environment:
+      - pip install poetry
+      - poetry config virtualenvs.create false
+    post_install:
+      # Install dependencies with 'docs' dependency group
+      # https://python-poetry.org/docs/managing-dependencies/#dependency-groups
+      - poetry install --with docs
 
-formats: []
+sphinx:
+  configuration: docs/conf.py

CHANGELOG.rst

@@ -1,6 +1,20 @@
 Changelog
 ==========
 
+3.2.0 - November 16 2021
+------------------------
+
+- update gha snok/install-poetry (#736) @dbarrosop
+- Update pygments because of vulnerabilities (#732) @ubaumann
+- Replace pkg_resources with importlib (#731) @ubaumann
+- Fix GitHub actions MacOS arch failure (#729) @ktbyers
+- Minor doc error on NORNIR_RUNNER_OPTIONS environment variable (#725) @ktbyers
+- Correct configuration order preference error (#728) @ktbyers
+- Update task_results.ipynb (#715) @MajesticFalcon
+- fixing domain name typo (#704) @marco-minervino
+- update ruamel dependency (#694) @itdependsnetworks
+- fixed stubs for mypy 0.900 (#696) @dbarrosop
+
 3.1.1 - April 26 2021
 ---------------------
 

Dockerfile

@@ -1,14 +1,14 @@
 ARG PYTHON
-FROM python:${PYTHON}-slim-stretch
+FROM python:${PYTHON}-slim-bookworm
 
-ENV PATH="/root/.poetry/bin:$PATH" \
+ENV PATH="/root/.local/bin:$PATH" \
     PYTHONDONTWRITEBYTECODE=1 \
     PYTHONUNBUFFERED=1 \
     NORNIR_TESTS=1
 
 RUN apt-get update \
     && apt-get install -yq curl git pandoc make \
-    && curl -sSL https://raw.githubusercontent.com/sdispater/poetry/master/get-poetry.py | python \
+    && curl -sSL https://install.python-poetry.org  | python3 - \
     && poetry config virtualenvs.create false
 
 COPY pyproject.toml .
@@ -17,7 +17,7 @@ COPY poetry.lock .
 # Dependencies change more often, so we break RUN to cache the previous layer
 RUN poetry install --no-interaction
 
-ARG NAME
+ARG NAME=nornir
 WORKDIR /${NAME}
 
 COPY . .

Makefile

@@ -4,7 +4,7 @@ DOCKER_COMPOSE_FILE=docker-compose.yaml
 DOCKER_COMPOSE=PYTHON=${PYTHON} docker-compose -f ${DOCKER_COMPOSE_FILE}
 NORNIR_DIRS=nornir tests docs
 
-PYTHON:=3.7
+PYTHON:=3.10
 
 .PHONY: docker
 docker:

README.md

@@ -16,7 +16,7 @@ What Nornir brings to the table is that it takes care of dealing with your inven
 Install
 =======
 
-Please note that Nornir requires Python 3.6.2 or higher. Install Nornir with pip.
+Please note that Nornir requires Python 3.7 or higher. Install Nornir with pip.
 
 ```
 pip install nornir
@@ -39,7 +39,7 @@ If you want to clone the repo and install it from there you will need to use [po
 Documentation
 =============
 
-Read the [Nornir documentation](https://nornir.readthedocs.io/) online or review it's [code here](https://github.com/nornir-automation/nornir/tree/develop/docs)
+Read the [Nornir documentation](https://nornir.readthedocs.io/) online or review its [code here](https://github.com/nornir-automation/nornir/tree/develop/docs)
 
 Examples
 ========

SECURITY.md

@@ -0,0 +1,10 @@
+# Security Policy
+
+## Supported Versions
+
+Only latest version is supported.
+
+## Reporting a Vulnerability
+
+To report a vulnerability feel free to reach out on [slack](https://github.com/nornir-automation/nornir#contact--support) so we can fix before a public disclosure.
+If the issue is on a dependency feel free to open a PR bumping such depdency without contacting us first.

docs/_images/Nornir3_Plugins_v0.drawio

@@ -0,0 +1 @@
+<mxfile host="Electron" modified="2022-05-23T10:06:55.813Z" agent="5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/13.3.9 Chrome/83.0.4103.119 Electron/9.0.5 Safari/537.36" etag="JW5QLFOkV7FbO5AIkN8e" version="13.3.9" type="device"><diagram id="1RKNiAfXPDfAQ1DdleVT" name="Page-1">7Vtdd5s4EP01eQxHID4fbcdum20Sb5zdNn3Zg0Gx2WBEBU7s/fUrgcCAhJPUkHg3cc9pzIAFmnt1Z0YSJ3C02nwibry8wD4KTzTgb07g2Ymm2aZN/2eGbW4wVJAbFiTwc5O6M8yCfxA3FpetAx8ltQtTjMM0iOtGD0cR8tKazSUEP9Yvu8Nh/a6xu0CCYea5oWj9FvjpkndLs3b2zyhYLIs7q6aTn1m5xcW8J8nS9fFjxQTHJ3BEME7zb6vNCIXMd4Vf8t9NWs6WD0ZQlD7nB3B9vogeHu8vls5QXX959C4uxqe8lQc3XPMOQ+KfsJbMkLY6nBP25OmWu8P8uWaPO7zDUXqaZGAN6AWqE1O8h7vz9NuC/Z26JN3y7peNaMt0FdJvKr3ATeIctbtgg+iDDksvAXY2DBYR/e7RLiJCDQ+IpAEFZ8BPrALfZ62yn8Ws9dVmwWioLLxYU3w3dedugv6ivh6G7hyFU5wEaYClbX5tXFC2zTrLiak6xTHvDesDvaMf0NbOAkL7kv84wWsG//AuCMMRDjHJeg7HJvuXOagJXoEEfRq0qZg4mJ8QXqGUUGcCftZy+E+2BfUcBWq56bFK1dy0rLIUGIoK+SDhA2RR3mDHIfqF00hOqZEb/LmdqVe/xz8TSwuHf9ze6qeaQCmBAASvI5/BnaH8uAxSNItdj519pPBRW4UiSUrwfTn4NA5Axal32adfZ6sWqDtbB4KnTQBEV1NrT36Ggp+n23RJ2aeBwfTLYT5veFKduyra53k5RtVBUhlEmnRoJ/RhgmhxzV0HesLNfCZusC/YisBWwe1L9EB7iLPnrgov19BwvQiiRACUeiCVjZQKPgCoZ8PRi4RURow6dWoKvQjdJClO3KPUW/KDJt5tzCE4dblmApF4gH5MU6DT4bwwHK3GC42Kp2oI1FCL9KVKDQMqhbl7dogB+Ya4UXKHyUrKjsk6ymLOy/kR4Qi9NTVUW6TGJPscETVsUTLkvACKbfTFC13gxejqenxgZH0WXHVtb2g53BuPGzGglVkFB0N0l+5Cwdfs6Ix2vTTd4JhZjD106IAB0DYUx67HDUdCAk0SN8oLO6eAJcmrmmpwiUkUENFeiTD/m1y8DCtP5eIRJlkuXpxraI3jiGyaTGzKp27YpDtOXU+AKcvTVWArjiEhFHR6DDeGKCt5IR1kiWRb7vGyZLKLpFGVoATAaASq3CS525q5ZE81ALRETTCc18wlNVETrtcUPvKiRLK3mNGQZ9ASTeqgwqF9NmlWDHBPmvB8YWrSi9NkiNMUrwqOdUEUu04UmhkIRNFUyVi3rb6IIo7zGze57zEapCxSt9aR0hBBL2YzfY2c8llppL5HZroA1GmMfNURALUkA9+0FKcvRM0PRA9AVLP1o0PUERCdEuyhJMHkPynakrK/A9GuVIWnTkcpGtQ0xWxkaY6h2DR1Kz+WmLGptmJKZle1vlQcikWgwIvmOPSCxMMKZQt1c8L/1skR44BhMGYVQsJtvpssd1W9gH5bmj7nkbRFOwTQ6dOEQYRG5doNOHxKQXvBDDEYDEaTUUeKAoBi1Cik66qYH8rSQ6g4vVFGDPwflDkWykDdOELK6GJm0T7J+E7DUAdyoTdqBCCZYDIkNQLsay7AEBcmPqTiWKRCt+3mlKSu04Dz9nJh2E/TBkX+gO3FYOgwJweeOEO0p9QvBQBtgvQ7A0UBjsGPb1kb9Bjy47MNRy072FYOpogEtM+MG/uXFxO8Jh7a0+eidkd+bfOIiN4TuBQ2gkKa0z6g2lPIkOJ3mLJBVdESzVCAtUtVGzwBUNEdUH4azeed5S3uuCC9iQktAzps5svWAJRHrqLd1CULlArtZhwrPXQA7cRqqTfatRLlSPCHltpE/NcwhhaoYazqDYx3ivNKMJvieugrqIthw7q6GO9YXQwV0uK48hHUBYCD1cVQdUUzKsyTEK/1Jn1zUEyIZx4JYprPaKa7YrlHNE/iDHPQs+kG4/ANbjuI41fM/VvWmlv2DTXLBWhCB/qSdKxYLZKtMsmKgw7SNrUxq1QuGde2H6mSjK2DWcZzdX75cBGO/U/npzdD7+o8+WGfilNIs9lnAdpn7h2perixnYQv5R+wmeSJbSKlbHdemcGG+Ej2BekSudU6WOWTQiZO4VyOb0ZXl5MP2GqbNo4MNjFqXI9nH7gJ2600Wp5YxwWdbKvNx0zIccyEmLA+caZD55WnQaSUeZNZEFtr1CnveRbENHTFsNrrFK2LOsU02JsTZZ2iNm5S4WL3xYmUd+I0yOLyQtz9/54jjGlqzWUWWtJKNKOvGCN980qiD3QcFf1mWxbxAkcuhbu0Nvy5u+YrzvfFUuPfKE233MvuOsV10KkTyfZ79eA2ExKjONzpRna0lUBnitCVJVNC2Z4WIodjFBW2ScC8w1suZRBT2uYWfl59riDte5ktH3H7hAs8U7hepki0V+62ckEW8JN2wbKLXaDFEhBfeduxKm/xV/XiPpjiH3P8G0I3U3T/7cGbjYDkhb9iz/BusycYEI+NZi9dE3S8UtLydpHeVekurLhIXgSAsk1Cv6AZ9HD3JmiO9e51Wjj+Fw==</diagram></mxfile>

docs/api/nornir/core/plugins/connections.rst

@@ -0,0 +1,6 @@
+nornir.core.plugins.connections
+=========================================
+
+.. automodule:: nornir.core.plugins.connections
+  :members:
+  :undoc-members:

docs/howto/ipdb_how_to_inspect_complex_structures.rst

@@ -2,7 +2,7 @@
 ipdb: How to inspect complex structures
 =======================================
 
-Python comes with a debuger called pdb. The python debugger is very powerful and really facilitates troubleshooting code. You can find the official documentation `here <https://docs.python.org/3.6/library/pdb.html>`_. `ipdb <https://github.com/gotcha/ipdb>`_ builds on top of ipython and pdb to give users a more interactive experience.
+Python comes with a debuger called pdb. The python debugger is very powerful and really facilitates troubleshooting code. You can find the official documentation `here <https://docs.python.org/3/library/pdb.html>`_. `ipdb <https://github.com/gotcha/ipdb>`_ builds on top of ipython and pdb to give users a more interactive experience.
 
 This how to isn't very extensive, it's just a very quick and dirty demo to show some of it's capabilities and how to use it with nornir. It doesn't assume previous knowledge but doesn't spend too much on explanations either so it expects users to give enough material for further investigation.
 

docs/howto/ipdb_how_to_use_it_with_nornir.rst

@@ -1,7 +1,7 @@
 ipdb: How to use it with Nornir
 ===============================
 
-Python comes with a debuger called pdb. The python debugger is very powerful and really facilitates troubleshooting code. You can find the official documentation `here <https://docs.python.org/3.6/library/pdb.html>`_. `ipdb <https://github.com/gotcha/ipdb>`_ builds on top of ipython and pdb to give users a more interactive experience.
+Python comes with a debuger called pdb. The python debugger is very powerful and really facilitates troubleshooting code. You can find the official documentation `here <https://docs.python.org/3/library/pdb.html>`_. `ipdb <https://github.com/gotcha/ipdb>`_ builds on top of ipython and pdb to give users a more interactive experience.
 
 This how to isn't very extensive, it's just a very quick and dirty demo to show some of it's capabilities and how to use it with nornir. It doesn't assume previous knowledge but doesn't spend too much on explanations either so it expects users to give enough material for further investigation.
 

docs/index.rst

@@ -17,7 +17,7 @@ as the Flask of automation. Nornir will take care of dealing with the inventory
 have your host information, it will take care of dispatching the tasks to your devices and
 will provide a common framework to write "plugins".
 
-Nornir requires Python 3.6.2 or higher to be installed.
+Nornir requires Python 3.7 or higher to be installed.
 
 How the documentation is structured
 ===================================

docs/nbval_sanitize.cfg

@@ -5,3 +5,12 @@ replace: \n
 [regex2]
 regex: File ".*task.py".
 replace: File "nornir/nornir/core/task.py"
+
+[regex3]
+regex: File "[\w\d/]*.py", line
+replace: File "/tmp/ipykernel_random.py", line
+
+# Py3.11 adds "^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^" to the traceback output
+[regex4]
+regex: \n\s*\^*\n
+replace: \n

docs/plugins/index.rst

@@ -3,6 +3,8 @@ Plugins
 
 Nornir is a pluggable system and only very basic ones are included with nornir 3, for a list of third party plugins visit `nornir.tech <https://nornir.tech/nornir/plugins>`_
 
+.. image:: ../_images/Nornir3_Plugins_v0.jpg
+
 Registering plugins
 -------------------
 

docs/tutorial/failed_tasks.ipynb

@@ -223,7 +223,7 @@
       "\u001b[0mTraceback (most recent call last):\n",
       "  File \"/nornir/core/task.py\", line 99, in start\n",
       "    r = self.task(self, **self.params)\n",
-      "  File \"<ipython-input-1-3ab8433d31a3>\", line 20, in say\n",
+      "  File \"/tmp/ipykernel_8235/676894166.py\", line 20, in say\n",
       "    raise Exception(\"I can't say anything right now\")\n",
       "Exception: I can't say anything right now\n",
       "\u001b[0m\n",
@@ -481,7 +481,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
    "name": "python3"
   },
@@ -495,7 +495,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.7"
+   "version": "3.8.10"
   }
  },
  "nbformat": 4,