finish updating documentation after refactor

2020-06-20 10:59:32 -05:00
parent 6b8e48a20e
commit 9f3e4f1102
16 changed files with 383 additions and 1143 deletions
@@ -1,112 +0,0 @@
-// VulcanizeDB
-// Copyright © 2019 Vulcanize
-
-// This program is free software: you can redistribute it and/or modify
-// it under the terms of the GNU Affero General Public License as published by
-// the Free Software Foundation, either version 3 of the License, or
-// (at your option) any later version.
-
-// This program is distributed in the hope that it will be useful,
-// but WITHOUT ANY WARRANTY; without even the implied warranty of
-// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-// GNU Affero General Public License for more details.
-
-// You should have received a copy of the GNU Affero General Public License
-// along with this program.  If not, see <http://www.gnu.org/licenses/>.
-
-package test_config
-
-import (
-	"errors"
-	"fmt"
-	"os"
-
-	"github.com/sirupsen/logrus"
-	"github.com/spf13/viper"
-	"github.com/vulcanize/ipfs-chain-watcher/pkg/config"
-	"github.com/vulcanize/ipfs-chain-watcher/pkg/core"
-	"github.com/vulcanize/ipfs-chain-watcher/pkg/postgres"
-)
-
-var TestConfig *viper.Viper
-var DBConfig config.Database
-var TestClient config.Client
-var ABIFilePath string
-
-func init() {
-	setTestConfig()
-	setABIPath()
-}
-
-func setTestConfig() {
-	TestConfig = viper.New()
-	TestConfig.SetConfigName("testing")
-	TestConfig.AddConfigPath("$GOPATH/src/github.com/vulcanize/ipfs-chain-watcher/environments/")
-	err := TestConfig.ReadInConfig()
-	if err != nil {
-		logrus.Fatal(err)
-	}
-	ipc := TestConfig.GetString("client.ipcPath")
-
-	// If we don't have an ipc path in the config file, check the env variable
-	if ipc == "" {
-		TestConfig.BindEnv("url", "INFURA_URL")
-		ipc = TestConfig.GetString("url")
-	}
-	if ipc == "" {
-		logrus.Fatal(errors.New("testing.toml IPC path or $INFURA_URL env variable need to be set"))
-	}
-
-	hn := TestConfig.GetString("database.hostname")
-	port := TestConfig.GetInt("database.port")
-	name := TestConfig.GetString("database.name")
-
-	DBConfig = config.Database{
-		Hostname: hn,
-		Name:     name,
-		Port:     port,
-	}
-	TestClient = config.Client{
-		IPCPath: ipc,
-	}
-}
-
-func setABIPath() {
-	gp := os.Getenv("GOPATH")
-	ABIFilePath = gp + "/src/github.com/vulcanize/ipfs-chain-watcher/pkg/eth/testing/"
-}
-
-func NewTestDB(node core.Node) *postgres.DB {
-	db, err := postgres.NewDB(DBConfig, node)
-	if err != nil {
-		panic(fmt.Sprintf("Could not create new test db: %v", err))
-	}
-	return db
-}
-
-func CleanTestDB(db *postgres.DB) {
-	// can't delete from nodes since this function is called after the required node is persisted
-	db.MustExec("DELETE FROM goose_db_version")
-	db.MustExec("DELETE FROM header_sync_logs")
-	db.MustExec("DELETE FROM header_sync_receipts")
-	db.MustExec("DELETE FROM header_sync_transactions")
-	db.MustExec("DELETE FROM headers")
-	db.MustExec("DELETE FROM queued_storage")
-	db.MustExec("DELETE FROM storage_diff")
-}
-
-func CleanCheckedHeadersTable(db *postgres.DB, columnNames []string) {
-	for _, name := range columnNames {
-		db.MustExec("ALTER TABLE checked_headers DROP COLUMN IF EXISTS " + name)
-	}
-}
-
-// Returns a new test node, with the same ID
-func NewTestNode() core.Node {
-	return core.Node{
-		GenesisBlock: "GENESIS",
-		NetworkID:    "1",
-		ID:           "b6f90c0fdd8ec9607aed8ee45c69322e47b7063f0bfb7a29c8ecafab24d0a22d24dd2329b5ee6ed4125a03cb14e57fd584e67f9e53e6c631055cbbd82f080845",
-		ClientName:   "Geth/v1.7.2-stable-1db4ecdc/darwin-amd64/go1.9",
-	}
-}