Project: Private Image Sharing (#633)

* Added support for Private Image Sharing features and unit tests

* Addressed PR comments

* Integration tests for private image sharing (#632)

* Create integration tests for share groups - part 1

* Create test test_try_to_add_member_invalid_token

* Update integration tests for private image sharing feature

* Apply code review sugestions

---------

Co-authored-by: Erik Zilber <ezilber@akamai.com>

---------

Co-authored-by: Pawel <100145168+psnoch-akamai@users.noreply.github.com>

Author: ezilber-akamai

linode_api4/groups/__init__.py

@@ -6,6 +6,7 @@
 from .database import *
 from .domain import *
 from .image import *
+from .image_share_group import *
 from .linode import *
 from .lke import *
 from .lke_tier import *

linode_api4/groups/image_share_group.py

@@ -0,0 +1,142 @@
+from typing import Optional
+
+from linode_api4.groups import Group
+from linode_api4.objects import (
+    ImageShareGroup,
+    ImageShareGroupImagesToAdd,
+    ImageShareGroupToken,
+)
+from linode_api4.objects.base import _flatten_request_body_recursive
+from linode_api4.util import drop_null_keys
+
+
+class ImageShareGroupAPIGroup(Group):
+    """
+    Collections related to Private Image Sharing.
+
+    NOTE: Private Image Sharing features are in beta and may not be generally available.
+    """
+
+    def __call__(self, *filters):
+        """
+        Retrieves a list of Image Share Groups created by the user (producer).
+        You can filter this query to retrieve only Image Share Groups
+        relevant to a specific query, for example::
+
+           filtered_share_groups = client.sharegroups(
+               ImageShareGroup.label == "my-label")
+
+        API Documentation: https://techdocs.akamai.com/linode-api/reference/get-sharegroups
+
+        :param filters: Any number of filters to apply to this query.
+                        See :doc:`Filtering Collections</linode_api4/objects/filtering>`
+                        for more details on filtering.
+
+        :returns: A list of Image Share Groups.
+        :rtype: PaginatedList of ImageShareGroup
+        """
+        return self.client._get_and_filter(ImageShareGroup, *filters)
+
+    def sharegroups_by_image_id(self, image_id: str):
+        """
+        Retrieves a list of Image Share Groups that share a specific Private Image.
+
+        API Documentation: https://techdocs.akamai.com/linode-api/reference/get-images-sharegroups-image
+
+        :param image_id: The ID of the Image to query for.
+        :type image_id: str
+
+        :returns: A list of Image Share Groups sharing the specified Image.
+        :rtype: PaginatedList of ImageShareGroup
+        """
+        return self.client._get_and_filter(
+            ImageShareGroup, endpoint="/images/{}/sharegroups".format(image_id)
+        )
+
+    def tokens(self, *filters):
+        """
+        Retrieves a list of Image Share Group Tokens created by the user (consumer).
+        You can filter this query to retrieve only Image Share Group Tokens
+        relevant to a specific query, for example::
+
+           filtered_share_group_tokens = client.sharegroups.tokens(
+               ImageShareGroupToken.label == "my-label")
+
+        API Documentation: https://techdocs.akamai.com/linode-api/reference/get-user-tokens
+
+        :param filters: Any number of filters to apply to this query.
+                        See :doc:`Filtering Collections</linode_api4/objects/filtering>`
+                        for more details on filtering.
+
+        :returns: A list of Image Share Group Tokens.
+        :rtype: PaginatedList of ImageShareGroupToken
+        """
+        return self.client._get_and_filter(ImageShareGroupToken, *filters)
+
+    def create_sharegroup(
+        self,
+        label: Optional[str] = None,
+        description: Optional[str] = None,
+        images: Optional[ImageShareGroupImagesToAdd] = None,
+    ):
+        """
+        Creates a new Image Share Group.
+
+        API Documentation: https://techdocs.akamai.com/linode-api/reference/post-sharegroups
+
+        :param label: The label for the resulting Image Share Group.
+        :type label: str
+        :param description: The description for the new Image Share Group.
+        :type description: str
+        :param images: A list of Images to share in the new Image Share Group, formatted in JSON.
+        :type images: Optional[ImageShareGroupImagesToAdd]
+
+        :returns: The new Image Share Group.
+        :rtype: ImageShareGroup
+        """
+        params = {
+            "label": label,
+            "description": description,
+        }
+
+        if images:
+            params["images"] = images
+
+        result = self.client.post(
+            "/images/sharegroups",
+            data=_flatten_request_body_recursive(drop_null_keys(params)),
+        )
+
+        return ImageShareGroup(self.client, result["id"], result)
+
+    def create_token(
+        self, valid_for_sharegroup_uuid: str, label: Optional[str] = None
+    ):
+        """
+        Creates a new Image Share Group Token and returns the token value.
+
+        API Documentation: https://techdocs.akamai.com/linode-api/reference/post-sharegroup-tokens
+
+        :param valid_for_sharegroup_uuid: The UUID of the Image Share Group that this token will be valid for.
+        :type valid_for_sharegroup_uuid: Optional[str]
+        :param label: The label for the resulting Image Share Group Token.
+        :type label: str
+
+        :returns: The new Image Share Group Token object and the one-time use token itself.
+        :rtype: (ImageShareGroupToken, str)
+        """
+        params = {"valid_for_sharegroup_uuid": valid_for_sharegroup_uuid}
+
+        if label:
+            params["label"] = label
+
+        result = self.client.post(
+            "/images/sharegroups/tokens",
+            data=_flatten_request_body_recursive(drop_null_keys(params)),
+        )
+
+        token_value = result.pop("token", None)
+        token_obj = ImageShareGroupToken(
+            self.client, result["token_uuid"], result
+        )
+        return token_obj, token_value

linode_api4/groups/linode.py

@@ -23,9 +23,7 @@
     NetworkInterface,
     _expand_placement_group_assignment,
 )
-from linode_api4.objects.linode_interfaces import (
-    LinodeInterfaceOptions,
-)
+from linode_api4.objects.linode_interfaces import LinodeInterfaceOptions
 from linode_api4.util import drop_null_keys
 
 

linode_api4/linode_client.py

@@ -16,6 +16,7 @@
     DatabaseGroup,
     DomainGroup,
     ImageGroup,
+    ImageShareGroupAPIGroup,
     LinodeGroup,
     LKEGroup,
     LockGroup,
@@ -441,6 +442,9 @@ def __init__(
         #: Access methods related to Images - See :any:`ImageGroup` for more information.
         self.images = ImageGroup(self)
 
+        #: Access methods related to Image Share Groups - See :any:`ImageShareGroupAPIGroup` for more information.
+        self.sharegroups = ImageShareGroupAPIGroup(self)
+
         #: Access methods related to VPCs - See :any:`VPCGroup` for more information.
         self.vpcs = VPCGroup(self)
 

linode_api4/objects/__init__.py

@@ -24,4 +24,5 @@
 from .placement import *
 from .monitor import *
 from .monitor_api import *
+from .image_share_group import *
 from .lock import *

linode_api4/objects/image.py

@@ -30,6 +30,38 @@ class ImageRegion(JSONObject):
     status: Optional[ReplicationStatus] = None
 
 
+@dataclass
+class ImageSharingSharedWith(JSONObject):
+    """
+    Data representing who an Image has been shared with.
+    """
+
+    sharegroup_count: Optional[int] = None
+    sharegroup_list_url: Optional[str] = None
+
+
+@dataclass
+class ImageSharingSharedBy(JSONObject):
+    """
+    Data representing who shared an Image.
+    """
+
+    sharegroup_id: Optional[int] = None
+    sharegroup_uuid: Optional[str] = None
+    sharegroup_label: Optional[str] = None
+    source_image_id: Optional[str] = None
+
+
+@dataclass
+class ImageSharing(JSONObject):
+    """
+    The Image Sharing status of an Image.
+    """
+
+    shared_with: Optional[ImageSharingSharedWith] = None
+    shared_by: Optional[ImageSharingSharedBy] = None
+
+
 class Image(Base):
     """
     An Image is something a Linode Instance or Disk can be deployed from.
@@ -51,6 +83,7 @@ class Image(Base):
         "updated": Property(is_datetime=True),
         "type": Property(),
         "is_public": Property(),
+        "is_shared": Property(),
         "vendor": Property(),
         "size": Property(),
         "deprecated": Property(),
@@ -60,6 +93,7 @@ class Image(Base):
         "tags": Property(mutable=True, unordered=True),
         "total_size": Property(),
         "regions": Property(json_object=ImageRegion, unordered=True),
+        "image_sharing": Property(json_object=ImageSharing),
     }
 
     def replicate(self, regions: Union[List[str], List[Region]]):