Add ic-repl and test fatfs example (#12)

* Add ic-repl and test fatfs example

* Restore crate-type for Wasm build products
* Revert back to using custom canister type
* Remove src directory from examples
* Provide interface in .did file
* Change fatfs ls return type
* Update how Rust packages are built

* Update DFINITY SDK for patchelfing fix

* Update DFINITY SDK for nativeBuildInputs fix

* Attempt to fix build inputs

* Try patchelfing binaries on linux

* Try using --emulator

* Don't use emulator, try different patchelfing

* Update dfinity-sdk for unconditional patchelfing

* Update dfinity-sdk for icx-proxy patchelfing

* Try 0.9.2

* Update dfinity-sdk to remove patchelfing

* Update dfinity-sdk to restore patchelfing

* Revert back to 0.8.4

* Update dfinity-sdk to remove patchelfing

* Remove Linux from the build matrix for now

* Revert "Remove Linux from the build matrix for now"

This reverts commit 4fe71be.

* Only run example tests on darwin for now

Author: paulyoung

Diff for: Cargo.lock

@@ -2,5 +2,5 @@
 members = [
     "crates/icfs",
     "crates/icfs-fatfs",
-    "examples/src/fatfs",
+    "examples/fatfs",
 ]

Diff for: Cargo.toml

@@ -8,6 +8,7 @@ authors = ["Paul Young <[email protected]>"]
 
 [lib]
 path = "lib.rs"
+crate-type = ["cdylib", "lib"]
 
 [dependencies]
 fatfs = { git = "https://github.com/rafalh/rust-fatfs", rev = "87fc1ed5074a32b4e0344fcdde77359ef9e75432" }

Diff for: crates/icfs-fatfs/Cargo.toml

@@ -8,6 +8,7 @@ authors = ["Paul Young <[email protected]>"]
 
 [lib]
 path = "lib.rs"
+crate-type = ["cdylib", "lib"]
 
 [dependencies]
 ic-cdk = { git = "https://github.com/dfinity/cdk-rs.git", rev = "a253119adb08929b6304d007ee0a6a37960656ed" }

Diff for: crates/icfs/Cargo.toml

@@ -3,9 +3,10 @@
   "dfx": "0.8.4",
   "canisters": {
     "fatfs": {
-      "type": "rust",
-      "package": "fatfs_example",
-      "candid": "examples/src/fatfs/fatfs.did"
+      "type": "custom",
+      "build": "nix build '.#fatfs-example'",
+      "candid": "examples/fatfs/fatfs.did",
+      "wasm": "result/lib/fatfs_example.wasm"
     }
   },
   "networks": {

Diff for: dfx.json

@@ -1,5 +1,5 @@
 [package]
-name = "fatfs_example"
+name = "fatfs-example"
 version = "0.1.0"
 edition = "2018"
 authors = ["Paul Young <[email protected]>"]
@@ -8,12 +8,12 @@ authors = ["Paul Young <[email protected]>"]
 
 [lib]
 path = "lib.rs"
-crate-type = ["cdylib"]
+crate-type = ["cdylib", "lib"]
 
 [dependencies]
 fatfs = { git = "https://github.com/rafalh/rust-fatfs", rev = "87fc1ed5074a32b4e0344fcdde77359ef9e75432" }
 fscommon = "0.1"
 ic-cdk = { git = "https://github.com/dfinity/cdk-rs.git", rev = "a253119adb08929b6304d007ee0a6a37960656ed" }
 ic-cdk-macros = "0.3"
-icfs = { path = "../../../crates/icfs" }
-icfs-fatfs = { path = "../../../crates/icfs-fatfs" }
+icfs = { path = "../../crates/icfs" }
+icfs-fatfs = { path = "../../crates/icfs-fatfs" }

Diff for: examples/src/fatfs/Cargo.toml renamed to examples/fatfs/Cargo.toml

@@ -0,0 +1,5 @@
+service : {
+  ls : () -> (vec text) query;
+  write_file : (filename : text, contents : text) -> ();
+  read_file : (filename : text) -> (text) query;
+}

Diff for: examples/fatfs/fatfs.did

@@ -57,11 +57,11 @@ thread_local! {
 }
 
 #[query]
-fn ls() -> String {
+fn ls() -> Vec<String> {
     _ls().unwrap()
 }
 
-fn _ls() -> std::io::Result<String> {
+fn _ls() -> std::io::Result<Vec<String>> {
     FS.with(|fs| {
         let fs = fs.borrow();
         let root_dir = fs.root_dir();
@@ -73,7 +73,7 @@ fn _ls() -> std::io::Result<String> {
                     .map_err(|error| std::io::Error::new(std::io::ErrorKind::Other, error))
             })
             .collect();
-        entries.map(|entries| entries.join("\n"))
+        entries
     })
 }
 

Diff for: examples/src/fatfs/lib.rs renamed to examples/fatfs/lib.rs

@@ -0,0 +1,29 @@
+import fatfs = "rrkah-fqaaa-aaaaa-aaaaq-cai" as "fatfs.did";
+// import fatfs = "ai7t5-aibaq-aaaaa-aaaaa-c" as "fatfs.did";
+
+let result = call fatfs.ls();
+assert result == vec {};
+
+let result = call fatfs.write_file("hello.txt", "Hello, World!");
+assert result == null;
+
+let result = call fatfs.ls();
+assert result == vec { "hello.txt"; };
+
+let result = call fatfs.read_file("hello.txt");
+assert result == "Hello, World!";
+
+let result = call fatfs.write_file("hello.txt", "Hello!");
+assert result == null;
+
+let result = call fatfs.read_file("hello.txt");
+assert result == "Hello!";
+
+let result = call fatfs.write_file("goodbye.txt", "Goodbye!");
+assert result == null;
+
+let result = call fatfs.ls();
+assert result == vec { "hello.txt"; "goodbye.txt"; };
+
+let result = call fatfs.read_file("goodbye.txt");
+assert result == "Goodbye!";

Diff for: examples/fatfs/test.ic-repl

@@ -4,6 +4,10 @@
       url = "github:paulyoung/nixpkgs-dfinity-sdk";
       flake = false;
     };
+    ic-repl-src = {
+      url = "github:chenyan2002/ic-repl";
+      flake = false;
+    };
     flake-utils.url = "github:numtide/flake-utils";
 
     # https://github.com/nix-community/naersk/pull/211
@@ -19,6 +23,7 @@
     nixpkgs,
     dfinity-sdk,
     flake-utils,
+    ic-repl-src,
     naersk,
     nixpkgs-mozilla,
   }:
@@ -34,8 +39,8 @@
         # Get a specific rust version
         mozilla = pkgs.callPackage (nixpkgs-mozilla + "/package-set.nix") {};
         rust = (mozilla.rustChannelOf {
-          channel = "1.55.0";
-          sha256 = "HNIlEerJvk6sBfd8zugzwSgSiHcQH8ZbqWQn9BGfmpo=";
+          channel = "1.56.0";
+          sha256 = "L1e0o7azRjOHd0zBa+xkFnxdFulPofTedSTEYZSjj2s=";
           # sha256 = pkgs.lib.fakeSha256;
         }).rust.override {
           extensions = [
@@ -67,40 +72,94 @@
           sdkSystem = system;
         })."0.8.4";
 
-        buildRustPackage = name:
+        buildRustPackage = name: root: attrs:
           let
-            defaultArgs = [
-              "--target" "wasm32-unknown-unknown"
-            ];
             packageArgs = [
               "--package" name
             ];
           in
-            naersk-lib.buildPackage {
-              root = ./.;
-              cargoBuildOptions = x: x ++ defaultArgs ++ packageArgs;
-              cargoTestOptions = x: x ++ defaultArgs ++ packageArgs;
+            naersk-lib.buildPackage ({
+              inherit root;
               compressTarget = true;
-              copyBins = false;
+              copyBins = true;
+              copyLibs = true;
               copyTarget = true;
-            };
+            } // attrs);
+
+        buildLocalRustPackage = name:
+          let
+            options = [
+              "--package" name
+              "--target" "wasm32-unknown-unknown"
+            ];
+          in
+            buildRustPackage name ./. {
+              cargoBuildOptions = x: x ++ options;
+              cargoTestOptions = x: x ++ options;
+              copyBins = false;
+            }
+        ;
+
+        ic-repl =
+          buildRustPackage "ic-repl" ic-repl-src {
+            buildInputs = [
+              pkgs.libiconv
+
+              # https://nixos.wiki/wiki/Rust#Building_the_openssl-sys_crate
+              pkgs.openssl_1_1
+              pkgs.pkgconfig
+            ] ++ pkgs.lib.optionals pkgs.stdenv.isDarwin [
+              pkgs.darwin.apple_sdk.frameworks.Security
+            ];
+          };
+
+        buildExampleTest = name: package: pkgs.runCommand "${name}-example-test" {
+          buildInputs = [
+            dfinitySdk
+            ic-repl
+            pkgs.jq
+          ];
+        } ''
+          HOME=$TMP
+          cp -R ${package}/. result
+          mkdir -p examples/${name}
+          cp -R ${./examples}/${name}/. examples/${name}
+
+          cp ${./dfx.json} dfx.json
+          jq '.canisters = (.canisters | map_values(.build = "echo"))' dfx.json > new.dfx.json
+          mv new.dfx.json dfx.json
+
+          dfx start --background
+          dfx deploy
+          ic-repl --replica local examples/${name}/test.ic-repl
+          dfx stop
+
+          touch $out
+        '';
+
+        packages = {
+          icfs = buildLocalRustPackage "icfs";
+          icfs-fatfs = buildLocalRustPackage "icfs-fatfs";
+          fatfs-example = buildLocalRustPackage "fatfs-example";
+        };
       in
-        rec {
+        {
           # `nix build`
           defaultPackage = pkgs.runCommand "all" {
             buildInputs = pkgs.lib.attrValues packages;
           } ''
             touch $out
           '';
 
-          packages.icfs = buildRustPackage "icfs";
-          packages.icfs-fatfs = buildRustPackage "icfs-fatfs";
-          packages.fatfs-example = buildRustPackage "fatfs_example";
+          packages = packages // pkgs.lib.optionalAttrs pkgs.stdenv.isDarwin {
+            fatfs-example-test = buildExampleTest "fatfs" packages.fatfs-example;
+          };
 
           # `nix develop`
           devShell = pkgs.mkShell {
             buildInputs = [
               dfinitySdk
+              ic-repl
             ] ++ pkgs.lib.optionals pkgs.stdenv.isDarwin [
               pkgs.libiconv
             ];