routing

Documentation

Overview

This file is part of SystemTestPortal. Copyright (C) 2017 Institute of Software Technology, University of Stuttgart

SystemTestPortal is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

SystemTestPortal 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 General Public License for more details.

You should have received a copy of the GNU General Public License along with SystemTestPortal. If not, see <http://www.gnu.org/licenses/>.

Package routing contains the routing for the application. This includes the routers and the urls belonging to each handler.

Index

• Constants
• func DefaultRedirect(url string) http.HandlerFunc
• func InitRouter() http.Handler
• func MethodNotAllowed(w http.ResponseWriter, r *http.Request, ...)
• func NotFound(w http.ResponseWriter, r *http.Request)
• func Redirect(redirectURL string, status int) http.HandlerFunc

Constants

const (
	Register = "/register"
	SignIn   = "/signin"
	SignOut  = "/signout"

	About = "/about"

	Explore = "/explore"

	Dashboard = "/dashboard"

	Projects = "/projects"
	Users    = "/users"
	Groups   = "/groups"

	Cases     = "/testcases"
	Sequences = "/testsequences"
	Protocols = "/protocols"
	Members   = "/members"
)

The different static parts a url can be made of

const (
	Show              = "/"
	New               = "/new"
	Edit              = "/edit"
	Update            = "/update"
	Duplicate         = "/duplicate"
	History           = "/history"
	Execute           = "/execute"
	Save              = "/save"
	Print             = "/print"
	JSON              = "/json"
	Info              = "/info"
	Versions          = "/versions"
	Settings          = "/settings"
	Labels            = "/labels"
	Roles             = "/roles"
	Add               = "/add"
	Remove            = "/remove"
	Tester            = "/tester"
	SequenceDashboard = "/sequences"
)

The actions that can be taken on an item

const (
	VarContainer = "/:container"
	VarProject   = "/:project"
	VarSequence  = "/:testsequence"
	VarCase      = "/:testcase"
)

The variables a url part can be

Functions

func DefaultRedirect

func DefaultRedirect(url string) http.HandlerFunc

DefaultRedirect returns a simple handler that just redirects to given url using 303 as status.

func InitRouter

func InitRouter() http.Handler

InitRouter initializes the main router that handles all incoming requests

func MethodNotAllowed

func MethodNotAllowed(w http.ResponseWriter, r *http.Request,
	methods map[string]httptreemux.HandlerFunc)

MethodNotAllowed responds with a method not allowed page on every request. noinspection GoUnusedParameter

func NotFound

func NotFound(w http.ResponseWriter, r *http.Request)

NotFound responds with a not found page on every request.

func Redirect

func Redirect(redirectURL string, status int) http.HandlerFunc

Redirect returns a simple handler that just redirects to given url using given status.