helper

Documentation

Index

• func MetadataFiles(sourceDirectory string) ([]string, error)
• func ProcessMetaFiles(metadataFiles []string, stepHelperData StepHelperData, ...) error
• type ContextDefaultData
• type ContextDefaultMetadata
• type ContextDefaultParameters
• type DocuHelperData
• type InfluxMeasurement
• type InfluxMetric
• type InfluxMetricContent
• type InfluxResource
  • func (i *InfluxResource) StructName() string
  • func (i *InfluxResource) StructString() (string, error)
• type PiperEnvironmentParameter
• type PiperEnvironmentResource
  • func (p *PiperEnvironmentResource) StructName() string
  • func (p *PiperEnvironmentResource) StructString() (string, error)
• type StepHelperData

Functions

func MetadataFiles

func MetadataFiles(sourceDirectory string) ([]string, error)

MetadataFiles provides a list of all step metadata files

func ProcessMetaFiles

func ProcessMetaFiles(metadataFiles []string, stepHelperData StepHelperData, docuHelperData DocuHelperData) error

ProcessMetaFiles generates step coding based on step configuration provided in yaml files

Types

type ContextDefaultData

type ContextDefaultData struct {
	Metadata   ContextDefaultMetadata     `json:"metadata"`
	Parameters []ContextDefaultParameters `json:"params"`
}

ContextDefaultData holds the meta data and the default data for the context default parameter descriptions

type ContextDefaultMetadata

type ContextDefaultMetadata struct {
	Name            string `json:"name"`
	Description     string `json:"description"`
	LongDescription string `json:"longDescription,omitempty"`
}

ContextDefaultMetadata holds meta data for the context default parameter descripten (name, description, long description)

type ContextDefaultParameters

type ContextDefaultParameters struct {
	Name        string   `json:"name"`
	Description string   `json:"description"`
	Scope       []string `json:"scope"`
}

ContextDefaultParameters holds the description for the context default parameters

type DocuHelperData

type DocuHelperData struct {
	IsGenerateDocu      bool
	DocTemplatePath     string
	OpenDocTemplateFile func(d string) (io.ReadCloser, error)
	DocFileWriter       func(f string, d []byte, p os.FileMode) error
}

DocuHelperData is used to transport the needed parameters and functions from the step generator to the docu generation.

type InfluxMeasurement

type InfluxMeasurement struct {
	Name   string
	Fields []InfluxMetric
	Tags   []InfluxMetric
}

InfluxMeasurement defines a measurement for Influx reporting which is defined via a step resource

type InfluxMetric

type InfluxMetric struct {
	Name string
}

InfluxMetric defines a metric (column) in an influx measurement

type InfluxMetricContent

type InfluxMetricContent struct {
	Measurement string
	ValType     string
	Name        string
	Value       *string
}

InfluxMetricContent defines the content of an Inflx metric

type InfluxResource

type InfluxResource struct {
	Name         string
	StepName     string
	Measurements []InfluxMeasurement
}

InfluxResource defines an Influx resouece that holds measurement information for a pipeline run

func (*InfluxResource) StructName

func (i *InfluxResource) StructName() string

StructName returns the name of the influx resource struct

func (*InfluxResource) StructString

func (i *InfluxResource) StructString() (string, error)

StructString returns the golang coding for the struct definition of the InfluxResource

type PiperEnvironmentParameter

type PiperEnvironmentParameter struct {
	Category string
	Name     string
}

PiperEnvironmentParameter defines a parameter within the Piper environment

type PiperEnvironmentResource

type PiperEnvironmentResource struct {
	Name       string
	StepName   string
	Parameters []PiperEnvironmentParameter
	Categories []string
}

PiperEnvironmentResource defines a piper environement resource which stores data across multiple pipeline steps

func (*PiperEnvironmentResource) StructName

func (p *PiperEnvironmentResource) StructName() string

StructName returns the name of the influx resource struct

func (*PiperEnvironmentResource) StructString

func (p *PiperEnvironmentResource) StructString() (string, error)

StructString returns the golang coding for the struct definition of the InfluxResource

type StepHelperData

type StepHelperData struct {
	OpenFile     func(s string) (io.ReadCloser, error)
	WriteFile    func(filename string, data []byte, perm os.FileMode) error
	ExportPrefix string
}

StepHelperData is used to transport the needed parameters and functions from the step generator to the step generation.