logarea

Documentation

Overview

Copyright Axis Communications AB.

For a full list of individual contributors, please see the commit history.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright Axis Communications AB.

For a full list of individual contributors, please see the commit history.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• Constants
• func New(cfg config.Config, log *logrus.Entry) application.Application
• type Auth
  • func (a Auth) DecryptPassword(logger *logrus.Entry) string
• type Decrypt
• type Directory
• type Download
• type Downloadable
• type Filter
  • func (f Filter) Run(jsondata []byte, headers interface{}, suite []byte, baseURL string) ([]Downloadable, error)
• type FilterType
• type Filters
• type LogArea
• type LogAreaApplication
  • func (a *LogAreaApplication) Close()
  • func (a LogAreaApplication) LoadRoutes(router *httprouter.Router)
• type LogAreaHandler
  • func (h LogAreaHandler) GetFileURLs(w http.ResponseWriter, r *http.Request, ps httprouter.Params)
  • func (h LogAreaHandler) Selftest(w http.ResponseWriter, r *http.Request, _ httprouter.Params)
• type Request
  • func (r Request) Do(ctx context.Context, logger *logrus.Entry) (*http.Response, error)
• type Response
• type Suite

Constants

const (
	REGEX   = "" /* 212-byte string literal not displayed */
	TIMEOUT = 15 * time.Second
)

REGEX for matching /testrun/tercc-id/suite/main-suite-id/subsuite/subsuite-id/suite.

Functions

func New

func New(cfg config.Config, log *logrus.Entry) application.Application

New returns a new LogAreaApplication object/struct.

Types

type Auth

type Auth struct {
	Username string  `json:"username"`
	Password Decrypt `json:"password"`
	AuthType string  `json:"type"`
}

func (Auth) DecryptPassword

func (a Auth) DecryptPassword(logger *logrus.Entry) string

DecryptPassword decrypts the password in the suite definition using a decryption key that has been provided as an environment variable.

type Decrypt

type Decrypt struct {
	Decrypt struct {
		Value string `json:"value"`
	} `json:"$decrypt"`
}

type Directory

type Directory struct {
	Logs      []Downloadable `json:"logs"`
	Artifacts []Downloadable `json:"artifacts"`
}

type Download

type Download struct {
	Request Request `json:"request"`
	Filters Filters `json:"filters"`
}

type Downloadable

type Downloadable struct {
	URL  string       `json:"url"`
	Name []FilterType `json:"name"`
}

type Filter

type Filter struct {
	URLs     []FilterType `json:"urls"`
	Filename []FilterType `json:"filename"`
}

func (Filter) Run

func (f Filter) Run(jsondata []byte, headers interface{}, suite []byte, baseURL string) ([]Downloadable, error)

Run the filters stored in the sub suite definition to get URLs from a json blob, headers or the suite definition (as json).

type FilterType

type FilterType struct {
	Source   string `json:"source"`
	JMESPath string `json:"jmespath"`
}

type Filters

type Filters struct {
	BaseURL   string `json:"base_url"`
	Logs      Filter `json:"logs"`
	Artifacts Filter `json:"artifacts"`
}

type LogArea

type LogArea struct {
	Download []Download `json:"download"`
}

type LogAreaApplication

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

func (*LogAreaApplication) Close

func (a *LogAreaApplication) Close()

Close cancels the application context and closes the ETCD client.

func (LogAreaApplication) LoadRoutes

func (a LogAreaApplication) LoadRoutes(router *httprouter.Router)

LoadRoutes loads all the v1alpha routes.

type LogAreaHandler

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

func (LogAreaHandler) GetFileURLs

func (h LogAreaHandler) GetFileURLs(w http.ResponseWriter, r *http.Request, ps httprouter.Params)

GetFileURLs is an endpoint for getting file URLs from a log area.

func (LogAreaHandler) Selftest

func (h LogAreaHandler) Selftest(w http.ResponseWriter, r *http.Request, _ httprouter.Params)

Selftest is a handler to just return 204.

type Request

type Request struct {
	Auth    Auth                   `json:"auth,omitempty"`
	URL     string                 `json:"url"`
	Method  string                 `json:"method"`
	Headers map[string]string      `json:"headers,omitempty"`
	Params  map[string]interface{} `json:"params,omitempty"`
}

func (Request) Do

func (r Request) Do(ctx context.Context, logger *logrus.Entry) (*http.Response, error)

Do executes a request using the information in the Request part of the ETOS sub suite definition.

type Response

type Response map[string]Directory

type Suite

type Suite struct {
	Name    string  `json:"name"`
	LogArea LogArea `json:"log_area"`
}

Suite is the partial sub suite definition of ETOS.