Browse Source

Documentation changes and formatting fixes.

nuwan_ag 10 years ago
parent
commit
c47542e170

+ 3 - 2
README.rst

@@ -2,7 +2,8 @@ cloudbridge
 ===========
 ===========
 
 
 cloudbridge provides a layer of abstraction over different cloud providers.
 cloudbridge provides a layer of abstraction over different cloud providers.
-It's a straightfoward implementation of the `bridge pattern`_.
+It's a straightfoward implementation of the `bridge pattern`_. It is currently
+under development and is in a Pre-Alpha state.
 
 
 .. image:: https://codeclimate.com/github/gvlproject/cloudbridge/badges/gpa.svg
 .. image:: https://codeclimate.com/github/gvlproject/cloudbridge/badges/gpa.svg
    :target: https://codeclimate.com/github/gvlproject/cloudbridge
    :target: https://codeclimate.com/github/gvlproject/cloudbridge
@@ -43,7 +44,7 @@ must be set to your cloud credentials.
 
 
 Documentation
 Documentation
 ~~~~~~~~~~~~~
 ~~~~~~~~~~~~~
-Complete documentation can be found at <https://cloudbridge.readthedocs.org>.
+Documentation can be found at <https://cloudbridge.readthedocs.org>.
 
 
 
 
 Running tests
 Running tests

+ 2 - 1
cloudbridge/providers/interfaces/services.py

@@ -490,7 +490,8 @@ class SecurityGroupService(ProviderService):
                           returned.
                           returned.
 
 
         :rtype: list of :class:`SecurityGroup`
         :rtype: list of :class:`SecurityGroup`
-        :return: A list of SecurityGroup objects or an empty list if none found.
+        :return: A list of SecurityGroup objects or an empty list if none
+        found.
         """
         """
         raise NotImplementedError(
         raise NotImplementedError(
             'get not implemented by this provider')
             'get not implemented by this provider')

+ 2 - 16
test/test_provider_security_service.py

@@ -1,6 +1,4 @@
 import uuid
 import uuid
-
-# from cloudbridge.providers import interfaces
 from test.helpers import ProviderTestBase
 from test.helpers import ProviderTestBase
 
 
 
 
@@ -10,18 +8,6 @@ class ProviderSecurityServiceTestCase(ProviderTestBase):
         super(ProviderSecurityServiceTestCase, self).__init__(
         super(ProviderSecurityServiceTestCase, self).__init__(
             methodName=methodName, provider=provider)
             methodName=methodName, provider=provider)
 
 
-    # def test_list_key_pairs(self):
-    #     key_pairs = self.provider.security.key_pairs.list()
-    #     # Assume there's always one keypair at least
-    #     self.assertIsInstance(key_pairs[0], interfaces.KeyPair)
-    #     self.assertIsNotNone(key_pairs[0].name)
-
-    # def test_list_security_groups(self):
-    #     groups = self.provider.security.security_groups.list()
-    #     # Assume there's always one keypair at least
-    #     self.assertIsInstance(groups[0], interfaces.SecurityGroup)
-    #     self.assertIsNotNone(groups[0].name)
-
     def test_crud_key_pair_service(self):
     def test_crud_key_pair_service(self):
         name = 'cbtestkeypair-{0}'.format(uuid.uuid4())
         name = 'cbtestkeypair-{0}'.format(uuid.uuid4())
         kp = self.provider.security.key_pairs.create(key_name=name)
         kp = self.provider.security.key_pairs.create(key_name=name)
@@ -29,7 +15,7 @@ class ProviderSecurityServiceTestCase(ProviderTestBase):
         found_kp = [k for k in kpl if k.name == name]
         found_kp = [k for k in kpl if k.name == name]
         self.assertTrue(
         self.assertTrue(
             len(found_kp) == 1,
             len(found_kp) == 1,
-            "List key pairs did not return return expected key {0}."
+            "List key pairs did not return the expected key {0}."
             .format(name))
             .format(name))
         self.provider.security.key_pairs.delete(key_name=kp.name)
         self.provider.security.key_pairs.delete(key_name=kp.name)
         kpl = self.provider.security.key_pairs.list()
         kpl = self.provider.security.key_pairs.list()
@@ -47,7 +33,7 @@ class ProviderSecurityServiceTestCase(ProviderTestBase):
         found_sg = [g for g in sgl if g.name == name]
         found_sg = [g for g in sgl if g.name == name]
         self.assertTrue(
         self.assertTrue(
             len(found_sg) == 1,
             len(found_sg) == 1,
-            "List security groups did not return return expected group {0}."
+            "List security groups did not return the expected group {0}."
             .format(name))
             .format(name))
         self.provider.security.security_groups.delete(group_id=sg.id)
         self.provider.security.security_groups.delete(group_id=sg.id)
         sgl = self.provider.security.security_groups.list()
         sgl = self.provider.security.security_groups.list()