stoobly-agent 0.34.13__py3-none-any.whl → 1.0.1__py3-none-any.whl

stoobly_agent/app/cli/scaffold/templates/app/entrypoint/mock/.docker-compose.mock.yml

@@ -0,0 +1,31 @@
+networks:
+  entrypoint:
+    name: entrypoint
+services:
+  entrypoint.configure:
+    build:
+      context: ./
+      dockerfile: ../../.Dockerfile.context
+    depends_on:
+      entrypoint.init:
+        condition: service_completed_successfully
+    environment: {}
+    extends:
+      file: ../.docker-compose.base.yml
+      service: entrypoint.configure_base
+    profiles:
+      - mock
+    volumes: []
+  entrypoint.init:
+    build:
+      context: ./
+      dockerfile: ../../.Dockerfile.context
+    environment: {}
+    extends:
+      file: ../.docker-compose.base.yml
+      service: entrypoint.init_base
+    profiles:
+      - mock
+    volumes:
+      - ./dist:/home/stoobly/dist
+volumes: {}

stoobly_agent/app/cli/scaffold/templates/app/entrypoint/mock/bin/.configure

@@ -0,0 +1,10 @@
+#!/bin/bash
+
+# Data
+echo "Configuring intercept mode"
+stoobly-agent intercept configure --mode mock --policy found
+
+echo "Enabling intercept"
+stoobly-agent intercept enable
+
+cd $(dirname -- "$0") && ./configure

stoobly_agent/app/cli/scaffold/templates/app/entrypoint/mock/bin/.init

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+stoobly-agent intercept enable
+
+cd $(dirname -- "$0") && ./init

stoobly_agent/app/cli/scaffold/templates/app/entrypoint/mock/bin/configure

@@ -0,0 +1 @@
+#!/bin/bash

stoobly_agent/app/cli/scaffold/templates/app/entrypoint/mock/bin/init

@@ -0,0 +1,4 @@
+#! /bin/bash
+
+# ARGV[1] = Path to 'dist' folder
+# Contents within this folder will be shared

stoobly_agent/app/cli/scaffold/templates/app/entrypoint/mock/docker-compose.yml

@@ -0,0 +1 @@
+# Define services here

stoobly_agent/app/cli/scaffold/templates/app/entrypoint/record/.docker-compose.record.yml

@@ -0,0 +1,31 @@
+networks:
+  entrypoint:
+    name: entrypoint
+services:
+  entrypoint.configure:
+    build:
+      context: ./
+      dockerfile: ../../.Dockerfile.context
+    depends_on:
+      entrypoint.init:
+        condition: service_completed_successfully
+    environment: {}
+    extends:
+      file: ../.docker-compose.base.yml
+      service: entrypoint.configure_base
+    profiles:
+      - record
+    volumes: []
+  entrypoint.init:
+    build:
+      context: ./
+      dockerfile: ../../.Dockerfile.context
+    environment: {}
+    extends:
+      file: ../.docker-compose.base.yml
+      service: entrypoint.init_base
+    profiles:
+      - record
+    volumes:
+      - ./dist:/home/stoobly/dist
+volumes: {}

stoobly_agent/app/cli/scaffold/templates/app/entrypoint/record/bin/.configure

@@ -0,0 +1,10 @@
+#!/bin/bash
+
+# Data
+echo "Configuring intercept mode"
+stoobly-agent intercept configure --mode record --policy all
+
+echo "Disabling intercept"
+stoobly-agent intercept disable
+
+cd $(dirname -- "$0") && ./configure

stoobly_agent/app/cli/scaffold/templates/app/entrypoint/record/bin/.init

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+stoobly-agent intercept enable
+
+cd $(dirname -- "$0") && ./init

stoobly_agent/app/cli/scaffold/templates/app/entrypoint/record/bin/configure

@@ -0,0 +1 @@
+#!/bin/bash

stoobly_agent/app/cli/scaffold/templates/app/entrypoint/record/bin/init

@@ -0,0 +1,4 @@
+#! /bin/bash
+
+# ARGV[1] = Path to 'dist' folder
+# Contents within this folder will be shared

stoobly_agent/app/cli/scaffold/templates/app/entrypoint/record/docker-compose.yml

@@ -0,0 +1 @@
+# Define services here

stoobly_agent/app/cli/scaffold/templates/app/entrypoint/test/.docker-compose.test.yml

@@ -0,0 +1,31 @@
+networks:
+  entrypoint:
+    name: entrypoint
+services:
+  entrypoint.configure:
+    build:
+      context: ./
+      dockerfile: ../../.Dockerfile.context
+    depends_on:
+      entrypoint.init:
+        condition: service_completed_successfully
+    environment: {}
+    extends:
+      file: ../.docker-compose.base.yml
+      service: entrypoint.configure_base
+    profiles:
+      - test
+    volumes: []
+  entrypoint.init:
+    build:
+      context: ./
+      dockerfile: ../../.Dockerfile.context
+    environment: {}
+    extends:
+      file: ../.docker-compose.base.yml
+      service: entrypoint.init_base
+    profiles:
+      - test
+    volumes:
+      - ./dist:/home/stoobly/dist
+volumes: {}

stoobly_agent/app/cli/scaffold/templates/app/entrypoint/test/bin/.configure

@@ -0,0 +1,10 @@
+#!/bin/bash
+
+# Data
+echo "Configuring intercept mode"
+stoobly-agent intercept configure --mode mock --policy found
+
+echo "Enabling intercept"
+stoobly-agent intercept enable
+
+cd $(dirname -- "$0") && ./configure

stoobly_agent/app/cli/scaffold/templates/app/entrypoint/test/bin/.init

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+cd $(dirname -- "$0") && ./init

stoobly_agent/app/cli/scaffold/templates/app/entrypoint/test/bin/configure

@@ -0,0 +1 @@
+#!/bin/bash

stoobly_agent/app/cli/scaffold/templates/app/entrypoint/test/bin/init

@@ -0,0 +1,4 @@
+#! /bin/bash
+
+# ARGV[1] = Path to 'dist' folder
+# Contents within this folder will be shared

stoobly_agent/app/cli/scaffold/templates/app/entrypoint/test/docker-compose.yml

@@ -0,0 +1 @@
+# Define services here

stoobly_agent/app/cli/scaffold/templates/app/gateway/.config.yml

@@ -0,0 +1 @@
+SERVICE_PRIORITY: 1

stoobly_agent/app/cli/scaffold/templates/app/gateway/.docker-compose.base.yml

@@ -0,0 +1,11 @@
+services:
+  gateway_base:
+    image: nginxproxy/nginx-proxy:1.5
+    ports:
+      - '80:80'
+      - '443:443' # Entry port
+    profiles:
+      - gateway_base
+    volumes:
+      - /var/run/docker.sock:/tmp/docker.sock:ro
+      - ${CERTS_DIR}:/etc/nginx/certs

stoobly_agent/app/cli/scaffold/templates/app/gateway/mock/.docker-compose.mock.yml

@@ -0,0 +1,13 @@
+services:
+  gateway.service:
+    extends:
+      file: ../.docker-compose.base.yml
+      service: gateway_base
+    networks:
+      - gateway
+    profiles:
+      - mock
+networks:
+  gateway:
+    name: ${APP_NETWORK}
+    external: true

stoobly_agent/app/cli/scaffold/templates/app/gateway/record/.docker-compose.record.yml

@@ -0,0 +1,13 @@
+services:
+  gateway.service:
+    extends:
+      file: ../.docker-compose.base.yml
+      service: gateway_base
+    networks:
+      - gateway
+    profiles:
+      - record
+networks:
+  gateway:
+    name: ${APP_NETWORK}
+    external: true

stoobly_agent/app/cli/scaffold/templates/app/stoobly-ui/.config.yml

@@ -0,0 +1 @@
+SERVICE_PRIORITY: 1

stoobly_agent/app/cli/scaffold/templates/app/stoobly-ui/.docker-compose.base.yml

@@ -0,0 +1,5 @@
+services:
+  stoobly_ui.base:
+    extends:
+      file: ../.docker-compose.base.yml
+      service: context_base 

stoobly_agent/app/cli/scaffold/templates/app/stoobly-ui/exec/.docker-compose.exec.yml

@@ -0,0 +1,12 @@
+services:
+  stoobly_ui.command:
+    build:
+      dockerfile: ../../.Dockerfile.context
+    command: ['${EXEC_COMMAND}', '${EXEC_ARGS}']
+    environment:
+      EXEC_OPTIONS: ${EXEC_OPTIONS}
+    extends:
+      file: ../.docker-compose.base.yml
+      service: stoobly_ui.base
+    profiles:
+      - exec

stoobly_agent/app/cli/scaffold/templates/app/stoobly-ui/exec/bin/.create

@@ -0,0 +1,11 @@
+#!/bin/bash
+
+extra_options=$EXEC_OPTIONS
+scenario_name="$1"
+
+if [ ! "$scenario_name" ]; then 
+    echo "Missing argument 'scenario_name'"
+    exit 
+fi
+
+stoobly-agent scenario create --select key --without-headers $extra_options "$scenario_name"

stoobly_agent/app/cli/scaffold/templates/app/stoobly-ui/exec/bin/.delete

@@ -0,0 +1,12 @@
+#!/bin/bash
+
+scenario_key=$1
+
+if [ ! "$scenario_key" ]; then 
+    echo "Missing argument 'scenario_key'"
+    stoobly-agent scenario list
+    exit
+fi
+
+stoobly-agent scenario delete "$scenario_key"
+stoobly-agent scenario snapshot --action DELETE "$scenario_key"

stoobly_agent/app/cli/scaffold/templates/app/stoobly-ui/exec/bin/.disable

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+stoobly-agent intercept disable

stoobly_agent/app/cli/scaffold/templates/app/stoobly-ui/exec/bin/.enable

@@ -0,0 +1,10 @@
+#!/bin/bash
+
+scenario_key=$1
+
+if [ "$scenario_key" ]; then 
+    echo "Using scenario $scenario_key"
+    stoobly-agent config scenario set "$scenario_key"
+fi
+
+stoobly-agent intercept enable

stoobly_agent/app/cli/scaffold/templates/app/stoobly-ui/exec/bin/.reset

@@ -0,0 +1,12 @@
+#!/bin/bash
+
+extra_options=$EXEC_OPTIONS
+scenario_key=$1
+
+if [ ! "$scenario_key" ]; then 
+    echo "Missing argument 'scenario_key'"
+    stoobly-agent scenario list
+    exit
+fi
+
+stoobly-agent scenario reset $extra_options "$scenario_key"

stoobly_agent/app/cli/scaffold/templates/app/stoobly-ui/exec/bin/.run

@@ -0,0 +1,11 @@
+#!/bin/bash
+
+extra_options=$EXEC_OPTIONS
+workflow=$1
+
+stoobly-agent scaffold workflow run \
+  --app-dir-path "$(pwd)" \
+  --dry-run \
+  --log-level warning \
+  $extra_options \
+  $workflow > .stoobly/tmp/run.sh

stoobly_agent/app/cli/scaffold/templates/app/stoobly-ui/exec/bin/.snapshot

@@ -0,0 +1,12 @@
+#!/bin/bash
+
+extra_options=$EXEC_OPTIONS
+scenario_key=$1
+
+if [ ! "$scenario_key" ]; then 
+    echo "Missing argument 'scenario_key'"
+    stoobly-agent scenario list
+    exit
+fi
+
+stoobly-agent scenario snapshot $extra_options "$scenario_key"

stoobly_agent/app/cli/scaffold/templates/app/stoobly-ui/exec/bin/.stop

@@ -0,0 +1,11 @@
+#!/bin/bash
+
+extra_options=$EXEC_OPTIONS
+workflow=$1
+
+stoobly-agent scaffold workflow stop \
+  --app-dir-path "$(pwd)" \
+  --dry-run \
+  --log-level error \
+  $extra_options \
+  $workflow > .stoobly/tmp/run.sh

stoobly_agent/app/cli/scaffold/templates/app/stoobly-ui/mock/.docker-compose.mock.yml

@@ -0,0 +1,12 @@
+services:
+  stoobly_ui.service:
+    build:
+      dockerfile: ../../.Dockerfile.context
+    command: --ui-port 4200
+    extends:
+      file: ../.docker-compose.base.yml
+      service: stoobly_ui.base
+    ports:
+      - '4200:4200'
+    profiles:
+      - mock

stoobly_agent/app/cli/scaffold/templates/app/stoobly-ui/record/.docker-compose.record.yml

@@ -0,0 +1,13 @@
+services:
+  stoobly_ui.service:
+    build:
+      dockerfile: ../../.Dockerfile.context
+    command: --ui-port 4200
+    extends:
+      file: ../.docker-compose.base.yml
+      service: stoobly_ui.base
+    ports:
+      - '4200:4200'
+    profiles:
+      - record
+

stoobly_agent/app/cli/scaffold/templates/constants.py

@@ -0,0 +1,63 @@
+import os
+
+CORE_BUILD_SERVICE_NAME = 'build'
+CORE_MOCK_UI_SERVICE_NAME = 'stoobly-ui'
+CORE_GATEWAY_SERVICE_NAME = 'gateway'
+CORE_ENTRYPOINT_SERVICE_NAME = 'entrypoint'
+CORE_SERVICES = [
+  CORE_BUILD_SERVICE_NAME, CORE_ENTRYPOINT_SERVICE_NAME, CORE_MOCK_UI_SERVICE_NAME, CORE_GATEWAY_SERVICE_NAME 
+]
+
+CORE_MOCK_WORKFLOW = 'mock'
+CORE_RECORD_WORKFLOW = 'record'
+
+CUSTOM_BUILD = os.path.join('bin', 'build')
+CUSTOM_CONFIGURE = os.path.join('bin', 'configure')
+CUSTOM_INIT = os.path.join('bin', 'init')
+CUSTOM_FIXTURES = 'fixtures.yml'
+CUSTOM_LIFECYCLE_HOOKS = os.path.join('lifecycle_hooks.py')
+MAINTAINED_CONFIGURE = os.path.join('bin', '.configure')
+MAINTAINED_INIT = os.path.join('bin', '.init')
+MAINTAINED_FIXTURES = os.path.join('fixtures', '.keep')
+
+MOCK_WORKFLOW_MAINTAINED_FILES = [
+  MAINTAINED_CONFIGURE,
+  MAINTAINED_INIT,
+  MAINTAINED_FIXTURES
+]
+
+MOCK_WORKFLOW_CUSTOM_FILES = [
+  CUSTOM_BUILD,
+  CUSTOM_CONFIGURE,
+  CUSTOM_FIXTURES,
+  CUSTOM_INIT,
+  CUSTOM_LIFECYCLE_HOOKS,
+]
+
+RECORD_WORKFLOW_MAINTAINED_FILES = [
+  MAINTAINED_CONFIGURE,
+  MAINTAINED_INIT
+]
+
+RECORD_WORKFLOW_CUSTOM_FILES = [
+  CUSTOM_BUILD,
+  CUSTOM_CONFIGURE,
+  CUSTOM_INIT,
+  CUSTOM_LIFECYCLE_HOOKS
+]
+
+TEST_WORKFLOW_MAINTAINED_FILES = [
+  MAINTAINED_CONFIGURE,
+  MAINTAINED_INIT,
+  MAINTAINED_FIXTURES
+]
+
+TEST_WORKFLOW_CUSTOM_FILES = [
+  CUSTOM_BUILD,
+  CUSTOM_CONFIGURE,
+  CUSTOM_FIXTURES,
+  CUSTOM_INIT,
+  CUSTOM_LIFECYCLE_HOOKS
+]
+
+SERVICE_HOSTNAME_BUILD_ARG = 'SERVICE_HOSTNAME'

stoobly_agent/app/cli/scaffold/templates/factory.py

@@ -0,0 +1,46 @@
+from ..constants import WORKFLOW_MOCK_TYPE, WORKFLOW_RECORD_TYPE, WORKFLOW_TEST_TYPE
+from ..docker.workflow.builder import WorkflowBuilder
+from .constants import (
+  CUSTOM_CONFIGURE, CUSTOM_INIT, MAINTAINED_CONFIGURE, MAINTAINED_FIXTURES, MOCK_WORKFLOW_CUSTOM_FILES, MOCK_WORKFLOW_MAINTAINED_FILES, RECORD_WORKFLOW_CUSTOM_FILES, RECORD_WORKFLOW_MAINTAINED_FILES, TEST_WORKFLOW_CUSTOM_FILES, TEST_WORKFLOW_MAINTAINED_FILES
+)
+
+def custom_files(workflow: str, workflow_builder: WorkflowBuilder):
+  files = []
+  if workflow == WORKFLOW_MOCK_TYPE:
+    files = MOCK_WORKFLOW_CUSTOM_FILES
+  elif workflow == WORKFLOW_RECORD_TYPE:
+    files = RECORD_WORKFLOW_CUSTOM_FILES
+  elif workflow == WORKFLOW_TEST_TYPE:
+    files = TEST_WORKFLOW_CUSTOM_FILES
+  else:
+    if workflow_builder.configure in workflow_builder.services:
+      files.append(CUSTOM_CONFIGURE)
+
+    if workflow_builder.init in workflow_builder.services:
+      files.append(CUSTOM_INIT)
+
+  # Fixtures are only relevant if the workflow is mock/test and if the service has a hostname
+  if not workflow_builder.config.hostname:
+    if MAINTAINED_FIXTURES in files:
+      files.remove(MAINTAINED_FIXTURES)
+
+  return files
+
+def maintained_files(workflow: str, workflow_builder: WorkflowBuilder):
+  files = []
+
+  if workflow == WORKFLOW_MOCK_TYPE:
+    files = MOCK_WORKFLOW_MAINTAINED_FILES
+  elif workflow == WORKFLOW_RECORD_TYPE:
+    files = RECORD_WORKFLOW_MAINTAINED_FILES
+  elif workflow == WORKFLOW_TEST_TYPE:
+    files = TEST_WORKFLOW_MAINTAINED_FILES
+  else:
+    if workflow_builder.configure in workflow_builder.services:
+      files.append(MAINTAINED_CONFIGURE)
+
+  if not workflow_builder.config.hostname:
+    if MAINTAINED_FIXTURES in files:
+      files.remove(MAINTAINED_FIXTURES)
+
+  return files

stoobly_agent/app/cli/scaffold/templates/workflow/mock/bin/.configure

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+cd $(dirname -- "$0") && ./configure

stoobly_agent/app/cli/scaffold/templates/workflow/mock/bin/.init

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+cd $(dirname -- "$0") && ./init

stoobly_agent/app/cli/scaffold/templates/workflow/mock/bin/configure

@@ -0,0 +1,18 @@
+#!/bin/bash
+
+scheme=$SERVICE_SCHEME
+hostname=$SERVICE_HOSTNAME
+port=$SERVICE_PORT
+
+url="$scheme://$hostname"
+
+if [ "$scheme" = 'http' -a "$port" != '80' ] || [ "$scheme" = 'https' -a "$port" != '443' ]; then
+  url="$url:$port"
+fi
+
+# Match
+echo "Configuring match rules"
+stoobly-agent config match set \
+  --method GET --method POST --method OPTIONS --method PUT --method DELETE \
+  --mode mock \
+  --pattern ".*?"

stoobly_agent/app/cli/scaffold/templates/workflow/mock/bin/init

@@ -0,0 +1,4 @@
+#! /bin/bash
+
+# ARGV[1] = Path to 'dist' folder
+# Contents within this folder will be shared

stoobly_agent/app/cli/scaffold/templates/workflow/mock/fixtures.yml

@@ -0,0 +1,5 @@
+# The following example matches requests for GET /users/d+ (e.g. /users/1) with the contents of user-1.json
+# Assumes that 'user-1.json' is created in the 'fixtures' folder
+#GET:
+#  /users/d+:
+#    path: ./fixtures/user-1.json

stoobly_agent/app/cli/scaffold/templates/workflow/mock/lifecycle_hooks.py

@@ -0,0 +1,12 @@
+# This file defines lifecyle hooks for when Stoobly intercepts a request
+from stoobly_agent.app.proxy.mock.context import MockContext
+
+def handle_before_request(context: MockContext):
+    intercept_settings = context.intercept_settings
+    flow = context.flow
+    request = flow.request
+
+    # For example, uncomment the following
+    #print(f"Agent running in {intercept_settings.mode} mode with {intercept_settings.policy} policy")
+    #print(dir(request))
+        

stoobly_agent/app/cli/scaffold/templates/workflow/record/bin/.configure

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+cd $(dirname -- "$0") && ./configure

stoobly_agent/app/cli/scaffold/templates/workflow/record/bin/.init

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+cd $(dirname -- "$0") && ./init

stoobly_agent/app/cli/scaffold/templates/workflow/record/bin/configure

@@ -0,0 +1,29 @@
+#!/bin/bash
+
+scheme=$SERVICE_SCHEME
+hostname=$SERVICE_HOSTNAME
+port=$SERVICE_PORT
+
+url="$scheme://$hostname"
+
+if [ "$scheme" = 'http' -a "$port" != '80' ] || [ "$scheme" = 'https' -a "$port" != '443' ]; then
+  url="$url:$port"
+fi
+
+# Firewall
+echo "Configuring firewall rules"
+stoobly-agent config firewall set \
+  --action include \
+  --method GET --method POST --method OPTIONS --method PUT --method DELETE \
+  --mode record \
+  --pattern "$url/.*?"
+
+# Rewrite
+echo "Configuring rewrite rules"
+stoobly-agent config rewrite set \
+  --method GET --method POST --method OPTIONS --method PUT --method DELETE \
+  --mode record \
+  --name cookie \
+  --pattern "$host/?.*?" \
+  --type Header \
+  --value '' \

stoobly_agent/app/cli/scaffold/templates/workflow/record/bin/init

@@ -0,0 +1,4 @@
+#! /bin/bash
+
+# ARGV[1] = Path to 'dist' folder
+# Contents within this folder will be shared

stoobly_agent/app/cli/scaffold/templates/workflow/record/lifecycle_hooks.py

@@ -0,0 +1,12 @@
+# This file defines lifecyle hooks for when Stoobly intercepts a request
+from stoobly_agent.app.proxy.record.context import RecordContext
+
+def handle_before_request(context: RecordContext):
+    intercept_settings = context.intercept_settings
+    flow = context.flow
+    request = flow.request
+
+    # For example, uncomment the following
+    #print(f"Agent running in {intercept_settings.mode} mode with {intercept_settings.policy} policy")
+    #print(dir(request))
+        

stoobly_agent/app/cli/scaffold/templates/workflow/test/bin/.configure

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+cd $(dirname -- "$0") && ./configure

stoobly_agent/app/cli/scaffold/templates/workflow/test/bin/.init

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+cd $(dirname -- "$0") && ./init

stoobly_agent/app/cli/scaffold/templates/workflow/test/bin/configure

@@ -0,0 +1,18 @@
+#!/bin/bash
+
+scheme=$SERVICE_SCHEME
+hostname=$SERVICE_HOSTNAME
+port=$SERVICE_PORT
+
+url="$scheme://$hostname"
+
+if [ "$scheme" = 'http' -a "$port" != '80' ] || [ "$scheme" = 'https' -a "$port" != '443' ]; then
+  url="$url:$port"
+fi
+
+# Match
+echo "Configuring match rules"
+stoobly-agent config match set \
+  --method GET --method POST --method OPTIONS --method PUT --method DELETE \
+  --mode mock \
+  --pattern ".*?"

stoobly_agent/app/cli/scaffold/templates/workflow/test/bin/init

@@ -0,0 +1,4 @@
+#! /bin/bash
+
+# ARGV[1] = Path to 'dist' folder
+# Contents within this folder will be shared

stoobly_agent/app/cli/scaffold/templates/workflow/test/fixtures.yml

@@ -0,0 +1,5 @@
+# The following example matches requests for GET /users/d+ (e.g. /users/1) with the contents of user-1.json
+# Assumes that 'user-1.json' is created in the 'fixtures' folder
+#GET:
+#  /users/d+:
+#    path: ./fixtures/user-1.json