Merge pull request #39 from dfinity-lab/hansl/canister-call

Canister query and call commands

Author: Hans

dfx/Cargo.lock

@@ -19,6 +19,7 @@ console = "0.7.7"
 flate2 = "1.0.11"
 futures = "0.1.28"
 indicatif = "0.12.0"
+rand = "0.7.2"
 reqwest = "0.9.20"
 serde = "1.0"
 serde_bytes = "0.11.2"

dfx/Cargo.toml

@@ -0,0 +1,53 @@
+use crate::lib::api_client::{call, Blob};
+use crate::lib::env::ClientEnv;
+use crate::lib::error::DfxResult;
+use crate::lib::CanisterId;
+use crate::util::clap::validators;
+use clap::{App, Arg, ArgMatches, SubCommand};
+use tokio::runtime::Runtime;
+
+pub fn construct() -> App<'static, 'static> {
+    SubCommand::with_name("call")
+        .about("Call a canister.")
+        .arg(
+            Arg::with_name("canister")
+                .takes_value(true)
+                .help("The canister ID (a number) to call.")
+                .required(true)
+                .validator(validators::is_canister_id),
+        )
+        .arg(
+            Arg::with_name("method_name")
+                .help("The method name file to use.")
+                .required(true),
+        )
+        .arg(
+            Arg::with_name("arguments")
+                .help("Arguments to pass to the method.")
+                .takes_value(true)
+                .multiple(true),
+        )
+}
+
+pub fn exec<T>(env: &T, args: &ArgMatches<'_>) -> DfxResult
+where
+    T: ClientEnv,
+{
+    // Read the config.
+    let canister_id = args.value_of("canister").unwrap().parse::<CanisterId>()?;
+    let method_name = args.value_of("method_name").unwrap();
+    let arguments: Option<Vec<&str>> = args.values_of("arguments").map(|args| args.collect());
+
+    let client = env.get_client();
+    let install = call(
+        client,
+        canister_id,
+        method_name.to_owned(),
+        arguments.map(|args| Blob(Vec::from(args[0]))),
+    );
+
+    let mut runtime = Runtime::new().expect("Unable to create a runtime");
+    runtime.block_on(install)?;
+
+    Ok(())
+}

dfx/src/commands/call.rs

@@ -1,16 +1,12 @@
 use crate::lib::api_client::{install_code, Blob};
 use crate::lib::env::{ClientEnv, ProjectConfigEnv};
 use crate::lib::error::DfxResult;
+use crate::lib::CanisterId;
+use crate::util::clap::validators;
 use clap::{App, Arg, ArgMatches, SubCommand};
 use std::path::PathBuf;
 use tokio::runtime::Runtime;
 
-fn is_number(v: String) -> Result<(), String> {
-    v.parse::<u64>()
-        .map_err(|_| String::from("The value must be a number."))
-        .map(|_| ())
-}
-
 pub fn construct() -> App<'static, 'static> {
     SubCommand::with_name("install")
         .about("Install a canister.")
@@ -19,7 +15,7 @@ pub fn construct() -> App<'static, 'static> {
                 .takes_value(true)
                 .help("The canister ID (a number).")
                 .required(true)
-                .validator(is_number),
+                .validator(validators::is_canister_id),
         )
         .arg(
             Arg::with_name("wasm")
@@ -36,7 +32,7 @@ where
     let config = env.get_config().unwrap();
     let project_root = config.get_path().parent().unwrap();
 
-    let canister_id = args.value_of("canister").unwrap().parse::<u64>()?;
+    let canister_id = args.value_of("canister").unwrap().parse::<CanisterId>()?;
     let wasm_path = args.value_of("wasm").unwrap();
     let wasm_path = PathBuf::from(project_root).join(wasm_path);
 

dfx/src/commands/canister/call.rs

@@ -3,13 +3,19 @@ use crate::lib::env::{ClientEnv, ProjectConfigEnv};
 use crate::lib::error::{DfxError, DfxResult};
 use clap::{App, ArgMatches, SubCommand};
 
+mod call;
 mod install;
+mod query;
 
 fn builtins<T>() -> Vec<CliCommand<T>>
 where
     T: ClientEnv + ProjectConfigEnv,
 {
-    vec![CliCommand::new(install::construct(), install::exec)]
+    vec![
+        CliCommand::new(call::construct(), call::exec),
+        CliCommand::new(install::construct(), install::exec),
+        CliCommand::new(query::construct(), query::exec),
+    ]
 }
 
 pub fn construct<T>() -> App<'static, 'static>

dfx/src/commands/canister/install.rs

@@ -0,0 +1,69 @@
+use crate::lib::api_client::{query, Blob, QueryResponseReply, ReadResponse};
+use crate::lib::env::ClientEnv;
+use crate::lib::error::{DfxError, DfxResult};
+use crate::lib::CanisterId;
+use crate::util::clap::validators;
+use clap::{App, Arg, ArgMatches, SubCommand};
+use tokio::runtime::Runtime;
+
+pub fn construct() -> App<'static, 'static> {
+    SubCommand::with_name("query")
+        .about("Query a canister.")
+        .arg(
+            Arg::with_name("canister")
+                .takes_value(true)
+                .help("The canister ID (a number) to query.")
+                .required(true)
+                .validator(validators::is_canister_id),
+        )
+        .arg(
+            Arg::with_name("method_name")
+                .help("The name of the method to query.")
+                .required(true),
+        )
+        .arg(
+            Arg::with_name("arguments")
+                .help("Arguments to pass to the method.")
+                .takes_value(true)
+                .multiple(true),
+        )
+}
+
+pub fn exec<T>(env: &T, args: &ArgMatches<'_>) -> DfxResult
+where
+    T: ClientEnv,
+{
+    // Read the config.
+    let canister_id = args.value_of("canister").unwrap().parse::<CanisterId>()?;
+    let method_name = args.value_of("method_name").unwrap();
+    let arguments: Option<Vec<&str>> = args.values_of("arguments").map(|args| args.collect());
+
+    let client = env.get_client();
+    let install = query(
+        client,
+        canister_id,
+        method_name.to_owned(),
+        arguments.map(|args| Blob(Vec::from(args[0]))),
+    );
+
+    let mut runtime = Runtime::new().expect("Unable to create a runtime");
+    match runtime.block_on(install) {
+        Ok(ReadResponse::Pending) => {
+            println!("Pending");
+            Ok(())
+        }
+        Ok(ReadResponse::Replied {
+            reply: QueryResponseReply { arg: Blob(blob) },
+        }) => {
+            println!("{}", String::from_utf8_lossy(&blob));
+            Ok(())
+        }
+        Ok(ReadResponse::Rejected {
+            reject_code,
+            reject_message,
+        }) => Err(DfxError::ClientError(reject_code, reject_message)),
+        // TODO: remove this when moving to ic_http_api.
+        Ok(ReadResponse::Unknown) => Err(DfxError::Unknown("Unknown response".to_owned())),
+        Err(x) => Err(x),
+    }
+}

dfx/src/commands/canister/mod.rs

@@ -5,7 +5,6 @@ use crate::lib::error::DfxResult;
 use clap::ArgMatches;
 
 mod build;
-mod call;
 mod canister;
 mod new;
 mod start;
@@ -41,7 +40,6 @@ where
 {
     vec![
         CliCommand::new(build::construct(), build::exec),
-        CliCommand::new(call::construct(), call::exec),
         CliCommand::new(canister::construct::<T>(), canister::exec),
         CliCommand::new(new::construct(), new::exec),
         CliCommand::new(start::construct(), start::exec),