models

Documentation

Index

• type SonarqubeAccessToken
  • func (sat SonarqubeAccessToken) GetAccessTokenAuthenticator() plugin.ApiAuthenticator
  • func (sat SonarqubeAccessToken) GetEncodedToken() string
  • func (sat SonarqubeAccessToken) SetupAuthentication(req *http.Request) errors.Error
• type SonarqubeAccount
  • func (SonarqubeAccount) TableName() string
• type SonarqubeAdditionalFileMetrics
  • func (SonarqubeAdditionalFileMetrics) TableName() string
• type SonarqubeApiParams
• type SonarqubeApiProject
  • func (sonarqubeApiProject SonarqubeApiProject) ConvertApiScope() plugin.ToolLayerScope
• type SonarqubeConn
• type SonarqubeConnection
  • func (SonarqubeConnection) TableName() string
• type SonarqubeFileMetrics
  • func (SonarqubeFileMetrics) TableName() string
• type SonarqubeHotspot
  • func (SonarqubeHotspot) TableName() string
• type SonarqubeIssue
  • func (SonarqubeIssue) TableName() string
• type SonarqubeIssueCodeBlock
  • func (SonarqubeIssueCodeBlock) TableName() string
• type SonarqubeProject
  • func (p SonarqubeProject) ScopeId() string
  • func (p SonarqubeProject) ScopeName() string
  • func (p SonarqubeProject) ScopeParams() interface{}
  • func (SonarqubeProject) TableName() string
• type SonarqubeResponse
• type SonarqubeWholeFileMetrics
  • func (SonarqubeWholeFileMetrics) TableName() string

Types

type SonarqubeAccessToken

type SonarqubeAccessToken helper.AccessToken

func (SonarqubeAccessToken) GetAccessTokenAuthenticator

func (sat SonarqubeAccessToken) GetAccessTokenAuthenticator() plugin.ApiAuthenticator

func (SonarqubeAccessToken) GetEncodedToken

func (sat SonarqubeAccessToken) GetEncodedToken() string

GetEncodedToken returns encoded bearer token for HTTP Basic Authentication

func (SonarqubeAccessToken) SetupAuthentication

func (sat SonarqubeAccessToken) SetupAuthentication(req *http.Request) errors.Error

SetupAuthentication sets up the HTTP Request Authentication

type SonarqubeAccount

type SonarqubeAccount struct {
	common.NoPKModel
	ConnectionId uint64 `gorm:"primaryKey"`
	Login        string `json:"login" gorm:"primaryKey"`
	Name         string `gorm:"type:varchar(100)"`
	Email        string `gorm:"type:varchar(100)"`
	Active       bool   `json:"active"`
	Local        bool   `json:"local"`
}

func (SonarqubeAccount) TableName

func (SonarqubeAccount) TableName() string

type SonarqubeAdditionalFileMetrics

type SonarqubeAdditionalFileMetrics struct {
	ConnectionId                        uint64 `gorm:"primaryKey"`
	FileMetricsKey                      string `gorm:"primaryKey"`
	DuplicatedFiles                     int
	DuplicatedLines                     int
	EffortToReachMaintainabilityRatingA int
	Complexity                          int
	CognitiveComplexity                 int
	NumOfLines                          int
	DuplicatedLinesDensity              float64
	DuplicatedBlocks                    int
	common.NoPKModel
}

func (SonarqubeAdditionalFileMetrics) TableName

func (SonarqubeAdditionalFileMetrics) TableName() string

type SonarqubeApiParams

type SonarqubeApiParams struct {
	ConnectionId uint64 `json:"connectionId"`
	ProjectKey   string
}

type SonarqubeApiProject

type SonarqubeApiProject struct {
	ProjectKey       string             `json:"key"`
	Name             string             `json:"name"`
	Qualifier        string             `json:"qualifier"`
	Visibility       string             `json:"visibility"`
	LastAnalysisDate *utils.Iso8601Time `json:"lastAnalysisDate"`
	Revision         string             `json:"revision"`
}

func (SonarqubeApiProject) ConvertApiScope

func (sonarqubeApiProject SonarqubeApiProject) ConvertApiScope() plugin.ToolLayerScope

Convert the API response to our DB model instance

type SonarqubeConn

type SonarqubeConn struct {
	helper.RestConnection `mapstructure:",squash"`
	SonarqubeAccessToken  `mapstructure:",squash"`
}

SonarqubeConn holds the essential information to connect to the sonarqube API

type SonarqubeConnection

type SonarqubeConnection struct {
	helper.BaseConnection `mapstructure:",squash"`
	helper.RestConnection `mapstructure:",squash"`
	SonarqubeAccessToken  `mapstructure:",squash"`
}

This object conforms to what the frontend currently sends.

func (SonarqubeConnection) TableName

func (SonarqubeConnection) TableName() string

type SonarqubeFileMetrics

type SonarqubeFileMetrics struct {
	ConnectionId             uint64 `gorm:"primaryKey"`
	FileMetricsKey           string `gorm:"primaryKey"`
	ProjectKey               string `gorm:"index"`
	FileName                 string
	FilePath                 string
	FileLanguage             string
	CodeSmells               int
	SqaleIndex               int
	SqaleRating              float64
	Bugs                     int
	ReliabilityRating        string
	Vulnerabilities          int
	SecurityRating           string
	SecurityHotspots         int
	SecurityHotspotsReviewed float64
	SecurityReviewRating     string
	Ncloc                    int
	Coverage                 float64
	UncoveredLines           int
	LinesToCover             int
	common.NoPKModel
}

func (SonarqubeFileMetrics) TableName

func (SonarqubeFileMetrics) TableName() string

type SonarqubeHotspot

type SonarqubeHotspot struct {
	ConnectionId             uint64 `gorm:"primaryKey"`
	HotspotKey               string `gorm:"primaryKey"`
	RuleKey                  string `gorm:"type:varchar(255)"`
	Component                string `gorm:"index"`
	ProjectKey               string `gorm:"index"`
	Line                     int
	Status                   string `gorm:"type:varchar(100)"`
	Message                  string
	Author                   string `gorm:"type:varchar(100)"`
	Assignee                 string `gorm:"type:varchar(100)"`
	SecurityCategory         string `gorm:"type:varchar(100)"`
	VulnerabilityProbability string `gorm:"type:varchar(100)"`
	CreationDate             *utils.Iso8601Time
	UpdateDate               *utils.Iso8601Time
	common.NoPKModel
}

func (SonarqubeHotspot) TableName

func (SonarqubeHotspot) TableName() string

type SonarqubeIssue

type SonarqubeIssue struct {
	ConnectionId uint64 `gorm:"primaryKey"`
	IssueKey     string `gorm:"primaryKey;type:varchar(100)"`
	Rule         string `gorm:"type:varchar(255)"`
	Severity     string `gorm:"type:varchar(100)"`
	Component    string `gorm:"type:varchar(255)"`
	ProjectKey   string `gorm:"index;type:varchar(255)"` //domain project key
	Line         int
	Status       string `gorm:"type:varchar(20)"`
	Message      string
	Debt         int
	Effort       int
	Author       string `gorm:"type:varchar(100)"`
	Hash         string `gorm:"type:varchar(100)"`
	Tags         string
	Type         string `gorm:"type:varchar(100)"`
	Scope        string `gorm:"type:varchar(255)"`
	StartLine    int
	EndLine      int
	StartOffset  int
	EndOffset    int
	CreationDate *utils.Iso8601Time
	UpdateDate   *utils.Iso8601Time
	common.NoPKModel
}

func (SonarqubeIssue) TableName

func (SonarqubeIssue) TableName() string

type SonarqubeIssueCodeBlock

type SonarqubeIssueCodeBlock struct {
	ConnectionId uint64 `gorm:"primaryKey"`
	Id           string `gorm:"primaryKey"`
	IssueKey     string `gorm:"index"`
	Component    string `gorm:"index"`
	StartLine    int
	EndLine      int
	StartOffset  int
	EndOffset    int
	Msg          string
	common.NoPKModel
}

func (SonarqubeIssueCodeBlock) TableName

func (SonarqubeIssueCodeBlock) TableName() string

type SonarqubeProject

type SonarqubeProject struct {
	common.NoPKModel `json:"-" mapstructure:"-"`
	ConnectionId     uint64             `json:"connectionId" validate:"required" gorm:"primaryKey" mapstructure:"connectionId"`
	ProjectKey       string             `json:"projectKey" validate:"required" gorm:"type:varchar(255);primaryKey" mapstructure:"projectKey"`
	Name             string             `json:"name" gorm:"type:varchar(255)" mapstructure:"name"`
	Qualifier        string             `json:"qualifier" gorm:"type:varchar(255)" mapstructure:"qualifier"`
	Visibility       string             `json:"visibility" gorm:"type:varchar(64)" mapstructure:"visibility"`
	LastAnalysisDate *utils.Iso8601Time `json:"lastAnalysisDate" mapstructure:"lastAnalysisDate"`
	Revision         string             `json:"revision" gorm:"type:varchar(128)" mapstructure:"revision"`
}

func (SonarqubeProject) ScopeId

func (p SonarqubeProject) ScopeId() string

func (SonarqubeProject) ScopeName

func (p SonarqubeProject) ScopeName() string

func (SonarqubeProject) ScopeParams

func (p SonarqubeProject) ScopeParams() interface{}

func (SonarqubeProject) TableName

func (SonarqubeProject) TableName() string

type SonarqubeResponse

type SonarqubeResponse struct {
	Name string `json:"name"`
	ID   int    `json:"id"`
	SonarqubeConnection
}

This object conforms to what the frontend currently expects.

type SonarqubeWholeFileMetrics

type SonarqubeWholeFileMetrics struct {
	ConnectionId                        uint64 `gorm:"primaryKey"`
	FileMetricsKey                      string `gorm:"primaryKey"`
	ProjectKey                          string `gorm:"index"`
	FileName                            string `gorm:"type:varchar(255)"`
	FilePath                            string
	FileLanguage                        string `gorm:"type:varchar(20)"`
	CodeSmells                          int
	SqaleIndex                          int
	SqaleRating                         float64
	Bugs                                int
	ReliabilityRating                   string `gorm:"type:varchar(20)"`
	Vulnerabilities                     int
	SecurityRating                      string `gorm:"type:varchar(20)"`
	SecurityHotspots                    int
	SecurityHotspotsReviewed            float64
	SecurityReviewRating                string `gorm:"type:varchar(20)"`
	Ncloc                               int
	Coverage                            float64
	UncoveredLines                      int
	LinesToCover                        int
	DuplicatedLinesDensity              float64
	DuplicatedBlocks                    int
	DuplicatedFiles                     int
	DuplicatedLines                     int
	EffortToReachMaintainabilityRatingA int
	Complexity                          int
	CognitiveComplexity                 int
	NumOfLines                          int
	common.NoPKModel
}

func (SonarqubeWholeFileMetrics) TableName

func (SonarqubeWholeFileMetrics) TableName() string