Merge f0bfc92295 into 4e399f63ea

.github/workflows/go.yml

@@ -15,14 +15,14 @@ jobs:
     - name: Set up Go
       uses: actions/setup-go@v4
       with:
-        go-version: '1.20.2'
+        go-version: ^1.15
     - name: Check out code
-      uses: actions/checkout@v4
+      uses: actions/checkout@v3
     - name: Build
       run: make build
     - name: Test
       run: make test-with-coverage
-    # - uses: codecov/codecov-action@v1
+    - uses: codecov/codecov-action@v1
-    #   with:
+      with:
-    #     token: ${{ secrets.CODECOV_TOKEN }}
+        token: ${{ secrets.CODECOV_TOKEN }}
-    #     files: coverage.out
+        files: coverage.out

Dockerfile

@@ -1,9 +1,11 @@
-FROM golang:1.20.2
+FROM golang:latest
 
 WORKDIR /app
 
 COPY ./ /app
 
-RUN go install github.com/githubnemo/CompileDaemon@latest
+RUN go mod download
 
-ENTRYPOINT CompileDaemon --build="make build" --command=./bin/edgeboxctl-$(go env GOOS)-$(go env GOARCH)
+RUN go get github.com/githubnemo/CompileDaemon
+
+ENTRYPOINT CompileDaemon --build="make build" --command=./bin/edgeboxctl

Makefile

@@ -1,13 +1,9 @@
-.DEFAULT_GOAL := build
+PROJECT?=github.com/edgebox-iot/edgeboxctl
 
-PROJECT ?= github.com/edgebox-iot/edgeboxctl
 RELEASE ?= dev
 COMMIT := $(shell git rev-parse --short HEAD)
 BUILD_DATE := $(shell date -u '+%Y-%m-%d_%H:%M:%S')
 BUILD_DIR = bin
-GOOS := $(shell go env GOOS)
-GOARCH := $(shell go env GOARCH)
-
 
 build-all:
 	GOOS=linux GOARCH=amd64 make build
@@ -36,6 +32,7 @@ build:
 		-X ${PROJECT}/internal/diagnostics.Commit=${COMMIT} \
 		-X ${PROJECT}/internal/diagnostics.BuildDate=${BUILD_DATE}" \
 		-o bin/edgeboxctl-${GOOS}-${GOARCH} ${PROJECT}/cmd/edgeboxctl
+	cp ./bin/edgeboxctl-${GOOS}-${GOARCH} ./bin/edgeboxctl
 
 clean:
 	rm -rf ${BUILD_DIR}
@@ -50,8 +47,8 @@ test-with-coverage:
 install:
 	sudo systemctl stop edgeboxctl || true
 	sudo rm -rf /usr/local/bin/edgeboxctl /usr/local/sbin/edgeboctl /lib/systemd/system/edgeboxctl.service
-	sudo cp ./bin/edgeboxctl-${GOOS}-${GOARCH} /usr/local/bin/edgeboxctl
+	sudo cp ./bin/edgeboxctl /usr/local/bin/edgeboxctl
-	sudo cp ./bin/edgeboxctl-${GOOS}-${GOARCH} /usr/local/sbin/edgeboxctl
+	sudo cp ./bin/edgeboxctl /usr/local/sbin/edgeboxctl
 	sudo cp ./edgeboxctl.service /lib/systemd/system/edgeboxctl.service
 	sudo systemctl daemon-reload
 	@echo "Edgeboxctl installed successfully"
@@ -71,3 +68,4 @@ stop:
 
 log: start
 	journalctl -fu edgeboxctl
+

README.md

@@ -8,7 +8,7 @@
   <h3 align="center">Edgebox Control Module</h3>
 
   <p align="center">
-    A System Control module written in Go. Its responsibility is to configure dependencies and perform system tasks, automatically on a schedule, or on demand.
+    A System Control module written in Go. Its resonsability is to configure dependencies and perform system tasks, automatically in a schedule, or by command.
     <br />
     <br />
     <a href="https://github.com/github_username/edgeboxctl/issues">Report Bug</a>
@@ -38,6 +38,8 @@
 <!-- ABOUT THE PROJECT -->
 ## About The Project
 
+[![Edgebox Screen Shot][product-screenshot]](https://edgebox.co)
+
 Edgebox is an easy to configure and use system. It brings powerful features that go alongside or can even completely replace various services that you already use in the day-to-day.
 
 
@@ -56,15 +58,18 @@ To get a local copy up and running follow these simple steps.
 
 ### Prerequisites
 
-If you're running for development purposes, a docker container suffices, so make sure you have:
+If you're installing this to run natively in the system, you better be doing it inside of the [Development Virtual Machine](https://github.com/edgebox-iot/devm). This software can do destructive action in the system is is running. You've been warned.
 
-* docker
+If you're running for development purposes, a Docker container suffices, so make sure you have:
-* docker compose
+* Docker
+* Docker Compose
+```sh
+sudo apt-get install docker docker-compose
+```
 
 Check the following links for more info on [Docker](https://www.docker.com/) and [Docker Compose](https://docs.docker.com/compose/).
 
-Aditionally, `edgeboxctl` needs the following bash commands available wherever it runs:
+Aditionally, edgeboxctl needs the following bash commands available wherever it runs:
-
 * `arm-linux-gnueabi-gcc` (`sudo apt-get install gcc-arm*`)
 * `sh`
 * `rm`
@@ -116,4 +121,4 @@ Contributions are what make the open source community such an amazing place to b
 <!-- LICENSE -->
 ## License
 
-Distributed under the Elastic License 2.0. See `LICENSE` for more information.
+Distributed under the MIT License. See `LICENSE` for more information.

codecov.yml

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

internal/edgeapps/edgeapps.go

@@ -416,24 +416,12 @@ func GetEdgeAppServices(ID string) []EdgeAppService {
 	var edgeAppServices []EdgeAppService
 
 	for _, serviceID := range serviceSlices {
-		shouldBeRunning := false
-		isRunning := false
-
-		// Is service "runnable" when .run lockfile in the app folder
-		_, err := os.Stat(utils.GetPath(utils.EdgeAppsPath) + ID + runnableFilename)
-		if !os.IsNotExist(err) {
-			shouldBeRunning = true
-		}
-
-		// Check if the service is actually running
-		if shouldBeRunning {
 		cmdArgs = []string{"-f", wsPath + "/docker-compose.yml", "exec", "-T", serviceID, "echo", "'Service Check'"}
 		cmdResult := utils.Exec(wsPath, "docker-compose", cmdArgs)
+		isRunning := false
 		if cmdResult != "" {
 			isRunning = true
 		}
-		}
-
 		edgeAppServices = append(edgeAppServices, EdgeAppService{ID: serviceID, IsRunning: isRunning})
 	}
 

internal/storage/storage.go

@@ -2,7 +2,6 @@ package storage
 
 import (
 	"fmt"
-	"strconv"
 	"os"
 	"path/filepath"
 	"strings"
@@ -74,13 +73,12 @@ const (
 	DISK_TYPE_SDA   DeviceIdentifier = "sda"
 	DISK_TYPE_MCBLK DeviceIdentifier = "mmcblk0"
 	DISK_TYPE_VDA   DeviceIdentifier = "vda"
-	MIN_DISK_SIZE   int              = 1048576 // 1GB in bytes
 )
 
 func GetDeviceIdentifier(release_version diagnostics.ReleaseVersion) DeviceIdentifier {
 	switch release_version {
 	case diagnostics.CLOUD_VERSION:
-		return DISK_TYPE_SDA
+		return DISK_TYPE_VDA
 	case diagnostics.PROD_VERSION:
 		return DISK_TYPE_MCBLK
 	}
@@ -136,13 +134,7 @@ func GetDevices(release_version diagnostics.ReleaseVersion) []Device {
 				currentDevice.InUse = currentDeviceInUseFlag
 				currentDeviceInUseFlag = false
 				currentPartitions = []Partition{}
-				size, err := strconv.Atoi(currentDevice.Size)
-				if err != nil {
-					size = 0
-				}
-				if size > MIN_DISK_SIZE {
 				devices = append(devices, currentDevice)
-				}
 			} else {
 				firstDevice = false
 			}
@@ -201,22 +193,8 @@ func GetDevices(release_version diagnostics.ReleaseVersion) []Device {
 		currentDevice.Status.Description = "Not configured"
 	}
 	currentDevice.InUse = currentDeviceInUseFlag
-
-	fmt.Println("Secondary Storage Devices Found: ", len(devices))
-	fmt.Println("Main Storage Device size: ", currentDevice.Size)
-
-	// only append device if size > 1GB
-	if currentDevice.Size != "" && currentDevice.Size != "0" {
-		// Convert size to int
-		// Convert string to int
-		size, err := strconv.Atoi(currentDevice.Size)
-		if err != nil {
-			size = 0
-		}
-		if size > MIN_DISK_SIZE {
 	devices = append([]Device{currentDevice}, devices...) // Prepending the first device...
-		}
+
-	}
 	devices = getDevicesSpaceUsage(devices)
 
 	return devices

internal/system/system.go

@@ -425,94 +425,3 @@ 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")
-}
-

internal/tasks/tasks.go

@@ -100,10 +100,6 @@ type taskSetupBackupsArgs struct {
 	RepositoryPassword string `json:"repository_password"`
 }
 
-type taskStartShellArgs struct {
-	Timeout int `json:"timeout"`
-}
-
 
 const STATUS_CREATED int = 0
 const STATUS_EXECUTING int = 1
@@ -146,33 +142,6 @@ 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 {
 
@@ -271,22 +240,6 @@ func ExecuteTask(task Task) Task {
 			taskResult := taskDisableTunnel()
 			task.Result = sql.NullString{String: taskResult, Valid: true}
 
-		case "start_shell":
-			log.Println("Starting SSHX.io Shell")
-			var args taskStartShellArgs
-			err := json.Unmarshal([]byte(task.Args.String), &args)
-			if err != nil {
-				log.Printf("Error reading arguments or start_shell task: %s", err)
-			} else {
-				taskResult := taskStartShell(args)
-				task.Result = sql.NullString{String: taskResult, Valid: true}												
-			}
-
-		case "stop_shell":
-			log.Println("Stopping SSHX.io Shell...")
-			taskResult := taskStopShell()
-			task.Result = sql.NullString{String: taskResult, Valid: true}
-
 		case "install_edgeapp":
 
 			log.Println("Installing EdgeApp...")
@@ -414,25 +367,6 @@ 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}
-			}
-
 		}
 
 	}
@@ -453,7 +387,6 @@ 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
@@ -507,9 +440,6 @@ func ExecuteSchedules(tick int) {
 		taskStartWs()
 		log.Println(taskGetEdgeApps())
 		taskUpdateSystemLoggerServices()
-		taskRecoverFromUpdate()
-		taskCheckSystemUpdates()
-		
 	}
 
 	if tick%5 == 0 {
@@ -556,7 +486,6 @@ func ExecuteSchedules(tick int) {
 
 	if tick%3600 == 0 {
 		// Executing every 3600 ticks (1 hour)
-		taskCheckSystemUpdates()
 	}
 
 	if tick%86400 == 0 {
@@ -1002,78 +931,6 @@ func taskDisableTunnel() string {
 	return "{\"status\": \"ok\"}"
 }
 
-func taskStartShell(args taskStartShellArgs) string {
-	fmt.Println("Executing taskStartShell")
-	wsPath := utils.GetPath(utils.WsPath)
-
-	// kill the process if its running
-	utils.Exec(wsPath, "killall", []string{"sshx"})
-
-	cmd := exec.Command("/usr/local/bin/sshx", "--quiet", "--shell", "bash")
-	stdout, err := cmd.StdoutPipe()
-	if err != nil {
-		panic(err)
-	}
-	scanner := bufio.NewScanner(stdout)
-	err = cmd.Start()
-	if err != nil {
-		panic(err)
-	}
-	url := ""
-
-	timeout := args.Timeout
-
-	for scanner.Scan() {
-		fmt.Println(scanner.Text())
-		text := scanner.Text()
-		if strings.Contains(text, "https://") {
-			url = text
-			fmt.Println("Shell start is responding with URL: " + url)
-			utils.WriteOption("SHELL_URL", url)
-			utils.WriteOption("SHELL_STATUS", "running")
-			break
-		}
-	}
-	if scanner.Err() != nil {
-		cmd.Process.Kill()
-		cmd.Wait()
-		panic(scanner.Err())
-	}
-
-	go func() {
-		fmt.Println("Running shell async")
-		
-		// cmd.Wait()
-
-		// Keep retrying to calculate timeout to know when to kill the process
-		for {
-			timeout = timeout - 1
-			if timeout <= 0 {
-				fmt.Println("Timeout reached, killing process...")
-				utils.Exec(wsPath, "killall sshx", []string{})
-				utils.WriteOption("SHELL_STATUS", "not_running")
-				break
-			}
-			fmt.Println("Active Shell Timeout is " + fmt.Sprint(timeout) + " seconds")
-			time.Sleep(1 * time.Second)
-		}
-	}()
-
-	return "{\"status\": \"ok\"}"
-}
-
-func taskStopShell() string {
-	fmt.Println("Executing taskStopShell")
-	wsPath := utils.GetPath(utils.WsPath)
-
-	// kill the process if its running
-	utils.Exec(wsPath, "killall", []string{"sshx"})
-	utils.WriteOption("SHELL_STATUS", "not_running")
-
-	return "{\"status\": \"ok\"}"
-
-}
-
 func taskInstallEdgeApp(args taskInstallEdgeAppArgs) string {
 	fmt.Println("Executing taskInstallEdgeApp for " + args.ID)
 
@@ -1281,38 +1138,6 @@ 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()
-	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")