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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
|
// Copyright 2023 The Bazel Authors. All rights reserved.
//
// Licensed 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.
/*
generate.go is a program that generates the Gazelle YAML manifest.
The Gazelle manifest is a file that contains extra information required when
generating the Bazel BUILD files.
*/
package main
import (
"encoding/json"
"flag"
"fmt"
"log"
"os"
"strings"
"github.com/bazelbuild/rules_python/gazelle/manifest"
)
func init() {
if os.Getenv("BUILD_WORKSPACE_DIRECTORY") == "" {
log.Fatalln("ERROR: this program must run under Bazel")
}
}
func main() {
var (
manifestGeneratorHashPath string
requirementsPath string
pipRepositoryName string
usePipRepositoryAliases bool
modulesMappingPath string
outputPath string
updateTarget string
)
flag.StringVar(
&manifestGeneratorHashPath,
"manifest-generator-hash",
"",
"The file containing the hash for the source code of the manifest generator."+
"This is important to force manifest updates when the generator logic changes.")
flag.StringVar(
&requirementsPath,
"requirements",
"",
"The requirements.txt file.")
flag.StringVar(
&pipRepositoryName,
"pip-repository-name",
"",
"The name of the pip_install or pip_repository target.")
flag.BoolVar(
&usePipRepositoryAliases,
"use-pip-repository-aliases",
false,
"Whether to use the pip-repository aliases, which are generated when passing 'incompatible_generate_aliases = True'.")
flag.StringVar(
&modulesMappingPath,
"modules-mapping",
"",
"The modules_mapping.json file.")
flag.StringVar(
&outputPath,
"output",
"",
"The output YAML manifest file.")
flag.StringVar(
&updateTarget,
"update-target",
"",
"The Bazel target to update the YAML manifest file.")
flag.Parse()
if requirementsPath == "" {
log.Fatalln("ERROR: --requirements must be set")
}
if modulesMappingPath == "" {
log.Fatalln("ERROR: --modules-mapping must be set")
}
if outputPath == "" {
log.Fatalln("ERROR: --output must be set")
}
if updateTarget == "" {
log.Fatalln("ERROR: --update-target must be set")
}
modulesMapping, err := unmarshalJSON(modulesMappingPath)
if err != nil {
log.Fatalf("ERROR: %v\n", err)
}
header := generateHeader(updateTarget)
manifestFile := manifest.NewFile(&manifest.Manifest{
ModulesMapping: modulesMapping,
PipRepository: &manifest.PipRepository{
Name: pipRepositoryName,
UsePipRepositoryAliases: usePipRepositoryAliases,
},
})
if err := writeOutput(
outputPath,
header,
manifestFile,
manifestGeneratorHashPath,
requirementsPath,
); err != nil {
log.Fatalf("ERROR: %v\n", err)
}
}
// unmarshalJSON returns the parsed mapping from the given JSON file path.
func unmarshalJSON(jsonPath string) (map[string]string, error) {
file, err := os.Open(jsonPath)
if err != nil {
return nil, fmt.Errorf("failed to unmarshal JSON file: %w", err)
}
defer file.Close()
decoder := json.NewDecoder(file)
output := make(map[string]string)
if err := decoder.Decode(&output); err != nil {
return nil, fmt.Errorf("failed to unmarshal JSON file: %w", err)
}
return output, nil
}
// generateHeader generates the YAML header human-readable comment.
func generateHeader(updateTarget string) string {
var header strings.Builder
header.WriteString("# GENERATED FILE - DO NOT EDIT!\n")
header.WriteString("#\n")
header.WriteString("# To update this file, run:\n")
header.WriteString(fmt.Sprintf("# bazel run %s\n", updateTarget))
return header.String()
}
// writeOutput writes to the final file the header and manifest structure.
func writeOutput(
outputPath string,
header string,
manifestFile *manifest.File,
manifestGeneratorHashPath string,
requirementsPath string,
) error {
stat, err := os.Stat(outputPath)
if err != nil {
return fmt.Errorf("failed to write output: %w", err)
}
outputFile, err := os.OpenFile(outputPath, os.O_WRONLY|os.O_TRUNC, stat.Mode())
if err != nil {
return fmt.Errorf("failed to write output: %w", err)
}
defer outputFile.Close()
if _, err := fmt.Fprintf(outputFile, "%s\n", header); err != nil {
return fmt.Errorf("failed to write output: %w", err)
}
manifestGeneratorHash, err := os.Open(manifestGeneratorHashPath)
if err != nil {
return fmt.Errorf("failed to write output: %w", err)
}
defer manifestGeneratorHash.Close()
requirements, err := os.Open(requirementsPath)
if err != nil {
return fmt.Errorf("failed to write output: %w", err)
}
defer requirements.Close()
if err := manifestFile.Encode(outputFile, manifestGeneratorHash, requirements); err != nil {
return fmt.Errorf("failed to write output: %w", err)
}
return nil
}
|
