stoobly-agent 0.21.0__py3-none-any.whl → 0.22.3__py3-none-any.whl

stoobly_agent/app/proxy/test/context_abc.py

@@ -0,0 +1,155 @@
+import abc
+
+from mitmproxy.http import Request
+from typing import Union
+
+from stoobly_agent.app.proxy.test.helpers.endpoint_facade import EndpointFacade
+from stoobly_agent.app.proxy.test.helpers.request_component_names_facade import RequestComponentNamesFacade
+
+from stoobly_agent.lib.api.interfaces.endpoints import EndpointShowResponse
+from stoobly_agent.lib.orm.trace import Trace
+
+from .context_response import TestContextResponse
+
+FuzzyContent = Union[dict, list, str]
+
+class TestContextABC(abc.ABC):
+
+  @abc.abstractmethod
+  def with_endpoints_resource(self, resource: EndpointShowResponse):
+    pass
+
+  @property
+  @abc.abstractmethod
+  def cached_expected_response_content(self) -> Union[bytes, None, str]:
+    pass
+
+  @property
+  @abc.abstractmethod
+  def endpoint(self) -> EndpointFacade:
+    pass
+
+  @property
+  @abc.abstractmethod
+  def lifecycle_hooks(self):
+    pass
+
+  @property
+  @abc.abstractmethod
+  def lifecycle_hooks_script_path(self):
+    pass
+
+  @property
+  @abc.abstractmethod
+  def end_time(self):
+    pass
+
+  @property
+  @abc.abstractmethod
+  def expected_response(self) -> TestContextResponse:
+    pass
+
+  @property
+  @abc.abstractmethod
+  def decoded_response_content(self) -> FuzzyContent:
+    pass
+
+  @property
+  @abc.abstractmethod
+  def decoded_expected_response_content(self) -> FuzzyContent:
+    pass
+
+  @property
+  @abc.abstractmethod
+  def filter(self):
+    pass
+
+  @property
+  @abc.abstractmethod
+  def flow(self):
+    pass
+
+  @property
+  @abc.abstractmethod
+  def intercept_settings(self):
+    pass
+
+  @property
+  @abc.abstractmethod
+  def log(self):
+    pass
+
+  @log.setter
+  @abc.abstractmethod
+  def log(self, v: str):
+    pass
+
+  @property
+  @abc.abstractmethod
+  def mock_request_id(self) -> Union[str, None]:
+    pass
+
+  @property
+  @abc.abstractmethod
+  def mock_request_endpoint_id(self) -> Union[str, None]:
+    pass
+
+  @property
+  @abc.abstractmethod
+  def passed(self):
+    pass
+
+  @passed.setter
+  @abc.abstractmethod
+  def passed(self, v):
+    pass
+
+  @property
+  @abc.abstractmethod
+  def request(self) -> Request:
+    pass
+
+  @property
+  @abc.abstractmethod
+  def request_headers(self):
+    pass
+
+  @property
+  @abc.abstractmethod
+  def response(self) -> TestContextResponse:
+    pass
+
+  @property
+  @abc.abstractmethod
+  def response_param_names(self) -> RequestComponentNamesFacade: 
+    pass
+
+  @property
+  @abc.abstractmethod
+  def rewritten_expected_response_content(self):
+    pass
+
+  @property
+  @abc.abstractmethod
+  def skipped(self):
+    pass
+
+  @skipped.setter
+  @abc.abstractmethod
+  def skipped(self, v: bool):
+    pass
+
+  @property
+  @abc.abstractmethod
+  def start_time(self):
+    pass
+
+  @property
+  @abc.abstractmethod
+  def strategy(self):
+    pass
+
+  @property
+  @abc.abstractmethod
+  def trace(self) -> Union[Trace, None]:
+    pass

stoobly_agent/app/proxy/test/matchers/context.py

@@ -2,7 +2,7 @@ import pdb
 
 from typing import Iterable, List, TypedDict, Union
 
-from stoobly_agent.app.proxy.test.context import TestContext
+from stoobly_agent.app.proxy.test.context_abc import TestContextABC as TestContext
 from stoobly_agent.app.proxy.test.helpers.request_component_names_facade import RequestComponentNamesFacade
 from stoobly_agent.lib.api.interfaces.endpoints import RequestComponentName, ResponseParamName
 from stoobly_agent.lib.utils.python_to_ruby_type import convert

stoobly_agent/app/proxy/test/matchers/contract.py

@@ -5,7 +5,7 @@ from typing import List, Tuple, TypedDict, Union
 from stoobly_agent.app.proxy.test.helpers.request_component_names_facade import RequestComponentNamesFacade
 from stoobly_agent.lib.api.interfaces.endpoints import RequestComponentName
 
-from ..context import TestContext
+from ..context_abc import TestContextABC as TestContext
 from .context import MatchContext, build_match_context
 from .errors import length_match_error, param_name_exists_error, param_name_missing_error, type_match_error, valid_type_error
 

stoobly_agent/app/proxy/test/matchers/custom.py

@@ -1,4 +1,4 @@
-from stoobly_agent.app.proxy.test.context import TestContext
+from stoobly_agent.app.proxy.test.context_abc import TestContextABC as TestContext
 
 def matches(context: TestContext):
     lifecycle_hooks = context.lifecycle_hooks 

stoobly_agent/app/proxy/test/matchers/diff.py

@@ -1,7 +1,7 @@
 import pdb
 
 from typing import Tuple
-from stoobly_agent.app.proxy.test.context import TestContext
+from stoobly_agent.app.proxy.test.context_abc import TestContextABC as TestContext
 
 from stoobly_agent.app.proxy.test.helpers.request_component_names_facade import RequestComponentNamesFacade
 from stoobly_agent.app.proxy.test.matchers.errors import length_match_error, param_name_missing_error, type_match_error, value_match_error

stoobly_agent/app/proxy/test/matchers/fuzzy.py

@@ -1,7 +1,7 @@
 import pdb
 
 from typing import Iterable, Tuple
-from stoobly_agent.app.proxy.test.context import TestContext
+from stoobly_agent.app.proxy.test.context_abc import TestContextABC as TestContext
 from stoobly_agent.app.proxy.test.helpers.request_component_names_facade import RequestComponentNamesFacade
 from stoobly_agent.app.proxy.test.matchers.errors import param_name_missing_error, type_match_error, valid_type_error
 

stoobly_agent/app/proxy/test/test_service.py

@@ -4,7 +4,7 @@ from stoobly_agent.app.proxy.replay.body_parser_service import decode_response,
 
 from stoobly_agent.config.constants import test_strategy
 
-from .context import TestContext
+from .context_abc import TestContextABC as TestContext
 from .matchers.custom import matches as custom_matches
 from .matchers.contract import matches as contract_matches
 from .matchers.diff import matches as diff_matches

stoobly_agent/app/proxy/upload/joined_request.py

@@ -53,5 +53,4 @@ class JoinedRequest:
         response_string = self.__response_string.get(control=True)
 
         joined = self.REQUEST_DELIMITTER.join([request_string, response_string])
-
         return joined

stoobly_agent/app/proxy/upload/proxy_request.py

@@ -1,7 +1,7 @@
 from ..mitmproxy.request_facade import MitmproxyRequestFacade
 
 class ProxyRequest:
-    def __init__(self, request: MitmproxyRequestFacade, upstream_url: str):
+    def __init__(self, request: MitmproxyRequestFacade, upstream_url: str = None):
         self.request = request
 
         self.upstream_url = upstream_url
@@ -9,4 +9,7 @@ class ProxyRequest:
     def url(self):
         url = self.request.url
 
+        if not self.upstream_url:
+            return url
+
         return url.replace(self.request.base_url, self.upstream_url)

stoobly_agent/app/proxy/upload/request_string.py

@@ -74,7 +74,7 @@ class RequestString:
         toks = header.split('_')
 
         for index, tok in enumerate(toks):
-            toks[index] = tok.lower().capitalize()
+            toks[index] = tok.lower().title()
 
         return "-".join(toks)
 

stoobly_agent/app/settings/constants/mode.py

@@ -0,0 +1,3 @@
+TEST = 'test'
+DEVELOPMENT = 'development'
+PRODUCTION = 'production'

stoobly_agent/app/settings/data_settings.py

@@ -14,7 +14,9 @@ class DataSettings:
     self.__data_rules_map = {k: DataRules(v) for k, v in self.__data_settings.items()}
 
   def data_rules(self, project_id: str) -> DataRules:
-    return self.__data_rules_map.get(project_id) or DataRules({})
+    if not self.__data_rules_map.get(project_id):
+      self.__data_rules_map[project_id] = DataRules({})
+    return self.__data_rules_map[project_id]
 
   def to_dict(self):
     return {k: v.to_dict() for k, v in self.__data_rules_map.items()}

stoobly_agent/cli.py

@@ -1,14 +1,21 @@
 import click
 import os
 import pdb
+import requests
 import sys
 
-from stoobly_agent.config.constants import env_vars
+from stoobly_agent import VERSION
+from stoobly_agent.app.cli.helpers.context import ReplayContext
+from stoobly_agent.app.cli.helpers.handle_mock_service import print_raw_response, RAW_FORMAT
+from stoobly_agent.app.proxy.constants import custom_response_codes
+from stoobly_agent.app.proxy.replay.replay_request_service import replay as replay_request
+from stoobly_agent.config.constants import env_vars, mode
+from stoobly_agent.config.data_dir import DataDir
 from stoobly_agent.lib.utils.conditional_decorator import ConditionalDecorator
 
 from .app.api import run as run_api
-from .app.cli import ca_cert, config, feature, intercept, MainGroup, project, request, trace
-from .app.proxy import CONNECTION_STRATEGIES, INTERCEPT_MODES, run as run_proxy
+from .app.cli import ca_cert, config, feature, intercept, MainGroup, request, scenario, trace
+from .app.proxy import CONNECTION_STRATEGIES, run as run_proxy
 from .app.settings import Settings
 from .lib import logger
 from .lib.orm.migrate_service import migrate as migrate_database
@@ -16,6 +23,9 @@ from .lib.orm.migrate_service import migrate as migrate_database
 settings = Settings.instance()
 is_remote = settings.cli.features.remote
 
+# Makes sure database is up to date
+migrate_database(VERSION)
+
 CONTEXT_SETTINGS = dict(help_option_names=['-h', '--help'])
 
 @click.version_option()
@@ -34,6 +44,7 @@ main.add_command(config)
 main.add_command(feature)
 main.add_command(intercept)
 main.add_command(request)
+main.add_command(scenario)
 main.add_command(trace)
 
 if settings.cli.features.dev_tools:
@@ -45,10 +56,15 @@ if settings.cli.features.exec:
     ExecDecorator(main).decorate()
 
 if settings.cli.features.remote:
-    from .app.cli import report, scenario
+    from .app.cli import project, report
     main.add_command(project)
     main.add_command(report)
-    main.add_command(scenario)
+
+@main.command(
+    help="Initialize a new context"
+)
+def init(**kwargs):
+    DataDir.instance().create()
 
 @main.command(
     help="Run proxy and/or UI",
@@ -56,7 +72,6 @@ if settings.cli.features.remote:
 @ConditionalDecorator(lambda f: click.option('--api-url', help='API URL.')(f), is_remote)
 @click.option('--headless', is_flag=True, default=False, help='Disable starting UI.')
 @click.option('--connection-strategy', help=', '.join(CONNECTION_STRATEGIES), type=click.Choice(CONNECTION_STRATEGIES))
-@click.option('--intercept-mode', help=', '.join(INTERCEPT_MODES), type=click.Choice(INTERCEPT_MODES))
 @click.option('--log-level', default=logger.INFO, type=click.Choice([logger.DEBUG, logger.INFO, logger.WARNING, logger.ERROR]), help='''
     Log levels can be "debug", "info", "warning", or "error"
 ''')
@@ -83,10 +98,73 @@ def run(**kwargs):
     if 'headless' in kwargs and not kwargs['headless']:
         run_api(**kwargs)
 
-    if kwargs['intercept_mode'] and kwargs['intercept_mode'] not in INTERCEPT_MODES:
-        print(f"Error: Invalid value for --intercept-mode, values: {', '.join(INTERCEPT_MODES)}", file=sys.stderr)
-        sys.exit(1)
+    run_proxy(**kwargs)
 
-    migrate_database()
+@main.command(
+  help="Mock request"
+)
+@click.option('-d', '--data', default='', help='HTTP POST data')
+@click.option('--format', type=click.Choice([RAW_FORMAT]), help='Format response')
+@click.option('-H', '--header', multiple=True, help='Pass custom header(s) to server')
+@ConditionalDecorator(lambda f: click.option('--project-key')(f), is_remote)
+@click.option('-X', '--request', default='GET', help='Specify request command to use')
+@click.option('--scenario-key')
+@click.argument('url')
+def mock(**kwargs):
+  request = __build_request_from_curl(**kwargs)
+
+  context = ReplayContext.from_python_request(request)
+  response: requests.Response = replay_request(context, {
+    **kwargs,
+    'mode': mode.MOCK,
+  })
+
+  if response.status_code == custom_response_codes.NOT_FOUND:
+    print(f"Error: {response.content.decode()}")
+    sys.exit(1)
+
+  if kwargs['format'] == RAW_FORMAT:
+    print_raw_response(response)
+  else:
+    print(response.content.decode())
 
-    run_proxy(**kwargs)
+@main.command(
+  help="Record request"
+)
+@click.option('-d', '--data', default='', help='HTTP POST data')
+@click.option('--format', type=click.Choice([RAW_FORMAT]), help='Format response')
+@click.option('-H', '--header', multiple=True, help='Pass custom header(s) to server')
+@ConditionalDecorator(lambda f: click.option('--project-key')(f), is_remote)
+@click.option('-X', '--request', default='GET', help='Specify request command to use')
+@click.option('--scenario-key')
+@click.argument('url')
+def record(**kwargs):
+  request = __build_request_from_curl(**kwargs)
+
+  context = ReplayContext.from_python_request(request)
+  response: requests.Response = replay_request(context, {
+    **kwargs,
+    'mode': mode.RECORD,
+  })
+
+  if kwargs['format'] == RAW_FORMAT:
+    print_raw_response(response)
+  else:
+    print(response.content.decode())
+
+def __build_request_from_curl(**kwargs):
+  headers = {}
+  for header in kwargs['header']:
+    toks = header.split(':')
+
+    if len(toks) != 2:
+      continue
+    
+    headers[toks[0]] = toks[1]
+
+  return requests.Request(
+    data=kwargs['data'],
+    headers=headers,
+    method=kwargs['request'],
+    url=kwargs['url']
+  )

stoobly_agent/config/constants/env_vars.py

@@ -1,8 +1,9 @@
 AGENT_ACTIVE_MODE = 'STOOBLY_AGENT_ACTIVE_MODE'
 AGENT_CONFIG_PATH = 'STOOBLY_AGENT_CONFIG_PATH'
 AGENT_ENABLED = 'STOOBLY_AGENT_ENABLED'
-AGENT_IS_HEADLESS = 'STOOBLY_AGENT_IS_HEADLESS'
+AGENT_SELF_INTERCEPT_ENABLED = 'STOOBLY_AGENT_SELF_INTERCEPT_ENABLED'
 AGENT_INCLUDE_PATTERNS = 'STOOBLY_AGENT_INCLUDE_PATTERNS'
+AGENT_IS_HEADLESS = 'STOOBLY_AGENT_IS_HEADLESS'
 AGENT_EXCLUDE_PATTERNS = 'STOOBLY_AGENT_EXCLUDE_PATTERNS'
 AGENT_POLICY = 'STOOBLY_AGENT_POLICY'
 AGENT_PROJECT_KEY = 'STOOBLY_AGENT_PROJECT_KEY'

stoobly_agent/config/data_dir.py

@@ -1,10 +1,12 @@
 import os
 import pdb
-import tempfile
+
+from stoobly_agent.config.constants.env_vars import ENV
 
 class DataDir:
     DATA_DIR_NAME = '.stoobly'
     DB_FILE_NAME = 'stoobly_agent.sqlite3'
+    DB_VERSION_NAME = 'VERSION'
 
     _instance = None
 
@@ -12,11 +14,15 @@ class DataDir:
         if DataDir._instance:
             raise RuntimeError('Call instance() instead')
         else:
-            self.__data_dir_path = os.path.join(os.path.expanduser('~'), self.DATA_DIR_NAME)
+            self.__data_dir_path = os.path.join(os.getcwd(), self.DATA_DIR_NAME)
 
+            # If the current working directory does not contain a .stoobly folder, default to home directory
             if not os.path.exists(self.__data_dir_path):
-                os.mkdir(self.__data_dir_path)
+                self.__data_dir_path = os.path.join(os.path.expanduser('~'), self.DATA_DIR_NAME)
 
+            if not os.path.exists(self.__data_dir_path):
+                os.makedirs(self.__data_dir_path, exist_ok=True)
+            
     @classmethod
     def instance(cls):
         if cls._instance is None:
@@ -26,6 +32,13 @@ class DataDir:
 
     @property
     def path(self):
+        if os.environ.get(ENV) == 'test':
+            test_path = os.path.join(self.__data_dir_path, 'tmp', self.DATA_DIR_NAME)
+            
+            if not os.path.exists(test_path):
+                os.makedirs(test_path, exist_ok=True)
+            return test_path
+
         return self.__data_dir_path
 
     @property
@@ -46,15 +59,23 @@ class DataDir:
 
         return db_dir_path
 
-    @property
-    def tmp_db_file_path(self):
-        tmp = tempfile.NamedTemporaryFile(delete=False)
-        return tmp.name
-
     @property
     def db_file_path(self):
         return os.path.join(self.db_dir_path, self.DB_FILE_NAME)
 
+    @property
+    def db_version_path(self):
+        return os.path.join(self.db_dir_path, self.DB_VERSION_NAME)
+
     @property
     def settings_file_path(self):
         return os.path.join(self.path, 'settings.yml')
+
+    def create(self, directoy_path = None):
+        if not directoy_path:
+            directoy_path = os.getcwd()
+
+        self.__data_dir_path = os.path.join(directoy_path, self.DATA_DIR_NAME)
+
+        if not os.path.exists(self.__data_dir_path):
+            os.mkdir(self.__data_dir_path)

stoobly_agent/config/settings.yml.sample

@@ -9,7 +9,7 @@ proxy:
     intercept:
         active: false
         mode: record
-        project_key: ''
+        project_key: eyJpIjowLCJvIjowfQ==
     firewall: {}
     rewrite: {}
 proxy_config_path: config/settings.yml

stoobly_agent/db/migrations/2022_12_12_092437_align_requests.py

@@ -26,14 +26,14 @@ class AlignRequests(Migration):
                 _request: requests.Request = RawHttpRequestAdapter(request.raw)
 
                 parsed_url = urlparse(_request.url)
-                request.path = parsed_url.path.decode()
-                request.query = parsed_url.query.decode()
+                request.path = parsed_url.path
+                request.query = parsed_url.query
 
                 if parsed_url.username:
-                    request.user = parsed_url.username.decode()
+                    request.user = parsed_url.username
 
                 if parsed_url.password:
-                    request.password = parsed_url.password.decode()
+                    request.password = parsed_url.password
 
                 response = request.response
                 if response:

stoobly_agent/lib/api/api.py

@@ -44,16 +44,16 @@ class Api():
     def set_proxy(self, val):
       current = {}
 
-      current[HTTP_PROXY] = os.environ.get(HTTP_PROXY)
+      current[HTTP_PROXY] = os.environ.get(HTTP_PROXY) or ''
       os.environ[HTTP_PROXY] = val
 
-      current[HTTPS_PROXY] = os.environ.get(HTTPS_PROXY)
+      current[HTTPS_PROXY] = os.environ.get(HTTPS_PROXY) or ''
       os.environ[HTTPS_PROXY] = val
 
-      current[HTTP_PROXY.lower()] = os.environ.get(HTTP_PROXY.lower())
+      current[HTTP_PROXY.lower()] = os.environ.get(HTTP_PROXY.lower()) or ''
       os.environ[HTTP_PROXY.lower()] = val
 
-      current[HTTPS_PROXY.lower()] = os.environ.get(HTTPS_PROXY.lower())
+      current[HTTPS_PROXY.lower()] = os.environ.get(HTTPS_PROXY.lower()) or ''
       os.environ[HTTPS_PROXY.lower()] = val
 
       return current

stoobly_agent/lib/api/keys/organization_key.py

@@ -1,5 +1,7 @@
 from .resource_key import ResourceKey
 
+LOCAL_ORGANIZATION_ID = 0
+
 class InvalidOrganizationKey(Exception):
   pass
 

stoobly_agent/lib/api/keys/project_key.py

@@ -1,4 +1,5 @@
 from .resource_key import ResourceKey
+from .organization_key import LOCAL_ORGANIZATION_ID
 
 LOCAL_PROJECT_ID = 0
 
@@ -16,6 +17,18 @@ class ProjectKey(ResourceKey):
     if not self.organization_id:
       raise InvalidProjectKey('Missing organization_id')
 
+  @property
+  @classmethod
+  def local_key(cls) -> str:
+    return cls.encode({
+      'i': LOCAL_PROJECT_ID,
+      'o': LOCAL_ORGANIZATION_ID,
+    })
+
+  @property
+  def is_local(self) -> bool:
+    return int(self.id) == LOCAL_PROJECT_ID
+
   @property
   def id(self) -> str:
     return self.get('i')

stoobly_agent/lib/api/keys/resource_key.py

@@ -1,11 +1,11 @@
 import base64
 import json
-import random
-import time
 
 class ResourceKey():
 
     def __init__(self, key):
+        self.__raw = key
+
         try:
             key = base64.b64decode(key)
         except:
@@ -19,6 +19,9 @@ class ResourceKey():
         except:
             self.decoded_key = {}
 
+    @property
+    def raw(self):
+        return self.__raw
 
     @staticmethod
     def encode(data: dict):
@@ -26,7 +29,6 @@ class ResourceKey():
             **data,
         }).encode())
 
-
     def get(self, k: str):
         v = self.decoded_key.get(k)
         return str(v) if v != None else None

stoobly_agent/lib/api/scenarios_resource.py

@@ -1,6 +1,8 @@
 import requests
 import urllib
 
+from stoobly_agent.app.models.types import ScenarioCreateParams
+
 from ..logger import Logger
 from .interfaces.pagination_query_params import PaginationQueryParams
 from .stoobly_api import StooblyApi
@@ -8,19 +10,9 @@ from .stoobly_api import StooblyApi
 class ScenariosResource(StooblyApi):
   SCENARIOS_ENDPOINT = 'scenarios'
 
-  def create(self, project_id: str, params, raw_requests = ''):
+  def create(self, **params: ScenarioCreateParams):
     url = f"{self.service_url}/{self.SCENARIOS_ENDPOINT}"
-
-    body = {
-        'project_id': project_id,
-        **params,
-    }
-
-    files = {}
-    if len(raw_requests) > 0:
-      files = { 'file': raw_requests }
-
-    return self.post(url, headers=self.default_headers, data=body, files=files)
+    return self.post(url, headers=self.default_headers, data=params)
 
   def index(self, **query_params: PaginationQueryParams) -> requests.Response:
     url = f"{self.service_url}/{self.SCENARIOS_ENDPOINT}"

stoobly_agent/lib/api/stoobly_api.py

@@ -1,10 +1,10 @@
 import base64
 import json
-import requests
-import urllib
+import os
 import pdb
 
-from ..logger import Logger
+from stoobly_agent.config.constants import custom_headers, env_vars
+
 from .api import Api
 
 class StooblyApi(Api):
@@ -71,11 +71,15 @@ class StooblyApi(Api):
 
     @property
     def default_headers(self):
-        return {
+        headers = {
             'X-API-KEY': self.api_key,
-            'X-Do-Proxy': '1',
         }
 
+        if not os.environ.get(env_vars.AGENT_SELF_INTERCEPT_ENABLED):
+            headers[custom_headers.DO_PROXY] = '1'
+
+        return headers
+
     # Request
 
     def from_project_key(self, project_key, handler):