Add support for code_version_string field in the db_version table of …

…the trade bot's database (closes #447) (#448)

* 1 - export test infrastructure fields for use outside the support/database package

* 2 - TestTradeUpgradeScripts along with upgrading db_version table in trade#upgradeScripts variable

cmd/trade.go

@@ -32,7 +32,9 @@ import (
 )
 
 var upgradeScripts = []*database.UpgradeScript{
-	database.MakeUpgradeScript(1, database.SqlDbVersionTableCreate),
+	database.MakeUpgradeScript(1,
+		database.SqlDbVersionTableCreate,
+	),
 	database.MakeUpgradeScript(2,
 		kelpdb.SqlMarketsTableCreate,
 		kelpdb.SqlTradesTableCreate,
@@ -42,6 +44,9 @@ var upgradeScripts = []*database.UpgradeScript{
 		kelpdb.SqlTradesIndexDrop,
 		kelpdb.SqlTradesIndexCreate2,
 	),
+	database.MakeUpgradeScript(4,
+		database.SqlDbVersionTableAlter1,
+	),
 }
 
 const tradeExamples = `  kelp trade --botConf ./path/trader.cfg --strategy buysell --stratConf ./path/buysell.cfg

cmd/trade_test.go

@@ -0,0 +1,203 @@
+package cmd
+
+import (
+	"fmt"
+	"testing"
+	"time"
+
+	"github.com/stretchr/testify/assert"
+
+	"github.com/stellar/kelp/support/database"
+)
+
+func TestTradeUpgradeScripts(t *testing.T) {
+	// run the PreTest and defer running the postTest
+	db, dbname := database.PreTest(t)
+	defer database.PostTestWithDbClose(db, dbname)
+
+	// run the upgrade scripts
+	codeVersionString := "TestTradeUpgradeScripts"
+	database.RunUpgradeScripts(db, upgradeScripts, codeVersionString)
+
+	// assert current state of the database
+	assert.Equal(t, 3, database.GetNumTablesInDb(db))
+	assert.True(t, database.CheckTableExists(db, "db_version"))
+	assert.True(t, database.CheckTableExists(db, "markets"))
+	assert.True(t, database.CheckTableExists(db, "trades"))
+
+	// check schema of db_version table
+	var columns []database.TableColumn
+	columns = database.GetTableSchema(db, "db_version")
+	assert.Equal(t, 5, len(columns), fmt.Sprintf("%v", columns))
+	database.AssertTableColumnsEqual(t, &database.TableColumn{
+		ColumnName:             "version",
+		OrdinalPosition:        1,
+		ColumnDefault:          nil,
+		IsNullable:             "NO",
+		DataType:               "integer",
+		CharacterMaximumLength: nil,
+	}, &columns[0])
+	database.AssertTableColumnsEqual(t, &database.TableColumn{
+		ColumnName:             "date_completed_utc",
+		OrdinalPosition:        2,
+		ColumnDefault:          nil,
+		IsNullable:             "NO",
+		DataType:               "timestamp without time zone",
+		CharacterMaximumLength: nil,
+	}, &columns[1])
+	database.AssertTableColumnsEqual(t, &database.TableColumn{
+		ColumnName:             "num_scripts",
+		OrdinalPosition:        3,
+		ColumnDefault:          nil,
+		IsNullable:             "NO",
+		DataType:               "integer",
+		CharacterMaximumLength: nil,
+	}, &columns[2])
+	database.AssertTableColumnsEqual(t, &database.TableColumn{
+		ColumnName:             "time_elapsed_millis",
+		OrdinalPosition:        4,
+		ColumnDefault:          nil,
+		IsNullable:             "NO",
+		DataType:               "bigint",
+		CharacterMaximumLength: nil,
+	}, &columns[3])
+	database.AssertTableColumnsEqual(t, &database.TableColumn{
+		ColumnName:             "code_version_string",
+		OrdinalPosition:        5,
+		ColumnDefault:          nil,
+		IsNullable:             "YES",
+		DataType:               "text",
+		CharacterMaximumLength: nil,
+	}, &columns[4])
+
+	// check schema of markets table
+	columns = database.GetTableSchema(db, "markets")
+	assert.Equal(t, 4, len(columns), fmt.Sprintf("%v", columns))
+	database.AssertTableColumnsEqual(t, &database.TableColumn{
+		ColumnName:             "market_id",
+		OrdinalPosition:        1,
+		ColumnDefault:          nil,
+		IsNullable:             "NO",
+		DataType:               "text",
+		CharacterMaximumLength: nil,
+	}, &columns[0])
+	database.AssertTableColumnsEqual(t, &database.TableColumn{
+		ColumnName:             "exchange_name",
+		OrdinalPosition:        2,
+		ColumnDefault:          nil,
+		IsNullable:             "NO",
+		DataType:               "text",
+		CharacterMaximumLength: nil,
+	}, &columns[1])
+	database.AssertTableColumnsEqual(t, &database.TableColumn{
+		ColumnName:             "base",
+		OrdinalPosition:        3,
+		ColumnDefault:          nil,
+		IsNullable:             "NO",
+		DataType:               "text",
+		CharacterMaximumLength: nil,
+	}, &columns[2])
+	database.AssertTableColumnsEqual(t, &database.TableColumn{
+		ColumnName:             "quote",
+		OrdinalPosition:        4,
+		ColumnDefault:          nil,
+		IsNullable:             "NO",
+		DataType:               "text",
+		CharacterMaximumLength: nil,
+	}, &columns[3])
+
+	// check schema of trades table
+	columns = database.GetTableSchema(db, "trades")
+	assert.Equal(t, 9, len(columns), fmt.Sprintf("%v", columns))
+	database.AssertTableColumnsEqual(t, &database.TableColumn{
+		ColumnName:             "market_id",
+		OrdinalPosition:        1,
+		ColumnDefault:          nil,
+		IsNullable:             "NO",
+		DataType:               "text",
+		CharacterMaximumLength: nil,
+	}, &columns[0])
+	database.AssertTableColumnsEqual(t, &database.TableColumn{
+		ColumnName:             "txid",
+		OrdinalPosition:        2,
+		ColumnDefault:          nil,
+		IsNullable:             "NO",
+		DataType:               "text",
+		CharacterMaximumLength: nil,
+	}, &columns[1])
+	database.AssertTableColumnsEqual(t, &database.TableColumn{
+		ColumnName:             "date_utc",
+		OrdinalPosition:        3,
+		ColumnDefault:          nil,
+		IsNullable:             "NO",
+		DataType:               "timestamp without time zone",
+		CharacterMaximumLength: nil,
+	}, &columns[2])
+	database.AssertTableColumnsEqual(t, &database.TableColumn{
+		ColumnName:             "action",
+		OrdinalPosition:        4,
+		ColumnDefault:          nil,
+		IsNullable:             "NO",
+		DataType:               "text",
+		CharacterMaximumLength: nil,
+	}, &columns[3])
+	database.AssertTableColumnsEqual(t, &database.TableColumn{
+		ColumnName:             "type",
+		OrdinalPosition:        5,
+		ColumnDefault:          nil,
+		IsNullable:             "NO",
+		DataType:               "text",
+		CharacterMaximumLength: nil,
+	}, &columns[4])
+	database.AssertTableColumnsEqual(t, &database.TableColumn{
+		ColumnName:             "counter_price",
+		OrdinalPosition:        6,
+		ColumnDefault:          nil,
+		IsNullable:             "NO",
+		DataType:               "double precision",
+		CharacterMaximumLength: nil,
+	}, &columns[5])
+	database.AssertTableColumnsEqual(t, &database.TableColumn{
+		ColumnName:             "base_volume",
+		OrdinalPosition:        7,
+		ColumnDefault:          nil,
+		IsNullable:             "NO",
+		DataType:               "double precision",
+		CharacterMaximumLength: nil,
+	}, &columns[6])
+	database.AssertTableColumnsEqual(t, &database.TableColumn{
+		ColumnName:             "counter_cost",
+		OrdinalPosition:        8,
+		ColumnDefault:          nil,
+		IsNullable:             "NO",
+		DataType:               "double precision",
+		CharacterMaximumLength: nil,
+	}, &columns[7])
+	database.AssertTableColumnsEqual(t, &database.TableColumn{
+		ColumnName:             "fee",
+		OrdinalPosition:        9,
+		ColumnDefault:          nil,
+		IsNullable:             "NO",
+		DataType:               "double precision",
+		CharacterMaximumLength: nil,
+	}, &columns[8])
+
+	// check entries of db_version table
+	var allRows [][]interface{}
+	allRows = database.QueryAllRows(db, "db_version")
+	assert.Equal(t, 4, len(allRows))
+	// first three code_version_string is nil becuase the field was not supported at the time when the upgrade script was run, and only in version 4 of
+	// the database do we add the field. See upgradeScripts and RunUpgradeScripts() for more details
+	database.ValidateDBVersionRow(t, allRows[0], 1, time.Now(), 1, 10, nil)
+	database.ValidateDBVersionRow(t, allRows[1], 2, time.Now(), 3, 10, nil)
+	database.ValidateDBVersionRow(t, allRows[2], 3, time.Now(), 2, 10, nil)
+	database.ValidateDBVersionRow(t, allRows[3], 4, time.Now(), 1, 10, &codeVersionString)
+
+	// check entries of markets table
+	allRows = database.QueryAllRows(db, "markets")
+	assert.Equal(t, 0, len(allRows))
+
+	// check entries of markets table
+	allRows = database.QueryAllRows(db, "trades")
+	assert.Equal(t, 0, len(allRows))
+}

support/database/upgrade.go

@@ -59,7 +59,7 @@ func ConnectInitializedDatabase(postgresDbConfig *postgresdb.Config, upgradeScri
 	// don't defer db.Close() here becuase we want it open for the life of the application for now
 
 	log.Printf("creating db schema and running upgrade scripts ...\n")
-	e = runUpgradeScripts(db, upgradeScripts, codeVersionString)
+	e = RunUpgradeScripts(db, upgradeScripts, codeVersionString)
 	if e != nil {
 		return nil, fmt.Errorf("could not run upgrade scripts: %s", e)
 	}
@@ -68,7 +68,8 @@ func ConnectInitializedDatabase(postgresDbConfig *postgresdb.Config, upgradeScri
 	return db, nil
 }
 
-func runUpgradeScripts(db *sql.DB, scripts []*UpgradeScript, codeVersionString string) error {
+// RunUpgradeScripts is a utility function that can be run from outside this package so we need to export it
+func RunUpgradeScripts(db *sql.DB, scripts []*UpgradeScript, codeVersionString string) error {
 	// save feature flags for the db_version table here
 	hasCodeVersionString := false