chore: bump python-on-whales to 0.63.0

MANIFEST.in

@@ -1,3 +1,5 @@
-include *.py *.md
+include *.py *.md *.mako
-recursive-include namekoplus/chassis *.py
+recursive-include namekoplus/chassis *.py *.mako
-recursive-include namekoplus/templates *.py *.yml
+recursive-include namekoplus/templates *.py *.yml *.mako
+recursive-include namekoplus/chassis-agent *.py *.yml *.mako
+recursive-include namekoplus/tests *.py *.mako

README.md

@@ -2,10 +2,6 @@
 
 A lightweight Python distributed microservice solution
 
-## Document
-
-[中文文档](https://doc.bearcatlog.com/)
-
 ## Command Line Tool Usage
 
 ### Checkout Command
@@ -14,8 +10,22 @@ A lightweight Python distributed microservice solution
 namekoplus --help
 ```
 
+### Start a middleware that nameko depends on
+
+```shell
+namekoplus start -m rabbitmq
+```
+
 ### Initialize a nameko service from templates
 
 ```shell
 namekoplus init --directory <dir_name> --type <template_type>
 ```
+
+
+## Detailed Usage
+
+See Documents: 
+
+- [中文](https://doc.bearcatlog.com/)
+- [English](https://legendary-sopapillas-e2626d.netlify.app/)

namekoplus/chassis-agent/rabbitmq/docker-compose-rabbitmq.yml

@@ -0,0 +1,25 @@
+version: "3"
+
+services:
+    rabbitmq:
+      image: rabbitmq:3-management
+      container_name: 'rabbitmq'
+      hostname: 'rabbitmq'
+      ports:
+        - "5672:5672"
+        - "15672:15672"
+        - "25672:25672"
+      volumes:
+        - rabbitmq_data:/var/lib/rabbitmq
+        - rabbitmq_log:/var/log/rabbitmq
+      environment:
+        RABBITMQ_DEFAULT_USER: ${RABBITMQ_DEFAULT_USER:-admin}
+        RABBITMQ_DEFAULT_PASS: ${RABBITMQ_DEFAULT_PASS:-admin}
+      restart: always
+
+
+volumes:
+  rabbitmq_data:
+    driver: local
+  rabbitmq_log:
+    driver: local

namekoplus/command.py

@@ -3,10 +3,32 @@ import shutil
 from contextlib import contextmanager
 
 import click
+from python_on_whales import DockerException, ClientNotFoundError, DockerClient, docker as docker_testing
+
+
+def check_docker():
+    """
+    Check if docker and docker compose are installed and running.
+    """
+    try:
+        docker_testing.ps()
+    except ClientNotFoundError:
+        click.echo('Please install docker first', err=True)
+        raise
+    except DockerException:
+        click.echo('Please start docker correctly', err=True)
+        raise
+
+    if not docker_testing.compose.is_installed():
+        click.echo('Please install docker-compose first', err=True)
+        raise
 
 
 @contextmanager
 def status(status_msg: str, newline: bool = False, quiet: bool = False):
+    """
+    Show status message and yield.
+    """
     msg_suffix = ' ...' if not newline else ' ...\n'
     click.echo(status_msg + msg_suffix)
     try:
@@ -20,15 +42,25 @@ def status(status_msg: str, newline: bool = False, quiet: bool = False):
             click.echo('  Done\n')
 
 
-def get_template_directory() -> str:
+def get_directory(dir_name: str) -> str:
-    """Return the directory where nameko_plus setup templates are found.
+    """
-
+    Return the directory path of the given nameko-plus directory name.
-    This method is used by the nameko_plus ``init`` commands.
     """
     import namekoplus
 
     package_dir = os.path.abspath(os.path.dirname(namekoplus.__file__))
-    return os.path.join(package_dir, 'templates')
+    return os.path.join(package_dir, dir_name)
+
+
+def copy_files(src_dir, dest_dir):
+    for file_ in os.listdir(src_dir):
+        if file_ == '__pycache__':
+            continue
+
+        src_file_path = os.path.join(src_dir, file_)
+        output_file = os.path.join(dest_dir, file_)
+        with status(f'Generating {os.path.abspath(output_file)}'):
+            shutil.copy(src_file_path, output_file)
 
 
 @click.group()
@@ -43,7 +75,7 @@ def cli():
 @click.option('-t', '--type', '_type',
               default='all',
               show_default=True,
-              type=click.Choice(['all', 'rpc', 'event', 'http', 'timer'], case_sensitive=False),
+              type=click.Choice(['all', 'rpc', 'event', 'http', 'timer', 'demo'], case_sensitive=False),
               help='The template type of nameko service')
 def init(directory, _type):
     """
@@ -53,32 +85,89 @@ def init(directory, _type):
         click.echo('Directory {} already exists and is not empty'.format(directory), err=True)
         return
 
-    template_dir = os.path.join(get_template_directory(), _type)
+    template_dir = os.path.join(get_directory('templates'), _type)
     if not os.access(template_dir, os.F_OK):
         click.echo('No such template type {}'.format(_type), err=True)
         return
 
-    # 创建目录
     if not os.access(directory, os.F_OK):
         with status(f'Creating directory {os.path.abspath(directory)!r}'):
             os.makedirs(directory)
 
-    # 把 templates 放入新建的目录
+    copy_files(template_dir, directory)
-    for file_ in os.listdir(template_dir):
-        if file_ == '__pycache__':
-            continue
-        src_file_path = os.path.join(template_dir, file_)
-        output_file = os.path.join(directory, file_)
-        with status(f'Generating {os.path.abspath(output_file)}'):
-            shutil.copy(src_file_path, output_file)
 
 
 @cli.command()
-def start():
+@click.option('-m', '--middleware',
+              required=True,
+              type=click.Choice(['rabbitmq'], case_sensitive=False),
+              help='The middleware name')
+@click.option('-u', '--user',
+              required=False,
+              help='The user name of the middleware')
+@click.option('-p', '--password',
+              required=False,
+              help='The password of the middleware')
+def start(middleware, user, password):
     """
-    Start a middleware, such as RabbitMQ.
+    Start a middleware that the nameko service depends on.
     """
-    click.echo('Initialized the database')
+    check_docker()
+
+    if user and password:
+        os.environ['RABBITMQ_DEFAULT_USER'] = user
+        os.environ['RABBITMQ_DEFAULT_PASS'] = password
+
+    docker_compose_file_dir = os.path.join(get_directory('chassis-agent'), middleware)
+    for file_ in os.listdir(docker_compose_file_dir):
+        compose_file_path = os.path.join(docker_compose_file_dir, file_)
+        with status(f'Starting {middleware}'):
+            docker = DockerClient(compose_files=[compose_file_path])
+            docker.compose.up(detach=True)
+
+
+@cli.command()
+@click.option('-m', '--middleware',
+              required=True,
+              type=click.Choice(['rabbitmq'], case_sensitive=False),
+              help='The middleware name')
+def stop(middleware):
+    """
+    Stop a middleware that the nameko service depends on.
+    """
+    check_docker()
+
+    docker_compose_file_dir = os.path.join(get_directory('chassis-agent'), middleware)
+    for file_ in os.listdir(docker_compose_file_dir):
+        compose_file_path = os.path.join(docker_compose_file_dir, file_)
+        with status(f'Stopping {middleware}'):
+            docker = DockerClient(compose_files=[compose_file_path])
+            docker.compose.down()
+
+
+@cli.command()
+@click.option('-e', '--existed_dir', 'directory',
+              required=True,
+              help='The existed directory name of the nameko service')
+@click.option('-t', '--type', '_type',
+              default='unit',
+              show_default=True,
+              type=click.Choice(['unit'], case_sensitive=False),
+              help='The test type of the nameko service')
+def test_gen(directory, _type):
+    """
+    Generate test files for nameko services.
+    """
+    if not os.access(directory, os.F_OK) or not os.listdir(directory):
+        click.echo('Directory {} dose not exist or is empty'.format(directory), err=True)
+        return
+
+    tests_dir = os.path.join(get_directory('tests'), _type)
+    if not os.access(tests_dir, os.F_OK):
+        click.echo('No such test type {}'.format(_type), err=True)
+        return
+
+    copy_files(tests_dir, directory)
 
 
 if __name__ == '__main__':

namekoplus/templates/all/config.yml

@@ -1,4 +1,5 @@
-AMQP_URI: pyamqp://${RABBIT_USER:guest}:${RABBIT_PASSWORD:guest}@${RABBIT_HOST:localhost}:${RABBIT_PORT:5672}/
+AMQP_URI: pyamqp://${RABBIT_USER:admin}:${RABBIT_PASSWORD:admin}@${RABBIT_HOST:localhost}:${RABBIT_PORT:5672}/
+WEB_SERVER_ADDRESS: '0.0.0.0:8000'
 RPC_EXCHANGE: 'nameko-rpc'
 
 max_workers: 10

namekoplus/templates/demo/config.yml

@@ -0,0 +1,5 @@
+AMQP_URI: pyamqp://${RABBIT_USER:admin}:${RABBIT_PASSWORD:admin}@${RABBIT_HOST:localhost}:${RABBIT_PORT:5672}/
+RPC_EXCHANGE: 'nameko-rpc'
+
+max_workers: 10
+parent_calls_tracked: 20

namekoplus/templates/demo/rpc_demo.py

@@ -0,0 +1,20 @@
+from nameko.rpc import rpc, ServiceRpc
+
+
+class RpcResponderDemoService:
+    name = "rpc_responder_demo_service"
+
+    @rpc
+    def hello(self, name):
+        return "Hello, {}!".format(name)
+
+
+class RpcCallerDemoService:
+    name = "rpc_caller_demo_service"
+
+    remote = ServiceRpc("rpc_responder_demo_service")
+
+    @rpc
+    def remote_hello(self, value="John Doe"):
+        res = u"{}".format(value)
+        return self.remote.hello(res)

namekoplus/templates/event/config.yml

@@ -1,4 +1,4 @@
-AMQP_URI: pyamqp://${RABBIT_USER:guest}:${RABBIT_PASSWORD:guest}@${RABBIT_HOST:localhost}:${RABBIT_PORT:5672}/
+AMQP_URI: pyamqp://${RABBIT_USER:admin}:${RABBIT_PASSWORD:admin}@${RABBIT_HOST:localhost}:${RABBIT_PORT:5672}/
 RPC_EXCHANGE: 'nameko-rpc'
 
 max_workers: 10

namekoplus/templates/http/config.yml

@@ -1,4 +1,5 @@
-AMQP_URI: pyamqp://${RABBIT_USER:guest}:${RABBIT_PASSWORD:guest}@${RABBIT_HOST:localhost}:${RABBIT_PORT:5672}/
+AMQP_URI: pyamqp://${RABBIT_USER:admin}:${RABBIT_PASSWORD:admin}@${RABBIT_HOST:localhost}:${RABBIT_PORT:5672}/
+WEB_SERVER_ADDRESS: '0.0.0.0:8000'
 RPC_EXCHANGE: 'nameko-rpc'
 
 max_workers: 10

namekoplus/templates/rpc/config.yml

@@ -1,4 +1,4 @@
-AMQP_URI: pyamqp://${RABBIT_USER:guest}:${RABBIT_PASSWORD:guest}@${RABBIT_HOST:localhost}:${RABBIT_PORT:5672}/
+AMQP_URI: pyamqp://${RABBIT_USER:admin}:${RABBIT_PASSWORD:admin}@${RABBIT_HOST:localhost}:${RABBIT_PORT:5672}/
 RPC_EXCHANGE: 'nameko-rpc'
 
 max_workers: 10

namekoplus/templates/timer/config.yml

@@ -1,4 +1,4 @@
-AMQP_URI: pyamqp://${RABBIT_USER:guest}:${RABBIT_PASSWORD:guest}@${RABBIT_HOST:localhost}:${RABBIT_PORT:5672}/
+AMQP_URI: pyamqp://${RABBIT_USER:admin}:${RABBIT_PASSWORD:admin}@${RABBIT_HOST:localhost}:${RABBIT_PORT:5672}/
 RPC_EXCHANGE: 'nameko-rpc'
 
 max_workers: 10

namekoplus/tests/unit/test_service.py

@@ -0,0 +1,29 @@
+"""
+Service unit testing best practice.
+"""
+
+import pytest
+from nameko.testing.services import worker_factory
+
+
+@pytest.mark.parametrize(
+    'value, expected',
+    [
+        ('John Doe', 'Hello, John Doe!'),
+        ('', 'Hello, !'),
+        ('Bryant', 'Hello, Bryant!'),
+    ],
+)
+def test_example_service(value, expected):
+    """
+    Test example service.
+    """
+    # create worker with mock dependencies
+    service = worker_factory(ServiceName)  # TODO replace ServiceName with the name of the service and import it
+
+    # add side effects to the mock rpc dependency on the "remote" service
+    service.remote.hello.side_effect = lambda name: "Hello, {}!".format(name)
+
+    # test remote_hello business logic
+    assert service.remote_hello(value) == expected
+    service.remote.hello.assert_called_once_with(value)

setup.py

@@ -9,12 +9,16 @@ with open(path.join(here, 'README.md'), encoding='utf-8') as f:
 
 setup(
     name='namekoplus',
-    version='0.1.2',
+    version='0.3.2',
     description='A lightweight Python distributed microservice solution',
     long_description=long_description,
     long_description_content_type='text/markdown',
-    url='https://github.com/Bryanthelol/namekoplus',
+    url='',
-
+    project_urls={
+        'Documentation': 'https://doc.bearcatlog.com/',
+        'Source Code': 'https://github.com/Bryanthelol/namekoplus',
+        'Bug Tracker': 'https://github.com/Bryanthelol/namekoplus/issues',
+    },
     author='Bryant He',
     author_email='bryantsisu@qq.com',
 
@@ -29,7 +33,7 @@ setup(
         'Topic :: Software Development :: Libraries :: Python Modules',
     ],
     platforms='any',
-    python_requires='>=3',
+    python_requires='>=3.8, <4',
 
     keywords='lightweight python distributed microservice solution',
 
@@ -45,20 +49,19 @@ setup(
 
     install_requires=[
         'nameko==3.0.0rc11',
-        'nameko-sentry==1.0.0',
-        'nameko-tracer==1.4.0',
         'click==8.1.5',
-        'pytest==7.4.0',
+        'python-on-whales==0.63.0',
-        'environs==9.5.0',
+        'pytest==7.4.0'
-        'logstash_formatter==0.5.17',
-        'statsd==4.0.1',
-        'tenacity==8.2.2',
-        'cachetools==5.3.0',
-        'circuitbreaker==2.0.0',
-        'shortuuid==1.0.11',
-        'cryptography'
     ],
     extras_require={
+        'ha': ['tenacity==8.2.2',
+               'cachetools==5.3.0',
+               'circuitbreaker==2.0.0',
+               'statsd==4.0.1',
+               'logstash_formatter==0.5.17',
+               'nameko-sentry==1.0.0',
+               'nameko-tracer==1.4.0',
+               'shortuuid==1.0.11'],
         'apiflask': ['apiflask>=1.3.1',
                      'gevent>=22.10.2',
                      'gunicorn==20.1.0'],
@@ -68,6 +71,8 @@ setup(
                   'sqlalchemy==2.0.15',
                   'sqlacodegen==2.3.0',
                   'alembic==1.11.1'],
-        'dev': ['mako==1.2.4'],
+        'security': ['cryptography'],
+        'dev': ['mako==1.2.4',
+                'environs==9.5.0']
     },
 )