-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathTaskfile.yml
More file actions
406 lines (345 loc) · 13.6 KB
/
Copy pathTaskfile.yml
File metadata and controls
406 lines (345 loc) · 13.6 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
# https://taskfile.dev
# Task runner for OpenEMR Sinch Conversations Module development
#
# SEPARATION OF CONCERNS:
# Taskfile: Infrastructure operations (Docker, database, module management)
# Composer: Code quality checks (phpcs, phpstan, rector)
#
# WHY BOTH?
# - Composer scripts work in ANY environment (local, Docker, CI)
# - Taskfile provides convenience wrappers and Docker orchestration
# - Prevents bloated composer.json with Docker-specific commands
# - Taskfile can call Composer scripts (see check: tasks below)
#
# Installation: https://taskfile.dev/installation/
# macOS: brew install go-task
# Linux: sh -c "$(curl --location https://taskfile.dev/install.sh)" -- -d -b ~/.local/bin
#
# Usage:
# task --list # Show all available tasks
# task dev:start # Start Docker environment
# task module:install # Install module in OpenEMR
# task check # Run code quality checks (calls pre-commit/composer)
version: '3'
vars:
MODULE_PATH: /var/www/localhost/htdocs/openemr/interface/modules/custom_modules/oce-module-sinch-conversations
DB_USER: root
DB_PASS: root
DB_NAME: openemr
tasks:
default:
desc: Show available tasks
cmds:
- task --list
# === Docker Environment ===
dev:start:
desc: Start Docker development environment
cmds:
- docker compose up -d --wait
- echo "✅ OpenEMR started. Get port with 'task dev:port'"
dev:stop:
desc: Stop Docker environment (keeps data)
cmds:
- docker compose down
- echo "✅ Docker environment stopped"
dev:restart:
desc: Restart Docker environment
cmds:
- docker compose restart
- echo "✅ Docker environment restarted"
dev:reset:
desc: Stop and remove all data (fresh start)
prompt: This will delete ALL data. Continue?
cmds:
- docker compose down -v
- echo "✅ All data removed. Run 'task dev:start' to start fresh"
dev:purge:
desc: Stop and remove all containers, volumes, and orphans
prompt: This will DELETE all Docker containers, volumes, and orphans. Continue?
cmds:
- docker compose down -v --remove-orphans
- echo "✅ Docker environment purged"
dev:has-volumes:
desc: Check if Docker volumes exist (returns 0 if exist, 1 if not)
internal: true
cmds:
- test -n "$(docker compose volumes -q)"
dev:logs:
desc: View OpenEMR logs (follow mode)
cmds:
- docker compose logs -f openemr
dev:logs:errors:
desc: View OpenEMR error logs only
cmds:
- docker compose logs -f openemr | grep -i error
dev:port:
desc: Get assigned port for OpenEMR
cmds:
- echo "OpenEMR HTTP port:"
- docker compose port openemr 80
- echo ""
- echo "Access OpenEMR at http://localhost:[PORT]"
- echo "Login - admin / pass"
dev:browse:
desc: Open OpenEMR in your default browser
cmds:
- |
HTTPS_PORT=$(docker compose port openemr 443 | cut -d: -f2)
if [ -z "$HTTPS_PORT" ]; then
echo "❌ Could not detect HTTPS port. Is Docker running?"
exit 1
fi
URL="https://localhost:$HTTPS_PORT"
echo "Opening OpenEMR at $URL"
echo "Login credentials: admin / pass"
if command -v open > /dev/null 2>&1; then
open "$URL"
elif command -v xdg-open > /dev/null 2>&1; then
xdg-open "$URL"
else
echo "❌ Could not find 'open' or 'xdg-open' command"
echo "Please open this URL manually: $URL"
fi
dev:shell:
desc: Access OpenEMR container shell
cmds:
- docker compose exec openemr bash
dev:status:
desc: Check Docker container status
cmds:
- docker compose ps
# === Module Management ===
module:list:
desc: List all registered modules in OpenEMR
cmds:
- docker compose exec openemr php {{.MODULE_PATH}}/bin/install-module.php module:list
module:register:
desc: Register module in OpenEMR database
cmds:
- docker compose exec openemr php {{.MODULE_PATH}}/bin/install-module.php module:register oce-module-sinch-conversations
module:install:
desc: Install module SQL schema (requires registered module)
cmds:
- docker compose exec openemr php {{.MODULE_PATH}}/bin/install-module.php module:install oce-module-sinch-conversations
module:enable:
desc: Enable the module
cmds:
- docker compose exec openemr php {{.MODULE_PATH}}/bin/install-module.php module:enable oce-module-sinch-conversations
module:disable:
desc: Disable the module
cmds:
- docker compose exec openemr php {{.MODULE_PATH}}/bin/install-module.php module:disable oce-module-sinch-conversations
module:unregister:
desc: Unregister module from database (must be disabled first)
cmds:
- docker compose exec openemr php {{.MODULE_PATH}}/bin/install-module.php module:unregister oce-module-sinch-conversations
module:install-enable:
desc: Full install (register + install SQL + enable) in one command
cmds:
- docker compose exec openemr php {{.MODULE_PATH}}/bin/install-module.php module:install-enable oce-module-sinch-conversations
module:reinstall:
desc: Reinstall module (cleanup, unregister, then full install)
cmds:
- task: module:cleanup
- task: module:unregister
- task: module:install-enable
module:cleanup:
desc: Drop all module database tables (for clean reinstall)
prompt: This will delete all module data. Continue?
cmds:
- docker compose exec -T mysql mariadb -u{{.DB_USER}} -p{{.DB_PASS}} {{.DB_NAME}} < cleanup.sql
- echo "✅ Module tables dropped. You can now reinstall the module."
module:tables:
desc: List all module database tables
cmds:
- docker compose exec mysql mariadb -u{{.DB_USER}} -p{{.DB_PASS}} -e "SELECT table_name FROM information_schema.tables WHERE table_schema='{{.DB_NAME}}' AND table_name LIKE 'oce_sinch%'" {{.DB_NAME}} 2>&1 | grep -v "Using a password"
module:data:
desc: Show counts of data in module tables
cmds:
- |
docker compose exec mysql mariadb -u{{.DB_USER}} -p{{.DB_PASS}} -e "
SELECT 'conversations' as table_name, COUNT(*) as count FROM oce_sinch_conversations
UNION ALL SELECT 'messages', COUNT(*) FROM oce_sinch_messages
UNION ALL SELECT 'contacts', COUNT(*) FROM oce_sinch_contacts
UNION ALL SELECT 'patient_consent', COUNT(*) FROM oce_sinch_patient_consent
UNION ALL SELECT 'templates', COUNT(*) FROM oce_sinch_message_templates
UNION ALL SELECT 'keywords', COUNT(*) FROM oce_sinch_keyword_responses
UNION ALL SELECT 'services', COUNT(*) FROM oce_sinch_services
" {{.DB_NAME}} 2>&1 | grep -v "Using a password"
# === Database Access ===
db:shell:
desc: Access MariaDB database shell
cmds:
- docker compose exec mysql mariadb -u{{.DB_USER}} -p{{.DB_PASS}} {{.DB_NAME}}
db:export:
desc: Export database to backup.sql
cmds:
- docker compose exec mysql mariadb-dump -u{{.DB_USER}} -p{{.DB_PASS}} {{.DB_NAME}} > backup.sql
- echo "✅ Database exported to backup.sql"
db:import:
desc: Import database from backup.sql
prompt: This will overwrite the current database. Continue?
cmds:
- docker compose exec -T mysql mariadb -u{{.DB_USER}} -p{{.DB_PASS}} {{.DB_NAME}} < backup.sql
- echo "✅ Database imported from backup.sql"
db:query:
desc: 'Run a SQL query (usage: task db:query -- "SELECT * FROM users LIMIT 5")'
cmds:
- docker compose exec mysql mariadb -u{{.DB_USER}} -p{{.DB_PASS}} -e "{{.CLI_ARGS}}" {{.DB_NAME}} 2>&1 | grep -v "Using a password"
# === Code Quality (delegates to Composer scripts) ===
# These tasks call Composer scripts directly on the host (no Docker needed).
# You can also run `composer phpcs`, `composer phpstan`, etc. directly.
check:
desc: Run all code quality checks (calls pre-commit run -a)
cmds:
- pre-commit run -a
check:phpcs:
desc: Run PHP CodeSniffer (calls composer phpcs)
cmds:
- composer phpcs
check:phpstan:
desc: Run PHPStan (calls composer phpstan)
cmds:
- composer phpstan
check:fix:
desc: Auto-fix code style (calls composer phpcbf)
cmds:
- composer phpcbf
# === Testing ===
test:
desc: Run PHPUnit tests
cmds:
- composer test
test:coverage:
desc: Run PHPUnit with HTML coverage report
cmds:
- composer phpunit-coverage
- echo "✅ Coverage report generated in htmlcov/"
test:integration:
desc: Run end-to-end integration tests (boots real OpenEMR + DB inside container)
cmds:
- docker compose up -d --wait
- docker compose exec -T openemr php {{.MODULE_PATH}}/vendor/bin/phpunit -c {{.MODULE_PATH}}/phpunit.integration.xml
# === Development Helpers ===
# Composer dependency management tasks (infrastructure, not code quality)
composer:install:
desc: Install composer dependencies
cmds:
- composer install
- echo "✅ Composer dependencies installed"
composer:update:
desc: Update composer dependencies
cmds:
- composer update
- echo "✅ Composer dependencies updated"
tools:install:
desc: Install OpenEMR source under tools/openemr (for PHPStan + Docker bind mount)
cmds:
- composer install --working-dir=tools/openemr
- echo "✅ OpenEMR source installed under tools/openemr/vendor/openemr/openemr"
docs:sinch:
desc: Fetch latest Sinch API documentation for AI agents
cmds:
- mkdir -p .local
- curl -fsSL https://developers.sinch.com/llms.txt -o .local/llms.txt
- echo "✅ Sinch API docs updated in .local/llms.txt"
openemr:prebuild:
desc: Pre-build OpenEMR dependencies in tools/openemr (speeds up first Docker start)
deps:
- tools:install
cmds:
- echo "Building OpenEMR dependencies..."
- cd tools/openemr/vendor/openemr/openemr && composer install --no-dev
- cd tools/openemr/vendor/openemr/openemr && npm install --legacy-peer-deps
- cd tools/openemr/vendor/openemr/openemr && npm run build
- echo "✅ OpenEMR dependencies built"
git:clean:
desc: Run git clean (remove untracked files, preserves .local/)
prompt: This will delete untracked files (except .local/). Continue?
cmds:
- git clean -fd -e .local
- echo "✅ Untracked files removed (preserved .local/)"
vendor:clean:
desc: Remove vendor directories (root and tools/openemr) — forces complete reinstall
prompt: This will DELETE the root vendor/ AND tools/openemr/vendor/ directories. Continue?
preconditions:
- sh: test -z "$(docker compose volumes -q)"
msg: |
❌ Docker volumes still exist. You must run 'task dev:purge' first.
Reason: OpenEMR stores crypto keys in both the database (volume) and filesystem
(tools/openemr/vendor/openemr/openemr/sites). Removing the OpenEMR vendor without
removing volumes will break encryption and make the database unusable.
Run: task workflow:nuke (to remove both) or task dev:purge (then task vendor:clean)
cmds:
- git clean -fdx vendor/ tools/openemr/vendor/
- echo "✅ Vendor directories removed (root + tools/openemr)"
# === Quick Workflows ===
setup:
desc: Complete setup (install deps, prebuild OpenEMR, start Docker)
cmds:
- task: composer:install
# openemr:prebuild deps on tools:install, so the OpenEMR source is
# installed transitively — no need to call tools:install here too.
- task: openemr:prebuild
- task: dev:start
- task: dev:port
workflow:reinstall:
desc: Complete reinstall workflow (cleanup tables, instructions)
cmds:
- task: module:cleanup
- task: module:install
workflow:reset:
desc: Complete reset (stop, clean data, restart)
cmds:
- task: dev:reset
- task: dev:start
- echo ""
- echo "✅ Environment reset complete"
- task: dev:port
webhook:url:
desc: Show the local webhook URL
cmds:
- |
HTTP_PORT=$(docker compose port openemr 80 2>/dev/null | cut -d: -f2)
if [ -z "$HTTP_PORT" ]; then
echo "Error: OpenEMR container not running. Start with 'task dev:start'"
exit 1
fi
echo "Local webhook URL:"
echo " http://localhost:$HTTP_PORT/interface/modules/custom_modules/oce-module-sinch-conversations/public/webhook.php"
webhook:tunnel:
desc: Start Tailscale Funnel to expose webhook endpoint (background, port 10000)
cmds:
- |
HTTP_PORT=$(docker compose port openemr 80 2>/dev/null | cut -d: -f2)
if [ -z "$HTTP_PORT" ]; then
echo "Error: OpenEMR container not running. Start with 'task dev:start'"
exit 1
fi
echo "Starting Tailscale Funnel (HTTPS :10000 -> HTTP :$HTTP_PORT)..."
tailscale funnel --bg --https 10000 $HTTP_PORT
HOSTNAME=$(tailscale status --json | jq -r '.Self.DNSName' | sed 's/\.$//')
echo ""
echo "Webhook URL for Sinch dashboard:"
echo " https://$HOSTNAME:10000/interface/modules/custom_modules/oce-module-sinch-conversations/public/webhook.php"
webhook:tunnel:status:
desc: Show Tailscale Funnel status and webhook URL
cmds:
- tailscale funnel status
- |
HOSTNAME=$(tailscale status --json | jq -r '.Self.DNSName' | sed 's/\.$//')
echo ""
echo "Webhook URL for Sinch dashboard:"
echo " https://$HOSTNAME:10000/interface/modules/custom_modules/oce-module-sinch-conversations/public/webhook.php"
webhook:tunnel:off:
desc: Turn off Tailscale Funnel
cmds:
- tailscale funnel --https=10000 off
- echo "Tailscale Funnel stopped"
workflow:nuke:
desc: Nuclear reset (removes vendor + database volumes, forces complete reinstall)
cmds:
- task: dev:purge
- task: vendor:clean
- echo "✅ Complete reset done. Vendor removed, Docker volumes deleted."
- echo " Run 'task setup' to rebuild from scratch."