Merge pull request #197 from tendermint/sed-dummy-kvstore

rename dummy to kvstore

README.md

@@ -87,7 +87,7 @@ See [the documentation](http://tendermint.readthedocs.io/en/master/) for more de
 ### Examples
 
 Check out the variety of example applications in the [example directory](example/).
-It also contains the code refered to by the `counter` and `dummy` apps; these apps come
+It also contains the code refered to by the `counter` and `kvstore` apps; these apps come
 built into the `abci-cli` binary.
 
 #### Counter
@@ -122,21 +122,21 @@ func cmdCounter(cmd *cobra.Command, args []string) error {
 
 and can be found in [this file](cmd/abci-cli/abci-cli.go).
 
-#### Dummy
+#### kvstore
 
-The `abci-cli dummy` application, which illustrates a simple key-value Merkle tree
+The `abci-cli kvstore` application, which illustrates a simple key-value Merkle tree
 
 ```golang
-func cmdDummy(cmd *cobra.Command, args []string) error {
+func cmdKVStore(cmd *cobra.Command, args []string) error {
 	logger := log.NewTMLogger(log.NewSyncWriter(os.Stdout))
 
 	// Create the application - in memory or persisted to disk
 	var app types.Application
 	if flagPersist == "" {
-		app = dummy.NewDummyApplication()
+		app = kvstore.NewKVStoreApplication()
 	} else {
-		app = dummy.NewPersistentDummyApplication(flagPersist)
-		app.(*dummy.PersistentDummyApplication).SetLogger(logger.With("module", "dummy"))
+		app = kvstore.NewPersistentKVStoreApplication(flagPersist)
+		app.(*kvstore.PersistentKVStoreApplication).SetLogger(logger.With("module", "kvstore"))
 	}
 
 	// Start the listener
@@ -157,4 +157,3 @@ func cmdDummy(cmd *cobra.Command, args []string) error {
 	return nil
 }
 ```
-

cmd/abci-cli/abci-cli.go

@@ -17,7 +17,7 @@ import (
 	abcicli "github.com/tendermint/abci/client"
 	"github.com/tendermint/abci/example/code"
 	"github.com/tendermint/abci/example/counter"
-	"github.com/tendermint/abci/example/dummy"
+	"github.com/tendermint/abci/example/kvstore"
 	"github.com/tendermint/abci/server"
 	servertest "github.com/tendermint/abci/tests/server"
 	"github.com/tendermint/abci/types"
@@ -47,7 +47,7 @@ var (
 	flagAddrC  string
 	flagSerial bool
 
-	// dummy
+	// kvstore
 	flagAddrD   string
 	flagPersist string
 )
@@ -59,7 +59,7 @@ var RootCmd = &cobra.Command{
 	PersistentPreRunE: func(cmd *cobra.Command, args []string) error {
 
 		switch cmd.Use {
-		case "counter", "dummy": // for the examples apps, don't pre-run
+		case "counter", "kvstore", "dummy": // for the examples apps, don't pre-run
 			return nil
 		case "version": // skip running for version command
 			return nil
@@ -133,6 +133,12 @@ func addDummyFlags() {
 	dummyCmd.PersistentFlags().StringVarP(&flagAddrD, "addr", "", "tcp://0.0.0.0:46658", "listen address")
 	dummyCmd.PersistentFlags().StringVarP(&flagPersist, "persist", "", "", "directory to use for a database")
 }
+
+func addKVStoreFlags() {
+	kvstoreCmd.PersistentFlags().StringVarP(&flagAddrD, "addr", "", "tcp://0.0.0.0:46658", "listen address")
+	kvstoreCmd.PersistentFlags().StringVarP(&flagPersist, "persist", "", "", "directory to use for a database")
+}
+
 func addCommands() {
 	RootCmd.AddCommand(batchCmd)
 	RootCmd.AddCommand(consoleCmd)
@@ -150,8 +156,12 @@ func addCommands() {
 	// examples
 	addCounterFlags()
 	RootCmd.AddCommand(counterCmd)
+	// deprecated, left for backwards compatibility
 	addDummyFlags()
 	RootCmd.AddCommand(dummyCmd)
+	// replaces dummy, see issue #196
+	addKVStoreFlags()
+	RootCmd.AddCommand(kvstoreCmd)
 }
 
 var batchCmd = &cobra.Command{
@@ -285,13 +295,25 @@ var counterCmd = &cobra.Command{
 	},
 }
 
+// deprecated, left for backwards compatibility
 var dummyCmd = &cobra.Command{
-	Use:   "dummy",
+	Use:        "dummy",
+	Deprecated: "use: [abci-cli kvstore] instead",
+	Short:      "ABCI demo example",
+	Long:       "ABCI demo example",
+	Args:       cobra.ExactArgs(0),
+	RunE: func(cmd *cobra.Command, args []string) error {
+		return cmdKVStore(cmd, args)
+	},
+}
+
+var kvstoreCmd = &cobra.Command{
+	Use:   "kvstore",
 	Short: "ABCI demo example",
 	Long:  "ABCI demo example",
 	Args:  cobra.ExactArgs(0),
 	RunE: func(cmd *cobra.Command, args []string) error {
-		return cmdDummy(cmd, args)
+		return cmdKVStore(cmd, args)
 	},
 }
 
@@ -654,16 +676,16 @@ func cmdCounter(cmd *cobra.Command, args []string) error {
 	return nil
 }
 
-func cmdDummy(cmd *cobra.Command, args []string) error {
+func cmdKVStore(cmd *cobra.Command, args []string) error {
 	logger := log.NewTMLogger(log.NewSyncWriter(os.Stdout))
 
 	// Create the application - in memory or persisted to disk
 	var app types.Application
 	if flagPersist == "" {
-		app = dummy.NewDummyApplication()
+		app = kvstore.NewKVStoreApplication()
 	} else {
-		app = dummy.NewPersistentDummyApplication(flagPersist)
-		app.(*dummy.PersistentDummyApplication).SetLogger(logger.With("module", "dummy"))
+		app = kvstore.NewPersistentKVStoreApplication(flagPersist)
+		app.(*kvstore.PersistentKVStoreApplication).SetLogger(logger.With("module", "kvstore"))
 	}
 
 	// Start the listener

example/example_test.go

@@ -16,14 +16,14 @@ import (
 
 	abcicli "github.com/tendermint/abci/client"
 	"github.com/tendermint/abci/example/code"
-	"github.com/tendermint/abci/example/dummy"
+	"github.com/tendermint/abci/example/kvstore"
 	abciserver "github.com/tendermint/abci/server"
 	"github.com/tendermint/abci/types"
 )
 
-func TestDummy(t *testing.T) {
-	fmt.Println("### Testing Dummy")
-	testStream(t, dummy.NewDummyApplication())
+func TestKVStore(t *testing.T) {
+	fmt.Println("### Testing KVStore")
+	testStream(t, kvstore.NewKVStoreApplication())
 }
 
 func TestBaseApp(t *testing.T) {

tests/client_server_test.go

@@ -6,14 +6,14 @@ import (
 	"github.com/stretchr/testify/assert"
 
 	abciclient "github.com/tendermint/abci/client"
-	"github.com/tendermint/abci/example/dummy"
+	"github.com/tendermint/abci/example/kvstore"
 	abciserver "github.com/tendermint/abci/server"
 )
 
 func TestClientServerNoAddrPrefix(t *testing.T) {
 	addr := "localhost:46658"
 	transport := "socket"
-	app := dummy.NewDummyApplication()
+	app := kvstore.NewKVStoreApplication()
 
 	server, err := abciserver.NewServer(addr, transport, app)
 	assert.NoError(t, err, "expected no error on NewServer")

tests/test_cli/test.sh

@@ -35,7 +35,7 @@ function testExample() {
 	rm "${INPUT}".out.new
 }
 
-testExample 1 tests/test_cli/ex1.abci abci-cli dummy
+testExample 1 tests/test_cli/ex1.abci abci-cli kvstore
 testExample 2 tests/test_cli/ex2.abci abci-cli counter
 
 echo ""