Rename to ActiveTokenA

Author: portante

lib/pbench/server/api/resources/users_api.py

@@ -11,7 +11,7 @@
 
 import pbench.server.auth.auth as Auth
 from pbench.server.database.database import Database
-from pbench.server.database.models.active_tokens import ActiveTokens
+from pbench.server.database.models.active_tokens import ActiveToken
 from pbench.server.database.models.server_config import ServerConfig
 from pbench.server.database.models.users import User
 
@@ -231,7 +231,7 @@ def post(self):
 
         # Add the new auth token to the database for later access
         try:
-            token = ActiveTokens(auth_token, expiration)
+            token = ActiveToken(auth_token, expiration)
             user.add_token(token)
         except IntegrityError:
             self.logger.warning(
@@ -251,8 +251,8 @@ def post(self):
 
         # Remove any expired tokens for this user
         try:
-            Database.db_session.query(ActiveTokens).filter_by(user_id=user.id).filter(
-                ActiveTokens.expiration <= datetime.now(timezone.utc)
+            Database.db_session.query(ActiveToken).filter_by(user_id=user.id).filter(
+                ActiveToken.expiration <= datetime.now(timezone.utc)
             ).delete()
             Database.db_session.commit()
         except Exception:
@@ -306,7 +306,7 @@ def post(self):
         if state == "invalid":
             self.logger.info("User logout with invalid token: {}", auth_token)
         else:
-            token = ActiveTokens.query(auth_token)
+            token = ActiveToken.query(auth_token)
             if token:
                 user = token.user
                 if not user:
@@ -315,7 +315,7 @@ def post(self):
                     )
                 else:
                     try:
-                        ActiveTokens.delete(auth_token)
+                        ActiveToken.delete(auth_token)
                     except Exception:
                         self.logger.exception(
                             "Exception occurred deleting auth token {!r} for user {!r}",

lib/pbench/server/auth/auth.py

@@ -9,7 +9,7 @@
 
 from pbench.server import PbenchServerConfig
 from pbench.server.auth import OpenIDClient, OpenIDClientError
-from pbench.server.database.models.active_tokens import ActiveTokens
+from pbench.server.database.models.active_tokens import ActiveToken
 from pbench.server.database.models.users import User
 
 # Module private constants
@@ -124,7 +124,7 @@ def verify_auth(auth_token: str) -> Optional[User]:
     """
     state = verify_token_only(auth_token)
     if state == "verified":
-        token = ActiveTokens.query(auth_token)
+        token = ActiveToken.query(auth_token)
         user = token.user if token else None
     else:
         user = None

lib/pbench/server/database/__init__.py

@@ -3,7 +3,7 @@
 an import statement of the same is required here.
 """
 from pbench.server.database.database import Database
-from pbench.server.database.models.active_tokens import ActiveTokens  # noqa F401
+from pbench.server.database.models.active_tokens import ActiveToken  # noqa F401
 from pbench.server.database.models.audit import Audit  # noqa F401
 from pbench.server.database.models.datasets import Dataset  # noqa F401
 from pbench.server.database.models.datasets import Metadata  # noqa F401

lib/pbench/server/database/models/active_tokens.py

@@ -6,10 +6,10 @@
 
 from pbench.server.database.database import Database
 
-AT = TypeVar("AT", bound="ActiveTokens")
+AT = TypeVar("AT", bound="ActiveToken")
 
 
-class ActiveTokens(Database.Base):
+class ActiveToken(Database.Base):
     """Token model for storing the active auth tokens.
 
     Each token is associated with a given User object, and stores its
@@ -36,7 +36,7 @@ def __init__(self, token: str, expiration: datetime):
     def query(token: str) -> AT:
         # We currently only query token database for a specific token.
         token_model = (
-            Database.db_session.query(ActiveTokens).filter_by(token=token).first()
+            Database.db_session.query(ActiveToken).filter_by(token=token).first()
         )
         return token_model
 
@@ -48,7 +48,7 @@ def delete(token: str) -> None:
         :return:
         """
         try:
-            Database.db_session.query(ActiveTokens).filter_by(token=token).delete()
+            Database.db_session.query(ActiveToken).filter_by(token=token).delete()
             Database.db_session.commit()
         except Exception:
             Database.db_session.rollback()

lib/pbench/server/database/models/users.py

@@ -8,7 +8,7 @@
 from sqlalchemy.orm.exc import NoResultFound
 
 from pbench.server.database.database import Database
-from pbench.server.database.models.active_tokens import ActiveTokens
+from pbench.server.database.models.active_tokens import ActiveToken
 
 
 class Roles(enum.Enum):
@@ -28,7 +28,7 @@ class User(Database.Base):
     registered_on = Column(DateTime, nullable=False, default=datetime.datetime.now())
     email = Column(String(255), unique=True, nullable=False)
     role = Column(Enum(Roles), unique=False, nullable=True)
-    auth_tokens = relationship("ActiveTokens", back_populates="user")
+    auth_tokens = relationship("ActiveToken", back_populates="user")
 
     def __str__(self):
         return f"User, id: {self.id}, username: {self.username}"
@@ -100,7 +100,7 @@ def evaluate_email(self, key, value):
 
         return email
 
-    def add_token(self, token: ActiveTokens):
+    def add_token(self, token: ActiveToken):
         """
         Add the given token to the database, removing any expired tokens.
         """

lib/pbench/test/unit/server/conftest.py

@@ -20,7 +20,7 @@
 from pbench.server.api import create_app, get_server_config
 import pbench.server.auth.auth as Auth
 from pbench.server.database.database import Database
-from pbench.server.database.models.active_tokens import ActiveTokens
+from pbench.server.database.models.active_tokens import ActiveToken
 from pbench.server.database.models.datasets import Dataset, Metadata, States
 from pbench.server.database.models.template import Template
 from pbench.server.database.models.users import User
@@ -812,7 +812,7 @@ def generate_token(
             {"pbench-client": {"roles": pbench_client_roles}}
         )
     token_str = jwt.encode(payload, jwt_secret, algorithm="HS256")
-    token = ActiveTokens(token_str, exp)
+    token = ActiveToken(token_str, exp)
     user.add_token(token)
     return token_str
 

lib/pbench/test/unit/server/test_user_auth.py

@@ -3,7 +3,7 @@
 import time
 
 from pbench.server.database.database import Database
-from pbench.server.database.models.active_tokens import ActiveTokens
+from pbench.server.database.models.active_tokens import ActiveToken
 from pbench.server.database.models.users import User
 from pbench.test.unit.server.conftest import admin_username
 
@@ -211,7 +211,7 @@ def test_login_removes_expired_tokens(client, server_config):
             user = User.query(username="me")
             # Add 3 expired tokens, values are in "days" old
             for age in (1, 2, 4):
-                token = ActiveTokens(
+                token = ActiveToken(
                     f"token-that-is-{age:d}-days-old",
                     datetime.now(timezone.utc) - timedelta(days=age),
                 )
@@ -224,7 +224,7 @@ def test_login_removes_expired_tokens(client, server_config):
             assert response.status_code == HTTPStatus.OK
 
             for age in (1, 2, 4):
-                token = ActiveTokens.query(f"token-that-is-{age:d}-days-old")
+                token = ActiveToken.query(f"token-that-is-{age:d}-days-old")
                 assert token is None
 
     @staticmethod
@@ -421,7 +421,7 @@ def test_valid_logout(client, server_config):
             assert response.status_code == HTTPStatus.OK
             # Check if the token has been successfully removed from the database
             assert (
-                not Database.db_session.query(ActiveTokens)
+                not Database.db_session.query(ActiveToken)
                 .filter_by(token=data_login["auth_token"])
                 .first()
             )