file

Documentation

Index

• type File
  • func New(spec interface{}) (*File, error)
  • func (f *File) Changelog() string
  • func (f *File) Condition(source string) (bool, error)
  • func (f *File) ConditionFromSCM(source string, scm scm.ScmHandler) (bool, error)
  • func (f *File) Read() error
  • func (f *File) Source(workingDir string) (string, error)
  • func (f *File) Target(source string, dryRun bool) (bool, error)
  • func (f *File) TargetFromSCM(source string, scm scm.ScmHandler, dryRun bool) (bool, []string, string, error)
  • func (f *File) Validate() error
• type Spec

Types

type File

type File struct {
	CurrentContent string
	// contains filtered or unexported fields
}

File defines a resource of kind "file"

func New

func New(spec interface{}) (*File, error)

New returns a reference to a newly initialized File object from a Spec or an error if the provided Filespec triggers a validation error.

func (*File) Changelog

func (f *File) Changelog() string

Changelog returns the changelog for this resource, or an empty string if not supported

func (*File) Condition

func (f *File) Condition(source string) (bool, error)

Condition test if a file content match the content provided via configuration. If the configuration doesn't specify a value then it fall back to the source output

func (*File) ConditionFromSCM

func (f *File) ConditionFromSCM(source string, scm scm.ScmHandler) (bool, error)

ConditionFromSCM test if a file content from SCM match the content provided via configuration. If the configuration doesn't specify a value then it fall back to the source output

func (*File) Read

func (f *File) Read() error

Read defines CurrentContent to the content of the file which path is specified in spec.File

func (*File) Source

func (f *File) Source(workingDir string) (string, error)

Source return a file content

func (*File) Target

func (f *File) Target(source string, dryRun bool) (bool, error)

Target creates or updates a file located locally. The default content is the value retrieved from source

func (*File) TargetFromSCM

func (f *File) TargetFromSCM(source string, scm scm.ScmHandler, dryRun bool) (bool, []string, string, error)

TargetFromSCM creates or updates a file from a source control management system. The default content is the value retrieved from source

func (*File) Validate

func (f *File) Validate() error

Validate validates the object and returns an error (with all the failed validation messages) if it is not valid

type Spec

type Spec struct {
	File           string
	Line           int
	Content        string
	ForceCreate    bool
	MatchPattern   string
	ReplacePattern string
}

Spec defines a specification for a "file" resource parsed from an updatecli manifest file