recce-nightly 1.10.0.20250629__py3-none-any.whl → 1.25.0.20251112a2066__py3-none-any.whl

tests/recce_cloud/test_cli.py

@@ -0,0 +1,372 @@
+"""
+Integration tests for recce-cloud CLI commands.
+"""
+
+import os
+import tempfile
+import unittest
+from pathlib import Path
+from unittest.mock import patch
+
+from click.testing import CliRunner
+
+from recce_cloud.cli import cloud_cli
+
+
+class TestUploadDryRun(unittest.TestCase):
+    """Test cases for the --dry-run flag in upload command."""
+
+    def setUp(self):
+        """Set up test fixtures."""
+        self.runner = CliRunner()
+        self.temp_dir = tempfile.mkdtemp()
+
+        # Create mock dbt artifacts
+        manifest_path = Path(self.temp_dir) / "manifest.json"
+        catalog_path = Path(self.temp_dir) / "catalog.json"
+
+        manifest_content = {
+            "metadata": {"adapter_type": "postgres"},
+            "nodes": {},
+        }
+
+        catalog_content = {
+            "nodes": {},
+        }
+
+        import json
+
+        with open(manifest_path, "w") as f:
+            json.dump(manifest_content, f)
+
+        with open(catalog_path, "w") as f:
+            json.dump(catalog_content, f)
+
+    def tearDown(self):
+        """Clean up test fixtures."""
+        import shutil
+
+        if os.path.exists(self.temp_dir):
+            shutil.rmtree(self.temp_dir)
+
+    def test_dry_run_github_actions_pr_context(self):
+        """Test dry-run with GitHub Actions PR context."""
+        env = {
+            "GITHUB_ACTIONS": "true",
+            "GITHUB_REPOSITORY": "DataRecce/recce",
+            "GITHUB_EVENT_NAME": "pull_request",
+            "GITHUB_SHA": "abc123def456",
+            "GITHUB_HEAD_REF": "feature/test-branch",
+            "GITHUB_BASE_REF": "main",
+            "RECCE_API_TOKEN": "test_token_123",
+        }
+
+        # Create mock event file
+        event_file = Path(self.temp_dir) / "github_event.json"
+        import json
+
+        with open(event_file, "w") as f:
+            json.dump({"pull_request": {"number": 42}}, f)
+
+        env["GITHUB_EVENT_PATH"] = str(event_file)
+
+        with patch.dict(os.environ, env, clear=True):
+            result = self.runner.invoke(
+                cloud_cli,
+                ["upload", "--target-path", self.temp_dir, "--dry-run"],
+            )
+
+        # Assertions
+        self.assertEqual(result.exit_code, 0, f"Command failed: {result.output}")
+        self.assertIn("Dry run mode enabled", result.output)
+        self.assertIn("Platform Information:", result.output)
+        self.assertIn("Platform: github-actions", result.output)
+        self.assertIn("Repository: DataRecce/recce", result.output)
+        self.assertIn("CR Number: 42", result.output)
+        self.assertIn("Commit SHA: abc123de", result.output)
+        self.assertIn("Source Branch: feature/test-branch", result.output)
+        self.assertIn("Base Branch: main", result.output)
+        self.assertIn("Upload Workflow:", result.output)
+        self.assertIn("Auto-create session and upload", result.output)
+        self.assertIn("Platform-specific APIs will be used", result.output)
+        self.assertIn("Files to upload:", result.output)
+        self.assertIn("manifest.json:", result.output)
+        self.assertIn("catalog.json:", result.output)
+        self.assertIn("Adapter type: postgres", result.output)
+        self.assertIn("Dry run completed successfully", result.output)
+
+    def test_dry_run_gitlab_ci_mr_context(self):
+        """Test dry-run with GitLab CI MR context."""
+        env = {
+            "GITLAB_CI": "true",
+            "CI_PROJECT_PATH": "recce/jaffle-shop",
+            "CI_PROJECT_URL": "https://gitlab.com/recce/jaffle-shop",
+            "CI_MERGE_REQUEST_IID": "5",
+            "CI_MERGE_REQUEST_SOURCE_BRANCH_NAME": "feature/new-models",
+            "CI_MERGE_REQUEST_TARGET_BRANCH_NAME": "main",
+            "CI_COMMIT_SHA": "def456abc789",
+            "CI_SERVER_URL": "https://gitlab.com",
+            "RECCE_API_TOKEN": "test_token_abc",
+        }
+
+        with patch.dict(os.environ, env, clear=True):
+            result = self.runner.invoke(
+                cloud_cli,
+                ["upload", "--target-path", self.temp_dir, "--dry-run"],
+            )
+
+        # Assertions
+        self.assertEqual(result.exit_code, 0, f"Command failed: {result.output}")
+        self.assertIn("Dry run mode enabled", result.output)
+        self.assertIn("Platform Information:", result.output)
+        self.assertIn("Platform: gitlab-ci", result.output)
+        self.assertIn("Repository: recce/jaffle-shop", result.output)
+        self.assertIn("CR Number: 5", result.output)
+        self.assertIn("Commit SHA: def456ab", result.output)
+        self.assertIn("Source Branch: feature/new-models", result.output)
+        self.assertIn("Base Branch: main", result.output)
+        self.assertIn("Auto-create session and upload", result.output)
+        self.assertIn("Platform-specific APIs will be used", result.output)
+        self.assertIn("Adapter type: postgres", result.output)
+
+    def test_dry_run_gitlab_ci_self_hosted(self):
+        """Test dry-run with self-hosted GitLab instance."""
+        env = {
+            "GITLAB_CI": "true",
+            "CI_PROJECT_PATH": "data-team/dbt-project",
+            "CI_PROJECT_URL": "https://gitlab.mycompany.com/data-team/dbt-project",
+            "CI_MERGE_REQUEST_IID": "25",
+            "CI_MERGE_REQUEST_SOURCE_BRANCH_NAME": "develop",
+            "CI_MERGE_REQUEST_TARGET_BRANCH_NAME": "production",
+            "CI_COMMIT_SHA": "fedcba987654",
+            "CI_SERVER_URL": "https://gitlab.mycompany.com",
+            "RECCE_API_TOKEN": "test_token_xyz",
+        }
+
+        with patch.dict(os.environ, env, clear=True):
+            result = self.runner.invoke(
+                cloud_cli,
+                ["upload", "--target-path", self.temp_dir, "--dry-run"],
+            )
+
+        # Assertions
+        self.assertEqual(result.exit_code, 0, f"Command failed: {result.output}")
+        self.assertIn("Platform: gitlab-ci", result.output)
+        self.assertIn("Repository: data-team/dbt-project", result.output)
+        self.assertIn("CR Number: 25", result.output)
+        self.assertIn("Source Branch: develop", result.output)
+        self.assertIn("Base Branch: production", result.output)
+
+    def test_dry_run_with_session_id(self):
+        """Test dry-run with existing session ID (generic workflow)."""
+        env = {
+            "GITHUB_ACTIONS": "true",
+            "GITHUB_REPOSITORY": "DataRecce/recce",
+            "RECCE_API_TOKEN": "test_token_789",
+        }
+
+        with patch.dict(os.environ, env, clear=True):
+            result = self.runner.invoke(
+                cloud_cli,
+                [
+                    "upload",
+                    "--target-path",
+                    self.temp_dir,
+                    "--session-id",
+                    "sess_abc123xyz",
+                    "--dry-run",
+                ],
+            )
+
+        # Assertions
+        self.assertEqual(result.exit_code, 0, f"Command failed: {result.output}")
+        self.assertIn("Dry run mode enabled", result.output)
+        self.assertIn("Upload Workflow:", result.output)
+        self.assertIn("Upload to existing session", result.output)
+        self.assertIn("Session ID: sess_abc123xyz", result.output)
+        self.assertNotIn("Auto-create session", result.output)
+
+    def test_dry_run_github_main_branch(self):
+        """Test dry-run with GitHub Actions main branch (no PR)."""
+        env = {
+            "GITHUB_ACTIONS": "true",
+            "GITHUB_REPOSITORY": "DataRecce/recce",
+            "GITHUB_EVENT_NAME": "push",
+            "GITHUB_REF": "refs/heads/main",
+            "GITHUB_SHA": "xyz789abc123",
+            "RECCE_API_TOKEN": "test_token_456",
+        }
+
+        with patch.dict(os.environ, env, clear=True):
+            result = self.runner.invoke(
+                cloud_cli,
+                ["upload", "--target-path", self.temp_dir, "--dry-run"],
+            )
+
+        # Assertions
+        self.assertEqual(result.exit_code, 0, f"Command failed: {result.output}")
+        self.assertIn("Platform: github-actions", result.output)
+        self.assertIn("Repository: DataRecce/recce", result.output)
+        self.assertIn("Commit SHA: xyz789ab", result.output)
+        # Session type depends on git branch detection, could be prod or dev
+        self.assertIn("Session Type:", result.output)
+        # Should not have CR number
+        self.assertNotIn("CR Number:", result.output)
+
+    def test_dry_run_gitlab_main_branch(self):
+        """Test dry-run with GitLab CI main branch (no MR)."""
+        env = {
+            "GITLAB_CI": "true",
+            "CI_PROJECT_PATH": "recce/analytics",
+            "CI_PROJECT_URL": "https://gitlab.com/recce/analytics",
+            "CI_COMMIT_BRANCH": "main",
+            "CI_COMMIT_SHA": "123abc456def",
+            "CI_SERVER_URL": "https://gitlab.com",
+            "RECCE_API_TOKEN": "test_token_main",
+        }
+
+        with patch.dict(os.environ, env, clear=True):
+            result = self.runner.invoke(
+                cloud_cli,
+                ["upload", "--target-path", self.temp_dir, "--dry-run"],
+            )
+
+        # Assertions
+        self.assertEqual(result.exit_code, 0, f"Command failed: {result.output}")
+        self.assertIn("Platform: gitlab-ci", result.output)
+        self.assertIn("Repository: recce/analytics", result.output)
+        # Session type depends on git branch detection, could be prod or dev
+        self.assertIn("Session Type:", result.output)
+        # Should not have CR number
+        self.assertNotIn("CR Number:", result.output)
+
+    def test_dry_run_with_manual_overrides(self):
+        """Test dry-run with manual overrides."""
+        env = {
+            "GITHUB_ACTIONS": "true",
+            "GITHUB_REPOSITORY": "DataRecce/recce",
+            "GITHUB_EVENT_NAME": "pull_request",
+            "GITHUB_SHA": "abc123",
+            "RECCE_API_TOKEN": "test_token",
+        }
+
+        # Create mock event file with PR number 42
+        event_file = Path(self.temp_dir) / "github_event.json"
+        import json
+
+        with open(event_file, "w") as f:
+            json.dump({"pull_request": {"number": 42}}, f)
+
+        env["GITHUB_EVENT_PATH"] = str(event_file)
+
+        with patch.dict(os.environ, env, clear=True):
+            result = self.runner.invoke(
+                cloud_cli,
+                [
+                    "upload",
+                    "--target-path",
+                    self.temp_dir,
+                    "--cr",
+                    "100",
+                    "--type",
+                    "cr",
+                    "--dry-run",
+                ],
+            )
+
+        # Assertions
+        self.assertEqual(result.exit_code, 0, f"Command failed: {result.output}")
+        # Should show overridden CR number
+        self.assertIn("CR Number: 100", result.output)
+        self.assertIn("Session Type: cr", result.output)
+
+    def test_dry_run_no_ci_environment(self):
+        """Test dry-run without CI environment (local development)."""
+        env = {
+            "RECCE_API_TOKEN": "test_token_local",
+        }
+
+        with patch.dict(os.environ, env, clear=True):
+            result = self.runner.invoke(
+                cloud_cli,
+                [
+                    "upload",
+                    "--target-path",
+                    self.temp_dir,
+                    "--session-id",
+                    "sess_local123",
+                    "--dry-run",
+                ],
+            )
+
+        # Assertions
+        self.assertEqual(result.exit_code, 0, f"Command failed: {result.output}")
+        self.assertIn("Dry run mode enabled", result.output)
+        self.assertIn("Upload to existing session", result.output)
+        self.assertIn("Session ID: sess_local123", result.output)
+        # Should not show platform information
+        self.assertNotIn("Platform Information:", result.output)
+
+    def test_dry_run_unsupported_platform_without_session_id(self):
+        """Test dry-run with unsupported platform and no session ID."""
+        env = {
+            "RECCE_API_TOKEN": "test_token",
+        }
+
+        with patch.dict(os.environ, env, clear=True):
+            result = self.runner.invoke(
+                cloud_cli,
+                ["upload", "--target-path", self.temp_dir, "--dry-run"],
+            )
+
+        # Assertions
+        self.assertEqual(result.exit_code, 0, f"Command failed: {result.output}")
+        self.assertIn("Dry run mode enabled", result.output)
+        self.assertIn("Auto-create session and upload", result.output)
+        self.assertIn("Warning: Platform not supported for auto-session creation", result.output)
+
+    def test_dry_run_missing_artifacts(self):
+        """Test dry-run with missing dbt artifacts."""
+        import shutil
+
+        shutil.rmtree(self.temp_dir)
+
+        env = {
+            "GITHUB_ACTIONS": "true",
+            "RECCE_API_TOKEN": "test_token",
+        }
+
+        with patch.dict(os.environ, env, clear=True):
+            result = self.runner.invoke(
+                cloud_cli,
+                ["upload", "--target-path", self.temp_dir, "--dry-run"],
+            )
+
+        # Assertions
+        # Should fail before dry-run validation happens
+        self.assertNotEqual(result.exit_code, 0)
+        self.assertIn("does not exist", result.output)
+
+    def test_dry_run_custom_target_path(self):
+        """Test dry-run with custom target path."""
+        env = {
+            "GITHUB_ACTIONS": "true",
+            "GITHUB_REPOSITORY": "DataRecce/recce",
+            "RECCE_API_TOKEN": "test_token",
+        }
+
+        with patch.dict(os.environ, env, clear=True):
+            result = self.runner.invoke(
+                cloud_cli,
+                ["upload", "--target-path", self.temp_dir, "--dry-run"],
+            )
+
+        # Assertions
+        self.assertEqual(result.exit_code, 0, f"Command failed: {result.output}")
+        self.assertIn(self.temp_dir, result.output)
+        self.assertIn("manifest.json:", result.output)
+        self.assertIn("catalog.json:", result.output)
+
+
+if __name__ == "__main__":
+    unittest.main()

tests/recce_cloud/test_client.py

@@ -0,0 +1,273 @@
+import json
+import unittest
+from unittest.mock import MagicMock, patch
+
+from recce_cloud.api.client import RecceCloudClient, RecceCloudException
+
+
+class RecceCloudClientTests(unittest.TestCase):
+    def setUp(self):
+        """Set up test fixtures."""
+        self.api_token = "rct-test-token-123"
+        self.session_id = "session-123"
+        self.org_id = "org-456"
+        self.project_id = "project-789"
+
+    def test_init_with_api_token(self):
+        """Test client initialization with Recce API token."""
+        client = RecceCloudClient(self.api_token)
+        self.assertEqual(client.token, self.api_token)
+        self.assertIn("/api/v2", client.base_url_v2)
+
+    def test_init_with_none_token_raises_error(self):
+        """Test client initialization with None token raises ValueError."""
+        with self.assertRaises(ValueError) as context:
+            RecceCloudClient(None)
+        self.assertIn("Token cannot be None", str(context.exception))
+
+    @patch("recce_cloud.api.client.requests.request")
+    def test_get_session_success(self, mock_request):
+        """Test successful get_session call."""
+        client = RecceCloudClient(self.api_token)
+
+        # Mock successful response
+        mock_response = MagicMock()
+        mock_response.status_code = 200
+        mock_response.json.return_value = {
+            "success": True,
+            "session": {
+                "id": self.session_id,
+                "org_id": self.org_id,
+                "project_id": self.project_id,
+            },
+        }
+        mock_request.return_value = mock_response
+
+        result = client.get_session(self.session_id)
+
+        self.assertEqual(result["id"], self.session_id)
+        self.assertEqual(result["org_id"], self.org_id)
+        self.assertEqual(result["project_id"], self.project_id)
+
+        # Verify request was made correctly
+        mock_request.assert_called_once()
+        call_args = mock_request.call_args
+        self.assertEqual(call_args[0][0], "GET")
+        self.assertIn(self.session_id, call_args[0][1])
+        self.assertEqual(call_args[1]["headers"]["Authorization"], f"Bearer {self.api_token}")
+
+    @patch("recce_cloud.api.client.requests.request")
+    def test_get_session_not_found(self, mock_request):
+        """Test get_session with 404 response."""
+        client = RecceCloudClient(self.api_token)
+
+        # Mock 404 response
+        mock_response = MagicMock()
+        mock_response.status_code = 404
+        mock_response.text = "Session not found"
+        mock_request.return_value = mock_response
+
+        with self.assertRaises(RecceCloudException) as context:
+            client.get_session(self.session_id)
+
+        self.assertEqual(context.exception.status_code, 404)
+        self.assertIn("Session not found", str(context.exception))
+
+    @patch("recce_cloud.api.client.requests.request")
+    def test_get_session_forbidden(self, mock_request):
+        """Test get_session with 403 response."""
+        client = RecceCloudClient(self.api_token)
+
+        # Mock 403 response
+        mock_response = MagicMock()
+        mock_response.status_code = 403
+        mock_response.json.return_value = {"detail": "Access denied"}
+        mock_request.return_value = mock_response
+
+        result = client.get_session(self.session_id)
+
+        self.assertEqual(result["status"], "error")
+        self.assertEqual(result["message"], "Access denied")
+
+    @patch("recce_cloud.api.client.requests.request")
+    def test_get_session_api_error(self, mock_request):
+        """Test get_session with API returning success=False."""
+        client = RecceCloudClient(self.api_token)
+
+        # Mock response with success=False
+        mock_response = MagicMock()
+        mock_response.status_code = 200
+        mock_response.json.return_value = {"success": False, "message": "Invalid session"}
+        mock_request.return_value = mock_response
+
+        with self.assertRaises(RecceCloudException) as context:
+            client.get_session(self.session_id)
+
+        self.assertIn("Invalid session", context.exception.reason)
+
+    @patch("recce_cloud.api.client.requests.request")
+    def test_get_upload_urls_success(self, mock_request):
+        """Test successful get_upload_urls_by_session_id call."""
+        client = RecceCloudClient(self.api_token)
+
+        # Mock successful response
+        mock_response = MagicMock()
+        mock_response.status_code = 200
+        mock_response.json.return_value = {
+            "presigned_urls": {
+                "manifest_url": "https://s3.amazonaws.com/bucket/manifest.json?token=abc",
+                "catalog_url": "https://s3.amazonaws.com/bucket/catalog.json?token=def",
+            }
+        }
+        mock_request.return_value = mock_response
+
+        result = client.get_upload_urls_by_session_id(self.org_id, self.project_id, self.session_id)
+
+        self.assertIn("manifest_url", result)
+        self.assertIn("catalog_url", result)
+        self.assertIn("s3.amazonaws.com", result["manifest_url"])
+
+        # Verify request was made correctly
+        mock_request.assert_called_once()
+        call_args = mock_request.call_args
+        self.assertEqual(call_args[0][0], "GET")
+        self.assertIn(self.org_id, call_args[0][1])
+        self.assertIn(self.project_id, call_args[0][1])
+        self.assertIn(self.session_id, call_args[0][1])
+        self.assertIn("upload-url", call_args[0][1])
+
+    @patch("recce_cloud.api.client.requests.request")
+    def test_get_upload_urls_no_presigned_urls(self, mock_request):
+        """Test get_upload_urls_by_session_id with no presigned URLs."""
+        client = RecceCloudClient(self.api_token)
+
+        # Mock response with null presigned_urls
+        mock_response = MagicMock()
+        mock_response.status_code = 200
+        mock_response.json.return_value = {"presigned_urls": None}
+        mock_request.return_value = mock_response
+
+        with self.assertRaises(RecceCloudException) as context:
+            client.get_upload_urls_by_session_id(self.org_id, self.project_id, self.session_id)
+
+        self.assertEqual(context.exception.status_code, 404)
+        self.assertIn("No presigned URLs", str(context.exception))
+
+    @patch("recce_cloud.api.client.requests.request")
+    def test_get_upload_urls_failure(self, mock_request):
+        """Test get_upload_urls_by_session_id with API failure."""
+        client = RecceCloudClient(self.api_token)
+
+        # Mock error response
+        mock_response = MagicMock()
+        mock_response.status_code = 500
+        mock_response.text = "Internal server error"
+        mock_request.return_value = mock_response
+
+        with self.assertRaises(RecceCloudException) as context:
+            client.get_upload_urls_by_session_id(self.org_id, self.project_id, self.session_id)
+
+        self.assertEqual(context.exception.status_code, 500)
+
+    @patch("recce_cloud.api.client.requests.request")
+    def test_update_session_success(self, mock_request):
+        """Test successful update_session call."""
+        client = RecceCloudClient(self.api_token)
+        adapter_type = "postgres"
+
+        # Mock successful response
+        mock_response = MagicMock()
+        mock_response.status_code = 200
+        mock_response.json.return_value = {"success": True, "session": {"adapter_type": adapter_type}}
+        mock_request.return_value = mock_response
+
+        result = client.update_session(self.org_id, self.project_id, self.session_id, adapter_type)
+
+        self.assertTrue(result["success"])
+        self.assertEqual(result["session"]["adapter_type"], adapter_type)
+
+        # Verify request was made correctly
+        mock_request.assert_called_once()
+        call_args = mock_request.call_args
+        self.assertEqual(call_args[0][0], "PATCH")
+        self.assertIn(self.org_id, call_args[0][1])
+        self.assertIn(self.project_id, call_args[0][1])
+        self.assertIn(self.session_id, call_args[0][1])
+        self.assertEqual(call_args[1]["json"]["adapter_type"], adapter_type)
+
+    @patch("recce_cloud.api.client.requests.request")
+    def test_update_session_forbidden(self, mock_request):
+        """Test update_session with 403 response."""
+        client = RecceCloudClient(self.api_token)
+
+        # Mock 403 response
+        mock_response = MagicMock()
+        mock_response.status_code = 403
+        mock_response.json.return_value = {"detail": "Insufficient permissions"}
+        mock_request.return_value = mock_response
+
+        result = client.update_session(self.org_id, self.project_id, self.session_id, "postgres")
+
+        self.assertEqual(result["status"], "error")
+        self.assertEqual(result["message"], "Insufficient permissions")
+
+    @patch("recce_cloud.api.client.requests.request")
+    def test_update_session_failure(self, mock_request):
+        """Test update_session with API failure."""
+        client = RecceCloudClient(self.api_token)
+
+        # Mock error response
+        mock_response = MagicMock()
+        mock_response.status_code = 400
+        mock_response.text = "Bad request"
+        mock_request.return_value = mock_response
+
+        with self.assertRaises(RecceCloudException) as context:
+            client.update_session(self.org_id, self.project_id, self.session_id, "invalid_adapter")
+
+        self.assertEqual(context.exception.status_code, 400)
+
+    def test_recce_cloud_exception_with_json_detail(self):
+        """Test RecceCloudException parses JSON detail."""
+        json_reason = json.dumps({"detail": "Invalid session ID"})
+        exception = RecceCloudException(reason=json_reason, status_code=400)
+
+        self.assertEqual(exception.status_code, 400)
+        self.assertEqual(exception.reason, "Invalid session ID")
+        self.assertIn("Invalid session ID", str(exception))
+
+    def test_recce_cloud_exception_with_plain_text(self):
+        """Test RecceCloudException with plain text reason."""
+        plain_reason = "Connection timeout"
+        exception = RecceCloudException(reason=plain_reason, status_code=500)
+
+        self.assertEqual(exception.status_code, 500)
+        self.assertEqual(exception.reason, plain_reason)
+
+    @patch.dict("os.environ", {"RECCE_INSTANCE_ENV": "docker"})
+    @patch("recce_cloud.api.client.requests.request")
+    def test_docker_internal_url_replacement(self, mock_request):
+        """Test localhost URL is replaced with docker internal URL."""
+        client = RecceCloudClient(self.api_token)
+
+        # Mock response with localhost URL
+        mock_response = MagicMock()
+        mock_response.status_code = 200
+        mock_response.json.return_value = {
+            "presigned_urls": {
+                "manifest_url": "http://localhost:8000/manifest.json",
+                "catalog_url": "http://localhost:8000/catalog.json",
+            }
+        }
+        mock_request.return_value = mock_response
+
+        result = client.get_upload_urls_by_session_id(self.org_id, self.project_id, self.session_id)
+
+        # URLs should be replaced with docker internal
+        self.assertIn("host.docker.internal", result["manifest_url"])
+        self.assertIn("host.docker.internal", result["catalog_url"])
+        self.assertNotIn("localhost", result["manifest_url"])
+
+
+if __name__ == "__main__":
+    unittest.main()