Repository navigation
Expand file tree
/
Copy pathMakefile
More file actions
355 lines (287 loc) · 14 KB
/
Copy pathMakefile
File metadata and controls
355 lines (287 loc) · 14 KB
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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
PROJECT_NAME := Pulumi SDK
SDKS ?= nodejs python go pcl
SUB_PROJECTS := $(SDKS:%=sdk/%)
include build/common.mk
PROJECT := github.com/pulumi/pulumi/pkg/v3/cmd/pulumi
# Ensure bin directory exists before targets are evaluated
# to avoid issues like realpath failing on macOS if the directory doesn't exist.
_ := $(shell mkdir -p bin)
_ := $(shell cd pkg && go build -o ../bin/helpmakego github.com/iwahbe/helpmakego)
PKG_CODEGEN := github.com/pulumi/pulumi/pkg/v3/codegen
PROJECT_PKGS = $(shell cd ./pkg && go list ./... | grep -v -E '^${PKG_CODEGEN}/(go|nodejs|python)')
LANGUAGE_CONFORMANCE_PKG := github.com/pulumi/pulumi/pkg/v3/testing/pulumi-test-language
TEST_FAST_PKGS = $(filter-out ${LANGUAGE_CONFORMANCE_PKG},${PROJECT_PKGS})
INTEGRATION_PKG := github.com/pulumi/pulumi/tests/integration
PERFORMANCE_PKG := github.com/pulumi/pulumi/tests/performance
TESTS_PKGS = $(shell cd ./tests && go list -tags all ./... | grep -v tests/templates | grep -v ^${INTEGRATION_PKG}$ | grep -v ^${PERFORMANCE_PKG}$)
VERSION = $(if ${PULUMI_VERSION},${PULUMI_VERSION},$(shell ./scripts/pulumi-version.sh))
# Relative paths to directories with go.mod files that should be linted.
LINT_GOLANG_PKGS := sdk pkg tests sdk/go/pulumi-language-go sdk/nodejs/cmd/pulumi-language-nodejs sdk/nodejs/cmd/pulumi-language-bun sdk/python/cmd/pulumi-language-python sdk/pcl
# Additional arguments to pass to golangci-lint.
GOLANGCI_LINT_ARGS ?=
PULUMI_DISABLE_AUTOMATIC_PLUGIN_ACQUISITION ?= true
export PULUMI_DISABLE_AUTOMATIC_PLUGIN_ACQUISITION
ifeq ($(DEBUG),"true")
$(info SHELL = ${SHELL})
$(info VERSION = ${VERSION})
endif
# Motivation: running `make TEST_ALL_DEPS= test_all` permits running
# `test_all` without the dependencies.
TEST_ALL_DEPS ?= build $(SUB_PROJECTS:%=%_install)
# The number of Rapid checks to perform when fuzzing lifecycle tests. See the documentation on Rapid at
# https://pkg.go.dev/pgregory.net/rapid#section-readme or the lifecycle test documentation under
# pkg/engine/lifecycletest for more information.
LIFECYCLE_TEST_FUZZ_CHECKS ?= 10000
ensure: .make/ensure/go .make/ensure/phony $(SUB_PROJECTS:%=%_ensure)
.make/ensure/phony: sdk/go.mod pkg/go.mod tests/go.mod
cd sdk && ../scripts/retry go mod download
cd pkg && ../scripts/retry go mod download
cd tests && ../scripts/retry go mod download
@mkdir -p .make/ensure && touch .make/ensure/phony
.PHONY: build-proto build_proto
PROTO_SOURCES := $(sort $(shell find proto -name '*.proto')) proto/generate.sh
build-proto: build_proto
build_proto: .make/proto
.make/proto: $(PROTO_SOURCES)
cd proto && ./generate.sh
@mkdir -p .make && touch $@
.PHONY: check-proto check_proto
check-proto: check_proto
check_proto: .make/proto
@if ! git diff --quiet -- sdk/proto/go sdk/nodejs/proto \
sdk/python/lib/pulumi/runtime/proto proto/grpc_version.txt; then \
echo "Proto output is out of date. Run 'make build_proto' and commit."; \
git diff -- sdk/proto/go sdk/nodejs/proto \
sdk/python/lib/pulumi/runtime/proto proto/grpc_version.txt; \
exit 1; \
fi
.PHONY: generate
generate::
$(call STEP_MESSAGE)
echo "This command does not do anything anymore. It will be removed in a future version."
.PHONY: generate-cli-spec
generate-cli-spec::
go run -C pkg ./cmd/pulumi generate-cli-spec --overrides ../tools/automation/automation-overrides.json > tools/automation/specification.json
.PHONY: generate-nodejs-automation-api
generate-nodejs-automation-api:: generate-cli-spec
cd sdk/nodejs/tools/automation && npm ci && npm start ../../../../tools/automation/specification.json boilerplate/standard.ts ../../automation/interface
.PHONY: test-nodejs-automation-api
test-nodejs-automation-api:: generate-cli-spec
cd sdk/nodejs/tools/automation && npm ci && npm start ../../../../tools/automation/specification.json boilerplate/testing.ts && npm run build && npm test
.PHONY: generate-python-automation-api
generate-python-automation-api:: generate-cli-spec
cd sdk/python/tools/automation && pip install -q -r requirements.txt && python main.py ../../../../tools/automation/specification.json boilerplate/standard.py ../../lib/pulumi/automation/interface
cd sdk/python && uv run --frozen -m ruff format lib/pulumi/automation/interface
.PHONY: test-python-automation-api
test-python-automation-api::
cd sdk/python/tools/automation && pip install -q -r requirements.txt && python -m unittest tests.test_commands -v
.PHONY: generate-go-automation-api
generate-go-automation-api:: generate-cli-spec
go run -C sdk ./go/tools/automation \
../tools/automation/specification.json \
boilerplate/standard \
go/auto/automation \
github.com/pulumi/pulumi/sdk/v3/go/auto/automation
.PHONY: test-go-automation-api
test-go-automation-api::
cd sdk && go test ./go/tools/automation/...
.PHONY: generate-automation-apis
generate-automation-apis:: generate-nodejs-automation-api generate-python-automation-api generate-go-automation-api
# For the `pulumi` CLI, building grpc with grpcnotrace has no effect since there other imports that end up disabling
# dead code elimation due to the usage of certain reflection methods.
bin/pulumi: GO_BUILD_TAGS =
bin/pulumi: .make/proto .make/ensure/go $(shell bin/helpmakego pkg/cmd/pulumi)
go build -C pkg -o ../$@ -tags="${GO_BUILD_TAGS}" -ldflags "-X github.com/pulumi/pulumi/sdk/v3/go/common/version.Version=${VERSION}" ${PROJECT}
.PHONY: bin/pulumi-display.wasm
bin/pulumi-display.wasm:: .make/ensure/go .make/ensure/phony pkg/backend/display/wasm/gold-size.txt
cd pkg && GOOS=js GOARCH=wasm go build -o ../bin/pulumi-display.wasm -tags="${GO_BUILD_TAGS}" -ldflags "-w -s -X github.com/pulumi/pulumi/sdk/v3/go/common/version.Version=${VERSION}" -trimpath ./backend/display/wasm
python3 scripts/wasm-size-check.py bin/pulumi-display.wasm pkg/backend/display/wasm/gold-size.txt
.PHONY: build
build:: export GOBIN=$(shell realpath ./bin)
build:: build_proto .make/ensure/go bin/pulumi bin/pulumi-display.wasm
install:: bin/pulumi
cp $< $(PULUMI_BIN)/pulumi
build_debug::
cd pkg && go install -gcflags="all=-N -l" -ldflags "-X github.com/pulumi/pulumi/sdk/v3/go/common/version.Version=${VERSION}" ${PROJECT}
build_cover::
cd pkg && go build -cover -o ../bin/pulumi \
-tags="${GO_BUILD_TAGS}" \
-coverpkg github.com/pulumi/pulumi/pkg/v3/...,github.com/pulumi/pulumi/sdk/v3/... \
-ldflags "-X github.com/pulumi/pulumi/sdk/v3/go/common/version.Version=${VERSION}" ${PROJECT}
install_cover:: build_cover
cp bin/pulumi $(PULUMI_BIN)
dist::
cd pkg && go install -tags="${GO_BUILD_TAGS}" -ldflags "-X github.com/pulumi/pulumi/sdk/v3/go/common/version.Version=${VERSION}" ${PROJECT}
.PHONY: brew
# NOTE: the brew target intentionally avoids the dependency on `build`, as each language SDK has its own brew target
brew::
./scripts/brew.sh "${PROJECT}"
.PHONY: lint_%
lint:: .make/ensure/golangci-lint lint_golang lint_pulumi_json lint_changelog
lint_changelog::
@if [ -n "$$(find changelog/pending -maxdepth 1 -name '*.yaml' -print -quit)" ]; then \
changie batch auto --dry-run; \
else \
echo "No pending changelog entries; skipping changie batch."; \
fi
lint_changelog_style::
vale changelog/pending
lint_pulumi_json::
# NOTE: github.com/santhosh-tekuri/jsonschema uses Go's regexp engine, but
# JSON schema says regexps should conform to ECMA 262.
go run github.com/santhosh-tekuri/jsonschema/cmd/jv@v0.7.0 pkg/codegen/schema/pulumi.json
# We only want to run `make ensure` in sdk/nodejs to install biome. We can't depend
# on the `ensure` target here because that installs extra dependencies, that we don't
# need here, and don't necessarily have installed in CI.
cd sdk/nodejs && make ensure
cd sdk/nodejs && npx biome format ../../pkg/codegen/schema/pulumi.json
lint_pulumi_json_fix::
# We only want to run `make ensure` in sdk/nodejs to install biome. We can't depend
# on the `ensure` target here because that installs extra dependencies, that we don't
# need here, and don't necessarily have installed in CI.
cd sdk/nodejs && make ensure
cd sdk/nodejs && npx biome format --write ../../pkg/codegen/schema/pulumi.json
lint_fix:: lint_golang_fix lint_pulumi_json_fix
# bin/custom-gcl is a golangci-lint binary with the requiredfield and noosexit
# linters baked in as module plugins. Built from .custom-gcl.yml and the
# wrappers under .golangci/plugins/.
#
# It also depends on .make/go-version: golangci-lint's analysis loader rejects
# source files that require a newer Go version than the linter binary itself,
# so the binary must be rebuilt when the toolchain changes.
CUSTOM_GCL := bin/custom-gcl
CUSTOM_GCL_DEPS := .custom-gcl.yml \
.make/go-version \
.golangci/plugins/requiredfield/go.mod \
.golangci/plugins/requiredfield/go.sum \
.golangci/plugins/requiredfield/plugin.go \
.golangci/plugins/noosexit/go.mod \
.golangci/plugins/noosexit/go.sum \
.golangci/plugins/noosexit/plugin.go
$(CUSTOM_GCL): $(CUSTOM_GCL_DEPS) .make/ensure/golangci-lint
golangci-lint custom
# .make/go-version records `go version` output; the recipe only rewrites the
# file when the output changes, so dependents rebuild on toolchain upgrades
# without being touched on every make invocation.
.PHONY: .check-go-version
.make/go-version: .check-go-version
@mkdir -p $(dir $@)
@version=$$(go version); \
if [ "$$version" != "$$(cat $@ 2>/dev/null)" ]; then \
echo "$$version" > $@; \
fi
define lint_golang_pkg
@echo "[golangci-lint] Linting $(1)..."
@(cd $(1) && $(abspath $(CUSTOM_GCL)) run $(GOLANGCI_LINT_ARGS) \
--config $(GOLANGCI_LINT_CONFIG) \
--max-same-issues 0 \
--max-issues-per-linter 0 \
--timeout 5m)
endef
.PHONY: lint_golang lint_golang_fix
lint_golang: GOLANGCI_LINT_CONFIG=$(shell pwd)/.golangci.yml
lint_golang: $(CUSTOM_GCL)
$(foreach pkg,$(LINT_GOLANG_PKGS),$(call lint_golang_pkg,${pkg}))
lint_golang_fix: GOLANGCI_LINT_ARGS=--fix
lint_golang_fix: lint_golang
lint_actions:
go run github.com/rhysd/actionlint/cmd/actionlint@v1.6.27 \
-format '{{range $$err := .}}### Error at line {{$$err.Line}}, col {{$$err.Column}} of `{{$$err.Filepath}}`\n\n{{$$err.Message}}\n\n```\n{{$$err.Snippet}}\n```\n\n{{end}}'
format:: ensure
cd sdk/nodejs && npx biome format --write ../../pkg/codegen/schema/pulumi.json
test_fast:: get_schemas
@cd pkg && $(GO_TEST_FAST) ${TEST_FAST_PKGS}
test_all:: test_pkg test_integration
test_lifecycle:
@cd pkg && $(GO_TEST) github.com/pulumi/pulumi/pkg/v3/engine/lifecycletest
test_lifecycle_fuzz: GO_TEST_RACE = false
test_lifecycle_fuzz: export PULUMI_LIFECYCLE_TEST_FUZZ := 1
test_lifecycle_fuzz:
@cd pkg && go test github.com/pulumi/pulumi/pkg/v3/engine/lifecycletest \
-run '^TestFuzz$$' \
-tags all \
-timeout 0 \
-rapid.checks=$(LIFECYCLE_TEST_FUZZ_CHECKS)
test_lifecycle_fuzz_from_state_file: GO_TEST_RACE = false
test_lifecycle_fuzz_from_state_file:
@cd pkg && go test github.com/pulumi/pulumi/pkg/v3/engine/lifecycletest \
-run '^TestFuzzFromStateFile$$' \
-tags all \
-rapid.checks=$(LIFECYCLE_TEST_FUZZ_CHECKS)
lang=$(subst test_codegen_,,$(word 1,$(subst !, ,$@)))
test_codegen_%: get_schemas
@cd pkg && $(GO_TEST) ${PKG_CODEGEN}/${lang}/...
test_pkg_rest: get_schemas
@cd pkg && $(GO_TEST) ${PROJECT_PKGS}
test_pkg:: test_pkg_rest test_codegen_go test_codegen_nodejs test_codegen_python
subset=$(subst test_integration_,,$(word 1,$(subst !, ,$@)))
test_integration_%:
@cd tests && PULUMI_INTEGRATION_TESTS=$(subset) $(GO_TEST) $(INTEGRATION_PKG)
test_integration_subpkgs:
@cd tests && $(GO_TEST) $(TESTS_PKGS)
test_integration:: $(SDKS:%=test_integration_%) test_integration_rest test_integration_subpkgs
test_performance:
@cd tests && go test -count=1 -tags=all -timeout 1h -parallel=1 -v $(PERFORMANCE_PKG)
# Used by CI to run tests in parallel across the Go modules pkg, sdk, and tests.
.PHONY: gotestsum/%
gotestsum/%:
cd $* && $(PYTHON) '$(CURDIR)/scripts/go-test.py' $(GO_TEST_FLAGS) $${OPTS} $${PKGS}
tidy::
./scripts/tidy.sh --check
tidy_fix::
./scripts/tidy.sh
renovate: tidy_fix
./scripts/renovate-changelog.py
validate_codecov_yaml::
curl --data-binary @codecov.yml https://codecov.io/validate
# We replace the '!' with a space, then take the first word
# schema-pkg!x.y.z => schema-pkg
# We then replace 'schema-' with nothing, giving only the package name.
# schema-pkg => pkg
# Recall that `$@` is the target make is trying to build, in our case schema-pkg!x.y.z
name=$(subst schema-,,$(word 1,$(subst !, ,$@)))
# Here we take the second word, just the version
version=$(word 2,$(subst !, ,$@))
schema-%: .make/ensure/curl .make/ensure/jq
@echo "Ensuring schema ${name}, ${version}"
@# Download the package from github, then stamp in the correct version.
@[ -f pkg/codegen/testing/utils/schemas/${name}-${version}.json ] || \
curl "https://raw.githubusercontent.com/pulumi/pulumi-${name}/v${version}/provider/cmd/pulumi-resource-${name}/schema.json" \
| jq '.version = "${version}"' > pkg/codegen/testing/utils/schemas/${name}-${version}.json
@# Confirm that the correct version is present. If not, error out.
@FOUND="$$(jq -r '.version' pkg/codegen/testing/utils/schemas/${name}-${version}.json)" && \
if ! [ "$$FOUND" = "${version}" ]; then \
echo "${name} required version ${version} but found existing version $$FOUND"; \
exit 1; \
fi
# Related files:
#
# pkg/codegen/testing/utils/host.go depends on this list, update that file on changes.
#
# pkg/codegen/testing/test/helpers.go depends on some of this list, update that file on changes.
#
# pkg/codegen/schema/schema_test.go depends on random@4.11.2, update that file on changes.
#
# As a courtesy to reviewers, please make changes to this list and the committed schema files in a
# separate commit from other changes, as online code review tools may balk at rendering these diffs.
get_schemas: \
schema-random!4.11.2 \
schema-tls!4.10.0
.PHONY: changelog
changelog:
changie new
clean::
rm -rf bin/*
rm -rf .make
.PHONY: work
work:
rm -f go.work go.work.sum
go work init \
pkg \
sdk \
sdk/go/pulumi-language-go \
sdk/nodejs/cmd/pulumi-language-nodejs \
sdk/nodejs/cmd/pulumi-language-bun \
sdk/python/cmd/pulumi-language-python \
sdk/pcl \
tests