Move Fields from pacakge libbeat/common to libbeat/mapping (#11198)

The structures `Field` and `Fields` are moved from `common` to the package `mapping`. This is a step towards moving things from the abused package `common`. I would like to move fields and other asset related functionality to this package in the future.
elastic · Mar 14, 2019 · e5ac246 · e5ac246
1 parent 5cdc84c
commit e5ac246
Show file tree

Hide file tree

Showing 12 changed files with 280 additions and 271 deletions.
diff --git a/CHANGELOG-developer.next.asciidoc b/CHANGELOG-developer.next.asciidoc
@@ -22,6 +22,7 @@ The list below covers the major changes between 7.0.0-beta1 and master only.
 
 - Remove support for deprecated `GenRootCmd` methods. {pull}10721[10721]
 - Remove SkipNormalization, SkipAgentMetadata, SkipAddHostName. {pull}10801[10801] {pull}10769[10769]
+- Move Fields from package libbeat/common to libbeat/mapping. {pull}11198[11198]
 
 ==== Bugfixes
 

diff --git a/auditbeat/module/auditd/audit_linux_test.go b/auditbeat/module/auditd/audit_linux_test.go
@@ -33,8 +33,8 @@ import (
 	"github.com/prometheus/procfs"
 
 	"github.com/elastic/beats/auditbeat/core"
-	"github.com/elastic/beats/libbeat/common"
 	"github.com/elastic/beats/libbeat/logp"
+	"github.com/elastic/beats/libbeat/mapping"
 	"github.com/elastic/beats/metricbeat/mb"
 	mbtest "github.com/elastic/beats/metricbeat/mb/testing"
 	"github.com/elastic/go-libaudit"
@@ -102,7 +102,7 @@ func TestData(t *testing.T) {
 
 // assertFieldsAreDocumented mimics assert_fields_are_documented in Python system tests.
 func assertFieldsAreDocumented(t *testing.T, events []mb.Event) {
-	fieldsYml, err := common.LoadFieldsYaml("../../fields.yml")
+	fieldsYml, err := mapping.LoadFieldsYaml("../../fields.yml")
 	if err != nil {
 		t.Fatal(err)
 	}

diff --git a/libbeat/idxmgmt/idxmgmt_test.go b/libbeat/idxmgmt/idxmgmt_test.go
@@ -28,6 +28,7 @@ import (
 	"github.com/elastic/beats/libbeat/beat"
 	"github.com/elastic/beats/libbeat/common"
 	"github.com/elastic/beats/libbeat/idxmgmt/ilm"
+	"github.com/elastic/beats/libbeat/mapping"
 	"github.com/elastic/beats/libbeat/template"
 )
 
@@ -96,7 +97,7 @@ func TestDefaultSupport_TemplateConfig(t *testing.T) {
 
 	cloneCfg := func(c template.TemplateConfig) template.TemplateConfig {
 		if c.AppendFields != nil {
-			tmp := make(common.Fields, len(c.AppendFields))
+			tmp := make(mapping.Fields, len(c.AppendFields))
 			copy(tmp, c.AppendFields)
 			c.AppendFields = tmp
 		}

diff --git a/libbeat/kibana/fields_transformer.go b/libbeat/kibana/fields_transformer.go
@@ -22,20 +22,21 @@ import (
 	"fmt"
 
 	"github.com/elastic/beats/libbeat/common"
+	"github.com/elastic/beats/libbeat/mapping"
 )
 
 var v640 = common.MustNewVersion("6.4.0")
 
 type fieldsTransformer struct {
-	fields                    common.Fields
+	fields                    mapping.Fields
 	transformedFields         []common.MapStr
 	transformedFieldFormatMap common.MapStr
 	version                   *common.Version
 	keys                      map[string]int
 	migration                 bool
 }
 
-func newFieldsTransformer(version *common.Version, fields common.Fields, migration bool) (*fieldsTransformer, error) {
+func newFieldsTransformer(version *common.Version, fields mapping.Fields, migration bool) (*fieldsTransformer, error) {
 	if version == nil {
 		return nil, errors.New("Version must be given")
 	}
@@ -64,10 +65,10 @@ func (t *fieldsTransformer) transform() (transformed common.MapStr, err error) {
 	// add some meta fields
 	truthy := true
 	falsy := false
-	t.add(common.Field{Path: "_id", Type: "keyword", Index: &falsy, Analyzed: &falsy, DocValues: &falsy, Searchable: &falsy, Aggregatable: &falsy})
-	t.add(common.Field{Path: "_type", Type: "keyword", Index: &falsy, Analyzed: &falsy, DocValues: &falsy, Searchable: &truthy, Aggregatable: &truthy})
-	t.add(common.Field{Path: "_index", Type: "keyword", Index: &falsy, Analyzed: &falsy, DocValues: &falsy, Searchable: &falsy, Aggregatable: &falsy})
-	t.add(common.Field{Path: "_score", Type: "integer", Index: &falsy, Analyzed: &falsy, DocValues: &falsy, Searchable: &falsy, Aggregatable: &falsy})
+	t.add(mapping.Field{Path: "_id", Type: "keyword", Index: &falsy, Analyzed: &falsy, DocValues: &falsy, Searchable: &falsy, Aggregatable: &falsy})
+	t.add(mapping.Field{Path: "_type", Type: "keyword", Index: &falsy, Analyzed: &falsy, DocValues: &falsy, Searchable: &truthy, Aggregatable: &truthy})
+	t.add(mapping.Field{Path: "_index", Type: "keyword", Index: &falsy, Analyzed: &falsy, DocValues: &falsy, Searchable: &falsy, Aggregatable: &falsy})
+	t.add(mapping.Field{Path: "_score", Type: "integer", Index: &falsy, Analyzed: &falsy, DocValues: &falsy, Searchable: &falsy, Aggregatable: &falsy})
 
 	transformed = common.MapStr{
 		"fields":         t.transformedFields,
@@ -76,7 +77,7 @@ func (t *fieldsTransformer) transform() (transformed common.MapStr, err error) {
 	return
 }
 
-func (t *fieldsTransformer) transformFields(commonFields common.Fields, path string) {
+func (t *fieldsTransformer) transformFields(commonFields mapping.Fields, path string) {
 	for _, f := range commonFields {
 		f.Path = f.Name
 		if path != "" {
@@ -119,7 +120,7 @@ func (t *fieldsTransformer) transformFields(commonFields common.Fields, path str
 	}
 }
 
-func (t *fieldsTransformer) update(target *common.MapStr, override common.Field) error {
+func (t *fieldsTransformer) update(target *common.MapStr, override mapping.Field) error {
 	field, _ := transformField(t.version, override)
 	if override.Type == "" || (*target)["type"] == field["type"] {
 		target.Update(field)
@@ -133,7 +134,7 @@ func (t *fieldsTransformer) update(target *common.MapStr, override common.Field)
 	return fmt.Errorf("field <%s> is duplicated", override.Path)
 }
 
-func (t *fieldsTransformer) add(f common.Field) {
+func (t *fieldsTransformer) add(f mapping.Field) {
 	if idx := t.keys[f.Path]; idx > 0 {
 		target := &t.transformedFields[idx-1] // 1-indexed
 		if err := t.update(target, f); err != nil {
@@ -150,7 +151,7 @@ func (t *fieldsTransformer) add(f common.Field) {
 	}
 }
 
-func transformField(version *common.Version, f common.Field) (common.MapStr, common.MapStr) {
+func transformField(version *common.Version, f mapping.Field) (common.MapStr, common.MapStr) {
 	field := common.MapStr{
 		"name":         f.Path,
 		"count":        f.Count,
@@ -217,7 +218,7 @@ func getVal(valP *bool, def bool) bool {
 	return def
 }
 
-func addParams(format *common.MapStr, version *common.Version, f common.Field) {
+func addParams(format *common.MapStr, version *common.Version, f mapping.Field) {
 	addFormatParam(format, "pattern", f.Pattern)
 	addFormatParam(format, "inputFormat", f.InputFormat)
 	addFormatParam(format, "outputFormat", f.OutputFormat)
@@ -248,7 +249,7 @@ func addFormatParam(f *common.MapStr, key string, val interface{}) {
 }
 
 // takes the highest version where major version <= given version
-func addVersionedFormatParam(f *common.MapStr, version *common.Version, key string, val []common.VersionizedString) {
+func addVersionedFormatParam(f *common.MapStr, version *common.Version, key string, val []mapping.VersionizedString) {
 	if len(val) == 0 {
 		return
 	}