feature: Documented all functions

Author: dogukanoksuz

app/handlers/command.go

@@ -8,6 +8,7 @@ import (
 	"github.com/limanmys/render-engine/pkg/logger"
 )
 
+// CommandRunner runs command on specified server
 func CommandRunner(c *fiber.Ctx) error {
 	if len(c.FormValue("server_id")) < 1 {
 		return logger.FiberError(fiber.StatusBadRequest, "server not found")
@@ -35,6 +36,7 @@ func CommandRunner(c *fiber.Ctx) error {
 	return c.SendString(output)
 }
 
+// OutsideCommandRunner runs command on external endpoints
 func OutsideCommandRunner(c *fiber.Ctx) error {
 	params := []string{
 		"command",

app/handlers/db.go

@@ -7,6 +7,7 @@ import (
 	"github.com/limanmys/render-engine/pkg/logger"
 )
 
+// SetExtensionDb changes specified vault keys from extension
 func SetExtensionDb(c *fiber.Ctx) error {
 	params := []string{"target", "new_param", "server_id", "extension_id", "token"}
 

app/handlers/extension.go

@@ -13,6 +13,7 @@ import (
 	"go.uber.org/zap"
 )
 
+// ExtensionRunner runs extensions and returns rendered HTML/JSON views
 func ExtensionRunner(c *fiber.Ctx) error {
 	if len(c.FormValue("extension_id")) < 1 {
 		return logger.FiberError(fiber.StatusBadRequest, "extension not found")

app/handlers/external.go

@@ -12,6 +12,7 @@ import (
 	"github.com/limanmys/render-engine/pkg/logger"
 )
 
+// ExternalAPI used for running other extension functions from a different extension
 func ExternalAPI(c *fiber.Ctx) error {
 	var extension *models.Extension
 	var err error

app/handlers/file.go

@@ -13,6 +13,7 @@ import (
 	"github.com/limanmys/render-engine/pkg/logger"
 )
 
+// PutFile puts file to remote end from local path
 func PutFile(c *fiber.Ctx) error {
 	params := []string{"server_id", "remote_path", "local_path"}
 
@@ -63,6 +64,7 @@ func PutFile(c *fiber.Ctx) error {
 	}`)
 }
 
+// GetFile downloads file from remote path to local path
 func GetFile(c *fiber.Ctx) error {
 	params := []string{"server_id", "remote_path", "local_path"}
 
@@ -113,6 +115,7 @@ func GetFile(c *fiber.Ctx) error {
 	}`)
 }
 
+// DownloadFile returns file pointer
 func DownloadFile(c *fiber.Ctx) error {
 	params := []string{"server_id", "path", "extension_id"}
 

app/handlers/job.go

@@ -10,6 +10,7 @@ import (
 	"github.com/limanmys/render-engine/pkg/logger"
 )
 
+// BackgroundJob creates a background shell command
 func BackgroundJob(c *fiber.Ctx) error {
 	if len(c.FormValue("extension_id")) < 1 {
 		return logger.FiberError(fiber.StatusBadRequest, "extension not found")

app/handlers/script.go

@@ -10,6 +10,7 @@ import (
 	"github.com/limanmys/render-engine/pkg/logger"
 )
 
+// ScriptRunner runs scripts on remote server
 func ScriptRunner(c *fiber.Ctx) error {
 	params := []string{"local_path", "root", "parameters", "server_id"}
 

app/handlers/tunnel.go

@@ -6,6 +6,7 @@ import (
 	"github.com/limanmys/render-engine/pkg/logger"
 )
 
+// OpenTunnel opens ssh tunnel on unix sockets or ports
 func OpenTunnel(c *fiber.Ctx) error {
 	params := []string{"remote_host", "remote_port", "username", "password"}
 
@@ -31,6 +32,7 @@ func OpenTunnel(c *fiber.Ctx) error {
 	return c.JSON(port)
 }
 
+// KeepTunnelAlive keeps tunnel connection alive
 func KeepTunnelAlive(c *fiber.Ctx) error {
 	params := []string{"remote_host", "remote_port", "username"}
 

app/handlers/verify.go

@@ -6,6 +6,7 @@ import (
 	"github.com/limanmys/render-engine/pkg/logger"
 )
 
+// Verify verifies credentials
 func Verify(c *fiber.Ctx) error {
 	params := []string{"ip_address", "username", "password", "port", "key_type"}
 

app/middleware/app_logger/new.go

@@ -10,6 +10,8 @@ import (
 	"go.uber.org/zap"
 )
 
+// Creates a new app logger instance
+// This logger logs requests and removes safe information like password etc.
 func New() fiber.Handler {
 	return func(c *fiber.Ctx) (err error) {
 		c.Locals("log_id", uuid.NewString())