report

Documentation

Index

• Constants
• Variables
• func NewCmdReport() *cobra.Command
• type DSN
  • func NewDSN(raw string) (*DSN, error)
• type QueryResponse
• type ReportOptions
  • func (opts *ReportOptions) Run() int
• type ReportQuery
• type ReportQueryInput

Constants

const (
	CliVersion = "v0.8.0"
)

Variables

var ErrInvalidDSN = errors.New("DeepSource | Error | Invalid DSN. Cross verify DEEPSOURCE_DSN value against the settings page of the repository")

Functions

func NewCmdReport

func NewCmdReport() *cobra.Command

NewCmdVersion returns the current version of cli being used

Types

type DSN

type DSN struct {
	Protocol string
	Host     string
	Token    string
}

func NewDSN

func NewDSN(raw string) (*DSN, error)

type QueryResponse

type QueryResponse struct {
	Data struct {
		CreateArtifact struct {
			Error   string `json:"error"`
			Message string `json:"message"`
			Ok      bool   `json:"ok"`
		} `json:"createArtifact"`
	} `json:"data"`
}

QueryResponse is the response returned by artifacts report GraphQL query

type ReportOptions

type ReportOptions struct {
	Analyzer                    string
	AnalyzerType                string
	Key                         string
	Value                       string
	ValueFile                   string
	SkipCertificateVerification bool
	DSN                         string
}

func (*ReportOptions) Run

func (opts *ReportOptions) Run() int

type ReportQuery

type ReportQuery struct {
	Query     string `json:"query"`
	Variables struct {
		Input ReportQueryInput `json:"input"`
	} `json:"variables"`
}

ReportQueryInput is the structure of artifacts report GraphQL query

type ReportQueryInput

type ReportQueryInput struct {
	AccessToken       string      `json:"accessToken"`
	CommitOID         string      `json:"commitOid"`
	ReporterName      string      `json:"reporter"`
	ReporterVersion   string      `json:"reporterVersion"`
	Key               string      `json:"key"`
	Data              string      `json:"data"`
	AnalyzerShortcode string      `json:"analyzer"`
	AnalyzerType      string      `json:"analyzerType,omitempty"`
	Metadata          interface{} `json:"metadata,omitempty"`
}

ReportQueryInput is the schema for variables of artifacts report GraphQL query