Documentation
¶
Overview ¶
Package cleaner contains all the business logic of cleaning (obfuscation + omission) files on different types of content (k8s resources, text files, paths).
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ContentObfuscator ¶
type ContentObfuscator struct {
Obfuscator obfuscator.Obfuscator
}
ContentObfuscator wraps any obfuscator and implements ReadWriteObfuscator
func (*ContentObfuscator) ObfuscateReader ¶
type FileContentObfuscator ¶
type FileContentObfuscator struct {
ContentObfuscator
// contains filtered or unexported fields
}
FileContentObfuscator obfuscates a file by implementing FileObfuscator and ReadWriteObfuscator.
func (*FileContentObfuscator) ObfuscateFile ¶
func (c *FileContentObfuscator) ObfuscateFile(inputFile string, outputFile string) error
type FileObfuscator ¶
type FileObfuscator interface {
// ObfuscateFile obfuscates a text file and writes the result into the outputFile.
ObfuscateFile(inputFile string, outputFile string) error
}
FileObfuscator is responsible for obfuscating a file on the filesystem and output the result into another file.
type FileProcessor ¶
type FileProcessor struct {
FileContentObfuscator
// contains filtered or unexported fields
}
FileProcessor cleans (either omit or obfuscates) a path by implementing Processor.
func (*FileProcessor) Process ¶
func (c *FileProcessor) Process(path string) error
type Processor ¶
type Processor interface {
// Process is the end2end method for cleaning (omit + obfuscate path and content of) a file on disk.
// Will return nil if the file was processed without an error (e.g. through omission) or the error otherwise.
Process(inputFile string) error
}
Processor is responsible for processing a single input file.
func NewFileCleaner ¶
func NewFileCleaner(inputPath string, outputPath string, obfuscator obfuscator.Obfuscator, omitter omitter.Omitter) Processor
type ReadWriteObfuscator ¶
type ReadWriteObfuscator interface {
// ObfuscateReader obfuscates on an agnostic line-based reader and writes to an agnostic writer facility
ObfuscateReader(inputReader io.Reader, outputWriter io.Writer) error
}
ReadWriteObfuscator is responsible for obfuscating input from an io.Reader and outputting to an io.Writer
Source Files