server

type FabricBrokerConfig struct {
	FabricEndpoint string              `json:"fabric_endpoint"` // URI to WebSocket endpoint
	UseTCP         bool                `json:"use_tcp"`         // Use TCP instead of WebSocket
	TCPPort        int                 `json:"tcp_port"`        // TCP port to use if UseTCP is true
	EndpointConfig *bus.EndpointConfig `json:"endpoint_config"` // STOMP configuration
}

type MessageBridge struct {
	ServiceListenStream bus.MessageHandler // message handler returned by bus.ListenStream responsible for relaying back messages as HTTP responses
	// contains filtered or unexported fields
}

type NoDirFileSystem struct {
	// contains filtered or unexported fields
}

type PlankIntegrationTest interface {
	SetPlatformServer(PlatformServer)
	SetSysChan(chan os.Signal)
	SetChannelManager(bus.ChannelManager)
	SetBus(eventBus bus.EventBus)
}

type PlankIntegrationTestSuite struct {

	// suite.Suite is a reference to a testify test suite.
	suite.Suite

	// server.PlatformServer is a reference to plank
	PlatformServer

	// os.Signal is the signal channel passed into plan for OS level notifications.
	Syschan chan os.Signal

	// bus.ChannelManager is a reference to the Transport's Channel Manager.
	bus.ChannelManager

	// bus.EventBus is a reference to Transport.
	bus.EventBus
}

type PlatformServer interface {
	StartServer(syschan chan os.Signal)                                         // start server
	StopServer()                                                                // stop server
	GetRouter() *mux.Router                                                     // get *mux.Router instance
	RegisterService(svc service.FabricService, svcChannel string) error         // register a new service at given channel
	SetHttpChannelBridge(bridgeConfig *service.RESTBridgeConfig)                // set up a REST bridge for a service
	SetStaticRoute(prefix, fullpath string, middlewareFn ...mux.MiddlewareFunc) // set up a static content route
	SetHttpPathPrefixChannelBridge(bridgeConfig *service.RESTBridgeConfig)      // set up a REST bridge for a path prefix for a service.
	CustomizeTLSConfig(tls *tls.Config) error                                   // used to replace default tls.Config for HTTP server with a custom config
	GetRestBridgeSubRoute(uri, method string) (*mux.Route, error)               // get *mux.Route that maps to the provided uri and method
	GetMiddlewareManager() middleware.MiddlewareManager                         // get middleware manager

}

type PlatformServerConfig struct {
	RootDir           string              `json:"root_dir"`                       // root directory the server should base itself on
	StaticDir         []string            `json:"static_dir"`                     // static content folders that HTTP server should serve
	SpaConfig         *SpaConfig          `json:"spa_config"`                     // single page application configuration
	Host              string              `json:"host"`                           // hostname for the server
	Port              int                 `json:"port"`                           // port for the server
	Logger            *slog.Logger        `json:"-"`                              // logger instance
	FabricConfig      *FabricBrokerConfig `json:"fabric_config"`                  // Fabric (websocket) configuration
	TLSCertConfig     *TLSCertConfig      `json:"tls_config"`                     // TLS certificate configuration
	Debug             bool                `json:"debug"`                          // enable debug logging
	NoBanner          bool                `json:"no_banner"`                      // start server without displaying the banner
	ShutdownTimeout   time.Duration       `json:"shutdown_timeout_in_minutes"`    // graceful server shutdown timeout in minutes
	RestBridgeTimeout time.Duration       `json:"rest_bridge_timeout_in_minutes"` // rest bridge timeout in minutes
}

type ServerAvailability struct {
	Http   bool // Http server availability
	Fabric bool // stomp broker availability
}

type SpaConfig struct {
	RootFolder        string            `json:"root_folder"`         // location where Plank will serve SPA
	BaseUri           string            `json:"base_uri"`            // base URI for the SPA
	StaticAssets      []string          `json:"static_assets"`       // locations for static assets used by the SPA
	CacheControlRules map[string]string `json:"cache_control_rules"` // map holding glob pattern - cache-control header value
	// contains filtered or unexported fields
}

type TLSCertConfig struct {
	CertFile                  string `json:"cert_file"`                   // path to certificate file
	KeyFile                   string `json:"key_file"`                    // path to private key file
	SkipCertificateValidation bool   `json:"skip_certificate_validation"` // whether to skip certificate validation (useful for self-signed cert)
}