Move conduct_call into a common test lib for all endpoints

endpoints/api/test/shared.py

@@ -1,58 +1,10 @@
-import datetime
+from endpoints.test.shared import conduct_call
-import json
-
-from contextlib import contextmanager
-from data import model
 from endpoints.api import api
 
-CSRF_TOKEN_KEY = '_csrf_token'
-CSRF_TOKEN = '123csrfforme'
-
-
-@contextmanager
-def client_with_identity(auth_username, client):
-  with client.session_transaction() as sess:
-    if auth_username and auth_username is not None:
-      loaded = model.user.get_user(auth_username)
-      sess['user_id'] = loaded.uuid
-      sess['login_time'] = datetime.datetime.now()
-      sess[CSRF_TOKEN_KEY] = CSRF_TOKEN
-    else:
-      sess['user_id'] = 'anonymous'
-
-  yield client
-
-  with client.session_transaction() as sess:
-    sess['user_id'] = None
-    sess['login_time'] = None
-    sess[CSRF_TOKEN_KEY] = None
-
-
-def add_csrf_param(params):
-  """ Returns a params dict with the CSRF parameter added. """
-  params = params or {}
-  params[CSRF_TOKEN_KEY] = CSRF_TOKEN
-  return params
-
-
 def conduct_api_call(client, resource, method, params, body=None, expected_code=200):
   """ Conducts an API call to the given resource via the given client, and ensures its returned
       status matches the code given.
 
       Returns the response.
   """
-  params = add_csrf_param(params)
+  return conduct_call(client, resource, api.url_for, method, params, body, expected_code)
-
-  final_url = api.url_for(resource, **params)
-
-  headers = {}
-  headers.update({"Content-Type": "application/json"})
-
-  if body is not None:
-    body = json.dumps(body)
-
-  rv = client.open(final_url, method=method, data=body, headers=headers)
-  msg = '%s %s: got %s expected: %s | %s' % (method, final_url, rv.status_code, expected_code,
-                                             rv.data)
-  assert rv.status_code == expected_code, msg
-  return rv

endpoints/api/test/test_disallow_for_apps.py

@@ -16,7 +16,8 @@ from endpoints.api.trigger import (BuildTriggerList, BuildTrigger, BuildTriggerS
                                    BuildTriggerActivate, BuildTriggerAnalyze, ActivateBuildTrigger,
                                    TriggerBuildList, BuildTriggerFieldValues, BuildTriggerSources,
                                    BuildTriggerSourceNamespaces)
-from endpoints.api.test.shared import client_with_identity, conduct_api_call
+from endpoints.api.test.shared import conduct_api_call
+from endpoints.test.shared import client_with_identity
 from test.fixtures import *
 
 BUILD_ARGS = {'build_uuid': '1234'}

endpoints/api/test/test_organization.py

@@ -2,8 +2,9 @@ import pytest
 
 from data import model
 from endpoints.api import api
-from endpoints.api.test.shared import client_with_identity, conduct_api_call
+from endpoints.api.test.shared import conduct_api_call
 from endpoints.api.organization import Organization
+from endpoints.test.shared import client_with_identity
 from test.fixtures import *
 
 @pytest.mark.parametrize('expiration, expected_code', [

endpoints/api/test/test_repository.py

@@ -2,8 +2,9 @@ import pytest
 
 from mock import patch, ANY, MagicMock
 
-from endpoints.api.test.shared import client_with_identity, conduct_api_call
+from endpoints.api.test.shared import conduct_api_call
 from endpoints.api.repository import RepositoryTrust, Repository
+from endpoints.test.shared import client_with_identity
 from features import FeatureNameValue
 
 from test.fixtures import *
@@ -52,8 +53,8 @@ def test_signing_disabled(client):
       params = {'repository': 'devtable/simple'}
       response = conduct_api_call(cl, Repository, 'GET', params).json
       assert not response['trust_enabled']
-      
+
-      
+
 def test_sni_support():
   import ssl
   assert ssl.HAS_SNI

endpoints/api/test/test_search.py

@@ -4,7 +4,8 @@ from playhouse.test_utils import assert_query_count
 
 from data.model import _basequery
 from endpoints.api.search import ConductRepositorySearch, ConductSearch
-from endpoints.api.test.shared import client_with_identity, conduct_api_call
+from endpoints.api.test.shared import conduct_api_call
+from endpoints.test.shared import client_with_identity
 from test.fixtures import *
 
 @pytest.mark.parametrize('query, expected_query_count', [

endpoints/api/test/test_security.py

@@ -4,12 +4,13 @@ from flask_principal import AnonymousIdentity
 from endpoints.api import api
 from endpoints.api.repositorynotification import RepositoryNotification
 from endpoints.api.team import OrganizationTeamSyncing
-from endpoints.api.test.shared import client_with_identity, conduct_api_call
+from endpoints.api.test.shared import conduct_api_call
 from endpoints.api.repository import RepositoryTrust
 from endpoints.api.signing import RepositorySignatures
 from endpoints.api.search import ConductRepositorySearch
 from endpoints.api.superuser import SuperUserRepositoryBuildLogs, SuperUserRepositoryBuildResource
 from endpoints.api.superuser import SuperUserRepositoryBuildStatus
+from endpoints.test.shared import client_with_identity
 
 from test.fixtures import *
 

endpoints/api/test/test_signing.py

@@ -3,8 +3,9 @@ import pytest
 from collections import Counter
 from mock import patch
 
-from endpoints.api.test.shared import client_with_identity, conduct_api_call
+from endpoints.api.test.shared import conduct_api_call
 from endpoints.api.signing import RepositorySignatures
+from endpoints.test.shared import client_with_identity
 
 from test.fixtures import *
 
@@ -14,21 +15,21 @@ VALID_TARGETS_MAP = {
         "latest": {
           "hashes": {
             "sha256": "2Q8GLEgX62VBWeL76axFuDj/Z1dd6Zhx0ZDM6kNwPkQ="
-          }, 
+          },
           "length": 2111
         }
-      }, 
+      },
       "expiration": "2020-05-22T10:26:46.618176424-04:00"
-    }, 
+    },
     "targets": {
       "targets": {
         "latest": {
           "hashes": {
             "sha256": "2Q8GLEgX62VBWeL76axFuDj/Z1dd6Zhx0ZDM6kNwPkQ="
-          }, 
+          },
           "length": 2111
         }
-      }, 
+      },
       "expiration": "2020-05-22T10:26:01.953414888-04:00"}
   }
 

endpoints/api/test/test_tag.py

@@ -2,8 +2,10 @@ import pytest
 
 from mock import patch, Mock
 
-from endpoints.api.test.shared import client_with_identity, conduct_api_call
+from endpoints.api.test.shared import conduct_api_call
 from endpoints.api.tag import RepositoryTag, RestoreTag
+from endpoints.test.shared import client_with_identity
+
 from features import FeatureNameValue
 
 from test.fixtures import *

endpoints/api/test/test_team.py

@@ -4,9 +4,11 @@ from mock import patch
 
 from data import model
 from endpoints.api import api
-from endpoints.api.test.shared import client_with_identity, conduct_api_call
+from endpoints.api.test.shared import conduct_api_call
 from endpoints.api.team import OrganizationTeamSyncing, TeamMemberList
 from endpoints.api.organization import Organization
+from endpoints.test.shared import client_with_identity
+
 from test.test_ldap import mock_ldap
 
 from test.fixtures import *

endpoints/appr/test/test_api_security.py

@@ -5,7 +5,7 @@ from flask import url_for
 
 from data import model
 from endpoints.appr.registry import appr_bp, blobs
-from endpoints.api.test.shared import client_with_identity
+from endpoints.test.shared import client_with_identity
 from test.fixtures import *
 
 BLOB_ARGS = {'digest': 'abcd1235'}

endpoints/test/shared.py

@@ -0,0 +1,55 @@
+import datetime
+import json
+
+from contextlib import contextmanager
+from data import model
+
+CSRF_TOKEN_KEY = '_csrf_token'
+CSRF_TOKEN = '123csrfforme'
+
+@contextmanager
+def client_with_identity(auth_username, client):
+  with client.session_transaction() as sess:
+    if auth_username and auth_username is not None:
+      loaded = model.user.get_user(auth_username)
+      sess['user_id'] = loaded.uuid
+      sess['login_time'] = datetime.datetime.now()
+      sess[CSRF_TOKEN_KEY] = CSRF_TOKEN
+    else:
+      sess['user_id'] = 'anonymous'
+
+  yield client
+
+  with client.session_transaction() as sess:
+    sess['user_id'] = None
+    sess['login_time'] = None
+    sess[CSRF_TOKEN_KEY] = None
+
+
+def add_csrf_param(params):
+  """ Returns a params dict with the CSRF parameter added. """
+  params = params or {}
+
+  if not CSRF_TOKEN_KEY in params:
+    params[CSRF_TOKEN_KEY] = CSRF_TOKEN
+
+  return params
+
+
+def conduct_call(client, resource, url_for, method, params, body=None, expected_code=200, headers=None):
+  """ Conducts a call to a Flask endpoint. """
+  params = add_csrf_param(params)
+
+  final_url = url_for(resource, **params)
+
+  headers = headers or {}
+  headers.update({"Content-Type": "application/json"})
+
+  if body is not None:
+    body = json.dumps(body)
+
+  rv = client.open(final_url, method=method, data=body, headers=headers)
+  msg = '%s %s: got %s expected: %s | %s' % (method, final_url, rv.status_code, expected_code,
+                                             rv.data)
+  assert rv.status_code == expected_code, msg
+  return rv