forked from elastic/beats
-
Notifications
You must be signed in to change notification settings - Fork 0
/
magefile.go
154 lines (130 loc) · 4.26 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
154
// 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.
//go:build mage
// +build mage
package main
import (
"fmt"
"os"
"path/filepath"
"github.com/magefile/mage/mg"
"go.uber.org/multierr"
devtools "github.com/elastic/beats/v7/dev-tools/mage"
//mage:import
"github.com/elastic/elastic-agent-libs/dev-tools/mage"
"github.com/elastic/beats/v7/dev-tools/mage/gotool"
)
var (
// BeatsWithDashboards is a list of Beats to collect dashboards from.
BeatsWithDashboards = []string{
"heartbeat",
"packetbeat",
"winlogbeat",
"x-pack/auditbeat",
"x-pack/filebeat",
"x-pack/metricbeat",
}
)
// Aliases are shortcuts to long target names.
// nolint: deadcode // it's used by `mage`.
var Aliases = map[string]interface{}{
"llc": mage.Linter.LastChange,
"lint": mage.Linter.All,
}
// PackageBeatDashboards packages the dashboards from all Beats into a zip
// file. The dashboards must be generated first.
func PackageBeatDashboards() error {
version, err := devtools.BeatQualifiedVersion()
if err != nil {
return err
}
spec := devtools.PackageSpec{
Name: "beats-dashboards",
Version: version,
Snapshot: devtools.Snapshot,
Files: map[string]devtools.PackageFile{
".build_hash.txt": devtools.PackageFile{
Content: "{{ commit }}\n",
},
},
OutputFile: "build/distributions/dashboards/{{.Name}}-{{.Version}}{{if .Snapshot}}-SNAPSHOT{{end}}",
}
for _, beatDir := range BeatsWithDashboards {
// The generated dashboard content is moving in the build dir, but
// not all projects have been updated so detect which dir to use.
dashboardDir := filepath.Join(beatDir, "build/kibana")
legacyDir := filepath.Join(beatDir, "_meta/kibana.generated")
beatName := filepath.Base(beatDir)
if _, err := os.Stat(dashboardDir); err == nil {
spec.Files[beatName] = devtools.PackageFile{Source: dashboardDir}
} else if _, err := os.Stat(legacyDir); err == nil {
spec.Files[beatName] = devtools.PackageFile{Source: legacyDir}
} else {
return fmt.Errorf("no dashboards found for %v", beatDir)
}
}
return devtools.PackageZip(spec.Evaluate())
}
// Fmt formats code and adds license headers.
func Fmt() {
mg.Deps(devtools.GoImports, devtools.PythonAutopep8)
mg.Deps(AddLicenseHeaders)
}
// AddLicenseHeaders adds ASL2 headers to .go files outside of x-pack and
// add Elastic headers to .go files in x-pack.
func AddLicenseHeaders() error {
fmt.Println(">> fmt - go-licenser: Adding missing headers")
mg.Deps(devtools.InstallGoLicenser)
licenser := gotool.Licenser
return multierr.Combine(
licenser(
licenser.License("ASL2"),
licenser.Exclude("x-pack"),
licenser.Exclude("generator/_templates/beat/{beat}"),
licenser.Exclude("generator/_templates/metricbeat/{beat}"),
),
licenser(
licenser.License("Elastic"),
licenser.Path("x-pack"),
),
)
}
// CheckLicenseHeaders checks ASL2 headers in .go files outside of x-pack and
// checks Elastic headers in .go files in x-pack.
func CheckLicenseHeaders() error {
fmt.Println(">> fmt - go-licenser: Checking for missing headers")
mg.Deps(devtools.InstallGoLicenser)
licenser := gotool.Licenser
return multierr.Combine(
licenser(
licenser.Check(),
licenser.License("ASL2"),
licenser.Exclude("x-pack"),
licenser.Exclude("generator/_templates/beat/{beat}"),
licenser.Exclude("generator/_templates/metricbeat/{beat}"),
),
licenser(
licenser.Check(),
licenser.License("Elastic"),
licenser.Path("x-pack"),
),
)
}
// DumpVariables writes the template variables and values to stdout.
func DumpVariables() error {
return devtools.DumpVariables()
}