-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathcommon.mk
More file actions
268 lines (252 loc) · 11.2 KB
/
common.mk
File metadata and controls
268 lines (252 loc) · 11.2 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
# common.mk - Shared Makefile rules for domain schemas
# Include this file in domain Makefiles with: include ../common.mk
#
# This Makefile uses dynamic dependency discovery to automatically determine
# which profile schemas need to be validated against for each event schema.
# Instead of hardcoding profile versions, it recursively follows allOf references
# in the schema files to discover all dependencies, ensuring version mismatches
# are avoided (e.g., supplier-allocation 2025-12 correctly uses common 2025-11-draft).
# Force bash as the shell for PIPESTATUS support
SHELL := /bin/bash
# Variables that must be set by the including Makefile:
# - DOMAIN: The domain name (e.g., supplier-allocation, examples)
# - PUBLISH_VERSION: The version directory (e.g., 2025-10)
# - ROOT_DIR: Absolute path to repository root
# Computed variables
SCHEMA_BASE_URL ?= https://notify.nhs.uk/cloudevents/schemas
# Strip "cloudevents/domains" from schema URLs to get cleaner GitHub Pages URLs
SCHEMA_URL_STRIP_PREFIX ?= cloudevents/domains
OUTPUT_BASE_DIR = $(ROOT_DIR)/output/$(DOMAIN)
SCHEMAS_BASE_DIR = $(ROOT_DIR)/schemas/$(DOMAIN)
OUTPUT_DIR = $(OUTPUT_BASE_DIR)/$(PUBLISH_VERSION)
SCHEMAS_DIR = $(SCHEMAS_BASE_DIR)/$(PUBLISH_VERSION)
EVENTS_DIR = $(OUTPUT_DIR)/example-events
SRC_DIR = $(ROOT_DIR)/src/cloudevents/domains/$(DOMAIN)/$(PUBLISH_VERSION)
CLOUD_EVENTS_DIR = $(ROOT_DIR)/src/cloudevents
# Discover YAML schema files by category
PROFILE_SCHEMAS = $(wildcard $(SRC_DIR)/*.schema.yaml)
DATA_SCHEMAS = $(wildcard $(SRC_DIR)/data/*.schema*.yaml)
DEFS_SCHEMAS = $(wildcard $(SRC_DIR)/defs/*.yaml)
EVENT_SCHEMAS = $(wildcard $(SRC_DIR)/events/*.schema.yaml)
# Extract base names for each category
PROFILE_NAMES = $(sort $(patsubst %.schema.yaml,%,$(notdir $(PROFILE_SCHEMAS))))
DATA_NAMES = $(sort $(patsubst %.yaml,%,$(notdir $(DATA_SCHEMAS))))
DEFS_NAMES = $(sort $(patsubst %.yaml,%,$(notdir $(DEFS_SCHEMAS))))
EVENT_NAMES = $(sort $(patsubst %.schema.yaml,%,$(notdir $(EVENT_SCHEMAS))))
.PHONY: build build-no-bundle publish publish-json publish-bundled-json publish-yaml generate test deploy clean
build:
$(MAKE) build-no-bundle
@if [ -n "$(EVENT_NAMES)" ]; then \
echo "Bundling and flattening event schemas..."; \
for schema in $(EVENT_NAMES); do \
echo " - $$schema (bundle & flatten)"; \
cd $(CLOUD_EVENTS_DIR) && npm run bundle -- --root-dir $(ROOT_DIR) $(OUTPUT_DIR)/events/$$schema.schema.json $(OUTPUT_DIR)/events/$$schema.bundle.schema.json || exit 1; \
cd $(CLOUD_EVENTS_DIR) && npm run bundle -- --flatten --root-dir $(ROOT_DIR) $(OUTPUT_DIR)/events/$$schema.schema.json $(OUTPUT_DIR)/events/$$schema.flattened.schema.json || exit 1; \
done; \
fi
build-no-bundle:
@echo "Building $(DOMAIN) schemas to output/..."
@if [ -n "$(PROFILE_NAMES)" ]; then \
echo "Building profile schemas..."; \
for schema in $(PROFILE_NAMES); do \
echo " - $$schema"; \
cd $(CLOUD_EVENTS_DIR) && npm run build -- --root-dir $(ROOT_DIR) $(SRC_DIR)/$$schema.schema.yaml $(OUTPUT_DIR) || exit 1; \
done; \
fi
@if [ -n "$(DEFS_NAMES)" ]; then \
echo "Building defs schemas..."; \
for schema in $(DEFS_NAMES); do \
echo " - $$schema"; \
cd $(CLOUD_EVENTS_DIR) && npm run build -- --root-dir $(ROOT_DIR) $(SRC_DIR)/defs/$$schema.yaml $(OUTPUT_DIR)/defs || exit 1; \
done; \
fi
@if [ -n "$(DATA_NAMES)" ]; then \
echo "Building data schemas..."; \
for schema in $(DATA_NAMES); do \
echo " - $$schema"; \
cd $(CLOUD_EVENTS_DIR) && npm run build -- --root-dir $(ROOT_DIR) $(SRC_DIR)/data/$$schema.yaml $(OUTPUT_DIR)/data || exit 1; \
done; \
fi
@if [ -n "$(EVENT_NAMES)" ]; then \
echo "Building event schemas..."; \
for schema in $(EVENT_NAMES); do \
echo " - $$schema"; \
cd $(CLOUD_EVENTS_DIR) && npm run build -- --root-dir $(ROOT_DIR) $(SRC_DIR)/events/$$schema.schema.yaml $(OUTPUT_DIR)/events || exit 1; \
done; \
fi
publish-json:
@echo "Publishing $(DOMAIN) schemas with public URLs..."
@if [ -n "$(PROFILE_NAMES)" ]; then \
echo "Publishing profile schemas..."; \
for schema in $(PROFILE_NAMES); do \
echo " - $$schema"; \
if [ -n "$(SCHEMA_URL_STRIP_PREFIX)" ]; then \
cd $(CLOUD_EVENTS_DIR) && npm run build -- --root-dir $(ROOT_DIR) --strip-prefix $(SCHEMA_URL_STRIP_PREFIX) $(SRC_DIR)/$$schema.schema.yaml $(SCHEMAS_DIR) $(SCHEMA_BASE_URL) || exit 1; \
else \
cd $(CLOUD_EVENTS_DIR) && npm run build -- --root-dir $(ROOT_DIR) $(SRC_DIR)/$$schema.schema.yaml $(SCHEMAS_DIR) $(SCHEMA_BASE_URL) || exit 1; \
fi; \
done; \
fi
@if [ -n "$(DEFS_NAMES)" ]; then \
echo "Publishing defs schemas..."; \
for schema in $(DEFS_NAMES); do \
echo " - $$schema"; \
if [ -n "$(SCHEMA_URL_STRIP_PREFIX)" ]; then \
cd $(CLOUD_EVENTS_DIR) && npm run build -- --root-dir $(ROOT_DIR) --strip-prefix $(SCHEMA_URL_STRIP_PREFIX) $(SRC_DIR)/defs/$$schema.yaml $(SCHEMAS_DIR)/defs $(SCHEMA_BASE_URL) || exit 1; \
else \
cd $(CLOUD_EVENTS_DIR) && npm run build -- --root-dir $(ROOT_DIR) $(SRC_DIR)/defs/$$schema.yaml $(SCHEMAS_DIR)/defs $(SCHEMA_BASE_URL) || exit 1; \
fi; \
done; \
fi
@if [ -n "$(DATA_NAMES)" ]; then \
echo "Publishing data schemas..."; \
for schema in $(DATA_NAMES); do \
echo " - $$schema"; \
if [ -n "$(SCHEMA_URL_STRIP_PREFIX)" ]; then \
cd $(CLOUD_EVENTS_DIR) && npm run build -- --root-dir $(ROOT_DIR) --strip-prefix $(SCHEMA_URL_STRIP_PREFIX) $(SRC_DIR)/data/$$schema.yaml $(SCHEMAS_DIR)/data $(SCHEMA_BASE_URL) || exit 1; \
else \
cd $(CLOUD_EVENTS_DIR) && npm run build -- --root-dir $(ROOT_DIR) $(SRC_DIR)/data/$$schema.yaml $(SCHEMAS_DIR)/data $(SCHEMA_BASE_URL) || exit 1; \
fi; \
done; \
fi
@if [ -n "$(EVENT_NAMES)" ]; then \
echo "Publishing event schemas..."; \
for schema in $(EVENT_NAMES); do \
echo " - $$schema"; \
if [ -n "$(SCHEMA_URL_STRIP_PREFIX)" ]; then \
cd $(CLOUD_EVENTS_DIR) && npm run build -- --root-dir $(ROOT_DIR) --strip-prefix $(SCHEMA_URL_STRIP_PREFIX) $(SRC_DIR)/events/$$schema.schema.yaml $(SCHEMAS_DIR)/events $(SCHEMA_BASE_URL) || exit 1; \
else \
cd $(CLOUD_EVENTS_DIR) && npm run build -- --root-dir $(ROOT_DIR) $(SRC_DIR)/events/$$schema.schema.yaml $(SCHEMAS_DIR)/events $(SCHEMA_BASE_URL) || exit 1; \
fi; \
done; \
echo "Bundling published event schemas..."; \
for schema in $(EVENT_NAMES); do \
echo " - $$schema (bundle)"; \
cd $(CLOUD_EVENTS_DIR) && npm run bundle -- --root-dir $(ROOT_DIR) --base-url $(SCHEMA_BASE_URL) $(OUTPUT_DIR)/events/$$schema.schema.json $(SCHEMAS_DIR)/events/$$schema.bundle.schema.json || exit 1; \
done; \
fi
$(MAKE) publish-bundled-json
publish-bundled-json:
@if [ -n "$(EVENT_NAMES)" ]; then \
@echo "Flattening published event schemas..."; \
for schema in $(EVENT_NAMES); do \
echo " - $$schema (flatten)"; \
cd $(CLOUD_EVENTS_DIR) && npm run bundle -- --flatten --root-dir $(ROOT_DIR) --base-url $(SCHEMA_BASE_URL) $(OUTPUT_DIR)/events/$$schema.schema.json $(SCHEMAS_DIR)/events/$$schema.flattened.schema.json || exit 1; \
done; \
fi
publish-yaml:
@echo "Publishing $(DOMAIN) YAML schemas alongside JSON..."
@if [ -n "$(PROFILE_NAMES)" ]; then \
echo "Converting profile schemas to YAML..."; \
for schema in $(PROFILE_NAMES); do \
echo " - $$schema"; \
cd $(ROOT_DIR)/src/cloudevents && npm run json-to-yaml $(SCHEMAS_DIR)/$$schema.schema.json $(SCHEMAS_DIR)/$$schema.schema.yaml || exit 1; \
done; \
fi
@if [ -n "$(DEFS_NAMES)" ]; then \
echo "Converting defs schemas to YAML..."; \
for schema in $(DEFS_NAMES); do \
echo " - $$schema"; \
cd $(ROOT_DIR)/src/cloudevents && npm run json-to-yaml $(SCHEMAS_DIR)/defs/$$schema.json $(SCHEMAS_DIR)/defs/$$schema.yaml || exit 1; \
done; \
fi
@if [ -n "$(DATA_NAMES)" ]; then \
echo "Converting data schemas to YAML..."; \
for schema in $(DATA_NAMES); do \
echo " - $$schema"; \
cd $(ROOT_DIR)/src/cloudevents && npm run json-to-yaml $(SCHEMAS_DIR)/data/$$schema.json $(SCHEMAS_DIR)/data/$$schema.yaml || exit 1; \
done; \
fi
@if [ -n "$(EVENT_NAMES)" ]; then \
echo "Converting event schemas to YAML..."; \
for schema in $(EVENT_NAMES); do \
echo " - $$schema (including bundle & flatten)"; \
cd $(ROOT_DIR)/src/cloudevents && npm run json-to-yaml $(SCHEMAS_DIR)/events/$$schema.schema.json $(SCHEMAS_DIR)/events/$$schema.schema.yaml || exit 1; \
cd $(ROOT_DIR)/src/cloudevents && npm run json-to-yaml $(SCHEMAS_DIR)/events/$$schema.bundle.schema.json $(SCHEMAS_DIR)/events/$$schema.bundle.schema.yaml || exit 1; \
cd $(ROOT_DIR)/src/cloudevents && npm run json-to-yaml $(SCHEMAS_DIR)/events/$$schema.flattened.schema.json $(SCHEMAS_DIR)/events/$$schema.flattened.schema.yaml || exit 1; \
done; \
fi
publish:
@echo "Publishing $(DOMAIN) schemas (JSON + YAML)..."
$(MAKE) publish-json
$(MAKE) publish-yaml
generate:
@if [ -n "$(EVENT_NAMES)" ]; then \
echo "Generating $(DOMAIN) events..."; \
for schema in $(EVENT_NAMES); do \
echo " - $$schema"; \
cd $(CLOUD_EVENTS_DIR) && npm run generate -- $(OUTPUT_DIR)/events/$$schema.schema.json $(EVENTS_DIR)/$$schema-event.json || exit 1; \
done; \
fi
test:
@if [ -n "$(EVENT_NAMES)" ]; then \
echo "Testing $(DOMAIN) events..."; \
FAILED=0; \
TOTAL_PASSED=0; \
TOTAL_TESTS=0; \
ALL_TEST_RESULTS=""; \
TMPFILE=$$(mktemp); \
for schema in $(EVENT_NAMES); do \
echo "Testing $$schema event..."; \
echo "Discovering schema dependencies for $$schema..."; \
SCHEMA_DEPS=$$(npx tsx $(ROOT_DIR)/src/cloudevents/tools/discovery/discover-schema-dependencies.ts $(SRC_DIR)/events/$$schema.schema.yaml $(ROOT_DIR)/output 2>/dev/null); \
if [ $$? -ne 0 ]; then \
echo "❌ Failed to discover dependencies for $$schema"; \
FAILED=1; \
continue; \
fi; \
set +e; \
$(ROOT_DIR)/tests/run-validations.sh \
$(ROOT_DIR)/output \
$(EVENTS_DIR)/$$schema-event.json \
$(OUTPUT_DIR)/events/$$schema.schema.json \
$(OUTPUT_DIR)/events/$$schema.bundle.schema.json \
$(OUTPUT_DIR)/events/$$schema.flattened.schema.json \
$$SCHEMA_DEPS 2>&1 | tee $$TMPFILE; \
TEST_EXIT=$${PIPESTATUS[0]}; \
set -e; \
if [ $$TEST_EXIT -ne 0 ]; then \
FAILED=1; \
fi; \
RESULT=$$(grep "VALIDATION_RESULTS:" $$TMPFILE | tail -1); \
if [ -n "$$RESULT" ]; then \
PASSED=$$(echo "$$RESULT" | awk '{print $$2}'); \
TOTAL=$$(echo "$$RESULT" | awk '{print $$3}'); \
TOTAL_PASSED=$$((TOTAL_PASSED + PASSED)); \
TOTAL_TESTS=$$((TOTAL_TESTS + TOTAL)); \
fi; \
TEST_RESULTS=$$(grep "TEST_RESULT:" $$TMPFILE); \
if [ -n "$$TEST_RESULTS" ]; then \
ALL_TEST_RESULTS="$$ALL_TEST_RESULTS$$TEST_RESULTS"$$'\n'; \
fi; \
done; \
rm -f $$TMPFILE; \
echo ""; \
echo "========================================"; \
echo "Domain Summary: $(DOMAIN)"; \
echo " Tests run: $$TOTAL_TESTS"; \
echo " Passed: $$TOTAL_PASSED"; \
echo " Failed: $$((TOTAL_TESTS - TOTAL_PASSED))"; \
if [ $$FAILED -eq 0 ]; then \
echo " Status: ✅ All tests passed"; \
else \
echo " Status: ❌ Some tests failed"; \
fi; \
echo "========================================"; \
echo ""; \
printf "$$ALL_TEST_RESULTS"; \
echo "DOMAIN_RESULTS: $(DOMAIN) $$TOTAL_PASSED $$TOTAL_TESTS $$FAILED"; \
exit $$FAILED; \
fi
deploy:
@echo "=== Deploying $(DOMAIN) schemas ==="
$(MAKE) build
$(MAKE) generate
$(MAKE) test
$(MAKE) publish
@echo ""
clean:
@echo "Cleaning $(DOMAIN) output..."
rm -rf $(OUTPUT_DIR)/*
rm -rf $(SCHEMAS_DIR)/*
rm -rf $(EVENTS_DIR)/*