2019-01-25 08:59:23 +00:00
|
|
|
// Copyright © 2019 Vulcanize, Inc
|
|
|
|
//
|
|
|
|
// 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 cmd
|
|
|
|
|
|
|
|
import (
|
|
|
|
"fmt"
|
|
|
|
"log"
|
|
|
|
"os"
|
|
|
|
"plugin"
|
|
|
|
"time"
|
|
|
|
|
|
|
|
"github.com/spf13/cobra"
|
2019-01-31 23:14:42 +00:00
|
|
|
"github.com/spf13/viper"
|
2019-01-25 08:59:23 +00:00
|
|
|
|
|
|
|
"github.com/vulcanize/vulcanizedb/libraries/shared/transformer"
|
|
|
|
"github.com/vulcanize/vulcanizedb/libraries/shared/watcher"
|
|
|
|
"github.com/vulcanize/vulcanizedb/pkg/autogen"
|
|
|
|
"github.com/vulcanize/vulcanizedb/utils"
|
|
|
|
)
|
|
|
|
|
|
|
|
// executePluginCmd represents the execute command
|
|
|
|
var composeAndExecuteCmd = &cobra.Command{
|
|
|
|
Use: "composeAndExecute",
|
|
|
|
Short: "Composes, loads, and executes transformer initializer plugin",
|
|
|
|
Long: `This command needs a config .toml file of form:
|
|
|
|
|
|
|
|
[database]
|
|
|
|
name = "vulcanize_public"
|
|
|
|
hostname = "localhost"
|
|
|
|
user = "vulcanize"
|
|
|
|
password = "vulcanize"
|
|
|
|
port = 5432
|
|
|
|
|
|
|
|
[client]
|
|
|
|
ipcPath = "http://kovan0.vulcanize.io:8545"
|
|
|
|
|
|
|
|
[exporter]
|
2019-01-31 23:14:42 +00:00
|
|
|
name = "exporter"
|
2019-01-25 08:59:23 +00:00
|
|
|
[exporter.transformers]
|
2019-01-31 01:38:56 +00:00
|
|
|
transformer1 = "github.com/path/to/transformer1"
|
|
|
|
transformer2 = "github.com/path/to/transformer2"
|
|
|
|
transformer3 = "github.com/path/to/transformer3"
|
|
|
|
transformer4 = "github.com/different/path/to/transformer1"
|
|
|
|
[exporter.repositories]
|
|
|
|
transformers = "github.com/path/to"
|
|
|
|
transformer4 = "github.com/different/path
|
|
|
|
[exporter.migrations]
|
|
|
|
transformers = "db/migrations"
|
|
|
|
transformer4 = "to/db/migrations"
|
2019-01-25 08:59:23 +00:00
|
|
|
|
|
|
|
Note: If any of the imported transformer need additional
|
|
|
|
config variables do not forget to include those as well
|
|
|
|
|
|
|
|
This information is used to write and build a .so with an arbitrary transformer
|
|
|
|
set composed from the transformer imports specified in the config file
|
|
|
|
This .so is loaded as a plugin and the set of transformer initializers is
|
|
|
|
loaded into and executed over by a generic watcher`,
|
|
|
|
Run: func(cmd *cobra.Command, args []string) {
|
|
|
|
composeAndExecute()
|
|
|
|
},
|
|
|
|
}
|
|
|
|
|
|
|
|
func composeAndExecute() {
|
2019-01-31 01:38:56 +00:00
|
|
|
// generate code to build the plugin according to the config file
|
2019-01-31 23:14:42 +00:00
|
|
|
autogenConfig = autogen.Config{
|
|
|
|
FilePath: "$GOPATH/src/github.com/vulcanize/vulcanizedb/plugins",
|
|
|
|
FileName: viper.GetString("exporter.name"),
|
|
|
|
Save: viper.GetBool("exporter.save"),
|
|
|
|
Initializers: viper.GetStringMapString("exporter.transformers"),
|
|
|
|
Dependencies: viper.GetStringMapString("exporter.repositories"),
|
|
|
|
Migrations: viper.GetStringMapString("exporter.migrations"),
|
|
|
|
}
|
|
|
|
|
|
|
|
fmt.Println("generating plugin")
|
2019-01-31 01:38:56 +00:00
|
|
|
generator := autogen.NewGenerator(autogenConfig, databaseConfig)
|
|
|
|
err := generator.GenerateExporterPlugin()
|
2019-01-25 08:59:23 +00:00
|
|
|
if err != nil {
|
2019-01-31 23:14:42 +00:00
|
|
|
fmt.Println("generating plugin failed")
|
2019-01-25 08:59:23 +00:00
|
|
|
log.Fatal(err)
|
|
|
|
}
|
|
|
|
|
2019-01-31 01:38:56 +00:00
|
|
|
// Get the plugin path and load the plugin
|
|
|
|
_, pluginPath, err := autogenConfig.GetPluginPaths()
|
2019-01-25 08:59:23 +00:00
|
|
|
if err != nil {
|
|
|
|
log.Fatal(err)
|
|
|
|
}
|
2019-01-31 23:14:42 +00:00
|
|
|
if !autogenConfig.Save {
|
|
|
|
defer utils.ClearFiles(pluginPath)
|
|
|
|
}
|
|
|
|
fmt.Println("opening plugin")
|
2019-01-25 08:59:23 +00:00
|
|
|
plug, err := plugin.Open(pluginPath)
|
|
|
|
if err != nil {
|
2019-01-31 23:14:42 +00:00
|
|
|
fmt.Println("opening pluggin failed")
|
2019-01-25 08:59:23 +00:00
|
|
|
log.Fatal(err)
|
|
|
|
}
|
|
|
|
|
2019-01-31 01:38:56 +00:00
|
|
|
// Load the `Exporter` symbol from the plugin
|
2019-01-31 23:14:42 +00:00
|
|
|
fmt.Println("loading transformers from plugin")
|
2019-01-25 08:59:23 +00:00
|
|
|
symExporter, err := plug.Lookup("Exporter")
|
|
|
|
if err != nil {
|
2019-01-31 23:14:42 +00:00
|
|
|
fmt.Println("loading Exporter symbol failed")
|
2019-01-25 08:59:23 +00:00
|
|
|
log.Fatal(err)
|
|
|
|
}
|
|
|
|
|
2019-01-31 01:38:56 +00:00
|
|
|
// Assert that the symbol is of type Exporter
|
2019-01-25 08:59:23 +00:00
|
|
|
exporter, ok := symExporter.(Exporter)
|
|
|
|
if !ok {
|
|
|
|
fmt.Println("plugged-in symbol not of type Exporter")
|
|
|
|
os.Exit(1)
|
|
|
|
}
|
|
|
|
|
2019-01-31 01:38:56 +00:00
|
|
|
// Use the Exporters export method to load the TransformerInitializer set
|
2019-01-25 08:59:23 +00:00
|
|
|
initializers := exporter.Export()
|
2019-01-31 01:38:56 +00:00
|
|
|
|
|
|
|
// Setup bc and db objects
|
|
|
|
blockChain := getBlockChain()
|
|
|
|
db := utils.LoadPostgres(databaseConfig, blockChain.Node())
|
|
|
|
|
|
|
|
// Create a watcher and load the TransformerInitializer set into it
|
2019-01-25 08:59:23 +00:00
|
|
|
w := watcher.NewWatcher(&db, blockChain)
|
|
|
|
w.AddTransformers(initializers)
|
|
|
|
|
2019-01-31 01:38:56 +00:00
|
|
|
// Execute over the TransformerInitializer set using the watcher
|
2019-01-31 23:14:42 +00:00
|
|
|
fmt.Println("executing transformers")
|
2019-01-31 01:38:56 +00:00
|
|
|
ticker := time.NewTicker(pollingInterval)
|
|
|
|
defer ticker.Stop()
|
2019-01-25 08:59:23 +00:00
|
|
|
for range ticker.C {
|
|
|
|
err := w.Execute()
|
|
|
|
if err != nil {
|
|
|
|
// TODO Handle watcher errors in composeAndExecute
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
type Exporter interface {
|
|
|
|
Export() []transformer.TransformerInitializer
|
|
|
|
}
|
|
|
|
|
|
|
|
func init() {
|
|
|
|
rootCmd.AddCommand(composeAndExecuteCmd)
|
|
|
|
composeAndExecuteCmd.Flags().Int64VarP(&startingBlockNumber, "starting-block-number", "s", 0, "Block number to start transformer execution from")
|
|
|
|
}
|