Replace bash test to TS using shelljs

README-dev.md

@@ -38,19 +38,19 @@ If your IDE is reporting Typescript issues after compiling the plugin, you may w
 
 A test case is added by creating a directory in a subdirectory of a test group in the `test` directory. E.g. `declare-test` is a test case in the `general-tests` test group. A test case should contain:
 
--   a `check.sh` script which does the testing logic
+-   a `check.ts` script which does the testing logic
 -   a `network.json` file which specifies on which networks should the test case be run
 -   a `hardhat.config.ts` file will be used
 
-The main testing script is `scripts/test.sh`. It iterates over the test cases the test group specified by the `TEST_SUBDIR` environment variable.
+The main testing script is `scripts/test.ts`. It iterates over the test cases the test group specified by the `TEST_SUBDIR` environment variable.
 
 ### Executing tests locally
 
 When running tests locally, you probably don't want to run the whole `test.sh` script as it may alter your development environment. However, you can run individual tests by:
 
 -   positioning yourself in your example repository
 -   configuring the `hardhat.config.ts`
--   executing the `check.sh` script (potentially modifying it to address path differences)
+-   executing the `check.ts` script (potentially modifying it to address path differences)
 
 To run all tests, you can use the `test-` scripts defined in `package.json`. For the tests to work, you may need to set the values from `config.json` as environment variables. You should also have the [`jq` CLI tool](https://stedolan.github.io/jq/) installed.
 

package.json

@@ -39,6 +39,7 @@
         "exit-hook": "2.2.1",
         "form-data": "^4.0.0",
         "glob": "^7.2.0",
+        "shelljs": "^0.8.5",
         "starknet": "^3.15.0"
     },
     "peerDependencies": {
@@ -50,6 +51,7 @@
         "@types/glob": "^7.2.0",
         "@types/mocha": "^9.0.0",
         "@types/node": "^16.11.26",
+        "@types/shelljs": "^0.8.11",
         "@typescript-eslint/eslint-plugin": "^5.8.1",
         "@typescript-eslint/parser": "^5.8.1",
         "chai": "^4.3.4",

scripts/test.sh

@@ -9,7 +9,7 @@ CONFIG_FILE_NAME="hardhat.config.ts"
 
 # setup example repo
 rm -rf starknet-hardhat-example
-git clone -b plugin --single-branch [email protected]:Shard-Labs/starknet-hardhat-example.git
+git clone -b resolveJsonModule --single-branch [email protected]:Shard-Labs/starknet-hardhat-example.git
 cd starknet-hardhat-example
 git log -n 1
 npm ci
@@ -69,7 +69,11 @@ function iterate_dir() {
 
         [ "$network" == "devnet" ] && ../scripts/run-devnet.sh
 
-        NETWORK="$network" "$test_case/check.sh" && success=$((success + 1)) || echo "Test failed!"
+        # check if test_case/check.ts exists
+        if [ -f "$test_case/check.ts" ]; then
+            # run the test
+            NETWORK="$network" npx mocha -r ts-node/register "$test_case/check.ts" && success=$((success + 1)) || echo "Test failed!"
+        fi
 
         rm -rf starknet-artifacts
         git checkout --force

test/configuration-tests/with-account-compilation-option/check.ts

@@ -0,0 +1,16 @@
+import { copyFileSync } from "fs";
+import path from "path";
+import { hardhatStarknetCompile } from "../../utils/cli-functions";
+import { contains } from "../../utils/utils";
+
+const contractName = "dummy_account.cairo";
+const contractPath = path.join("contracts", contractName);
+
+const expected = "Use the --account-contract flag to compile an account contract.";
+
+console.log("Testing rejection of compilation without the account flag");
+copyFileSync(path.join(__dirname, contractName), contractPath);
+const execution = hardhatStarknetCompile(contractPath.split(" "), true);
+contains(execution.stderr, expected);
+console.log("Success");
+hardhatStarknetCompile(`${contractPath} --account-contract`.split(" "));

test/configuration-tests/with-artifacts-path/check.ts

@@ -0,0 +1,8 @@
+import { hardhatStarknetCompile, hardhatStarknetDeploy } from "../../utils/cli-functions";
+import { ensureEnvVar, rmrfSync } from "../../utils/utils";
+
+const network = ensureEnvVar("NETWORK");
+
+hardhatStarknetCompile("contracts/contract.cairo".split(" "));
+hardhatStarknetDeploy(`--starknet-network ${network} my-starknet-artifacts/contracts/contract.cairo/ --inputs 10`.split(" "));
+rmrfSync("my-starknet-artifacts");

test/configuration-tests/with-cairo-version/check.ts

@@ -0,0 +1,7 @@
+import { hardhatStarknetCompile, hardhatStarknetDeploy } from "../../utils/cli-functions";
+import { ensureEnvVar } from "../../utils/utils";
+
+const network = ensureEnvVar("NETWORK");
+
+hardhatStarknetCompile("contracts/contract.cairo".split(" "));
+hardhatStarknetDeploy(`starknet-artifacts/contracts/contract.cairo --starknet-network ${network} --inputs 10`.split(" "));

test/configuration-tests/with-cli-network/check.ts

@@ -0,0 +1,9 @@
+import { hardhatStarknetRun, hardhatStarknetTest } from "../../utils/cli-functions";
+
+// Test how --starknet-network can be specified through CLI while at the same time
+// overriding hardhat.config specification.
+// It would be sufficient to run this test just once and not for both alpha and devnet.
+// Only tests if --starknet-network is accepted, not if the correct network is targeted.
+
+hardhatStarknetRun("--no-compile scripts/compile-contract.ts".split(" "));
+hardhatStarknetTest("--no-compile --starknet-network devnet test/quick-test.ts".split(" "));