-
Notifications
You must be signed in to change notification settings - Fork 0
/
magefile.go
153 lines (126 loc) · 4.32 KB
/
magefile.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
// 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 (
"fmt"
"time"
"github.com/magefile/mage/mg"
devtools "github.com/elastic/beats/v7/dev-tools/mage"
"github.com/elastic/beats/v7/dev-tools/mage/target/build"
"github.com/elastic/beats/v7/dev-tools/mage/target/collectors"
"github.com/elastic/beats/v7/dev-tools/mage/target/common"
"github.com/elastic/beats/v7/dev-tools/mage/target/pkg"
"github.com/elastic/beats/v7/dev-tools/mage/target/unittest"
metricbeat "github.com/elastic/beats/v7/metricbeat/scripts/mage"
// mage:import
_ "github.com/elastic/beats/v7/metricbeat/scripts/mage/target/metricset"
)
func init() {
devtools.SetBuildVariableSources(devtools.DefaultBeatBuildVariableSources)
devtools.BeatDescription = "One sentence description of the Beat."
devtools.BeatVendor = "Nabeel Shakeel"
devtools.CrossBuildMountModcache = true
}
// CollectAll generates the docs and the fields.
func CollectAll() {
mg.Deps(collectors.CollectDocs, FieldsDocs)
}
// 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)) }()
devtools.UseCommunityBeatPackaging()
devtools.PackageKibanaDashboardsFromBuildDir()
mg.Deps(Update)
mg.Deps(build.CrossBuild, build.CrossBuildGoDaemon)
mg.SerialDeps(devtools.Package, pkg.PackageTest)
}
// FieldsDocs generates docs/fields.asciidoc containing all fields
// (including x-pack).
func FieldsDocs() error {
inputs := []string{
devtools.OSSBeatDir("module"),
}
output := devtools.CreateDir("build/fields/fields.all.yml")
if err := devtools.GenerateFieldsYAMLTo(output, inputs...); err != nil {
return err
}
return devtools.Docs.FieldDocs(output)
}
// Fields generates a fields.yml for the Beat.
func Fields() error {
return devtools.GenerateFieldsYAML("module")
}
// Config generates both the short/reference/docker configs.
func Config() {
mg.Deps(configYML, metricbeat.GenerateDirModulesD)
}
func configYML() error {
p := devtools.DefaultConfigFileParams()
p.Templates = append(p.Templates, "_meta/config/*.tmpl")
return devtools.Config(devtools.AllConfigTypes, p, ".")
}
// 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 is an alias for running fields, dashboards, config.
func Update() {
mg.SerialDeps(Fields, Dashboards, Config, Imports)
}
// Dashboards collects all the dashboards and generates index patterns.
func Dashboards() error {
return devtools.KibanaDashboards("module")
}
// Imports generates an include/list.go file containing
// a import statement for each module and dataset.
func Imports() error {
return devtools.GenerateModuleIncludeListGo()
}
// 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()
}
// BuildGoDaemon builds the go-daemon binary (use crossBuildGoDaemon).
func BuildGoDaemon() error {
return build.BuildGoDaemon()
}
// GolangCrossBuild build the Beat binary inside of the golang-builder.
// Do not use directly, use crossBuild instead.
func GolangCrossBuild() error {
return build.GolangCrossBuild()
}