Re-usable and extendable main package.

Fixes #39

Author: joesiltberg

CHANGELOG.md

@@ -1,5 +1,8 @@
 ## Releases
 
+## v1.2.1 (2024-09-19)
+  - Re-usable and extendable main package (#39)
+
 ## v1.2.0 (2024-09-16)
 #### Features
   - Windermere can run as a Windows service (#18)

cmd/windermere/start.go

@@ -0,0 +1,27 @@
+/*
+*  This file is part of Windermere (EGIL SCIM Server).
+*
+*  Copyright (C) 2019-2024 Föreningen Sambruk
+*
+*  This program is free software: you can redistribute it and/or modify
+*  it under the terms of the GNU Affero General Public License as
+*  published by the Free Software Foundation, either version 3 of the
+*  License, or (at your option) any later version.
+
+*  This program is distributed in the hope that it will be useful,
+*  but WITHOUT ANY WARRANTY; without even the implied warranty of
+*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+*  GNU Affero General Public License for more details.
+
+*  You should have received a copy of the GNU Affero General Public License
+*  along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+package main
+
+import (
+	"github.com/Sambruk/windermere/program"
+)
+
+func main() {
+	program.Main(nil)
+}

cmd/windermere/accesslog.go renamed to program/accesslog.go

@@ -17,7 +17,7 @@
  *  along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-package main
+package program
 
 import (
 	"log"

cmd/windermere/apikeyauth.go renamed to program/apikeyauth.go

@@ -1,4 +1,4 @@
-package main
+package program
 
 import (
 	"context"

cmd/windermere/limiter.go renamed to program/limiter.go

@@ -1,4 +1,4 @@
-package main
+package program
 
 import (
 	"net/http"

cmd/windermere/main.go renamed to program/main.go

@@ -17,7 +17,7 @@
  *  along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-package main
+package program
 
 import (
 	"context"
@@ -40,6 +40,12 @@ import (
 	"golang.org/x/time/rate"
 )
 
+type Extension interface {
+	ParametersOfInterest() []string
+	Start(parameters map[string]interface{}, w *windermere.Windermere)
+	Stop()
+}
+
 // Windermere can be run in interactive mode as a regular executable,
 // or as a service. The code below is used when using the program as
 // a service.
@@ -59,10 +65,12 @@ type serviceInterface struct {
 	// When running as a service, the process will send to this channel to signal
 	// when proper shutdown is complete.
 	done chan bool
+
+	extension Extension
 }
 
 func (si serviceInterface) Start(s service.Service) error {
-	go run(si.signals, si.done)
+	go run(si.signals, si.done, si.extension)
 	return nil
 }
 
@@ -179,11 +187,21 @@ func parseClients(value interface{}) (map[string]string, error) {
 	return res, nil
 }
 
+func getViperParameters(parameters []string) map[string]interface{} {
+	result := make(map[string]interface{})
+	for _, p := range parameters {
+		if viper.IsSet(p) {
+			result[p] = viper.Get(p)
+		}
+	}
+	return result
+}
+
 // This is like the programs core main function. The actual main()
 // will take care of parsing arguments and behaves a bit differently
 // depending on whether we're running interactively, as a service,
 // or if we're installing/uninstalling a service.
-func run(signals chan os.Signal, done chan bool) {
+func run(signals chan os.Signal, done chan bool, extension Extension) {
 	certFile := viper.GetString(CNFCert)
 	keyFile := viper.GetString(CNFKey)
 
@@ -341,6 +359,11 @@ func run(signals chan os.Signal, done chan bool) {
 		}()
 	}
 
+	if extension != nil {
+		extensionParameters := getViperParameters(extension.ParametersOfInterest())
+		extension.Start(extensionParameters, wind)
+	}
+
 	waitForShutdownSignal(signals)
 
 	log.Printf("Shutting down, waiting for active requests to finish...")
@@ -359,6 +382,10 @@ func run(signals chan os.Signal, done chan bool) {
 		}
 	}
 
+	if extension != nil {
+		extension.Stop()
+	}
+
 	err = wind.Shutdown()
 	if err != nil {
 		log.Printf("Failed to gracefully shutdown Windermere: %v", err)
@@ -376,7 +403,7 @@ func run(signals chan os.Signal, done chan bool) {
 	}
 }
 
-func main() {
+func Main(ext Extension) {
 	// Configuration defaults
 	defaults := map[string]interface{}{
 		CNFMDURL:                  "https://fed.skolfederation.se/prod/md/kontosynk.jws",
@@ -462,7 +489,7 @@ func main() {
 		UserName:    *serviceUser,
 		Option:      opts,
 	}
-	si := &serviceInterface{signals: sigs, done: make(chan bool)}
+	si := &serviceInterface{signals: sigs, done: make(chan bool), extension: ext}
 	s, err := service.New(si, serviceConfig)
 	if err != nil {
 		log.Fatalf("Cannot create the service: %s", err.Error())
@@ -485,7 +512,7 @@ func main() {
 		} else {
 			// Don't use the service, just run directly so Ctrl-C works
 			signal.Notify(sigs, syscall.SIGINT, syscall.SIGTERM)
-			run(sigs, nil)
+			run(sigs, nil, ext)
 		}
 	} else {
 		err = s.Run()

cmd/windermere/metadata.go renamed to program/metadata.go

@@ -17,7 +17,7 @@
  *  along with this program.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-package main
+package program
 
 import (
 	"crypto/x509"

cmd/windermere/panicreporttimeouthandler.go renamed to program/panicreporttimeouthandler.go

@@ -1,4 +1,4 @@
-package main
+package program
 
 import (
 	"log"

cmd/windermere/parseclients_test.go renamed to program/parseclients_test.go

@@ -1,4 +1,4 @@
-package main
+package program
 
 import (
 	"strings"