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
This commit is contained in:
Paulo Truta
2024-12-07 01:26:45 +01:00
committed by GitHub
parent b11034dd17
commit e80aaf7d18
7 changed files with 496 additions and 4 deletions
+82
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 {
@@ -516,3 +518,83 @@ func ApplyUpdates() {
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
}
+117
View File
@@ -108,6 +108,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
@@ -291,6 +295,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...")
@@ -449,6 +458,30 @@ func ExecuteTask(task Task) Task {
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}
}
}
@@ -495,6 +528,10 @@ func ExecuteSchedules(tick int) {
if tick == 1 {
log.Println("Fetching Browser Dev Environment Information")
taskGetBrowserDevPassword()
taskGetBrowserDevStatus()
ip := taskGetSystemIP()
log.Println("System IP is: " + ip)
@@ -572,7 +609,9 @@ func ExecuteSchedules(tick int) {
if tick%3600 == 0 {
// Executing every 3600 ticks (1 hour)
taskGetBrowserDevStatus()
taskCheckSystemUpdates()
}
if tick%86400 == 0 {
@@ -1099,6 +1138,84 @@ 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")
return "{\"status\": \"running\"}"
} else {
fmt.Println("Browser Dev Environment is not running")
utils.WriteOption("BROWSERDEV_STATUS", "not_running")
return "{\"status\": \"not_running\"}"
}
}
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")
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 := utils.ReadOption("BROWSERDEV_PASSWORD")
if password == "" {
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)
+16
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)