Skip to content

refact pkg/acquisition: extract loop method #3615

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion cmd/crowdsec/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ func LoadAcquisition(cConfig *csconfig.Config) ([]acquisition.DataSource, error)
return nil, fmt.Errorf("failed to configure datasource for %s: %w", flags.OneShotDSN, err)
}
} else {
dataSources, err = acquisition.LoadAcquisitionFromFile(cConfig.Crowdsec, cConfig.Prometheus)
dataSources, err = acquisition.LoadAcquisitionFromFiles(cConfig.Crowdsec, cConfig.Prometheus)
if err != nil {
return nil, err
}
Expand Down
158 changes: 87 additions & 71 deletions pkg/acquisition/acquisition.go
Original file line number Diff line number Diff line change
Expand Up @@ -216,113 +216,129 @@
return configuration.METRICS_FULL
}

// LoadAcquisitionFromFile unmarshals the configuration item and checks its availability
func LoadAcquisitionFromFile(config *csconfig.CrowdsecServiceCfg, prom *csconfig.PrometheusCfg) ([]DataSource, error) {
var sources []DataSource

metrics_level := GetMetricsLevelFromPromCfg(prom)

for _, acquisFile := range config.AcquisitionFiles {
log.Infof("loading acquisition file : %s", acquisFile)

yamlFile, err := os.Open(acquisFile)
if err != nil {
return nil, err
}
// sourcesFromFile reads and parses one acquisition file into DataSources.
func sourcesFromFile(acquisFile string, metrics_level int) ([]DataSource, error) {
var sources []DataSource

defer yamlFile.Close()
log.Infof("loading acquisition file : %s", acquisFile)

acquisContent, err := io.ReadAll(yamlFile)
if err != nil {
return nil, fmt.Errorf("failed to read %s: %w", acquisFile, err)
}
yamlFile, err := os.Open(acquisFile)
if err != nil {
return nil, err
}

expandedAcquis := csstring.StrictExpand(string(acquisContent), os.LookupEnv)
defer yamlFile.Close()

dec := yaml.NewDecoder(strings.NewReader(expandedAcquis))
dec.SetStrict(true)
acquisContent, err := io.ReadAll(yamlFile)
if err != nil {
return nil, fmt.Errorf("failed to read %s: %w", acquisFile, err)
}

Check warning on line 236 in pkg/acquisition/acquisition.go

View check run for this annotation

Codecov / codecov/patch

pkg/acquisition/acquisition.go#L235-L236

Added lines #L235 - L236 were not covered by tests

idx := -1
expandedAcquis := csstring.StrictExpand(string(acquisContent), os.LookupEnv)

for {
var sub configuration.DataSourceCommonCfg
dec := yaml.NewDecoder(strings.NewReader(expandedAcquis))
dec.SetStrict(true)

idx += 1
idx := -1

err = dec.Decode(&sub)
if err != nil {
if !errors.Is(err, io.EOF) {
return nil, fmt.Errorf("failed to parse %s: %w", acquisFile, err)
}
for {
var sub configuration.DataSourceCommonCfg

log.Tracef("End of yaml file")
idx += 1

break
err = dec.Decode(&sub)
if err != nil {
if !errors.Is(err, io.EOF) {
return nil, fmt.Errorf("failed to parse %s: %w", acquisFile, err)
}

// for backward compat ('type' was not mandatory, detect it)
if guessType := detectBackwardCompatAcquis(sub); guessType != "" {
log.Debugf("datasource type missing in %s (position %d): detected 'source=%s'", acquisFile, idx, guessType)
log.Tracef("End of yaml file")

if sub.Source != "" && sub.Source != guessType {
log.Warnf("datasource type mismatch in %s (position %d): found '%s' but should probably be '%s'", acquisFile, idx, sub.Source, guessType)
}
break
}

sub.Source = guessType
}
// it's an empty item, skip it
if len(sub.Labels) == 0 {
if sub.Source == "" {
log.Debugf("skipping empty item in %s", acquisFile)
continue
}
// for backward compat ('type' was not mandatory, detect it)
if guessType := detectBackwardCompatAcquis(sub); guessType != "" {
log.Debugf("datasource type missing in %s (position %d): detected 'source=%s'", acquisFile, idx, guessType)

if sub.Source != "docker" {
// docker is the only source that can be empty
return nil, fmt.Errorf("missing labels in %s (position %d)", acquisFile, idx)
}
if sub.Source != "" && sub.Source != guessType {
log.Warnf("datasource type mismatch in %s (position %d): found '%s' but should probably be '%s'", acquisFile, idx, sub.Source, guessType)
}

sub.Source = guessType
}
// it's an empty item, skip it
if len(sub.Labels) == 0 {
if sub.Source == "" {
return nil, fmt.Errorf("data source type is empty ('source') in %s (position %d)", acquisFile, idx)
log.Debugf("skipping empty item in %s", acquisFile)
continue
}

// pre-check that the source is valid
_, err := GetDataSourceIface(sub.Source)
if err != nil {
return nil, fmt.Errorf("in file %s (position %d) - %w", acquisFile, idx, err)
if sub.Source != "docker" {
// docker is the only source that can be empty
return nil, fmt.Errorf("missing labels in %s (position %d)", acquisFile, idx)
}
}

uniqueId := uuid.NewString()
sub.UniqueId = uniqueId
if sub.Source == "" {
return nil, fmt.Errorf("data source type is empty ('source') in %s (position %d)", acquisFile, idx)
}

Check warning on line 286 in pkg/acquisition/acquisition.go

View check run for this annotation

Codecov / codecov/patch

pkg/acquisition/acquisition.go#L285-L286

Added lines #L285 - L286 were not covered by tests

src, err := DataSourceConfigure(sub, metrics_level)
if err != nil {
var dserr *DataSourceUnavailableError
if errors.As(err, &dserr) {
log.Error(err)
continue
}
// pre-check that the source is valid
_, err := GetDataSourceIface(sub.Source)
if err != nil {
return nil, fmt.Errorf("in file %s (position %d) - %w", acquisFile, idx, err)
}

return nil, fmt.Errorf("while configuring datasource of type %s from %s (position %d): %w", sub.Source, acquisFile, idx, err)
uniqueId := uuid.NewString()
sub.UniqueId = uniqueId

src, err := DataSourceConfigure(sub, metrics_level)
if err != nil {
var dserr *DataSourceUnavailableError
if errors.As(err, &dserr) {
log.Error(err)
continue
}

if sub.TransformExpr != "" {
vm, err := expr.Compile(sub.TransformExpr, exprhelpers.GetExprOptions(map[string]interface{}{"evt": &types.Event{}})...)
if err != nil {
return nil, fmt.Errorf("while compiling transform expression '%s' for datasource %s in %s (position %d): %w", sub.TransformExpr, sub.Source, acquisFile, idx, err)
}
return nil, fmt.Errorf("while configuring datasource of type %s from %s (position %d): %w", sub.Source, acquisFile, idx, err)
}

transformRuntimes[uniqueId] = vm
if sub.TransformExpr != "" {
vm, err := expr.Compile(sub.TransformExpr, exprhelpers.GetExprOptions(map[string]interface{}{"evt": &types.Event{}})...)
if err != nil {
return nil, fmt.Errorf("while compiling transform expression '%s' for datasource %s in %s (position %d): %w", sub.TransformExpr, sub.Source, acquisFile, idx, err)

Check warning on line 311 in pkg/acquisition/acquisition.go

View check run for this annotation

Codecov / codecov/patch

pkg/acquisition/acquisition.go#L309-L311

Added lines #L309 - L311 were not covered by tests
}

sources = append(sources, src)
transformRuntimes[uniqueId] = vm

Check warning on line 314 in pkg/acquisition/acquisition.go

View check run for this annotation

Codecov / codecov/patch

pkg/acquisition/acquisition.go#L314

Added line #L314 was not covered by tests
}

sources = append(sources, src)
}

return sources, nil
}


// LoadAcquisitionFromFiles unmarshals the configuration item and checks its availability
func LoadAcquisitionFromFiles(config *csconfig.CrowdsecServiceCfg, prom *csconfig.PrometheusCfg) ([]DataSource, error) {
var allSources []DataSource

metrics_level := GetMetricsLevelFromPromCfg(prom)

for _, acquisFile := range config.AcquisitionFiles {
sources, err := sourcesFromFile(acquisFile, metrics_level)
if err != nil {
return nil, err
}

allSources = append(allSources, sources...)
}

return allSources, nil
}

func GetMetrics(sources []DataSource, aggregated bool) error {
var metrics []prometheus.Collector

Expand Down
4 changes: 2 additions & 2 deletions pkg/acquisition/acquisition_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,7 @@ wowo: ajsajasjas
}
}

func TestLoadAcquisitionFromFile(t *testing.T) {
func TestLoadAcquisitionFromFiles(t *testing.T) {
appendMockSource()
t.Setenv("TEST_ENV", "test_value2")

Expand Down Expand Up @@ -293,7 +293,7 @@ func TestLoadAcquisitionFromFile(t *testing.T) {
}
for _, tc := range tests {
t.Run(tc.TestName, func(t *testing.T) {
dss, err := LoadAcquisitionFromFile(&tc.Config, nil)
dss, err := LoadAcquisitionFromFiles(&tc.Config, nil)
cstest.RequireErrorContains(t, err, tc.ExpectedError)

if tc.ExpectedError != "" {
Expand Down