Compare commits

...

9 Commits

Author SHA1 Message Date
Malachi Soord 73c3a69390
Merge f0bfc92295 into 1e0a5df370 2024-12-08 21:06:08 +01:00
dependabot[bot] 1e0a5df370
Bump actions/setup-go from 4 to 5 (#36)
Bumps [actions/setup-go](https://github.com/actions/setup-go) from 4 to 5.
- [Release notes](https://github.com/actions/setup-go/releases)
- [Commits](https://github.com/actions/setup-go/compare/v4...v5)

---
updated-dependencies:
- dependency-name: actions/setup-go
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-12-08 21:04:42 +01:00
Paulo Truta 7913be080d
Release 1.3.1 (#41)
* Added password refresh to activate browser dev task

* Added http and https prefixes to broserdevurl

* Added changelog file
2024-12-08 21:03:18 +01:00
Paulo Truta e80aaf7d18
Release/1.3.0 (#40)
* Implemented scaffolding for BrowserDev tasks and implemented taskGetBrowserDevPassword

* Added SetBrowserDevPasswordFile and ReplaceTextInFile funcs

* Added browserDevProxyPath

* Polished code and added missing pieces

* Improved Makefile with info and install + build processes

* Added vscode tasks support

* Added run command and reverted build-all to old logic, added run vscode task

* Added GetBrowserDevStatus task and into schedules

* Fixed check for tasks.GetBrowserStatus()

* Reverted to no result log in Exec command
2024-12-07 01:26:45 +01:00
Paulo Truta b11034dd17 Shell timeout log only every 10 seconds 2024-11-04 13:36:52 +01:00
Paulo Truta 80fc8b40cd Remove postinstall flagged file when removing app 2024-11-03 03:25:59 +01:00
Paulo Truta 01f423ee84 Add support to fetch experimental info from apps, add bulk install edgeapps task 2024-11-02 22:42:56 +01:00
Paulo Truta a8b1da4b7c
Added update_system task and accompanying logic (#37) 2024-07-04 16:22:32 +02:00
Malachi Soord f0bfc92295
Enable codecov 2022-10-09 15:56:29 +02:00
11 changed files with 844 additions and 31 deletions

View File

@ -13,7 +13,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Set up Go
uses: actions/setup-go@v4
uses: actions/setup-go@v5
with:
go-version: '1.20.2'
- name: Check out code
@ -22,7 +22,7 @@ jobs:
run: make build
- name: Test
run: make test-with-coverage
# - uses: codecov/codecov-action@v1
# with:
# token: ${{ secrets.CODECOV_TOKEN }}
# files: coverage.out
- uses: codecov/codecov-action@v1
with:
token: ${{ secrets.CODECOV_TOKEN }}
files: coverage.out

236
.vscode/tasks.json vendored 100644
View File

@ -0,0 +1,236 @@
{
"version": "2.0.0",
"tasks": [
{
"label": "Build",
"type": "shell",
"command": "make",
"args": ["build"],
"options": {
"cwd": "${workspaceFolder}"
},
"group": {
"kind": "build",
"isDefault": true
},
"problemMatcher": []
},
{
"label": "Build All",
"type": "shell",
"command": "make",
"args": ["build-all"],
"options": {
"cwd": "${workspaceFolder}"
},
"group": "build",
"problemMatcher": []
},
{
"label": "Build Prod",
"type": "shell",
"command": "make",
"args": ["build-prod"],
"options": {
"cwd": "${workspaceFolder}"
},
"group": "build",
"problemMatcher": []
},
{
"label": "Build Cloud",
"type": "shell",
"command": "make",
"args": ["build-cloud"],
"options": {
"cwd": "${workspaceFolder}"
},
"group": "build",
"problemMatcher": []
},
{
"label": "Build ARM64",
"type": "shell",
"command": "make",
"args": ["build-arm64"],
"options": {
"cwd": "${workspaceFolder}"
},
"group": "build",
"problemMatcher": []
},
{
"label": "Build ARMHF",
"type": "shell",
"command": "make",
"args": ["build-armhf"],
"options": {
"cwd": "${workspaceFolder}"
},
"group": "build",
"problemMatcher": []
},
{
"label": "Build AMD64",
"type": "shell",
"command": "make",
"args": ["build-amd64"],
"options": {
"cwd": "${workspaceFolder}"
},
"group": "build",
"problemMatcher": []
},
{
"label": "Clean",
"type": "shell",
"command": "make",
"args": ["clean"],
"options": {
"cwd": "${workspaceFolder}"
},
"problemMatcher": []
},
{
"label": "Test",
"type": "shell",
"command": "make",
"args": ["test"],
"options": {
"cwd": "${workspaceFolder}"
},
"problemMatcher": []
},
{
"label": "Test with Coverage",
"type": "shell",
"command": "make",
"args": ["test-with-coverage"],
"options": {
"cwd": "${workspaceFolder}"
},
"problemMatcher": []
},
{
"label": "Run",
"type": "shell",
"command": "make",
"args": ["run"],
"options": {
"cwd": "${workspaceFolder}"
},
"problemMatcher": []
},
{
"label": "Install",
"type": "shell",
"command": "make",
"args": ["install"],
"options": {
"cwd": "${workspaceFolder}"
},
"problemMatcher": []
},
{
"label": "Install Prod",
"type": "shell",
"command": "make",
"args": ["install-prod"],
"options": {
"cwd": "${workspaceFolder}"
},
"problemMatcher": []
},
{
"label": "Install Cloud",
"type": "shell",
"command": "make",
"args": ["install-cloud"],
"options": {
"cwd": "${workspaceFolder}"
},
"problemMatcher": []
},
{
"label": "Install ARM64",
"type": "shell",
"command": "make",
"args": ["install-arm64"],
"options": {
"cwd": "${workspaceFolder}"
},
"problemMatcher": []
},
{
"label": "Install ARMHF",
"type": "shell",
"command": "make",
"args": ["install-armhf"],
"options": {
"cwd": "${workspaceFolder}"
},
"problemMatcher": []
},
{
"label": "Install AMD64",
"type": "shell",
"command": "make",
"args": ["install-amd64"],
"options": {
"cwd": "${workspaceFolder}"
},
"problemMatcher": []
},
{
"label": "Start",
"type": "shell",
"command": "make",
"args": ["start"],
"options": {
"cwd": "${workspaceFolder}"
},
"problemMatcher": []
},
{
"label": "Stop",
"type": "shell",
"command": "make",
"args": ["stop"],
"options": {
"cwd": "${workspaceFolder}"
},
"problemMatcher": []
},
{
"label": "Restart",
"type": "shell",
"command": "make",
"args": ["restart"],
"options": {
"cwd": "${workspaceFolder}"
},
"problemMatcher": []
},
{
"label": "Status",
"type": "shell",
"command": "make",
"args": ["status"],
"options": {
"cwd": "${workspaceFolder}"
},
"problemMatcher": []
},
{
"label": "Logs",
"type": "shell",
"command": "make",
"args": ["log"],
"options": {
"cwd": "${workspaceFolder}"
},
"problemMatcher": []
}
]
}

18
CHANGELOG.md 100644
View File

@ -0,0 +1,18 @@
# Changelog
## [1.3.1] - 08-12-2024
* Fixes to Browser Dev feature:
* Now edgeboxctl also fetches or generates the browser dev environment url and saves it into an option both when starting, and every time the browser dev status is fetched.
## [1.3.0] - 05-12-2024
* Added Edgebox Browser Development Environment Feature Support
* Added tasks for handling browser development environment into tasks.go
* Added executable tasks to ExecuteTask and scheduled ones to ExecuteSchedules
* Other bug fixes and improvements.
### Missing Past Releases
Release notes for past versions are not available in this file. Please refer to the [GitHub releases](https://hithub.com/edgebox-iot/edgeboxctl/releases) for more information. Feel free to contribute to this file by adding missing release notes.

View File

@ -10,9 +10,14 @@ GOARCH := $(shell go env GOARCH)
build-all:
@echo "\n🏗 Building all architectures for ${RELEASE} mode"
@echo "🟡 This will build all supported architectures and release combinations. It can take a while...\n"
GOOS=linux GOARCH=amd64 make build
GOOS=linux GOARCH=arm make build
@echo "\n🟢 All builds completed and available at ./bin/ \n"
build-prod:
GOOS=linux GOARCH=arm RELEASE=prod make build
@ -30,32 +35,54 @@ build-amd64:
build:
@echo "Building ${GOOS}-${GOARCH}"
@echo "\n🏗 Building edgeboxctl (${RELEASE} release) on ${GOOS} (${GOARCH})"
@echo "📦 Binary will be saved in ./${BUILD_DIR}/edgeboxctl-${GOOS}-${GOARCH}\n"
GOOS=${GOOS} GOARCH=${GOARCH} go build \
-trimpath -ldflags "-s -w -X ${PROJECT}/internal/diagnostics.Version=${RELEASE} \
-X ${PROJECT}/internal/diagnostics.Commit=${COMMIT} \
-X ${PROJECT}/internal/diagnostics.BuildDate=${BUILD_DATE}" \
-o bin/edgeboxctl-${GOOS}-${GOARCH} ${PROJECT}/cmd/edgeboxctl
@echo "\n🟢 Build task completed\n"
clean:
@echo "🧹 Cleaning build directory and go cache\n"
rm -rf ${BUILD_DIR}
go clean
@echo "\n🟢 Clean task completed\n"
test:
go test -tags=unit -timeout=600s -v ./...
test-with-coverage:
go test -tags=unit -timeout=600s -v ./... -coverprofile=coverage.out
run:
@echo "\n🚀 Running edgeboxctl\n"
./bin/edgeboxctl-${GOOS}-${GOARCH}
install:
@echo "📦 Installing edgeboxctl service (${RELEASE}) for ${GOOS} (${GOARCH})\n"
@echo "🚧 Stopping edgeboxctl service if it is running"
sudo systemctl stop edgeboxctl || true
@echo "\n🗑 Removing old edgeboxctl binary and service"
sudo rm -rf /usr/local/bin/edgeboxctl /usr/local/sbin/edgeboctl /lib/systemd/system/edgeboxctl.service
@echo "\n🚚 Copying edgeboxctl binary to /usr/local/bin"
sudo cp ./bin/edgeboxctl-${GOOS}-${GOARCH} /usr/local/bin/edgeboxctl
sudo cp ./bin/edgeboxctl-${GOOS}-${GOARCH} /usr/local/sbin/edgeboxctl
@echo "\n🚚 Copying edgeboxctl service to /lib/systemd/system"
sudo cp ./edgeboxctl.service /lib/systemd/system/edgeboxctl.service
sudo systemctl daemon-reload
@echo "Edgeboxctl installed successfully"
@echo "To start edgeboxctl run: systemctl start edgeboxctl"
@echo "\n 🚀 To start edgeboxctl run: make start"
@echo "🟢 Edgeboxctl installed successfully\n"
install-prod: build-prod install
install-cloud: build-cloud install
@ -64,10 +91,24 @@ install-armhf: build-armhf install
install-amd64: build-amd64 install
start:
@echo "\n 🚀 Starting edgeboxctl service\n"
systemctl start edgeboxctl
@echo "\n 🟢 Edgebox service started\n"
stop:
@echo "\n✋ Stopping edgeboxctl service\n"
systemctl stop edgeboxctl
@echo "\n 🟢 Edgebox service stopped\n"
log: start
restart:
@echo "\n💫 Restarting edgeboxctl service\n"
systemctl restart edgeboxctl
@echo "\n 🟢 Edgebox service restarted\n"
status:
@echo "\n edgeboxctl Service Info:\n"
systemctl status edgeboxctl
log:
@echo "\n📰 edgeboxctl service logs:\n"
journalctl -fu edgeboxctl

View File

@ -1,4 +1,3 @@
codecov:
require_ci_to_pass: no
comment: false
github_checks:
annotations: false

1
go.mod
View File

@ -8,6 +8,7 @@ require (
github.com/dustin/go-humanize v1.0.0 // indirect
github.com/go-ole/go-ole v1.2.5 // indirect
github.com/go-sql-driver/mysql v1.5.0
github.com/go-yaml/yaml v2.1.0+incompatible // indirect
github.com/joho/godotenv v1.3.0
github.com/mattn/go-sqlite3 v1.14.7 // indirect
github.com/shirou/gopsutil v3.21.4+incompatible // indirect

2
go.sum
View File

@ -11,6 +11,8 @@ 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=
github.com/go-sql-driver/mysql v1.5.0/go.mod h1:DCzpHaOWr8IXmIStZouvnhqoel9Qv2LBy8hT2VhHyBg=
github.com/go-yaml/yaml v2.1.0+incompatible h1:RYi2hDdss1u4YE7GwixGzWwVo47T8UQwnTLB6vQiq+o=
github.com/go-yaml/yaml v2.1.0+incompatible/go.mod h1:w2MrLa16VYP0jy6N7M5kHaCkaLENm+P+Tv+MfurjSw0=
github.com/google/renameio v0.1.0/go.mod h1:KWCgfxg9yswjAJkECMjeO8J8rahYeXnNhOm40UhjYkI=
github.com/joho/godotenv v1.3.0 h1:Zjp+RcGpHhGlrMbJzXTrZZPrWj+1vfm90La1wgB6Bhc=
github.com/joho/godotenv v1.3.0/go.mod h1:7hK45KPybAkOC6peb+G5yklZfMxEjkZhHbwpqxOKXbg=

View File

@ -11,6 +11,7 @@ import (
"github.com/edgebox-iot/edgeboxctl/internal/system"
"github.com/edgebox-iot/edgeboxctl/internal/utils"
"github.com/edgebox-iot/edgeboxctl/internal/diagnostics"
)
// EdgeApp : Struct representing an EdgeApp in the system
@ -18,6 +19,7 @@ type EdgeApp struct {
ID string `json:"id"`
Name string `json:"name"`
Description string `json:"description"`
Experimental bool `json:"experimental"`
Status EdgeAppStatus `json:"status"`
Services []EdgeAppService `json:"services"`
InternetAccessible bool `json:"internet_accessible"`
@ -69,6 +71,7 @@ const optionsEnvFilename = "/edgeapp.env"
const authEnvFilename = "/auth.env"
const runnableFilename = "/.run"
const appdataFoldername = "/appdata"
const postInstallFilename = "/edgebox-postinstall.done"
const myEdgeAppServiceEnvFilename = "/myedgeapp.env"
const defaultContainerOperationSleepTime time.Duration = time.Second * 10
@ -86,6 +89,7 @@ func GetEdgeApp(ID string) MaybeEdgeApp {
edgeAppName := ID
edgeAppDescription := ""
edgeAppExperimental := false
edgeAppOptions := []EdgeAppOption{}
edgeAppEnv, err := godotenv.Read(utils.GetPath(utils.EdgeAppsPath) + ID + envFilename)
@ -99,6 +103,9 @@ func GetEdgeApp(ID string) MaybeEdgeApp {
if edgeAppEnv["EDGEAPP_DESCRIPTION"] != "" {
edgeAppDescription = edgeAppEnv["EDGEAPP_DESCRIPTION"]
}
if edgeAppEnv["EDGEAPP_EXPERIMENTAL"] == "true" {
edgeAppExperimental = true
}
}
needsConfig := false
@ -231,6 +238,7 @@ func GetEdgeApp(ID string) MaybeEdgeApp {
ID: ID,
Name: edgeAppName,
Description: edgeAppDescription,
Experimental: edgeAppExperimental,
Status: GetEdgeAppStatus(ID),
Services: GetEdgeAppServices(ID),
InternetAccessible: edgeAppInternetAccessible,
@ -263,22 +271,54 @@ func IsEdgeAppInstalled(ID string) bool {
}
func writeAppRunnableFiles(ID string) bool {
edgeAppPath := utils.GetPath(utils.EdgeAppsPath)
_, err := os.Stat(edgeAppPath + ID + runnableFilename)
if os.IsNotExist(err) {
_, err := os.Create(edgeAppPath + ID + runnableFilename)
if err != nil {
log.Fatal("Runnable file for EdgeApp could not be created!")
return false
}
// Check the block default apps option
blockDefaultAppsOption := utils.ReadOption("DASHBOARD_BLOCK_DEFAULT_APPS_PUBLIC_ACCESS")
if blockDefaultAppsOption != "yes" {
// Create myedgeapp.env file with default network URL
envFilePath := edgeAppPath + ID + myEdgeAppServiceEnvFilename
var networkURL string
domainName := utils.ReadOption("DOMAIN_NAME")
if domainName != "" {
networkURL = ID + "." + domainName
} else if diagnostics.GetReleaseVersion() == diagnostics.CLOUD_VERSION {
cluster := utils.ReadOption("CLUSTER")
username := utils.ReadOption("USERNAME")
if cluster != "" && username != "" {
networkURL = username + "-" + ID + "." + cluster
}
} else {
networkURL = ID + "." + system.GetHostname() + ".local" // default
}
env, _ := godotenv.Unmarshal("INTERNET_URL=" + networkURL)
err = godotenv.Write(env, envFilePath)
if err != nil {
log.Printf("Error creating myedgeapp.env file: %s", err)
// result = false
}
}
}
return true
}
func SetEdgeAppInstalled(ID string) bool {
result := true
edgeAppPath := utils.GetPath(utils.EdgeAppsPath)
_, err := os.Stat(edgeAppPath + ID + runnableFilename)
if os.IsNotExist(err) {
_, err := os.Create(edgeAppPath + ID + runnableFilename)
result = true
if err != nil {
log.Fatal("Runnable file for EdgeApp could not be created!")
result = false
}
if writeAppRunnableFiles(ID) {
buildFrameworkContainers()
} else {
@ -292,6 +332,21 @@ func SetEdgeAppInstalled(ID string) bool {
}
func SetEdgeAppBulkInstalled(IDs []string) bool {
result := true
for _, ID := range IDs {
writeAppRunnableFiles(ID)
}
buildFrameworkContainers()
return result
}
func SetEdgeAppNotInstalled(ID string) bool {
// Stop the app first
@ -330,6 +385,12 @@ func SetEdgeAppNotInstalled(ID string) bool {
log.Println(err)
}
err = os.Remove(utils.GetPath(utils.EdgeAppsPath) + ID + postInstallFilename)
if err != nil {
result = false
log.Println(err)
}
buildFrameworkContainers()
return result

View File

@ -7,6 +7,7 @@ import (
"log"
"os"
"io"
"errors"
"os/exec"
"bufio"
"path/filepath"
@ -17,6 +18,7 @@ import (
"github.com/joho/godotenv"
"github.com/shirou/gopsutil/host"
"github.com/go-yaml/yaml"
)
type cloudflaredTunnelJson struct {
@ -425,3 +427,174 @@ func CopyFile(src string, dest string) error {
return nil
}
func CheckUpdates() {
fmt.Println("Checking for Edgebox System Updates.")
// Configure the service and start it
cmd := exec.Command("sh", "/home/system/components/updater/run.sh", "--check")
stdout, err := cmd.StdoutPipe()
if err != nil {
panic(err)
}
scanner := bufio.NewScanner(stdout)
err = cmd.Start()
if err != nil {
panic(err)
}
for scanner.Scan() {
// fmt.Println(scanner.Text())
text := scanner.Text()
fmt.Println(text)
}
if scanner.Err() != nil {
cmd.Process.Kill()
cmd.Wait()
fmt.Println("Error running updates check.")
utils.WriteOption("SYSTEM_UPDATES", "[]")
return
}
// Read targets.env file into JSON list structure
targets := []string{}
targetsFile, err := os.Open("/home/system/components/updater/targets.env")
if err != nil {
fmt.Println("No targets.env file found. Skipping.")
utils.WriteOption("SYSTEM_UPDATES", "[]")
return
}
defer targetsFile.Close()
scanner = bufio.NewScanner(targetsFile)
for scanner.Scan() {
text := scanner.Text()
// text line should look like: {"target": "<target>", "version": "<version>"}
target := strings.Split(text, "=")
newText := "{\"target\": \"" + strings.Replace(target[0], "_VERSION", "", -1) + "\", \"version\": \"" + target[1] + "\"}"
targets = append(targets, newText)
}
if scanner.Err() != nil {
fmt.Println("Error reading update targets file.")
utils.WriteOption("SYSTEM_UPDATES", "[]")
return
}
// convert targets to string
targetsString := strings.Join(targets, ",")
targetsString = "[" + targetsString + "]"
fmt.Println(targetsString)
// Write option with targets
utils.WriteOption("SYSTEM_UPDATES", targetsString)
}
func ApplyUpdates() {
fmt.Println("Applying Edgebox System Updates.")
utils.WriteOption("UPDATING_SYSTEM", "true")
// Configure the service and start it
cmd := exec.Command("sh", "/home/system/components/updater/run.sh", "--update")
stdout, err := cmd.StdoutPipe()
if err != nil {
panic(err)
}
scanner := bufio.NewScanner(stdout)
err = cmd.Start()
if err != nil {
panic(err)
}
for scanner.Scan() {
fmt.Println(scanner.Text())
text := scanner.Text()
fmt.Println(text)
}
if scanner.Err() != nil {
cmd.Process.Kill()
cmd.Wait()
panic(scanner.Err())
}
// If the system did not yet restart, set updating system to false
utils.WriteOption("UPDATING_SYSTEM", "false")
}
func FetchBrowserDevPasswordFromFile() (string, error) {
fmt.Println("Executing FetchBrowserDevPasswordFromFile")
// Read the "password" entry on the yaml file
// Read the yaml file in system.GetPath(BrowserDevPasswordFileLocation)
yamlFile, err := ioutil.ReadFile(utils.GetPath(utils.BrowserDevPasswordFileLocation))
if err != nil {
return "", err
}
// Parse the yaml file and get the "password" entry
var yamlFileMap yaml.MapSlice
err = yaml.Unmarshal(yamlFile, &yamlFileMap)
if err != nil {
return "", err
}
for _, item := range yamlFileMap {
key, value := item.Key, item.Value
if key == "password" {
if pwString, ok := value.(string); ok {
return pwString, nil
} else {
return "", errors.New("password value is not a string")
}
}
}
return "", errors.New("password key not found")
}
func SetBrowserDevPasswordFile(password string) error {
// Get current password from file
currentPassword, err := FetchBrowserDevPasswordFromFile()
if err != nil {
fmt.Println("Error fetching current password from file.")
return err
}
// Write the new password on the file using ReplaceTextInFile
err = ReplaceTextInFile(utils.GetPath(utils.BrowserDevPasswordFileLocation), currentPassword, password)
if err != nil {
fmt.Println("Error writing new password to file.")
return err
}
return nil
}
func ReplaceTextInFile(filePath string, oldText string, newText string) error {
// Open the file for reading
file, err := os.OpenFile(filePath, os.O_RDWR, 0644)
if err != nil {
return err
}
// Read the file contents
data, err := ioutil.ReadAll(file)
if err != nil {
return err
}
// Close the file
err = file.Close()
if err != nil {
return err
}
// Replace the text in the file
newData := strings.Replace(string(data), oldText, newText, -1)
// Write the new data back to the file
err = ioutil.WriteFile(filePath, []byte(newData), 0644)
if err != nil {
return err
}
return nil
}

View File

@ -18,6 +18,8 @@ import (
"github.com/edgebox-iot/edgeboxctl/internal/system"
"github.com/edgebox-iot/edgeboxctl/internal/utils"
"github.com/joho/godotenv"
_ "github.com/go-sql-driver/mysql" // Mysql Driver
_ "github.com/mattn/go-sqlite3" // SQlite Driver
)
@ -56,6 +58,10 @@ type taskInstallEdgeAppArgs struct {
ID string `json:"id"`
}
type taskInstallBulkEdgeAppsArgs struct {
IDS []string `json:"ids"`
}
type taskRemoveEdgeAppArgs struct {
ID string `json:"id"`
}
@ -104,6 +110,10 @@ type taskStartShellArgs struct {
Timeout int `json:"timeout"`
}
type taskSetBrowserDevPasswordArgs struct {
Password string `json:"password"`
}
const STATUS_CREATED int = 0
const STATUS_EXECUTING int = 1
@ -146,6 +156,33 @@ func GetNextTask() Task {
}
// GetExecutingTasks : Performs a MySQL query over the device's Edgebox API to obtain all tasks that are currently executing
func GetExecutingTasks() []Task {
// Will try to connect to API database, which should be running locally under WS.
db, err := sql.Open("sqlite3", utils.GetSQLiteDbConnectionDetails())
if err != nil {
panic(err.Error())
}
results, err := db.Query("SELECT id, task, args, status, result, created, updated FROM task WHERE status = 1;")
if err != nil {
panic(err.Error())
}
var tasks []Task
for results.Next() {
// for each row, scan the result into our task composite object
var task Task
err = results.Scan(&task.ID, &task.Task, &task.Args, &task.Status, &task.Result, &task.Created, &task.Updated)
if err != nil {
panic(err.Error()) // proper error handling instead of panic in your app
}
tasks = append(tasks, task)
}
results.Close()
db.Close()
return tasks
}
// ExecuteTask : Performs execution of the given task, updating the task status as it goes, and publishing the task result
func ExecuteTask(task Task) Task {
@ -260,6 +297,11 @@ func ExecuteTask(task Task) Task {
taskResult := taskStopShell()
task.Result = sql.NullString{String: taskResult, Valid: true}
case "activate_browser_dev":
log.Println("Activating Browser Dev Environment")
taskResult := taskActivateBrowserDev()
task.Result = sql.NullString{String: taskResult, Valid: true}
case "install_edgeapp":
log.Println("Installing EdgeApp...")
@ -272,6 +314,18 @@ func ExecuteTask(task Task) Task {
task.Result = sql.NullString{String: taskResult, Valid: true}
}
case "install_bulk_edgeapps":
log.Println("Installing Bulk EdgeApps...")
var args taskInstallBulkEdgeAppsArgs
err := json.Unmarshal([]byte(task.Args.String), &args)
if err != nil {
log.Printf("Error reading arguments of install_bulk_edgeapps task: %s", err)
} else {
taskResult := taskInstallBulkEdgeApps(args)
task.Result = sql.NullString{String: taskResult, Valid: true}
}
case "remove_edgeapp":
log.Println("Removing EdgeApp...")
@ -387,6 +441,49 @@ func ExecuteTask(task Task) Task {
taskResult := taskDisablePublicDashboard()
task.Result = sql.NullString{String: taskResult, Valid: true}
case "check_updates":
log.Println("Checking for updates...")
taskResult := taskCheckSystemUpdates()
task.Result = sql.NullString{String: taskResult, Valid: true}
case "apply_updates":
log.Println("Updating Edgebox System...")
is_updating := utils.ReadOption("UPDATING_SYSTEM")
if is_updating == "true" {
log.Println("Edgebox update was running... Probably system restarted. Finishing update...")
utils.WriteOption("UPDATING_SYSTEM", "false")
task.Result = sql.NullString{String: "{result: true}", Valid: true}
} else {
log.Println("Updating Edgebox System...")
taskResult := taskUpdateSystem()
task.Result = sql.NullString{String: taskResult, Valid: true}
}
case "set_browserdev_password":
log.Println("Setting BrowserDev Password...")
var args taskSetBrowserDevPasswordArgs
err := json.Unmarshal([]byte(task.Args.String), &args)
if err != nil {
log.Printf("Error reading arguments of set_browserdev_password task: %s", err)
} else {
taskResult := taskSetBrowserDevPassword(args)
task.Result = sql.NullString{String: taskResult, Valid: true}
}
case "activate_browserdev":
log.Println("Activating BrowserDev Environment...")
taskResult := taskActivateBrowserDev()
task.Result = sql.NullString{String: taskResult, Valid: true}
case "deactivate_browserdev":
log.Println("Deactivating BrowserDev Environment...")
taskResult := taskDeactivateBrowserDev()
task.Result = sql.NullString{String: taskResult, Valid: true}
}
}
@ -407,6 +504,7 @@ func ExecuteTask(task Task) Task {
if err != nil {
log.Fatal(err.Error())
}
} else {
fmt.Println("Error executing task with result: " + task.Result.String)
_, err = statement.Exec(STATUS_ERROR, "Error", formatedDatetime, strconv.Itoa(task.ID)) // Execute SQL Statement with Error info
@ -432,6 +530,12 @@ func ExecuteSchedules(tick int) {
if tick == 1 {
log.Println("Fetching Browser Dev Environment Information")
taskGetBrowserDevPassword()
taskGetBrowserDevStatus()
taskCheckSystemUpdates()
ip := taskGetSystemIP()
log.Println("System IP is: " + ip)
@ -460,6 +564,7 @@ func ExecuteSchedules(tick int) {
taskStartWs()
log.Println(taskGetEdgeApps())
taskUpdateSystemLoggerServices()
taskRecoverFromUpdate()
}
if tick%5 == 0 {
@ -468,6 +573,10 @@ func ExecuteSchedules(tick int) {
log.Println(taskGetStorageDevices())
}
if tick%15 == 0 {
taskGetBrowserDevStatus()
}
if tick%30 == 0 {
// Executing every 30 ticks
log.Println(taskGetEdgeApps())
@ -506,6 +615,9 @@ func ExecuteSchedules(tick int) {
if tick%3600 == 0 {
// Executing every 3600 ticks (1 hour)
taskGetBrowserDevStatus()
taskCheckSystemUpdates()
}
if tick%86400 == 0 {
@ -924,12 +1036,19 @@ func taskSetupTunnel(args taskSetupTunnelArgs) string {
}
func taskStartTunnel() string {
fmt.Println("Executing taskStartTunnel")
system.StartService("cloudflared")
domainName := utils.ReadOption("DOMAIN_NAME")
status := "{\"status\": \"connected\", \"domain\": \"" + domainName + "\"}"
utils.WriteOption("TUNNEL_STATUS", status)
return "{\"status\": \"ok\"}"
fmt.Println("Executing taskStartTunnel")
// Read tunnel status to check if cloudflare is configured
tunnelStatus := utils.ReadOption("TUNNEL_STATUS")
if tunnelStatus != "" {
// Only start cloudflared if we have a tunnel configured
system.StartService("cloudflared")
domainName := utils.ReadOption("DOMAIN_NAME")
status := "{\"status\": \"connected\", \"domain\": \"" + domainName + "\"}"
utils.WriteOption("TUNNEL_STATUS", status)
}
return "{\"status\": \"ok\"}"
}
func taskStopTunnel() string {
@ -1003,7 +1122,9 @@ func taskStartShell(args taskStartShellArgs) string {
utils.WriteOption("SHELL_STATUS", "not_running")
break
}
fmt.Println("Active Shell Timeout is " + fmt.Sprint(timeout) + " seconds")
if timeout%10 == 0 {
fmt.Println("Active Shell Timeout is " + fmt.Sprint(timeout) + " seconds")
}
time.Sleep(1 * time.Second)
}
}()
@ -1023,6 +1144,108 @@ func taskStopShell() string {
}
func taskGetBrowserDevStatus() string {
fmt.Println("Executing taskGetBrowserDevStatus")
// Read status from systemctl status code-server@root
browserDevStatus := utils.Exec(
utils.GetPath(utils.WsPath),
"sh",
[]string{"-c", "systemctl --quiet is-active code-server@root && echo 'active' || echo 'inactive'"},
)
if browserDevStatus == "active" {
fmt.Println("Browser Dev Environment is running")
utils.WriteOption("BROWSERDEV_STATUS", "running")
taskGetBrowserDevUrl()
return "{\"status\": \"running\"}"
} else {
fmt.Println("Browser Dev Environment is not running")
utils.WriteOption("BROWSERDEV_STATUS", "not_running")
return "{\"status\": \"not_running\"}"
}
}
func taskGetBrowserDevUrl() string {
url := ""
myEdgeAppServiceEnv, err := godotenv.Read(utils.GetPath(utils.EdgeAppsPath) + "dev/myedgeapp.env")
if err != nil {
log.Println("No myedge.app environment file found. Status is Network-Only")
url = "http://dev." + system.GetHostname() + ".local"
} else {
if myEdgeAppServiceEnv["INTERNET_URL"] != "" {
url = "https://" + myEdgeAppServiceEnv["INTERNET_URL"]
}
}
fmt.Println("Browser Dev Url: " + url)
utils.WriteOption("BROWSERDEV_URL", url)
return url
}
func taskActivateBrowserDev() string {
fmt.Println("Executing taskActivateBrowserDev")
wsPath := utils.GetPath(utils.WsPath)
// Start the service
utils.Exec(wsPath, "systemctl", []string{"start", "code-server@root"})
// Write run file to /home/system/components/dev/.run
utils.Exec(wsPath, "touch", []string{utils.GetPath(utils.BrowserDevProxyPath) + ".run"})
// Rebuild WS (necessary to start the proxy)
system.StartWs()
// Write control option for API
utils.WriteOption("BROWSERDEV_STATUS", "running")
// Write and refresh the dev environment password option
taskGetBrowserDevPassword()
return "{\"status\": \"ok\"}"
}
func taskDeactivateBrowserDev() string {
fmt.Println("Executing taskDeactivateBrowserDev")
wsPath := utils.GetPath(utils.WsPath)
// Remove the run file
os.Remove(utils.GetPath(utils.BrowserDevProxyPath) + ".run")
system.StartWs()
utils.Exec(wsPath, "systemctl", []string{"stop", "code-server@root"})
utils.WriteOption("BROWSERDEV_STATUS", "not_running")
return "{\"status\": \"ok\"}"
}
func taskGetBrowserDevPassword() string {
fmt.Println("Executing taskGetBrowserDevPassword")
password, err := system.FetchBrowserDevPasswordFromFile()
if err == nil {
utils.WriteOption("BROWSERDEV_PASSWORD", password)
} else {
fmt.Println("Error fetching browser dev password from file: " + err.Error())
}
return password
}
func taskSetBrowserDevPassword(args taskSetBrowserDevPasswordArgs) string {
fmt.Println("Executing taskSetBrowserDevPassword")
wsPath := utils.GetPath(utils.WsPath)
system.SetBrowserDevPasswordFile(args.Password)
utils.WriteOption("BROWSERDEV_PASSWORD", args.Password)
// Check if BROWSERDEV_STATUS is "running", if so, restart the service
if utils.ReadOption("BROWSERDEV_STATUS") == "running" {
utils.Exec(wsPath, "systemctl", []string{"restart", "code-server@root"})
}
return "{\"status\": \"ok\"}"
}
func taskInstallEdgeApp(args taskInstallEdgeAppArgs) string {
fmt.Println("Executing taskInstallEdgeApp for " + args.ID)
@ -1033,6 +1256,16 @@ func taskInstallEdgeApp(args taskInstallEdgeAppArgs) string {
return string(resultJSON)
}
func taskInstallBulkEdgeApps(args taskInstallBulkEdgeAppsArgs) string {
fmt.Println("Executing taskInstallBulkEdgeApps for " + strings.Join(args.IDS, ", "))
// args.Apps is a list of edgeapp ids
edgeapps.SetEdgeAppBulkInstalled(args.IDS)
taskGetEdgeApps()
return "{\"status\": \"ok\"}"
}
func taskRemoveEdgeApp(args taskRemoveEdgeAppArgs) string {
fmt.Println("Executing taskRemoveEdgeApp for " + args.ID)
@ -1230,6 +1463,39 @@ func taskDisablePublicDashboard() string {
return "{result: false}"
}
func taskCheckSystemUpdates() string {
fmt.Println("Executing taskCheckSystemUpdates")
system.CheckUpdates()
return "{result: true}"
}
func taskUpdateSystem() string {
fmt.Println("Executing taskUpdateSystem")
system.ApplyUpdates()
utils.WriteOption("LAST_UPDATE", strconv.FormatInt(time.Now().Unix(), 10))
return "{result: true}"
}
func taskRecoverFromUpdate() string {
fmt.Println("Executing taskRecoverFromUpdate")
executing_tasks := GetExecutingTasks()
// Filter out the task with task value "update_system"
filteredTasks := []Task{}
for _, task := range executing_tasks {
if task.Task != "update_system" {
filteredTasks = append(filteredTasks, task)
}
}
// If tasks is not empty, Get the last task
if len(filteredTasks) > 0 {
lastTask := filteredTasks[len(filteredTasks)-1]
ExecuteTask(lastTask)
}
return "{result: true}"
}
func taskSetReleaseVersion() string {
fmt.Println("Executing taskSetReleaseVersion")

View File

@ -112,6 +112,8 @@ const EdgeAppsPath string = "edgeAppsPath"
const EdgeAppsBackupPath string = "edgeAppsBackupPath"
const WsPath string = "wsPath"
const LoggerPath string = "loggerPath"
const BrowserDevPasswordFileLocation string = "browserDevPasswordFileLocation"
const BrowserDevProxyPath string = "browserDevProxyPath"
// GetPath : Returns either the hardcoded path, or a overwritten value via .env file at project root. Register paths here for seamless working code between dev and prod environments ;)
@ -189,6 +191,20 @@ func GetPath(pathKey string) string {
targetPath = "/home/system/components/backups/pw.txt"
}
case BrowserDevPasswordFileLocation:
if env["BROWSERDEV_PASSWORD_FILE_LOCATION"] != "" {
targetPath = env["BROWSERDEV_PASSWORD_FILE_LOCATION"]
} else {
targetPath = "/root/.config/code-server/config.yaml"
}
case BrowserDevProxyPath:
if env["BROWSERDEV_PROXY_PATH"] != "" {
targetPath = env["BROWSERDEV_PROXY_PATH"]
} else {
targetPath = "/home/system/components/dev/"
}
default:
log.Printf("path_key %s nonexistant in GetPath().\n", pathKey)