basic tests added

Author: katzy687

.pre-commit-config.yaml

@@ -0,0 +1,44 @@
+repos:
+  - repo: https://github.com/timothycrosley/isort
+    rev: 5.4.2
+    hooks:
+      - id: isort
+        language_version: python3.7
+        args: [--line-length=127]
+  - repo: https://github.com/python/black
+    rev: 20.8b1
+    hooks:
+      - id: black
+        language_version: python3.7
+        args: [--line-length=127]
+  - repo: https://gitlab.com/pycqa/flake8
+    rev: 3.8.3
+    hooks:
+      - id: flake8
+        additional_dependencies: [
+          flake8-docstrings,
+          flake8-builtins,
+          flake8-comprehensions,
+          flake8-print,
+          flake8-eradicate,
+        ]
+        language_version: python3.7
+        args: [
+          --max-line-length=127,
+          '--ignore=D100,D101,D102,D103,D104,D105,D106,D107,D200,D210,D401,W503,E203'
+        ]
+  # See https://stackoverflow.com/questions/61238318/pylint-and-pre-commit-hook-unable-to-import/61238571#61238571
+  - repo: local
+    hooks:
+      - id: pylint
+        name: pylint
+        entry: pylint
+        language: system
+        types: [python]
+        args: [
+          --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'
+        ]

build/lib/cloudshell/__init__.py

@@ -1,3 +1,4 @@
-__author__ = 'quali'
+__author__ = "quali"
 from pkgutil import extend_path
-__path__ = extend_path(__path__, __name__)
+
+__path__ = extend_path(__path__, __name__)

build/lib/cloudshell/sandbox_rest/__init__.py

@@ -1,3 +1,4 @@
-__author__ = 'quali'
+__author__ = "quali"
 from pkgutil import extend_path
-__path__ = extend_path(__path__, __name__)
+
+__path__ = extend_path(__path__, __name__)

build/lib/cloudshell/sandbox_rest/sandbox_api.py

@@ -1,3 +1,4 @@
-__author__ = 'quali'
+__author__ = "quali"
 from pkgutil import extend_path
-__path__ = extend_path(__path__, __name__)
+
+__path__ = extend_path(__path__, __name__)

cloudshell/__init__.py

@@ -1,3 +1,4 @@
-__author__ = 'quali'
+__author__ = "quali"
 from pkgutil import extend_path
-__path__ = extend_path(__path__, __name__)
+
+__path__ = extend_path(__path__, __name__)

cloudshell/sandbox_rest/__init__.py

@@ -3,10 +3,12 @@
 Using 'retrying' library to do polling:
 https://pypi.org/project/retrying/
 """
-from typing import List, Callable
-from retrying import retry, RetryError  # pip install retrying
-from cloudshell.sandbox_rest.sandbox_api import SandboxRestApiSession
 from enum import Enum
+from typing import Callable, List
+
+from retrying import RetryError, retry  # pip install retrying
+
+from cloudshell.sandbox_rest.sandbox_api import SandboxRestApiSession
 
 
 class OrchestrationPollingTimeout(Exception):
@@ -18,8 +20,8 @@ class CommandPollingTimeout(Exception):
 
 
 class SandboxStates(Enum):
-    before_setup_state = "BeforeSetup"
-    running_setup_state = "Setup"
+    BEFORE_SETUP_STATE = "BeforeSetup"
+    RUNNING_SETUP_STATE = "Setup"
     error_state = "Error"
     ready_state = "Ready"
     teardown_state = "Teardown"
@@ -33,19 +35,16 @@ class ExecutionStatuses(Enum):
     failed_status = "Failed"
 
 
-SANDBOX_SETUP_STATES = [SandboxStates.before_setup_state.value,
-                        SandboxStates.running_setup_state.value]
+SANDBOX_SETUP_STATES = [SandboxStates.BEFORE_SETUP_STATE.value, SandboxStates.RUNNING_SETUP_STATE.value]
 
-SANDBOX_ACTIVE_STATES = [SandboxStates.ready_state.value,
-                         SandboxStates.error_state.value]
+SANDBOX_ACTIVE_STATES = [SandboxStates.ready_state.value, SandboxStates.error_state.value]
 
-UNFINISHED_EXECUTION_STATUSES = [ExecutionStatuses.running_status.value,
-                                 ExecutionStatuses.pending_status.value]
+UNFINISHED_EXECUTION_STATUSES = [ExecutionStatuses.running_status.value, ExecutionStatuses.pending_status.value]
 
 
 def _should_we_keep_polling_setup(sandbox_details: dict) -> bool:
     """ if still in setup keep polling """
-    setup_states = [SandboxStates.before_setup_state.value, SandboxStates.running_setup_state.value]
+    setup_states = [SandboxStates.BEFORE_SETUP_STATE.value, SandboxStates.RUNNING_SETUP_STATE.value]
     if sandbox_details["state"] in setup_states:
         return True
     return False
@@ -58,13 +57,19 @@ def _should_we_keep_polling_teardown(sandbox_details: dict) -> bool:
     return False
 
 
-def _poll_sandbox_state(api: SandboxRestApiSession, reservation_id: str, polling_func: Callable,
-                        max_polling_minutes: int, polling_frequency_seconds: int) -> str:
+def _poll_sandbox_state(
+    api: SandboxRestApiSession,
+    reservation_id: str,
+    polling_func: Callable,
+    max_polling_minutes: int,
+    polling_frequency_seconds: int,
+) -> str:
     """ Create blocking polling process """
 
     # retry wait times are in milliseconds
-    @retry(retry_on_result=polling_func, wait_fixed=polling_frequency_seconds * 1000,
-           stop_max_delay=max_polling_minutes * 60000)
+    @retry(
+        retry_on_result=polling_func, wait_fixed=polling_frequency_seconds * 1000, stop_max_delay=max_polling_minutes * 60000
+    )
     def get_sandbox_details():
         return api.get_sandbox_details(reservation_id)
 
@@ -75,19 +80,23 @@ def get_sandbox_details():
     return sandbox_details
 
 
-def poll_sandbox_setup(api: SandboxRestApiSession, reservation_id: str, max_polling_minutes=20,
-                       polling_frequency_seconds=30) -> dict:
+def poll_sandbox_setup(
+    api: SandboxRestApiSession, reservation_id: str, max_polling_minutes=20, polling_frequency_seconds=30
+) -> dict:
     """ poll until completion """
-    sandbox_details = _poll_sandbox_state(api, reservation_id, _should_we_keep_polling_setup, max_polling_minutes,
-                                          polling_frequency_seconds)
+    sandbox_details = _poll_sandbox_state(
+        api, reservation_id, _should_we_keep_polling_setup, max_polling_minutes, polling_frequency_seconds
+    )
     return sandbox_details
 
 
-def poll_sandbox_teardown(api: SandboxRestApiSession, reservation_id: str, max_polling_minutes=20,
-                          polling_frequency_seconds=30) -> dict:
+def poll_sandbox_teardown(
+    api: SandboxRestApiSession, reservation_id: str, max_polling_minutes=20, polling_frequency_seconds=30
+) -> dict:
     """ poll until completion  """
-    sandbox_details = _poll_sandbox_state(api, reservation_id, _should_we_keep_polling_teardown, max_polling_minutes,
-                                          polling_frequency_seconds)
+    sandbox_details = _poll_sandbox_state(
+        api, reservation_id, _should_we_keep_polling_teardown, max_polling_minutes, polling_frequency_seconds
+    )
     return sandbox_details
 
 
@@ -98,15 +107,19 @@ def _should_we_keep_polling_execution(exc_data: dict) -> bool:
     return False
 
 
-def poll_execution_for_completion(sandbox_rest: SandboxRestApiSession, command_execution_id: str,
-                                  max_polling_in_minutes=20, polling_frequency_in_seconds=30) -> str:
+def poll_execution_for_completion(
+    sandbox_rest: SandboxRestApiSession, command_execution_id: str, max_polling_in_minutes=20, polling_frequency_in_seconds=30
+) -> str:
     """
     poll execution for "Completed" status, then return the execution output
     """
 
     # retry wait times are in milliseconds
-    @retry(retry_on_result=_should_we_keep_polling_execution, wait_fixed=polling_frequency_in_seconds * 1000,
-           stop_max_delay=max_polling_in_minutes * 60000)
+    @retry(
+        retry_on_result=_should_we_keep_polling_execution,
+        wait_fixed=polling_frequency_in_seconds * 1000,
+        stop_max_delay=max_polling_in_minutes * 60000,
+    )
     def get_execution_data():
         exc_data = sandbox_rest.get_execution_details(command_execution_id)
         return exc_data