stoobly-agent 1.0.6__py3-none-any.whl → 1.0.8__py3-none-any.whl

stoobly_agent/config/data_dir.py

@@ -1,3 +1,4 @@
+import pdb
 import os
 import shutil
 
@@ -16,6 +17,8 @@ class DataDir:
         if DataDir._instances.get(path):
             raise RuntimeError('Call instance() instead')
         else:
+            self.__path = path
+
             if path:
                 self.__data_dir_path = os.path.join(path, DATA_DIR_NAME)
             else:
@@ -35,6 +38,9 @@ class DataDir:
             if not os.path.exists(self.__data_dir_path):
                 self.create(os.path.dirname(self.__data_dir_path))
 
+    def __repr__(self) -> str:
+      return self.path
+
     @classmethod
     def instance(cls, path: str = None):
         if not cls._instances:
@@ -58,7 +64,7 @@ class DataDir:
 
     @property
     def path(self):
-        if os.environ.get(ENV) == 'test':
+        if not self.__path and os.environ.get(ENV) == 'test':
             test_path = os.path.join(self.__data_dir_path, 'tmp', DATA_DIR_NAME)
 
             if not os.path.exists(test_path):
@@ -122,13 +128,13 @@ class DataDir:
                     options = json.loads(contents)
                     _conf_dir = options.get('confdir')
 
-                    if _conf_dir or not os.path.exists(_conf_dir):
+                    if _conf_dir and os.path.exists(_conf_dir):
                         conf_dir = _conf_dir
             except Exception:
                 pass
-
-        if not os.path.exists(conf_dir):
-            os.makedirs(conf_dir)
+        else:
+            if not os.path.exists(conf_dir):
+                os.makedirs(conf_dir)
 
         return conf_dir
 
@@ -212,8 +218,10 @@ class DataDir:
         if not os.path.exists(self.__data_dir_path):
             os.mkdir(self.__data_dir_path)
 
+            # Create the certs_dir_path if it doesn't exist
+            self.certs_dir_path
             # Create tmp folder
-            os.mkdir(os.path.join(self.__data_dir_path, 'tmp'))
+            os.makedirs(os.path.join(self.__data_dir_path, 'tmp'), exist_ok=True)
 
             with open(os.path.join(self.__data_dir_path, '.gitignore'), 'w') as fp:
                 fp.write(

stoobly_agent/test/app/cli/scaffold/e2e_test.py

@@ -0,0 +1,428 @@
+from pathlib import Path
+import pathlib
+import pdb
+import shutil
+
+from click.testing import CliRunner
+import docker
+import pytest
+
+from stoobly_agent.app.cli import scaffold
+from stoobly_agent.app.cli.scaffold.app import App
+from stoobly_agent.app.cli.scaffold.constants import (
+  WORKFLOW_RECORD_TYPE,
+  WORKFLOW_TEST_TYPE,
+)
+from stoobly_agent.app.cli.scaffold.constants import DOCKER_NAMESPACE
+from stoobly_agent.app.cli.scaffold.managed_services_docker_compose import (
+  ManagedServicesDockerCompose,
+)
+from stoobly_agent.app.cli.scaffold.service_docker_compose import ServiceDockerCompose
+from stoobly_agent.app.cli.scaffold.service_workflow_validate_command import (
+  ServiceWorkflowValidateCommand,
+)
+from stoobly_agent.app.cli.scaffold.workflow_validate_command import (
+  WorkflowValidateCommand,
+)
+from stoobly_agent.config.data_dir import DATA_DIR_NAME, DataDir
+from stoobly_agent.test.test_helper import reset
+
+
+@pytest.mark.e2e
+class TestScaffoldE2e():
+
+  @pytest.fixture(scope='module', autouse=True)
+  def settings(self):
+    return reset()
+
+  @pytest.fixture(scope='module')
+  def runner(self):
+    yield CliRunner()
+
+  @pytest.fixture(scope='class')
+  def docker_client(self):
+    yield docker.from_env()
+
+  @pytest.fixture(scope='class')
+  def app_name(self):
+    yield "0.0.1"
+
+  @pytest.fixture(scope='class', autouse=True)
+  def temp_dir(self):
+    data_dir_path = DataDir.instance().path
+    tmp_path = data_dir_path[:data_dir_path.rfind('/')]
+
+    yield tmp_path
+
+  @pytest.fixture(scope='class', autouse=True)
+  def app_dir_path(self, temp_dir, app_name):
+    yield temp_dir
+
+  @pytest.fixture(scope='class')
+  def mock_data_directory_path(self):
+    yield Path(__file__).parent.parent.parent.parent / 'mock_data'
+  
+  @pytest.fixture(scope='class')
+  def local_service_mock_docker_compose_path(self, mock_data_directory_path):
+    path = mock_data_directory_path / "scaffold" / "docker-compose-local-service.yml"
+    yield path
+
+  @pytest.fixture(scope='class')
+  def hostname(self):
+    yield "http.badssl.com"
+
+  @pytest.fixture(scope='class')
+  def https_service_hostname(self):
+    yield "example.com"
+  
+  @pytest.fixture(scope='class')
+  def external_service_name(self):
+    yield "external-service"
+
+  @pytest.fixture(scope='class')
+  def external_https_service_name(self):
+    yield "external-https-service"
+
+  @pytest.fixture(scope='class')
+  def local_hostname(self):
+    yield "my-httpbin.com"
+
+  @pytest.fixture(scope='class')
+  def local_service_name(self):
+    yield "my-httpbin"
+
+  
+  class TestRecordWorkflow():
+    @pytest.fixture(scope='class', autouse=True)
+    def target_workflow_name(self):
+      yield WORKFLOW_RECORD_TYPE
+
+    @pytest.fixture(scope='class')
+    def managed_services_docker_compose(self, target_workflow_name):
+      yield ManagedServicesDockerCompose(target_workflow_name=target_workflow_name)
+
+    @pytest.fixture(scope='class')
+    def external_service_docker_compose(self, app_dir_path, target_workflow_name, external_service_name, hostname):
+      yield ServiceDockerCompose(app_dir_path=app_dir_path, target_workflow_name=target_workflow_name, service_name=external_service_name, hostname=hostname)
+    
+    @pytest.fixture(scope='class')
+    def external_https_service_docker_compose(self, app_dir_path, target_workflow_name, external_https_service_name, https_service_hostname):
+      yield ServiceDockerCompose(app_dir_path=app_dir_path, target_workflow_name=target_workflow_name, service_name=external_https_service_name, hostname=https_service_hostname)
+
+    @pytest.fixture(scope='class')
+    def local_service_docker_compose(self, app_dir_path, target_workflow_name, local_service_name, local_hostname):
+      yield ServiceDockerCompose(app_dir_path=app_dir_path, target_workflow_name=target_workflow_name, service_name=local_service_name, hostname=local_hostname)
+
+    @pytest.fixture(scope='class', autouse=True)
+    def setup_docker_composes(self, managed_services_docker_compose, external_service_docker_compose, local_service_docker_compose):
+      self.managed_services_docker_compose = managed_services_docker_compose
+      self.external_service_docker_compose = external_service_docker_compose
+      self.local_service_docker_compose = local_service_docker_compose
+
+    @pytest.fixture(scope="class", autouse=True)
+    def create_scaffold_setup(self, runner, app_dir_path, app_name, target_workflow_name, external_service_docker_compose, external_https_service_docker_compose, local_service_docker_compose, local_service_mock_docker_compose_path):
+      TestScaffoldE2e.cli_app_create(runner, app_dir_path, app_name)
+
+      # Create external user defined service
+      TestScaffoldE2e.cli_service_create(runner, app_dir_path, external_service_docker_compose.hostname, external_service_docker_compose.service_name, False)
+      TestScaffoldE2e.cli_service_create(runner, app_dir_path, external_https_service_docker_compose.hostname, external_https_service_docker_compose.service_name, True)
+
+      # Create local user defined service
+      TestScaffoldE2e.cli_service_create(runner, app_dir_path, local_service_docker_compose.hostname, local_service_docker_compose.service_name, False)
+
+      # Validate docker-compose path exists
+      destination_path = Path(local_service_docker_compose.docker_compose_path)
+      assert destination_path.is_file()
+      # Add user defined Docker Compose file for the local service
+      shutil.copyfile(local_service_mock_docker_compose_path, destination_path)
+
+      # Record workflow doesn't have a fixtures folder
+
+      # Generate certs
+      TestScaffoldE2e.cli_app_mkcert(runner, app_dir_path)
+
+      TestScaffoldE2e.cli_workflow_run(runner, app_dir_path, target_workflow_name)
+
+    @pytest.fixture(scope="class", autouse=True)
+    def cleanup_after_all(self, runner, app_dir_path, target_workflow_name):
+      yield
+      TestScaffoldE2e.cli_workflow_stop(runner, app_dir_path, target_workflow_name)
+
+    def test_core_components(self, app_dir_path, target_workflow_name):
+      app = App(app_dir_path, DOCKER_NAMESPACE)
+      config = {
+        'workflow_name': target_workflow_name,
+        'service_name': 'build'
+      }
+
+      command = WorkflowValidateCommand(app, **config)
+      command.validate()
+
+    def test_external_service(self, external_service_docker_compose: ServiceDockerCompose, app_dir_path, target_workflow_name):
+      app = App(app_dir_path, DOCKER_NAMESPACE)
+      config = {
+        'workflow_name': target_workflow_name,
+        'service_name': external_service_docker_compose.service_name 
+      }
+
+      command = ServiceWorkflowValidateCommand(app, **config)
+      command.validate()
+
+    def test_local_service(self, app_dir_path, target_workflow_name, local_service_docker_compose: ServiceDockerCompose):
+      app = App(app_dir_path, DOCKER_NAMESPACE)
+      config = {
+        'workflow_name': target_workflow_name,
+        'service_name': local_service_docker_compose.service_name 
+      }
+
+      command = ServiceWorkflowValidateCommand(app, **config)
+      command.validate()
+
+
+  class TestTestWorkflow():
+    @pytest.fixture(scope='class')
+    def assets_service_mock_docker_compose_path(self, mock_data_directory_path):
+      path = mock_data_directory_path / "scaffold" / "docker-compose-assets-service.yml"
+      yield path
+
+    @pytest.fixture(scope='class')
+    def assets_service_assets_path(self, mock_data_directory_path):
+      path = mock_data_directory_path / "scaffold" / "index.html"
+      yield path
+    
+    @pytest.fixture(scope='class', autouse=True)
+    def target_workflow_name(self):
+      yield WORKFLOW_TEST_TYPE
+
+    @pytest.fixture(scope='class')
+    def assets_service_name(self):
+      yield "assets"
+    
+    @pytest.fixture(scope='class')
+    def assets_hostname(self):
+      yield "assets"
+
+    @pytest.fixture(scope='class')
+    def managed_services_docker_compose(self, target_workflow_name):
+      yield ManagedServicesDockerCompose(target_workflow_name=target_workflow_name)
+    
+    @pytest.fixture(scope='class')
+    def external_service_docker_compose(self, app_dir_path, target_workflow_name, external_service_name, hostname):
+      yield ServiceDockerCompose(app_dir_path=app_dir_path, target_workflow_name=target_workflow_name, service_name=external_service_name, hostname=hostname)
+
+    @pytest.fixture(scope='class')
+    def local_service_docker_compose(self, app_dir_path, target_workflow_name, local_service_name, local_hostname):
+      yield ServiceDockerCompose(app_dir_path=app_dir_path, target_workflow_name=target_workflow_name, service_name=local_service_name, hostname=local_hostname)
+    
+    @pytest.fixture(scope='class')
+    def assets_service_docker_compose(self, app_dir_path, target_workflow_name, assets_service_name, assets_hostname):
+      yield ServiceDockerCompose(app_dir_path=app_dir_path, target_workflow_name=target_workflow_name, service_name=assets_service_name, hostname=assets_hostname)
+
+    @pytest.fixture(scope='class', autouse=True)
+    def setup_docker_composes(self, managed_services_docker_compose, external_service_docker_compose, local_service_docker_compose, assets_service_docker_compose):
+      self.managed_services_docker_compose = managed_services_docker_compose
+      self.external_service_docker_compose = external_service_docker_compose
+      self.local_service_docker_compose = local_service_docker_compose
+      self.assets_service_docker_compose = assets_service_docker_compose
+
+    @pytest.fixture(scope="class", autouse=True)
+    def create_scaffold_setup(self, runner, app_name, app_dir_path, target_workflow_name, external_service_docker_compose, local_service_docker_compose, assets_service_docker_compose, mock_data_directory_path, assets_service_mock_docker_compose_path):
+
+      TestScaffoldE2e.cli_app_create(runner, app_dir_path, app_name)
+
+      # Create external user defined service
+      TestScaffoldE2e.cli_service_create(runner, app_dir_path, external_service_docker_compose.hostname, external_service_docker_compose.service_name, False)
+      # Create local user defined services
+      TestScaffoldE2e.cli_service_create(runner, app_dir_path, local_service_docker_compose.hostname, local_service_docker_compose.service_name, False)
+      TestScaffoldE2e.cli_service_create_assets(runner, app_dir_path, assets_service_docker_compose.hostname, assets_service_docker_compose.service_name, False)
+
+      # Don't run the local user defined service in the 'test' workflow
+      # So don't copy the Docker Compose file over
+
+      # Add user defined Docker Compose file for the assets service
+      destination_path = Path(assets_service_docker_compose.docker_compose_path)
+      assert destination_path.is_file()
+      shutil.copyfile(assets_service_mock_docker_compose_path, destination_path)
+
+      TestScaffoldE2e.cli_service_create_assets(runner, app_dir_path, assets_service_docker_compose.hostname, assets_service_docker_compose.service_name, False)
+
+      # Add assets for assets service
+      data_dir_path = DataDir.instance().path
+      destination_assets_path = f"{data_dir_path}/docker/{assets_service_docker_compose.service_name}/{target_workflow_name}/index.html"
+      destination_path = Path(destination_assets_path)
+      assets_mock_path = mock_data_directory_path / "scaffold" / "index.html"
+      shutil.copyfile(assets_mock_path, destination_path)
+
+      # Created shared file in fixtures folder
+      app = App(app_dir_path, DOCKER_NAMESPACE)
+      config = {
+        'workflow_name': target_workflow_name,
+        'service_name': external_service_docker_compose.service_name 
+      }
+      command = ServiceWorkflowValidateCommand(app, **config)
+      with open(f"{command.fixtures_dir_path}/shared_file.txt", 'w') as file:
+        file.write('this is a shared file')
+
+      TestScaffoldE2e.cli_workflow_run(runner, app_dir_path, target_workflow_name=target_workflow_name)
+    
+    @pytest.fixture(scope="class", autouse=True)
+    def cleanup_after_all(self, runner, app_dir_path, target_workflow_name):
+      yield
+      TestScaffoldE2e.cli_workflow_stop(runner, app_dir_path, target_workflow_name)
+
+    def test_no_core_components(self, app_dir_path, target_workflow_name):
+      app = App(app_dir_path, DOCKER_NAMESPACE)
+      config = {
+        'workflow_name': target_workflow_name,
+        'service_name': 'build'
+      }
+
+      command = WorkflowValidateCommand(app, **config)
+      command.validate()
+
+    def test_user_services(self, app_dir_path, target_workflow_name, external_service_docker_compose, local_service_docker_compose):
+      app = App(app_dir_path, DOCKER_NAMESPACE)
+
+      config = {
+        'workflow_name': target_workflow_name,
+        'service_name': external_service_docker_compose.service_name 
+      }
+      command = ServiceWorkflowValidateCommand(app, **config)
+      command.validate()
+
+      config = {
+        'workflow_name': target_workflow_name,
+        'service_name': local_service_docker_compose.service_name 
+      }
+      command = ServiceWorkflowValidateCommand(app, **config)
+      command.validate()
+
+    def test_tests(self):
+      # This is covered by test_assets
+      pass
+
+    def test_assets(self, app_dir_path, target_workflow_name):
+
+      app = App(app_dir_path, DOCKER_NAMESPACE)
+      config = {
+        'workflow_name': target_workflow_name,
+        'service_name': 'assets'
+      }
+
+      command = ServiceWorkflowValidateCommand(app, **config)
+      command.validate()
+
+  @staticmethod
+  def cli_app_create(runner: CliRunner, app_dir_path: str, app_name: str):
+    pathlib.Path(f"{app_dir_path}/{DATA_DIR_NAME}").mkdir(parents=True, exist_ok=True)
+
+    result = runner.invoke(scaffold, ['app', 'create',
+      '--app-dir-path', app_dir_path,
+      '--force',
+      app_name
+    ])
+
+    assert result.exit_code == 0
+    output = result.stdout
+    assert not output
+
+  @staticmethod
+  def cli_app_mkcert(runner: CliRunner, app_dir_path: str):
+    result = runner.invoke(scaffold, ['app', 'mkcert',
+      '--app-dir-path', app_dir_path,
+      '--context-dir-path', app_dir_path,
+    ])
+
+    assert result.exit_code == 0
+    output = result.stdout
+    assert not output
+
+
+  @staticmethod
+  def cli_service_create(runner: CliRunner, app_dir_path: str, hostname: str, service_name: str, https: bool):
+    scheme = 'http'
+    port = '80'
+    if https == True:
+      scheme = 'https'
+      port = '443'
+
+    result = runner.invoke(scaffold, ['service', 'create',
+      '--app-dir-path', app_dir_path,
+      '--env', 'TEST',
+      '--force',
+      '--hostname', hostname,
+      '--scheme', scheme,
+      '--port', port,
+      '--workflow', 'mock',
+      '--workflow', 'record',
+      '--workflow', 'test',
+      service_name
+    ])
+    assert result.exit_code == 0
+    output = result.stdout
+    assert not output
+ 
+  # Specific flags for assets
+  @staticmethod
+  def cli_service_create_assets(runner: CliRunner, app_dir_path: str, hostname: str, service_name: str, https: bool):
+    scheme = 'http'
+    port = '80'
+    if https == True:
+      scheme = 'https'
+      port = '443'
+    proxy_mode_reverse_spec = f"reverse:{scheme}://{hostname}:8080"
+
+    result = runner.invoke(scaffold, ['service', 'create',
+      '--app-dir-path', app_dir_path,
+      '--force',
+      '--hostname', hostname,
+      '--scheme', scheme,
+      '--port', port,
+      '--proxy-mode', proxy_mode_reverse_spec,
+      '--detached',
+      '--workflow', 'test',
+      service_name
+    ])
+    assert result.exit_code == 0
+    output = result.stdout
+    assert not output
+  
+  @staticmethod
+  def cli_workflow_create(runner: CliRunner, app_dir_path: str, service_name: str):
+    result = runner.invoke(scaffold, ['workflow', 'create',
+      '--app-dir-path', app_dir_path,
+      '--service', service_name,
+      '--template', 'mock',
+      'ci',
+    ])
+
+    assert result.exit_code == 0
+    output = result.stdout
+    assert not output
+
+  @staticmethod
+  def cli_workflow_run(runner: CliRunner, app_dir_path: str, target_workflow_name: str):
+    command = ['workflow', 'run',
+      '--app-dir-path', app_dir_path,
+      '--context-dir-path', app_dir_path,
+      target_workflow_name,
+    ]
+    result = runner.invoke(scaffold, command)
+
+    assert result.exit_code == 0
+    output = result.stdout
+    assert output
+  
+  @staticmethod
+  def cli_workflow_stop(runner: CliRunner, app_dir_path: str, target_workflow_name: str):
+    command = ['workflow', 'stop',
+      '--app-dir-path', app_dir_path,
+      '--context-dir-path', app_dir_path,
+      target_workflow_name,
+    ]
+    result = runner.invoke(scaffold, command)
+
+    assert result.exit_code == 0
+    output = result.stdout
+    assert output
+

stoobly_agent/test/app/models/schemas/.stoobly/db/VERSION

@@ -1 +1 @@
-1.0.5
+1.0.7

stoobly_agent/test/mock_data/scaffold/docker-compose-assets-service.yml

@@ -0,0 +1,18 @@
+# Define services here
+
+networks:
+  app:
+    external: true
+    name: ${APP_NETWORK}
+
+services:
+  assets:
+    image: nginx:1.27
+    hostname: assets
+    networks:
+      - app
+    volumes:
+      - ./index.html:/usr/share/nginx/html/index.html
+    profiles: &id001
+      - test
+

stoobly_agent/test/mock_data/scaffold/docker-compose-local-service.yml

@@ -0,0 +1,16 @@
+# Define services here
+
+networks:
+  gateway:
+    external: true
+    name: ${APP_NETWORK}
+
+services:
+  my-httpbin:
+    image: kennethreitz/httpbin:latest
+    hostname: my-httpbin.com
+    networks:
+      - gateway
+    profiles: &id001
+      - record
+

stoobly_agent/test/mock_data/scaffold/index.html

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Welcome to NGINX</title>
+</head>
+<body>
+    <h1>Hello, NGINX is serving this page!</h1>
+</body>
+</html>
+

{stoobly_agent-1.0.6.dist-info → stoobly_agent-1.0.8.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: stoobly-agent
-Version: 1.0.6
+Version: 1.0.8
 Summary: Record, mock, and test HTTP(s) requests. CLI agent for Stoobly
 License: Apache-2.0
 Author: Matt Le
@@ -16,6 +16,7 @@ Requires-Dist: click (>=8.1.0,<9.0.0)
 Requires-Dist: diff-match-patch (>=20230430,<20230431)
 Requires-Dist: distro (>=1.6.0,<1.7.0)
 Requires-Dist: dnspython (>=2.6.1,<2.7.0)
+Requires-Dist: docker (>=7.1.0,<8.0)
 Requires-Dist: httptools (>=0.4.0)
 Requires-Dist: jmespath (>=1.0.0)
 Requires-Dist: mergedeep (>=1.3.0,<1.3.4)