Add --repo option to ipfs init.

Closes ipfs#1296 License: MIT Signed-off-by: dignifiedquire <dignifiedquire@gmail.com>
dignifiedquire · Apr 4, 2016 · 1476eb0 · 1476eb0
1 parent 8acd87d
commit 1476eb0
Show file tree

Hide file tree

Showing 3 changed files with 194 additions and 1 deletion.
diff --git a/cmd/ipfs/init.go b/cmd/ipfs/init.go
@@ -18,6 +18,8 @@ import (
 
 const nBitsForKeypairDefault = 2048
 
+var repoDefault = path.Join(os.Getenv("HOME"), ".ipfs")
+
 var initCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
 		Tagline: "Initializes IPFS config file.",
@@ -37,6 +39,7 @@ at ~/.ipfs. To change the repo location, set the $IPFS_PATH environment variable
 		cmds.IntOption("bits", "b", fmt.Sprintf("Number of bits to use in the generated RSA private key (defaults to %d)", nBitsForKeypairDefault)),
 		cmds.BoolOption("force", "f", "Overwrite existing config (if it exists)."),
 		cmds.BoolOption("empty-repo", "e", "Don't add and pin help files to the local storage."),
+		cmds.StringOption("repo", "r", fmt.Sprintf("Set the repo path to this location (defaults to %s)", repoDefault)),
 
 		// TODO need to decide whether to expose the override as a file or a
 		// directory. That is: should we allow the user to also specify the
@@ -85,7 +88,21 @@ at ~/.ipfs. To change the repo location, set the $IPFS_PATH environment variable
 			nBitsForKeypair = nBitsForKeypairDefault
 		}
 
-		if err := doInit(os.Stdout, req.InvocContext().ConfigRoot, force, empty, nBitsForKeypair); err != nil {
+		repoRoot, _, err := req.Option("repo").String()
+		if err != nil {
+			res.SetError(err, cmds.ErrNormal)
+			return
+		}
+
+		if repoRoot == "" {
+			if repoEnv := os.Getenv("IPFS_PATH"); repoEnv != "" {
+				repoRoot = repoEnv
+			} else {
+				repoRoot = repoDefault
+			}
+		}
+
+		if err := doInit(os.Stdout, repoRoot, force, empty, nBitsForKeypair); err != nil {
 			res.SetError(err, cmds.ErrNormal)
 			return
 		}

diff --git a/test/sharness/t0020-init b/test/sharness/t0020-init
@@ -0,0 +1,156 @@
+#!/bin/sh
+#
+# Copyright (c) 2014 Christian Couder
+# MIT Licensed; see the LICENSE file in this repository.
+#
+
+test_description="Test init command"
+
+. lib/test-lib.sh
+
+# test that ipfs fails to init if IPFS_PATH isnt writeable
+test_expect_success "create dir and change perms succeeds" '
+	export IPFS_PATH="$(pwd)/.badipfs" &&
+	mkdir "$IPFS_PATH" &&
+	chmod 000 "$IPFS_PATH"
+'
+
+test_expect_success "ipfs init fails" '
+	test_must_fail ipfs init 2> init_fail_out
+'
+
+# Under Windows/Cygwin the error message is different,
+# so we use the STD_ERR_MSG prereq.
+if test_have_prereq STD_ERR_MSG; then
+	init_err_msg="Error: failed to take lock at $IPFS_PATH: permission denied"
+else
+	init_err_msg="Error: mkdir $IPFS_PATH: The system cannot find the path specified."
+fi
+
+test_expect_success "ipfs init output looks good" '
+	echo "$init_err_msg" >init_fail_exp &&
+	test_cmp init_fail_exp init_fail_out
+'
+
+test_expect_success "cleanup dir with bad perms" '
+	chmod 775 "$IPFS_PATH" &&
+	rmdir "$IPFS_PATH"
+'
+
+# test no repo error message
+# this applies to `ipfs add sth`, `ipfs refs <hash>`
+test_expect_success "ipfs cat fails" '
+    export IPFS_PATH="$(pwd)/.ipfs" &&
+    test_must_fail ipfs cat Qmaa4Rw81a3a1VEx4LxB7HADUAXvZFhCoRdBzsMZyZmqHD 2> cat_fail_out
+'
+
+test_expect_success "ipfs cat no repo message looks good" '
+    echo "Error: no ipfs repo found in $IPFS_PATH." > cat_fail_exp &&
+    echo "please run: ipfs init" >> cat_fail_exp &&
+    test_path_cmp cat_fail_exp cat_fail_out
+'
+
+# test that init succeeds
+test_expect_success "ipfs init succeeds" '
+	export IPFS_PATH="$(pwd)/.ipfs" &&
+	echo "IPFS_PATH: \"$IPFS_PATH\"" &&
+	BITS="2048" &&
+	ipfs init --bits="$BITS" >actual_init ||
+	test_fsh cat actual_init
+'
+
+test_expect_success ".ipfs/ has been created" '
+	test -d ".ipfs" &&
+	test -f ".ipfs/config" &&
+	test -d ".ipfs/datastore" &&
+	test -d ".ipfs/blocks" ||
+	test_fsh ls -al .ipfs
+'
+
+test_expect_success "ipfs config succeeds" '
+	echo /ipfs >expected_config &&
+	ipfs config Mounts.IPFS >actual_config &&
+	test_cmp expected_config actual_config
+'
+
+test_expect_success "ipfs peer id looks good" '
+	PEERID=$(ipfs config Identity.PeerID) &&
+	test_check_peerid "$PEERID"
+'
+
+test_expect_success "ipfs init output looks good" '
+	STARTFILE="ipfs cat /ipfs/$HASH_WELCOME_DOCS/readme" &&
+	echo "initializing ipfs node at $IPFS_PATH" >expected &&
+	echo "generating $BITS-bit RSA keypair...done" >>expected &&
+	echo "peer identity: $PEERID" >>expected &&
+	echo "to get started, enter:" >>expected &&
+	printf "\\n\\t$STARTFILE\\n\\n" >>expected &&
+	test_cmp expected actual_init
+'
+
+test_expect_success "Welcome readme exists" '
+	ipfs cat /ipfs/$HASH_WELCOME_DOCS/readme
+'
+
+test_expect_success "clean up ipfs dir" '
+	rm -rf "$IPFS_PATH"
+'
+
+test_expect_success "'ipfs init --empty-repo' succeeds" '
+	BITS="1024" &&
+	ipfs init --bits="$BITS" --empty-repo >actual_init
+'
+
+test_expect_success "ipfs peer id looks good" '
+	PEERID=$(ipfs config Identity.PeerID) &&
+	test_check_peerid "$PEERID"
+'
+
+test_expect_success "'ipfs init --empty-repo' output looks good" '
+	echo "initializing ipfs node at $IPFS_PATH" >expected &&
+	echo "generating $BITS-bit RSA keypair...done" >>expected &&
+	echo "peer identity: $PEERID" >>expected &&
+	test_cmp expected actual_init
+'
+
+test_expect_success "Welcome readme doesn't exists" '
+	test_must_fail ipfs cat /ipfs/$HASH_WELCOME_DOCS/readme
+'
+
+test_expect_success "clean up ipfs dir" '
+	rm -rf "$IPFS_PATH"
+'
+
+test_expect_success "'ipfs init --repo' succeeds" '
+	BITS="1024" &&
+	ipfs init --bits="$BITS" --repo="$(pwd)/.ipfs2" >actual_init
+'
+
+test_expect_success "'ipfs init --repo' output looks good" '
+  export IPFS_PATH=$(pwd)/.ipfs2 &&
+	PEERID=$(ipfs config Identity.PeerID) &&
+	echo "initializing ipfs node at $(pwd)/.ipfs2" >expected &&
+	echo "generating $BITS-bit RSA keypair...done" >>expected &&
+	echo "peer identity: $PEERID" >>expected &&
+	echo "to get started, enter:" >>expected &&
+	printf "\\n\\t$STARTFILE\\n\\n" >>expected &&
+	test_cmp expected actual_init
+'
+
+test_expect_success "clean up ipfs dir" '
+	rm -rf "$IPFS_PATH"
+'
+
+test_init_ipfs
+
+test_launch_ipfs_daemon
+
+test_expect_success "ipfs init should not run while daemon is running" '
+	test_must_fail ipfs init 2> daemon_running_err &&
+	EXPECT="Error: ipfs daemon is running. please stop it to run this command" &&
+	grep "$EXPECT" daemon_running_err
+'
+
+test_kill_ipfs_daemon
+
+test_done
diff --git a/test/sharness/t0020-init.sh b/test/sharness/t0020-init.sh
@@ -121,6 +121,26 @@ test_expect_success "clean up ipfs dir" '
 	rm -rf "$IPFS_PATH"
 '
 
+test_expect_success "'ipfs init --repo' succeeds" '
+	BITS="1024" &&
+	ipfs init --bits="$BITS" --repo="$(pwd)/.ipfs2" >actual_init
+'
+
+test_expect_success "'ipfs init --repo' output looks good" '
+  export IPFS_PATH=$(pwd)/.ipfs2 &&
+	PEERID=$(ipfs config Identity.PeerID) &&
+	echo "initializing ipfs node at $(pwd)/.ipfs2" >expected &&
+	echo "generating $BITS-bit RSA keypair...done" >>expected &&
+	echo "peer identity: $PEERID" >>expected &&
+	echo "to get started, enter:" >>expected &&
+	printf "\\n\\t$STARTFILE\\n\\n" >>expected &&
+	test_cmp expected actual_init
+'
+
+test_expect_success "clean up ipfs dir" '
+	rm -rf "$IPFS_PATH"
+'
+
 test_init_ipfs
 
 test_launch_ipfs_daemon