// 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. // +build mage package main import ( "context" "fmt" "regexp" "time" "github.com/magefile/mage/mg" "github.com/magefile/mage/sh" "github.com/pkg/errors" "github.com/elastic/beats/dev-tools/mage" ) func init() { mage.BeatDescription = "Metricbeat is a lightweight shipper for metrics." } // Build builds the Beat binary. func Build() error { return mage.Build(mage.DefaultBuildArgs()) } // GolangCrossBuild build the Beat binary inside of the golang-builder. // Do not use directly, use crossBuild instead. func GolangCrossBuild() error { return mage.GolangCrossBuild(mage.DefaultGolangCrossBuildArgs()) } // CrossBuildXPack cross-builds the beat with XPack for all target platforms. func CrossBuildXPack() error { return mage.CrossBuildXPack() } // BuildGoDaemon builds the go-daemon binary (use crossBuildGoDaemon). func BuildGoDaemon() error { return mage.BuildGoDaemon() } // CrossBuild cross-builds the beat for all target platforms. func CrossBuild() error { return mage.CrossBuild() } // CrossBuildGoDaemon cross-builds the go-daemon binary using Docker. func CrossBuildGoDaemon() error { return mage.CrossBuildGoDaemon() } // Clean cleans all generated files and build artifacts. func Clean() error { return mage.Clean() } // Package packages the Beat for distribution. // Use SNAPSHOT=true to build snapshots. // Use PLATFORMS to control the target platforms. func Package() { start := time.Now() defer func() { fmt.Println("package ran for", time.Since(start)) }() mage.UseElasticBeatPackaging() customizePackaging() mg.Deps(Update) mg.Deps(CrossBuild, CrossBuildXPack, CrossBuildGoDaemon) mg.SerialDeps(mage.Package, TestPackages) } // TestPackages tests the generated packages (i.e. file modes, owners, groups). func TestPackages() error { return mage.TestPackages(mage.WithModulesD()) } // Update updates the generated files (aka make update). func Update() error { return sh.Run("make", "update") } // Fields generates a fields.yml for the Beat. func Fields() error { return mage.GenerateFieldsYAML("module") } // GoTestUnit executes the Go unit tests. // Use TEST_COVERAGE=true to enable code coverage profiling. // Use RACE_DETECTOR=true to enable the race detector. func GoTestUnit(ctx context.Context) error { return mage.GoTest(ctx, mage.DefaultGoTestUnitArgs()) } // GoTestIntegration executes the Go integration tests. // Use TEST_COVERAGE=true to enable code coverage profiling. // Use RACE_DETECTOR=true to enable the race detector. func GoTestIntegration(ctx context.Context) error { return mage.GoTest(ctx, mage.DefaultGoTestIntegrationArgs()) } // ----------------------------------------------------------------------------- // Customizations specific to Metricbeat. // - Include modules.d directory in packages. // - Disable system/load metricset for Windows. // customizePackaging modifies the package specs to add the modules.d directory. // And for Windows it comments out the system/load metricset because it's // not supported. func customizePackaging() { var ( archiveModulesDir = "modules.d" unixModulesDir = "/etc/{{.BeatName}}/modules.d" modulesDir = mage.PackageFile{ Mode: 0644, Source: "modules.d", Config: true, } windowsModulesDir = mage.PackageFile{ Mode: 0644, Source: "{{.PackageDir}}/modules.d", Config: true, Dep: func(spec mage.PackageSpec) error { if err := mage.Copy("modules.d", spec.MustExpand("{{.PackageDir}}/modules.d")); err != nil { return errors.Wrap(err, "failed to copy modules.d dir") } return mage.FindReplace( spec.MustExpand("{{.PackageDir}}/modules.d/system.yml"), regexp.MustCompile(`- load`), `#- load`) }, } windowsReferenceConfig = mage.PackageFile{ Mode: 0644, Source: "{{.PackageDir}}/metricbeat.reference.yml", Dep: func(spec mage.PackageSpec) error { err := mage.Copy("metricbeat.reference.yml", spec.MustExpand("{{.PackageDir}}/metricbeat.reference.yml")) if err != nil { return errors.Wrap(err, "failed to copy reference config") } return mage.FindReplace( spec.MustExpand("{{.PackageDir}}/metricbeat.reference.yml"), regexp.MustCompile(`- load`), `#- load`) }, } ) for _, args := range mage.Packages { switch args.OS { case "windows": args.Spec.Files[archiveModulesDir] = windowsModulesDir args.Spec.ReplaceFile("{{.BeatName}}.reference.yml", windowsReferenceConfig) default: pkgType := args.Types[0] switch pkgType { case mage.TarGz, mage.Zip: args.Spec.Files[archiveModulesDir] = modulesDir case mage.Deb, mage.RPM, mage.DMG: args.Spec.Files[unixModulesDir] = modulesDir default: panic(errors.Errorf("unhandled package type: %v", pkgType)) } } } }