repo-stat

License: MIT
Signed-off-by: David Dias <daviddias.p@gmail.com>

core/commands/repo.go

@@ -3,22 +3,12 @@ package commands
 import (
 	"bytes"
 	"fmt"
-	"io"
-	"strings"
-
-	humanize "github.com/ipfs/go-ipfs/Godeps/_workspace/src/github.com/dustin/go-humanize"
 	cmds "github.com/ipfs/go-ipfs/commands"
 	corerepo "github.com/ipfs/go-ipfs/core/corerepo"
-	fsrepo "github.com/ipfs/go-ipfs/repo/fsrepo"
 	u "gx/ipfs/QmZNVWh8LLjAavuQ2JXuFmuYH3C11xo988vSgp7UQrTRj1/go-ipfs-util"
+	"io"
 )
 
-type RepoStat struct {
-	repoPath  string
-	repoSize  uint64 // size in bytes
-	numBlocks uint64
-}
-
 var RepoCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
 		Tagline: "Manipulate the IPFS repo.",
@@ -108,59 +98,56 @@ order to reclaim hard disk space.
 
 var repoStatCmd = &cmds.Command{
 	Helptext: cmds.HelpText{
-		Tagline:          "Print status of the local repo.",
-		ShortDescription: ``,
+		Tagline: "Get stats for the currently used repo.",
+		ShortDescription: `
+'ipfs repo stat' is a plumbing command that will scan the local
+set of stored objects and print repo statistics. It outputs to stdout:
+NumObjects      int number of objects in the local repo
+RepoSize        int size in bytes that the repo is currently taking
+RepoPath        string the path to the repo being currently used	
+`,
 	},
 	Run: func(req cmds.Request, res cmds.Response) {
-		ctx := req.Context()
 		n, err := req.InvocContext().GetNode()
 		if err != nil {
 			res.SetError(err, cmds.ErrNormal)
 			return
 		}
 
-		usage, err := n.Repo.GetStorageUsage()
-		if err != nil {
-			res.SetError(err, cmds.ErrNormal)
-			return
-		}
-
-		allKeys, err := n.Blockstore.AllKeysChan(ctx)
-		if err != nil {
-			res.SetError(err, cmds.ErrNormal)
-			return
-		}
-
-		count := uint64(0)
-		for range allKeys {
-			count++
-		}
-
-		path, err := fsrepo.BestKnownPath()
+		stat, err := corerepo.RepoStat(n, req.Context())
 		if err != nil {
 			res.SetError(err, cmds.ErrNormal)
 			return
 		}
 
-		res.SetOutput(&RepoStat{
-			repoPath:  path,
-			repoSize:  usage,
-			numBlocks: count,
-		})
+		res.SetOutput(stat)
 	},
-	Type: RepoStat{},
+	Options: []cmds.Option{
+		cmds.BoolOption("human", "Output RepoSize in MiB."),
+	},
+	Type: corerepo.Stat{},
 	Marshalers: cmds.MarshalerMap{
 		cmds.Text: func(res cmds.Response) (io.Reader, error) {
-			stat, ok := res.Output().(*RepoStat)
+			stat, ok := res.Output().(*corerepo.Stat)
 			if !ok {
 				return nil, u.ErrCast()
 			}
 
-			out := fmt.Sprintf(
-				"Path: %s\nSize: %s\nBlocks: %d\n",
-				stat.repoPath, humanize.Bytes(stat.repoSize), stat.numBlocks)
+			human, _, err := res.Request().Option("human").Bool()
+			if err != nil {
+				return nil, err
+			}
+
+			buf := new(bytes.Buffer)
+			fmt.Fprintf(buf, "NumObjects \t %d\n", stat.NumObjects)
+			if human {
+				fmt.Fprintf(buf, "RepoSize (MiB) \t %d\n", stat.RepoSize/1024)
+			} else {
+				fmt.Fprintf(buf, "RepoSize \t %d\n", stat.RepoSize)
+			}
+			fmt.Fprintf(buf, "RepoPath \t %s\n", stat.RepoPath)
 
-			return strings.NewReader(out), nil
+			return buf, nil
 		},
 	},
 }

core/corerepo/stat.go

@@ -0,0 +1,43 @@
+package corerepo
+
+import (
+	"github.com/ipfs/go-ipfs/core"
+	fsrepo "github.com/ipfs/go-ipfs/repo/fsrepo"
+	context "gx/ipfs/QmZy2y8t9zQH2a1b8q2ZSLKp17ATuJoCNxxyMFG5qFExpt/go-net/context"
+)
+
+type Stat struct {
+	NumObjects uint64
+	RepoSize   uint64 // size in bytes
+	RepoPath   string
+}
+
+func RepoStat(n *core.IpfsNode, ctx context.Context) (*Stat, error) {
+	r := n.Repo
+
+	usage, err := r.GetStorageUsage()
+	if err != nil {
+		return nil, err
+	}
+
+	allKeys, err := n.Blockstore.AllKeysChan(ctx)
+	if err != nil {
+		return nil, err
+	}
+
+	count := uint64(0)
+	for range allKeys {
+		count++
+	}
+
+	path, err := fsrepo.BestKnownPath()
+	if err != nil {
+		return nil, err
+	}
+
+	return &Stat{
+		NumObjects: count,
+		RepoSize:   usage,
+		RepoPath:   path,
+	}, nil
+}

test/sharness/t0080-repo.sh

@@ -219,6 +219,31 @@ test_expect_success "'ipfs refs --unique --recursive (bigger)'" '
 	test_sort_cmp expected actual || test_fsh cat refs_output
 '
 
+get_field_num() {
+  field=$1
+  file=$2
+  num=$(grep "$field" "$file" | awk '{ print $2 }')
+  echo $num
+}
+
+test_expect_success "'ipfs repo stat' succeeds" '
+  ipfs repo stat > repo-stats
+'
+test_expect_success "repo stats came out correct" '
+  grep "RepoPath" repo-stats &&
+  grep "RepoSize" repo-stats &&
+  grep "NumObjects" repo-stats
+'
+
+test_expect_success "'ipfs repo stat' after adding a file" '
+  ipfs add repo-stats &&
+  ipfs repo stat > repo-stats-2
+'
+
+test_expect_success "repo stats are updated correctly" '
+  test $(get_field_num "RepoSize" repo-stats-2) -ge $(get_field_num "RepoSize" repo-stats)
+'
+
 test_kill_ipfs_daemon
 
 test_done