reports

Documentation

Index

• Constants
• func MergeFromString(old, new string) string
• type Action
  • func (a *Action) Merge(sourceAction *Action, useDetailsFromSourceAction bool)
  • func (a *Action) String() string
  • func (a Action) ToActionsMarkdownString() string
  • func (a Action) ToActionsString() string
  • func (a *Action) UpdatePipelineURL()
• type ActionTarget
  • func (a *ActionTarget) Merge(sourceActionTarget *ActionTarget, useDetailsFromSourceActionTarget bool)
• type ActionTargetChangelog
• type Actions
  • func (a *Actions) Merge(sourceActions *Actions)
  • func (a *Actions) String() string
• type PipelineURL
• type Report
  • func (r *Report) ExportToYAML(reportDir string, hideTimestamp bool) (string, error)
  • func (r *Report) String(mode string) (report string, err error)
  • func (r *Report) UpdateID() error
• type Reports
  • func (r *Reports) Show() error
  • func (r *Reports) Sort()
  • func (r *Reports) Summary() (successCounter, changedCounter, failedCounter, skippedCounter int, ...)
• type Stage

Constants

const (
	// CONDITIONREPORTTEMPLATE defines
	CONDITIONREPORTTEMPLATE string = `` /* 190-byte string literal not displayed */

	// TARGETREPORTTEMPLATE ...
	TARGETREPORTTEMPLATE string = `` /* 172-byte string literal not displayed */

	// SOURCEREPORTTEMPLATE ...
	SOURCEREPORTTEMPLATE string = `` /* 169-byte string literal not displayed */

	// REPORTTEMPLATE ...
	REPORTTEMPLATE string = `` /* 833-byte string literal not displayed */

)

Functions

func MergeFromString

func MergeFromString(old, new string) string

Types

type Action

type Action struct {
	// ID is the unique identifier of the action
	ID string `xml:"id,attr" json:"id,omitempty"`
	// Title is the title of the action
	Title string `xml:"-" json:"title,omitempty"`
	// PipelineTitle is the title of the pipeline
	PipelineTitle string `xml:"h3,omitempty" json:"pipelineTitle,omitempty"`
	// Description is the description of the action
	Description string `xml:"p,omitempty" json:"description,omitempty"`
	// Targets is the list of targets IDs associated with the action
	Targets []ActionTarget `xml:"details,omitempty" json:"targets,omitempty"`
	// using a pointer to avoid empty tag
	PipelineURL *PipelineURL `xml:"a,omitempty" json:"pipelineURL,omitempty"`
	// Link is the URL of the action
	Link string `xml:"link,omitempty" json:"actionUrl,omitempty"`
}

Action is a struct used to store the result of an action. It is used to generate pullrequest body

func (*Action) Merge

func (a *Action) Merge(sourceAction *Action, useDetailsFromSourceAction bool)

func (*Action) String

func (a *Action) String() string

String show an action report formatted as a string

func (Action) ToActionsMarkdownString

func (a Action) ToActionsMarkdownString() string

ToActionsMarkdownString show an action report formatted as a string using markdown

func (Action) ToActionsString

func (a Action) ToActionsString() string

ToActionsString show an action report formatted as a string

func (*Action) UpdatePipelineURL

func (a *Action) UpdatePipelineURL()

UpdatePipelineURL analyze the local environment to guess if Updatecli is executed from a CI pipeline

type ActionTarget

type ActionTarget struct {
	ID          string                  `xml:"id,attr"`
	Title       string                  `xml:"summary,omitempty"`
	Description string                  `xml:"p,omitempty"`
	Changelogs  []ActionTargetChangelog `xml:"details,omitempty"`
}

ActionTarget holds target data to describe an action report

func (*ActionTarget) Merge

func (a *ActionTarget) Merge(sourceActionTarget *ActionTarget, useDetailsFromSourceActionTarget bool)

type ActionTargetChangelog

type ActionTargetChangelog struct {
	// Title is the title of the changelog
	Title string `xml:"summary,omitempty" json:"title,omitempty"`
	// Description is the description of the changelog
	Description string `xml:"pre,omitempty" json:"description,omitempty"`
}

ActionTargetChangelog is a struct used to store a target changelog

type Actions

type Actions struct {
	Actions []Action `xml:"action"`
}

func (*Actions) Merge

func (a *Actions) Merge(sourceActions *Actions)

func (*Actions) String

func (a *Actions) String() string

String show an action report formatted as a string

type PipelineURL

type PipelineURL struct {
	// URL is the URL of the pipeline
	URL string `xml:"href,attr"`
	// Name is the name of the pipeline
	Name string `xml:",chardata"`
}

PipelineURL is a struct used to store a pipeline URL

type Report

type Report struct {
	Name   string
	Err    string
	Result string
	// ID defines the report ID
	ID string
	// PipelineID represents the Updatecli manifest pipelineID
	PipelineID string
	Actions    map[string]*Action
	Sources    map[string]*result.Source
	Conditions map[string]*result.Condition
	Targets    map[string]*result.Target
	ReportURL  string
}

Report contains the result of the execution of a pipeline

func (*Report) ExportToYAML

func (r *Report) ExportToYAML(reportDir string, hideTimestamp bool) (string, error)

ExportToYAML exports the report to a YAML file in the temporary report directory. The filename is based on the report ID and the current timestamp.

func (*Report) String

func (r *Report) String(mode string) (report string, err error)

String returns a report as a string

func (*Report) UpdateID

func (r *Report) UpdateID() error

UpdateID generates a unique ID for the report based on the content of the report Ideally the report ID should be the same regardless of the result of the pipeline. The goal is to be able to identify what report corresponds to what pipeline manifest. It's different from the pipelineID which is used to identify an update scenario which could be the result of multiple Updatecli manifests.

type Reports

type Reports []Report

Reports contains a list of report

func (*Reports) Show

func (r *Reports) Show() error

Show return a small reports of what has been changed

func (*Reports) Sort

func (r *Reports) Sort()

Sort reports by result in the following order SUCCESS > SKIPPED > ATTENTION > FAILURE > UNKNOWN

func (*Reports) Summary

func (r *Reports) Summary() (successCounter, changedCounter, failedCounter, skippedCounter int, actionLinks []string)

Summary display a summary of

type Stage

type Stage struct {
	Name   string
	Kind   string
	Result string
}

Stage contains the information if specific stage reported a success, a change, an error