v0.6.2: LatestRelease <- Development (#82)

Author: lmbek

.github/workflows/Run-Go-Tests-Linux.yml

@@ -0,0 +1,33 @@
+# This workflow will build a golang project
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-go
+
+name: Go Tests (Linux)
+
+on:
+ # push:
+ #   branches: [ "Development" ]
+  pull_request:
+    branches: [ "Development", "LatestRelease" ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    
+    #- uses: browser-actions/setup-chrome@v1
+    #- run: chrome --version
+
+    - name: Set up Go
+      uses: actions/setup-go@v3
+      with:
+        go-version: 1.19
+        
+    - name: Go Tests
+      run: go test -v ./tests/...
+    
+#    - name: Go Tests utils
+#      run: go test -v ./tests/utils
+      
+    #- name: Go Tests net
+    #  run: go test -v ./tests/utils/net

.github/workflows/Run-Go-Tests.yml …ithub/workflows/Run-Go-Tests-Windows.yml.github/workflows/Run-Go-Tests.yml renamed to .github/workflows/Run-Go-Tests-Windows.yml .github/workflows/Run-Go-Tests.yml renamed to .github/workflows/Run-Go-Tests-Windows.yml

@@ -1,13 +1,13 @@
 # This workflow will build a golang project
 # For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-go
 
-name: Go Tests (only random package)
+name: Go Tests (Windows)
 
 on:
  # push:
  #   branches: [ "Development" ]
   pull_request:
-    branches: [ "Development" ]
+    branches: [ "Development", "LatestRelease" ]
 
 jobs:
   build:
@@ -23,8 +23,8 @@ jobs:
       with:
         go-version: 1.19
 
-    - name: Go Test random package
-      run: go test -v ./tests/utils/random
+    - name: Go Tests
+      run: go test -v ./tests/...
 
 #    - name: Go Tests utils
 #      run: go test -v ./tests/utils

README.md

@@ -42,47 +42,60 @@ Example: how to add framework to main.go
 package main
 
 import (
-	"github.com/lmbek/gobek/fileserver"
+	"fmt"
 	"github.com/lmbek/gobek/launcher"
-	"net/http"
 	"os"
-	"runtime"
 )
 
 // For windows we need a organisation name and project name
 var organisationName = "NewOrganisationName" // put in organisation name
 var projectName = "NewProjectName"           // put in project name
 
-//Remember to create this folder manually if it doesnt exist, and put a index.html file into it
 var frontendPath = "./frontend" // this should be set to where frontend files is (frontend folder: html, css, javascript...)
 
-// remember to change the ports to something unique
 var chromeLauncher = launcher.ChromeLauncher{
-	Location:                "C:\\Program Files\\Google\\Chrome\\Application\\chrome.exe",
-	LocationCMD:             "C:\\\"Program Files\"\\Google\\Chrome\\Application\\chrome.exe",
-	FrontendInstallLocation: os.Getenv("localappdata") + "\\Google\\Chrome\\InstalledApps\\" + organisationName + "\\" + projectName,
-	Domain:                  "localhost",
-	PortMin:                 11430,
-	PreferredPort:           11451,
-	PortMax:                 11500,
+	Location:                os.Getenv("programfiles") + "\\Google\\Chrome\\Application\\chrome.exe",
+	FrontendInstallLocation: os.Getenv("localappdata") + "\\Google\\Chrome\\InstalledApps\\" + "DefaultOrganisationName" + "\\" + "DefaultProjectName",
 }
 
 var chromiumLauncher = launcher.DefaultChromiumLauncher // default chrome or chromium launcher settings can be used like this
 
-func main() {
-    // if you want to have an api, you can add your own
-	//http.HandleFunc("/api/", api.ServeAPIUseGZip)
+/*
+	// Otherwise they can also be customized like this
+
+	var chromiumLauncher = launcher.ChromiumLauncher{
+		Location:      "/var/lib/snapd/desktop/applications/chromium_chromium.desktop", // TODO: check if better location or can be customised
+		Domain:        "localhost",
+	}
+*/
 
-    // if you want to use your own http handlerFunc, you can use launcher.StartCustom instead
-	err := launcher.Start(frontendPath, chromeLauncher, chromiumLauncher) // serves "/" as fileserver.ServeFileServer. If you want to manage "/", then use launcher.StartCustom() instead
+func main() {
+    // add your own API
+	//api.Init()
+	/*
+		var once sync.Once
+		once.Do(func() {
+			http.HandleFunc("/", fileserver.ServeFileServer)
+			http.HandleFunc("/api/", api.ServeAPIUseGZip)
+		})
+		err := launcher.Start(frontendPath, chromeLauncher, chromiumLauncher) // serves "/" as fileserver.ServeFileServer. If you want to manage "/", then use launcher.StartCustom() instead
+		if err != nil {
+			fmt.Println(err)
+		}
+	*/
+	err := launcher.StartDefault(frontendPath, chromeLauncher, chromiumLauncher)
 	if err != nil {
 		fmt.Println(err)
 	}
 }
+
 </pre>
 
+## How to test
+<code>go test ./tests/...</code>
+
 ## How to run
-<code>go run main.go</code>
+make your own main.go by following https://github.com/lmbek/gobek-example
 
 ## How to apply manifest and logo to executible
 Use something like goversioninfo: https://github.com/josephspurrier/goversioninfo
@@ -94,4 +107,4 @@ Use something like goversioninfo: https://github.com/josephspurrier/goversioninf
 Coming later
 
 ## Further plans
-I want to embed chromium or webview into this project at some time. Please let me know or make a pull request if you want to help.
+Huge changes coming to version 0.7.0 that will change the whole project structure, this will break all versions before 0.7.0 when upgrading

fileserver/fileserver.go

@@ -10,14 +10,15 @@ import (
 	"net/http"
 	"os"
 	"os/signal"
+	"path"
 	"strings"
 	"syscall"
 	"time"
 )
 
 var FrontendPath = "./frontend" // should be set doing runtime by main.go
 var Server = http.Server{
-	Addr:              "", // should be set doing runtime by main.go with fileserver.SetServerAddress
+	Addr:              "localhost:0", // port is set on runtime
 	Handler:           nil,
 	TLSConfig:         nil,
 	ReadTimeout:       5 * time.Second,
@@ -61,26 +62,71 @@ func ServeFileServer(response http.ResponseWriter, request *http.Request) {
 
 func setHeaders(response http.ResponseWriter, request *http.Request) http.ResponseWriter {
 	// Headers can be set here
-	// Add Cache Cache-Control: max-age=31536000, immutable
 
-	// response.Header().Add("Cache-Control", "max-age=31536000, immutable")
+	// set content-type for requested url path
+	contentType := getContentType(path.Ext(request.URL.Path))
+	response.Header().Set("Content-Type", contentType)
 
-	// Check if the requested file has a ".css" extension
-	if strings.HasSuffix(request.URL.Path, ".html") {
-		response.Header().Set("Content-Type", "text/html")
-	}
+	response.Header().Set("Cache-Control", "no-store, no-cache, must-revalidate")
+	response.Header().Set("Expires", "Thu, 01 Jan 1970 00:00:00 GMT")
 
-	if strings.HasSuffix(request.URL.Path, ".js") {
-		response.Header().Set("Content-Type", "application/javascript")
-	}
+	// Add Cache Cache-Control: max-age=31536000, immutable
+	// response.Header().Add("Cache-Control", "max-age=31536000, immutable")
+	return response
+}
 
-	if strings.HasSuffix(request.URL.Path, ".css") {
-		response.Header().Set("Content-Type", "text/css")
+func getContentType(ext string) string {
+	if len(ext) == 0 {
+		return "text/html" // return and do not run further if no extension, we assume it is html
 	}
 
-	response.Header().Set("Cache-Control", "no-store, no-cache, must-revalidate")
-	response.Header().Set("Expires", "Thu, 01 Jan 1970 00:00:00 GMT")
-	return response
+	switch ext {
+	case ".html", ".htm", ".shtml":
+		return "text/html"
+	case ".css":
+		return "text/css"
+	case ".js":
+		return "application/javascript"
+	case ".json":
+		return "application/json"
+	case ".xml":
+		return "application/xml"
+	case ".pdf":
+		return "application/pdf"
+	case ".zip":
+		return "application/zip"
+	case ".gzip", ".gz":
+		return "application/gzip"
+	case ".png":
+		return "image/png"
+	case ".jpg", ".jpeg":
+		return "image/jpeg"
+	case ".gif":
+		return "image/gif"
+	case ".svg":
+		return "image/svg+xml"
+	case ".webp":
+		return "image/webp"
+	case ".ico":
+		return "image/x-icon"
+	case ".mp4":
+		return "video/mp4"
+	case ".webm":
+		return "video/webm"
+	case ".mp3":
+		return "audio/mpeg"
+	case ".wav":
+		return "audio/wav"
+	case ".ogg":
+		return "audio/ogg"
+	// cases like these below should be handled by an API, that should return something custom
+	//case ".exe":
+	//	return "application/octet-stream"
+	//case ".msi":
+	//	return "application/octet-stream"
+	default:
+		return "text/plain"
+	}
 }
 
 func Start() error {
@@ -91,18 +137,20 @@ func Start() error {
 	return nil
 }
 
+// TODO: Make proper tests for graceful shutdowns, maybe it does not work properly, remove this comment when confirmed
 func Shutdown(serverContext context.Context) error {
 	serverContext, cancel := context.WithTimeout(serverContext, ServerGraceShutdownTime)
 	defer cancel()
 	err := Server.Shutdown(serverContext)
 	if err != nil {
-		log.Println("Failed to gracefully shutdown the server:", err)
+		log.Println("Failed to gracefully shutdown the server: ", err)
 		return err
 	}
 	log.Println("Server has been shut down gracefully")
 	return nil
 }
 
+// TODO: Make proper tests for graceful shutdowns, maybe it does not work properly, remove this comment when confirmed
 func GracefulStart() error {
 	err := Start()
 
@@ -113,7 +161,8 @@ func GracefulStart() error {
 	} else {
 		_, closeChannel := CreateChannel()
 		defer closeChannel()
-		log.Println("Application stopped gracefully")
+		// Error shutting down gracefully
+		fmt.Println("Application stopped gracefully")
 		return Shutdown(context.Background())
 	}
 }

go.work

@@ -0,0 +1 @@
+use .