Rename get_events to list_events on the Revoke API

Methods that return a list of entities are named
list_<entity-name>s throughout the project. For
example: list_projects and list_users.

In the Revoke API, the method to list revocation
events was called get_events(). This patch
renames it to list_events(), in order to keep
consistency.

Change-Id: I1032916201a46476b92b44aa7fbcffdcb072f6ea

keystone/contrib/revoke/backends/kvs.py

@@ -39,7 +39,7 @@ class Revoke(revoke.Driver):
         self._store = kvs.get_key_value_store('os-revoke-driver')
         self._store.configure(backing_store=_KVS_BACKEND, **kwargs)
 
-    def _get_event(self):
+    def _list_events(self):
         try:
             return self._store.get(_EVENT_KEY)
         except exception.NotFound:
@@ -53,7 +53,7 @@ class Revoke(revoke.Driver):
         # TODO(ayoung): Store the time of the oldest event so that the
         # prune process can be skipped if none of the events have timed out.
         with self._store.get_lock(_EVENT_KEY) as lock:
-            events = self._get_event()
+            events = self._list_events()
             if new_event is not None:
                 events.append(new_event)
 
@@ -66,7 +66,7 @@ class Revoke(revoke.Driver):
             self._store.set(_EVENT_KEY, pruned, lock)
         return results
 
-    def get_events(self, last_fetch=None):
+    def list_events(self, last_fetch=None):
         return self._prune_expired_events_and_get(last_fetch=last_fetch)
 
     def revoke(self, event):

keystone/contrib/revoke/backends/sql.py

@@ -80,7 +80,7 @@ class Revoke(revoke.Driver):
 
         session.flush()
 
-    def get_events(self, last_fetch=None):
+    def list_events(self, last_fetch=None):
         self._prune_expired_events()
         session = sql.get_session()
         query = session.query(RevocationEvent).order_by(

keystone/contrib/revoke/controllers.py

@@ -31,7 +31,7 @@ class RevokeController(controller.V3Controller):
             except ValueError:
                 raise exception.ValidationError(
                     message=_('invalid date format %s') % since)
-        events = self.revoke_api.get_events(last_fetch=last_fetch)
+        events = self.revoke_api.list_events(last_fetch=last_fetch)
         # Build the links by hand as the standard controller calls require ids
         response = {'events': [event.to_dict() for event in events],
                     'links': {

keystone/contrib/revoke/core.py

@@ -202,7 +202,7 @@ class Manager(manager.Manager):
     @cache.on_arguments(should_cache_fn=SHOULD_CACHE,
                         expiration_time=REVOCATION_CACHE_EXPIRATION_TIME)
     def _get_revoke_tree(self):
-        events = self.driver.get_events()
+        events = self.driver.list_events()
         revoke_tree = model.RevokeTree(revoke_events=events)
 
         return revoke_tree
@@ -230,7 +230,7 @@ class Driver(object):
     """Interface for recording and reporting revocation events."""
 
     @abc.abstractmethod
-    def get_events(self, last_fetch=None):
+    def list_events(self, last_fetch=None):
         """return the revocation events, as a list of objects
 
         :param last_fetch:   Time of last fetch.  Return all events newer.

keystone/tests/unit/test_auth.py

@@ -508,7 +508,7 @@ class AuthWithToken(AuthTest):
 
             self.token_provider_api.revoke_token(token_id, revoke_chain=True)
 
-            revoke_events = self.revoke_api.get_events()
+            revoke_events = self.revoke_api.list_events()
             self.assertThat(revoke_events, matchers.HasLength(1))
             revoke_event = revoke_events[0].to_dict()
             self.assertIn('expires_at', revoke_event)
@@ -536,7 +536,7 @@ class AuthWithToken(AuthTest):
             # token are revoked.
             self.token_provider_api.revoke_token(token_id)
 
-            revoke_events = self.revoke_api.get_events()
+            revoke_events = self.revoke_api.list_events()
             self.assertThat(revoke_events, matchers.HasLength(2))
             revoke_event = revoke_events[1].to_dict()
             self.assertIn('expires_at', revoke_event)

keystone/tests/unit/test_revoke.py

@@ -114,27 +114,27 @@ def _matches(event, token_values):
 class RevokeTests(object):
     def test_list(self):
         self.revoke_api.revoke_by_user(user_id=1)
-        self.assertEqual(1, len(self.revoke_api.get_events()))
+        self.assertEqual(1, len(self.revoke_api.list_events()))
 
         self.revoke_api.revoke_by_user(user_id=2)
-        self.assertEqual(2, len(self.revoke_api.get_events()))
+        self.assertEqual(2, len(self.revoke_api.list_events()))
 
     def test_list_since(self):
         self.revoke_api.revoke_by_user(user_id=1)
         self.revoke_api.revoke_by_user(user_id=2)
         past = timeutils.utcnow() - datetime.timedelta(seconds=1000)
-        self.assertEqual(2, len(self.revoke_api.get_events(past)))
+        self.assertEqual(2, len(self.revoke_api.list_events(past)))
         future = timeutils.utcnow() + datetime.timedelta(seconds=1000)
-        self.assertEqual(0, len(self.revoke_api.get_events(future)))
+        self.assertEqual(0, len(self.revoke_api.list_events(future)))
 
     def test_past_expiry_are_removed(self):
         user_id = 1
         self.revoke_api.revoke_by_expiration(user_id, _future_time())
-        self.assertEqual(1, len(self.revoke_api.get_events()))
+        self.assertEqual(1, len(self.revoke_api.list_events()))
         event = model.RevokeEvent()
         event.revoked_at = _past_time()
         self.revoke_api.revoke(event)
-        self.assertEqual(1, len(self.revoke_api.get_events()))
+        self.assertEqual(1, len(self.revoke_api.list_events()))
 
     @mock.patch.object(timeutils, 'utcnow')
     def test_expired_events_removed_validate_token_success(self, mock_utcnow):