dcor-shared 0.7.0__tar.gz → 0.7.2__tar.gz

{dcor_shared-0.7.0 → dcor_shared-0.7.2}/CHANGELOG

@@ -1,3 +1,8 @@
+0.7.2
+ - tests: fix invalid make_dataset method
+0.7.1
+ - fix: handle non-existent bucket when S3 object is missing
+ - docs: be more verbose in s3cc docstrings
 0.7.0
  - feat: implement `s3.create_presigned_upload_url` for creating presigned
    upload URLs that DCOR-Aid can use to upload resources directly to S3

{dcor_shared-0.7.0 → dcor_shared-0.7.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dcor_shared
-Version: 0.7.0
+Version: 0.7.2
 Summary: Functionalities shared by the DCOR CKAN extensions
 Home-page: https://github.com/DCOR-dev/dcor_shared
 Author: Paul Müller

{dcor_shared-0.7.0 → dcor_shared-0.7.2}/dcor_shared/_version_save.py

@@ -1,3 +1,3 @@
 #!/usr/bin/env python
 # This file was created automatically
-longversion = '0.7.0'
+longversion = '0.7.2'

{dcor_shared-0.7.0 → dcor_shared-0.7.2}/dcor_shared/s3.py

@@ -256,7 +256,8 @@ def make_object_public(bucket_name, object_name, missing_ok=False):
         response = s3_client.get_object_tagging(
             Bucket=bucket_name,
             Key=object_name)
-    except s3_client.exceptions.NoSuchKey:
+    except (s3_client.exceptions.NoSuchBucket,
+            s3_client.exceptions.NoSuchKey):
         if not missing_ok:
             raise
     else:

{dcor_shared-0.7.0 → dcor_shared-0.7.2}/dcor_shared/s3cc.py

@@ -26,7 +26,11 @@ def create_presigned_url(
         artifact: Literal["condensed", "preview", "resource"] = "resource",
         expiration: int = 3600,
         filename: str = None):
-    """Create a presigned URL for a given artifact of a CKAN resource"""
+    """Create a presigned URL for a given artifact of a CKAN resource
+
+    The resource with the identifier `resource_id` must exist in the
+    CKAN database.
+    """
     bucket_name, object_name = get_s3_bucket_object_for_artifact(
         resource_id=resource_id, artifact=artifact)
     return s3.create_presigned_url(bucket_name=bucket_name,
@@ -42,6 +46,9 @@ def get_s3_bucket_object_for_artifact(
 
     The value of artifact can be either "condensed", "preview", or "resource"
     (those are the keys under which the individual objects are stored in S3).
+
+    The resource with the identifier `resource_id` must exist in the
+    CKAN database.
     """
     bucket_name = get_s3_bucket_name_for_resource(resource_id=resource_id)
     rid = resource_id
@@ -54,6 +61,9 @@ def get_s3_bucket_name_for_resource(resource_id):
 
     The bucket name is determined by the ID of the organization
     which the dataset containing the resource belongs to.
+
+    The resource with the identifier `resource_id` must exist in the
+    CKAN database.
     """
     import ckan.logic
     res_dict = ckan.logic.get_action('resource_show')(
@@ -69,7 +79,11 @@ def get_s3_bucket_name_for_resource(resource_id):
 
 
 def get_s3_dc_handle(resource_id):
-    """Return an instance of :class:`RTDC_S3`"""
+    """Return an instance of :class:`RTDC_S3`
+
+    The resource with the identifier `resource_id` must exist in the
+    CKAN database.
+    """
     s3_url = get_s3_url_for_artifact(resource_id)
     ds = fmt_s3.RTDC_S3(
         url=s3_url,
@@ -88,6 +102,9 @@ def get_s3_url_for_artifact(
 
     The value of artifact can be either "condensed", "preview", or "resource"
     (those are the keys under which the individual objects are stored in S3).
+
+    The resource with the identifier `resource_id` must exist in the
+    CKAN database.
     """
     s3_endpoint = get_ckan_config_option("dcor_object_store.endpoint_url")
     bucket_name, object_name = get_s3_bucket_object_for_artifact(
@@ -97,7 +114,11 @@ def get_s3_url_for_artifact(
 
 def make_resource_public(resource_id: str,
                          missing_ok: bool = True):
-    """Make a resource, including all its artifacts, public"""
+    """Make a resource, including all its artifacts, public
+
+    The resource with the identifier `resource_id` must exist in the
+    CKAN database.
+    """
     for artifact in ["condensed", "preview", "resource"]:
         bucket_name, object_name = get_s3_bucket_object_for_artifact(
             resource_id=resource_id, artifact=artifact)
@@ -109,6 +130,11 @@ def make_resource_public(resource_id: str,
 def object_exists(
         resource_id: str,
         artifact: Literal["condensed", "preview", "resource"] = "resource"):
+    """Check whether an object is available on S3
+
+    The resource with the identifier `resource_id` must exist in the
+    CKAN database.
+    """
     bucket_name, object_name = get_s3_bucket_object_for_artifact(
         resource_id=resource_id, artifact=artifact)
     return s3.object_exists(bucket_name=bucket_name, object_name=object_name)

{dcor_shared-0.7.0 → dcor_shared-0.7.2}/dcor_shared/testing.py

@@ -35,7 +35,7 @@ def create_with_upload_no_temp(clean_db, ckan_config, monkeypatch):
 
 
 def make_dataset(create_context, owner_org, create_with_upload=None,
-                 activate=False, **kwargs):
+                 resource_path=None, activate=False, **kwargs):
     if "title" not in kwargs:
         kwargs["title"] = "test-dataset"
     if "authors" not in kwargs:
@@ -52,7 +52,10 @@ def make_dataset(create_context, owner_org, create_with_upload=None,
                              )
 
     if create_with_upload is not None:
-        rs = make_resource(create_with_upload, create_context, ds["id"])
+        rs = make_resource(resource_path=resource_path,
+                           create_with_upload=create_with_upload,
+                           create_context=create_context,
+                           dataset_id=ds["id"])
 
     if activate:
         helpers.call_action("package_patch", create_context,

{dcor_shared-0.7.0 → dcor_shared-0.7.2}/dcor_shared.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dcor-shared
-Version: 0.7.0
+Version: 0.7.2
 Summary: Functionalities shared by the DCOR CKAN extensions
 Home-page: https://github.com/DCOR-dev/dcor_shared
 Author: Paul Müller

{dcor_shared-0.7.0 → dcor_shared-0.7.2}/dcor_shared.egg-info/SOURCES.txt

@@ -23,4 +23,5 @@ dcor_shared.egg-info/top_level.txt
 tests/test_basic.py
 tests/test_data.py
 tests/test_s3.py
-tests/test_s3cc.py
+tests/test_s3cc.py
+tests/test_testing.py

dcor_shared-0.7.2/tests/test_testing.py

@@ -0,0 +1,46 @@
+import pathlib
+import pytest
+
+import ckan.tests.factories as factories
+
+from dcor_shared.testing import make_dataset
+
+data_path = pathlib.Path(__file__).parent / "data"
+
+
+@pytest.mark.ckan_config('ckan.plugins', 'dcor_schemas')
+@pytest.mark.usefixtures('clean_db', 'with_request_context')
+def test_make_dataset():
+    user = factories.User()
+    owner_org = factories.Organization(users=[{
+        'name': user['id'],
+        'capacity': 'admin'
+    }])
+    # Note: `call_action` bypasses authorization!
+    create_context = {'ignore_auth': False,
+                      'user': user['name'], 'api_version': 3}
+    ds_dict = make_dataset(create_context, owner_org,
+                           activate=False)
+    assert ds_dict["state"] == "draft"
+
+
+@pytest.mark.ckan_config('ckan.plugins', 'dcor_schemas')
+@pytest.mark.usefixtures('clean_db', 'with_request_context')
+def test_make_dataset_with_resource(create_with_upload):
+    user = factories.User()
+    owner_org = factories.Organization(users=[{
+        'name': user['id'],
+        'capacity': 'admin'
+    }])
+    # Note: `call_action` bypasses authorization!
+    create_context = {'ignore_auth': False,
+                      'user': user['name'], 'api_version': 3}
+    # upload a *valid* [sic] .rtdc File (this is the control)
+    ds_dict, res_dict = make_dataset(
+        create_context, owner_org,
+        create_with_upload=create_with_upload,
+        resource_path=data_path / "calibration_beads_47.rtdc",
+        activate=True)
+    assert len(ds_dict["resources"]) == 1
+    assert "id" in res_dict
+    assert res_dict["package_id"] == ds_dict["id"]