testutils

Documentation

Index

• func AddSampleFileRelationships(s *sbom.SBOM)
• func AssertEncoderAgainstGoldenImageSnapshot(t *testing.T, imgCfg ImageSnapshotTestConfig, cfg EncoderSnapshotTestConfig)
• func AssertEncoderAgainstGoldenSnapshot(t *testing.T, cfg EncoderSnapshotTestConfig)
• func DirectoryInput(t testing.TB, dir string) sbom.SBOM
• func DirectoryInputWithAuthorField(t testing.TB) sbom.SBOM
• func ImageInput(t testing.TB, testImage string, options ...ImageOption) sbom.SBOM
• type EncoderSnapshotTestConfig
• type ImageOption
  • func FromSnapshot() ImageOption
• type ImageSnapshotTestConfig
• type PatternReplacement
  • func NewPatternReplacement(r *regexp.Regexp) PatternReplacement
  • func (p PatternReplacement) Redact(b []byte) []byte
• type Redactions
  • func NewRedactions(redactors ...Redactor) *Redactions
  • func (r Redactions) Redact(b []byte) []byte
  • func (r *Redactions) WithFunctions(values ...func([]byte) []byte) *Redactions
  • func (r *Redactions) WithPatternRedactors(values map[string]string) *Redactions
  • func (r *Redactions) WithPatternsRedacted(values ...string) *Redactions
  • func (r *Redactions) WithRedactors(rs ...Redactor) *Redactions
  • func (r *Redactions) WithValueRedactors(values map[string]string) *Redactions
  • func (r *Redactions) WithValuesRedacted(values ...string) *Redactions
• type Redactor
• type RedactorFn
  • func (r RedactorFn) Redact(b []byte) []byte
• type ValueReplacement
  • func NewValueReplacement(v string) ValueReplacement
  • func (v ValueReplacement) Redact(b []byte) []byte

Functions

func AddSampleFileRelationships

func AddSampleFileRelationships(s *sbom.SBOM)

func AssertEncoderAgainstGoldenImageSnapshot

func AssertEncoderAgainstGoldenImageSnapshot(t *testing.T, imgCfg ImageSnapshotTestConfig, cfg EncoderSnapshotTestConfig)

func AssertEncoderAgainstGoldenSnapshot

func AssertEncoderAgainstGoldenSnapshot(t *testing.T, cfg EncoderSnapshotTestConfig)

func DirectoryInput

func DirectoryInput(t testing.TB, dir string) sbom.SBOM

func DirectoryInputWithAuthorField

func DirectoryInputWithAuthorField(t testing.TB) sbom.SBOM

func ImageInput

func ImageInput(t testing.TB, testImage string, options ...ImageOption) sbom.SBOM

Types

type EncoderSnapshotTestConfig

type EncoderSnapshotTestConfig struct {
	Subject                     sbom.SBOM
	Format                      sbom.Format
	UpdateSnapshot              bool
	PersistRedactionsInSnapshot bool
	IsJSON                      bool
	Redactor                    Redactor
}

type ImageOption

type ImageOption func(cfg *imageCfg)

func FromSnapshot

func FromSnapshot() ImageOption

type ImageSnapshotTestConfig

type ImageSnapshotTestConfig struct {
	Image               string
	UpdateImageSnapshot bool
}

type PatternReplacement

type PatternReplacement struct {
	Search  *regexp.Regexp
	Replace string
}

func NewPatternReplacement

func NewPatternReplacement(r *regexp.Regexp) PatternReplacement

func (PatternReplacement) Redact

func (p PatternReplacement) Redact(b []byte) []byte

type Redactions

type Redactions struct {
	// contains filtered or unexported fields
}

func NewRedactions

func NewRedactions(redactors ...Redactor) *Redactions

func (Redactions) Redact

func (r Redactions) Redact(b []byte) []byte

func (*Redactions) WithFunctions

func (r *Redactions) WithFunctions(values ...func([]byte) []byte) *Redactions

func (*Redactions) WithPatternRedactors

func (r *Redactions) WithPatternRedactors(values map[string]string) *Redactions

func (*Redactions) WithPatternsRedacted

func (r *Redactions) WithPatternsRedacted(values ...string) *Redactions

func (*Redactions) WithRedactors

func (r *Redactions) WithRedactors(rs ...Redactor) *Redactions

func (*Redactions) WithValueRedactors

func (r *Redactions) WithValueRedactors(values map[string]string) *Redactions

func (*Redactions) WithValuesRedacted

func (r *Redactions) WithValuesRedacted(values ...string) *Redactions

type Redactor

type Redactor interface {
	Redact([]byte) []byte
}

type RedactorFn

type RedactorFn func([]byte) []byte

func (RedactorFn) Redact

func (r RedactorFn) Redact(b []byte) []byte

type ValueReplacement

type ValueReplacement struct {
	Search  string
	Replace string
}

func NewValueReplacement

func NewValueReplacement(v string) ValueReplacement

func (ValueReplacement) Redact

func (v ValueReplacement) Redact(b []byte) []byte