Fix Weekly Build (#18)

* pin to non pre-release cfg/replay * fix order of operations issue for junos abort config * slack dependabot to be monthly instead of weekly * pin to scrapli 2022.01.30a2 to fix juniper shell prompts * regen docs
scrapli · Oct 3, 2021 · 0d967f2 · 0d967f2
1 parent b75b68c
commit 0d967f2
Show file tree

Hide file tree

Showing 23 changed files with 659 additions and 1,498 deletions.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -3,16 +3,14 @@ updates:
   - package-ecosystem: "github-actions"
     directory: "/"
     schedule:
-      interval: "weekly"
-      day: "sunday"
+      interval: "monthly"
       timezone: "PST8PDT"
       time: "03:00"
     target-branch: "develop"
   - package-ecosystem: "pip"
     directory: "/"
     schedule:
-      interval: "weekly"
-      day: "sunday"
+      interval: "monthly"
       timezone: "PST8PDT"
       time: "03:00"
     target-branch: "develop"
diff --git a/.github/workflows/commit.yaml b/.github/workflows/commit.yaml
@@ -30,7 +30,7 @@ jobs:
       max-parallel: 12
       matrix:
         os: [ubuntu-latest, macos-latest]
-        version: [3.6, 3.7, 3.8, 3.9, 3.10.0-beta.4]
+        version: [3.6, 3.7, 3.8, 3.9, 3.10.0-rc.2]
     steps:
       - uses: actions/checkout@v2
       - name: set up python ${{ matrix.version }}
@@ -42,6 +42,11 @@ jobs:
         # version we are targeting with nox, while still having versions like 3.9.0a4
         run: |
           echo "FRIENDLY_PYTHON_VERSION=$(python -c "import sys; print(f'{sys.version_info.major}.{sys.version_info.minor}')")" >> $GITHUB_ENV
+      - name: ensure openssl installed for macos
+        # openssl missing/being linked incorrectly causes ssh2-python install failures
+        if: matrix.os == 'macos-latest'
+        run: |
+          brew install openssl
       - name: setup test env
         run: |
           python -m pip install --upgrade pip

diff --git a/.github/workflows/weekly.yaml b/.github/workflows/weekly.yaml
@@ -34,7 +34,7 @@ jobs:
       max-parallel: 12
       matrix:
         os: [ubuntu-latest, macos-latest]
-        version: [3.6, 3.7, 3.8, 3.9, 3.10.0-beta.4]
+        version: [3.6, 3.7, 3.8, 3.9, 3.10.0-rc.2]
     steps:
       - uses: actions/checkout@v2
       - name: set up python ${{ matrix.version }}
@@ -46,6 +46,11 @@ jobs:
         # version we are targeting with nox, while still having versions like 3.9.0a4
         run: |
           echo "FRIENDLY_PYTHON_VERSION=$(python -c "import sys; print(f'{sys.version_info.major}.{sys.version_info.minor}')")" >> $GITHUB_ENV
+      - name: ensure openssl installed for macos
+        # openssl missing/being linked incorrectly causes ssh2-python install failures
+        if: matrix.os == 'macos-latest'
+        run: |
+          brew install openssl
       - name: setup test env
         run: |
           python -m pip install --upgrade pip

diff --git a/docs/api_docs/platform/core/juniper_junos/async_platform.md b/docs/api_docs/platform/core/juniper_junos/async_platform.md
@@ -38,7 +38,6 @@ from scrapli_cfg.exceptions import DiffConfigError
 from scrapli_cfg.platform.base.async_platform import AsyncScrapliCfgPlatform
 from scrapli_cfg.platform.core.juniper_junos.base_platform import (
     CONFIG_SOURCES,
-    JUNOS_ADDTL_PRIVS,
     ScrapliCfgJunosBase,
 )
 from scrapli_cfg.response import ScrapliCfgResponse
@@ -77,11 +76,6 @@ class AsyncScrapliCfgJunos(AsyncScrapliCfgPlatform, ScrapliCfgJunosBase):
 
         self.cleanup_post_commit = cleanup_post_commit
 
-        original_privs = self.conn.privilege_levels
-        updated_privs = {**original_privs, **JUNOS_ADDTL_PRIVS}
-        self.conn.privilege_levels = updated_privs
-        self.conn.update_privilege_levels()
-
     async def _delete_candidate_config(self) -> Response:
         """
         Delete candidate config from the filesystem
@@ -180,12 +174,12 @@ class AsyncScrapliCfgJunos(AsyncScrapliCfgPlatform, ScrapliCfgJunosBase):
             session_or_config_file=bool(self.candidate_config_filename)
         )
 
-        abort_result = await self._delete_candidate_config()
         rollback_result = await self.conn.send_config(config="rollback 0")
+        abort_result = await self._delete_candidate_config()
         self._reset_config_session()
 
         return self._post_abort_config(
-            response=response, scrapli_responses=[abort_result, rollback_result]
+            response=response, scrapli_responses=[rollback_result, abort_result]
         )
 
     async def commit_config(self, source: str = "running") -> ScrapliCfgResponse:
@@ -334,11 +328,6 @@ class AsyncScrapliCfgJunos(AsyncScrapliCfgPlatform, ScrapliCfgJunosBase):
 
         self.cleanup_post_commit = cleanup_post_commit
 
-        original_privs = self.conn.privilege_levels
-        updated_privs = {**original_privs, **JUNOS_ADDTL_PRIVS}
-        self.conn.privilege_levels = updated_privs
-        self.conn.update_privilege_levels()
-
     async def _delete_candidate_config(self) -> Response:
         """
         Delete candidate config from the filesystem
@@ -437,12 +426,12 @@ class AsyncScrapliCfgJunos(AsyncScrapliCfgPlatform, ScrapliCfgJunosBase):
             session_or_config_file=bool(self.candidate_config_filename)
         )
 
-        abort_result = await self._delete_candidate_config()
         rollback_result = await self.conn.send_config(config="rollback 0")
+        abort_result = await self._delete_candidate_config()
         self._reset_config_session()
 
         return self._post_abort_config(
-            response=response, scrapli_responses=[abort_result, rollback_result]
+            response=response, scrapli_responses=[rollback_result, abort_result]
         )
 
     async def commit_config(self, source: str = "running") -> ScrapliCfgResponse:

diff --git a/docs/api_docs/platform/core/juniper_junos/base_platform.md b/docs/api_docs/platform/core/juniper_junos/base_platform.md
@@ -34,7 +34,6 @@ from datetime import datetime
 from logging import LoggerAdapter
 from typing import Tuple
 
-from scrapli.driver.network.base_driver import PrivilegeLevel
 from scrapli_cfg.platform.core.juniper_junos.patterns import (
     EDIT_PATTERN,
     OUTPUT_HEADER_PATTERN,
@@ -45,33 +44,6 @@ CONFIG_SOURCES = [
     "running",
 ]
 
-JUNOS_ADDTL_PRIVS = {
-    "shell": (
-        PrivilegeLevel(
-            pattern=r"^(?!root)%\s?$",
-            name="shell",
-            previous_priv="exec",
-            deescalate="exit",
-            escalate="start shell",
-            escalate_auth=False,
-            escalate_prompt="",
-        )
-    ),
-    # feel like ive had issues w/ root shell in the past... if this all goes well then it can be
-    # added back to scrapli core
-    "root_shell": (
-        PrivilegeLevel(
-            pattern=r"^root@%\s?$",
-            name="root_shell",
-            previous_priv="exec",
-            deescalate="exit",
-            escalate="start shell user root",
-            escalate_auth=True,
-            escalate_prompt=r"^[pP]assword:\s?$",
-        )
-    ),
-}
-
 
 class ScrapliCfgJunosBase:
     logger: LoggerAdapter

diff --git a/docs/api_docs/platform/core/juniper_junos/sync_platform.md b/docs/api_docs/platform/core/juniper_junos/sync_platform.md
@@ -38,7 +38,6 @@ from scrapli_cfg.exceptions import DiffConfigError
 from scrapli_cfg.platform.base.sync_platform import ScrapliCfgPlatform
 from scrapli_cfg.platform.core.juniper_junos.base_platform import (
     CONFIG_SOURCES,
-    JUNOS_ADDTL_PRIVS,
     ScrapliCfgJunosBase,
 )
 from scrapli_cfg.response import ScrapliCfgResponse
@@ -77,11 +76,6 @@ class ScrapliCfgJunos(ScrapliCfgPlatform, ScrapliCfgJunosBase):
 
         self.cleanup_post_commit = cleanup_post_commit
 
-        original_privs = self.conn.privilege_levels
-        updated_privs = {**original_privs, **JUNOS_ADDTL_PRIVS}
-        self.conn.privilege_levels = updated_privs
-        self.conn.update_privilege_levels()
-
     def _delete_candidate_config(self) -> Response:
         """
         Delete candidate config from the filesystem
@@ -178,12 +172,12 @@ class ScrapliCfgJunos(ScrapliCfgPlatform, ScrapliCfgJunosBase):
             session_or_config_file=bool(self.candidate_config_filename)
         )
 
-        abort_result = self._delete_candidate_config()
         rollback_result = self.conn.send_config(config="rollback 0")
+        abort_result = self._delete_candidate_config()
         self._reset_config_session()
 
         return self._post_abort_config(
-            response=response, scrapli_responses=[abort_result, rollback_result]
+            response=response, scrapli_responses=[rollback_result, abort_result]
         )
 
     def commit_config(self, source: str = "running") -> ScrapliCfgResponse:
@@ -332,11 +326,6 @@ class ScrapliCfgJunos(ScrapliCfgPlatform, ScrapliCfgJunosBase):
 
         self.cleanup_post_commit = cleanup_post_commit
 
-        original_privs = self.conn.privilege_levels
-        updated_privs = {**original_privs, **JUNOS_ADDTL_PRIVS}
-        self.conn.privilege_levels = updated_privs
-        self.conn.update_privilege_levels()
-
     def _delete_candidate_config(self) -> Response:
         """
         Delete candidate config from the filesystem
@@ -433,12 +422,12 @@ class ScrapliCfgJunos(ScrapliCfgPlatform, ScrapliCfgJunosBase):
             session_or_config_file=bool(self.candidate_config_filename)
         )
 
-        abort_result = self._delete_candidate_config()
         rollback_result = self.conn.send_config(config="rollback 0")
+        abort_result = self._delete_candidate_config()
         self._reset_config_session()
 
         return self._post_abort_config(
-            response=response, scrapli_responses=[abort_result, rollback_result]
+            response=response, scrapli_responses=[rollback_result, abort_result]
         )
 
     def commit_config(self, source: str = "running") -> ScrapliCfgResponse:

diff --git a/docs/changelog.md b/docs/changelog.md
@@ -1,6 +1,12 @@
 Changelog
 =========
 
+## 2022.01.30
+
+- Revised juniper abort config to remove candidate config file *after* rollback 0 to avoid issues where junos would 
+  prompt for confirmation when exiting config mode to go delete the candidate config file prompting timeouts.
+
+
 ## 2021.07.30
 
 - Initial release!
diff --git a/examples/basic_usage/config_replace.py b/examples/basic_usage/config_replace.py
@@ -16,7 +16,7 @@ def main():
     """Demo basic config replace functionality"""
 
     # load up a config to use for the candidate config
-    with open("config", "r") as f:
+    with open("config", "r", encoding="utf-8") as f:
         my_config = f.read()
 
     # open the "normal" scrapli connection

diff --git a/examples/selective_config_replace/eos_selective_config_replace.py b/examples/selective_config_replace/eos_selective_config_replace.py
@@ -22,7 +22,7 @@ def main():
     # in the configuration that looks an awful lot like a jinja2 variable, in this case:
     # "{{ ethernet_interfaces }}" -- all we need to do is tell scrapli_cfg how to match (from the
     # actual running config) what *should* go in this section (see the next comment section!)
-    with open("config", "r") as f:
+    with open("config", "r", encoding="utf-8") as f:
         my_config = f.read()
 
     # in this example we have a `dedicated_connection` which means that the scrapli connection is

diff --git a/noxfile.py b/noxfile.py
@@ -28,7 +28,7 @@ def parse_requirements(dev: bool = True) -> Dict[str, str]:
     requirements = {}
     requirements_file = "requirements.txt" if dev is False else "requirements-dev.txt"
 
-    with open(requirements_file, "r") as f:
+    with open(requirements_file, "r", encoding="utf-8") as f:
         requirements_file_lines = f.readlines()
 
     requirements_lines: List[str] = [

diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -1,17 +1,17 @@
-black==21.7b0
+black==21.9b0
 darglint==1.8.0
 isort==5.9.3
 mypy==0.910
-nox==2021.6.12
+nox==2021.10.1
 pycodestyle==2.7.0
 pydocstyle==6.1.1
-pyfakefs==4.5.0
+pyfakefs==4.5.1
 pylama==7.7.1
-pylint==2.9.6
+pylint==2.11.1
 pytest-asyncio==0.15.1
 pytest-cov==2.12.1
-pytest==6.2.4
-scrapli-replay==2021.7.30a5
+pytest==6.2.5
+scrapli-replay==2021.7.30
 -r requirements-asyncssh.txt
 -r requirements-paramiko.txt
 -r requirements-ssh2.txt

diff --git a/requirements-docs.txt b/requirements-docs.txt
@@ -1,5 +1,5 @@
 mdx-gh-links==0.2
 mkdocs==1.2.2
-mkdocs-material==7.2.1
-mkdocs-material-extensions==1.0.1
-pdoc3==0.9.2 ; sys_platform != "win32"
+mkdocs-material==7.3.1
+mkdocs-material-extensions==1.0.3
+pdoc3==0.10.0 ; sys_platform != "win32"
diff --git a/requirements.txt b/requirements.txt
@@ -1 +1 @@
-scrapli>=2021.07.30a3
+scrapli>=2022.01.30a2
diff --git a/scrapli_cfg/platform/core/juniper_junos/async_platform.py b/scrapli_cfg/platform/core/juniper_junos/async_platform.py
@@ -8,7 +8,6 @@
 from scrapli_cfg.platform.base.async_platform import AsyncScrapliCfgPlatform
 from scrapli_cfg.platform.core.juniper_junos.base_platform import (
     CONFIG_SOURCES,
-    JUNOS_ADDTL_PRIVS,
     ScrapliCfgJunosBase,
 )
 from scrapli_cfg.response import ScrapliCfgResponse
@@ -47,11 +46,6 @@ def __init__(
 
         self.cleanup_post_commit = cleanup_post_commit
 
-        original_privs = self.conn.privilege_levels
-        updated_privs = {**original_privs, **JUNOS_ADDTL_PRIVS}
-        self.conn.privilege_levels = updated_privs
-        self.conn.update_privilege_levels()
-
     async def _delete_candidate_config(self) -> Response:
         """
         Delete candidate config from the filesystem
@@ -150,12 +144,12 @@ async def abort_config(self) -> ScrapliCfgResponse:
             session_or_config_file=bool(self.candidate_config_filename)
         )
 
-        abort_result = await self._delete_candidate_config()
         rollback_result = await self.conn.send_config(config="rollback 0")
+        abort_result = await self._delete_candidate_config()
         self._reset_config_session()
 
         return self._post_abort_config(
-            response=response, scrapli_responses=[abort_result, rollback_result]
+            response=response, scrapli_responses=[rollback_result, abort_result]
         )
 
     async def commit_config(self, source: str = "running") -> ScrapliCfgResponse:

diff --git a/scrapli_cfg/platform/core/juniper_junos/base_platform.py b/scrapli_cfg/platform/core/juniper_junos/base_platform.py
@@ -4,7 +4,6 @@
 from logging import LoggerAdapter
 from typing import Tuple
 
-from scrapli.driver.network.base_driver import PrivilegeLevel
 from scrapli_cfg.platform.core.juniper_junos.patterns import (
     EDIT_PATTERN,
     OUTPUT_HEADER_PATTERN,
@@ -15,33 +14,6 @@
     "running",
 ]
 
-JUNOS_ADDTL_PRIVS = {
-    "shell": (
-        PrivilegeLevel(
-            pattern=r"^(?!root)%\s?$",
-            name="shell",
-            previous_priv="exec",
-            deescalate="exit",
-            escalate="start shell",
-            escalate_auth=False,
-            escalate_prompt="",
-        )
-    ),
-    # feel like ive had issues w/ root shell in the past... if this all goes well then it can be
-    # added back to scrapli core
-    "root_shell": (
-        PrivilegeLevel(
-            pattern=r"^root@%\s?$",
-            name="root_shell",
-            previous_priv="exec",
-            deescalate="exit",
-            escalate="start shell user root",
-            escalate_auth=True,
-            escalate_prompt=r"^[pP]assword:\s?$",
-        )
-    ),
-}
-
 
 class ScrapliCfgJunosBase:
     logger: LoggerAdapter