-
Notifications
You must be signed in to change notification settings - Fork 94
Expand file tree
/
Copy pathMakefile
More file actions
694 lines (632 loc) · 30 KB
/
Makefile
File metadata and controls
694 lines (632 loc) · 30 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
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
# SPDX-FileCopyrightText: Copyright (C) 2025 Intel Corporation
# SPDX-License-Identifier: Apache-2.0
# ==============================================================================
# Chat Question & Answer Core - Makefile
# ==============================================================================
#
# Build, test, deploy, and manage the Chat Q&A application.
# Supports OpenVINO and Ollama backends with CPU/GPU deployment modes.
#
# Quick Start:
# make help - Show all available commands
# make build - Build all Docker images
# make deploy - Deploy using pre-built images
# make deploy-build - Build and deploy
# make undeploy - Stop the application
#
# Configuration:
# BACKEND - OPENVINO (default) or OLLAMA
# DEVICE - CPU (default) or GPU (OpenVINO only)
# HUGGINGFACEHUB_API_TOKEN - Required for OpenVINO backend
#
# ==============================================================================
SHELL := bash -eu -o pipefail
.DEFAULT_GOAL := help
# ==============================================================================
# Project Configuration
# ==============================================================================
SERVICE_NAME := chatqna-core
VERSION ?= latest
PYTHON_VERSION := 3.12
NODE_VERSION := 22
# ==============================================================================
# Pre-built Image Configuration
# ==============================================================================
DEFAULT_REGISTRY := intel/
DEFAULT_UI_TAG := core_1.3.2
DEFAULT_BACKEND_TAG := core_1.3.2
DEFAULT_GPU_TAG := core_gpu_1.3.2
DEFAULT_OLLAMA_TAG := core_ollama_1.3.2
# ==============================================================================
# Component Configuration
# ==============================================================================
COMPONENTS := frontend backend
TEST_COMPONENTS := frontend backend
frontend_CONTEXT_DIR := ./ui/
frontend_DOCKERFILE := ./ui/Dockerfile
backend_CONTEXT_DIR := ./
backend_DOCKERFILE := ./docker/Dockerfile
# ==============================================================================
# Deployment Configuration
# ==============================================================================
DEVICE ?= CPU
BACKEND ?= OPENVINO
REGISTRY ?= $(DEFAULT_REGISTRY)
UI_TAG ?= $(DEFAULT_UI_TAG)
DEVICE_UPPER := $(shell echo $(DEVICE) | tr '[:lower:]' '[:upper:]')
BACKEND_UPPER := $(shell echo $(BACKEND) | tr '[:lower:]' '[:upper:]')
# ==============================================================================
# Internal Variables
# ==============================================================================
TEST_TARGETS := $(addprefix test-,$(TEST_COMPONENTS))
.PHONY: all build test clean help list deploy deploy-build undeploy \
shellcheck pylint \
trivy-scan trivy-scan-fs trivy-scan-image trivy-scan-config \
clamav-scan bandit-scan gitleaks-scan codeql-scan \
$(TEST_TARGETS) \
get-service-name get-component-names get-image-tags get-context-dirs \
get-python-version get-node-version get-scan-matrix-json
# ==============================================================================
# Build Targets
# ==============================================================================
build:
@echo "📦 Building all components..."
@$(foreach component,$(COMPONENTS), \
echo "Building $(component): $(SERVICE_NAME)-$(component):$(VERSION)"; \
docker build \
-t $(SERVICE_NAME)-$(component):$(VERSION) \
-f $($(component)_DOCKERFILE) $($(component)_CONTEXT_DIR); \
)
@echo "✅ All components built successfully."
# ==============================================================================
# Test Targets
# ==============================================================================
test: $(TEST_TARGETS)
@if [ -z "$(TEST_TARGETS)" ]; then \
echo "⚠️ No test components configured."; \
else \
echo "✅ All tests completed."; \
fi
test-frontend:
@echo "🧪 Running frontend tests..."
@cd $(frontend_CONTEXT_DIR) && npm install && npm run coverage
test-backend:
@echo "🧪 Running backend tests ($(BACKEND_UPPER))..."
@python3 -m venv chat-qna-core-venv && \
source chat-qna-core-venv/bin/activate && \
pip install poetry && \
poetry install --no-root --with dev && \
export HUGGINGFACEHUB_API_TOKEN="$${HUGGINGFACEHUB_API_TOKEN:-}" && \
source scripts/setup_env.sh 2>/dev/null || true && \
cd tests && \
poetry run pytest \
--model-runtime=$(shell echo $(BACKEND_UPPER) | tr '[:upper:]' '[:lower:]') \
--verbose \
--cov=app \
--cov-report=html:../coverage-backend \
--cov-report=xml:../coverage-backend.xml \
--cov-report=term-missing \
--cov-branch && \
cd .. && \
deactivate && \
rm -rf chat-qna-core-venv
# ==============================================================================
# Deployment Targets
# ==============================================================================
deploy:
@echo "══════════════════════════════════════════════════"
@echo "🚀 Deploy - $(SERVICE_NAME)"
@echo "══════════════════════════════════════════════════"
@echo ""
@echo "Configuration:"
@echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
@if [ "$(BACKEND_UPPER)" = "OLLAMA" ]; then \
echo " BACKEND: $(BACKEND_UPPER) (CPU only)"; \
echo " DEVICE: CPU"; \
BACKEND_TAG_COMPUTED="$${BACKEND_TAG:-$(DEFAULT_OLLAMA_TAG)}"; \
else \
echo " BACKEND: $(BACKEND_UPPER)"; \
echo " DEVICE: $(DEVICE_UPPER)"; \
if [ "$(DEVICE_UPPER)" = "GPU" ]; then \
BACKEND_TAG_COMPUTED="$${BACKEND_TAG:-$(DEFAULT_GPU_TAG)}"; \
else \
BACKEND_TAG_COMPUTED="$${BACKEND_TAG:-$(DEFAULT_BACKEND_TAG)}"; \
fi; \
fi; \
echo ""; \
echo "Images:"; \
echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"; \
echo " REGISTRY: $${REGISTRY:-$(DEFAULT_REGISTRY)}"; \
echo " UI_TAG: $${UI_TAG:-$(DEFAULT_UI_TAG)}"; \
echo " BACKEND_TAG: $$BACKEND_TAG_COMPUTED"; \
if [ "$(BACKEND_UPPER)" = "OPENVINO" ]; then \
if [ -z "$${HUGGINGFACEHUB_API_TOKEN:-}" ]; then \
echo " HF_TOKEN: ❌ NOT SET"; \
else \
echo " HF_TOKEN: ✅ Set"; \
fi; \
else \
echo " HF_TOKEN: (not required for Ollama)"; \
fi; \
echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"; \
echo ""; \
VALIDATION_ERROR=""; \
if [ "$(BACKEND_UPPER)" = "OPENVINO" ] && [ -z "$${HUGGINGFACEHUB_API_TOKEN:-}" ]; then \
echo "❌ HUGGINGFACEHUB_API_TOKEN is required for OpenVINO backend."; \
echo " export HUGGINGFACEHUB_API_TOKEN=<your-token>"; \
echo ""; \
VALIDATION_ERROR="true"; \
fi; \
if [ "$(BACKEND_UPPER)" != "OPENVINO" ] && [ "$(BACKEND_UPPER)" != "OLLAMA" ]; then \
echo "❌ Invalid BACKEND '$(BACKEND_UPPER)'. Use OPENVINO or OLLAMA."; \
echo ""; \
VALIDATION_ERROR="true"; \
fi; \
if [ "$(BACKEND_UPPER)" = "OPENVINO" ] && [ "$(DEVICE_UPPER)" != "CPU" ] && [ "$(DEVICE_UPPER)" != "GPU" ]; then \
echo "❌ Invalid DEVICE '$(DEVICE_UPPER)'. Use CPU or GPU."; \
echo ""; \
VALIDATION_ERROR="true"; \
fi; \
if [ -n "$$VALIDATION_ERROR" ]; then \
exit 0; \
fi; \
read -p "Proceed with deployment? [y/N]: " confirm; \
if [ "$$confirm" != "y" ] && [ "$$confirm" != "Y" ]; then \
echo ""; \
echo "Deployment cancelled."; \
echo ""; \
else \
echo ""; \
echo "→ Deploying..."; \
if [ "$(BACKEND_UPPER)" = "OLLAMA" ]; then \
export BACKEND_TAG="$${BACKEND_TAG:-$(DEFAULT_OLLAMA_TAG)}"; \
export UI_TAG="$${UI_TAG:-$(DEFAULT_UI_TAG)}"; \
export REGISTRY="$${REGISTRY:-$(DEFAULT_REGISTRY)}"; \
bash -c "source scripts/setup_env.sh -b ollama && docker compose -f docker/compose.yaml up -d"; \
elif [ "$(DEVICE_UPPER)" = "GPU" ]; then \
export BACKEND_TAG="$${BACKEND_TAG:-$(DEFAULT_GPU_TAG)}"; \
export UI_TAG="$${UI_TAG:-$(DEFAULT_UI_TAG)}"; \
export REGISTRY="$${REGISTRY:-$(DEFAULT_REGISTRY)}"; \
bash -c "source scripts/setup_env.sh -d gpu && docker compose -f docker/compose.yaml up -d"; \
else \
export BACKEND_TAG="$${BACKEND_TAG:-$(DEFAULT_BACKEND_TAG)}"; \
export UI_TAG="$${UI_TAG:-$(DEFAULT_UI_TAG)}"; \
export REGISTRY="$${REGISTRY:-$(DEFAULT_REGISTRY)}"; \
bash -c "source scripts/setup_env.sh && docker compose -f docker/compose.yaml up -d"; \
fi; \
echo ""; \
echo "✅ Deployment complete!"; \
fi
deploy-build:
@bash -c '\
echo "══════════════════════════════════════════════════"; \
echo "🚀 Deploy Build - $(SERVICE_NAME)"; \
echo "══════════════════════════════════════════════════"; \
echo ""; \
echo "Configuration:"; \
echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"; \
if [ "$(BACKEND_UPPER)" = "OLLAMA" ]; then \
echo " BACKEND: $(BACKEND_UPPER) (CPU only)"; \
echo " DEVICE: CPU"; \
else \
echo " BACKEND: $(BACKEND_UPPER)"; \
echo " DEVICE: $(DEVICE_UPPER)"; \
fi; \
if [ "$(BACKEND_UPPER)" = "OPENVINO" ]; then \
if [ -z "$${HUGGINGFACEHUB_API_TOKEN:-}" ]; then \
echo " HF_TOKEN: ❌ NOT SET"; \
else \
echo " HF_TOKEN: ✅ Set"; \
fi; \
else \
echo " HF_TOKEN: (not required for Ollama)"; \
fi; \
echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"; \
echo ""; \
if [ "$(BACKEND_UPPER)" = "OPENVINO" ] && [ -z "$${HUGGINGFACEHUB_API_TOKEN:-}" ]; then \
echo "❌ HUGGINGFACEHUB_API_TOKEN is required for OpenVINO backend."; \
echo " export HUGGINGFACEHUB_API_TOKEN=<your-token>"; \
echo ""; \
exit 0; \
elif [ "$(BACKEND_UPPER)" != "OPENVINO" ] && [ "$(BACKEND_UPPER)" != "OLLAMA" ]; then \
echo "❌ Invalid BACKEND '\''$(BACKEND_UPPER)'\''. Use OPENVINO or OLLAMA."; \
exit 0; \
elif [ "$(BACKEND_UPPER)" = "OPENVINO" ] && [ "$(DEVICE_UPPER)" != "CPU" ] && [ "$(DEVICE_UPPER)" != "GPU" ]; then \
echo "❌ Invalid DEVICE '\''$(DEVICE_UPPER)'\''. Use CPU or GPU."; \
exit 0; \
else \
read -p "Proceed with deployment? [y/N]: " confirm; \
if [ "$$confirm" != "y" ] && [ "$$confirm" != "Y" ]; then \
echo ""; \
echo "Deployment cancelled."; \
echo ""; \
else \
echo ""; \
echo "→ Building and deploying..."; \
if [ "$(BACKEND_UPPER)" = "OLLAMA" ]; then \
source scripts/setup_env.sh -b ollama && docker compose -f docker/compose.yaml up -d --build; \
elif [ "$(DEVICE_UPPER)" = "GPU" ]; then \
source scripts/setup_env.sh -d gpu && docker compose -f docker/compose.yaml up -d --build; \
else \
source scripts/setup_env.sh && docker compose -f docker/compose.yaml up -d --build; \
fi; \
echo ""; \
echo "✅ Deployment complete!"; \
fi; \
fi; \
'
undeploy:
@echo "══════════════════════════════════════════════════"
@echo "🛑 Stopping $(SERVICE_NAME)"
@echo "══════════════════════════════════════════════════"
@if [ "$(BACKEND_UPPER)" = "OLLAMA" ]; then \
bash -c "source scripts/setup_env.sh -b ollama 2>/dev/null || true && docker compose -f docker/compose.yaml down"; \
elif [ "$(DEVICE_UPPER)" = "GPU" ]; then \
bash -c "source scripts/setup_env.sh -d gpu 2>/dev/null || true && docker compose -f docker/compose.yaml down"; \
else \
bash -c "source scripts/setup_env.sh 2>/dev/null || true && docker compose -f docker/compose.yaml down"; \
fi
@echo "✅ Application stopped."
# ==============================================================================
# Code Quality
# ==============================================================================
shellcheck:
@echo "🔍 Running ShellCheck..."
@mkdir -p security-results
@find . -type f \( -name "*.sh" -o -name "*.bash" \) -print0 | xargs -0 -r \
shellcheck --format=json > security-results/shellcheck-report-$(SERVICE_NAME).json 2>/dev/null || true
@echo "✅ Report: security-results/shellcheck-report-$(SERVICE_NAME).json"
pylint:
@echo "🔍 Running Pylint..."
@python3 -m venv pylint-venv && \
source pylint-venv/bin/activate && \
pip install poetry && \
poetry install --no-root --with dev && \
poetry add --group dev pylint && \
mkdir -p security-results && \
echo "=== Pylint Report ===" > security-results/pylint-report-$(SERVICE_NAME).txt && \
echo "Date: $$(date)" >> security-results/pylint-report-$(SERVICE_NAME).txt && \
echo "" >> security-results/pylint-report-$(SERVICE_NAME).txt && \
( \
echo "[MESSAGES CONTROL]"; \
echo "disable=C0111,C0103,R0903,R0913,W0613,W0622,R0801,R0902,R0914,R0915,R0912,C0301,C0302"; \
echo ""; \
echo "[FORMAT]"; \
echo "max-line-length=120"; \
echo ""; \
echo "[REPORTS]"; \
echo "output-format=json"; \
echo "reports=yes"; \
) > .pylintrc && \
find app/ -type f -name "*.py" -exec poetry run pylint --rcfile=.pylintrc {} + \
> security-results/pylint-report-$(SERVICE_NAME).json 2>/dev/null || true && \
deactivate && \
rm -rf pylint-venv .pylintrc
@echo "✅ Report: security-results/pylint-report-$(SERVICE_NAME).json"
# ==============================================================================
# Security Scanning
# ==============================================================================
trivy-scan: trivy-scan-fs trivy-scan-image trivy-scan-config
@echo "📦 Creating security scan archive..."
@cd security-results && zip -r trivy-scan-$(SERVICE_NAME)-$$(date +%Y%m%d-%H%M%S).zip trivy-* 2>/dev/null || true
@echo "✅ All Trivy scans complete. Reports: security-results/trivy-*"
# Trivy HTML template - auto-detect or download
TRIVY_HTML_TPL_URL := https://raw.githubusercontent.com/aquasecurity/trivy/main/pkg/report/templates/html.tpl
TRIVY_HTML_TPL_LOCAL := security-results/.trivy-html.tpl
define ENSURE_TRIVY_HTML_TPL
if [ -f "/usr/local/share/trivy/templates/html.tpl" ]; then \
TRIVY_HTML_TPL="/usr/local/share/trivy/templates/html.tpl"; \
elif [ -f "/usr/share/trivy/templates/html.tpl" ]; then \
TRIVY_HTML_TPL="/usr/share/trivy/templates/html.tpl"; \
else \
echo " → Trivy HTML template not found locally, downloading..."; \
mkdir -p security-results; \
curl -sSL -o $(TRIVY_HTML_TPL_LOCAL) $(TRIVY_HTML_TPL_URL) || \
wget -qO $(TRIVY_HTML_TPL_LOCAL) $(TRIVY_HTML_TPL_URL) || \
{ echo " ⚠️ Could not download HTML template. HTML reports will be skipped."; TRIVY_HTML_TPL=""; }; \
TRIVY_HTML_TPL="$(TRIVY_HTML_TPL_LOCAL)"; \
fi
endef
trivy-scan-fs:
@echo "🔍 Running Trivy Filesystem Scan..."
@mkdir -p security-results
@trivy fs --severity HIGH,CRITICAL --ignore-unfixed --format json \
--output security-results/trivy-fs-$(SERVICE_NAME).json . || true
@trivy fs --format spdx-json \
--output security-results/trivy-fs-$(SERVICE_NAME).spdx.json . || true
@$(ENSURE_TRIVY_HTML_TPL); \
if [ -n "$$TRIVY_HTML_TPL" ] && [ -f "$$TRIVY_HTML_TPL" ]; then \
trivy fs --severity HIGH,CRITICAL --ignore-unfixed --format template \
--template "@$$TRIVY_HTML_TPL" \
--output security-results/trivy-fs-$(SERVICE_NAME).html . || true; \
echo "✅ Filesystem scan complete: security-results/trivy-fs-$(SERVICE_NAME).{json,spdx.json,html}"; \
else \
echo "✅ Filesystem scan complete: security-results/trivy-fs-$(SERVICE_NAME).{json,spdx.json}"; \
fi
trivy-scan-image:
@echo "🔍 Running Trivy Image Scans..."
@mkdir -p security-results
@$(ENSURE_TRIVY_HTML_TPL); \
echo "Scanning backend image..."; \
trivy image --severity HIGH,CRITICAL --ignore-unfixed --format json \
--output security-results/trivy-image-$(SERVICE_NAME)-backend.json \
$(SERVICE_NAME)-backend:$(VERSION) 2>/dev/null || echo "⚠️ Backend image not found. Run 'make build' first."; \
trivy image --format spdx-json \
--output security-results/trivy-image-$(SERVICE_NAME)-backend.spdx.json \
$(SERVICE_NAME)-backend:$(VERSION) 2>/dev/null || true; \
if [ -n "$$TRIVY_HTML_TPL" ] && [ -f "$$TRIVY_HTML_TPL" ]; then \
trivy image --severity HIGH,CRITICAL --ignore-unfixed --format template \
--template "@$$TRIVY_HTML_TPL" \
--output security-results/trivy-image-$(SERVICE_NAME)-backend.html \
$(SERVICE_NAME)-backend:$(VERSION) 2>/dev/null || true; \
fi; \
echo "Scanning frontend image..."; \
trivy image --severity HIGH,CRITICAL --ignore-unfixed --format json \
--output security-results/trivy-image-$(SERVICE_NAME)-frontend.json \
$(SERVICE_NAME)-frontend:$(VERSION) 2>/dev/null || echo "⚠️ Frontend image not found. Run 'make build' first."; \
trivy image --format spdx-json \
--output security-results/trivy-image-$(SERVICE_NAME)-frontend.spdx.json \
$(SERVICE_NAME)-frontend:$(VERSION) 2>/dev/null || true; \
if [ -n "$$TRIVY_HTML_TPL" ] && [ -f "$$TRIVY_HTML_TPL" ]; then \
trivy image --severity HIGH,CRITICAL --ignore-unfixed --format template \
--template "@$$TRIVY_HTML_TPL" \
--output security-results/trivy-image-$(SERVICE_NAME)-frontend.html \
$(SERVICE_NAME)-frontend:$(VERSION) 2>/dev/null || true; \
fi
@echo "✅ Image scans complete: security-results/trivy-image-*.{json,spdx.json,html}"
trivy-scan-config:
@echo "🔍 Running Trivy Config Scans..."
@mkdir -p security-results
@$(ENSURE_TRIVY_HTML_TPL); \
trivy config --severity HIGH,CRITICAL --format json \
--output security-results/trivy-config-$(SERVICE_NAME)-backend.json \
--file-patterns "dockerfile:Dockerfile" . || true; \
if [ -n "$$TRIVY_HTML_TPL" ] && [ -f "$$TRIVY_HTML_TPL" ]; then \
trivy config --severity HIGH,CRITICAL --format template \
--template "@$$TRIVY_HTML_TPL" \
--output security-results/trivy-config-$(SERVICE_NAME)-backend.html \
--file-patterns "dockerfile:Dockerfile" . || true; \
fi; \
trivy config --severity HIGH,CRITICAL --format json \
--output security-results/trivy-config-$(SERVICE_NAME)-frontend.json \
--file-patterns "dockerfile:Dockerfile" ui/ || true; \
if [ -n "$$TRIVY_HTML_TPL" ] && [ -f "$$TRIVY_HTML_TPL" ]; then \
trivy config --severity HIGH,CRITICAL --format template \
--template "@$$TRIVY_HTML_TPL" \
--output security-results/trivy-config-$(SERVICE_NAME)-frontend.html \
--file-patterns "dockerfile:Dockerfile" ui/ || true; \
fi
@echo "✅ Config scans complete: security-results/trivy-config-*.{json,html}"
clamav-scan:
@echo "🦠 Running ClamAV Antivirus Scan..."
@mkdir -p security-results
@clamscan -r . \
--exclude-dir=.git \
--exclude-dir=node_modules \
--exclude-dir=venv \
--exclude-dir=ui/test \
--exclude-dir=tests \
> security-results/clamav-$(SERVICE_NAME)-$$(date +%Y%m%d-%H%M%S).txt 2>&1 || true
@echo "✅ ClamAV scan complete: security-results/clamav-*"
bandit-scan:
@echo "🔐 Running Bandit Security Scan..."
@mkdir -p security-results
@python3 -m venv bandit-venv && \
source bandit-venv/bin/activate && \
pip install --upgrade pip && \
pip install bandit[toml] && \
CONFIG_OPT=""; \
if [ -f "pyproject.toml" ]; then CONFIG_OPT="-c pyproject.toml"; fi; \
echo "📝 Generating TXT Report (matches CI)..." && \
bandit $$CONFIG_OPT --severity-level low --confidence-level low \
-r . --exclude .git,node_modules,venv,bandit-venv,ui \
-f txt -o security-results/bandit-report-$(SERVICE_NAME).txt || true && \
echo "📊 Generating JSON Report..." && \
bandit $$CONFIG_OPT --severity-level low --confidence-level low \
-r . --exclude .git,node_modules,venv,bandit-venv,ui \
-f json -o security-results/bandit-report-$(SERVICE_NAME).json || true && \
echo "🌐 Generating HTML Report..." && \
bandit $$CONFIG_OPT --severity-level low --confidence-level low \
-r . --exclude .git,node_modules,venv,bandit-venv,ui \
-f html -o security-results/bandit-report-$(SERVICE_NAME).html || true && \
deactivate && \
rm -rf bandit-venv
@echo "✅ Bandit scan complete. Check security-results/ for txt, json, and html reports."
gitleaks-scan:
@echo "🔑 Running Gitleaks Secrets Scan..."
@mkdir -p security-results
@gitleaks dir . -v \
-r security-results/gitleaks-$(SERVICE_NAME)-$$(date +%Y%m%d-%H%M%S).json || true
@echo "✅ Gitleaks scan complete: security-results/gitleaks-*"
codeql-scan:
@echo "🛡️ Running CodeQL Security Analysis..."
@if ! command -v codeql >/dev/null 2>&1; then \
echo ""; \
echo "❌ CodeQL CLI is not installed."; \
echo "Install: https://github.com/github/codeql-cli-binaries/releases"; \
echo ""; \
exit 1; \
fi
@mkdir -p security-results
@echo ""
@# --- Download / verify required query packs ---
@echo "→ Checking CodeQL Python query pack..."
@if ! codeql resolve qlpacks 2>/dev/null | grep -q 'codeql/python-queries'; then \
echo " ⬇️ Downloading codeql/python-queries..."; \
codeql pack download codeql/python-queries; \
else \
echo " ✅ codeql/python-queries already available."; \
fi
@echo "→ Checking CodeQL JavaScript/TypeScript query pack..."
@if ! codeql resolve qlpacks 2>/dev/null | grep -q 'codeql/javascript-queries'; then \
echo " ⬇️ Downloading codeql/javascript-queries..."; \
codeql pack download codeql/javascript-queries; \
else \
echo " ✅ codeql/javascript-queries already available."; \
fi
@echo ""
@# --- Python: app/ (backend) ---
@echo "→ Creating CodeQL database for Python (app/)..."
@codeql database create security-results/codeql-db-python-app-$(SERVICE_NAME) \
--language=python \
--source-root=app \
--build-mode=none \
--overwrite 2>&1 | tail -5
@echo "→ Running CodeQL analysis on app/ (SARIF)..."
@codeql database analyze security-results/codeql-db-python-app-$(SERVICE_NAME) \
codeql/python-queries \
--format=sarif-latest --sarif-add-snippets \
--output=security-results/codeql-python-app-$(SERVICE_NAME).sarif || true
@echo "→ Running CodeQL analysis on app/ (CSV)..."
@codeql database analyze security-results/codeql-db-python-app-$(SERVICE_NAME) \
codeql/python-queries \
--format=csv \
--output=security-results/codeql-python-app-$(SERVICE_NAME).csv || true
@echo "✅ Python (app/) analysis complete."
@echo ""
@# --- Python: tests/ ---
@echo "→ Creating CodeQL database for Python (tests/)..."
@codeql database create security-results/codeql-db-python-tests-$(SERVICE_NAME) \
--language=python \
--source-root=tests \
--build-mode=none \
--overwrite 2>&1 | tail -5
@echo "→ Running CodeQL analysis on tests/ (SARIF)..."
@codeql database analyze security-results/codeql-db-python-tests-$(SERVICE_NAME) \
codeql/python-queries \
--format=sarif-latest --sarif-add-snippets \
--output=security-results/codeql-python-tests-$(SERVICE_NAME).sarif || true
@echo "→ Running CodeQL analysis on tests/ (CSV)..."
@codeql database analyze security-results/codeql-db-python-tests-$(SERVICE_NAME) \
codeql/python-queries \
--format=csv \
--output=security-results/codeql-python-tests-$(SERVICE_NAME).csv || true
@echo "✅ Python (tests/) analysis complete."
@echo ""
@# --- JavaScript/TypeScript: frontend ---
@echo "→ Creating CodeQL database for JavaScript/TypeScript (frontend)..."
@codeql database create security-results/codeql-db-javascript-$(SERVICE_NAME) \
--language=javascript \
--source-root=ui \
--build-mode=none \
--overwrite 2>&1 | tail -5
@echo "→ Running CodeQL analysis on JavaScript/TypeScript (SARIF)..."
@codeql database analyze security-results/codeql-db-javascript-$(SERVICE_NAME) \
codeql/javascript-queries \
--format=sarif-latest --sarif-add-snippets \
--output=security-results/codeql-javascript-$(SERVICE_NAME).sarif || true
@echo "→ Running CodeQL analysis on JavaScript/TypeScript (CSV)..."
@codeql database analyze security-results/codeql-db-javascript-$(SERVICE_NAME) \
codeql/javascript-queries \
--format=csv \
--output=security-results/codeql-javascript-$(SERVICE_NAME).csv || true
@echo "✅ JavaScript/TypeScript analysis complete."
@echo ""
@echo "✅ CodeQL scan complete: security-results/codeql-*.{sarif,csv}"
# ==============================================================================
# Utility Targets
# ==============================================================================
list:
@echo "══════════════════════════════════════════════════"
@echo "📋 Build Configuration: $(SERVICE_NAME)"
@echo "══════════════════════════════════════════════════"
@echo ""
@echo "Version: $(VERSION)"
@echo ""
@echo "Components:"
@$(foreach component,$(COMPONENTS), echo " • $(component) → $(SERVICE_NAME)-$(component):$(VERSION)";)
@echo ""
@echo "Test Components:"
@$(foreach component,$(TEST_COMPONENTS), echo " • $(component)";)
clean:
@echo "🧹 Removing Docker images..."
@$(foreach component,$(COMPONENTS), \
docker rmi -f $(SERVICE_NAME)-$(component):$(VERSION) 2>/dev/null || true; \
)
@echo "✅ Cleanup complete."
# ==============================================================================
# CI/CD Targets
# ==============================================================================
get-service-name:
@echo $(SERVICE_NAME)
get-component-names:
@echo "$(COMPONENTS)"
get-image-tags:
@$(foreach component,$(COMPONENTS), echo "$(SERVICE_NAME)-$(component):$(VERSION)";)
get-context-dirs:
@$(foreach component,$(COMPONENTS), echo "$($(component)_CONTEXT_DIR)";)
get-python-version:
@echo $(PYTHON_VERSION)
get-node-version:
@echo $(NODE_VERSION)
get-scan-matrix-json:
@printf '{"include":['
@$(foreach component,$(COMPONENTS), \
$(eval COMMA := $(if $(findstring $(component),$(firstword $(COMPONENTS))),,',')) \
printf '%s' '$(COMMA){"name":"$(component)","image":"$(SERVICE_NAME)-$(component):$(VERSION)","context":"$($(component)_CONTEXT_DIR)","dockerfile":"$($(component)_DOCKERFILE)"}'; \
)
@printf ']}\n'
# ==============================================================================
# Help
# ==============================================================================
help:
@echo ""
@echo "╔══════════════════════════════════════════════════════════════════╗"
@echo "║ Chat Question & Answer Core - Makefile ║"
@echo "╚══════════════════════════════════════════════════════════════════╝"
@echo ""
@echo "Usage: make <target>"
@echo ""
@echo "BUILD & TEST"
@echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
@echo " build Build all Docker images"
@echo " test Run all unit tests"
@echo " test-frontend Run frontend tests"
@echo " test-backend Run backend tests (uses BACKEND env var)"
@echo ""
@echo "DEPLOYMENT"
@echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
@echo " deploy Deploy using pre-built images"
@echo " deploy-build Build images and deploy"
@echo " undeploy Stop and remove containers"
@echo ""
@echo " Environment Variables:"
@echo " BACKEND OPENVINO (default) or OLLAMA"
@echo " DEVICE CPU (default) or GPU (OpenVINO only)"
@echo " HUGGINGFACEHUB_API_TOKEN Required for OpenVINO"
@echo " REGISTRY Image registry (default: $(DEFAULT_REGISTRY))"
@echo " UI_TAG UI image tag (default: $(DEFAULT_UI_TAG))"
@echo " BACKEND_TAG Backend image tag (auto-selected by BACKEND/DEVICE)"
@echo ""
@echo "CODE QUALITY & SECURITY"
@echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
@echo " shellcheck Run ShellCheck on shell scripts"
@echo " pylint Run Pylint on Python code"
@echo " trivy-scan Run all Trivy scans"
@echo " trivy-scan-fs Run Trivy filesystem scan"
@echo " trivy-scan-image Run Trivy image scans"
@echo " trivy-scan-config Run Trivy Dockerfile scans"
@echo " clamav-scan Run ClamAV antivirus scan"
@echo " bandit-scan Run Bandit security scan"
@echo " gitleaks-scan Run Gitleaks secrets scan"
@echo " codeql-scan Run CodeQL security analysis (Python + JavaScript)"
@echo ""
@echo "UTILITIES"
@echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
@echo " list Show build configuration"
@echo " clean Remove built Docker images"
@echo " help Show this help message"
@echo ""
@echo "EXAMPLES"
@echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
@echo " # Deploy with pre-built images (OpenVINO CPU)"
@echo " export HUGGINGFACEHUB_API_TOKEN=<token>"
@echo " make deploy"
@echo ""
@echo " # Deploy with Ollama"
@echo " BACKEND=OLLAMA make deploy"
@echo ""
@echo " # Build and deploy with OpenVINO GPU"
@echo " export HUGGINGFACEHUB_API_TOKEN=<token>"
@echo " DEVICE=GPU make deploy-build"
@echo ""