Browse Source

runtime: storage: Add extrinsic.

- add `accept_distribution_bucket_invitation`
Shamil Gadelshin 3 years ago
parent
commit
afb2f9ff8f

+ 64 - 9
runtime-modules/storage/src/lib.rs

@@ -74,6 +74,8 @@
 //!  invites a distribution bucket operator.
 //! - [cancel_distribution_bucket_operator_invite](./struct.Module.html#method.cancel_distribution_bucket_operator_invite) -
 //!  Cancels pending invite for a distribution bucket.
+//! - [accept_distribution_bucket_invitation](./struct.Module.html#method.accept_distribution_bucket_invitation) -
+//!  Accepts pending invite for a distribution bucket.
 //!
 //! #### Public methods
 //! Public integration methods are exposed via the [DataObjectStorage](./trait.DataObjectStorage.html)
@@ -149,6 +151,7 @@ use storage_bucket_picker::StorageBucketPicker;
 // How to be sure that we don't have already accepted invitation? We need to have it in the bucket
 // a separate map. DistributionOperatorId is not sustainable - verify that on Monday.
 // TODO: test invite_distribution_bucket_operator with accepted invitation.
+
 /// Public interface for the storage module.
 pub trait DataObjectStorage<T: Trait> {
     /// Validates upload parameters and conditions (like global uploading block).
@@ -1139,12 +1142,23 @@ decl_event! {
         /// Params
         /// - distribution bucket family ID
         /// - distribution bucket ID
-        /// - worker ID
+        /// - operator worker ID
         DistributionBucketInvitationCancelled(
             DistributionBucketFamilyId,
             DistributionBucketId,
             WorkerId,
         ),
+
+        /// Emits on canceling a distribution bucket invitation for the operator.
+        /// Params
+        /// - distribution bucket family ID
+        /// - distribution bucket ID
+        /// - worker ID
+        DistributionBucketInvitationAccepted(
+            WorkerId,
+            DistributionBucketFamilyId,
+            DistributionBucketId,
+        ),
     }
 }
 
@@ -2170,7 +2184,7 @@ decl_module! {
             origin,
             distribution_bucket_family_id: T::DistributionBucketFamilyId,
             distribution_bucket_id: T::DistributionBucketId,
-            worker_id: WorkerId<T>
+            operator_worker_id: WorkerId<T>
         ) {
             T::ensure_distribution_working_group_leader_origin(origin)?;
 
@@ -2181,13 +2195,13 @@ decl_module! {
                 &distribution_bucket_id
             )?;
 
-            Self::ensure_distribution_provider_can_be_invited(&bucket, &worker_id)?;
+            Self::ensure_distribution_provider_can_be_invited(&bucket, &operator_worker_id)?;
 
             //
             // == MUTATION SAFE ==
             //
 
-            bucket.pending_invitations.insert(worker_id);
+            bucket.pending_invitations.insert(operator_worker_id);
             family.distribution_buckets.insert(distribution_bucket_id, bucket);
 
             <DistributionBucketFamilyById<T>>::insert(distribution_bucket_family_id, family);
@@ -2196,7 +2210,7 @@ decl_module! {
                 RawEvent::DistributionBucketOperatorInvited(
                     distribution_bucket_family_id,
                     distribution_bucket_id,
-                    worker_id,
+                    operator_worker_id,
                 )
             );
         }
@@ -2207,7 +2221,7 @@ decl_module! {
             origin,
             distribution_bucket_family_id: T::DistributionBucketFamilyId,
             distribution_bucket_id: T::DistributionBucketId,
-            worker_id: WorkerId<T>
+            operator_worker_id: WorkerId<T>
         ) {
             T::ensure_distribution_working_group_leader_origin(origin)?;
 
@@ -2219,7 +2233,7 @@ decl_module! {
             )?;
 
             ensure!(
-                bucket.pending_invitations.contains(&worker_id),
+                bucket.pending_invitations.contains(&operator_worker_id),
                 Error::<T>::NoDistributionBucketInvitation
             );
 
@@ -2227,7 +2241,7 @@ decl_module! {
             // == MUTATION SAFE ==
             //
 
-            bucket.pending_invitations.remove(&worker_id);
+            bucket.pending_invitations.remove(&operator_worker_id);
             family.distribution_buckets.insert(distribution_bucket_id, bucket);
 
             <DistributionBucketFamilyById<T>>::insert(distribution_bucket_family_id, family);
@@ -2236,13 +2250,54 @@ decl_module! {
                 RawEvent::DistributionBucketInvitationCancelled(
                     distribution_bucket_family_id,
                     distribution_bucket_id,
-                    worker_id
+                    operator_worker_id
                 )
             );
         }
 
         // ===== Distribution Operator actions =====
 
+        /// Accept pending invite.
+        #[weight = 10_000_000] // TODO: adjust weight
+        pub fn accept_distribution_bucket_invitation(
+            origin,
+            worker_id: WorkerId<T>,
+            distribution_bucket_family_id: T::DistributionBucketFamilyId,
+            distribution_bucket_id: T::DistributionBucketId,
+
+        ) {
+            T::ensure_distribution_worker_origin(origin, worker_id)?;
+
+            let mut family =
+                Self::ensure_distribution_bucket_family_exists(&distribution_bucket_family_id)?;
+            let mut bucket = Self::ensure_distribution_bucket_exists(
+                &family,
+                &distribution_bucket_id
+            )?;
+
+            ensure!(
+                bucket.pending_invitations.contains(&worker_id),
+                Error::<T>::NoDistributionBucketInvitation
+            );
+
+            //
+            // == MUTATION SAFE ==
+            //
+
+            bucket.pending_invitations.remove(&worker_id);
+            bucket.operators.insert(worker_id);
+            family.distribution_buckets.insert(distribution_bucket_id, bucket);
+
+            <DistributionBucketFamilyById<T>>::insert(distribution_bucket_family_id, family);
+
+            Self::deposit_event(
+                RawEvent::DistributionBucketInvitationAccepted(
+                    worker_id,
+                    distribution_bucket_family_id,
+                    distribution_bucket_id,
+                )
+            );
+        }
     }
 }
 

+ 57 - 0
runtime-modules/storage/src/tests/fixtures.rs

@@ -1750,3 +1750,60 @@ impl CancelDistributionBucketInvitationFixture {
         }
     }
 }
+
+pub struct AcceptDistributionBucketInvitationFixture {
+    origin: RawOrigin<u64>,
+    bucket_id: u64,
+    family_id: u64,
+    worker_id: u64,
+}
+
+impl AcceptDistributionBucketInvitationFixture {
+    pub fn default() -> Self {
+        Self {
+            origin: RawOrigin::Signed(DEFAULT_DISTRIBUTION_PROVIDER_ACCOUNT_ID),
+            bucket_id: Default::default(),
+            family_id: Default::default(),
+            worker_id: Default::default(),
+        }
+    }
+
+    pub fn with_origin(self, origin: RawOrigin<u64>) -> Self {
+        Self { origin, ..self }
+    }
+
+    pub fn with_bucket_id(self, bucket_id: u64) -> Self {
+        Self { bucket_id, ..self }
+    }
+
+    pub fn with_family_id(self, family_id: u64) -> Self {
+        Self { family_id, ..self }
+    }
+
+    pub fn with_worker_id(self, worker_id: u64) -> Self {
+        Self { worker_id, ..self }
+    }
+
+    pub fn call_and_assert(&self, expected_result: DispatchResult) {
+        let actual_result = Storage::accept_distribution_bucket_invitation(
+            self.origin.clone().into(),
+            self.worker_id,
+            self.family_id,
+            self.bucket_id,
+        );
+
+        assert_eq!(actual_result, expected_result);
+
+        if actual_result.is_ok() {
+            let new_family = Storage::distribution_bucket_family_by_id(self.family_id);
+            let new_bucket = new_family
+                .distribution_buckets
+                .get(&self.bucket_id)
+                .unwrap();
+
+            assert!(!new_bucket.pending_invitations.contains(&self.worker_id));
+
+            assert!(new_bucket.operators.contains(&self.worker_id));
+        }
+    }
+}

+ 101 - 0
runtime-modules/storage/src/tests/mod.rs

@@ -31,6 +31,7 @@ use mocks::{
     DISTRIBUTION_WG_LEADER_ACCOUNT_ID, STORAGE_WG_LEADER_ACCOUNT_ID,
 };
 
+use crate::tests::mocks::DEFAULT_DISTRIBUTION_PROVIDER_ACCOUNT_ID;
 use fixtures::*;
 
 #[test]
@@ -4438,3 +4439,103 @@ fn cancel_distribution_bucket_operator_invite_fails_with_invalid_distribution_bu
             ));
     });
 }
+
+#[test]
+fn accept_distribution_bucket_operator_invite_succeeded() {
+    build_test_externalities().execute_with(|| {
+        let starting_block = 1;
+        run_to_block(starting_block);
+
+        let provider_id = DEFAULT_DISTRIBUTION_PROVIDER_ID;
+
+        let family_id = CreateDistributionBucketFamilyFixture::default()
+            .with_origin(RawOrigin::Signed(DISTRIBUTION_WG_LEADER_ACCOUNT_ID))
+            .call_and_assert(Ok(()))
+            .unwrap();
+
+        let bucket_id = CreateDistributionBucketFixture::default()
+            .with_family_id(family_id)
+            .with_origin(RawOrigin::Signed(DISTRIBUTION_WG_LEADER_ACCOUNT_ID))
+            .call_and_assert(Ok(()))
+            .unwrap();
+
+        InviteDistributionBucketOperatorFixture::default()
+            .with_origin(RawOrigin::Signed(DISTRIBUTION_WG_LEADER_ACCOUNT_ID))
+            .with_bucket_id(bucket_id)
+            .with_family_id(family_id)
+            .with_operator_worker_id(provider_id)
+            .call_and_assert(Ok(()));
+
+        AcceptDistributionBucketInvitationFixture::default()
+            .with_origin(RawOrigin::Signed(DEFAULT_DISTRIBUTION_PROVIDER_ACCOUNT_ID))
+            .with_family_id(family_id)
+            .with_bucket_id(bucket_id)
+            .with_worker_id(provider_id)
+            .call_and_assert(Ok(()));
+
+        EventFixture::assert_last_crate_event(RawEvent::DistributionBucketInvitationAccepted(
+            provider_id,
+            family_id,
+            bucket_id,
+        ));
+    });
+}
+
+#[test]
+fn accept_distribution_bucket_operator_invite_fails_with_non_leader_origin() {
+    build_test_externalities().execute_with(|| {
+        let invalid_account_id = 11111;
+
+        AcceptDistributionBucketInvitationFixture::default()
+            .with_origin(RawOrigin::Signed(invalid_account_id))
+            .call_and_assert(Err(DispatchError::BadOrigin));
+    });
+}
+
+#[test]
+fn accept_distribution_bucket_operator_invite_fails_with_non_existing_storage_bucket() {
+    build_test_externalities().execute_with(|| {
+        let family_id = CreateDistributionBucketFamilyFixture::default()
+            .with_origin(RawOrigin::Signed(DISTRIBUTION_WG_LEADER_ACCOUNT_ID))
+            .call_and_assert(Ok(()))
+            .unwrap();
+
+        AcceptDistributionBucketInvitationFixture::default()
+            .with_family_id(family_id)
+            .with_origin(RawOrigin::Signed(DEFAULT_DISTRIBUTION_PROVIDER_ACCOUNT_ID))
+            .call_and_assert(Err(Error::<Test>::DistributionBucketDoesntExist.into()));
+    });
+}
+
+#[test]
+fn accept_distribution_bucket_operator_invite_fails_with_non_invited_storage_provider() {
+    build_test_externalities().execute_with(|| {
+        let family_id = CreateDistributionBucketFamilyFixture::default()
+            .with_origin(RawOrigin::Signed(DISTRIBUTION_WG_LEADER_ACCOUNT_ID))
+            .call_and_assert(Ok(()))
+            .unwrap();
+
+        let bucket_id = CreateDistributionBucketFixture::default()
+            .with_family_id(family_id)
+            .with_origin(RawOrigin::Signed(DISTRIBUTION_WG_LEADER_ACCOUNT_ID))
+            .call_and_assert(Ok(()))
+            .unwrap();
+
+        AcceptDistributionBucketInvitationFixture::default()
+            .with_origin(RawOrigin::Signed(DEFAULT_DISTRIBUTION_PROVIDER_ACCOUNT_ID))
+            .with_family_id(family_id)
+            .with_bucket_id(bucket_id)
+            .call_and_assert(Err(Error::<Test>::NoDistributionBucketInvitation.into()));
+    });
+}
+
+#[test]
+fn accept_distribution_bucket_operator_invite_fails_with_invalid_distribution_bucket_family() {
+    build_test_externalities().execute_with(|| {
+        AcceptDistributionBucketInvitationFixture::default()
+            .with_origin(RawOrigin::Signed(DEFAULT_DISTRIBUTION_PROVIDER_ACCOUNT_ID))
+            .call_and_assert(Err(
+                Error::<Test>::DistributionBucketFamilyDoesntExist.into()
+            ));
+    });
+}