Browse Source

Add error tests

Shamil Gadelshin 5 years ago
parent
commit
e9f1f165f6

+ 11 - 9
runtime-modules/proposals/codex/src/lib.rs

@@ -1,15 +1,20 @@
 //! Proposals codex module for the Joystream platform. Version 2.
-//! Contains preset proposal types
+//! Contains preset proposal types.
 //!
 //! Supported extrinsics (proposal type):
 //! - create_text_proposal
+//! - create_runtime_upgrade_proposal
+//!
+//! Proposal implementations of this module:
+//! - execute_text_proposal - prints the proposal to the log
+//! - execute_runtime_upgrade_proposal - sets the runtime code
 //!
 
 // Ensure we're `no_std` when compiling for Wasm.
 #![cfg_attr(not(feature = "std"), no_std)]
 
 // Do not delete! Cannot be uncommented by default, because of Parity decl_module! issue.
-//#![warn(missing_docs)]
+// #![warn(missing_docs)]
 
 mod proposal_types;
 #[cfg(test)]
@@ -71,9 +76,6 @@ decl_error! {
 
         /// Require root origin in extrinsics
         RequireRootOrigin,
-
-        /// Errors from the proposal engine
-        ProposalsEngineError
     }
 }
 
@@ -151,7 +153,7 @@ decl_module! {
                 member_id.clone(),
             )?;
 
-            let proposal_code = <Call<T>>::text_proposal(title.clone(), description.clone(), text);
+            let proposal_code = <Call<T>>::execute_text_proposal(title.clone(), description.clone(), text);
 
             let discussion_thread_id = <proposal_discussion::Module<T>>::create_thread(
                 member_id,
@@ -200,7 +202,7 @@ decl_module! {
                 member_id.clone(),
             )?;
 
-            let proposal_code = <Call<T>>::text_proposal(title.clone(), description.clone(), wasm);
+            let proposal_code = <Call<T>>::execute_runtime_upgrade_proposal(title.clone(), description.clone(), wasm);
 
             let discussion_thread_id = <proposal_discussion::Module<T>>::create_thread(
                 member_id,
@@ -223,7 +225,7 @@ decl_module! {
 // *************** Extrinsic to execute
 
         /// Text proposal extrinsic. Should be used as callable object to pass to the engine module.
-        fn text_proposal(
+        fn execute_text_proposal(
             origin,
             title: Vec<u8>,
             _description: Vec<u8>,
@@ -239,7 +241,7 @@ decl_module! {
 
         /// Runtime upgrade proposal extrinsic.
         /// Should be used as callable object to pass to the engine module.
-        fn runtime_upgrade_proposal(
+        fn execute_runtime_upgrade_proposal(
             origin,
             title: Vec<u8>,
             _description: Vec<u8>,

+ 1 - 3
runtime-modules/proposals/discussion/src/lib.rs

@@ -7,6 +7,7 @@
 //!
 //! Public API:
 //! - create_discussion - creates a discussion
+//! - ensure_can_create_thread - ensures safe thread creation
 //!
 
 // Ensure we're `no_std` when compiling for Wasm.
@@ -84,9 +85,6 @@ pub trait Trait: system::Trait + membership::members::Trait {
 
 decl_error! {
     pub enum Error {
-        /// The size of the provided text for text proposal exceeded the limit
-        TextProposalSizeExceeded,
-
         /// Author should match the post creator
         NotAuthor,
 

+ 2 - 0
runtime-modules/proposals/discussion/src/types.rs

@@ -1,3 +1,5 @@
+#![warn(missing_docs)]
+
 use codec::{Decode, Encode};
 #[cfg(feature = "std")]
 use serde::{Deserialize, Serialize};

+ 3 - 1
runtime-modules/proposals/engine/src/lib.rs

@@ -9,6 +9,8 @@
 //!
 //! Public API (requires root origin):
 //! - create_proposal - creates proposal using provided parameters
+//! - ensure_create_proposal_parameters_are_valid - ensures that we can create the proposal
+//! - refund_proposal_stake - a callback for StakingHandlerEvents
 //!
 
 // Ensure we're `no_std` when compiling for Wasm.
@@ -373,7 +375,7 @@ impl<T: Trait> Module<T> {
 
     /// Performs all checks for the proposal creation:
     /// - title, body lengths
-    /// - mac active proposal
+    /// - max active proposal
     /// - provided parameters: approval_threshold_percentage and slashing_threshold_percentage > 0
     /// - provided stake balance and parameters.required_stake are valid
     pub fn ensure_create_proposal_parameters_are_valid(

+ 2 - 0
runtime-modules/proposals/engine/src/types/mod.rs

@@ -1,6 +1,8 @@
 //! Proposals types module for the Joystream platform. Version 2.
 //! Provides types for the proposal engine.
 
+#![warn(missing_docs)]
+
 use codec::{Decode, Encode};
 use rstd::cmp::PartialOrd;
 use rstd::ops::Add;

+ 1 - 1
runtime/src/test/proposals_integration.rs

@@ -40,7 +40,7 @@ impl Default for DummyProposalFixture {
     fn default() -> Self {
         let title = b"title".to_vec();
         let description = b"description".to_vec();
-        let dummy_proposal = proposals_codex::Call::<Runtime>::text_proposal(
+        let dummy_proposal = proposals_codex::Call::<Runtime>::execute_text_proposal(
             title.clone(),
             description.clone(),
             b"text".to_vec(),