Rename quantumclient to neutronclient

Implements Blueprint: remove-use-of-quantum

Change-Id: Idebe92d56d277435ffd23f292984f9b8b8fdb2df

Author: markmcclain

.gitignore

@@ -8,9 +8,9 @@ build-stamp
 cover/*
 doc/build/
 doc/source/api/
-python_quantumclient.egg-info/*
-quantum/vcsversion.py
-quantumclient/versioninfo
+python_neutronclient.egg-info/*
+neutron/vcsversion.py
+neutronclient/versioninfo
 run_tests.err.log
 run_tests.log
 .autogenerated

HACKING.rst

@@ -1,4 +1,4 @@
-QuantumClient Style Commandments
+Neutron Style Commandments
 ================================
 
 - Step 1: Read http://www.python.org/dev/peps/pep-0008/
@@ -39,7 +39,7 @@ Example::
   \n
   {{third-party lib imports in human alphabetical order}}
   \n
-  {{quantum imports in human alphabetical order}}
+  {{neutron imports in human alphabetical order}}
   \n
   \n
   {{begin your code}}
@@ -59,12 +59,12 @@ Example::
   import eventlet
   import webob.exc
 
-  import quantum.api.networks
-  from quantum.api import ports
-  from quantum.db import models
-  from quantum.extensions import multiport
-  import quantum.manager
-  from quantum import service
+  import neutron.api.networks
+  from neutron.api import ports
+  from neutron.db import models
+  from neutron.extensions import multiport
+  import neutron.manager
+  from neutron import service
 
 
 Docstrings

README.rst

@@ -1 +1 @@
-This is the client API library for Quantum.
+This is the client API library for Neutron.

doc/source/conf.py

@@ -4,7 +4,7 @@
 import sys
 import os
 
-project = 'python-quantumclient'
+project = 'python-neutronclient'
 
 # -- General configuration ---------------------------------------------
 

doc/source/index.rst

@@ -1,19 +1,19 @@
 Python bindings to the OpenStack Network API
 ============================================
 
-In order to use the python quantum client directly, you must first obtain an auth token and identify which endpoint you wish to speak to. Once you have done so, you can use the API like so::
+In order to use the python neutron client directly, you must first obtain an auth token and identify which endpoint you wish to speak to. Once you have done so, you can use the API like so::
 
     >>> import logging
-    >>> from quantumclient.quantum import client
+    >>> from neutronclient.neutron import client
     >>> logging.basicConfig(level=logging.DEBUG)
-    >>> quantum = client.Client('2.0', endpoint_url=OS_URL, token=OS_TOKEN)
-    >>> quantum.format = 'json'
+    >>> neutron = client.Client('2.0', endpoint_url=OS_URL, token=OS_TOKEN)
+    >>> neutron.format = 'json'
     >>> network = {'name': 'mynetwork', 'admin_state_up': True}
-    >>> quantum.create_network({'network':network})
-    >>> networks = quantum.list_networks(name='mynetwork')
+    >>> neutron.create_network({'network':network})
+    >>> networks = neutron.list_networks(name='mynetwork')
     >>> print networks
     >>> network_id = networks['networks'][0]['id']
-    >>> quantum.delete_network(network_id)
+    >>> neutron.delete_network(network_id)
 
 
 Command-line Tool
@@ -27,21 +27,21 @@ In order to use the CLI, you must provide your OpenStack username, password, ten
 
 The command line tool will attempt to reauthenticate using your provided credentials for every request. You can override this behavior by manually supplying an auth token using ``--os-url`` and ``--os-auth-token``. You can alternatively set these environment variables::
 
-    export OS_URL=http://quantum.example.org:9696/
+    export OS_URL=http://neutron.example.org:9696/
     export OS_TOKEN=3bcc3d3a03f44e3d8377f9247b0ad155
 
-If quantum server does not require authentication, besides these two arguments or environment variables (We can use any value as token.), we need manually supply ``--os-auth-strategy`` or set the environment variable::
+If neutron server does not require authentication, besides these two arguments or environment variables (We can use any value as token.), we need manually supply ``--os-auth-strategy`` or set the environment variable::
 
     export OS_AUTH_STRATEGY=noauth
 
-Once you've configured your authentication parameters, you can run ``quantum -h`` to see a complete listing of available commands.
+Once you've configured your authentication parameters, you can run ``neutron -h`` to see a complete listing of available commands.
 
 Release Notes
 =============
 
 2.0
 -----
-* support Quantum API 2.0
+* support Neutron API 2.0
 
 2.2.0
 -----

quantum_test.sh renamed to neutron_test.sh

@@ -18,111 +18,111 @@ FORMAT=" --request-format xml"
 
 # test the CRUD of network
 network=mynet1
-quantum net-create $FORMAT $NOAUTH $network || die "fail to create network $network"
-temp=`quantum net-list $FORMAT -- --name $network --fields id | wc -l`
+neutron net-create $FORMAT $NOAUTH $network || die "fail to create network $network"
+temp=`neutron net-list $FORMAT -- --name $network --fields id | wc -l`
 echo $temp
 if [ $temp -ne 5 ]; then
    die "networks with name $network is not unique or found"
 fi
-network_id=`quantum net-list -- --name $network --fields id | tail -n 2 | head -n 1 |  cut -d' ' -f 2`
+network_id=`neutron net-list -- --name $network --fields id | tail -n 2 | head -n 1 |  cut -d' ' -f 2`
 echo "ID of network with name $network is $network_id"
 
-quantum net-show $FORMAT $network ||  die "fail to show network $network"
-quantum net-show $FORMAT $network_id ||  die "fail to show network $network_id"
+neutron net-show $FORMAT $network ||  die "fail to show network $network"
+neutron net-show $FORMAT $network_id ||  die "fail to show network $network_id"
 
-quantum  net-update $FORMAT $network --admin_state_up False  ||  die "fail to update network $network"
-quantum  net-update $FORMAT $network_id --admin_state_up True  ||  die "fail to update network $network_id"
+neutron  net-update $FORMAT $network --admin_state_up False  ||  die "fail to update network $network"
+neutron  net-update $FORMAT $network_id --admin_state_up True  ||  die "fail to update network $network_id"
 
-quantum net-list $FORMAT -c id -- --id fakeid  || die "fail to list networks with column selection on empty list"
+neutron net-list $FORMAT -c id -- --id fakeid  || die "fail to list networks with column selection on empty list"
 
 # test the CRUD of subnet
 subnet=mysubnet1
 cidr=10.0.1.3/24
-quantum subnet-create $FORMAT $NOAUTH $network $cidr --name $subnet  || die "fail to create subnet $subnet"
-tempsubnet=`quantum subnet-list $FORMAT -- --name $subnet --fields id | wc -l`
+neutron subnet-create $FORMAT $NOAUTH $network $cidr --name $subnet  || die "fail to create subnet $subnet"
+tempsubnet=`neutron subnet-list $FORMAT -- --name $subnet --fields id | wc -l`
 echo $tempsubnet
 if [ $tempsubnet -ne 5 ]; then
    die "subnets with name $subnet is not unique or found"
 fi
-subnet_id=`quantum subnet-list $FORMAT -- --name $subnet --fields id | tail -n 2 | head -n 1 |  cut -d' ' -f 2`
+subnet_id=`neutron subnet-list $FORMAT -- --name $subnet --fields id | tail -n 2 | head -n 1 |  cut -d' ' -f 2`
 echo "ID of subnet with name $subnet is $subnet_id"
-quantum subnet-show $FORMAT $subnet ||  die "fail to show subnet $subnet"
-quantum subnet-show $FORMAT $subnet_id ||  die "fail to show subnet $subnet_id"
+neutron subnet-show $FORMAT $subnet ||  die "fail to show subnet $subnet"
+neutron subnet-show $FORMAT $subnet_id ||  die "fail to show subnet $subnet_id"
 
-quantum  subnet-update $FORMAT $subnet --dns_namesevers host1  ||  die "fail to update subnet $subnet"
-quantum  subnet-update $FORMAT $subnet_id --dns_namesevers host2  ||  die "fail to update subnet $subnet_id"
+neutron  subnet-update $FORMAT $subnet --dns_namesevers host1  ||  die "fail to update subnet $subnet"
+neutron  subnet-update $FORMAT $subnet_id --dns_namesevers host2  ||  die "fail to update subnet $subnet_id"
 
 # test the crud of ports
 port=myport1
-quantum port-create $FORMAT $NOAUTH $network --name $port  || die "fail to create port $port"
-tempport=`quantum port-list $FORMAT -- --name $port --fields id | wc -l`
+neutron port-create $FORMAT $NOAUTH $network --name $port  || die "fail to create port $port"
+tempport=`neutron port-list $FORMAT -- --name $port --fields id | wc -l`
 echo $tempport
 if [ $tempport -ne 5 ]; then
    die "ports with name $port is not unique or found"
 fi
-port_id=`quantum port-list $FORMAT -- --name $port --fields id | tail -n 2 | head -n 1 |  cut -d' ' -f 2`
+port_id=`neutron port-list $FORMAT -- --name $port --fields id | tail -n 2 | head -n 1 |  cut -d' ' -f 2`
 echo "ID of port with name $port is $port_id"
-quantum port-show $FORMAT $port ||  die "fail to show port $port"
-quantum port-show $FORMAT $port_id ||  die "fail to show port $port_id"
+neutron port-show $FORMAT $port ||  die "fail to show port $port"
+neutron port-show $FORMAT $port_id ||  die "fail to show port $port_id"
 
-quantum  port-update $FORMAT $port --device_id deviceid1  ||  die "fail to update port $port"
-quantum  port-update $FORMAT $port_id --device_id deviceid2  ||  die "fail to update port $port_id"
+neutron  port-update $FORMAT $port --device_id deviceid1  ||  die "fail to update port $port"
+neutron  port-update $FORMAT $port_id --device_id deviceid2  ||  die "fail to update port $port_id"
 
 # test quota commands RUD
 DEFAULT_NETWORKS=10
 DEFAULT_PORTS=50
 tenant_id=tenant_a
 tenant_id_b=tenant_b
-quantum quota-update $FORMAT --tenant_id $tenant_id --network 30 || die "fail to update quota for tenant $tenant_id"
-quantum quota-update $FORMAT --tenant_id $tenant_id_b --network 20 || die "fail to update quota for tenant $tenant_id"
-networks=`quantum quota-list $FORMAT -c network -c tenant_id | grep $tenant_id | awk '{print $2}'`
+neutron quota-update $FORMAT --tenant_id $tenant_id --network 30 || die "fail to update quota for tenant $tenant_id"
+neutron quota-update $FORMAT --tenant_id $tenant_id_b --network 20 || die "fail to update quota for tenant $tenant_id"
+networks=`neutron quota-list $FORMAT -c network -c tenant_id | grep $tenant_id | awk '{print $2}'`
 if [ $networks -ne 30 ]; then
    die "networks quota should be 30"
 fi
-networks=`quantum quota-list $FORMAT -c network -c tenant_id | grep $tenant_id_b | awk '{print $2}'`
+networks=`neutron quota-list $FORMAT -c network -c tenant_id | grep $tenant_id_b | awk '{print $2}'`
 if [ $networks -ne 20 ]; then
    die "networks quota should be 20"
 fi
-networks=`quantum quota-show $FORMAT --tenant_id $tenant_id | grep network | awk -F'|'  '{print $3}'`
+networks=`neutron quota-show $FORMAT --tenant_id $tenant_id | grep network | awk -F'|'  '{print $3}'`
 if [ $networks -ne 30 ]; then
    die "networks quota should be 30"
 fi
-quantum quota-delete $FORMAT --tenant_id $tenant_id || die "fail to delete quota for tenant $tenant_id"
-networks=`quantum quota-show $FORMAT --tenant_id $tenant_id | grep network | awk -F'|'  '{print $3}'`
+neutron quota-delete $FORMAT --tenant_id $tenant_id || die "fail to delete quota for tenant $tenant_id"
+networks=`neutron quota-show $FORMAT --tenant_id $tenant_id | grep network | awk -F'|'  '{print $3}'`
 if [ $networks -ne $DEFAULT_NETWORKS ]; then
    die "networks quota should be $DEFAULT_NETWORKS"
 fi
 # update self
 if [ "t$NOAUTH" = "t" ]; then
     # with auth
-    quantum quota-update $FORMAT --port 99 || die "fail to update quota for self"
-    ports=`quantum quota-show $FORMAT | grep port | awk -F'|'  '{print $3}'`
+    neutron quota-update $FORMAT --port 99 || die "fail to update quota for self"
+    ports=`neutron quota-show $FORMAT | grep port | awk -F'|'  '{print $3}'`
     if [ $ports -ne 99 ]; then
        die "ports quota should be 99"
     fi
-    
-    ports=`quantum quota-list $FORMAT -c port | grep 99 | awk '{print $2}'`
+
+    ports=`neutron quota-list $FORMAT -c port | grep 99 | awk '{print $2}'`
     if [ $ports -ne 99 ]; then
        die "ports quota should be 99"
     fi
-    quantum quota-delete $FORMAT || die "fail to delete quota for tenant self"
-    ports=`quantum quota-show $FORMAT | grep port | awk -F'|'  '{print $3}'`
+    neutron quota-delete $FORMAT || die "fail to delete quota for tenant self"
+    ports=`neutron quota-show $FORMAT | grep port | awk -F'|'  '{print $3}'`
     if [ $ports -ne $DEFAULT_PORTS ]; then
        die "ports quota should be $DEFAULT_PORTS"
     fi
 else
     # without auth
-    quantum quota-update $FORMAT --port 100
+    neutron quota-update $FORMAT --port 100
     if [ $? -eq 0 ]; then
         die "without valid context on server, quota update command should fail."
     fi
-    quantum quota-show $FORMAT
+    neutron quota-show $FORMAT
     if [ $? -eq 0 ]; then
         die "without valid context on server, quota show command should fail."
     fi
-    quantum quota-delete $FORMAT
+    neutron quota-delete $FORMAT
     if [ $? -eq 0 ]; then
         die "without valid context on server, quota delete command should fail."
     fi
-    quantum quota-list $FORMAT || die "fail to update quota for self"
+    neutron quota-list $FORMAT || die "fail to update quota for self"
 fi

quantumclient/__init__.py renamed to neutronclient/__init__.py

@@ -29,12 +29,13 @@
 
 import httplib2
 
-from quantumclient.common import exceptions
-from quantumclient.common import utils
+from neutronclient.common import exceptions
+from neutronclient.common import utils
 
 _logger = logging.getLogger(__name__)
 
-if 'QUANTUMCLIENT_DEBUG' in os.environ and os.environ['QUANTUMCLIENT_DEBUG']:
+
+if os.environ.get('NEUTRONCLIENT_DEBUG'):
     ch = logging.StreamHandler()
     _logger.setLevel(logging.DEBUG)
     _logger.addHandler(ch)
@@ -61,7 +62,7 @@ def get_token(self):
 
     def url_for(self, attr=None, filter_value=None,
                 service_type='network', endpoint_type='publicURL'):
-        """Fetch the URL from the Quantum service for
+        """Fetch the URL from the Neutron service for
         a particular endpoint type. If none given, return
         publicURL.
         """
@@ -91,7 +92,7 @@ def url_for(self, attr=None, filter_value=None,
 class HTTPClient(httplib2.Http):
     """Handles the REST calls and responses, include authn."""
 
-    USER_AGENT = 'python-quantumclient'
+    USER_AGENT = 'python-neutronclient'
 
     def __init__(self, username=None, tenant_name=None,
                  password=None, auth_url=None,
@@ -215,7 +216,7 @@ def _get_endpoint_url(self):
         try:
             resp, body = self._cs_request(url, "GET")
         except exceptions.Unauthorized:
-            # rollback to authenticate() to handle case when quantum client
+            # rollback to authenticate() to handle case when neutron client
             # is initialized just before the token is expired
             self.authenticate()
             return self.endpoint_url

quantumclient/client.py renamed to neutronclient/client.py

@@ -17,7 +17,7 @@
 
 import gettext
 
-t = gettext.translation('quantumclient', fallback=True)
+t = gettext.translation('neutronclient', fallback=True)
 
 
 def _(msg):

quantumclient/common/__init__.py renamed to neutronclient/common/__init__.py

@@ -20,8 +20,8 @@
 
 import logging
 
-from quantumclient import client
-from quantumclient.quantum import client as quantum_client
+from neutronclient import client
+from neutronclient.neutron import client as neutron_client
 
 
 LOG = logging.getLogger(__name__)
@@ -45,7 +45,7 @@ def __get__(self, instance, owner):
 class ClientManager(object):
     """Manages access to API clients, including authentication.
     """
-    quantum = ClientCache(quantum_client.make_client)
+    neutron = ClientCache(neutron_client.make_client)
 
     def __init__(self, token=None, url=None,
                  auth_url=None,