cmd/swarm: make bzzaccount flag optional and add bzzkeyhex flag (#1531)

* cmd/swarm: don't require bzzaccount flag

* docker: remove setup script because bzzaccount is not required anymore

* cmd/swarm: manage account creation/selection when bzzflag is not defined

* cmd/swarm: no bzzaccount flag tests

* cmd/swarm: use random network ports on tests

* cmd/swarm: fix typo

* cmd/swarm: add --bzzkeyhex flag

* cmd/swarm: use different ipc paths for tests

* readme: update example on how to run swarm

* cmd/swarm: rename getAccount -> getOrCreateAccount

* cmd/swarm: remove unneeded comment

* cmd/swarm: use shorter ipc path for test

Dockerfile

@@ -10,5 +10,4 @@ FROM alpine:3.9
 RUN apk --no-cache add ca-certificates && update-ca-certificates
 COPY --from=builder /swarm/build/bin/swarm /usr/local/bin/
 COPY --from=geth /usr/local/bin/geth /usr/local/bin/
-COPY docker/run.sh /run.sh
-ENTRYPOINT ["/run.sh"]
+ENTRYPOINT ["/usr/local/bin/swarm"]

Dockerfile.alltools

@@ -10,6 +10,5 @@ FROM alpine:3.9
 RUN apk --no-cache add ca-certificates
 COPY --from=builder /swarm/build/bin/* /usr/local/bin/
 COPY --from=geth /usr/local/bin/geth /usr/local/bin/
-COPY docker/run.sh /run.sh
 COPY docker/run-smoke.sh /run-smoke.sh
-ENTRYPOINT ["/run.sh"]
+ENTRYPOINT ["/usr/local/bin/swarm"]

README.md

@@ -9,26 +9,26 @@ Swarm is a distributed storage platform and content distribution service, a nati
 
 ## Table of Contents  <!-- omit in toc -->
 
-- [Building the source](#building-the-source)
-- [Running Swarm](#running-swarm)
-  - [Verifying that your local Swarm node is running](#verifying-that-your-local-swarm-node-is-running)
-  - [Ethereum Name Service resolution](#ethereum-name-service-resolution)
-- [Documentation](#documentation)
-- [Docker](#docker)
-  - [Docker tags](#docker-tags)
-  - [Environment variables](#environment-variables)
-  - [Swarm command line arguments](#swarm-command-line-arguments)
-- [Developers Guide](#developers-guide)
-  - [Go Environment](#go-environment)
-  - [Vendored Dependencies](#vendored-dependencies)
-  - [Testing](#testing)
-  - [Profiling Swarm](#profiling-swarm)
-  - [Metrics and Instrumentation in Swarm](#metrics-and-instrumentation-in-swarm)
-    - [Visualizing metrics](#visualizing-metrics)
-- [Public Gateways](#public-gateways)
-- [Swarm Dapps](#swarm-dapps)
-- [Contributing](#contributing)
-- [License](#license)
+- [Building the source](#Building-the-source)
+- [Running Swarm](#Running-Swarm)
+  - [Verifying that your local Swarm node is running](#Verifying-that-your-local-Swarm-node-is-running)
+  - [Ethereum Name Service resolution](#Ethereum-Name-Service-resolution)
+- [Documentation](#Documentation)
+- [Docker](#Docker)
+  - [Docker tags](#Docker-tags)
+  - [Environment variables](#Environment-variables)
+  - [Swarm command line arguments](#Swarm-command-line-arguments)
+- [Developers Guide](#Developers-Guide)
+  - [Go Environment](#Go-Environment)
+  - [Vendored Dependencies](#Vendored-Dependencies)
+  - [Testing](#Testing)
+  - [Profiling Swarm](#Profiling-Swarm)
+  - [Metrics and Instrumentation in Swarm](#Metrics-and-Instrumentation-in-Swarm)
+    - [Visualizing metrics](#Visualizing-metrics)
+- [Public Gateways](#Public-Gateways)
+- [Swarm Dapps](#Swarm-Dapps)
+- [Contributing](#Contributing)
+- [License](#License)
 
 ## Building the source
 
@@ -53,34 +53,24 @@ $ go install github.com/ethersphere/swarm/cmd/swarm
 
 ## Running Swarm
 
-Going through all the possible command line flags is out of scope here, but we've enumerated a few common parameter combos to get you up to speed quickly on how you can run your own Swarm node.
-
-To run Swarm you need an Ethereum account. Download and install [Geth](https://geth.ethereum.org) if you don't have it on your system. You can create a new Ethereum account by running the following command:
-
 ```bash
-$ geth account new
+$ swarm
 ```
 
-You will be prompted for a password:
+If you don't have an account yet, then you will be prompted to create one and secure it with a password:
 
 ```
 Your new account is locked with a password. Please give a password. Do not forget this password.
 Passphrase:
 Repeat passphrase:
 ```
 
-Once you have specified the password, the output will be the Ethereum address representing that account. For example:
-
-```
-Address: {2f1cd699b0bf461dcfbf0098ad8f5587b038f0f1}
-```
-
-Using this account, connect to Swarm with
+If you have multiple accounts created, then you'll have to choose one of the accounts by using the `--bzzaccount` flag.
 
 ```bash
 $ swarm --bzzaccount <your-account-here>
 
-# in our example
+# example
 $ swarm --bzzaccount 2f1cd699b0bf461dcfbf0098ad8f5587b038f0f1
 ```
 

cmd/swarm/access.go

@@ -106,7 +106,7 @@ func accessNewPass(ctx *cli.Context) {
 		accessKey []byte
 		err       error
 		ref       = args[0]
-		password  = getPassPhrase("", 0, makePasswordList(ctx))
+		password  = getPassPhrase("", false, 0, makePasswordList(ctx))
 		dryRun    = ctx.Bool(SwarmDryRunFlag.Name)
 	)
 	accessKey, ae, err = api.DoPassword(ctx, password, salt)

cmd/swarm/config.go

@@ -17,6 +17,7 @@
 package main
 
 import (
+	"crypto/ecdsa"
 	"errors"
 	"fmt"
 	"io"
@@ -60,6 +61,7 @@ var (
 const (
 	SwarmEnvChequebookAddr       = "SWARM_CHEQUEBOOK_ADDR"
 	SwarmEnvAccount              = "SWARM_ACCOUNT"
+	SwarmEnvBzzKeyHex            = "SWARM_BZZ_KEY_HEX"
 	SwarmEnvListenAddr           = "SWARM_LISTEN_ADDR"
 	SwarmEnvPort                 = "SWARM_PORT"
 	SwarmEnvNetworkID            = "SWARM_NETWORK_ID"
@@ -121,9 +123,9 @@ func buildConfig(ctx *cli.Context) (config *bzzapi.Config, err error) {
 
 //finally, after the configuration build phase is finished, initialize
 func initSwarmNode(config *bzzapi.Config, stack *node.Node, ctx *cli.Context, nodeconfig *node.Config) error {
-	//at this point, all vars should be set in the Config
 	//get the account for the provided swarm account
-	prvkey := getAccount(config.BzzAccount, ctx, stack)
+	var prvkey *ecdsa.PrivateKey
+	config.BzzAccount, prvkey = getOrCreateAccount(ctx, stack)
 	//set the resolved config path (geth --datadir)
 	config.Path = expandPath(stack.InstanceDir())
 	//finally, initialize the configuration

cmd/swarm/config_test.go

@@ -17,6 +17,7 @@
 package main
 
 import (
+	"encoding/hex"
 	"fmt"
 	"io"
 	"io/ioutil"
@@ -28,6 +29,8 @@ import (
 
 	"github.com/docker/docker/pkg/reexec"
 	"github.com/ethereum/go-ethereum/cmd/utils"
+	"github.com/ethereum/go-ethereum/crypto"
+	"github.com/ethereum/go-ethereum/node"
 	"github.com/ethereum/go-ethereum/rpc"
 	"github.com/ethersphere/swarm"
 	"github.com/ethersphere/swarm/api"
@@ -48,6 +51,7 @@ func TestConfigFailsSwapEnabledNoSwapApi(t *testing.T) {
 	flags := []string{
 		fmt.Sprintf("--%s", SwarmNetworkIdFlag.Name), "42",
 		fmt.Sprintf("--%s", SwarmPortFlag.Name), "54545",
+		fmt.Sprintf("--%s", utils.ListenPortFlag.Name), "0",
 		fmt.Sprintf("--%s", SwarmSwapEnabledFlag.Name),
 	}
 
@@ -56,15 +60,161 @@ func TestConfigFailsSwapEnabledNoSwapApi(t *testing.T) {
 	swarm.ExpectExit()
 }
 
-func TestConfigFailsNoBzzAccount(t *testing.T) {
+func TestBzzKeyFlag(t *testing.T) {
+	key, err := crypto.GenerateKey()
+	if err != nil {
+		t.Fatal("unable to generate key")
+	}
+	hexKey := hex.EncodeToString(crypto.FromECDSA(key))
+	bzzaccount := crypto.PubkeyToAddress(key.PublicKey).Hex()
+
+	dir, err := ioutil.TempDir("", "bzztest")
+	if err != nil {
+		t.Fatal(err)
+	}
+	defer os.RemoveAll(dir)
+
+	conf := &node.Config{
+		DataDir: dir,
+		IPCPath: "testbzzkeyflag.ipc",
+		NoUSB:   true,
+	}
+
+	node := &testNode{Dir: dir}
+
 	flags := []string{
 		fmt.Sprintf("--%s", SwarmNetworkIdFlag.Name), "42",
-		fmt.Sprintf("--%s", SwarmPortFlag.Name), "54545",
+		fmt.Sprintf("--%s", SwarmPortFlag.Name), "0",
+		fmt.Sprintf("--%s", utils.ListenPortFlag.Name), "0",
+		fmt.Sprintf("--%s", utils.DataDirFlag.Name), dir,
+		fmt.Sprintf("--%s", utils.IPCPathFlag.Name), conf.IPCPath,
+		fmt.Sprintf("--%s", SwarmBzzKeyHexFlag.Name), hexKey,
 	}
 
-	swarm := runSwarm(t, flags...)
-	swarm.Expect("Fatal: " + SwarmErrNoBZZAccount + "\n")
-	swarm.ExpectExit()
+	node.Cmd = runSwarm(t, flags...)
+	defer func() {
+		node.Shutdown()
+	}()
+
+	node.Cmd.InputLine(testPassphrase)
+
+	// wait for the node to start
+	for start := time.Now(); time.Since(start) < 10*time.Second; time.Sleep(50 * time.Millisecond) {
+		node.Client, err = rpc.Dial(conf.IPCEndpoint())
+		if err == nil {
+			break
+		}
+	}
+	if node.Client == nil {
+		t.Fatal(err)
+	}
+
+	// load info
+	var info swarm.Info
+	if err := node.Client.Call(&info, "bzz_info"); err != nil {
+		t.Fatal(err)
+	}
+
+	if info.BzzAccount != bzzaccount {
+		t.Fatalf("Expected account to be %s, got %s", bzzaccount, info.BzzAccount)
+	}
+}
+func TestEmptyBzzAccountFlagMultipleAccounts(t *testing.T) {
+	dir, err := ioutil.TempDir("", "bzztest")
+	if err != nil {
+		t.Fatal(err)
+	}
+	defer os.RemoveAll(dir)
+
+	// Create two accounts on disk
+	getTestAccount(t, dir)
+	getTestAccount(t, dir)
+
+	node := &testNode{Dir: dir}
+
+	flags := []string{
+		fmt.Sprintf("--%s", SwarmNetworkIdFlag.Name), "42",
+		fmt.Sprintf("--%s", SwarmPortFlag.Name), "0",
+		fmt.Sprintf("--%s", utils.ListenPortFlag.Name), "0",
+		fmt.Sprintf("--%s", utils.DataDirFlag.Name), dir,
+	}
+
+	node.Cmd = runSwarm(t, flags...)
+
+	node.Cmd.ExpectRegexp(fmt.Sprintf("Please choose one of the accounts by running swarm with the --%s flag.", SwarmAccountFlag.Name))
+}
+
+func TestEmptyBzzAccountFlagSingleAccount(t *testing.T) {
+	dir, err := ioutil.TempDir("", "bzztest")
+	if err != nil {
+		t.Fatal(err)
+	}
+	defer os.RemoveAll(dir)
+
+	conf, account := getTestAccount(t, dir)
+	node := &testNode{Dir: dir}
+
+	flags := []string{
+		fmt.Sprintf("--%s", SwarmNetworkIdFlag.Name), "42",
+		fmt.Sprintf("--%s", SwarmPortFlag.Name), "0",
+		fmt.Sprintf("--%s", utils.ListenPortFlag.Name), "0",
+		fmt.Sprintf("--%s", utils.DataDirFlag.Name), dir,
+		fmt.Sprintf("--%s", utils.IPCPathFlag.Name), conf.IPCPath,
+	}
+
+	node.Cmd = runSwarm(t, flags...)
+	defer func() {
+		node.Shutdown()
+	}()
+
+	node.Cmd.InputLine(testPassphrase)
+
+	// wait for the node to start
+	for start := time.Now(); time.Since(start) < 10*time.Second; time.Sleep(50 * time.Millisecond) {
+		node.Client, err = rpc.Dial(conf.IPCEndpoint())
+		if err == nil {
+			break
+		}
+	}
+	if node.Client == nil {
+		t.Fatal(err)
+	}
+
+	// load info
+	var info swarm.Info
+	if err := node.Client.Call(&info, "bzz_info"); err != nil {
+		t.Fatal(err)
+	}
+
+	if info.BzzAccount != account.Address.Hex() {
+		t.Fatalf("Expected account to be %s, got %s", account.Address.Hex(), info.BzzAccount)
+	}
+}
+
+func TestEmptyBzzAccountFlagNoAccountWrongPassword(t *testing.T) {
+	dir, err := ioutil.TempDir("", "bzztest")
+	if err != nil {
+		t.Fatal(err)
+	}
+	defer os.RemoveAll(dir)
+
+	node := &testNode{Dir: dir}
+
+	flags := []string{
+		fmt.Sprintf("--%s", SwarmNetworkIdFlag.Name), "42",
+		fmt.Sprintf("--%s", SwarmPortFlag.Name), "0",
+		fmt.Sprintf("--%s", utils.ListenPortFlag.Name), "0",
+		fmt.Sprintf("--%s", utils.DataDirFlag.Name), dir,
+	}
+
+	node.Cmd = runSwarm(t, flags...)
+
+	// Set password
+	node.Cmd.InputLine("goodpassword")
+	// Confirm password
+	node.Cmd.InputLine("wrongpassword")
+
+	node.Cmd.ExpectRegexp("Passphrases do not match")
 }
 
 func TestConfigCmdLineOverrides(t *testing.T) {
@@ -86,6 +236,7 @@ func TestConfigCmdLineOverrides(t *testing.T) {
 	flags := []string{
 		fmt.Sprintf("--%s", SwarmNetworkIdFlag.Name), "42",
 		fmt.Sprintf("--%s", SwarmPortFlag.Name), httpPort,
+		fmt.Sprintf("--%s", utils.ListenPortFlag.Name), "0",
 		fmt.Sprintf("--%s", SwarmSyncDisabledFlag.Name),
 		fmt.Sprintf("--%s", CorsStringFlag.Name), "*",
 		fmt.Sprintf("--%s", SwarmAccountFlag.Name), account.Address.String(),

cmd/swarm/download.go

@@ -101,7 +101,7 @@ func download(ctx *cli.Context) {
 		return nil
 	}
 	if passwords := makePasswordList(ctx); passwords != nil {
-		password := getPassPhrase(fmt.Sprintf("Downloading %s is restricted", uri), 0, passwords)
+		password := getPassPhrase(fmt.Sprintf("Downloading %s is restricted", uri), false, 0, passwords)
 		err = dl(password)
 	} else {
 		err = dl("")

cmd/swarm/flags.go

@@ -30,6 +30,11 @@ var (
 		Usage:  "Swarm account key file",
 		EnvVar: SwarmEnvAccount,
 	}
+	SwarmBzzKeyHexFlag = cli.StringFlag{
+		Name:   "bzzkeyhex",
+		Usage:  "BzzAccount key in hex (for testing)",
+		EnvVar: SwarmEnvBzzKeyHex,
+	}
 	SwarmListenAddrFlag = cli.StringFlag{
 		Name:   "httpaddr",
 		Usage:  "Swarm HTTP API listening interface",