defaults

package
v0.0.0-...-51710b4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 17, 2019 License: GPL-3.0 Imports: 1 Imported by: 0

Documentation

Overview

Package defaults defines default constraints for the server and the test suite. Do not modify these settings because the server and the tests rely on them.

Index

Constants

View Source
const (
	// The following constants are the default settings
	// for the productive server. Do not modify these or
	// use them in test cases.
	ServerPort        uint16 = 8443                       // The default server port
	ServerTickets     string = "./files/tickets"          // The default ticket directory path
	ServerUsers       string = "./files/users/users.json" // The default user file path
	ServerMails       string = "./files/mails"            // The default mail directory path
	ServerCertificate string = "./ssl/server.cert"        // The default SSL certificate file
	ServerKey         string = "./ssl/server.key"         // The default SSL private key file
	ServerWeb         string = "./www"                    // The default web directory

	// The following values are an addition to the default
	// server configuration. They can be used in packages
	// and tests which are located in a subdirectory of
	// the project's root directory.
	ServerTicketsTrimmed string = "../files/tickets"          // The trimmed default ticket directory path
	ServerUsersTrimmed   string = "../files/users/users.json" // The trimmed default user file path
	ServerMailsTrimmed   string = "../files/mails"            // The trimmed default mail directory path

	// These constants form the default logging configuration
	// of the server. It can be safely used inside tests.
	LogVerbose     bool   = false  // The default value for the verbose logging option
	LogFullPaths   bool   = false  // The default value for the full paths logging option
	LogLevelString string = "info" // The default value for the log level option

	// The following values are the default CLI configuration.
	CliHost        string = "localhost"         // The default CLI hostname
	CliPort        uint16 = 8443                // The default CLI port
	CliCertificate string = "./ssl/server.cert" // The default SSL certificate file
	CliFetch       bool   = false               // The default value for the fetch option
	CliSubmit      bool   = false               // The default value for the submit option

	// These constants are testing values for the server
	// configuration. The directories for tickets and
	// mails have been changed.
	TestPort        uint16 = 8444                           // The default test port
	TestTickets     string = "../../files/testtickets"      // The default path to the test ticket directory
	TestUsers       string = "../../files/users/users.json" // The default path to the users file
	TestMails       string = "../../files/testmails"        // The default path to the test mail directory
	TestCertificate string = "../../ssl/server.cert"        // The default file path to the SSL certificate
	TestKey         string = "../../ssl/server.key"         // The default file path to the SSL private key
	TestWeb         string = "../../www"                    // The default path to the web directory

	// These constants are testing values as well, but
	// for packages which are only "one directory deep"
	// as seen from the project's root directory.
	TestTicketsTrimmed     string = "../files/testtickets"          // The trimmed default path to the test ticket directory
	TestUsersTrimmed       string = "../files/testusers/users.json" // The trimmed default path to the test users file
	TestMailsTrimmed       string = "../files/testmails"            // The trimmed default path to the test mail directory
	TestCertificateTrimmed string = "../ssl/server.cert"            // The trimmed default file path to the SSL certificate
	TestKeyTrimmed         string = "../ssl/server.key"             // The trimmed default file path to the SSL private key
	TestWebTrimmed         string = "../www"                        // The trimmed default path to the web directory
)

Global default constraints for the server and the included test cases. Do not modify these settings because the server and the tests rely on them.

View Source
const (
	// FileModeRegular is the default file mode used
	// to write ticket and mail files as well as the
	// users file.
	FileModeRegular os.FileMode = 0644
)

Standard file modes for writing of ticket and mail files.

Variables

This section is empty.

Functions

This section is empty.

Types

type ExitCode

type ExitCode int

ExitCode is a type to represent exit codes of the server.

const (
	// ExitSuccessful is the exit code for a successful
	// server startup and shutdown.
	ExitSuccessful ExitCode = iota

	// ExitStartError is an exit code that denotes a
	// server startup error.
	ExitStartError

	// ExitShutdownError is an exit code that denotes a
	// server shutdown error.
	ExitShutdownError
)

The exit codes defined by the server.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL