custom preset cached on target

--preset bootstrap is not the default anymore.
Moved assemblies to own common folder
Updated README.md
Improved configuration testing
Removed unused certificate files after generating
Removed unused genesis state files after generating
singleCurrency and dualCurrency presets.
nemesis seed is shared across the different nodes avoiding duplicated files.

.prettierignore

@@ -1 +0,0 @@
-/test/reports/**/*.json

CHANGELOG.md

@@ -12,6 +12,9 @@ The changelog format is based on [Keep a Changelog](https://keepachangelog.com/e
 | ---------------- | ------- | ------------------------------------------------------------------ |
 | Symbol Bootstrap | v1.1.0  | [symbol-bootstrap](https://www.npmjs.com/package/symbol-bootstrap) |
 
+-   The `bootstrap` preset is not the default anymore. The name must be provided via --preset or as a custom preset field. 
+-   When upgrading, the --customPreset param is now only required if there is a configuration change, since
+    the properties from the original custom preset are fully cached in the target folder.
 -   Added `wizard` command.
 -   Added `pack` command.
 -   Explorer `1.1.0` upgrade.

README.md

@@ -16,8 +16,7 @@ Symbol CLI tool that allows you creating, configuring and running Symbol's c
 * [Key benefits:](#key-benefits)
 * [Concepts](#concepts)
 * [Requirements](#requirements)
-* [Usage](#usage)
-* [General Usage](#general-usage)
+* [Installation](#installation)
 * [Wizard](#wizard)
 * [E2E Testing support](#e2e-testing-support)
 * [Development](#development)
@@ -27,12 +26,7 @@ Symbol CLI tool that allows you creating, configuring and running Symbol's c
 
 # Why this tool?
 
-This tool has been created to address the problems defined in Symbol's [NIP11](https://github.com/nemtech/NIP/blob/main/NIPs/nip-0011.md).
-
-It replaces:
-
--   [catapult-service-bootstrap](https://github.com/nemtech/catapult-service-bootstrap)
--   [symbol-testnet-bootstrap](https://github.com/nemgrouplimited/symbol-service-bootstrap)
+This tool has been created to address the original problems defined in Symbol's [NIP11](https://github.com/nemtech/NIP/blob/main/NIPs/nip-0011.md).
 
 # Key benefits:
 
@@ -58,20 +52,26 @@ Yaml files that define the configuration and layout of the network and nodes. It
 Presets are defined at 4 levels from general to specific:
 
 -   Shared: Default configurations for all the networks.
--   Network: It defines the main preset of a given network, example: `bootstrap` or `testnet`.
--   Assembly: It defines a modification of a network, example: `testnet peer`, `tesnet dual`, `testnet api`. Assembly is required for some networks (like `testnet`).
+-   Network: It defines the configuration of a given network.
+-   Assembly: It defines a modification of a network selecting the services that the node will run.
 -   Custom: A user provided yml file (`--customPreset` param) that could override some or all properties in the out-of-the-box presets.
 
 Properties in each file override the previous values (by object deep merge).
 
-### Out-of-the-box presets:
+### Network Presets:
+
+-   [`mainnet`](presets/mainnet/network.yml): Used to created nodes' connected to Symbol's Mainnet network. The [nemesis block](presets/mainnet/seed/00000) is copied over.
+-   [`testnet`](presets/testnet/network.yml): Used to created nodes' connected to Symbol's Testnet network. The [nemesis block](presets/testnet/seed/00000) is copied over.
+-   [`dualCurrency`](presets/dualCurrency/network.yml): Used to create new private networks with dual currency configuration, network and harvest currencies. Nemesis block is generated.
+-   [`singleCurrency`](presets/singleCurrency/network.yml): Used to create private/user networks with a single network currency configuration, just main network currency. Nemesis block is generated.
 
--   `-p bootstrap`: Default [preset](https://github.com/nemtech/symbol-bootstrap/blob/main/presets/bootstrap/network.yml). It's a private network with 1 mongo database, 2 peers, 1 api and 1 rest gateway. Nemesis block is generated.
--   `-p bootstrap -a light`: A [light](https://github.com/nemtech/symbol-bootstrap/blob/main/presets/bootstrap/assembly-light.yml) network. It's a version of bootstrap preset with 1 mongo database, 1 dual peer and 1 rest gateway. Great for faster light e2e automatic testing. Nemesis block is generated.
--   `-p bootstrap -a full`: A [full](https://github.com/nemtech/symbol-bootstrap/blob/main/presets/bootstrap/assembly-full.yml) network. The default bootstrap preset plus 1 wallet, 1 explorer and 1 faucet. Great for demonstration purposes. Nemesis block is generated.
--   `-p testnet -a peer`: A [harvesting](https://github.com/nemtech/symbol-bootstrap/blob/main/presets/testnet/assembly-peer.yml) peer node that connects to the current public [testnet](https://github.com/nemtech/symbol-bootstrap/blob/main/presets/testnet/network.yml). [Nemesis block](https://github.com/nemtech/symbol-bootstrap/tree/main/presets/testnet/seed/00000) is copied over.
--   `-p testnet -a api`: A [api](https://github.com/nemtech/symbol-bootstrap/blob/main/presets/testnet/assembly-api.yml) peer node that connects to the current public [testnet](https://github.com/nemtech/symbol-bootstrap/blob/main/presets/testnet/network.yml) running its own mongo database and rest gateway. [Nemesis block](https://github.com/nemtech/symbol-bootstrap/tree/main/presets/testnet/seed/00000) is copied over.
--   `-p testnet -a dual`: A [dual](https://github.com/nemtech/symbol-bootstrap/blob/main/presets/testnet/assembly-dual.yml) haversting peer node that connects to the current public [testnet](https://github.com/nemtech/symbol-bootstrap/blob/main/presets/testnet/network.yml) running its own mongo database and rest gateway. [Nemesis block](https://github.com/nemtech/symbol-bootstrap/tree/main/presets/testnet/seed/00000) is copied over.
+### Assemblies:
+
+-   [`dual`](presets/assemblies/assembly-dual.yml): A standard dual node that contains 1 mongo database. 1 api node, 1 rest gateway, and 1 broker.
+-   [`peer`](presets/assemblies/assembly-peer.yml): A standard peer only node that contains 1 peer node.
+-   [`api`](presets/assemblies/assembly-api.yml): A standard api node that contains 1 mongo database. 1 api node, 1 rest gateway, and 1 broker.
+-   [`demo`](presets/assemblies/assembly-demo.yml): A dual node that contains an explorer, web wallet and faucet for test and demonstration purposes.
+-   [`multinode`](presets/assemblies/assembly-multinode.yml): An special assembly that contains 1 api node and 2 peer only nodes. This assembly is for testing, it showcases how a private network with 3 nodes runs.
 
 ### Custom preset:
 
@@ -81,7 +81,9 @@ Custom presets give Symbol Bootstrap its versatility. Check out the custom prese
 
 ## Target:
 
-The folder where the generated config, docker files and data are stored. The folder structure is:
+The folder where the generated config, docker files and data are stored.
+
+The folder structure is:
 
 -   `./preset.yml`: the final generated preset.yml that it's used to configure bootstrap, the nodes, docker, etc.
 -   `./addresses.yml`: randomly generated data that wasn't provided in the preset. e.g.: SSL keys, nodes' keys, nemesis accounts, generation hash seed, etc.
@@ -90,20 +92,18 @@ The folder where the generated config, docker files and data are stored. The fol
 -   `./nemesis`: The folder used to hold the nemesis block. Block 1 data is generated via `nemgen` tool for new networks. For existing network, it is copied over.
 -   `./databases`: the location where the mongo data is stored for the different database instances.
 -   `./docker`: the generated docker-compose.yml, mongo init scripts and server basic bash scripts.
+-   `./explorers`: the generated explorer configuration.
+-   `./wallets`: the generated wallet configuration.
 -   `./reports`: the location of the generated reports.
 
+Note: **The target folder should not be manually modified**. This tool may override any file in the target folder when doing upgrades. Any custom configuration should be provided via a custom preset. Check out the custom preset [guides](docs/presetGuides.md)!
+
 # Requirements
 
 -   Node 12.0.0+
 -   Docker 18.3.0+
 -   Docker Compose 1.25.0+
 
-Validate your environment by running:
-
-```
-symbol-bootstrap verify
-```
-
 Check your user can run docker without sudo:
 
 ```
@@ -118,7 +118,7 @@ Got permission denied while trying to connect to the Docker daemon socket at uni
 
 Please follow this [guide](https://www.digitalocean.com/community/questions/how-to-fix-docker-got-permission-denied-while-trying-to-connect-to-the-docker-daemon-socket).
 
-# Usage
+# Installation
 
 It's recommended to run the commands from en empty working dir.
 
@@ -145,20 +145,24 @@ USAGE
 ```
 <!-- usagestop -->
 
-# General Usage
+Validate your environment by running:
+
+```
+symbol-bootstrap verify
+```
 
 The general usage would be:
 
 ```
-symbol-bootstrap config -p bootstrap
+symbol-bootstrap config -p testnet -a dual
 symbol-bootstrap compose
 symbol-bootstrap run
 ```
 
 You can aggregate all these commands with this one liner:
 
 ```
-symbol-bootstrap start -p bootstrap
+symbol-bootstrap start -p testnet -a dual
 ```
 
 If you need to start fresh, you many need to sudo remove the target folder (docker volumes dirs may be created using sudo). Example:
@@ -167,6 +171,26 @@ If you need to start fresh, you many need to sudo remove the target folder (dock
 sudo rm -rf ./target
 ```
 
+## Examples
+
+Network presets and assemblies can be combined to generate different types of nodes. Some examples:
+
+-   `$ symbol-bootstrap start -p mainnet -a dual -c customPreset.yml`
+-   `$ symbol-bootstrap start -p testnet -a peer -c customPreset.yml`
+-   `$ symbol-bootstrap start -p testnet -a demo -c customPreset.yml`
+-   `$ symbol-bootstrap start -p dualCurrency -a multinode -c customPreset.yml`
+-   `$ symbol-bootstrap start -p dualCurrency -a demo -c customPreset.yml`
+-   `$ symbol-bootstrap start -p dualCurrency -a dual -c customPreset.yml`
+-   `$ symbol-bootstrap start -p singleCurrency -a multinode -c customPreset.yml`
+-   `$ symbol-bootstrap start -p singleCurrency -a demo -c customPreset.yml`
+
+Although some combinations can be done, they may not be really useful. Examples are running `mainnet` and `testnet` combined the `demo` or `multinode` assemblies.
+
+A custom network preset file can also be provided. This is useful when you have your own custom Symbol network, and you want other nodes to join.
+For this case, you provide your own `networkPreset.yml` and nemesis feed folder. The node admin can then run:
+
+-   `$ symbol-bootstrap start -p customNetworkPreset.yml -a dual -c customNodePreset.yml`
+
 # Wizard
 
 If this is your first time creating a node, it's recommended to use the Wizard. Just follow the instructions:
@@ -180,7 +204,7 @@ symbol-bootstrap wizard
 One use case of this CLI is client E2E testing support. If you are coding a Symbol client, you (Travis or Jenkins) can run e2e tests like:
 
 ```
-symbol-bootstrap start -p bootstrap --detached
+symbol-bootstrap start -p dualCurrency -a dual -c my_custom_preset.yml --detached --healthCheck
 YOUR TEST (e.g: npm run test, gradle test, selenium etc.)
 symbol-bootstrap stop
 ```
@@ -205,7 +229,7 @@ Your `package.json` can look like this:
 scripts": {
 ...
     "clean-network": "symbol-bootstrap clean",
-    "run-network": "symbol-bootstrap start -c ./output/my_custom_preset.yml --detached --healthCheck",
+    "run-network": "symbol-bootstrap start -p dualCurrency -a dual -c my_custom_preset.yml --detached --healthCheck",
     "run-stop": "symbol-bootstrap stop",
     "integration-test": "....some mocha/jest/etc tests running against localhost:3000 network....",
     "e2e": "npm run clean-network && npm run run-network && npm run integration-test && npm run stop-network",
@@ -221,7 +245,7 @@ npm run e2e
 
 ## Node client E2E via API:
 
-Alternatively, you can use the [BootstrapService](https://github.com/nemtech/symbol-bootstrap/blob/main/src/service/BootstrapService.ts) facade to programmatically start and stop a server.
+Alternatively, you can use the [BootstrapService](src/service/BootstrapService.ts) facade to programmatically start and stop a server.
 
 Example:
 

cmds/config-dualCurrency.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+set -e
+
+symbol-bootstrap config -p dualCurrency -a multinode --report -t target/bootstrap $1

cmds/start-dualCurrency-custom.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+set -e
+symbol-bootstrap start -u current -p dualCurrency  -a multinode -c test/custom_preset.yml -t target/bootstrap-custom --password 1234 $1

cmds/start-dualCurrency-demo.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+set -e
+
+symbol-bootstrap start -p dualCurrency -a demo -t target/bootstrap --password 1234 -c test/full_preset.yml $1 $2 $3

cmds/start-dualCurrency-freenodes.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+set -e
+
+symbol-bootstrap start --reset -p dualCurrency -a multinode --customPreset ./test/freenodes_preset.yml --user current -t target/bootstrap-freenodes

cmds/start-dualCurrency-repeat.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+docker stop $(docker ps -aq)
+docker rm $(docker ps -aq)
+symbol-bootstrap start -p dualCurrency -a multinode -c test/repeat_preset.yml -t target/bootstrap-repeat --password 1234 $1

cmds/start-dualCurrency.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+set -e
+
+# docker rm -f $(docker ps -aq)
+symbol-bootstrap start -p dualCurrency -a multinode -u current -t target/bootstrap  -c test/custom_bootstrap.yml --password 1234 $1

cmds/start-singleCurrency.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+set -e
+
+# docker rm -f $(docker ps -aq)
+symbol-bootstrap start -p singleCurrency -u current -t target/singleCurrency  -c test/custom_bootstrap.yml --password 1234 $1

docs/config.md

@@ -14,43 +14,41 @@ USAGE
   $ symbol-bootstrap config
 
 OPTIONS
-  -a, --assembly=assembly                   The assembly, example "dual" for testnet. If not provided, the value is
-                                            resolved from the target/preset.yml file.
+  -a, --assembly=assembly          The assembly that define the node(s) layout. It can be provided via custom preset or
+                                   cli parameter. If not provided, the value is resolved from the target/preset.yml
+                                   file.
 
-  -c, --customPreset=customPreset           External preset file. Values in this file will override the provided presets
+  -c, --customPreset=customPreset  External preset file. Values in this file will override the provided presets.
 
-  -h, --help                                It shows the help of this command.
+  -h, --help                       It shows the help of this command.
 
-  -p, --preset=(bootstrap|testnet|mainnet)  The network preset, can be provided via custom preset or cli parameter. If
-                                            not provided, the value is resolved from the target/preset.yml file.
+  -p, --preset=preset              The network preset. It can be provided via custom preset or cli parameter. If not
+                                   provided, the value is resolved from the target/preset.yml file.
 
-  -r, --reset                               It resets the configuration generating a new one
+  -r, --reset                      It resets the configuration generating a new one.
 
-  -t, --target=target                       [default: target] The target folder where the symbol-bootstrap network is
-                                            generated
+  -t, --target=target              [default: target] The target folder where the symbol-bootstrap network is generated
 
-  -u, --user=user                           [default: current] User used to run docker images when creating
-                                            configuration files like certificates or nemesis block. "current" means the
-                                            current user.
+  -u, --user=user                  [default: current] User used to run docker images when creating configuration files
+                                   like certificates or nemesis block. "current" means the current user.
 
-  --noPassword                              When provided, Bootstrap will not use a password, so private keys will be
-                                            stored in plain text. Use with caution.
+  --noPassword                     When provided, Bootstrap will not use a password, so private keys will be stored in
+                                   plain text. Use with caution.
 
-  --password=password                       A password used to encrypt and decrypt private keys in preset files like
-                                            addresses.yml and preset.yml. Bootstrap prompts for a password by default,
-                                            can be provided in the command line (--password=XXXX) or disabled in the
-                                            command line (--noPassword).
+  --password=password              A password used to encrypt and decrypt private keys in preset files like
+                                   addresses.yml and preset.yml. Bootstrap prompts for a password by default, can be
+                                   provided in the command line (--password=XXXX) or disabled in the command line
+                                   (--noPassword).
 
-  --report                                  It generates reStructuredText (.rst) reports describing the configuration of
-                                            each node.
+  --report                         It generates reStructuredText (.rst) reports describing the configuration of each
+                                   node.
 
-  --upgrade                                 It regenerates the configuration reusing the previous keys. Use this flag
-                                            when upgrading the version of bootstrap to keep your node up to date without
-                                            dropping the local data. The original preset (-t), assembly (-a), and custom
-                                            preset (-a) must be used. Backup the target folder before upgrading.
+  --upgrade                        It regenerates the configuration reusing the previous keys. Use this flag when
+                                   upgrading the version of bootstrap to keep your node up to date without dropping the
+                                   local data. Backup the target folder before upgrading.
 
 EXAMPLES
-  $ symbol-bootstrap config -p bootstrap
+  $ symbol-bootstrap config -p dualCurrency -a demo
   $ symbol-bootstrap config -p testnet -a dual --password 1234
   $ echo "$MY_ENV_VAR_PASSWORD" | symbol-bootstrap config -p testnet -a dual
 ```

docs/help.md

@@ -20,4 +20,4 @@ OPTIONS
   --all  see all commands in CLI
 ```
 
-_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.1.0/src/commands/help.ts)_
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.2.2/src/commands/help.ts)_