Merge pull request #301 from networktocode/release-1.0.1

Release 1.0.1

Author: jeffkala

.github/workflows/ci.yml

@@ -83,7 +83,7 @@ jobs:
     strategy:
       fail-fast: true
       matrix:
-        python-version: ["3.7", "3.8", "3.9"]  # "3.10" add back after pyeapi new release.
+        python-version: ["3.8", "3.9", "3.10", "3.11"]  # "3.10" add back after pyeapi new release.
     runs-on: "ubuntu-20.04"
     env:
       PYTHON_VER: "${{ matrix.python-version }}"
@@ -156,7 +156,7 @@ jobs:
     strategy:
       fail-fast: true
       matrix:
-        python-version: ["3.7", "3.8", "3.9"]  # "3.10" add back after pyeapi new release.
+        python-version: ["3.8", "3.9", "3.10", "3.11"]
     runs-on: "ubuntu-20.04"
     env:
       PYTHON_VER: "${{ matrix.python-version }}"

Dockerfile

@@ -15,7 +15,7 @@ RUN apt-get update && \
 RUN pip install --upgrade pip
 
 RUN curl -sSL https://install.python-poetry.org -o /tmp/install-poetry.py && \
-    python /tmp/install-poetry.py --version 1.2.0 && \
+    python /tmp/install-poetry.py --version 1.6.0 && \
     rm -f /tmp/install-poetry.py
 
 # Add poetry install location to the $PATH

docs/admin/release_notes/version_1_0.md

@@ -1,5 +1,10 @@
 # v1.0 Release Notes
 
+## [1.0.1] 11-2023
+
+### Fixed
+- [300](https://github.com/networktocode/pyntc/pull/300) Fixed default port value handling for `aireos, asa, ios` drivers, dropped python 3.7 support, updated pyeapi dependency, refreshed poetry dependencies.
+
 ## [1.0.0] 04-2023
 
 ### Added

poetry.lock

@@ -2,6 +2,7 @@
 
 import os
 import warnings
+from importlib import metadata
 
 from .devices import supported_devices
 from .errors import ConfFileNotFoundError, DeviceNameNotFoundError, UnsupportedDeviceError
@@ -11,11 +12,6 @@
 except ImportError:
     from ConfigParser import SafeConfigParser
 
-try:
-    from importlib import metadata
-except ImportError:
-    # Python version < 3.8
-    import importlib_metadata as metadata
 
 __version__ = metadata.version(__name__)
 

pyntc/__init__.py

@@ -70,7 +70,7 @@ class AIREOSDevice(BaseDevice):
     active_redundancy_states = {None, "active"}
 
     def __init__(  # nosec  # pylint: disable=too-many-arguments
-        self, host, username, password, secret="", port=22, confirm_active=True, **kwargs
+        self, host, username, password, secret="", port=None, confirm_active=True, **kwargs
     ):  # noqa: D403
         """
         PyNTC Device implementation for Cisco WLC.
@@ -80,13 +80,13 @@ def __init__(  # nosec  # pylint: disable=too-many-arguments
             username (str): The username to authenticate with the device.
             password (str): The password to authenticate with the device.
             secret (str): The password to escalate privilege on the device.
-            port (int): The port to use to establish the connection.
+            port (int): The port to use to establish the connection. Defaults to 22.
             confirm_active (bool): Determines if device's high availability state should be validated before leaving connection open.
         """
         super().__init__(host, username, password, device_type="cisco_aireos_ssh")
         self.native = None
         self.secret = secret
-        self.port = int(port)
+        self.port = int(port) if port else 22
         self.global_delay_factor = kwargs.get("global_delay_factor", 1)
         self.delay_factor = kwargs.get("delay_factor", 1)
         self._connected = False

pyntc/devices/aireos_device.py

@@ -38,22 +38,22 @@ class ASADevice(BaseDevice):
     vendor = "cisco"
     active_redundancy_states = {None, "active"}
 
-    def __init__(self, host: str, username: str, password: str, secret="", port=22, **kwargs):  # nosec
+    def __init__(self, host: str, username: str, password: str, secret="", port=None, **kwargs):  # nosec
         """
         Pyntc Device constructor for Cisco ASA.
 
         Args:
             host (str): The address of the network device.
             username (str): The username to authenticate to the device.
             password (str): The password to authenticate to the device.
-            secret (str, optional): The password to escalate privilege on the device. Defaults to "".
+            secret (str, optional): The password to escalate privilege on the device. Defaults to 22.
             port (int, optional): Port used to establish connection. Defaults to 22.
         """
         super().__init__(host, username, password, device_type="cisco_asa_ssh")
 
         self.native: Optional[CiscoAsaSSH] = None
         self.secret = secret
-        self.port = int(port)
+        self.port = int(port) if port else 22
         self.kwargs = kwargs
         self.global_delay_factor: int = kwargs.get("global_delay_factor", 1)
         self.delay_factor: int = kwargs.get("delay_factor", 1)

pyntc/devices/asa_device.py

@@ -44,7 +44,7 @@ class IOSDevice(BaseDevice):
     active_redundancy_states = {None, "active"}
 
     def __init__(  # nosec
-        self, host, username, password, secret="", port=22, confirm_active=True, fast_cli=True, **kwargs
+        self, host, username, password, secret="", port=None, confirm_active=True, fast_cli=True, **kwargs
     ):  # noqa: D403
         """
         PyNTC Device implementation for Cisco IOS.
@@ -54,15 +54,15 @@ def __init__(  # nosec
             username (str): The username to authenticate with the device.
             password (str): The password to authenticate with the device.
             secret (str): The password to escalate privilege on the device.
-            port (int): The port to use to establish the connection.
+            port (int): The port to use to establish the connection. Defaults to 22.
             confirm_active (bool): Determines if device's high availability state should be validated before leaving connection open.
             fast_cli (bool): Fast CLI mode for Netmiko, it is recommended to use False when opening the client on code upgrades
         """
         super().__init__(host, username, password, device_type="cisco_ios_ssh")
 
         self.native = None
         self.secret = secret
-        self.port = int(port)
+        self.port = int(port) if port else 22
         self.global_delay_factor = kwargs.get("global_delay_factor", 1)
         self.delay_factor = kwargs.get("delay_factor", 1)
         self._fast_cli = fast_cli

pyntc/devices/ios_device.py

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pyntc"
-version = "1.0.0"
+version = "1.0.1"
 description = "SDK to simplify common workflows for Network Devices."
 authors = ["Network to Code, LLC <[email protected]>"]
 readme = "README.md"
@@ -24,14 +24,11 @@ include = [
 ]
 
 [tool.poetry.dependencies]
-python = "^3.7"
-# Required for Python 3.7 for now. See: https://stackoverflow.com/a/73932581/194311
-importlib-metadata = "4.13.0"
+python = "^3.8"
 f5-sdk = "^3.0.21"
 junos-eznc = "^2.6"
 netmiko = "^4.0"
-# pyeapi doesn't support py3.10 yet in a release, and pypi doesn't allow direct dependencies. py3.10 to work. https://github.com/arista-eosplus/pyeapi/blob/236503162d1aa3ecc953678ec05380f1f605be02/pyeapi/api/abstract.py#L44
-pyeapi = "^0.8.4"
+pyeapi = "^1.0.2"
 pynxos = "^0.0.5"
 requests = "^2.28"
 scp = "^0.14"

pyproject.toml

@@ -1671,3 +1671,13 @@ def test_uptime_string(mock_uptime_components, aireos_device):
 def test_wlans(aireos_show, aireos_expected_wlans):
     device = aireos_show(["show_wlan_summary.txt"])
     assert device.wlans == aireos_expected_wlans
+
+
+def test_port(aireos_device):
+    assert aireos_device.port == 22
+
+
+@mock.patch.object(AIREOSDevice, "open")
+def test_port_none(patch):
+    device = AIREOSDevice("host", "user", "pass", port=None)
+    assert device.port == 22