split up the backend

Author: jp

backend/backend.go

@@ -1,9 +1,12 @@
 package backend
 
-import "soarca-gui/models/reporting"
+import "soarca-gui/models/reporter"
 
-type Backend interface {
-	GetReports() ([]reporting.PlaybookExecutionReport, error)
-	GetReportsById(string) (reporting.PlaybookExecutionReport, error)
+type Report interface {
+	GetReports() ([]reporter.PlaybookExecutionReport, error)
+	GetReportsById(string) (reporter.PlaybookExecutionReport, error)
+}
+
+type Status interface {
 	GetPongFromStatus() (string, error)
 }

backend/soarca/helper.go

@@ -0,0 +1,42 @@
+package soarca
+
+import (
+	"encoding/json"
+	"fmt"
+	"io"
+	"net/http"
+)
+
+func fetchToJson(client http.Client, url string, target interface{}) error {
+	body, err := fetch(client, url)
+	if err != nil {
+		return err
+	}
+	err = json.Unmarshal(body, target)
+	if err != nil {
+		return fmt.Errorf("failed to unmarshal JSON object: %w", err)
+	}
+	return nil
+}
+
+func fetch(client http.Client, url string) ([]byte, error) {
+	response, err := client.Get(url)
+	if err != nil {
+		return []byte{}, fmt.Errorf("failed to make GET request: %w", err)
+	}
+	defer response.Body.Close()
+
+	if response.StatusCode != http.StatusOK {
+		return []byte{}, fmt.Errorf("unexpected status code: %d", response.StatusCode)
+	}
+
+	body, err := io.ReadAll(response.Body)
+	if err != nil {
+		return []byte{}, fmt.Errorf("failed to read response body: %w", err)
+	}
+
+	if len(body) == 0 {
+		return []byte{}, fmt.Errorf("empty response body")
+	}
+	return body, nil
+}

backend/soarca/report.go

@@ -0,0 +1,46 @@
+package soarca
+
+import (
+	"fmt"
+	"net/http"
+
+	"soarca-gui/models/reporter"
+)
+
+const (
+	statusPingPath    = "/status/ping"
+	reporterPath      = "/reporter"
+	reporterApiPathId = "/reporter/:id"
+)
+
+type Report struct {
+	Host   string
+	client http.Client
+}
+
+func NewReporter(host string, client http.Client) *Report {
+	return &Report{Host: host, client: client}
+}
+
+func (report *Report) GetReports() ([]reporter.PlaybookExecutionReport, error) {
+	url := fmt.Sprintf("%s%s", report.Host, reporterPath)
+
+	var reportings []reporter.PlaybookExecutionReport
+	err := fetchToJson(report.client, url, &reportings)
+	if err != nil {
+		return nil, err
+	}
+
+	return reportings, nil
+}
+
+func (report *Report) GetReportsById(Id string) (reporter.PlaybookExecutionReport, error) {
+	url := fmt.Sprintf("%s%s/%s", report.Host, reporterApiPathId, Id)
+	var returnReport reporter.PlaybookExecutionReport
+
+	err := fetchToJson(report.client, url, &returnReport)
+	if err != nil {
+		return reporter.PlaybookExecutionReport{}, err
+	}
+	return returnReport, nil
+}

backend/soarca/soarca.go

@@ -0,0 +1,26 @@
+package soarca
+
+import (
+	"fmt"
+	"net/http"
+)
+
+type Status struct {
+	Host   string
+	client http.Client
+}
+
+func NewStatus(host string, client http.Client) *Status {
+	return &Status{Host: host, client: client}
+}
+
+func (status *Status) GetPongFromStatus() (string, error) {
+	url := fmt.Sprintf("%s%s", status.Host, statusPingPath)
+
+	body, err := fetch(status.client, url)
+	if err != nil {
+		return "", fmt.Errorf("failed to read response body: %w", err)
+	}
+
+	return string(body), nil
+}

backend/soarca/status.go

@@ -14,11 +14,11 @@ import (
 )
 
 type reportingHandler struct {
-	backend backend.Backend
+	reporter backend.Report
 }
 
-func NewReportingHandler(backend backend.Backend) reportingHandler {
-	return reportingHandler{backend: backend}
+func NewReportingHandler(backend backend.Report) reportingHandler {
+	return reportingHandler{reporter: backend}
 }
 
 func ReportingDashboardHandler(context *gin.Context) {
@@ -49,7 +49,7 @@ func (r *reportingHandler) ReportingIndexHandler(context *gin.Context) {
 }
 
 func (r *reportingHandler) ReportingTableCardHandler(context *gin.Context) {
-	reports, _ := r.backend.GetReports()
+	reports, _ := r.reporter.GetReports()
 	var rows []table.ReportingDataTableRow
 
 	for _, report := range reports {

handlers/reporting.go

@@ -11,15 +11,15 @@ import (
 )
 
 type statusHandler struct {
-	backend backend.Backend
+	status backend.Status
 }
 
-func NewStatusHandler(backend backend.Backend) statusHandler {
-	return statusHandler{backend: backend}
+func NewStatusHandler(backend backend.Status) statusHandler {
+	return statusHandler{status: backend}
 }
 
 func (s *statusHandler) HealthComponentHandler(context *gin.Context) {
-	response, err := s.backend.GetPongFromStatus()
+	response, err := s.status.GetPongFromStatus()
 	indicatorData := miscellaneous.HealthIndicatorData{Loaded: true}
 
 	switch {

handlers/status.go

@@ -1,4 +1,4 @@
-package reporting
+package reporter
 
 import (
 	"time"

models/reporting/reporter.go models/reporter/reporter.gomodels/reporting/reporter.go renamed to models/reporter/reporter.go

@@ -4,7 +4,7 @@ import (
 	"net/http"
 
 	"soarca-gui/backend"
-	soarca "soarca-gui/backend/soarca"
+	"soarca-gui/backend/soarca"
 	"soarca-gui/handlers"
 	"soarca-gui/public"
 	"soarca-gui/utils"
@@ -18,12 +18,14 @@ func Setup(app *gin.Engine) {
 		ctx.Redirect(http.StatusTemporaryRedirect, "/404-page")
 	})
 
-	backend := soarca.New(utils.GetEnv("SOARCA_URI", "http://localhost:8080"), http.Client{})
+	reporter := soarca.NewReporter(utils.GetEnv("SOARCA_URI", "http://localhost:8080"), http.Client{})
+	status := soarca.NewStatus(utils.GetEnv("SOARCA_URI", "http://localhost:8080"), http.Client{})
+
 	publicRoutes := app.Group("/")
 
 	PublicRoutes(publicRoutes)
-	ReportingRoutes(backend, publicRoutes)
-	StatusRoutes(backend, publicRoutes)
+	ReportingRoutes(reporter, publicRoutes)
+	StatusRoutes(status, publicRoutes)
 	SettingsRoutes(publicRoutes)
 }
 
@@ -41,7 +43,7 @@ func PublicRoutes(app *gin.RouterGroup) {
 	publicRoute.StaticFS("/public", public.GetPublicAssetsFileSystem())
 }
 
-func ReportingRoutes(backend backend.Backend, app *gin.RouterGroup) {
+func ReportingRoutes(backend backend.Report, app *gin.RouterGroup) {
 	reportingHandlers := handlers.NewReportingHandler(backend)
 
 	reportingRoute := app.Group("/reporting")
@@ -52,7 +54,7 @@ func ReportingRoutes(backend backend.Backend, app *gin.RouterGroup) {
 	}
 }
 
-func StatusRoutes(backend backend.Backend, app *gin.RouterGroup) {
+func StatusRoutes(backend backend.Status, app *gin.RouterGroup) {
 	statusHandlers := handlers.NewStatusHandler(backend)
 
 	statusRoute := app.Group("/status")

routes/routes.go

@@ -0,0 +1,5 @@
+<body class=\"min-h-screen bg-gray-100 dark:bg-slate-800 flex flex-col justify-center sm:py-12 font-family-sans-serif\"><div class=\"p-10 xs:p-0 mx-auto md:w-full md:max-w-md\"><a href=\"
+\" class=\"text-white text-3xl font-semibold uppercase hover:text-gray-300\"><img src=\"
+\" class=\"w-30 py-3 md:py-0 g-image\"></a><div class=\"bg-white shadow w-full rounded-lg divide-y divide-gray-200\"><div id=\"extra-information\" class=\"px-5 py-7\"></div><div class=\"bg-white shadow w-full rounded-lg divide-y divide-gray-200\">
+</div><div class=\"py-5\"><div class=\"grid grid-cols-2 gap-1\"><div class=\"text-center sm:text-left whitespace-nowrap\"><button class=\"transition duration-200 mx-5 px-5 py-4 cursor-pointer font-normal text-sm rounded-lg text-gray-500 hover:bg-gray-100 focus:outline-none focus:bg-gray-200 focus:ring-2 focus:ring-gray-400 focus:ring-opacity-50 ring-inset\"><svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" viewBox=\"0 0 24 24\" stroke=\"currentColor\" class=\"w-4 h-4 inline-block align-text-top\"><path stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" d=\"M8 11V7a4 4 0 118 0m-4 8v2m-6 4h12a2 2 0 002-2v-6a2 2 0 00-2-2H6a2 2 0 00-2 2v6a2 2 0 002 2z\"></path></svg> <span class=\"inline-block ml-1\">Forgot Password</span></button></div><div class=\"text-center sm:text-right whitespace-nowrap\"><button class=\"transition duration-200 mx-5 px-5 py-4 cursor-pointer font-normal text-sm rounded-lg text-gray-500 hover:bg-gray-100 focus:outline-none focus:bg-gray-200 focus:ring-2 focus:ring-gray-400 focus:ring-opacity-50 ring-inset\"><svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" viewBox=\"0 0 24 24\" stroke=\"currentColor\" class=\"w-4 h-4 inline-block align-text-bottom\t\"><path stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" d=\"M18.364 5.636l-3.536 3.536m0 5.656l3.536 3.536M9.172 9.172L5.636 5.636m3.536 9.192l-3.536 3.536M21 12a9 9 0 11-18 0 9 9 0 0118 0zm-5 0a4 4 0 11-8 0 4 4 0 018 0z\"></path></svg> <span class=\"inline-block ml-1\">Help</span></button></div></div></div></div><div class=\"py-5\"><div class=\"grid grid-cols-2 gap-1\"><div class=\"text-center sm:text-left whitespace-nowrap\"><button class=\"transition duration-200 mx-5 px-5 py-4 cursor-pointer font-normal text-sm rounded-lg text-gray-500 hover:bg-gray-200 focus:outline-none focus:bg-gray-300 focus:ring-2 focus:ring-gray-400 focus:ring-opacity-50 ring-inset\"><svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" viewBox=\"0 0 24 24\" stroke=\"currentColor\" class=\"w-4 h-4 inline-block align-text-top\"><path stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" d=\"M10 19l-7-7m0 0l7-7m-7 7h18\"></path></svg> <span class=\"inline-block ml-1\">Back to SOARCA.com</span></button></div></div></div></div></body>
+<form hx-post=\"/login\" class=\"px-5 py-7\" method=\"post\" hx-target=\"#extra-information\" hx-swap=\"innerHTML\"><label name=\"email\" type=\"email\" class=\"border-none font-semibold text-sm text-gray-600 pb-1 block\">E-mail</label> <input id=\"email\" name=\"email\" type=\"email\" required class=\"border rounded-lg px-3 py-2 mt-1 mb-5 text-sm w-full\"> <label name=\"password\" type=\"password\" class=\"border-none font-semibold text-sm text-gray-600 pb-1 block\">Password</label> <input id=\"password\" name=\"password\" type=\"password\" required class=\"border rounded-lg px-3 py-2 mt-1 mb-5 text-sm w-full\"> <button class=\"transition duration-200 bg-blue-500 hover:bg-blue-600 focus:bg-blue-700 focus:shadow-sm focus:ring-4 focus:ring-blue-500 focus:ring-opacity-50 text-white w-full py-2.5 rounded-lg text-sm shadow-sm hover:shadow-md font-semibold text-center inline-block\"><span class=\"inline-block mr-2\">Login</span> <svg xmlns=\"http://www.w3.org/2000/svg\" fill=\"none\" viewBox=\"0 0 24 24\" stroke=\"currentColor\" class=\"w-4 h-4 inline-block\"><path stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" d=\"M17 8l4 4m0 0l-4 4m4-4H3\"></path></svg></button></form>