commiting tests

Author: katzy687

.pre-commit-config.yaml

@@ -36,9 +36,9 @@ repos:
         language: system
         types: [python]
         args: [
-          --max-line-length=127,
-          --max-public-methods=32,
-          --max-args=8,
+#          --max-line-length=127,
+#          --max-public-methods=32,
+#          --max-args=8,
           '--disable=too-few-public-methods,logging-fstring-interpolation,too-many-instance-attributes,no-else-return,too-many-locals,no-self-use,duplicate-code,broad-except,logging-not-lazy,unspecified-encoding',
           '--good-names=ip,rc,eval'
         ]

cloudshell/sandbox_rest/exceptions.py

@@ -3,6 +3,7 @@
 
 class SandboxRestException(Exception):
     """ Base Exception Class inside Rest client class """
+
     def __init__(self, msg: str, response: Response = None):
         self.msg = msg
         self.response = response
@@ -18,11 +19,14 @@ def _format_err_msg(self, custom_err_msg="Failed Api Call", response: Response =
 
     @staticmethod
     def _format_response_msg(response: Response):
-        return (f"Response: {response.status_code}, Reason: {response.reason}\n"
-                f"Request URL: {response.request.url}\n"
-                f"Request Headers: {response.request.headers}")
+        return (
+            f"Response: {response.status_code}, Reason: {response.reason}\n"
+            f"Request URL: {response.request.url}\n"
+            f"Request Headers: {response.request.headers}"
+        )
 
 
 class SandboxRestAuthException(SandboxRestException):
     """ Failed auth action """
+
     pass

cloudshell/sandbox_rest/sandbox_api.py

@@ -1,8 +1,10 @@
 import json
 from dataclasses import asdict, dataclass
 from typing import List
+
 import requests
-from cloudshell.sandbox_rest.exceptions import SandboxRestException, SandboxRestAuthException
+
+from cloudshell.sandbox_rest.exceptions import SandboxRestAuthException, SandboxRestException
 
 
 @dataclass
@@ -22,8 +24,9 @@ class SandboxRestApiSession:
     View http://<API_SERVER>/api/v2/explore to see schemas of return json values
     """
 
-    def __init__(self, host: str, username: str, password="", token="", domain="Global", port=82, is_https=False,
-                 api_version="v2"):
+    def __init__(
+        self, host: str, username: str, password="", token="", domain="Global", port=82, is_https=False, api_version="v2"
+    ):
         """ login to api and store headers for future requests """
         _protocol = "https" if is_https else "http"
         self._base_url = f"{_protocol}://{host}:{port}/api"
@@ -106,12 +109,12 @@ def delete_token(self, token_id: str) -> None:
 
     # SANDBOX POST REQUESTS
     def start_sandbox(
-            self,
-            blueprint_id: str,
-            sandbox_name="",
-            duration="PT2H0M",
-            bp_params: List[InputParam] = None,
-            permitted_users: List[str] = None,
+        self,
+        blueprint_id: str,
+        sandbox_name="",
+        duration="PT2H0M",
+        bp_params: List[InputParam] = None,
+        permitted_users: List[str] = None,
     ) -> dict:
         """
         Create a sandbox from the provided blueprint id
@@ -139,8 +142,7 @@ def start_sandbox(
         return response.json()
 
     def start_persistent_sandbox(
-            self, blueprint_id: str, sandbox_name="", bp_params: List[InputParam] = None,
-            permitted_users: List[str] = None
+        self, blueprint_id: str, sandbox_name="", bp_params: List[InputParam] = None, permitted_users: List[str] = None
     ) -> dict:
         """ Create a persistent sandbox from the provided blueprint id """
         self._validate_auth_headers()
@@ -159,8 +161,9 @@ def start_persistent_sandbox(
             raise SandboxRestException(err_msg, response)
         return response.json()
 
-    def run_sandbox_command(self, sandbox_id: str, command_name: str, params: List[InputParam] = None,
-                            print_output=True) -> dict:
+    def run_sandbox_command(
+        self, sandbox_id: str, command_name: str, params: List[InputParam] = None, print_output=True
+    ) -> dict:
         """ Run a sandbox level command """
         self._validate_auth_headers()
         url = f"{self._versioned_url}/sandboxes/{sandbox_id}/commands/{command_name}/start"
@@ -173,8 +176,7 @@ def run_sandbox_command(self, sandbox_id: str, command_name: str, params: List[I
         return response.json()
 
     def run_component_command(
-            self, sandbox_id: str, component_id: str, command_name: str, params: List[InputParam] = None,
-            print_output: bool = True
+        self, sandbox_id: str, component_id: str, command_name: str, params: List[InputParam] = None, print_output: bool = True
     ) -> dict:
         """ Start a command on sandbox component """
         self._validate_auth_headers()
@@ -231,8 +233,9 @@ def get_sandbox_details(self, sandbox_id: str) -> dict:
             raise SandboxRestException(exc_msg, response)
         return response.json()
 
-    def get_sandbox_activity(self, sandbox_id: str, error_only=False, since="", from_event_id: int = None,
-                             tail: int = None) -> dict:
+    def get_sandbox_activity(
+        self, sandbox_id: str, error_only=False, since="", from_event_id: int = None, tail: int = None
+    ) -> dict:
         """
         Get list of sandbox activity
         'since' - format must be a valid 'ISO 8601'. (e.g 'PT23H' or 'PT4H2M')
@@ -298,9 +301,7 @@ def get_sandbox_component_details(self, sandbox_id: str, component_id: str) -> d
         )
         if not response.ok:
             custom_err_msg = (
-                f"Failed to get sandbox component details.\n"
-                f"component id: '{component_id}'\n"
-                f"sandbox id: '{sandbox_id}'"
+                f"Failed to get sandbox component details.\n" f"component id: '{component_id}'\n" f"sandbox id: '{sandbox_id}'"
             )
             raise SandboxRestException(custom_err_msg, response)
         return response.json()
@@ -309,14 +310,12 @@ def get_sandbox_component_commands(self, sandbox_id: str, component_id: str) ->
         """ Get list of commands for a particular component in sandbox """
         self._validate_auth_headers()
         response = requests.get(
-            f"{self._versioned_url}/sandboxes/{sandbox_id}/components/{component_id}/commands",
-            headers=self._auth_headers
+            f"{self._versioned_url}/sandboxes/{sandbox_id}/components/{component_id}/commands", headers=self._auth_headers
         )
         if not response.ok:
             custom_err_msg = (
-                f"Failed to get component commands.\n"
-                f"component id: '{component_id}'\n"
-                f"sandbox id: '{sandbox_id}'")
+                f"Failed to get component commands.\n" f"component id: '{component_id}'\n" f"sandbox id: '{sandbox_id}'"
+            )
             raise SandboxRestException(custom_err_msg, response)
         return response.json()
 
@@ -328,24 +327,22 @@ def get_sandbox_component_command_details(self, sandbox_id: str, component_id: s
             headers=self._auth_headers,
         )
         if not response.ok:
-            custom_err_msg = (f"Failed to get command details.\n "
-                              f"component id: '{component_id}'\n"
-                              f"sandbox id: '{sandbox_id}'")
+            custom_err_msg = (
+                f"Failed to get command details.\n " f"component id: '{component_id}'\n" f"sandbox id: '{sandbox_id}'"
+            )
             raise SandboxRestException(custom_err_msg, response)
         return response.json()
 
     def get_sandbox_instructions(self, sandbox_id: str) -> str:
         """ pull the instruction text of sandbox """
         self._validate_auth_headers()
-        response = requests.get(f"{self._versioned_url}/sandboxes/{sandbox_id}/instructions",
-                                headers=self._auth_headers)
+        response = requests.get(f"{self._versioned_url}/sandboxes/{sandbox_id}/instructions", headers=self._auth_headers)
         if not response.ok:
             err_msg = f"Failed to get sandbox instructions for '{sandbox_id}'"
             raise SandboxRestException(err_msg, response)
         return response.json()
 
-    def get_sandbox_output(self, sandbox_id: str, tail: int = None, from_entry_id: int = None,
-                           since: str = None) -> dict:
+    def get_sandbox_output(self, sandbox_id: str, tail: int = None, from_entry_id: int = None, since: str = None) -> dict:
         """ Get list of sandbox output """
         self._validate_auth_headers()
         url = f"{self._versioned_url}/sandboxes/{sandbox_id}/output"

test-requirements.txt

@@ -1,2 +1,4 @@
 pytest
-python-dotenv
+python-dotenv
+flake8
+pylint

tests/conftest.py

@@ -2,6 +2,7 @@
 
 import pytest
 from env_settings import *
+
 from cloudshell.sandbox_rest.sandbox_api import SandboxRestApiSession
 
 
@@ -11,4 +12,3 @@ def admin_session() -> SandboxRestApiSession:
         yield api
         time.sleep(2)
         print("admin session token revoked")
-

tests/env_settings.py

@@ -6,6 +6,7 @@
 """
 
 import os
+
 from dotenv import load_dotenv
 
 load_dotenv()
@@ -19,4 +20,3 @@
 DUT_RESOURCE = "DUT_1"
 DEFAULT_BLUEPRINT_TEMPLATE = "CloudShell Sandbox Template"
 HEALTH_CHECK_COMMAND = "health_check"
-

tests/test_api _no_sandbox.py

@@ -5,9 +5,10 @@
 - get blueprint by id
 - get token + delete token
 """
-from cloudshell.sandbox_rest.sandbox_api import SandboxRestApiSession
 from env_settings import DEFAULT_BLUEPRINT_TEMPLATE
 
+from cloudshell.sandbox_rest.sandbox_api import SandboxRestApiSession
+
 
 def test_get_sandboxes(admin_session: SandboxRestApiSession):
     res = admin_session.get_sandboxes()

tests/test_api_empty_sandbox.py

@@ -2,16 +2,18 @@
 Test the api methods that require a live sandbox against default
 - start sandbox
 """
-from cloudshell.sandbox_rest.sandbox_api import SandboxRestApiSession
-from env_settings import DEFAULT_BLUEPRINT_TEMPLATE
 import pytest
+from env_settings import DEFAULT_BLUEPRINT_TEMPLATE
+
+from cloudshell.sandbox_rest.sandbox_api import SandboxRestApiSession
 
 
 @pytest.fixture(scope="module")
 def sandbox_id(admin_session: SandboxRestApiSession):
     # start sandbox
-    start_res = admin_session.start_sandbox(blueprint_id=DEFAULT_BLUEPRINT_TEMPLATE,
-                                            sandbox_name="Pytest empty blueprint test")
+    start_res = admin_session.start_sandbox(
+        blueprint_id=DEFAULT_BLUEPRINT_TEMPLATE, sandbox_name="Pytest empty blueprint test"
+    )
     sandbox_id = start_res["id"]
     print(f"Sandbox started: {sandbox_id}")
     yield sandbox_id
@@ -39,8 +41,7 @@ def test_get_sandbox_commands(admin_session, sandbox_id):
     sb_commands = admin_session.get_sandbox_commands(sandbox_id)
     print(f"Sandbox commands: {[x['name'] for x in sb_commands]}")
     first_sb_command = admin_session.get_sandbox_command_details(sandbox_id, sb_commands[0]["name"])
-    print(f"SB command name: {first_sb_command['name']}\n"
-          f"description: {first_sb_command['description']}")
+    print(f"SB command name: {first_sb_command['name']}\n" f"description: {first_sb_command['description']}")
 
 
 def test_get_sandbox_events(admin_session, sandbox_id):
@@ -63,5 +64,3 @@ def test_get_instructions(admin_session, sandbox_id):
 def test_extend_sandbox(admin_session, sandbox_id):
     extend_response = admin_session.extend_sandbox(sandbox_id, "PT0H10M")
     print(f"extended sandbox. Remaining time: {extend_response['remaining_time']}")
-
-