From 6ca7cf3cc6b879b46f2652dcdbb6c82cf22cc0e7 Mon Sep 17 00:00:00 2001
From: Arthur Hamon <arthur@lumapps.com>
Date: Sat, 13 Jul 2019 13:08:03 +0200
Subject: [PATCH] refactor boto3 integration test using fixtures instead of
 global variables

---
 tests/integration/test_boto3.py | 73 +++++++++++++++++----------------
 vcr/stubs/boto3_stubs.py        |  1 -
 2 files changed, 37 insertions(+), 37 deletions(-)

diff --git a/tests/integration/test_boto3.py b/tests/integration/test_boto3.py
index 1e418e7..74af71e 100644
--- a/tests/integration/test_boto3.py
+++ b/tests/integration/test_boto3.py
@@ -7,18 +7,6 @@ import boto3  # NOQA
 import botocore  # NOQA
 import vcr  # NOQA
 
-ses = boto3.Session(
-    aws_access_key_id=os.environ.get('AWS_ACCESS_KEY_ID', "default"),
-    aws_secret_access_key=os.environ.get('AWS_SECRET_ACCESS_KEY', "default"),
-    aws_session_token=None,
-    region_name=os.environ.get('AWS_DEFAULT_REGION', "default"),
-    # botocore_session=None,
-    # profile_name=None
-)
-
-IAM_CLIENT = ses.client('iam')
-IAM_USER_NAME = 'vcrpy'
-
 try:
     from botocore import awsrequest  # NOQA
 
@@ -26,7 +14,6 @@ try:
 except ImportError:
     botocore_awsrequest = False
 
-
 # skip tests if boto does not use vendored requests anymore
 # https://github.com/boto/botocore/pull/1495
 boto3_skip_vendored_requests = pytest.mark.skipif(
@@ -40,6 +27,33 @@ boto3_skip_awsrequest = pytest.mark.skipif(
         ver=botocore.__version__))
 
 
+IAM_USER_NAME = "vcrpy"
+
+
+@pytest.fixture
+def iam_client():
+    def _iam_client(boto3_session=None):
+        if boto3_session is None:
+            boto3_session = boto3.Session(
+                aws_access_key_id=os.environ.get('AWS_ACCESS_KEY_ID', "default"),
+                aws_secret_access_key=os.environ.get('AWS_SECRET_ACCESS_KEY', "default"),
+                aws_session_token=None,
+                region_name=os.environ.get('AWS_DEFAULT_REGION', "default"),
+            )
+        return boto3_session.client('iam')
+    return _iam_client
+
+
+@pytest.fixture
+def get_user(iam_client):
+    def _get_user(client=None, user_name=IAM_USER_NAME):
+        if client is None:
+            # Default client set with fixture `iam_client`
+            client = iam_client()
+        return client.get_user(UserName=user_name)
+    return _get_user
+
+
 @boto3_skip_vendored_requests
 def test_boto_vendored_stubs(tmpdir):
     with vcr.use_cassette(str(tmpdir.join('boto3-stubs.yml'))):
@@ -55,45 +69,32 @@ def test_boto_vendored_stubs(tmpdir):
         VerifiedHTTPSConnection('hostname.does.not.matter')
 
 
-@boto3_skip_awsrequest
-def test_boto3_awsrequest_stubs(tmpdir):
-    with vcr.use_cassette(str(tmpdir.join('boto3-stubs.yml'))):
-        from botocore.awsrequest import AWSHTTPConnection, AWSHTTPSConnection
-        from vcr.stubs.boto3_stubs import VCRRequestsHTTPConnection, VCRRequestsHTTPSConnection
-        assert issubclass(VCRRequestsHTTPConnection, AWSHTTPConnection)
-        assert issubclass(VCRRequestsHTTPSConnection, AWSHTTPSConnection)
-        AWSHTTPConnection('hostname.does.not.matter')
-        AWSHTTPSConnection('hostname.does.not.matter')
-
-
-def test_boto3_without_vcr():
-    response = IAM_CLIENT.get_user(UserName=IAM_USER_NAME)
-
+def test_boto3_without_vcr(get_user):
+    response = get_user()
     assert response['User']['UserName'] == IAM_USER_NAME
 
 
-def test_boto_medium_difficulty(tmpdir):
+def test_boto_medium_difficulty(tmpdir, get_user):
 
     with vcr.use_cassette(str(tmpdir.join('boto3-medium.yml'))):
-        response = IAM_CLIENT.get_user(UserName=IAM_USER_NAME)
+        response = get_user()
         assert response['User']['UserName'] == IAM_USER_NAME
 
     with vcr.use_cassette(str(tmpdir.join('boto3-medium.yml'))) as cass:
-        response = IAM_CLIENT.get_user(UserName=IAM_USER_NAME)
+        response = get_user()
         assert response['User']['UserName'] == IAM_USER_NAME
         assert cass.all_played
 
 
-def test_boto_hardcore_mode(tmpdir):
+def test_boto_hardcore_mode(tmpdir, iam_client, get_user):
     with vcr.use_cassette(str(tmpdir.join('boto3-hardcore.yml'))):
         ses = boto3.Session(
             aws_access_key_id=os.environ.get('AWS_ACCESS_KEY_ID'),
             aws_secret_access_key=os.environ.get('AWS_SECRET_ACCESS_KEY'),
             region_name=os.environ.get('AWS_DEFAULT_REGION'),
         )
-
-        iam_client = ses.client('iam')
-        response = iam_client.get_user(UserName=IAM_USER_NAME)
+        client = iam_client(ses)
+        response = get_user(client=client)
         assert response['User']['UserName'] == IAM_USER_NAME
 
     with vcr.use_cassette(str(tmpdir.join('boto3-hardcore.yml'))) as cass:
@@ -104,7 +105,7 @@ def test_boto_hardcore_mode(tmpdir):
             region_name=os.environ.get('AWS_DEFAULT_REGION'),
         )
 
-        iam_client = ses.client('iam')
-        response = iam_client.get_user(UserName=IAM_USER_NAME)
+        client = iam_client(ses)
+        response = get_user(client=client)
         assert response['User']['UserName'] == IAM_USER_NAME
         assert cass.all_played
diff --git a/vcr/stubs/boto3_stubs.py b/vcr/stubs/boto3_stubs.py
index d83fac2..73a455f 100644
--- a/vcr/stubs/boto3_stubs.py
+++ b/vcr/stubs/boto3_stubs.py
@@ -41,4 +41,3 @@ class VCRRequestsHTTPSConnection(VCRHTTPSConnection, VerifiedHTTPSConnection):
             self.real_connection.cert_reqs = kwargs.get("cert_reqs", 'CERT_NONE')
 
         self._sock = None
-