ENG-10556 | Add OracleCloud (OCI) Object Storage provider for osfstorage (#474)

* ENG-10556 | Add OracleCloud (OCI) Object Storage provider for osfstorage

* ENG-10556 | Add tests for the OracleCloud (OCI) Object Storage provider for osfstorage

Author: sh-andriy

pyproject.toml

@@ -23,6 +23,7 @@ humanfriendly = "10.0"
 invoke = "2.2.0"
 multidict = ">=6.0.0"
 newrelic = "10.8.1"
+oci = "^2.149.0"
 oauthlib = "3.2.2"
 pyjwe = "1.0.0"
 pyjwt = "2.10.1"
@@ -91,6 +92,7 @@ googledrive = "waterbutler.providers.googledrive:GoogleDriveProvider"
 onedrive = "waterbutler.providers.onedrive:OneDriveProvider"
 googlecloud = "waterbutler.providers.googlecloud:GoogleCloudProvider"
 azureblobstorage = "waterbutler.providers.azureblobstorage:AzureBlobStorageProvider"
+oraclecloud = "waterbutler.providers.oraclecloud:OracleCloudProvider"
 
 [tool.pytest.ini_options]
 asyncio_default_fixture_loop_scope = "function"

tests/providers/oraclecloud/__init__.py

@@ -0,0 +1,25 @@
+import pytest
+
+
+@pytest.fixture()
+def mock_auth():
+    return {"name": "Test User", "email": "test@osf.io"}
+
+
+@pytest.fixture()
+def mock_creds():
+    return {
+        "oci_user": "ocid1.user.oc1..aaaaaaaafakeuser",
+        "oci_fingerprint": "aa:bb:cc:dd:ee:ff:00:11:22:33:44:55:66:77:88:99",
+        "oci_tenancy": "ocid1.tenancy.oc1..aaaaaaaafaketenancy",
+        "oci_region": "us-ashburn-1",
+        "oci_key_content": "-----BEGIN RSA PRIVATE KEY-----\nfake\n-----END RSA PRIVATE KEY-----",
+    }
+
+
+@pytest.fixture()
+def mock_settings():
+    return {
+        "bucket": "test-bucket",
+        "namespace": "test-namespace",
+    }

tests/providers/oraclecloud/fixtures/__init__.py

@@ -0,0 +1,132 @@
+from unittest import mock
+
+import pytest
+
+from waterbutler.providers.oraclecloud.metadata import (
+    BaseOracleCloudMetadata,
+    OracleCloudFileMetadata,
+    OracleCloudFolderMetadata,
+)
+
+
+class TestOracleCloudFileMetadata:
+
+    def test_file_metadata_from_dict(self):
+
+        raw = {
+            "object_name": "path/to/file.txt",
+            "content_type": "text/plain",
+            "last_modified": "Thu, 01 Mar 2025 19:04:45 GMT",
+            "size": 1024,
+            "etag": "abc123def456",
+            "extra": {
+                "md5": "rL0Y20zC+Fzt72VPzMSk2A==",
+                "storage_tier": "Standard",
+                "archival_state": None,
+            },
+            "time_created": "2025-03-01T19:00:00+00:00",
+        }
+        metadata = OracleCloudFileMetadata(raw)
+
+        assert isinstance(metadata, BaseOracleCloudMetadata)
+        assert metadata.provider == "oraclecloud"
+        assert metadata.kind == "file"
+        assert metadata.name == "file.txt"
+        assert metadata.path == "/path/to/file.txt"
+        assert metadata.content_type == "text/plain"
+        assert metadata.modified == "Thu, 01 Mar 2025 19:04:45 GMT"
+        assert metadata.size == 1024
+        assert metadata.size_as_int == 1024
+        assert metadata.etag == "abc123def456"
+        assert metadata.extra["md5"] == "rL0Y20zC+Fzt72VPzMSk2A=="
+        assert metadata.extra["storage_tier"] == "Standard"
+        assert metadata.created_utc == "2025-03-01T19:00:00+00:00"
+
+    def test_file_metadata_missing_optional_fields(self):
+
+        raw = {
+            "object_name": "simple.txt",
+            "content_type": None,
+            "last_modified": None,
+            "size": None,
+            "etag": None,
+            "extra": {},
+        }
+        metadata = OracleCloudFileMetadata(raw)
+
+        assert metadata.name == "simple.txt"
+        assert metadata.content_type is None
+        assert metadata.modified is None
+        assert metadata.size is None
+        assert metadata.etag is None
+        assert metadata.extra == {}
+        assert metadata.created_utc is None
+
+    def test_file_metadata_from_head_response(self):
+
+        head_resp = mock.Mock()
+        head_resp.headers = {
+            "content-type": "application/pdf",
+            "content-length": "2048",
+            "last-modified": "Fri, 14 Mar 2025 12:00:00 GMT",
+            "etag": '"deadbeef"',
+            "opc-content-md5": "rL0Y20zC+Fzt72VPzMSk2A==",
+            "storage-tier": "Standard",
+        }
+
+        metadata = OracleCloudFileMetadata.new_from_head_response(
+            "folder/report.pdf", head_resp
+        )
+
+        assert metadata.provider == "oraclecloud"
+        assert metadata.name == "report.pdf"
+        assert metadata.path == "/folder/report.pdf"
+        assert metadata.content_type == "application/pdf"
+        assert metadata.size == 2048
+        assert metadata.etag == "deadbeef"
+        assert metadata.extra["md5"] == "rL0Y20zC+Fzt72VPzMSk2A=="
+
+    def test_file_metadata_from_object_summary(self):
+
+        obj_summary = mock.Mock()
+        obj_summary.name = "data/results.csv"
+        obj_summary.size = 4096
+        obj_summary.etag = "etag123"
+        obj_summary.md5 = "abc123"
+        obj_summary.storage_tier = "InfrequentAccess"
+        obj_summary.archival_state = None
+        obj_summary.time_modified = mock.Mock()
+        obj_summary.time_modified.isoformat.return_value = "2025-03-10T08:00:00+00:00"
+        obj_summary.time_created = None
+
+        metadata = OracleCloudFileMetadata.new_from_oci_object_summary(obj_summary)
+
+        assert metadata.name == "results.csv"
+        assert metadata.path == "/data/results.csv"
+        assert metadata.size == 4096
+        assert metadata.etag == "etag123"
+        assert metadata.extra["md5"] == "abc123"
+        assert metadata.modified == "2025-03-10T08:00:00+00:00"
+        assert metadata.created_utc is None
+
+
+class TestOracleCloudFolderMetadata:
+
+    def test_folder_metadata(self):
+
+        raw = {"object_name": "path/to/folder/"}
+        metadata = OracleCloudFolderMetadata(raw)
+
+        assert isinstance(metadata, BaseOracleCloudMetadata)
+        assert metadata.provider == "oraclecloud"
+        assert metadata.kind == "folder"
+        assert metadata.name == "folder"
+        assert metadata.path == "/path/to/folder/"
+
+    def test_folder_metadata_nested(self):
+
+        raw = {"object_name": "a/b/c/"}
+        metadata = OracleCloudFolderMetadata(raw)
+
+        assert metadata.name == "c"
+        assert metadata.path == "/a/b/c/"