transformer

Documentation

Index

• Variables
• func Destroy()
• func GetInitializedTransformers() map[string]Transformer
• func GetInitializedTransformersF(filters labels.Selector) map[string]Transformer
• func GetServices(prjName string, dir string) (services map[string][]plantypes.PlanArtifact, err error)
• func Init(assetsPath, sourcePath string, selector labels.Selector, ...) (err error)
• func InitTransformers(transformerToInit map[string]string, selector labels.Selector, ...) error
• func Transform(plan plantypes.Plan, outputPath string) (err error)
• type CloudFoundry
  • func (t *CloudFoundry) DirectoryDetect(dir string) (services map[string][]transformertypes.Artifact, err error)
  • func (t *CloudFoundry) GetConfig() (transformertypes.Transformer, *environment.Environment)
  • func (t *CloudFoundry) Init(tc transformertypes.Transformer, env *environment.Environment) (err error)
  • func (t *CloudFoundry) Transform(newArtifacts []transformertypes.Artifact, ...) ([]transformertypes.PathMapping, []transformertypes.Artifact, error)
• type ReadMeGenerator
  • func (t *ReadMeGenerator) DirectoryDetect(dir string) (services map[string][]transformertypes.Artifact, err error)
  • func (t *ReadMeGenerator) GetConfig() (transformertypes.Transformer, *environment.Environment)
  • func (t *ReadMeGenerator) Init(tc transformertypes.Transformer, env *environment.Environment) (err error)
  • func (t *ReadMeGenerator) Transform(newArtifacts []transformertypes.Artifact, ...) ([]transformertypes.PathMapping, []transformertypes.Artifact, error)
• type Router
  • func (t *Router) DirectoryDetect(dir string) (services map[string][]transformertypes.Artifact, err error)
  • func (t *Router) GetConfig() (transformertypes.Transformer, *environment.Environment)
  • func (t *Router) GetStringFromTemplate(templateString string, artifact transformertypes.Artifact) (filledString string, err error)
  • func (t *Router) Init(tc transformertypes.Transformer, env *environment.Environment) (err error)
  • func (t *Router) Transform(newArtifacts []transformertypes.Artifact, ...) ([]transformertypes.PathMapping, []transformertypes.Artifact, error)
• type RouterQuestion
• type RouterYamlConfig
• type Transformer
• type VCAPService

Variables

var VariableLiteralPattern = regexp.MustCompile("[-.+~`!@#$%^&*(){}\\[\\]:;\"',?<>/]")

VariableLiteralPattern to identify variable literals in environment names

Functions

func Destroy

func Destroy()

Destroy destroys the transformers

func GetInitializedTransformers

func GetInitializedTransformers() map[string]Transformer

GetInitializedTransformers returns the list of initialized transformers

func GetInitializedTransformersF

func GetInitializedTransformersF(filters labels.Selector) map[string]Transformer

GetInitializedTransformersF returns the list of initialized transformers after filtering

func GetServices

func GetServices(prjName string, dir string) (services map[string][]plantypes.PlanArtifact, err error)

GetServices returns the list of services detected in a directory

func Init

func Init(assetsPath, sourcePath string, selector labels.Selector, outputPath, projName string) (err error)

Init initializes the transformers

func InitTransformers

func InitTransformers(transformerToInit map[string]string, selector labels.Selector, sourcePath string, outputPath, projName string, logError bool) error

InitTransformers initializes a subset of transformers

func Transform

func Transform(plan plantypes.Plan, outputPath string) (err error)

Transform transforms as per the plan

Types

type CloudFoundry

type CloudFoundry struct {
	Config transformertypes.Transformer
	Env    *environment.Environment
}

CloudFoundry implements Transformer interface

func (*CloudFoundry) DirectoryDetect

func (t *CloudFoundry) DirectoryDetect(dir string) (services map[string][]transformertypes.Artifact, err error)

DirectoryDetect detects cloud foundry projects in various directories

func (*CloudFoundry) GetConfig

func (t *CloudFoundry) GetConfig() (transformertypes.Transformer, *environment.Environment)

GetConfig returns the transformer config

func (*CloudFoundry) Init

func (t *CloudFoundry) Init(tc transformertypes.Transformer, env *environment.Environment) (err error)

Init Initializes the transformer

func (*CloudFoundry) Transform

func (t *CloudFoundry) Transform(newArtifacts []transformertypes.Artifact, alreadySeenArtifacts []transformertypes.Artifact) ([]transformertypes.PathMapping, []transformertypes.Artifact, error)

Transform transforms the artifacts

type ReadMeGenerator

type ReadMeGenerator struct {
	Config transformertypes.Transformer
	Env    *environment.Environment
}

ReadMeGenerator implements Transformer interface

func (*ReadMeGenerator) DirectoryDetect

func (t *ReadMeGenerator) DirectoryDetect(dir string) (services map[string][]transformertypes.Artifact, err error)

DirectoryDetect executes detect in directories respecting the m2kignore

func (*ReadMeGenerator) GetConfig

func (t *ReadMeGenerator) GetConfig() (transformertypes.Transformer, *environment.Environment)

GetConfig returns the config of the transformer

func (*ReadMeGenerator) Init

func (t *ReadMeGenerator) Init(tc transformertypes.Transformer, env *environment.Environment) (err error)

Init initializes the translator

func (*ReadMeGenerator) Transform

func (t *ReadMeGenerator) Transform(newArtifacts []transformertypes.Artifact, alreadySeenArtifacts []transformertypes.Artifact) ([]transformertypes.PathMapping, []transformertypes.Artifact, error)

Transform transforms the artifacts

type Router

type Router struct {
	Config       transformertypes.Transformer
	Env          *environment.Environment
	RouterConfig *RouterYamlConfig
}

Router implements Transformer interface

func (*Router) DirectoryDetect

func (t *Router) DirectoryDetect(dir string) (services map[string][]transformertypes.Artifact, err error)

DirectoryDetect runs detects if necessary

func (*Router) GetConfig

func (t *Router) GetConfig() (transformertypes.Transformer, *environment.Environment)

GetConfig returns the transformer config

func (*Router) GetStringFromTemplate

func (t *Router) GetStringFromTemplate(templateString string, artifact transformertypes.Artifact) (filledString string, err error)

GetStringFromTemplate Translates question properties from templates to string

func (*Router) Init

func (t *Router) Init(tc transformertypes.Transformer, env *environment.Environment) (err error)

Init Initializes the transformer

func (*Router) Transform

func (t *Router) Transform(newArtifacts []transformertypes.Artifact, alreadySeenArtifacts []transformertypes.Artifact) ([]transformertypes.PathMapping, []transformertypes.Artifact, error)

Transform transforms the artifacts

type RouterQuestion

type RouterQuestion struct {
	ID    string   `yaml:"id" json:"id"`
	Desc  string   `yaml:"description,omitempty" json:"description,omitempty"`
	Hints []string `yaml:"hints,omitempty" json:"hints,omitempty"`
}

RouterQuestion stores the templated question for Router

type RouterYamlConfig

type RouterYamlConfig struct {
	TransformerSelector metav1.LabelSelector `yaml:"transformerSelector" json:"transformerSelector"`
	RouterQuestion      RouterQuestion       `yaml:"question" json:"question"`
}

RouterYamlConfig stores the yaml configuration for Router transformer

type Transformer

type Transformer interface {
	Init(tc transformertypes.Transformer, env *environment.Environment) (err error)
	// GetConfig returns the transformer config
	GetConfig() (transformertypes.Transformer, *environment.Environment)
	DirectoryDetect(dir string) (services map[string][]transformertypes.Artifact, err error)
	Transform(newArtifacts []transformertypes.Artifact, alreadySeenArtifacts []transformertypes.Artifact) ([]transformertypes.PathMapping, []transformertypes.Artifact, error)
}

Transformer interface defines transformer that transforms files and converts it to ir representation

type VCAPService

type VCAPService struct {
	ServiceName        string                 `json:"name"`
	ServiceCredentials map[string]interface{} `json:"credentials"`
}

VCAPService defines the VCAP service data from JSON