ux

Documentation

Index

• type AnalysisIsReadyProperties
• type AnalysisIsTriggeredProperties
• type AnalysisType
• type Analytics
• type IDE
• type IssueHoverIsDisplayedProperties
• type IssueType
• type PluginIsInstalledProperties
• type Result
• type ScanModeIsSelectedProperties
• type Severity
• type TestAnalytics
  • func NewTestAnalytics() *TestAnalytics
  • func (n *TestAnalytics) AnalysisIsReady(properties AnalysisIsReadyProperties)
  • func (n *TestAnalytics) AnalysisIsTriggered(properties AnalysisIsTriggeredProperties)
  • func (n *TestAnalytics) GetAnalytics() []any
  • func (n *TestAnalytics) Identify()
  • func (n *TestAnalytics) Initialise()
  • func (n *TestAnalytics) IssueHoverIsDisplayed(properties IssueHoverIsDisplayedProperties)
  • func (n *TestAnalytics) PluginIsInstalled(properties PluginIsInstalledProperties)
  • func (n *TestAnalytics) ScanModeIsSelected(properties ScanModeIsSelectedProperties)
  • func (n *TestAnalytics) Shutdown() error

Types

type AnalysisIsReadyProperties

type AnalysisIsReadyProperties struct {
	AnalysisType      AnalysisType `json:"analysisType"`
	Result            Result       `json:"result"`
	FileCount         int          `json:"fileCount,omitempty"`
	DurationInSeconds float64      `json:"durationInSeconds,omitempty"`
}

type AnalysisIsTriggeredProperties

type AnalysisIsTriggeredProperties struct {
	AnalysisType    []AnalysisType `json:"analysisType"`
	TriggeredByUser bool           `json:"triggeredByUser"`
}

type AnalysisType

type AnalysisType string

const (
	Advisor              AnalysisType = "Vulnmap Advisor"
	CodeQuality          AnalysisType = "Vulnmap Code Quality"
	CodeSecurity         AnalysisType = "Vulnmap Code Security"
	OpenSource           AnalysisType = "Vulnmap Open Source"
	Container            AnalysisType = "Vulnmap Container"
	InfrastructureAsCode AnalysisType = "Vulnmap Infrastructure as Code"
)

type Analytics

type Analytics interface {
	Initialise()
	Shutdown() error
	Identify()
	AnalysisIsReady(properties AnalysisIsReadyProperties)
	AnalysisIsTriggered(properties AnalysisIsTriggeredProperties)
	IssueHoverIsDisplayed(properties IssueHoverIsDisplayedProperties)
	PluginIsInstalled(properties PluginIsInstalledProperties)
	ScanModeIsSelected(properties ScanModeIsSelectedProperties)
}

type IDE

type IDE string

const (
	VisualStudioCode IDE = "Visual Studio Code"
	VisualStudio     IDE = "Visual Studio"
	Eclipse          IDE = "Eclipse"
	JetBrains        IDE = "JetBrains"
)

type IssueHoverIsDisplayedProperties

type IssueHoverIsDisplayedProperties struct {
	IssueId   string    `json:"issueId"`
	IssueType IssueType `json:"issueType"`
	Severity  Severity  `json:"severity"`
}

type IssueType

type IssueType string

const (
	AdvisorIssue              IssueType = "Advisor"
	CodeQualityIssue          IssueType = "Code Quality Issue"
	CodeSecurityVulnerability IssueType = "Code Security Vulnerability"
	LicenceIssue              IssueType = "Licence Issue"
	OpenSourceVulnerability   IssueType = "Open Source Vulnerability"
	InfrastructureAsCodeIssue IssueType = "Infrastructure as Code Issue"
	ContainerVulnerability    IssueType = "Container Vulnerability"
)

type PluginIsInstalledProperties

type PluginIsInstalledProperties struct {
}

type Result

type Result string

const (
	Success Result = "Success"
	Error   Result = "Error"
)

type ScanModeIsSelectedProperties

type ScanModeIsSelectedProperties struct {
	ScanningMode string `json:"scanningMode"`
}

type Severity

type Severity string

const (
	High     Severity = "High"
	Medium   Severity = "Medium"
	Low      Severity = "Low"
	Critical Severity = "Critical"
)

type TestAnalytics

type TestAnalytics struct {
	Identified              bool
	Initialized             bool
	ScanModeIsSelectedCount int
	// contains filtered or unexported fields
}

func NewTestAnalytics

func NewTestAnalytics() *TestAnalytics

func (*TestAnalytics) AnalysisIsReady

func (n *TestAnalytics) AnalysisIsReady(properties AnalysisIsReadyProperties)

func (*TestAnalytics) AnalysisIsTriggered

func (n *TestAnalytics) AnalysisIsTriggered(properties AnalysisIsTriggeredProperties)

func (*TestAnalytics) GetAnalytics

func (n *TestAnalytics) GetAnalytics() []any

func (*TestAnalytics) Identify

func (n *TestAnalytics) Identify()

func (*TestAnalytics) Initialise

func (n *TestAnalytics) Initialise()

func (*TestAnalytics) IssueHoverIsDisplayed

func (n *TestAnalytics) IssueHoverIsDisplayed(properties IssueHoverIsDisplayedProperties)

func (*TestAnalytics) PluginIsInstalled

func (n *TestAnalytics) PluginIsInstalled(properties PluginIsInstalledProperties)

func (*TestAnalytics) ScanModeIsSelected

func (n *TestAnalytics) ScanModeIsSelected(properties ScanModeIsSelectedProperties)

func (*TestAnalytics) Shutdown

func (n *TestAnalytics) Shutdown() error