Merge pull request gmr#108 from mrwacky42/feature/add-service-list

Add service list to cli

Author: gmr

CONTRIBUTING.md

@@ -12,7 +12,7 @@ of being accepted.*
 
 Consulate test suite has a couple of requirements:
 
- * Dependencies from [requirements/testing.txt](requirements/testing.txt) are installed
+ * Dependencies from [requires/testing.txt](requires/testing.txt) are installed
  * Local Docker and [docker-compose](https://docs.docker.com/compose/)
 
 ## Installing Dependencies
@@ -28,8 +28,8 @@ source env/bin/activate
 To install the dependencies needed to run Consulate tests, use
 
 ```bash
-pip install -r requirements/testing.txt
-```    
+pip install -r requires/testing.txt
+```
 
 ## Starting the test dependency
 
@@ -38,7 +38,7 @@ Prior to running tests, ensure that Consul is running via Docker using:
 ```bash
 ./bootstrap
 ```
-    
+
 This script uses [docker-compose](https://docs.docker.com/compose/) to launch a Consul server container that is
 pre-configured for the tests. In addition, it configures `build/test-environment` that is loaded
 by the tests with configuration information for connecting to Consul.
@@ -56,5 +56,5 @@ with ``pep8`` style prior to issuing your pull request. In addition, run
 ``flake8`` to look for any style errors prior to submitting your PR.
 
 Both are included when the test requirements are installed. If you are fixing
-formatting for existing code, please separate code-reformatting commits from 
+formatting for existing code, please separate code-reformatting commits from
 functionality changes.

README.rst

@@ -53,11 +53,12 @@ setting, and deleting keys from the KV database.
       --token TOKEN         ACL token
 
     Commands:
-      {register,deregister,kv,run_once}
+      {register,deregister,kv,run_once,services}
         register            Register a service for this node
         deregister          Deregister a service for this node
         kv                  Key/Value Database Utilities
         run_once            Lock command
+        services            List services for this node
 
     If the CONSUL_RPC_ADDR environment variable is set, it will be parsed and used
     for default values when connecting.
@@ -122,6 +123,17 @@ Locking Operations Help:
       -h, --help            show this help message and exit
       -i, --interval        hold the lock for INTERVAL seconds
 
+Service listing Help:
+
+.. code:: bash
+
+    usage: consulate services [-h] [-i INDENT]
+
+    optional arguments:
+      -h, --help            show this help message and exit
+      -i INDENT, --indent INDENT
+                            The indent level for output
+
 API Usage Examples
 ------------------
 The following examples highlight the usage of Consulate and does not document

consulate/cli.py

@@ -210,6 +210,18 @@ def add_deregister_args(parser):
     registerp.add_argument('service_id', help='The service registration id')
 
 
+def add_services_args(parser):
+    """Add the services command and arguments.
+
+    :param argparse.Subparser parser: parser
+
+    """
+    # Service registration
+    registerp = parser.add_parser('services',
+                                  help='List services for this node')
+
+    registerp.add_argument('-i', '--indent', type=int, default=None, help='The indent level for output')
+
 def parse_cli_args():
     """Create the argument parser and add the arguments"""
     parser = argparse.ArgumentParser(description='CLI utilities for Consul',
@@ -239,6 +251,7 @@ def parse_cli_args():
     add_register_args(sparser)
     add_deregister_args(sparser)
     add_run_once_args(sparser)
+    add_services_args(sparser)
     return parser.parse_args()
 
 
@@ -570,6 +583,21 @@ def run_once(consul, args):
         on_error(error_msg, error_code)
 
 
+def services(consul, args):
+    """Dump the list of services registered with Consul
+
+    :param consulate.api.Consul consul: The Consul instance
+    :param argparser.namespace args: The cli args
+
+    """
+
+    svcs = consul.agent.services()
+    print(json.dumps(svcs,
+                     sort_keys=True,
+                     indent=args.indent,
+                     separators=(',', ': ')) + '\n')
+
+
 def main():
     """Entrypoint for the consulate cli application"""
     args = parse_cli_args()
@@ -600,5 +628,7 @@ def main():
         register(consul, args)
     elif args.command == 'deregister':
         deregister(consul, args)
+    elif args.command == 'services':
+        services(consul, args)
     elif args.command == 'run_once':
         run_once(consul, args)