file

Documentation

Index

• Constants
• func Diff(a, b string) (result string)
• func HasPrefix(filename string, prefixes []string) bool
• func IsURL(str string) bool
• func Read(filename, workingDir string) (data []byte, err error)
• func ReadFromFile(file string) (data []byte, err error)
• func ReadFromURL(file string) (data []byte, err error)
• func Show(content string) (result string)
• func WriteToFile(content string, filename string) (err error)
• type File
  • func (f *File) Condition(source string) (bool, error)
  • func (f *File) ConditionFromSCM(source string, scm scm.Scm) (bool, error)
  • func (f *File) Source(workingDir string) (string, error)
  • func (f *File) Target(source string, dryRun bool) (changed bool, err error)
  • func (f *File) TargetFromSCM(source string, scm scm.Scm, dryRun bool) (changed bool, files []string, message string, err error)
• type Line
  • func (l *Line) ContainsExcluded(content string) (output string, err error)
  • func (l *Line) ContainsIncluded(content string) (output string, err error)
  • func (l *Line) HasIncluded(content string) (found bool, err error)

Constants

const (
	//ErrLineNotFound is the error message when no matching line found
	ErrLineNotFound string = "line not found"
)

Functions

func Diff

func Diff(a, b string) (result string)

Diff return a diff like string, comparing string A and string B

func HasPrefix

func HasPrefix(filename string, prefixes []string) bool

HasPrefix test if a filename uses a prefix

func IsURL

func IsURL(str string) bool

IsURL tests if a string is a valid http URL

func Read

func Read(filename, workingDir string) (data []byte, err error)

Read read file from a location then return an array of byte. The location accepts multiple input http/https urls "https://", file url "file://", or a simple file

func ReadFromFile

func ReadFromFile(file string) (data []byte, err error)

ReadFromFile read a file then return its data as an array of byte.

func ReadFromURL

func ReadFromURL(file string) (data []byte, err error)

ReadFromURL read a file form a http/https url then return its data as an array of byte.

func Show

func Show(content string) (result string)

Show return a string where each line start with a tabulation to increase visibility

func WriteToFile

func WriteToFile(content string, filename string) (err error)

WriteToFile write a string to a file

Types

type File

type File struct {
	File    string
	Line    Line
	Content string
}

File defines the resource file that can be configured from an updatecli configuration

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.Scm) (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) 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) (changed bool, err 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.Scm, dryRun bool) (changed bool, files []string, message string, err error)

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

type Line

type Line struct {
	HasIncludes []string
	Includes    []string
	Excludes    []string
}

Line hold rule that define if a specific line should be included or excluded

func (*Line) ContainsExcluded

func (l *Line) ContainsExcluded(content string) (output string, err error)

ContainsExcluded return a content without excluded lines

func (*Line) ContainsIncluded

func (l *Line) ContainsIncluded(content string) (output string, err error)

ContainsIncluded return a content with only matching lines

func (*Line) HasIncluded

func (l *Line) HasIncluded(content string) (found bool, err error)

HasIncluded return an error content with only matching lines