Merge pull request #222 from onefinestay/mandatory-service-name

Mandatory service name

docs/built_in_extensions.rst

@@ -53,7 +53,7 @@ Nameko's HTTP entrypoint supports simple GET and POST:
 .. code-block:: shell
 
     $ nameko run http
-    starting services: httpservice
+    starting services: http_service
 
 .. code-block:: shell
 
@@ -88,7 +88,7 @@ The HTTP entrypoint is built on top of `werkzeug <http://werkzeug.pocoo.org/>`_.
 .. code-block:: shell
 
     $ nameko run advanced_http
-    starting services: advancedhttpservice
+    starting services: advanced_http_service
 
 .. code-block:: shell
 

docs/examples/advanced_http.py

@@ -4,6 +4,7 @@
 from werkzeug.wrappers import Response
 
 class Service(object):
+    name = "advanced_http_service"
 
     @http('GET', '/privileged')
     def forbidden(self):

docs/examples/example.py

@@ -1,6 +1,7 @@
 from nameko.rpc import rpc, RpcProxy
 
 class Service(object):
+    name = "service"
 
     # we depend on the RPC interface of "another_service"
     other_rpc = RpcProxy("another_service")

docs/examples/fibonacci.py

@@ -14,6 +14,7 @@ def get_dependency(self, worker_ctx):
 
 
 class Fibonacci(object):
+    name = "fibonacci"
 
     store = DataStore()
 

docs/examples/helloworld.py

@@ -1,7 +1,7 @@
 from nameko.rpc import rpc
 
-
-class HelloWorld(object):
+class GreetingService(object):
+    name = "greeting_service"
 
     @rpc
     def hello(self, name):

docs/examples/http.py

@@ -4,6 +4,7 @@
 from nameko.web.handlers import http
 
 class HttpService(object):
+    name = "http_service"
 
     @http('GET', '/get/<int:value>')
     def get_method(self, value):

docs/examples/service_container.py

@@ -1,7 +1,7 @@
 from nameko.containers import ServiceContainer
 
 class Service(object):
-    pass
+    name = "service"
 
 # create a container
 container = ServiceContainer(Service, config={})

docs/examples/service_runner.py

@@ -2,10 +2,10 @@
 from nameko.utils import get_container
 
 class ServiceA(object):
-    pass
+    name = "service_a"
 
 class ServiceB(object):
-    pass
+    name = "service_b"
 
 # create a runner for ServiceA and ServiceB
 runner = ServiceRunner(config={})

docs/examples/testing/entrypoint_hook.py

@@ -8,6 +8,7 @@
 class HelloService(object):
     """ Service under test
     """
+    name = "hello_service"
 
     language = Language()
 

docs/examples/testing/large_integration_test.py

@@ -66,6 +66,7 @@ def __iter__(self):
 
 
 class AcmeShopService(object):
+    name = "acmeshopservice"
 
     user_basket = ShoppingBasket()
     stock_rpc = RpcProxy('stockservice')
@@ -140,6 +141,7 @@ def get_dependency(self, worker_ctx):
 
 
 class StockService(object):
+    name = "stockservice"
 
     warehouse = Warehouse()
 
@@ -205,6 +207,7 @@ def get_user_details():
 
 
 class InvoiceService(object):
+    name = "invoiceservice"
 
     get_user_details = AddressBook()
 
@@ -227,6 +230,7 @@ def prepare_invoice(self, amount):
 
 
 class PaymentService(object):
+    name = "paymentservice"
 
     @rpc
     def take_payment(self, invoice):

docs/examples/testing/unit_test.py

@@ -8,6 +8,8 @@
 class ConversionService(object):
     """ Service under test
     """
+    name = "conversions"
+
     maths_rpc = RpcProxy("maths")
 
     @rpc

docs/examples/testing/unit_test_alternative_dependency.py

@@ -25,6 +25,8 @@ class Result(Base):
 class Service(object):
     """ Service under test
     """
+    name = "service"
+
     db = Session(Base)
 
     @rpc

docs/examples/timer.py

@@ -1,6 +1,7 @@
 from nameko.timer import timer
 
 class Service(object):
+    name ="service"
 
     @timer(interval=5)
     def ping(self):

docs/examples/travis.py

@@ -28,6 +28,7 @@ def get_dependency(self, worker_ctx):
 
 
 class Travis(object):
+    name = "travis_service"
 
     webservice = TravisWebservice()
 

docs/examples/websocket_rpc.py

@@ -3,6 +3,7 @@
 from nameko.web.websocket import rpc, WebSocketHubProvider
 
 class WebsocketRpc(object):
+    name = "websocket_rpc_service"
 
     websocket_hub = WebSocketHubProvider()
 

docs/index.rst

@@ -17,7 +17,8 @@ A nameko service is just a class:
 
     from nameko.rpc import rpc
 
-    class HelloWorld(object):
+    class GreetingService(object):
+        name = "greeting_service"
 
         @rpc
         def hello(self, name):
@@ -29,15 +30,15 @@ You can run it in a shell:
 .. code-block:: shell
 
     $ nameko run helloworld
-    starting services: helloworld
+    starting services: greeting_service
     ...
 
 And play with it from another:
 
 .. code-block:: pycon
 
     $ nameko shell
-    >>> n.rpc.helloworld.hello(name="Matt")
+    >>> n.rpc.greeting_service.hello(name="Matt")
     u'Hello, Matt!'
 
 

nameko/cli/main.py

@@ -1,6 +1,6 @@
 import argparse
 
-from nameko.exceptions import CommandError
+from nameko.exceptions import CommandError, ConfigurationError
 from . import backdoor, run, shell
 
 
@@ -22,5 +22,5 @@ def main():
     args = parser.parse_args()
     try:
         args.main(args)
-    except CommandError as exc:
+    except (CommandError, ConfigurationError) as exc:
         print "Error: {}".format(exc)

nameko/containers.py

@@ -18,7 +18,7 @@
 
 from nameko.extensions import (
     is_dependency, ENTRYPOINT_EXTENSIONS_ATTR, iter_extensions)
-from nameko.exceptions import ContainerBeingKilled
+from nameko.exceptions import ContainerBeingKilled, ConfigurationError
 from nameko.log_helpers import make_timing_logger
 from nameko.utils import repr_safe_str, SpawningSet
 
@@ -29,7 +29,16 @@
 
 
 def get_service_name(service_cls):
-    return getattr(service_cls, "name", service_cls.__name__.lower())
+    service_name = getattr(service_cls, 'name', None)
+    if service_name is None:
+        raise ConfigurationError(
+            'Service class must define a `name` attribute ({}.{})'.format(
+                service_cls.__module__, service_cls.__name__))
+    if not isinstance(service_name, basestring):
+        raise ConfigurationError(
+            'Service name attribute must be a string ({}.{}.name)'.format(
+                service_cls.__module__, service_cls.__name__))
+    return service_name
 
 
 def new_call_id():

nameko/exceptions.py

@@ -158,6 +158,10 @@ def __str__(self):
         return "Unserializable value: `{}`".format(self.repr_value)
 
 
+class ConfigurationError(Exception):
+    pass
+
+
 class CommandError(Exception):
     """Raise from subcommands to report error back to the user"""
 

nameko/testing/services.py

@@ -143,6 +143,8 @@ def worker_factory(service_cls, **dependencies):
         from nameko.rpc import RpcProxy, rpc
 
         class ConversionService(object):
+            name = "conversions"
+
             maths_rpc = RpcProxy("maths")
 
             @rpc
@@ -239,6 +241,8 @@ def replace_dependencies(container, *dependencies):
         from nameko.standalone.rpc import ServiceRpcProxy
 
         class ConversionService(object):
+            name = "conversions"
+
             maths_rpc = RpcProxy("maths")
 
             @rpc
@@ -304,6 +308,7 @@ def restrict_entrypoints(container, *entrypoints):
     .. code-block:: python
 
         class Service(object):
+            name = "service"
 
             @timer(interval=1)
             def foo(self, arg):

nameko/timer.py

@@ -23,6 +23,7 @@ def __init__(self, interval):
             timer = Timer.decorator
 
             class Service(object):
+                name = "service"
 
                 @timer(interval=5)
                 def tick(self):

test/cli/test_main.py

@@ -4,7 +4,7 @@
 import pytest
 
 from nameko.cli.main import main, setup_parser
-from nameko.exceptions import CommandError
+from nameko.exceptions import CommandError, ConfigurationError
 
 
 @pytest.yield_fixture(autouse=True)
@@ -31,9 +31,10 @@ def test_run():
     assert args.broker == 'my_broker'
 
 
-def test_error(capsys):
+@pytest.mark.parametrize('exception', (CommandError, ConfigurationError))
+def test_error(exception, capsys):
     with patch('nameko.cli.main.run.main') as run:
-        run.side_effect = CommandError('boom')
+        run.side_effect = exception('boom')
         main()
     out, _ = capsys.readouterr()
     assert out.strip() == 'Error: boom'

test/cli/test_run.py

@@ -10,6 +10,7 @@
 from nameko.cli.main import setup_parser
 from nameko.cli.run import import_service, setup_backdoor, main, run
 from nameko.exceptions import CommandError
+from nameko.runners import ServiceRunner
 from nameko.standalone.rpc import ClusterRpcProxy
 
 from test.sample import Service
@@ -114,7 +115,7 @@ def test_stopping(rabbit_config):
             KeyboardInterrupt,
             None,  # second wait, after stop() which returns normally
         ]
-        gt = eventlet.spawn(run, [object], rabbit_config)
+        gt = eventlet.spawn(run, [Service], rabbit_config)
         gt.wait()
         # should complete
 
@@ -131,7 +132,7 @@ def test_stopping_twice(rabbit_config):
             runner.stop.side_effect = KeyboardInterrupt
             runner.kill.return_value = None
 
-            gt = eventlet.spawn(run, [object], rabbit_config)
+            gt = eventlet.spawn(run, [Service], rabbit_config)
             gt.wait()
 
 
@@ -142,8 +143,11 @@ def test_os_error_for_signal(rabbit_config):
             OSError(errno.EINTR, ''),
             None,  # second wait, after stop() which returns normally
         ]
-        gt = eventlet.spawn(run, [object], rabbit_config)
-        gt.wait()
+        # don't actually start the service -- we're not firing a real signal
+        # so the signal handler won't stop it again
+        with patch.object(ServiceRunner, 'start'):
+            gt = eventlet.spawn(run, [Service], rabbit_config)
+            gt.wait()
         # should complete
 
 
@@ -154,6 +158,9 @@ def test_other_errors_propagate(rabbit_config):
             OSError(0, ''),
             None,  # second wait, after stop() which returns normally
         ]
-        gt = eventlet.spawn(run, [object], rabbit_config)
-        with pytest.raises(OSError):
-            gt.wait()
+        # don't actually start the service -- there's no real OSError that
+        # would otherwise kill the whole process
+        with patch.object(ServiceRunner, 'start'):
+            gt = eventlet.spawn(run, [Service], rabbit_config)
+            with pytest.raises(OSError):
+                gt.wait()

test/sample.py

@@ -2,6 +2,8 @@
 
 
 class Service(object):
+    name = "service"
+
     @rpc
     def ping(self):
         pass

test/standalone/test_rpc_proxy.py

@@ -224,6 +224,8 @@ def test_multiple_calls_to_result(container_factory, rabbit_config):
 
 
 class ExampleService(object):
+    name = "exampleservice"
+
     def callback(self):
         # to be patched out with mock
         pass

test/test_broker.py

@@ -40,6 +40,7 @@ def logger():
 
 
 class ExampleService(object):
+    name = "exampleservice"
 
     @rpc
     def echo(self, arg):
@@ -66,6 +67,8 @@ def handle(self, evt_data):
 
 
 class ProxyService(object):
+    name = "proxyservice"
+
     example_rpc = RpcProxy('exampleservice')
 
     @dummy