From 2f36538e1edece4ce462bc9dd1881c2cc51fefa6 Mon Sep 17 00:00:00 2001 From: Paulo Truta Date: Sun, 6 Feb 2022 15:15:32 +0000 Subject: [PATCH 01/14] Installed urfave/cli/v2 lib and cleaned main(). Runs as service clock by default --- cmd/edgeboxctl/main.go | 35 ++++++++++++++++------------------- go.mod | 1 + go.sum | 9 +++++++++ 3 files changed, 26 insertions(+), 19 deletions(-) diff --git a/cmd/edgeboxctl/main.go b/cmd/edgeboxctl/main.go index e8f5b22..436055d 100644 --- a/cmd/edgeboxctl/main.go +++ b/cmd/edgeboxctl/main.go @@ -1,7 +1,6 @@ package main import ( - "flag" "fmt" "log" "os" @@ -12,6 +11,7 @@ import ( "github.com/edgebox-iot/edgeboxctl/internal/diagnostics" "github.com/edgebox-iot/edgeboxctl/internal/tasks" "github.com/edgebox-iot/edgeboxctl/internal/utils" + "github.com/urfave/cli/v2" // imports as package "cli" ) const defaultNotReadySleepTime time.Duration = time.Second * 60 @@ -19,25 +19,23 @@ const defaultSleepTime time.Duration = time.Second func main() { - // load command line arguments - - version := flag.Bool("version", false, "Get the version info") - db := flag.Bool("database", false, "Get database connection info") - name := flag.String("name", "edgebox", "Name for the service") - - flag.Parse() - - if *version { - printVersion() - os.Exit(0) + app := &cli.App{ + Name: "edgeboxctl", + Usage: "A tool to facilitate hosting apps and securing your personal data", + Action: func(c *cli.Context) error { + startService() + return nil + }, } - if *db { - printDbDetails() - os.Exit(0) + err := app.Run(os.Args) + if err != nil { + log.Fatal(err) } +} - log.Printf("Starting edgeboxctl service for %s", *name) +func startService() { + log.Printf("Starting edgeboxctl service") // setup signal catching sigs := make(chan os.Signal, 1) @@ -67,7 +65,7 @@ func main() { if isSystemReady() { tick++ // Tick is an int, so eventually will "go out of ticks?" Maybe we want to reset the ticks every once in a while, to avoid working with big numbers... - systemIterator(name, tick) + systemIterator(tick) } else { // Wait about 60 seconds before trying again. log.Printf("System not ready. Next try will be executed in 60 seconds") @@ -75,7 +73,6 @@ func main() { } } - } // AppCleanup : cleanup app state before exit @@ -108,7 +105,7 @@ func isDatabaseReady() bool { return false } -func systemIterator(name *string, tick int) { +func systemIterator(tick int) { log.Printf("Tick is %d", tick) diff --git a/go.mod b/go.mod index 1645bc4..fd837f4 100644 --- a/go.mod +++ b/go.mod @@ -12,6 +12,7 @@ require ( github.com/mattn/go-sqlite3 v1.14.7 // indirect github.com/shirou/gopsutil v3.21.4+incompatible // indirect github.com/tklauser/go-sysconf v0.3.6 // indirect + github.com/urfave/cli/v2 v2.3.0 // indirect golang.org/x/sys v0.0.0-20210531080801-fdfd190a6549 // indirect gopkg.in/yaml.v2 v2.4.0 ) diff --git a/go.sum b/go.sum index c25bdef..0e248f7 100644 --- a/go.sum +++ b/go.sum @@ -1,6 +1,8 @@ github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU= github.com/StackExchange/wmi v0.0.0-20210224194228-fe8f1750fd46 h1:5sXbqlSomvdjlRbWyNqkPsJ3Fg+tQZCbgeX1VGljbQY= github.com/StackExchange/wmi v0.0.0-20210224194228-fe8f1750fd46/go.mod h1:3eOhrUMpNV+6aFIbp5/iudMxNCF27Vw2OZgy4xEx0Fg= +github.com/cpuguy83/go-md2man/v2 v2.0.0-20190314233015-f79a8a8ca69d h1:U+s90UTSYgptZMwQh2aRr3LuazLJIa+Pg3Kc1ylSYVY= +github.com/cpuguy83/go-md2man/v2 v2.0.0-20190314233015-f79a8a8ca69d/go.mod h1:maD7wRr/U5Z6m/iR4s+kqSMx2CaBsrgA7czyZG/E6dU= github.com/dariubs/percent v0.0.0-20200128140941-b7801cf1c7e2 h1:5EPE4Uk7ucthLTJAZqZxu6LZluox5/AqXUxJDpzgJjg= github.com/dariubs/percent v0.0.0-20200128140941-b7801cf1c7e2/go.mod h1:NDZpkezJ8QqyIW/510MywB5T2KdC8v/0oTlEoPcMsRM= github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= @@ -23,8 +25,12 @@ github.com/mattn/go-sqlite3 v1.14.7/go.mod h1:NyWgC/yNuGj7Q9rpYnZvas74GogHl5/Z4A github.com/pkg/errors v0.8.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= github.com/rogpeppe/go-internal v1.3.0/go.mod h1:M8bDsm7K2OlrFYOpmOWEs/qY81heoFRclV5y23lUDJ4= +github.com/russross/blackfriday/v2 v2.0.1 h1:lPqVAte+HuHNfhJ/0LC98ESWRz8afy9tM/0RK8m9o+Q= +github.com/russross/blackfriday/v2 v2.0.1/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM= github.com/shirou/gopsutil v3.21.4+incompatible h1:fuHcTm5mX+wzo542cmYcV9RTGQLbnHLI5SyQ5ryTVck= github.com/shirou/gopsutil v3.21.4+incompatible/go.mod h1:5b4v6he4MtMOwMlS0TUMTu2PcXUg8+E1lC7eC3UO/RA= +github.com/shurcooL/sanitized_anchor_name v1.0.0 h1:PdmoCO6wvbs+7yrJyMORt4/BmY5IYyJwS/kOiWx8mHo= +github.com/shurcooL/sanitized_anchor_name v1.0.0/go.mod h1:1NzhyTcUVG4SuEtjjoZeVRXNmyL/1OwPU0+IJeTBvfc= github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI= github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4= @@ -32,6 +38,8 @@ github.com/tklauser/go-sysconf v0.3.6 h1:oc1sJWvKkmvIxhDHeKWvZS4f6AW+YcoguSfRF2/ github.com/tklauser/go-sysconf v0.3.6/go.mod h1:MkWzOF4RMCshBAMXuhXJs64Rte09mITnppBXY/rYEFI= github.com/tklauser/numcpus v0.2.2 h1:oyhllyrScuYI6g+h/zUvNXNp1wy7x8qQy3t/piefldA= github.com/tklauser/numcpus v0.2.2/go.mod h1:x3qojaO3uyYt0i56EW/VUYs7uBvdl2fkfZFu0T9wgjM= +github.com/urfave/cli/v2 v2.3.0 h1:qph92Y649prgesehzOrQjdWyxFOp/QVM+6imKHad91M= +github.com/urfave/cli/v2 v2.3.0/go.mod h1:LJmUH05zAU44vOAcrfzZQKsZbVcdbOG8rtL3/XcUArI= go.uber.org/atomic v1.6.0 h1:Ezj3JGmsOnG1MoRWQkPBsKLe9DwWD9QeXzTRzzldNVk= go.uber.org/atomic v1.6.0/go.mod h1:sABNBOSYdrvTF6hTgEIbc7YasKWGhgEQZyfxyTvoXHQ= go.uber.org/atomic v1.7.0 h1:ADUqmZGgLDDfbSL9ZmPxKTybcoEYHgpYfELNoN+7hsw= @@ -67,6 +75,7 @@ gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8 gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= gopkg.in/errgo.v2 v2.1.0/go.mod h1:hNsd1EY+bozCKY1Ytp96fpM3vjJbqLJn88ws8XvfDNI= gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= +gopkg.in/yaml.v2 v2.2.3/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= gopkg.in/yaml.v2 v2.4.0 h1:D8xgwECY7CYvx+Y2n4sBz93Jn9JRvxdiyyo8CTfuKaY= gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ= honnef.co/go/tools v0.0.1-2019.2.3/go.mod h1:a3bituU0lyd329TUQxRnasdCoJDkEUEAqEt0JzvZhAg= From c88726917ffab88b8367d3c8abafe30b054f2ed7 Mon Sep 17 00:00:00 2001 From: Paulo Truta Date: Sun, 6 Feb 2022 17:10:02 +0000 Subject: [PATCH 02/14] Minor adjustments, Example poc for sub commands with 'app start' and 'app stop' working concepts --- cmd/edgeboxctl/main.go | 56 +++++++++++++++++++++++++++++++++++- internal/tasks/tasks.go | 4 +-- internal/utils/utils.go | 6 ++-- internal/utils/utils_test.go | 4 +-- 4 files changed, 62 insertions(+), 8 deletions(-) diff --git a/cmd/edgeboxctl/main.go b/cmd/edgeboxctl/main.go index 436055d..427910c 100644 --- a/cmd/edgeboxctl/main.go +++ b/cmd/edgeboxctl/main.go @@ -1,6 +1,7 @@ package main import ( + "database/sql" "fmt" "log" "os" @@ -23,9 +24,62 @@ func main() { Name: "edgeboxctl", Usage: "A tool to facilitate hosting apps and securing your personal data", Action: func(c *cli.Context) error { - startService() + startService() // Defaults to start as a service if no commands or flags are passed return nil }, + Commands: []*cli.Command{ + { + Name: "bootstrap", + Aliases: []string{"a"}, + Usage: "Setps up initial structure and dependencies for the edgebox system", + Action: func(c *cli.Context) error { + fmt.Println("Edgebox Setup") + return nil + }, + }, + { + Name: "app", + Aliases: []string{"t"}, + Usage: "options for edgeapp management", + Subcommands: []*cli.Command{ + { + Name: "start", + Usage: "start the specified app", + Action: func(c *cli.Context) error { + fmt.Println("Starting edgeapp: ", c.Args().First()) + currentFormattedTime := utils.GetFormattedDateTime(time.Now()) + var task tasks.Task + task.ID = 0 + task.Task = "start_edgeapp" + task.Args = sql.NullString{String: fmt.Sprintf("{\"id\": \"%s\"}", c.Args().First()), Valid: true} + task.Status = string(tasks.STATUS_CREATED) + task.Created = currentFormattedTime + task.Updated = currentFormattedTime + + task = tasks.ExecuteTask(task) + return nil + }, + }, + { + Name: "stop", + Usage: "stop the specified app", + Action: func(c *cli.Context) error { + fmt.Println("Stopping edgeapp: ", c.Args().First()) + currentFormattedTime := utils.GetFormattedDateTime(time.Now()) + var task tasks.Task + task.ID = 0 + task.Task = "stop_edgeapp" + task.Args = sql.NullString{String: fmt.Sprintf("{\"id\": \"%s\"}", c.Args().First()), Valid: true} + task.Status = string(tasks.STATUS_CREATED) + task.Created = currentFormattedTime + task.Updated = currentFormattedTime + task = tasks.ExecuteTask(task) + return nil + }, + }, + }, + }, + }, } err := app.Run(os.Args) diff --git a/internal/tasks/tasks.go b/internal/tasks/tasks.go index ce465b8..774c7a5 100644 --- a/internal/tasks/tasks.go +++ b/internal/tasks/tasks.go @@ -119,7 +119,7 @@ func ExecuteTask(task Task) Task { log.Fatal(err.Error()) } - formatedDatetime := utils.GetSQLiteFormattedDateTime(time.Now()) + formatedDatetime := utils.GetFormattedDateTime(time.Now()) _, err = statement.Exec(STATUS_EXECUTING, formatedDatetime, strconv.Itoa(task.ID)) // Execute SQL Statement if err != nil { @@ -246,7 +246,7 @@ func ExecuteTask(task Task) Task { log.Fatal(err.Error()) } - formatedDatetime = utils.GetSQLiteFormattedDateTime(time.Now()) + formatedDatetime = utils.GetFormattedDateTime(time.Now()) if task.Result.Valid { _, err = statement.Exec(STATUS_FINISHED, task.Result.String, formatedDatetime, strconv.Itoa(task.ID)) // Execute SQL Statement with result info diff --git a/internal/utils/utils.go b/internal/utils/utils.go index 2eeaa35..0e5acb3 100644 --- a/internal/utils/utils.go +++ b/internal/utils/utils.go @@ -91,8 +91,8 @@ func GetSQLiteDbConnectionDetails() string { } -// GetSQLiteFormattedDateTime: Given a Time, Returns a string that is formatted ready to be inserted into an SQLite Datetime field using sql.Prepare. -func GetSQLiteFormattedDateTime(t time.Time) string { +// GetFormattedDateTime: Given a Time, Returns a string that is formatted ready to be inserted into an SQLite Datetime field using sql.Prepare. +func GetFormattedDateTime(t time.Time) string { // This date is used to indicate the layout. const datetimeLayout = "2006-01-02 15:04:05" formatedDatetime := t.Format(datetimeLayout) @@ -177,7 +177,7 @@ func WriteOption(optionKey string, optionValue string) { log.Fatal(err.Error()) } - formatedDatetime := GetSQLiteFormattedDateTime(time.Now()) + formatedDatetime := GetFormattedDateTime(time.Now()) _, err = statement.Exec(optionKey, optionValue, formatedDatetime, formatedDatetime) // Execute SQL Statement if err != nil { diff --git a/internal/utils/utils_test.go b/internal/utils/utils_test.go index eef26e2..72b8970 100644 --- a/internal/utils/utils_test.go +++ b/internal/utils/utils_test.go @@ -97,9 +97,9 @@ func TestGetPath(t *testing.T) { } } -func TestGetSQLiteFormattedDateTime(t *testing.T) { +func TestGetFormattedDateTime(t *testing.T) { datetime := time.Date(2021, time.Month(1), 01, 1, 30, 15, 0, time.UTC) - result := GetSQLiteFormattedDateTime(datetime) + result := GetFormattedDateTime(datetime) if result != "2021-01-01 01:30:15" { t.Log("Expected 2021-01-01 01:30:15 but got ", result) From 6a61ac4d178ef19b98c342cda183fdb700e346b9 Mon Sep 17 00:00:00 2001 From: Paulo Truta Date: Sun, 6 Feb 2022 17:25:41 +0000 Subject: [PATCH 03/14] Using fmt.Sprintf instead of casting int to string --- cmd/edgeboxctl/main.go | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/cmd/edgeboxctl/main.go b/cmd/edgeboxctl/main.go index 427910c..64e2bf1 100644 --- a/cmd/edgeboxctl/main.go +++ b/cmd/edgeboxctl/main.go @@ -52,7 +52,7 @@ func main() { task.ID = 0 task.Task = "start_edgeapp" task.Args = sql.NullString{String: fmt.Sprintf("{\"id\": \"%s\"}", c.Args().First()), Valid: true} - task.Status = string(tasks.STATUS_CREATED) + task.Status = fmt.Sprintf("%d", tasks.STATUS_CREATED) task.Created = currentFormattedTime task.Updated = currentFormattedTime @@ -70,7 +70,7 @@ func main() { task.ID = 0 task.Task = "stop_edgeapp" task.Args = sql.NullString{String: fmt.Sprintf("{\"id\": \"%s\"}", c.Args().First()), Valid: true} - task.Status = string(tasks.STATUS_CREATED) + task.Status = fmt.Sprintf("%d", tasks.STATUS_CREATED) task.Created = currentFormattedTime task.Updated = currentFormattedTime task = tasks.ExecuteTask(task) From 9ccb3f1d718f262c55831700afeaa6eb4a62df70 Mon Sep 17 00:00:00 2001 From: Paulo Truta Date: Mon, 7 Feb 2022 20:20:09 +0000 Subject: [PATCH 04/14] Commented out unecessary logging (should be under --verbose flag), tidy up command logic, implemented stop and start app commands --- cmd/edgeboxctl/main.go | 35 ++++++++--------------- go.mod | 5 +++- go.sum | 16 +++++++++++ internal/edgeapps/edgeapps.go | 3 +- internal/tasks/tasks.go | 53 +++++++++++++++++++++++------------ internal/utils/utils.go | 9 ++++++ 6 files changed, 78 insertions(+), 43 deletions(-) diff --git a/cmd/edgeboxctl/main.go b/cmd/edgeboxctl/main.go index 64e2bf1..cf5d04d 100644 --- a/cmd/edgeboxctl/main.go +++ b/cmd/edgeboxctl/main.go @@ -1,7 +1,6 @@ package main import ( - "database/sql" "fmt" "log" "os" @@ -46,35 +45,25 @@ func main() { Name: "start", Usage: "start the specified app", Action: func(c *cli.Context) error { - fmt.Println("Starting edgeapp: ", c.Args().First()) - currentFormattedTime := utils.GetFormattedDateTime(time.Now()) - var task tasks.Task - task.ID = 0 - task.Task = "start_edgeapp" - task.Args = sql.NullString{String: fmt.Sprintf("{\"id\": \"%s\"}", c.Args().First()), Valid: true} - task.Status = fmt.Sprintf("%d", tasks.STATUS_CREATED) - task.Created = currentFormattedTime - task.Updated = currentFormattedTime + task := tasks.ExecuteTask(tasks.GetBaseTask( + "start_edgeapp", + fmt.Sprintf("{\"id\": \"%s\"}", c.Args().First()), + )) - task = tasks.ExecuteTask(task) - return nil + return cli.Exit(utils.ColorJsonString(task.Result.String), 0) }, }, { Name: "stop", Usage: "stop the specified app", Action: func(c *cli.Context) error { - fmt.Println("Stopping edgeapp: ", c.Args().First()) - currentFormattedTime := utils.GetFormattedDateTime(time.Now()) - var task tasks.Task - task.ID = 0 - task.Task = "stop_edgeapp" - task.Args = sql.NullString{String: fmt.Sprintf("{\"id\": \"%s\"}", c.Args().First()), Valid: true} - task.Status = fmt.Sprintf("%d", tasks.STATUS_CREATED) - task.Created = currentFormattedTime - task.Updated = currentFormattedTime - task = tasks.ExecuteTask(task) - return nil + + task := tasks.ExecuteTask(tasks.GetBaseTask( + "stop_edgeapp", + fmt.Sprintf("{\"id\": \"%s\"}", c.Args().First()), + )) + + return cli.Exit(utils.ColorJsonString(task.Result.String), 0) }, }, }, diff --git a/go.mod b/go.mod index fd837f4..3a672b0 100644 --- a/go.mod +++ b/go.mod @@ -4,15 +4,18 @@ go 1.15 require ( github.com/StackExchange/wmi v0.0.0-20210224194228-fe8f1750fd46 // indirect + github.com/TylerBrock/colorjson v0.0.0-20200706003622-8a50f05110d2 // indirect github.com/dariubs/percent v0.0.0-20200128140941-b7801cf1c7e2 // indirect github.com/dustin/go-humanize v1.0.0 // indirect + github.com/fatih/color v1.13.0 // indirect github.com/go-ole/go-ole v1.2.5 // indirect github.com/go-sql-driver/mysql v1.5.0 github.com/joho/godotenv v1.3.0 + github.com/mattn/go-colorable v0.1.12 // indirect github.com/mattn/go-sqlite3 v1.14.7 // indirect github.com/shirou/gopsutil v3.21.4+incompatible // indirect github.com/tklauser/go-sysconf v0.3.6 // indirect github.com/urfave/cli/v2 v2.3.0 // indirect - golang.org/x/sys v0.0.0-20210531080801-fdfd190a6549 // indirect + golang.org/x/sys v0.0.0-20220204135822-1c1b9b1eba6a // indirect gopkg.in/yaml.v2 v2.4.0 ) diff --git a/go.sum b/go.sum index 0e248f7..201d889 100644 --- a/go.sum +++ b/go.sum @@ -1,6 +1,8 @@ github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU= github.com/StackExchange/wmi v0.0.0-20210224194228-fe8f1750fd46 h1:5sXbqlSomvdjlRbWyNqkPsJ3Fg+tQZCbgeX1VGljbQY= github.com/StackExchange/wmi v0.0.0-20210224194228-fe8f1750fd46/go.mod h1:3eOhrUMpNV+6aFIbp5/iudMxNCF27Vw2OZgy4xEx0Fg= +github.com/TylerBrock/colorjson v0.0.0-20200706003622-8a50f05110d2 h1:ZBbLwSJqkHBuFDA6DUhhse0IGJ7T5bemHyNILUjvOq4= +github.com/TylerBrock/colorjson v0.0.0-20200706003622-8a50f05110d2/go.mod h1:VSw57q4QFiWDbRnjdX8Cb3Ow0SFncRw+bA/ofY6Q83w= github.com/cpuguy83/go-md2man/v2 v2.0.0-20190314233015-f79a8a8ca69d h1:U+s90UTSYgptZMwQh2aRr3LuazLJIa+Pg3Kc1ylSYVY= github.com/cpuguy83/go-md2man/v2 v2.0.0-20190314233015-f79a8a8ca69d/go.mod h1:maD7wRr/U5Z6m/iR4s+kqSMx2CaBsrgA7czyZG/E6dU= github.com/dariubs/percent v0.0.0-20200128140941-b7801cf1c7e2 h1:5EPE4Uk7ucthLTJAZqZxu6LZluox5/AqXUxJDpzgJjg= @@ -9,6 +11,8 @@ github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSs github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= github.com/dustin/go-humanize v1.0.0 h1:VSnTsYCnlFHaM2/igO1h6X3HA71jcobQuxemgkq4zYo= github.com/dustin/go-humanize v1.0.0/go.mod h1:HtrtbFcZ19U5GC7JDqmcUSB87Iq5E25KnS6fMYU6eOk= +github.com/fatih/color v1.13.0 h1:8LOYc1KYPPmyKMuN8QV2DNRWNbLo6LZ0iLs8+mlH53w= +github.com/fatih/color v1.13.0/go.mod h1:kLAiJbzzSOZDVNGyDpeOxJ47H46qBXwg5ILebYFFOfk= github.com/go-ole/go-ole v1.2.5 h1:t4MGB5xEDZvXI+0rMjjsfBsD7yAgp/s9ZDkL1JndXwY= github.com/go-ole/go-ole v1.2.5/go.mod h1:pprOEPIfldk/42T2oK7lQ4v4JSDwmV0As9GaiUsvbm0= github.com/go-sql-driver/mysql v1.5.0 h1:ozyZYNQW3x3HtqT1jira07DN2PArx2v7/mN66gGcHOs= @@ -20,6 +24,12 @@ github.com/kisielk/gotool v1.0.0/go.mod h1:XhKaO+MFFWcvkIS/tQcRk01m1F5IRFswLeQ+o github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo= github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ= github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI= +github.com/mattn/go-colorable v0.1.9/go.mod h1:u6P/XSegPjTcexA+o6vUJrdnUu04hMope9wVRipJSqc= +github.com/mattn/go-colorable v0.1.12 h1:jF+Du6AlPIjs2BiUiQlKOX0rt3SujHxPnksPKZbaA40= +github.com/mattn/go-colorable v0.1.12/go.mod h1:u5H1YNBxpqRaxsYJYSkiCWKzEfiAb1Gb520KVy5xxl4= +github.com/mattn/go-isatty v0.0.12/go.mod h1:cbi8OIDigv2wuxKPP5vlRcQ1OAZbq2CE4Kysco4FUpU= +github.com/mattn/go-isatty v0.0.14 h1:yVuAays6BHfxijgZPzw+3Zlu5yQgKGP2/hcQbHb7S9Y= +github.com/mattn/go-isatty v0.0.14/go.mod h1:7GGIvUiUoEMVVmxf/4nioHXj79iQHKdU27kJ6hsGG94= github.com/mattn/go-sqlite3 v1.14.7 h1:fxWBnXkxfM6sRiuH3bqJ4CfzZojMOLVc0UTsTglEghA= github.com/mattn/go-sqlite3 v1.14.7/go.mod h1:NyWgC/yNuGj7Q9rpYnZvas74GogHl5/Z4A/KQRfk6bU= github.com/pkg/errors v0.8.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= @@ -62,9 +72,15 @@ golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJ golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20190916202348-b4ddaad3f8a3/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20200116001909-b77594299b42/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20200223170610-d5e6a3e2c0ae/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210316164454-77fc1eacc6aa/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210531080801-fdfd190a6549 h1:OL5GcZ2XPkte3dpfuFQ9o884vrE3BZQhajdntNMruv4= golang.org/x/sys v0.0.0-20210531080801-fdfd190a6549/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20210927094055-39ccf1dd6fa6/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20220204135822-1c1b9b1eba6a h1:ppl5mZgokTT8uPkmYOyEUmPTr3ypaKkg5eFOGrAmxxE= +golang.org/x/sys v0.0.0-20220204135822-1c1b9b1eba6a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= golang.org/x/tools v0.0.0-20190311212946-11955173bddd/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs= golang.org/x/tools v0.0.0-20190621195816-6e04913cbbac/go.mod h1:/rFqwRUd4F7ZHNgwSSTFct+R/Kf4OFW1sUzUTQQTgfc= diff --git a/internal/edgeapps/edgeapps.go b/internal/edgeapps/edgeapps.go index 79ae78e..5a8a792 100644 --- a/internal/edgeapps/edgeapps.go +++ b/internal/edgeapps/edgeapps.go @@ -81,7 +81,8 @@ func GetEdgeApp(ID string) MaybeEdgeApp { myEdgeAppServiceEnv, err := godotenv.Read(utils.GetPath("edgeAppsPath") + ID + myEdgeAppServiceEnvFilename) if err != nil { - log.Println("No myedge.app environment file found. Status is Network-Only") + // log.Println("No myedge.app environment file found. Status is Network-Only") + // File probably not found! } else { if myEdgeAppServiceEnv["INTERNET_URL"] != "" { edgeAppInternetAccessible = true diff --git a/internal/tasks/tasks.go b/internal/tasks/tasks.go index 774c7a5..37adc21 100644 --- a/internal/tasks/tasks.go +++ b/internal/tasks/tasks.go @@ -69,6 +69,23 @@ const STATUS_EXECUTING int = 1 const STATUS_FINISHED int = 2 const STATUS_ERROR int = 3 +func GetBaseTask(taskCode string, argsString string) Task { + currentFormattedTime := utils.GetFormattedDateTime(time.Now()) + task := Task{ + ID: 0, + Task: taskCode, + Args: sql.NullString{ + String: argsString, + Valid: true, + }, + Status: fmt.Sprintf("%d", STATUS_CREATED), + Created: currentFormattedTime, + Updated: currentFormattedTime, + } + + return task +} + // GetNextTask : Performs a MySQL query over the device's Edgebox API func GetNextTask() Task { @@ -129,8 +146,8 @@ func ExecuteTask(task Task) Task { if diagnostics.GetReleaseVersion() == diagnostics.DEV_VERSION { log.Printf("Dev environemnt. Not executing tasks.") } else { - log.Println("Task: " + task.Task) - log.Println("Args: " + task.Args.String) + // log.Println("Task: " + task.Task) + // log.Println("Args: " + task.Args.String) switch task.Task { case "setup_tunnel": @@ -327,7 +344,7 @@ func ExecuteSchedules(tick int) { } func taskSetupTunnel(args taskSetupTunnelArgs) string { - fmt.Println("Executing taskSetupTunnel") + // // fmt.Println("Executing taskSetupTunnel") cmdargs := []string{"gen", "--name", args.NodeName, "--token", args.BootnodeToken, args.BootnodeAddress + ":8655", "--prefix", args.AssignedAddress} utils.Exec(utils.GetPath("wsPath"), "tinc-boot", cmdargs) @@ -343,7 +360,7 @@ func taskSetupTunnel(args taskSetupTunnelArgs) string { } func taskInstallEdgeApp(args taskInstallEdgeAppArgs) string { - fmt.Println("Executing taskInstallEdgeApp for " + args.ID) + // fmt.Println("Executing taskInstallEdgeApp for " + args.ID) result := edgeapps.SetEdgeAppInstalled(args.ID) resultJSON, _ := json.Marshal(result) @@ -353,7 +370,7 @@ func taskInstallEdgeApp(args taskInstallEdgeAppArgs) string { } func taskRemoveEdgeApp(args taskRemoveEdgeAppArgs) string { - fmt.Println("Executing taskRemoveEdgeApp for " + args.ID) + // fmt.Println("Executing taskRemoveEdgeApp for " + args.ID) // Making sure the application is stopped before setting it as removed. edgeapps.StopEdgeApp(args.ID) @@ -365,7 +382,7 @@ func taskRemoveEdgeApp(args taskRemoveEdgeAppArgs) string { } func taskStartEdgeApp(args taskStartEdgeAppArgs) string { - fmt.Println("Executing taskStartEdgeApp for " + args.ID) + // fmt.Println("Executing taskStartEdgeApp for " + args.ID) result := edgeapps.RunEdgeApp(args.ID) resultJSON, _ := json.Marshal(result) @@ -375,7 +392,7 @@ func taskStartEdgeApp(args taskStartEdgeAppArgs) string { } func taskStopEdgeApp(args taskStopEdgeAppArgs) string { - fmt.Println("Executing taskStopEdgeApp for " + args.ID) + // fmt.Println("Executing taskStopEdgeApp for " + args.ID) result := edgeapps.StopEdgeApp(args.ID) resultJSON, _ := json.Marshal(result) @@ -385,7 +402,7 @@ func taskStopEdgeApp(args taskStopEdgeAppArgs) string { } func taskEnableOnline(args taskEnableOnlineArgs) string { - fmt.Println("Executing taskEnableOnline for " + args.ID) + // fmt.Println("Executing taskEnableOnline for " + args.ID) result := edgeapps.EnableOnline(args.ID, args.InternetURL) resultJSON, _ := json.Marshal(result) @@ -395,7 +412,7 @@ func taskEnableOnline(args taskEnableOnlineArgs) string { } func taskDisableOnline(args taskDisableOnlineArgs) string { - fmt.Println("Executing taskDisableOnline for " + args.ID) + // fmt.Println("Executing taskDisableOnline for " + args.ID) result := edgeapps.DisableOnline(args.ID) resultJSON, _ := json.Marshal(result) @@ -405,7 +422,7 @@ func taskDisableOnline(args taskDisableOnlineArgs) string { } func taskEnablePublicDashboard(args taskEnablePublicDashboardArgs) string { - fmt.Println("Enabling taskEnablePublicDashboard") + // fmt.Println("Enabling taskEnablePublicDashboard") result := edgeapps.EnablePublicDashboard(args.InternetURL) if result { @@ -418,7 +435,7 @@ func taskEnablePublicDashboard(args taskEnablePublicDashboardArgs) string { } func taskDisablePublicDashboard() string { - fmt.Println("Executing taskDisablePublicDashboard") + // fmt.Println("Executing taskDisablePublicDashboard") result := edgeapps.DisablePublicDashboard() utils.WriteOption("PUBLIC_DASHBOARD", "") if result { @@ -429,7 +446,7 @@ func taskDisablePublicDashboard() string { func taskSetReleaseVersion() string { - fmt.Println("Executing taskSetReleaseVersion") + // fmt.Println("Executing taskSetReleaseVersion") utils.WriteOption("RELEASE_VERSION", diagnostics.Version) @@ -437,7 +454,7 @@ func taskSetReleaseVersion() string { } func taskGetEdgeApps() string { - fmt.Println("Executing taskGetEdgeApps") + // fmt.Println("Executing taskGetEdgeApps") edgeApps := edgeapps.GetEdgeApps() edgeAppsJSON, _ := json.Marshal(edgeApps) @@ -447,14 +464,14 @@ func taskGetEdgeApps() string { } func taskGetSystemUptime() string { - fmt.Println("Executing taskGetSystemUptime") + // fmt.Println("Executing taskGetSystemUptime") uptime := system.GetUptimeInSeconds() utils.WriteOption("SYSTEM_UPTIME", uptime) return uptime } func taskGetStorageDevices() string { - fmt.Println("Executing taskGetStorageDevices") + // fmt.Println("Executing taskGetStorageDevices") devices := storage.GetDevices(diagnostics.GetReleaseVersion()) devicesJSON, _ := json.Marshal(devices) @@ -465,20 +482,20 @@ func taskGetStorageDevices() string { } func taskGetSystemIP() string { - fmt.Println("Executing taskGetStorageDevices") + // fmt.Println("Executing taskGetStorageDevices") ip := system.GetIP() utils.WriteOption("IP_ADDRESS", ip) return ip } func taskGetHostname() string { - fmt.Println("Executing taskGetHostname") + // fmt.Println("Executing taskGetHostname") hostname := system.GetHostname() utils.WriteOption("HOSTNAME", hostname) return hostname } func taskSetupCloudOptions() { - fmt.Println("Executing taskSetupCloudOptions") + // fmt.Println("Executing taskSetupCloudOptions") system.SetupCloudOptions() } diff --git a/internal/utils/utils.go b/internal/utils/utils.go index 0e5acb3..28142ca 100644 --- a/internal/utils/utils.go +++ b/internal/utils/utils.go @@ -4,6 +4,7 @@ import ( "bufio" "bytes" "database/sql" + "encoding/json" "fmt" "io" "log" @@ -12,6 +13,7 @@ import ( "strings" "time" + "github.com/TylerBrock/colorjson" "github.com/joho/godotenv" ) @@ -186,3 +188,10 @@ func WriteOption(optionKey string, optionValue string) { db.Close() } + +func ColorJsonString(jsonString string) string { + var obj map[string]interface{} + json.Unmarshal([]byte(jsonString), &obj) + resultJSON, _ := colorjson.Marshal(obj) + return string(resultJSON) +} From a44c44baa8517b5662f8021e03128744c8f82550 Mon Sep 17 00:00:00 2001 From: Paulo Truta Date: Mon, 7 Feb 2022 20:39:53 +0000 Subject: [PATCH 05/14] Added validation for argument in start/stop app command. Colorized error output on validation fail --- cmd/edgeboxctl/main.go | 24 +++++++++++++++++++----- go.mod | 1 + go.sum | 2 ++ 3 files changed, 22 insertions(+), 5 deletions(-) diff --git a/cmd/edgeboxctl/main.go b/cmd/edgeboxctl/main.go index cf5d04d..802db2c 100644 --- a/cmd/edgeboxctl/main.go +++ b/cmd/edgeboxctl/main.go @@ -11,12 +11,16 @@ import ( "github.com/edgebox-iot/edgeboxctl/internal/diagnostics" "github.com/edgebox-iot/edgeboxctl/internal/tasks" "github.com/edgebox-iot/edgeboxctl/internal/utils" - "github.com/urfave/cli/v2" // imports as package "cli" + "github.com/mitchellh/colorstring" + "github.com/urfave/cli/v2" // imports as package "cli", ) const defaultNotReadySleepTime time.Duration = time.Second * 60 const defaultSleepTime time.Duration = time.Second +var errorMissingApplicationSlug = colorstring.Color("[red]Error: [white]Missing application slug") +var errorUnexpected = colorstring.Color("[red]An unexpected error ocurring and the application crashed") + func main() { app := &cli.App{ @@ -29,7 +33,7 @@ func main() { Commands: []*cli.Command{ { Name: "bootstrap", - Aliases: []string{"a"}, + Aliases: []string{"b"}, Usage: "Setps up initial structure and dependencies for the edgebox system", Action: func(c *cli.Context) error { fmt.Println("Edgebox Setup") @@ -38,13 +42,19 @@ func main() { }, { Name: "app", - Aliases: []string{"t"}, + Aliases: []string{"a"}, Usage: "options for edgeapp management", Subcommands: []*cli.Command{ { - Name: "start", - Usage: "start the specified app", + Name: "start", + Aliases: []string{"s"}, + Usage: "start the specified app", Action: func(c *cli.Context) error { + + if c.Args().Get(0) == "" { + return cli.Exit(errorMissingApplicationSlug, 1) + } + task := tasks.ExecuteTask(tasks.GetBaseTask( "start_edgeapp", fmt.Sprintf("{\"id\": \"%s\"}", c.Args().First()), @@ -58,6 +68,10 @@ func main() { Usage: "stop the specified app", Action: func(c *cli.Context) error { + if c.Args().Get(0) == "" { + return cli.Exit(errorMissingApplicationSlug, 1) + } + task := tasks.ExecuteTask(tasks.GetBaseTask( "stop_edgeapp", fmt.Sprintf("{\"id\": \"%s\"}", c.Args().First()), diff --git a/go.mod b/go.mod index 3a672b0..b346f1b 100644 --- a/go.mod +++ b/go.mod @@ -13,6 +13,7 @@ require ( github.com/joho/godotenv v1.3.0 github.com/mattn/go-colorable v0.1.12 // indirect github.com/mattn/go-sqlite3 v1.14.7 // indirect + github.com/mitchellh/colorstring v0.0.0-20190213212951-d06e56a500db // indirect github.com/shirou/gopsutil v3.21.4+incompatible // indirect github.com/tklauser/go-sysconf v0.3.6 // indirect github.com/urfave/cli/v2 v2.3.0 // indirect diff --git a/go.sum b/go.sum index 201d889..52ebafe 100644 --- a/go.sum +++ b/go.sum @@ -32,6 +32,8 @@ github.com/mattn/go-isatty v0.0.14 h1:yVuAays6BHfxijgZPzw+3Zlu5yQgKGP2/hcQbHb7S9 github.com/mattn/go-isatty v0.0.14/go.mod h1:7GGIvUiUoEMVVmxf/4nioHXj79iQHKdU27kJ6hsGG94= github.com/mattn/go-sqlite3 v1.14.7 h1:fxWBnXkxfM6sRiuH3bqJ4CfzZojMOLVc0UTsTglEghA= github.com/mattn/go-sqlite3 v1.14.7/go.mod h1:NyWgC/yNuGj7Q9rpYnZvas74GogHl5/Z4A/KQRfk6bU= +github.com/mitchellh/colorstring v0.0.0-20190213212951-d06e56a500db h1:62I3jR2EmQ4l5rM/4FEfDWcRD+abF5XlKShorW5LRoQ= +github.com/mitchellh/colorstring v0.0.0-20190213212951-d06e56a500db/go.mod h1:l0dey0ia/Uv7NcFFVbCLtqEBQbrT4OCwCSKTEv6enCw= github.com/pkg/errors v0.8.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= github.com/rogpeppe/go-internal v1.3.0/go.mod h1:M8bDsm7K2OlrFYOpmOWEs/qY81heoFRclV5y23lUDJ4= From 1427a023fda40b4e5063afc5d0798616b2f72a72 Mon Sep 17 00:00:00 2001 From: Paulo Truta Date: Wed, 9 Feb 2022 22:53:15 +0000 Subject: [PATCH 06/14] Reworked command route handler logic, fixed arguments for enable_online commands --- cmd/edgeboxctl/main.go | 171 +++++++++++++++++++++++++++++++++++++---- 1 file changed, 154 insertions(+), 17 deletions(-) diff --git a/cmd/edgeboxctl/main.go b/cmd/edgeboxctl/main.go index 802db2c..ed1b6da 100644 --- a/cmd/edgeboxctl/main.go +++ b/cmd/edgeboxctl/main.go @@ -46,40 +46,153 @@ func main() { Usage: "options for edgeapp management", Subcommands: []*cli.Command{ { - Name: "start", - Aliases: []string{"s"}, - Usage: "start the specified app", + Name: "install", + Aliases: []string{"i"}, + Usage: "install the specified app (slug or package file)", Action: func(c *cli.Context) error { - if c.Args().Get(0) == "" { - return cli.Exit(errorMissingApplicationSlug, 1) + argumentError := checkArgumentsPresence(c, 1) + if argumentError != nil { + return argumentError } - task := tasks.ExecuteTask(tasks.GetBaseTask( - "start_edgeapp", - fmt.Sprintf("{\"id\": \"%s\"}", c.Args().First()), - )) + task := getCommandTask("install_edgeapp", fmt.Sprintf("{\"id\": \"%s\"}", c.Args().First()), true) return cli.Exit(utils.ColorJsonString(task.Result.String), 0) }, }, { - Name: "stop", - Usage: "stop the specified app", + Name: "remove", + Aliases: []string{"r"}, + Usage: "remove the specified app", Action: func(c *cli.Context) error { - if c.Args().Get(0) == "" { - return cli.Exit(errorMissingApplicationSlug, 1) + argumentError := checkArgumentsPresence(c, 1) + if argumentError != nil { + return argumentError } - task := tasks.ExecuteTask(tasks.GetBaseTask( - "stop_edgeapp", - fmt.Sprintf("{\"id\": \"%s\"}", c.Args().First()), - )) + task := getCommandTask("remove_edgeapp", fmt.Sprintf("{\"id\": \"%s\"}", c.Args().First()), true) return cli.Exit(utils.ColorJsonString(task.Result.String), 0) }, }, + { + Name: "start", + Aliases: []string{"s"}, + Usage: "start the specified app", + Action: func(c *cli.Context) error { + + argumentError := checkArgumentsPresence(c, 1) + if argumentError != nil { + return argumentError + } + + task := getCommandTask("start_edgeapp", fmt.Sprintf("{\"id\": \"%s\"}", c.Args().First()), true) + + return cli.Exit(utils.ColorJsonString(task.Result.String), 0) + }, + }, + { + Name: "stop", + Aliases: []string{"k"}, + Usage: "stop the specified app", + Action: func(c *cli.Context) error { + + argumentError := checkArgumentsPresence(c, 1) + if argumentError != nil { + return argumentError + } + + task := getCommandTask("stop_edgeapp", fmt.Sprintf("{\"id\": \"%s\"}", c.Args().First()), true) + + return cli.Exit(utils.ColorJsonString(task.Result.String), 0) + }, + }, + { + Name: "online", + Aliases: []string{"o"}, + Usage: "set an app status for online access", + Subcommands: []*cli.Command{ + { + Name: "enable", + Aliases: []string{"e"}, + Usage: "set an app as accessible online", + Action: func(c *cli.Context) error { + + argumentError := checkArgumentsPresence(c, 2) + if argumentError != nil { + return argumentError + } + + task := getCommandTask( + "enable_online", + fmt.Sprintf( + "{\"id\": \"%s\", \"internet_url\": \"%s\"}", + c.Args().Get(0), + c.Args().Get(1), + ), + true, + ) + + return cli.Exit(utils.ColorJsonString(task.Result.String), 0) + }, + }, + { + Name: "disable", + Aliases: []string{"d"}, + Usage: "set an app as local-network private", + Action: func(c *cli.Context) error { + + argumentError := checkArgumentsPresence(c, 1) + if argumentError != nil { + return argumentError + } + + task := getCommandTask("disable_online", fmt.Sprintf("{\"id\": \"%s\"}", c.Args().First()), true) + + return cli.Exit(utils.ColorJsonString(task.Result.String), 0) + }, + }, + }, + }, + }, + }, + { + Name: "dashboard", + Aliases: []string{"d"}, + Usage: "set dashboard access", + Subcommands: []*cli.Command{ + { + Name: "enable", + Aliases: []string{"e"}, + Usage: "enable dashboard access", + Action: func(c *cli.Context) error { + argumentError := checkArgumentsPresence(c, 1) + if argumentError != nil { + return argumentError + } + + task := getCommandTask("enable_public_dashboard", fmt.Sprintf("{\"internet_url\": \"%s\"}", c.Args().First()), true) + return cli.Exit(utils.ColorJsonString(task.Result.String), 0) + }, + }, + { + Name: "disable", + Aliases: []string{"d"}, + Usage: "disable dashboard access", + Action: func(c *cli.Context) error { + + argumentError := checkArgumentsPresence(c, 1) + if argumentError != nil { + return argumentError + } + + task := getCommandTask("disable_public_dashboard", "", true) + return cli.Exit(utils.ColorJsonString(task.Result.String), 0) + + }, + }, }, }, }, @@ -91,6 +204,30 @@ func main() { } } +func checkArgumentsPresence(c *cli.Context, count int) error { + if count != 0 { + for i := 0; i < count; i++ { + if c.Args().Get(i) == "" { + return cli.Exit(errorMissingApplicationSlug, 1) + } + } + } + return nil +} + +func getCommandTask(taskSlug string, taskArgs string, execute bool) tasks.Task { + task := tasks.GetBaseTask( + taskSlug, + taskArgs, + ) + + if execute { + task = tasks.ExecuteTask(task) + } + + return task +} + func startService() { log.Printf("Starting edgeboxctl service") From a2492ef59cabe5c7d8eef9b55ad7f30677fced03 Mon Sep 17 00:00:00 2001 From: Paulo Truta Date: Wed, 9 Feb 2022 23:06:50 +0000 Subject: [PATCH 07/14] Implemented command for tunnel setup and stubs for enabling and disabling the tunnel# --- cmd/edgeboxctl/main.go | 50 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) diff --git a/cmd/edgeboxctl/main.go b/cmd/edgeboxctl/main.go index ed1b6da..aed4ad3 100644 --- a/cmd/edgeboxctl/main.go +++ b/cmd/edgeboxctl/main.go @@ -20,6 +20,7 @@ const defaultSleepTime time.Duration = time.Second var errorMissingApplicationSlug = colorstring.Color("[red]Error: [white]Missing application slug") var errorUnexpected = colorstring.Color("[red]An unexpected error ocurring and the application crashed") +var notYetImplemented = colorstring.Color("[yellow]This feature is not yet implemented, this command is only a stub.") func main() { @@ -40,6 +41,55 @@ func main() { return nil }, }, + { + Name: "tunnel", + Aliases: []string{"t"}, + Usage: "Edgebox tunnel settings", + Subcommands: []*cli.Command{ + { + Name: "setup", + Aliases: []string{"s"}, + Usage: "Sets up an encrypted secure connection to a tunnel", + Action: func(c *cli.Context) error { + + argumentError := checkArgumentsPresence(c, 4) + if argumentError != nil { + return argumentError + } + + task := getCommandTask( + "setup_tunnel", + fmt.Sprintf( + "{\"bootnode_address\": \"%s\", \"token\": \"%s\", \"assigned_address\": \"%s\", \"node_name\": \"%s\"}", + c.Args().Get(0), + c.Args().Get(1), + c.Args().Get(2), + c.Args().Get(3), + ), + true, + ) + + return cli.Exit(utils.ColorJsonString(task.Result.String), 0) + }, + }, + { + Name: "enable", + Aliases: []string{"e"}, + Usage: "enables the public tunnel (when configured)", + Action: func(c *cli.Context) error { + return cli.Exit(notYetImplemented, 1) + }, + }, + { + Name: "disable", + Aliases: []string{"d"}, + Usage: "disables the public tunnel (when online)", + Action: func(c *cli.Context) error { + return cli.Exit(notYetImplemented, 1) + }, + }, + }, + }, { Name: "app", Aliases: []string{"a"}, From 9eb47f3248af2864b407bb6895666864d21f7cab Mon Sep 17 00:00:00 2001 From: Paulo Truta Date: Wed, 9 Feb 2022 23:27:33 +0000 Subject: [PATCH 08/14] Implemented list command + task. colorjson output disabled for this command (bug detected) --- cmd/edgeboxctl/main.go | 10 ++++++++++ internal/tasks/tasks.go | 6 ++++++ 2 files changed, 16 insertions(+) diff --git a/cmd/edgeboxctl/main.go b/cmd/edgeboxctl/main.go index aed4ad3..4b9c9fc 100644 --- a/cmd/edgeboxctl/main.go +++ b/cmd/edgeboxctl/main.go @@ -95,6 +95,16 @@ func main() { Aliases: []string{"a"}, Usage: "options for edgeapp management", Subcommands: []*cli.Command{ + { + Name: "list", + Aliases: []string{"i"}, + Usage: "list currently installed apps and their status", + Action: func(c *cli.Context) error { + task := getCommandTask("list_edgeapps", "", true) + // return cli.Exit(utils.ColorJsonString(task.Result.String), 0) + return cli.Exit(task.Result.String, 0) + }, + }, { Name: "install", Aliases: []string{"i"}, diff --git a/internal/tasks/tasks.go b/internal/tasks/tasks.go index 37adc21..43c8aab 100644 --- a/internal/tasks/tasks.go +++ b/internal/tasks/tasks.go @@ -161,6 +161,12 @@ func ExecuteTask(task Task) Task { task.Result = sql.NullString{String: taskResult, Valid: true} } + case "list_edgeapps": + + log.Println("Fetching current status on Edgeapps...") + taskResult := taskGetEdgeApps() + task.Result = sql.NullString{String: taskResult, Valid: true} + case "install_edgeapp": log.Println("Installing EdgeApp...") From 23f9926b4bc9dc76fbddf91bc71dec20abf4bc7f Mon Sep 17 00:00:00 2001 From: Paulo Truta Date: Sat, 12 Feb 2022 13:36:35 +0100 Subject: [PATCH 09/14] Update cmd/edgeboxctl/main.go Co-authored-by: Malachi Soord --- cmd/edgeboxctl/main.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cmd/edgeboxctl/main.go b/cmd/edgeboxctl/main.go index 4b9c9fc..c2ceb66 100644 --- a/cmd/edgeboxctl/main.go +++ b/cmd/edgeboxctl/main.go @@ -35,7 +35,7 @@ func main() { { Name: "bootstrap", Aliases: []string{"b"}, - Usage: "Setps up initial structure and dependencies for the edgebox system", + Usage: "Sets up initial structure and dependencies for the edgebox system", Action: func(c *cli.Context) error { fmt.Println("Edgebox Setup") return nil From 09f07c01dbf68ba206e99c75b54bd892ca75404c Mon Sep 17 00:00:00 2001 From: Paulo Truta Date: Sun, 13 Feb 2022 14:40:04 +0000 Subject: [PATCH 10/14] Fixed shorthand command and fixed incomplete func comment --- cmd/edgeboxctl/main.go | 2 +- internal/edgeapps/edgeapps.go | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/cmd/edgeboxctl/main.go b/cmd/edgeboxctl/main.go index 4b9c9fc..fd40a63 100644 --- a/cmd/edgeboxctl/main.go +++ b/cmd/edgeboxctl/main.go @@ -97,7 +97,7 @@ func main() { Subcommands: []*cli.Command{ { Name: "list", - Aliases: []string{"i"}, + Aliases: []string{"l"}, Usage: "list currently installed apps and their status", Action: func(c *cli.Context) error { task := getCommandTask("list_edgeapps", "", true) diff --git a/internal/edgeapps/edgeapps.go b/internal/edgeapps/edgeapps.go index 5a8a792..604e74e 100644 --- a/internal/edgeapps/edgeapps.go +++ b/internal/edgeapps/edgeapps.go @@ -236,7 +236,7 @@ func GetEdgeAppStatus(ID string) EdgeAppStatus { } -// GetEdgeAppServices : Returns a +// GetEdgeAppServices : Returns a list of services for a single edgeapp func GetEdgeAppServices(ID string) []EdgeAppService { cmdArgs := []string{"-r", ".services | keys[]", utils.GetPath("edgeAppsPath") + ID + configFilename} From 01dc4943b1b353ad427ebf12d15a7d581247cf38 Mon Sep 17 00:00:00 2001 From: Paulo Truta Date: Mon, 14 Feb 2022 17:23:08 +0000 Subject: [PATCH 11/14] Various polishments, now validating that ws is ready to run for every command --- cmd/edgeboxctl/main.go | 47 +++++++++++++++++++++++------------------ internal/utils/utils.go | 13 +++++++++++- 2 files changed, 39 insertions(+), 21 deletions(-) diff --git a/cmd/edgeboxctl/main.go b/cmd/edgeboxctl/main.go index 48cdb0e..d99afdf 100644 --- a/cmd/edgeboxctl/main.go +++ b/cmd/edgeboxctl/main.go @@ -19,8 +19,8 @@ const defaultNotReadySleepTime time.Duration = time.Second * 60 const defaultSleepTime time.Duration = time.Second var errorMissingApplicationSlug = colorstring.Color("[red]Error: [white]Missing application slug") -var errorUnexpected = colorstring.Color("[red]An unexpected error ocurring and the application crashed") -var notYetImplemented = colorstring.Color("[yellow]This feature is not yet implemented, this command is only a stub.") +var errorSystemNotReady = colorstring.Color("[red]Eror: [white]The system is not ready to run. \n[white]Please run 'cd /home/system/components/ws/ && ./ws -b' first.") +var errorNotYetImplemented = colorstring.Color("[yellow]This feature is not yet implemented, this command is only a stub.") func main() { @@ -37,8 +37,7 @@ func main() { Aliases: []string{"b"}, Usage: "Sets up initial structure and dependencies for the edgebox system", Action: func(c *cli.Context) error { - fmt.Println("Edgebox Setup") - return nil + return cli.Exit(errorNotYetImplemented, 1) }, }, { @@ -50,6 +49,7 @@ func main() { Name: "setup", Aliases: []string{"s"}, Usage: "Sets up an encrypted secure connection to a tunnel", + Before: canRunCommands, Action: func(c *cli.Context) error { argumentError := checkArgumentsPresence(c, 4) @@ -76,16 +76,18 @@ func main() { Name: "enable", Aliases: []string{"e"}, Usage: "enables the public tunnel (when configured)", + Before: canRunCommands, Action: func(c *cli.Context) error { - return cli.Exit(notYetImplemented, 1) + return cli.Exit(errorNotYetImplemented, 1) }, }, { Name: "disable", Aliases: []string{"d"}, Usage: "disables the public tunnel (when online)", + Before: canRunCommands, Action: func(c *cli.Context) error { - return cli.Exit(notYetImplemented, 1) + return cli.Exit(errorNotYetImplemented, 1) }, }, }, @@ -99,6 +101,7 @@ func main() { Name: "list", Aliases: []string{"l"}, Usage: "list currently installed apps and their status", + Before: canRunCommands, Action: func(c *cli.Context) error { task := getCommandTask("list_edgeapps", "", true) // return cli.Exit(utils.ColorJsonString(task.Result.String), 0) @@ -109,6 +112,7 @@ func main() { Name: "install", Aliases: []string{"i"}, Usage: "install the specified app (slug or package file)", + Before: canRunCommands, Action: func(c *cli.Context) error { argumentError := checkArgumentsPresence(c, 1) @@ -125,6 +129,7 @@ func main() { Name: "remove", Aliases: []string{"r"}, Usage: "remove the specified app", + Before: canRunCommands, Action: func(c *cli.Context) error { argumentError := checkArgumentsPresence(c, 1) @@ -141,6 +146,7 @@ func main() { Name: "start", Aliases: []string{"s"}, Usage: "start the specified app", + Before: canRunCommands, Action: func(c *cli.Context) error { argumentError := checkArgumentsPresence(c, 1) @@ -157,6 +163,7 @@ func main() { Name: "stop", Aliases: []string{"k"}, Usage: "stop the specified app", + Before: canRunCommands, Action: func(c *cli.Context) error { argumentError := checkArgumentsPresence(c, 1) @@ -178,6 +185,7 @@ func main() { Name: "enable", Aliases: []string{"e"}, Usage: "set an app as accessible online", + Before: canRunCommands, Action: func(c *cli.Context) error { argumentError := checkArgumentsPresence(c, 2) @@ -202,6 +210,7 @@ func main() { Name: "disable", Aliases: []string{"d"}, Usage: "set an app as local-network private", + Before: canRunCommands, Action: func(c *cli.Context) error { argumentError := checkArgumentsPresence(c, 1) @@ -227,6 +236,7 @@ func main() { Name: "enable", Aliases: []string{"e"}, Usage: "enable dashboard access", + Before: canRunCommands, Action: func(c *cli.Context) error { argumentError := checkArgumentsPresence(c, 1) if argumentError != nil { @@ -241,6 +251,7 @@ func main() { Name: "disable", Aliases: []string{"d"}, Usage: "disable dashboard access", + Before: canRunCommands, Action: func(c *cli.Context) error { argumentError := checkArgumentsPresence(c, 1) @@ -264,6 +275,14 @@ func main() { } } +func canRunCommands(c *cli.Context) error { + if !utils.IsSystemReady() { + return cli.Exit(errorSystemNotReady, 1) + } + + return nil +} + func checkArgumentsPresence(c *cli.Context, count int) error { if count != 0 { for i := 0; i < count; i++ { @@ -309,7 +328,6 @@ func startService() { }() printVersion() - printDbDetails() tick := 0 @@ -317,7 +335,7 @@ func startService() { // infinite loop for { - if isSystemReady() { + if utils.IsSystemReady() { tick++ // Tick is an int, so eventually will "go out of ticks?" Maybe we want to reset the ticks every once in a while, to avoid working with big numbers... systemIterator(tick) } else { @@ -348,17 +366,6 @@ func printDbDetails() { ) } -// IsSystemReady : Checks hability of the service to execute commands (Only after "edgebox --build" is ran at least once via SSH, or if built for distribution) -func isSystemReady() bool { - _, err := os.Stat("/home/system/components/ws/.ready") - return !os.IsNotExist(err) -} - -// IsDatabaseReady : Checks is it can successfully connect to the task queue db -func isDatabaseReady() bool { - return false -} - func systemIterator(tick int) { log.Printf("Tick is %d", tick) @@ -376,7 +383,7 @@ func systemIterator(tick int) { log.Printf("No tasks to execute.") } - // Wait about 1 second before resumming operations. + // Wait about 1 second before resuming operations. log.Printf("Next instruction will be executed 1 second") time.Sleep(defaultSleepTime) diff --git a/internal/utils/utils.go b/internal/utils/utils.go index 28142ca..6ede10d 100644 --- a/internal/utils/utils.go +++ b/internal/utils/utils.go @@ -93,7 +93,7 @@ func GetSQLiteDbConnectionDetails() string { } -// GetFormattedDateTime: Given a Time, Returns a string that is formatted ready to be inserted into an SQLite Datetime field using sql.Prepare. +// GetFormattedDateTime: Given a Time, Returns a string that is formatted to be passed around the application, including correctly inserting SQLite Datetime field using sql.Prepare. func GetFormattedDateTime(t time.Time) string { // This date is used to indicate the layout. const datetimeLayout = "2006-01-02 15:04:05" @@ -189,6 +189,17 @@ func WriteOption(optionKey string, optionValue string) { db.Close() } +// IsSystemReady : Checks hability of the service to execute commands (Only after "edgebox --build" is ran at least once via SSH, or if built for distribution) +func IsSystemReady() bool { + _, err := os.Stat("/home/system/components/ws/.ready") + return !os.IsNotExist(err) +} + +// IsDatabaseReady : Checks is it can successfully connect to the task queue db +func IsDatabaseReady() bool { + return false +} + func ColorJsonString(jsonString string) string { var obj map[string]interface{} json.Unmarshal([]byte(jsonString), &obj) From a33a6f5e84bffdc8bcfb76a0d00f9604aeec67f9 Mon Sep 17 00:00:00 2001 From: Paulo Truta Date: Mon, 14 Feb 2022 21:33:10 +0100 Subject: [PATCH 12/14] Update internal/utils/utils.go Thanks @inverse ! Co-authored-by: Malachi Soord --- internal/utils/utils.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/internal/utils/utils.go b/internal/utils/utils.go index 6ede10d..fc6ce85 100644 --- a/internal/utils/utils.go +++ b/internal/utils/utils.go @@ -191,7 +191,7 @@ func WriteOption(optionKey string, optionValue string) { // IsSystemReady : Checks hability of the service to execute commands (Only after "edgebox --build" is ran at least once via SSH, or if built for distribution) func IsSystemReady() bool { - _, err := os.Stat("/home/system/components/ws/.ready") + _, err := os.Stat(GetPath("wsPath") + ".ready") return !os.IsNotExist(err) } From b6bf06172c83fae2a0015d8e57603fcf2bf76469 Mon Sep 17 00:00:00 2001 From: Paulo Truta Date: Mon, 14 Feb 2022 21:33:29 +0100 Subject: [PATCH 13/14] Update internal/utils/utils.go Thanks @inverse ! Co-authored-by: Malachi Soord --- internal/utils/utils.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/internal/utils/utils.go b/internal/utils/utils.go index fc6ce85..eee5b1f 100644 --- a/internal/utils/utils.go +++ b/internal/utils/utils.go @@ -189,7 +189,7 @@ func WriteOption(optionKey string, optionValue string) { db.Close() } -// IsSystemReady : Checks hability of the service to execute commands (Only after "edgebox --build" is ran at least once via SSH, or if built for distribution) +// IsSystemReady : Checks readiness of the service to execute commands (Only after "edgebox --build" is ran at least once via SSH, or if built for distribution) func IsSystemReady() bool { _, err := os.Stat(GetPath("wsPath") + ".ready") return !os.IsNotExist(err) From 7fd9c94c7b9336820e694d7e6738c1f5d75d3518 Mon Sep 17 00:00:00 2001 From: Paulo Truta Date: Sat, 8 Oct 2022 16:20:37 +0000 Subject: [PATCH 14/14] Explicit arch var for cloud release make command --- Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Makefile b/Makefile index bcabf7f..e110438 100644 --- a/Makefile +++ b/Makefile @@ -13,7 +13,7 @@ build-prod: GOOS=linux GOARCH=arm RELEASE=prod make build build-cloud: - GOOS=linux GOARCH=amd64 RELEASE=cloud make build + CGO_ENABLED=1 GOOS=linux GOARCH=amd64 RELEASE=cloud make build build: @echo "Building ${GOOS}-${GOARCH}"