Merge pull request #294 from ardriveapp/dev

PE-1898: Release CLI v1.17.0

README.md

@@ -84,10 +84,11 @@ ardrive upload-file --wallet-file /path/to/my/wallet.json --parent-folder-id "f0
     8. [Limitations](#limitations)
 3. [Using the CLI](#using-the-cli)
     1. [CLI Help](#cli-help)
-    2. [Wallet Operations](#wallet-operations)
-    3. [Working With Entities](#working-with-entities)
+    2. [CLI Version](#cli-version)
+    3. [Wallet Operations](#wallet-operations)
+    4. [Working With Entities](#working-with-entities)
         1. [Dry Run](#dry-run)
-    4. [Working With Drives](#working-with-drives)
+    5. [Working With Drives](#working-with-drives)
         1. [Understanding Drive Hierarchies](#understanding-drive-hierarchies)
             1. [Fetching Drive Info](#drive-info)
         2. [Understanding Drive and File Keys](#understanding-drive-and-file-keys)
@@ -104,13 +105,13 @@ ardrive upload-file --wallet-file /path/to/my/wallet.json --parent-folder-id "f0
             1. [Get Share Links for Files in the Drive](#get-share-links)
             2. [Get Total Size of Files in the Drive](#get-total-size)
             3. [Get Total Count of Files in the Drive](#get-file-count)
-    5. [Working With Folders](#working-with-folders)
+    6. [Working With Folders](#working-with-folders)
         1. [Creating Folders](#creating-folders)
         2. [Moving Folders](#moving-folders)
         3. [Renaming Folders](#rename-folder)
         4. [Viewing Folder Metadata](#viewing-folder-metadata)
         5. [Listing Contents of a Folder](#listing-contents-of-a-folder)
-    6. [Working With Files](#working-with-files)
+    7. [Working With Files](#working-with-files)
         1. [Uploading a Single File](#uploading-a-single-file)
         2. [Download a Single File (BETA)](#download-file)
         3. [Rename a Single File](#rename-file)
@@ -129,7 +130,7 @@ ardrive upload-file --wallet-file /path/to/my/wallet.json --parent-folder-id "f0
         16. [Hosting a Webpage with Manifest](#hosting-a-webpage-with-manifest)
         17. [Uploading With a Custom Content Type](#custom-content-type)
         18. [Uploading a Custom Manifest](#custom-manifest)
-    7. [Other Utility Operations](#other-utility-operations)
+    8. [Other Utility Operations](#other-utility-operations)
         1. [Monitoring Transactions](#monitoring-transactions)
         2. [Dealing With Network Congestion](#dealing-with-network-congestion)
         3. [Check for network congestion before uploading](#check-congestion)
@@ -278,6 +279,15 @@ Learn to use any command:
 ardrive --help
 ```
 
+## CLI Version
+
+You can print out the version by running any of:
+
+```shell
+ardrive --version
+ardrive -V
+```
+
 ## Wallet Operations
 
 Browsing of ArDrive public data is possible without the need for an [Arweave wallet][kb-wallets]. However, for all write operations, or read operations without encryption/decryption keys, you'll need a wallet.

bats_test/base-reward/base-reward.bats

@@ -1,5 +1,7 @@
 #!/usr/bin/env bats
 
+bats_require_minimum_version 1.5.0
+
 # Support lib
 load '/home/node/packages/node_modules/bats-support/load.bash'
 # Assertions

bats_test/create-drive/create-drive.bats

@@ -1,5 +1,7 @@
 #!/usr/bin/env bats
 
+bats_require_minimum_version 1.5.0
+
 # Support lib
 load '/home/node/packages/node_modules/bats-support/load.bash'
 # Assertions
@@ -43,4 +45,4 @@ load '/home/node/packages/node_modules/bats-assert/load.bash'
 
 #     [ "${lines[0]}" = "${lines[1]}" ]
 #     assert_line -n 2 'null'
-# }
+# }

bats_test/create-drive/drive-name-validation.bats

@@ -1,5 +1,7 @@
 #!/usr/bin/env bats
 
+bats_require_minimum_version 1.5.0
+
 # Support lib
 load '/home/node/packages/node_modules/bats-support/load.bash'
 # Assertions

bats_test/downloads/drive-downloads/error_outputs.bats

@@ -1,5 +1,7 @@
 #!/usr/bin/env bats
 
+bats_require_minimum_version 1.5.0
+
 # Support lib
 load '/home/node/packages/node_modules/bats-support/load.bash'
 # File methods. DEPENDS on SUPPORT lib.

bats_test/downloads/drive-downloads/happy_paths.bats

@@ -1,5 +1,7 @@
 #!/usr/bin/env bats
 
+bats_require_minimum_version 1.5.0
+
 # Support lib
 load '/home/node/packages/node_modules/bats-support/load.bash'
 # File methods. DEPENDS on SUPPORT lib.

bats_test/downloads/file-downloads/public_files.bats

@@ -1,5 +1,7 @@
 #!/usr/bin/env bats
 
+bats_require_minimum_version 1.5.0
+
 # Support lib
 load '/home/node/packages/node_modules/bats-support/load.bash'
 # File methods. DEPENDS on SUPPORT lib.

bats_test/downloads/folder-downloads/error_outputs.bats

@@ -1,5 +1,7 @@
 #!/usr/bin/env bats
 
+bats_require_minimum_version 1.5.0
+
 # Support lib
 load '/home/node/packages/node_modules/bats-support/load.bash'
 # File methods. DEPENDS on SUPPORT lib.

bats_test/downloads/folder-downloads/happy_paths.bats

@@ -1,5 +1,7 @@
 #!/usr/bin/env bats
 
+bats_require_minimum_version 1.5.0
+
 # Support lib
 load '/home/node/packages/node_modules/bats-support/load.bash'
 # File methods. DEPENDS on SUPPORT lib.

bats_test/generate-wallet/generate-wallet.bats

@@ -1,12 +1,14 @@
 #!/usr/bin/env bats
 
+bats_require_minimum_version 1.5.0
+
 # Support lib
 load '/home/node/packages/node_modules/bats-support/load.bash'
 # Assertions
 load '/home/node/packages/node_modules/bats-assert/load.bash'
 
 @test "generate-wallet creates canonical wallet" {
-    
+
     run -0 bash -c "yarn ardrive generate-wallet -s 'this is an example twelve word seed phrase that you could use' | jq .kty,.n,.e,.d,.p,.q,.dp,.dq,.qi,.kid"
 
     assert_line -n 0 '"RSA"'
@@ -22,11 +24,11 @@ load '/home/node/packages/node_modules/bats-assert/load.bash'
 }
 
 @test "generate-wallet rejects short and long seed phrases" {
-    
+
     run -1 bash -c "yarn ardrive generate-wallet -s 'invalid seed phrase'"
 
     assert_line -n 0 "Error: 'invalid seed phrase' is not a valid 12 word seed phrase!"
-    
+
     run -1 bash -c "yarn ardrive generate-wallet -s 'this invalid seed phrase has thirteen words and is expected to be rejected'"
 
     assert_line -n 0 "Error: 'this invalid seed phrase has thirteen words and is expected to be rejected' is not a valid 12 word seed phrase!"

bats_test/get-address/get-address.bats

@@ -1,23 +1,25 @@
 #!/usr/bin/env bats
 
+bats_require_minimum_version 1.5.0
+
 # Support lib
 load '/home/node/packages/node_modules/bats-support/load.bash'
 # Assertions
 load '/home/node/packages/node_modules/bats-assert/load.bash'
 
 @test "get-address finds the correct address of a canonical seed phrase" {
-    
+
     run -0 bash -c "yarn ardrive get-address -s 'this is an example twelve word seed phrase that you could use'"
 
     assert_line -n 0 'HTTn8F92tR32N8wuo-NIDkjmqPknrbl10JWo5MZ9x2k'
 }
 
 @test "get-address rejects short and long seed phrases" {
-    
+
     run -1 bash -c "yarn ardrive get-address -s 'invalid seed phrase'"
 
     assert_line -n 0 "Error: 'invalid seed phrase' is not a valid 12 word seed phrase!"
-    
+
     run -1 bash -c "yarn ardrive get-address -s 'this invalid seed phrase has thirteen words and is expected to be rejected'"
 
     assert_line -n 0 "Error: 'this invalid seed phrase has thirteen words and is expected to be rejected' is not a valid 12 word seed phrase!"

bats_test/get-mempool/get-mempool.bats

@@ -1,5 +1,7 @@
 #!/usr/bin/env bats
 
+bats_require_minimum_version 1.5.0
+
 # Support lib
 load '/home/node/packages/node_modules/bats-support/load.bash'
 # Assertions

bats_test/help/base-reward.bats

@@ -1,5 +1,7 @@
 #!/usr/bin/env bats
 
+bats_require_minimum_version 1.5.0
+
 # Support lib
 load '/home/node/packages/node_modules/bats-support/load.bash'
 # Assertions

bats_test/help/get-mempool.bats

@@ -1,5 +1,7 @@
 #!/usr/bin/env bats
 
+bats_require_minimum_version 1.5.0
+
 # Support lib
 load '/home/node/packages/node_modules/bats-support/load.bash'
 # Assertions

bats_test/help/no_command.bats

@@ -1,8 +1,11 @@
 #!/usr/bin/env bats
 
+bats_require_minimum_version 1.5.0
+
 help="Usage: ardrive [command] [command-specific options]
 
 Options:
+  -V, --version              output the version number
   -h, --help                 display help for command
 
 Commands:
@@ -33,23 +36,24 @@ Commands:
   rename-drive [options]
   rename-file [options]
   rename-folder [options]
+  retry-tx [options]
   send-ar [options]
   send-tx [options]
   tx-status [options]
   upload-file [options]
   help [command]             display help for command"
 
 @test "'ardrive' with no input arguments prints general help with all expected commands" {
-    run -0 yarn ardrive
-    [[ "$output" = "$help" ]]
+  run -0 yarn ardrive
+  [[ "$output" = "$help" ]]
 }
 
 @test "'ardrive -h' prints general help with all expected commands" {
-    run -0 yarn ardrive -h
-    [[ "$output" = "$help" ]]
+  run -0 yarn ardrive -h
+  [[ "$output" = "$help" ]]
 }
 
 @test "'ardrive --help' prints general help with all expected commands" {
-    run -0 yarn ardrive --help
-    [[ "$output" = "$help" ]]
+  run -0 yarn ardrive --help
+  [[ "$output" = "$help" ]]
 }

bats_test/rename/rename-drive/rename_public_drive.bats

@@ -1,5 +1,7 @@
 #!/usr/bin/env bats
 
+bats_require_minimum_version 1.5.0
+
 # Support lib
 load '/home/node/packages/node_modules/bats-support/load.bash'
 # File methods. DEPENDS on SUPPORT lib.

bats_test/rename/rename-file/rename_public_file.bats

@@ -1,5 +1,7 @@
 #!/usr/bin/env bats
 
+bats_require_minimum_version 1.5.0
+
 # Support lib
 load '/home/node/packages/node_modules/bats-support/load.bash'
 # File methods. DEPENDS on SUPPORT lib.

bats_test/rename/rename-folder/rename_public_folder.bats

@@ -1,5 +1,7 @@
 #!/usr/bin/env bats
 
+bats_require_minimum_version 1.5.0
+
 # Support lib
 load '/home/node/packages/node_modules/bats-support/load.bash'
 # File methods. DEPENDS on SUPPORT lib.
@@ -18,7 +20,6 @@ load './rename_same_name.sh'
 # Constants
 load '../../constants.sh'
 
-
 DIR="$(cd "$(dirname "$BATS_TEST_FILENAME")" >/dev/null 2>&1 && pwd)"
 
 setup_file() {

bats_test/upload-file/file-name-validation.bats

@@ -1,5 +1,7 @@
 #!/usr/bin/env bats
 
+bats_require_minimum_version 1.5.0
+
 # Support lib
 load '/home/node/packages/node_modules/bats-support/load.bash'
 # Assertions

bats_test/upload-file/reward-test.bats

@@ -1,5 +1,7 @@
 #!/usr/bin/env bats
 
+bats_require_minimum_version 1.5.0
+
 # Support lib
 load '/home/node/packages/node_modules/bats-support/load.bash'
 # Assertions
@@ -18,4 +20,3 @@ setup_file() {
 
     [ "$rewardFromUpload" = "$rewardFromNetwork" ]
 }
-

bats_test/upload-file/single-bundled-files.bats

@@ -1,5 +1,7 @@
 #!/usr/bin/env bats
 
+bats_require_minimum_version 1.5.0
+
 # Support lib
 load '/home/node/packages/node_modules/bats-support/load.bash'
 # Assertions
@@ -19,7 +21,6 @@ setup_file() {
     cd /home/node/ardrive-cli
 }
 
-
 @test "upload-file creates a bundled transaction by default" {
     run -0 bash -c "yarn ardrive upload-file --dry-run --local-path '/home/node/10Chunks.txt' -F $PUB_FOLD_ID -w $WALLET | jq '.created[] .type'"
 
@@ -49,7 +50,7 @@ setup_file() {
     assert_line -n 1 '"file"'
     assert_line -n 2 '"bundle"'
     assert_line -n 3 ''
-    
+
 }
 
 @test "upload-file used on a bulk folder returns the expected results" {

bats_test/version/version.bats

@@ -0,0 +1,21 @@
+#!/usr/bin/env bats
+
+bats_require_minimum_version 1.5.0
+
+EXPECTED_VERSION=$(jq -r '.version' ./package.json)
+
+@test "'ardrive --version' prints the version" {
+    run -0 yarn ardrive --version
+    [[ "$output" = "$EXPECTED_VERSION" ]]
+
+}
+
+@test "'ardrive -V' prints the version" {
+    run -0 yarn ardrive -V
+    [[ "$output" = "$EXPECTED_VERSION" ]]
+}
+
+@test "'ardrive <SOME COMMAND> -V' ONLY prints the version" {
+    run -0 yarn ardrive tx-status -V
+    [[ "$output" = "$EXPECTED_VERSION" ]]
+}

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "ardrive-cli",
-	"version": "1.16.0",
+	"version": "1.17.0",
 	"description": "The ArDrive Command Line Interface (CLI is a Node.js application for terminal-based ArDrive workflows. It also offers utility operations for securely interacting with Arweave wallets and inspecting various Arweave blockchain conditions.",
 	"main": "./lib/index.js",
 	"bin": {

src/CLICommand/cli.ts

@@ -21,6 +21,7 @@ export abstract class CliApiObject {
 	abstract usage(usage: string): CliApiObject;
 	abstract outputHelp(): void;
 	abstract exitOverride(callback?: (commanderError: CommanderError) => void): CliApiObject;
+	abstract version(str: string, flags?: string, description?: string): CliApiObject;
 }
 
 export type ActionCallback = (options: ParsedParameters) => ActionReturnType; // commander action callback

src/CLICommand/cli_command.test.ts

@@ -63,13 +63,20 @@ class TestCliApiObject {
 	name = stub(this.program, 'name').returnsThis();
 	usage = stub(this.program, 'usage').returnsThis();
 	outputHelp = stub(this.program, 'outputHelp');
+	version = stub(this.program, 'version');
 }
 
 describe('CLICommand class', () => {
 	let stubbedProgram: SinonStubbedInstance<CliApiObject>;
 	const program: CliApiObject = new Command() as CliApiObject;
 
 	before(() => {
+		program.name('ardrive');
+		program.addHelpCommand(true);
+		program.usage('[command] [command-specific options]');
+		// Override the commander's default exit (process.exit()) to avoid abruptly interrupting the script execution
+		program.exitOverride();
+
 		stubbedProgram = new TestCliApiObject(program);
 	});