from unittest.mock import MagicMock, call, patch import pytest from prowler.lib.powershell.powershell import PowerShellSession from prowler.providers.m365.exceptions.exceptions import ( M365UserNotBelongingToTenantError, ) from prowler.providers.m365.lib.powershell.m365_powershell import M365PowerShell from prowler.providers.m365.models import M365Credentials class Testm365PowerShell: @patch("subprocess.Popen") def test_init(self, mock_popen): mock_process = MagicMock() mock_popen.return_value = mock_process credentials = M365Credentials(user="test@example.com", passwd="test_password") with patch.object(M365PowerShell, "init_credential") as mock_init_credential: session = M365PowerShell(credentials) mock_popen.assert_called_once() mock_init_credential.assert_called_once_with(credentials) assert session.process == mock_process assert session.END == "" session.close() @patch("subprocess.Popen") def test_sanitize(self, _): credentials = M365Credentials(user="test@example.com", passwd="test_password") session = M365PowerShell(credentials) test_cases = [ ("test@example.com", "test@example.com"), ("test@example.com!", "test@example.com"), ("test@example.com#", "test@example.com"), ("test@example.com$", "test@example.com"), ("test@example.com%", "test@example.com"), ("test@example.com^", "test@example.com"), ("test@example.com&", "test@example.com"), ("test@example.com*", "test@example.com"), ("test@example.com(", "test@example.com"), ("test@example.com)", "test@example.com"), ("test@example.com-", "test@example.com-"), ("test@example.com_", "test@example.com_"), ("test@example.com+", "test@example.com+"), ("test_;echo pwned;password", "test_echopwnedpassword"), ] for input_str, expected in test_cases: assert session.sanitize(input_str) == expected session.close() @patch("subprocess.Popen") def test_init_credential(self, mock_popen): mock_process = MagicMock() mock_popen.return_value = mock_process credentials = M365Credentials( user="test@example.com", passwd="test_password", client_id="test_client_id", client_secret="test_client_secret", tenant_id="test_tenant_id", ) session = M365PowerShell(credentials) session.execute = MagicMock() session.init_credential(credentials) session.execute.assert_any_call(f'$user = "{credentials.user}"') session.execute.assert_any_call( f'$secureString = "{credentials.passwd}" | ConvertTo-SecureString' ) session.execute.assert_any_call( "$credential = New-Object System.Management.Automation.PSCredential ($user, $secureString)" ) session.close() @patch("subprocess.Popen") @patch("msal.ConfidentialClientApplication") def test_test_credentials(self, mock_msal, mock_popen): mock_process = MagicMock() mock_popen.return_value = mock_process mock_msal_instance = MagicMock() mock_msal.return_value = mock_msal_instance mock_msal_instance.acquire_token_by_username_password.return_value = { "access_token": "test_token" } credentials = M365Credentials( user="test@contoso.onmicrosoft.com", passwd="test_password", client_id="test_client_id", client_secret="test_client_secret", tenant_id="test_tenant_id", provider_id="contoso.onmicrosoft.com", ) session = M365PowerShell(credentials) # Mock read_output to return the decrypted password session.read_output = MagicMock(return_value="decrypted_password") # Mock execute to return the result of read_output session.execute = MagicMock(side_effect=lambda _: session.read_output()) # Execute the test result = session.test_credentials(credentials) assert result is True # Verify execute was called with the correct commands session.execute.assert_any_call( f'$securePassword = "{credentials.passwd}" | ConvertTo-SecureString' ) session.execute.assert_any_call( f'$credential = New-Object System.Management.Automation.PSCredential("{credentials.user}", $securePassword)\n' ) session.execute.assert_any_call( 'Write-Output "$($credential.GetNetworkCredential().Password)"' ) # Verify MSAL was called with the correct parameters mock_msal.assert_called_once_with( client_id="test_client_id", client_credential="test_client_secret", authority="https://login.microsoftonline.com/test_tenant_id", ) mock_msal_instance.acquire_token_by_username_password.assert_called_once_with( username="test@contoso.onmicrosoft.com", password="decrypted_password", scopes=["https://graph.microsoft.com/.default"], ) session.close() @patch("subprocess.Popen") @patch("msal.ConfidentialClientApplication") def test_test_credentials_user_not_belonging_to_tenant(self, mock_msal, mock_popen): mock_process = MagicMock() mock_popen.return_value = mock_process mock_msal_instance = MagicMock() mock_msal.return_value = mock_msal_instance mock_msal_instance.acquire_token_by_username_password.return_value = { "access_token": "test_token" } credentials = M365Credentials( user="user@otherdomain.com", passwd="test_password", client_id="test_client_id", client_secret="test_client_secret", tenant_id="test_tenant_id", provider_id="contoso.onmicrosoft.com", ) session = M365PowerShell(credentials) # Mock the execute method to return the decrypted password def mock_execute(command, *args, **kwargs): if "Write-Output" in command: return "decrypted_password" return None session.execute = MagicMock(side_effect=mock_execute) session.process.stdin.write = MagicMock() session.read_output = MagicMock(return_value="decrypted_password") with pytest.raises(M365UserNotBelongingToTenantError) as exception: session.test_credentials(credentials) assert exception.type == M365UserNotBelongingToTenantError assert "The provided M365 User does not belong to the specified tenant." in str( exception.value ) mock_msal.assert_called_once_with( client_id="test_client_id", client_credential="test_client_secret", authority="https://login.microsoftonline.com/test_tenant_id", ) mock_msal_instance.acquire_token_by_username_password.assert_called_once_with( username="user@otherdomain.com", password="decrypted_password", scopes=["https://graph.microsoft.com/.default"], ) session.close() @patch("subprocess.Popen") @patch("msal.ConfidentialClientApplication") def test_test_credentials_auth_failure(self, mock_msal, mock_popen): mock_process = MagicMock() mock_popen.return_value = mock_process mock_msal_instance = MagicMock() mock_msal.return_value = mock_msal_instance mock_msal_instance.acquire_token_by_username_password.return_value = None credentials = M365Credentials( user="test@contoso.onmicrosoft.com", passwd="test_password", client_id="test_client_id", client_secret="test_client_secret", tenant_id="test_tenant_id", provider_id="contoso.onmicrosoft.com", ) session = M365PowerShell(credentials) # Mock the execute method to return the decrypted password def mock_execute(command, *args, **kwargs): if "Write-Output" in command: return "decrypted_password" return None session.execute = MagicMock(side_effect=mock_execute) session.process.stdin.write = MagicMock() session.read_output = MagicMock(return_value="decrypted_password") assert session.test_credentials(credentials) is False mock_msal.assert_called_once_with( client_id="test_client_id", client_credential="test_client_secret", authority="https://login.microsoftonline.com/test_tenant_id", ) mock_msal_instance.acquire_token_by_username_password.assert_called_once_with( username="test@contoso.onmicrosoft.com", password="decrypted_password", scopes=["https://graph.microsoft.com/.default"], ) session.close() @patch("subprocess.Popen") def test_remove_ansi(self, mock_popen): credentials = M365Credentials(user="test@example.com", passwd="test_password") session = M365PowerShell(credentials) test_cases = [ ("\x1b[32mSuccess\x1b[0m", "Success"), ("\x1b[31mError\x1b[0m", "Error"), ("\x1b[33mWarning\x1b[0m", "Warning"), ("Normal text", "Normal text"), ("\x1b[1mBold\x1b[0m", "Bold"), ] for input_str, expected in test_cases: assert session.remove_ansi(input_str) == expected session.close() @patch("subprocess.Popen") def test_execute(self, mock_popen): mock_process = MagicMock() mock_popen.return_value = mock_process credentials = M365Credentials(user="test@example.com", passwd="test_password") session = M365PowerShell(credentials) command = "Get-Command" expected_output = {"Name": "Get-Command"} with patch.object(session, "execute", return_value=expected_output): result = session.execute(command) assert result == expected_output session.close() @patch("subprocess.Popen") def test_read_output(self, mock_popen): """Test the read_output method with various scenarios: - Normal stdout output - Error in stderr - Timeout in stdout - Empty output - Empty queue handling """ # Setup mock_process = MagicMock() mock_popen.return_value = mock_process credentials = M365Credentials(user="test@example.com", passwd="test_password") session = M365PowerShell(credentials) # Test 1: Normal stdout output mock_process.stdout.readline.side_effect = [ "test@example.com\n", f"{session.END}\n", ] mock_process.stderr.readline.return_value = f"Write-Error: {session.END}\n" with patch.object(session, "remove_ansi", side_effect=lambda x: x): result = session.read_output() assert result == "test@example.com" # Test 2: Error in stderr mock_process.stdout.readline.side_effect = ["\n", f"{session.END}\n"] mock_process.stderr.readline.side_effect = [ "Write-Error: Authentication failed\n", f"Write-Error: {session.END}\n", ] with patch.object(session, "remove_ansi", side_effect=lambda x: x): with patch("prowler.lib.logger.logger.error") as mock_error: result = session.read_output() assert result == "" mock_error.assert_called_once_with( "PowerShell error output: Write-Error: Authentication failed" ) # Test 3: Timeout in stdout mock_process.stdout.readline.side_effect = ["test output\n"] # No END marker mock_process.stderr.readline.return_value = f"Write-Error: {session.END}\n" result = session.read_output(timeout=0.1, default="timeout") assert result == "timeout" # Test 4: Empty output mock_process.stdout.readline.side_effect = [f"{session.END}\n"] mock_process.stderr.readline.return_value = f"Write-Error: {session.END}\n" result = session.read_output() assert result == "" # Test 5: Empty queue handling mock_process.stdout.readline.side_effect = [] # No output at all mock_process.stderr.readline.return_value = f"Write-Error: {session.END}\n" result = session.read_output(timeout=0.1, default="empty_queue") assert result == "empty_queue" # Test 6: Empty error queue handling mock_process.stdout.readline.side_effect = ["test output\n", f"{session.END}\n"] mock_process.stderr.readline.side_effect = [] # No error output with patch("prowler.lib.logger.logger.error") as mock_error: result = session.read_output() assert result == "test output" mock_error.assert_not_called() # Test 7: Both queues empty mock_process.stdout.readline.side_effect = [] # No output mock_process.stderr.readline.side_effect = [] # No error output result = session.read_output(timeout=0.1, default="both_empty") assert result == "both_empty" session.close() @patch("subprocess.Popen") def test_read_output_queue_empty(self, mock_popen): """Test read_output when both queues are empty""" mock_process = MagicMock() mock_popen.return_value = mock_process credentials = M365Credentials(user="test@example.com", passwd="test_password") session = M365PowerShell(credentials) # Mock process to return empty queues mock_process.stdout.readline.side_effect = [] # No output mock_process.stderr.readline.side_effect = [] # No error output # Test with default value result = session.read_output(timeout=0.1, default="empty_queue") assert result == "empty_queue" # Test without default value result = session.read_output(timeout=0.1) assert result == "" session.close() @patch("subprocess.Popen") def test_read_output_error_queue_empty(self, mock_popen): """Test read_output when error queue is empty but stdout has content""" mock_process = MagicMock() mock_popen.return_value = mock_process credentials = M365Credentials(user="test@example.com", passwd="test_password") session = M365PowerShell(credentials) # Mock process to return content in stdout but empty stderr mock_process.stdout.readline.side_effect = ["test output\n", f"{session.END}\n"] mock_process.stderr.readline.side_effect = [] # No error output with patch("prowler.lib.logger.logger.error") as mock_error: result = session.read_output() assert result == "test output" mock_error.assert_not_called() session.close() @patch("subprocess.Popen") def test_read_output_result_queue_empty(self, mock_popen): """Test read_output when result queue is empty but stderr has content""" mock_process = MagicMock() mock_popen.return_value = mock_process credentials = M365Credentials(user="test@example.com", passwd="test_password") session = M365PowerShell(credentials) # Mock process to return empty stdout but content in stderr mock_process.stdout.readline.side_effect = [] # No output mock_process.stderr.readline.side_effect = [ "Error message\n", f"Write-Error: {session.END}\n", ] with patch("prowler.lib.logger.logger.error") as mock_error: result = session.read_output(timeout=0.1, default="default") assert result == "default" mock_error.assert_called_once_with("PowerShell error output: Error message") session.close() @patch("subprocess.Popen") def test_json_parse_output(self, mock_popen): mock_process = MagicMock() mock_popen.return_value = mock_process credentials = M365Credentials(user="test@example.com", passwd="test_password") session = M365PowerShell(credentials) test_cases = [ ('{"key": "value"}', {"key": "value"}), ('[{"key": "value"}]', [{"key": "value"}]), ( '[{"key": "value"},{"key": "value"}]', [{"key": "value"}, {"key": "value"}], ), ("[{}]", [{}]), ("[{},{}]", [{}, {}]), ("not json", {}), ("", {}), ] for input_str, expected in test_cases: result = session.json_parse_output(input_str) assert result == expected session.close() @patch("subprocess.Popen") def test_close(self, mock_popen): mock_process = MagicMock() mock_popen.return_value = mock_process credentials = M365Credentials(user="test@example.com", passwd="test_password") session = M365PowerShell(credentials) session.close() mock_process.stdin.flush.assert_called_once() mock_process.terminate.assert_called_once() @patch("subprocess.Popen") def test_initialize_m365_powershell_modules_success(self, mock_popen): """Test initialize_m365_powershell_modules when all modules are successfully initialized""" mock_process = MagicMock() mock_popen.return_value = mock_process # Mock the execute method to simulate successful module installation def mock_execute(command, *args, **kwargs): if "Get-Module" in command: return None # Module not installed elif "Install-Module" in command: return None # Installation successful elif "Import-Module" in command: return None # Import successful return None with ( patch.object( PowerShellSession, "execute", side_effect=mock_execute ) as mock_execute_obj, patch("prowler.lib.logger.logger.info") as mock_info, ): from prowler.providers.m365.lib.powershell.m365_powershell import ( initialize_m365_powershell_modules, ) result = initialize_m365_powershell_modules() # Verify successful initialization assert result is True # Verify that execute was called for each module assert mock_execute_obj.call_count == 6 # 2 modules * 3 commands each # Verify success messages were logged mock_info.assert_any_call( "Successfully installed module ExchangeOnlineManagement" ) mock_info.assert_any_call("Successfully installed module MicrosoftTeams") @patch("subprocess.Popen") def test_initialize_m365_powershell_modules_failure(self, mock_popen): """Test initialize_m365_powershell_modules when module initialization fails""" mock_process = MagicMock() mock_popen.return_value = mock_process # Mock the execute method to simulate installation failure def mock_execute(command, *args, **kwargs): if "Get-Module" in command: return None # Module not installed elif "Install-Module" in command: raise Exception("Installation failed") return None with ( patch.object( PowerShellSession, "execute", side_effect=mock_execute ) as mock_execute_obj, patch("prowler.lib.logger.logger.error") as mock_error, ): from prowler.providers.m365.lib.powershell.m365_powershell import ( initialize_m365_powershell_modules, ) result = initialize_m365_powershell_modules() # Verify failed initialization assert result is False # Verify that execute was called at least twice assert mock_execute_obj.call_count >= 2 # Verify error was logged mock_error.assert_called_with( "Failed to initialize module ExchangeOnlineManagement: Installation failed" ) @patch("subprocess.Popen") def test_main_success(self, mock_popen): """Test main() function when module initialization is successful""" mock_process = MagicMock() mock_popen.return_value = mock_process # Mock the execute method to simulate successful module installation def mock_execute(command, *args, **kwargs): if "Get-Module" in command: return None # Module not installed elif "Install-Module" in command: return None # Installation successful elif "Import-Module" in command: return None # Import successful return None with ( patch.object(PowerShellSession, "execute", side_effect=mock_execute), patch("prowler.lib.logger.logger.info") as mock_info, patch("prowler.lib.logger.logger.error") as mock_error, ): from prowler.providers.m365.lib.powershell.m365_powershell import main main() # Verify all info messages were logged in the correct order assert mock_info.call_count == 3 mock_info.assert_has_calls( [ call("Successfully installed module ExchangeOnlineManagement"), call("Successfully installed module MicrosoftTeams"), call("M365 PowerShell modules initialized successfully"), ] ) # Verify no error was logged mock_error.assert_not_called() @patch("subprocess.Popen") def test_main_failure(self, mock_popen): """Test main() function when module initialization fails""" mock_process = MagicMock() mock_popen.return_value = mock_process # Mock the execute method to simulate installation failure def mock_execute(command, *args, **kwargs): if "Get-Module" in command: return None # Module not installed elif "Install-Module" in command: raise Exception("Installation failed") return None with ( patch.object(PowerShellSession, "execute", side_effect=mock_execute), patch("prowler.lib.logger.logger.info") as mock_info, patch("prowler.lib.logger.logger.error") as mock_error, ): from prowler.providers.m365.lib.powershell.m365_powershell import main main() # Verify all error messages were logged in the correct order assert mock_error.call_count == 2 mock_error.assert_has_calls( [ call( "Failed to initialize module ExchangeOnlineManagement: Installation failed" ), call("Failed to initialize M365 PowerShell modules"), ] ) # Verify no info messages were logged mock_info.assert_not_called()