Skip to content
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

Stop using mage:import in custom beats #14162

Merged
merged 3 commits into from
Oct 22, 2019
Merged
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: 2 additions & 0 deletions CHANGELOG-developer.next.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ The list below covers the major changes between 7.0.0-rc2 and master only.

==== Bugfixes

- Stop using `mage:import` in community beats. This was ignoring the vendorized beats directory for some mage targets, using the code available in GOPATH, this causes inconsistencies and compilation problems if the version of the code in the GOPATH is different to the vendored one. Use of `mage:import` will continue to be unsupported in custom beats till beats is migrated to go modules, or mage supports vendored dependencies. {issue}13998[13998] {pull}14162[14162]

==== Added

- Metricset generator generates beta modules by default now. {pull}10657[10657]
Expand Down
48 changes: 35 additions & 13 deletions generator/beat/{beat}/magefile.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,20 +10,11 @@ import (
"github.com/magefile/mage/sh"

devtools "github.com/elastic/beats/dev-tools/mage"
"github.com/elastic/beats/generator/common/beatgen"

// mage:import
"github.com/elastic/beats/dev-tools/mage/target/pkg"
// mage:import
"github.com/elastic/beats/dev-tools/mage/target/build"
// mage:import
_ "github.com/elastic/beats/dev-tools/mage/target/common"
// mage:import
_ "github.com/elastic/beats/dev-tools/mage/target/test"
// mage:import
_ "github.com/elastic/beats/dev-tools/mage/target/unittest"
// mage:import
_ "github.com/elastic/beats/dev-tools/mage/target/integtest"
"github.com/elastic/beats/dev-tools/mage/target/common"
"github.com/elastic/beats/dev-tools/mage/target/pkg"
"github.com/elastic/beats/dev-tools/mage/target/unittest"
"github.com/elastic/beats/generator/common/beatgen"
)

func init() {
Expand Down Expand Up @@ -66,3 +57,34 @@ func Fields() error {
func Config() error {
return devtools.Config(devtools.AllConfigTypes, devtools.ConfigFileParams{}, ".")
}

// Clean cleans all generated files and build artifacts.
func Clean() error {
return devtools.Clean()
}

// Check formats code, updates generated content, check for common errors, and
// checks for any modified files.
func Check() {
common.Check()
}

// Fmt formats source code (.go and .py) and adds license headers.
func Fmt() {
common.Fmt()
}

// Test runs all available tests
func Test() {
mg.Deps(unittest.GoUnitTest)
}

// Build builds the Beat binary.
func Build() error {
return build.Build()
}

// CrossBuild cross-builds the beat for all target platforms.
func CrossBuild() error {
return build.CrossBuild()
}
57 changes: 41 additions & 16 deletions generator/metricbeat/{beat}/magefile.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,25 +9,14 @@ import (
"github.com/magefile/mage/mg"

devtools "github.com/elastic/beats/dev-tools/mage"
"github.com/elastic/beats/generator/common/beatgen"
metricbeat "github.com/elastic/beats/metricbeat/scripts/mage"

// mage:import
_ "github.com/elastic/beats/dev-tools/mage/target/common"
// mage:import
"github.com/elastic/beats/dev-tools/mage/target/build"
// mage:import
"github.com/elastic/beats/dev-tools/mage/target/pkg"
// mage:import
_ "github.com/elastic/beats/dev-tools/mage/target/test"
// mage:import
_ "github.com/elastic/beats/dev-tools/mage/target/unittest"
// mage:import
_ "github.com/elastic/beats/dev-tools/mage/target/integtest"
// mage:import
"github.com/elastic/beats/dev-tools/mage/target/collectors"
// mage:import
"github.com/elastic/beats/dev-tools/mage/target/common"
"github.com/elastic/beats/dev-tools/mage/target/pkg"
"github.com/elastic/beats/dev-tools/mage/target/unittest"
"github.com/elastic/beats/dev-tools/mage/target/update"
"github.com/elastic/beats/generator/common/beatgen"
metricbeat "github.com/elastic/beats/metricbeat/scripts/mage"
)

func init() {
Expand Down Expand Up @@ -93,3 +82,39 @@ func configYML() error {
}
return devtools.Config(devtools.AllConfigTypes, customDeps, ".")
}

// Clean cleans all generated files and build artifacts.
func Clean() error {
return devtools.Clean()
}

// Check formats code, updates generated content, check for common errors, and
// checks for any modified files.
func Check() {
common.Check()
}

// Fmt formats source code (.go and .py) and adds license headers.
func Fmt() {
common.Fmt()
}

// Update updates the generated files (aka make update).
func Update() error {
return update.Update()
}

// Test runs all available tests
func Test() {
mg.Deps(unittest.GoUnitTest)
}

// Build builds the Beat binary.
func Build() error {
return build.Build()
}

// CrossBuild cross-builds the beat for all target platforms.
func CrossBuild() error {
return build.CrossBuild()
}