[cleanup] change generate-json-rpc-spec to cargo example instead of b…

…inary (MystenLabs#3103)

* don't need to build generate-json-rpc-spec binary

* fixup after rebase

* fixup after rebase

* minor doc fix

* minor doc fix

Cargo.toml

@@ -1,7 +1,6 @@
 [workspace]
 resolver = "2"
 members = [
-    "crates/generate-json-rpc-spec",
     "crates/sui",
     "crates/sui-adapter",
     "crates/sui-adapter-transactional-tests",

crates/sui-open-rpc/Cargo.toml

@@ -10,3 +10,26 @@ edition = "2021"
 schemars = "0.8.10"
 serde = "1.0.138"
 workspace-hack = { path = "../workspace-hack"}
+
+[dev-dependencies]
+anyhow = { version = "1.0.58", features = ["backtrace"] }
+clap = { version = "3.1.17", features = ["derive"] }
+pretty_assertions = "1.2.0"
+serde_json = "1.0.80"
+tokio = { version = "1.18.2", features = ["full"] }
+hyper = { version = "0.14.18", features = ["full"] }
+
+sui = { path = "../sui" }
+sui-json-rpc = { path = "../sui-json-rpc" }
+sui-json-rpc-api = { path = "../sui-json-rpc-api" }
+sui-json = { path = "../sui-json" }
+sui-types = { path = "../sui-types" }
+sui-config = { path = "../sui-config" }
+test-utils = { path = "../test-utils" }
+
+move-package = { git = "https://github.com/move-language/move", rev = "7733658048a8bc80e9ba415b8c99aed9234eaa5f" }
+
+[[example]]
+name = "generate-json-rpc-spec"
+path = "src/generate_json_rpc_spec.rs"
+test = false

crates/generate-json-rpc-spec/src/main.rs → crates/sui-open-rpc/src/generate_json_rpc_spec.rs

@@ -55,25 +55,15 @@ struct Options {
     action: Action,
 }
 
-const FILE_PATH: &str = concat!(
-    env!("CARGO_MANIFEST_DIR"),
-    "/../sui-open-rpc/spec/openrpc.json",
-);
-
-const OBJECT_SAMPLE_FILE_PATH: &str = concat!(
-    env!("CARGO_MANIFEST_DIR"),
-    "/../sui-open-rpc/samples/objects.json",
-);
-
-const TRANSACTION_SAMPLE_FILE_PATH: &str = concat!(
-    env!("CARGO_MANIFEST_DIR"),
-    "/../sui-open-rpc/samples/transactions.json",
-);
-
-const OWNED_OBJECT_SAMPLE_FILE_PATH: &str = concat!(
-    env!("CARGO_MANIFEST_DIR"),
-    "/../sui-open-rpc/samples/owned_objects.json",
-);
+const FILE_PATH: &str = concat!(env!("CARGO_MANIFEST_DIR"), "/spec/openrpc.json",);
+
+const OBJECT_SAMPLE_FILE_PATH: &str = concat!(env!("CARGO_MANIFEST_DIR"), "/samples/objects.json",);
+
+const TRANSACTION_SAMPLE_FILE_PATH: &str =
+    concat!(env!("CARGO_MANIFEST_DIR"), "/samples/transactions.json",);
+
+const OWNED_OBJECT_SAMPLE_FILE_PATH: &str =
+    concat!(env!("CARGO_MANIFEST_DIR"), "/samples/owned_objects.json",);
 
 #[tokio::main]
 async fn main() {

crates/sui-open-rpc/tests/generate-spec.rs

@@ -0,0 +1,21 @@
+// Copyright (c) 2022, Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+
+#[test]
+fn test_json_rpc_spec() {
+    // If this test breaks and you intended a json rpc schema change, you need to run to get the fresh schema:
+    // # cargo -q run --example generate-json-rpc-spec -- record
+    let status = std::process::Command::new("cargo")
+        .current_dir("..")
+        .args(&["run", "--example", "generate-json-rpc-spec", "--"])
+        .arg("test")
+        .status()
+        .expect("failed to execute process");
+    assert!(
+        status.success(),
+        "\n\
+If this test breaks and you intended a json rpc schema change, you need to run to get the fresh schema:\n\
+cargo -q run --example generate-json-rpc-spec -- record\n\
+        "
+    );
+}