Use temp profile context when executing integration tests (#206)

Author: Juliya Smith

tests/cmds/conftest.py

@@ -35,7 +35,7 @@ def sdk(mocker):
     return mocker.MagicMock(spec=SDKClient)
 
 
-@pytest.fixture()
+@pytest.fixture
 def mock_42(mocker):
     return mocker.patch("py42.sdk.from_local_account")
 

tests/integration/__init__.py

@@ -1,36 +0,0 @@
-import os
-
-import pexpect
-
-
-LINE_FEED = b"\r\n"
-PASSWORD_PROMPT = b"Password: "
-ENCODING_TYPE = "utf-8"
-
-
-def encode_response(line, encoding_type=ENCODING_TYPE):
-    return line.decode(encoding_type)
-
-
-def run_command(command):
-
-    process = pexpect.spawn(command)
-    response = []
-    try:
-        expected = process.expect([PASSWORD_PROMPT, pexpect.EOF])
-        if expected == 0:
-            process.sendline(os.environ["C42_PW"])
-            process.expect(LINE_FEED)
-            output = process.readlines()
-            response = [encode_response(line) for line in output]
-        else:
-            output = process.before
-            response = encode_response(output).splitlines()
-    except pexpect.TIMEOUT:
-        process.close()
-        return process.exitstatus, response
-    process.close()
-    return process.exitstatus, response
-
-
-__all__ = [run_command]

tests/integration/conftest.py

@@ -0,0 +1,70 @@
+import os
+from contextlib import contextmanager
+
+import pexpect
+import pytest
+
+from code42cli.errors import Code42CLIError
+from code42cli.profile import create_profile
+from code42cli.profile import delete_profile
+from code42cli.profile import get_profile
+from code42cli.profile import switch_default_profile
+
+TEST_PROFILE_NAME = "TEMP-INTEGRATION-TEST"
+_LINE_FEED = b"\r\n"
+_PASSWORD_PROMPT = b"Password: "
+_ENCODING_TYPE = "utf-8"
+
+
+@contextmanager
+def use_temp_profile():
+    """Creates a temporary profile to use for executing integration tests."""
+    host = os.environ.get("C42_HOST") or "http://127.0.0.1:4200"
+    username = os.environ.get("C42_USER") or "test_username@example.com"
+    password = os.environ.get("C42_PW") or "test_password"
+    current_profile_name = _get_current_profile_name()
+    create_profile(TEST_PROFILE_NAME, host, username, True)
+    switch_default_profile(TEST_PROFILE_NAME)
+    yield password
+    delete_profile(TEST_PROFILE_NAME)
+
+    # Switch back to the original profile if there was one
+    if current_profile_name:
+        switch_default_profile(current_profile_name)
+
+
+def _get_current_profile_name():
+    try:
+        profile = get_profile()
+        return profile.name
+    except Code42CLIError:
+        return None
+
+
+@pytest.fixture
+def command_runner():
+    def run_command(command):
+        with use_temp_profile() as pw:
+            process = pexpect.spawn(command)
+            response = []
+            try:
+                expected = process.expect([_PASSWORD_PROMPT, pexpect.EOF])
+                if expected == 0:
+                    process.sendline(pw)
+                    process.expect(_LINE_FEED)
+                    output = process.readlines()
+                    response = [_encode_response(line) for line in output]
+                else:
+                    output = process.before
+                    response = _encode_response(output).splitlines()
+            except pexpect.TIMEOUT:
+                process.close()
+                return process.exitstatus, response
+            process.close()
+            return process.exitstatus, response
+
+    return run_command
+
+
+def _encode_response(line, encoding_type=_ENCODING_TYPE):
+    return line.decode(encoding_type)

tests/integration/test_alert_rules.py

@@ -1,5 +1,4 @@
 import pytest
-from tests.integration import run_command
 
 ALERT_RULES_COMMAND = "code42 alert-rules"
 
@@ -20,6 +19,6 @@
         "{} list --format RAW-JSON".format(ALERT_RULES_COMMAND),
     ],
 )
-def test_alert_rules_command_returns_success_return_code(command):
-    return_code, response = run_command(command)
+def test_alert_rules_command_returns_success_return_code(command, command_runner):
+    return_code, response = command_runner(command)
     assert return_code == 0

tests/integration/test_alerts.py

@@ -2,15 +2,16 @@
 from datetime import timedelta
 
 import pytest
-from tests.integration import run_command
 
 
 begin_date = datetime.utcnow() - timedelta(days=20)
 end_date = datetime.utcnow() - timedelta(days=10)
 begin_date_str = begin_date.strftime("%Y-%m-%d")
 end_date_str = end_date.strftime("%Y-%m-%d")
 
-ALERT_COMMAND = "code42 alerts search -b {} -e {}".format(begin_date_str, end_date_str)
+ALERT_SEARCH_COMMAND = "code42 alerts search -b {} -e {}".format(
+    begin_date_str, end_date_str
+)
 ADVANCED_QUERY = """{"groupClause":"AND", "groups":[{"filterClause":"AND",
 "filters":[{"operator":"ON_OR_AFTER", "term":"eventTimestamp", "value":"2020-09-13T00:00:00.000Z"},
 {"operator":"ON_OR_BEFORE", "term":"eventTimestamp", "value":"2020-12-07T13:20:15.195Z"}]}],
@@ -25,25 +26,27 @@
 @pytest.mark.parametrize(
     "command",
     [
-        ALERT_COMMAND,
-        "{} --state OPEN".format(ALERT_COMMAND),
-        "{} --state RESOLVED".format(ALERT_COMMAND),
-        "{} --actor user@code42.com".format(ALERT_COMMAND),
-        "{} --rule-name 'File Upload Alert'".format(ALERT_COMMAND),
-        "{} --rule-id 962a6a1c-54f6-4477-90bd-a08cc74cbf71".format(ALERT_COMMAND),
-        "{} --rule-type FedEndpointExfiltration".format(ALERT_COMMAND),
-        "{} --description 'Alert on any file upload'".format(ALERT_COMMAND),
-        "{} --exclude-rule-type 'FedEndpointExfiltration'".format(ALERT_COMMAND),
+        ALERT_SEARCH_COMMAND,
+        "{} --state OPEN".format(ALERT_SEARCH_COMMAND),
+        "{} --state RESOLVED".format(ALERT_SEARCH_COMMAND),
+        "{} --actor user@code42.com".format(ALERT_SEARCH_COMMAND),
+        "{} --rule-name 'File Upload Alert'".format(ALERT_SEARCH_COMMAND),
+        "{} --rule-id 962a6a1c-54f6-4477-90bd-a08cc74cbf71".format(
+            ALERT_SEARCH_COMMAND
+        ),
+        "{} --rule-type FedEndpointExfiltration".format(ALERT_SEARCH_COMMAND),
+        "{} --description 'Alert on any file upload'".format(ALERT_SEARCH_COMMAND),
+        "{} --exclude-rule-type 'FedEndpointExfiltration'".format(ALERT_SEARCH_COMMAND),
         "{} --exclude-rule-id '962a6a1c-54f6-4477-90bd-a08cc74cbf71'".format(
-            ALERT_COMMAND
+            ALERT_SEARCH_COMMAND
         ),
-        "{} --exclude-rule-name 'File Upload Alert'".format(ALERT_COMMAND),
-        "{} --exclude-actor-contains 'user@code42.com'".format(ALERT_COMMAND),
-        "{} --exclude-actor 'user@code42.com'".format(ALERT_COMMAND),
-        "{} --actor-contains 'user@code42.com'".format(ALERT_COMMAND),
+        "{} --exclude-rule-name 'File Upload Alert'".format(ALERT_SEARCH_COMMAND),
+        "{} --exclude-actor-contains 'user@code42.com'".format(ALERT_SEARCH_COMMAND),
+        "{} --exclude-actor 'user@code42.com'".format(ALERT_SEARCH_COMMAND),
+        "{} --actor-contains 'user@code42.com'".format(ALERT_SEARCH_COMMAND),
         ALERT_ADVANCED_QUERY_COMMAND,
     ],
 )
-def test_alert_command_returns_success_return_code(command):
-    return_code, response = run_command(command)
+def test_alert_command_returns_success_return_code(command, command_runner):
+    return_code, response = command_runner(command)
     assert return_code == 0

tests/integration/test_auditlogs.py

@@ -2,7 +2,6 @@
 from datetime import timedelta
 
 import pytest
-from tests.integration import run_command
 
 SEARCH_COMMAND = "code42 audit-logs search"
 BASE_COMMAND = "{} -b".format(SEARCH_COMMAND)
@@ -42,6 +41,6 @@
         ("{} '{}' --debug".format(BASE_COMMAND, begin_date_str)),
     ],
 )
-def test_auditlogs_search_command_returns_success_return_code(command):
-    return_code, response = run_command(command)
+def test_auditlogs_search_command_returns_success_return_code(command, command_runner):
+    return_code, response = command_runner(command)
     assert return_code == 0

tests/integration/test_legal_hold.py

@@ -1,5 +1,4 @@
 import pytest
-from tests.integration import run_command
 
 LEGAL_HOLD_COMMAND = "code42 legal-hold"
 
@@ -20,6 +19,6 @@
         "{} list --format RAW-JSON".format(LEGAL_HOLD_COMMAND),
     ],
 )
-def test_alert_rules_command_returns_success_return_code(command):
-    return_code, response = run_command(command)
+def test_alert_rules_command_returns_success_return_code(command, command_runner):
+    return_code, response = command_runner(command)
     assert return_code == 0