constants

Documentation

Index

• Constants

Constants

const (
	// ProjectAuthTokenAPIHeader is the header name used to authenticate project requests.
	ProjectAuthTokenAPIHeader = "x-project-auth"

	// DisplayAPIRegex is the regular expression used to match requests to the display api
	DisplayAPIRegex = "^/reports/(?P<project>[\\w\\/]+)/(?P<tag>[A-z0-9]+)\\.(?P<format>html|svg)"

	// ProjectIDParamName is used as the key wherever a project id is expected.
	ProjectIDParamName = "project_id"

	// OffsetParamName is used as the key used by clients to specify offset.
	OffsetParamName = "offset"

	// LimitParamName is used as the key used by clients to specific limit.
	LimitParamName = "limit"

	// ReportIDParamName is used as the key wherever a report id is expected.
	ReportIDParamName = "report_id"

	// ReportProjectIDBodyParam is the body param key that will be used as the project id in the report upload request.
	ReportProjectIDBodyParam = "project_id"

	// ReportFileBodyParam is the body param key that will be used to load files for a given report.
	ReportFileBodyParam = "files"

	// ShieldTextQueryParam is used as a query param key that, if provided, will determine which text to display.
	ShieldTextQueryParam = "text"
)

const (
	// AWSBucketNameEnvVariable defines the key under which the aws s3 bucket name is stored.
	AWSBucketNameEnvVariable = "AWS_BUCKET_NAME"

	// AWSAccessKeyEnvVariable defines the key under which the aws access key value will be stored.
	AWSAccessKeyEnvVariable = "AWS_ACCESS_KEY"

	// AWSAccessTokenEnvVariable defines the key under which the aws access token will be stored.
	AWSAccessTokenEnvVariable = "AWS_ACCESS_TOKEN"

	// AWSAccessKeyIDEnvVariable holds the id of the key being used for communication.
	AWSAccessKeyIDEnvVariable = "AWS_ACCESS_ID"
)

const (
	// DatabaseUsernameEnvVariable is used during connection to the db
	DatabaseUsernameEnvVariable = "DB_USERNAME"

	// DatabasePortEnvVariable is used during connection to the db
	DatabasePortEnvVariable = "DB_PORT"

	// DatabaseDatabaseEnvVariable is used during connection to the db
	DatabaseDatabaseEnvVariable = "DB_DATABASE"

	// DatabasePasswordEnvVariable is used during connection to the db
	DatabasePasswordEnvVariable = "DB_PASSWORD"

	// DatabaseHostnameEnvVariable is used during connection to the db
	DatabaseHostnameEnvVariable = "DB_HOSTNAME"
)

const (
	// GoodCoverageAmount is the float value that will determine when the display api renders green badges.
	GoodCoverageAmount = 80.00

	// DefaultShieldStyle is the style used in shield.io requests if the user has not provided one.
	DefaultShieldStyle = "flat-square"

	// ShieldConfigTemplate defines the string formatting used for shield text.
	ShieldConfigTemplate = "%s-%.2f%%-%s"

	// ShieldURLTemplate defines where the shields api lives.
	ShieldURLTemplate = "https://img.shields.io/badge/%s.svg"
)

const (
	// SyslogNetworkEnvVariable is the value of the 'net' param used duing syslog.Dial
	SyslogNetworkEnvVariable = "SYSLOG_NETWORK"

	// SyslogAddressEnvVariable is the value of the 'addr' param used duing syslog.Dial
	SyslogAddressEnvVariable = "SYSLOG_ADDRESS"

	// SyslogTagEnvVariable is the value of the 'tag' param used during syslog.Dial
	SyslogTagEnvVariable = "SYSLOG_TAG"
)

const (
	// MaxHTMLReportFileSize defines how large the byte slice used to read report data into will be.
	MaxHTMLReportFileSize = 2048
)