Movelibbeat/opt and libbeat/common/transform packages (#33)

Author: kvch

api/npipe/listener_windows_test.go

@@ -44,8 +44,7 @@ func TestHTTPOverNamedPipe(t *testing.T) {
 	})
 
 	go func() {
-		err := http.Serve(l, mux)
-		require.NoError(t, err)
+		_ = http.Serve(l, mux)
 	}()
 
 	c := http.Client{

go.mod

@@ -4,6 +4,7 @@ go 1.17
 
 require (
 	github.com/Microsoft/go-winio v0.5.2
+	github.com/elastic/go-structform v0.0.9
 	github.com/elastic/go-ucfg v0.8.4
 	github.com/fatih/color v1.13.0
 	github.com/hashicorp/go-multierror v1.1.1

go.sum

@@ -98,6 +98,8 @@ github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/elastic/go-licenser v0.3.1 h1:RmRukU/JUmts+rpexAw0Fvt2ly7VVu6mw8z4HrEzObU=
 github.com/elastic/go-licenser v0.3.1/go.mod h1:D8eNQk70FOCVBl3smCGQt/lv7meBeQno2eI1S5apiHQ=
+github.com/elastic/go-structform v0.0.9 h1:HpcS7xljL4kSyUfDJ8cXTJC6rU5ChL1wYb6cx3HLD+o=
+github.com/elastic/go-structform v0.0.9/go.mod h1:CZWf9aIRYY5SuKSmOhtXScE5uQiLZNqAFnwKR4OrIM4=
 github.com/elastic/go-sysinfo v1.1.1 h1:ZVlaLDyhVkDfjwPGU55CQRCRolNpc7P0BbyhhQZQmMI=
 github.com/elastic/go-sysinfo v1.1.1/go.mod h1:i1ZYdU10oLNfRzq4vq62BEwD2fH8KaWh6eh0ikPT9F0=
 github.com/elastic/go-ucfg v0.8.4 h1:OAHTnubzXKsYYYWVzl8psLcS5mCbNKjXxtMY41itthk=

opt/format_types.go

@@ -0,0 +1,58 @@
+// Licensed to Elasticsearch B.V. under one or more contributor
+// license agreements. See the NOTICE file distributed with
+// this work for additional information regarding copyright
+// ownership. Elasticsearch B.V. licenses this file to you under
+// the Apache License, Version 2.0 (the "License"); you may
+// not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+package opt
+
+// The types here work as wrappers for the sake of go-structform
+// Due to structform's streaming type, we can't declare nested types
+// inside of struct tag directives, so in the numerous cases where we have
+// fields like thing.bytes, thing.pct, etc, use these wrappers to keep it somewhat clean
+
+// BytesOpt wraps a uint64 byte value in an option type
+type BytesOpt struct {
+	Bytes Uint `json:"bytes" struct:"bytes"`
+}
+
+// IsZero returns true if the underlying value nil
+func (opt BytesOpt) IsZero() bool {
+	return opt.Bytes.IsZero()
+}
+
+// Bytes wraps a uint64 byte value
+type Bytes struct {
+	Bytes uint64 `json:"bytes" struct:"bytes"`
+}
+
+// Us wraps a uint64 microseconds value
+type Us struct {
+	Us uint64 `json:"us" struct:"us"`
+}
+
+// Pct wraps a float64 percent value
+type Pct struct {
+	Pct float64 `json:"pct" struct:"pct"`
+}
+
+// PctOpt wraps a float64 percent value in an option type
+type PctOpt struct {
+	Pct Float `json:"pct" struct:"pct"`
+}
+
+// IsZero returns true if the underlying value nil
+func (opt PctOpt) IsZero() bool {
+	return opt.Pct.IsZero()
+}

opt/opt.go

@@ -0,0 +1,202 @@
+// Licensed to Elasticsearch B.V. under one or more contributor
+// license agreements. See the NOTICE file distributed with
+// this work for additional information regarding copyright
+// ownership. Elasticsearch B.V. licenses this file to you under
+// the Apache License, Version 2.0 (the "License"); you may
+// not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+package opt
+
+import "github.com/elastic/go-structform"
+
+// ZeroInterface is a type interface for cases where we need to cast from a void pointer
+type ZeroInterface interface {
+	IsZero() bool
+}
+
+// Int
+
+// Int is a wrapper for "optional" types, with the bool value indicating
+// if the stored int is a legitimate value.
+type Int struct {
+	exists bool
+	value  int
+}
+
+// NewUintNone returns a new OptUint wrapper
+func NewIntNone() Int {
+	return Int{
+		exists: false,
+		value:  0,
+	}
+}
+
+// UintWith returns a new OptUint wrapper with a given int
+func IntWith(i int) Int {
+	return Int{
+		exists: true,
+		value:  i,
+	}
+}
+
+// IsZero returns true if the underlying value nil
+func (opt Int) IsZero() bool {
+	return !opt.exists
+}
+
+// Exists returns true if the underlying value exists
+func (opt Int) Exists() bool {
+	return opt.exists
+}
+
+// ValueOr returns the stored value, or a given int
+// Please do not use this for populating reported data,
+// as we actually want to avoid sending zeros where values are functionally null
+func (opt Int) ValueOr(i int) int {
+	if opt.exists {
+		return opt.value
+	}
+	return i
+}
+
+// Fold implements the folder interface for OptUint
+func (opt *Int) Fold(v structform.ExtVisitor) error {
+	if opt.exists {
+		value := opt.value
+		_ = v.OnInt(value)
+	} else {
+		_ = v.OnNil()
+	}
+	return nil
+}
+
+// Uint
+
+// Uint is a wrapper for "optional" types, with the bool value indicating
+// if the stored int is a legitimate value.
+type Uint struct {
+	exists bool
+	value  uint64
+}
+
+// NewUintNone returns a new OptUint wrapper
+func NewUintNone() Uint {
+	return Uint{
+		exists: false,
+		value:  0,
+	}
+}
+
+// UintWith returns a new OptUint wrapper with a given int
+func UintWith(i uint64) Uint {
+	return Uint{
+		exists: true,
+		value:  i,
+	}
+}
+
+// IsZero returns true if the underlying value nil
+func (opt Uint) IsZero() bool {
+	return !opt.exists
+}
+
+// Exists returns true if the underlying value exists
+func (opt Uint) Exists() bool {
+	return opt.exists
+}
+
+// ValueOr returns the stored value, or a given int
+// Please do not use this for populating reported data,
+// as we actually want to avoid sending zeros where values are functionally null
+func (opt Uint) ValueOr(i uint64) uint64 {
+	if opt.exists {
+		return opt.value
+	}
+	return i
+}
+
+// SumOptUint sums a list of OptUint values
+func SumOptUint(opts ...Uint) uint64 {
+	var sum uint64
+	for _, opt := range opts {
+		sum += opt.ValueOr(0)
+	}
+	return sum
+}
+
+// Fold implements the folder interface for OptUint
+func (opt *Uint) Fold(v structform.ExtVisitor) error {
+	if opt.exists {
+		value := opt.value
+		_ = v.OnUint64(value)
+	} else {
+		_ = v.OnNil()
+	}
+	return nil
+}
+
+// Float
+
+// Float is a wrapper for "optional" types, with the bool value indicating
+// if the stored int is a legitimate value.
+type Float struct {
+	exists bool
+	value  float64
+}
+
+// NewFloatNone returns a new uint wrapper
+func NewFloatNone() Float {
+	return Float{
+		exists: false,
+		value:  0,
+	}
+}
+
+// FloatWith returns a new uint wrapper for the specified value
+func FloatWith(f float64) Float {
+	return Float{
+		exists: true,
+		value:  f,
+	}
+}
+
+// IsZero returns true if the underlying value nil
+func (opt Float) IsZero() bool {
+	return !opt.exists
+}
+
+// Exists returns true if the underlying value exists
+func (opt Float) Exists() bool {
+	return opt.exists
+}
+
+// ValueOr returns the stored value, or zero
+// Please do not use this for populating reported data,
+// as we actually want to avoid sending zeros where values are functionally null
+func (opt Float) ValueOr(f float64) float64 {
+	if opt.exists {
+		return opt.value
+	}
+	return f
+}
+
+// Fold implements the folder interface for OptUint
+func (opt *Float) Fold(v structform.ExtVisitor) error {
+	if opt.exists {
+		value := opt.value
+		_ = v.OnFloat64(value)
+	} else {
+		_ = v.OnNil()
+	}
+	return nil
+}