process

Documentation

Index

• Constants
• func CheckFlags(cx1client *Cx1ClientGo.Cx1Client, logger *logrus.Logger, test TestRunner) bool
• func GenerateReport(tests *[]TestResult, logger *logrus.Logger, Config *TestConfig) (float32, error)
• func LogResult(logger *logrus.Logger, result TestResult)
• func LogStart(logger *logrus.Logger, test TestRunner, CRUD, testName string)
• func OutputReportHTML(reportName string, reportData *Report, Config *TestConfig) error
• func OutputReportJSON(reportName string, reportData *Report) error
• func OutputSummaryConsole(reportData *Report, logger *logrus.Logger)
• func RunTest(cx1client *Cx1ClientGo.Cx1Client, logger *logrus.Logger, CRUD, testName string, ...)
• func RunTests(cx1client *Cx1ClientGo.Cx1Client, logger *logrus.Logger, Config *TestConfig) float32
• type Counter
  • func (c *Counter) AddTest(t *TestResult)
• type CounterSet
  • func (c *CounterSet) AddTest(t *TestResult)
• type Report
  • func (r *Report) AddTest(t *TestResult)
• type ReportSettings
• type ReportSummary
  • func (s *ReportSummary) AddTest(t *TestResult)
• type ReportTestDetails
  • func (d ReportTestDetails) String() string
• type TestConfig
  • func LoadConfig(logger *logrus.Logger, configPath string) (TestConfig, error)
• type TestResult
  • func MakeResult(test TestRunner) TestResult
  • func Run(cx1client *Cx1ClientGo.Cx1Client, logger *logrus.Logger, CRUD, testName string, ...) TestResult
• type TestRunner
• type TestSet
  • func (t *TestSet) Run(cx1client *Cx1ClientGo.Cx1Client, logger *logrus.Logger, CRUD string, ...) []TestResult
  • func (t *TestSet) RunTests(cx1client *Cx1ClientGo.Cx1Client, logger *logrus.Logger, Config *TestConfig) []TestResult

Constants

const (
	TST_FAIL = 0
	TST_PASS = 1
	TST_SKIP = 2
)

Functions

func CheckFlags

func CheckFlags(cx1client *Cx1ClientGo.Cx1Client, logger *logrus.Logger, test TestRunner) bool

func GenerateReport

func GenerateReport(tests *[]TestResult, logger *logrus.Logger, Config *TestConfig) (float32, error)

func LogResult

func LogResult(logger *logrus.Logger, result TestResult)

func LogStart

func LogStart(logger *logrus.Logger, test TestRunner, CRUD, testName string)

func OutputReportHTML

func OutputReportHTML(reportName string, reportData *Report, Config *TestConfig) error

func OutputReportJSON

func OutputReportJSON(reportName string, reportData *Report) error

func OutputSummaryConsole

func OutputSummaryConsole(reportData *Report, logger *logrus.Logger)

func RunTest

func RunTest(cx1client *Cx1ClientGo.Cx1Client, logger *logrus.Logger, CRUD, testName string, test TestRunner, results *[]TestResult, Config *TestConfig)

func RunTests

func RunTests(cx1client *Cx1ClientGo.Cx1Client, logger *logrus.Logger, Config *TestConfig) float32

Types

type Counter

type Counter struct {
	Pass uint
	Fail uint
	Skip uint
}

test result output

func (*Counter) AddTest

func (c *Counter) AddTest(t *TestResult)

type CounterSet

type CounterSet struct {
	Create Counter
	Read   Counter
	Update Counter
	Delete Counter
}

func (*CounterSet) AddTest

func (c *CounterSet) AddTest(t *TestResult)

type Report

type Report struct {
	Settings ReportSettings      `json:"Settings"`
	Summary  ReportSummary       `json:"Summary"`
	Details  []ReportTestDetails `json:"Details"`
}

func (*Report) AddTest

func (r *Report) AddTest(t *TestResult)

type ReportSettings

type ReportSettings struct {
	Target    string                  `json:"TestTarget"`
	Auth      string                  `json:"Authentication"`
	Config    string                  `json:"TestConfig"`
	Timestamp string                  `json:"ExecutionTime"`
	E2ESuffix string                  `json:"E2ESuffix"`
	Version   Cx1ClientGo.VersionInfo `json:"TargetVersions"`
}

type ReportSummary

type ReportSummary struct {
	Total Counter `json:"Total"`
	Area  struct {
		Access      CounterSet
		Application CounterSet
		Flag        CounterSet
		Group       CounterSet
		Import      CounterSet
		Preset      CounterSet
		Project     CounterSet
		Query       CounterSet
		Result      CounterSet
		Report      CounterSet
		Role        CounterSet
		Scan        CounterSet
		User        CounterSet
	} `json:"Area"`
}

func (*ReportSummary) AddTest

func (s *ReportSummary) AddTest(t *TestResult)

type ReportTestDetails

type ReportTestDetails struct {
	Name       string
	Source     string
	Test       string
	Duration   float64
	ResultType int `json:"-"`
	Result     string
}

func (ReportTestDetails) String

func (d ReportTestDetails) String() string

type TestConfig

type TestConfig struct {
	Cx1URL             string                  `yaml:"Cx1URL"`
	IAMURL             string                  `yaml:"IAMURL"`
	Tenant             string                  `yaml:"Tenant"`
	ProxyURL           string                  `yaml:"ProxyURL"`
	Tests              []TestSet               `yaml:"Tests"`
	LogLevel           string                  `yaml:"LogLevel"`
	ConfigPath         string                  `yaml:"-"`
	AuthType           string                  `yaml:"-"`
	AuthUser           string                  `yaml:"-"`
	ReportType         string                  `yaml:"ReportType"`
	ReportName         string                  `yaml:"ReportName"`
	Engines            types.EnabledEngines    `yaml:"-"`
	EnvironmentVersion Cx1ClientGo.VersionInfo `yaml:"-"`
}

func LoadConfig

func LoadConfig(logger *logrus.Logger, configPath string) (TestConfig, error)

type TestResult

type TestResult struct {
	FailTest   bool
	Result     int
	CRUD       string
	Module     string
	Duration   float64
	Name       string
	Id         int
	TestObject string
	Reason     string
	TestSource string
}

func MakeResult

func MakeResult(test TestRunner) TestResult

func Run

func Run(cx1client *Cx1ClientGo.Cx1Client, logger *logrus.Logger, CRUD, testName string, test TestRunner, Config *TestConfig) TestResult

type TestRunner

type TestRunner interface {
	Validate(testType string) error
	String() string
	IsType(testType string) bool
	IsForced() bool
	IsSupported(cx1client *Cx1ClientGo.Cx1Client, logger *logrus.Logger, testType string, Engines *types.EnabledEngines) error
	IsNegative() bool
	GetSource() string
	GetModule() string
	GetFlags() []string

	RunCreate(cx1client *Cx1ClientGo.Cx1Client, logger *logrus.Logger, Engines *types.EnabledEngines) error
	RunRead(cx1client *Cx1ClientGo.Cx1Client, logger *logrus.Logger, Engines *types.EnabledEngines) error
	RunUpdate(cx1client *Cx1ClientGo.Cx1Client, logger *logrus.Logger, Engines *types.EnabledEngines) error
	RunDelete(cx1client *Cx1ClientGo.Cx1Client, logger *logrus.Logger, Engines *types.EnabledEngines) error
}

type TestSet

type TestSet struct {
	Name              string                       `yaml:"Name"`
	File              string                       `yaml:"File"`
	AccessAssignments []types.AccessAssignmentCRUD `yaml:"AccessAssignments"`
	Applications      []types.ApplicationCRUD      `yaml:"Applications"`
	Flags             []types.FlagCRUD             `yaml:"Flags"`
	Groups            []types.GroupCRUD            `yaml:"Groups"`
	Imports           []types.ImportCRUD           `yaml:"Imports"`
	Presets           []types.PresetCRUD           `yaml:"Presets"`
	Projects          []types.ProjectCRUD          `yaml:"Projects"`
	Queries           []types.CxQLCRUD             `yaml:"Queries"`
	Reports           []types.ReportCRUD           `yaml:"Reports"`
	Results           []types.ResultCRUD           `yaml:"Results"`
	Roles             []types.RoleCRUD             `yaml:"Roles"`
	Scans             []types.ScanCRUD             `yaml:"Scans"`
	Users             []types.UserCRUD             `yaml:"Users"`

	Wait uint `yaml:"Wait"`
}

func (*TestSet) Run

func (t *TestSet) Run(cx1client *Cx1ClientGo.Cx1Client, logger *logrus.Logger, CRUD string, Config *TestConfig) []TestResult

func (*TestSet) RunTests

func (t *TestSet) RunTests(cx1client *Cx1ClientGo.Cx1Client, logger *logrus.Logger, Config *TestConfig) []TestResult