-
Notifications
You must be signed in to change notification settings - Fork 25
/
Copy pathtask
executable file
·2441 lines (1996 loc) · 84.9 KB
/
task
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
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/bin/bash
cd "$(dirname "$0")" || exit
# Commands such as git pull return exit code if there are no changes
# set -e
if [[ -a ".env" ]]; then
source .env
fi
function help-table() {
# Define column widths
CMD_WIDTH=25
OPT_WIDTH=20
DESC_WIDTH=90
COLUMN="| %-${CMD_WIDTH}s | %-${OPT_WIDTH}s | %-${DESC_WIDTH}s |\n"
# Print table header
printf "$COLUMN" "Command" "Option" "Description"
echo "|$(printf '%*s' $((CMD_WIDTH + 2)) '' | tr ' ' '-')|$(printf '%*s' $((OPT_WIDTH + 2)) '' | tr ' ' '-')|$(printf '%*s' $((DESC_WIDTH + 2)) '' | tr ' ' '-')|"
# Print table rows
printf "$COLUMN" "activate-venv" "" "Activate virtualenv."
printf "$COLUMN" "add-git-submodule" "[url] [path]" "Add git submodule."
printf "$COLUMN" "build" "[platform]" "Build Odoo Conainer image. Optionally define the target platform."
printf "$COLUMN" "build-vuepress" "" "Create Vuepress build."
printf "$COLUMN" "change-uuid" "[env]" "Change database uuid via xmlrpc."
printf "$COLUMN" "checkout" "[branch]" "Checkout Odoo version / branch."
printf "$COLUMN" "checkout-all" "" "Checkout every Odoo version / branch."
printf "$COLUMN" "checkout-config-files" "[branch]" "Checkout config files from another branch."
printf "$COLUMN" "checkout-git-submodule" "" "Checkout submodule commits."
printf "$COLUMN" "checkout-revision" "[revision]" "Run Odoo revision script or checkout revision set by env var."
printf "$COLUMN" "clear-assets" "[db]" "Clear all assets of Odoo database."
printf "$COLUMN" "clear-filestore" "[db]" "Clear local filestore folder. No param will clear all filestores. Default is branch name."
printf "$COLUMN" "clear-views" "[db]" "Clear all views of Odoo database."
printf "$COLUMN" "clock-odoo" "[db]" "Count custom line of codes. Default is branch name."
printf "$COLUMN" "commit-git-submodule-all" "[message][path]" "Commit all changes in path."
printf "$COLUMN" "container-login" "" "Setup container hub login credentials."
printf "$COLUMN" "convert-database" "[db]" "Convert database backup file from PostgreSQL 9.5 to latest. Default is branch name."
printf "$COLUMN" "create-git-feature-branch" "[path]" "Create feature branch for Odoo module."
printf "$COLUMN" "create-git-mig-branch" "[path]" "Create migration branch for Odoo module."
printf "$COLUMN" "create-module" "[path]" "Create new Odoo module from template."
printf "$COLUMN" "create-module-repo" "[path]" "Initialize Odoo module repo from template."
printf "$COLUMN" "create-nextcloud-env" "[env]" "Create env file for Nextcloud instance."
printf "$COLUMN" "create-odoo-env" "[env]" "Create env file for Odoo Instance."
printf "$COLUMN" "create-revision" "[revision]" "Create new Odoo revision."
printf "$COLUMN" "create-snippet" "[id]" "Create snippet from template."
printf "$COLUMN" "delete-git-submodule" "" "Delete all submodule folders."
printf "$COLUMN" "dev-vuepress" "" "Start Vuepress development server."
printf "$COLUMN" "disable-mailserver" "[env]" "Disable mail server settings via xmlrpc."
printf "$COLUMN" "disable-snippet" "[env][path]" "Disable snippet definition."
printf "$COLUMN" "drop-db" "[db]" "Drop target Odoo database. Default is branch name."
printf "$COLUMN" "edit-env" "[env]" "Open env file in default editor."
printf "$COLUMN" "fetch-git-origin" "" "Fetch all Odoo version branches."
printf "$COLUMN" "generate-admin-passwd" "[pass]" "Generate hash for Odoo master password."
printf "$COLUMN" "generate-help-doc" "" "Write help table to task.md file."
printf "$COLUMN" "generate-module-model" "[path][model]" "Generate model files from templates."
printf "$COLUMN" "generate-module-overview" "" "Update module overview doc file."
printf "$COLUMN" "generate-module-security" "[path][model]" "Generate model access file for a selected model of a module."
printf "$COLUMN" "generate-module-snippet" "[path][ref]" "Generate view snippet from template."
printf "$COLUMN" "generate-revisions-doc" "" "Update revisions doc file."
printf "$COLUMN" "generate-snippets-doc" "" "Update snippets doc file."
printf "$COLUMN" "get-addons-path" "" "Output addons path."
printf "$COLUMN" "get-git-submodule-status" "[path]" "Show status for submodules in path."
printf "$COLUMN" "get-modules" "[path][option]" "Get list of modules in path. Option is 'basename' or 'dirname'."
printf "$COLUMN" "get-module-version" "[path]" "Get module version from manifest."
printf "$COLUMN" "import-csv" "[db][path]" "Import data from csv. Filename must match PostgreSQL table name."
printf "$COLUMN" "info" "" "Show values of project env vars."
printf "$COLUMN" "init-db" "[db]" "Initialize the Odoo database. Default is branch name."
printf "$COLUMN" "init-git-submodule" "" "Init submodules listed in the .gitmodules file."
printf "$COLUMN" "init-module" "[db][path,module]" "Initialize Odoo module. Default database is branch name."
printf "$COLUMN" "init-venv" "" "Initialize python virtual env."
printf "$COLUMN" "install-native" "" "Install Odoo requirements in source folder."
printf "$COLUMN" "install-odoo-scripts" "" "Install Odoo scripts."
printf "$COLUMN" "install-requirements" "[db][path]" "Install python packages from requirements.txt."
printf "$COLUMN" "install-snippet" "[env][path]" "Install snippet definition."
printf "$COLUMN" "install-vuepress" "" "Install Node build dependencies."
printf "$COLUMN" "lint-module" "[path]" "Run pylint odoo for module."
printf "$COLUMN" "lint-module-repo" "[path]" "Run pylint odoo for modules in repo folder."
printf "$COLUMN" "lint-snippets" "" "Run checks for all snippets."
printf "$COLUMN" "list-env" "" "List env files."
printf "$COLUMN" "list-git-submodule" "" "List path and url of submodules."
printf "$COLUMN" "list-modules" "[path]" "Get modules in path as list."
printf "$COLUMN" "list-revision" "" "List available Odoo revisions."
printf "$COLUMN" "llm-update" "[path][prompt]" "Feed module files with prompt to LLM and apply file changes."
printf "$COLUMN" "load-language" "[db][lang]" "Install language package in Odoo db."
printf "$COLUMN" "logs" "" "Tail Odoo container logs."
printf "$COLUMN" "ls-git-submodule" "[grep]" "List submodule path space separated."
printf "$COLUMN" "odooctl" "[param]" "Execute odooctl cli."
printf "$COLUMN" "patch-database" "[db][path]" "Apply sql file to database. Default database is branch name."
printf "$COLUMN" "ps" "" "List container processes."
printf "$COLUMN" "publish" "" "Publish Odoo container image."
printf "$COLUMN" "pull-git-submodule" "" "Pull all submodules listed in the .gitmodules file."
printf "$COLUMN" "push-git-submodule" "" "Push all submodules in path."
printf "$COLUMN" "pytest-module" "[db][name,path]" "Run module tests with pytest."
printf "$COLUMN" "release-module" "[path]" "Create GitHub release for a module."
printf "$COLUMN" "remove" "[name]" "Remove containers and volumes. Options: none, db, admin, odoo, mail."
printf "$COLUMN" "remove-env" "[env]" "Remove environment config."
printf "$COLUMN" "remove-git-submodule" "[path]" "Remove a git submodule."
printf "$COLUMN" "remove-module" "[db][name]" "Remove target Odoo module."
printf "$COLUMN" "remove-snippet" "[env][path]" "Remove snippet definition."
printf "$COLUMN" "reset-views" "[db][key]" "Execute hard reset on views matching keys."
printf "$COLUMN" "restart" "[name]" "Restart container."
printf "$COLUMN" "restore-dotenv" "" "Restore content of .env from pass entry."
printf "$COLUMN" "run" "[name][cmd]" "Run container with command."
printf "$COLUMN" "save-config" "[name]" "Save Odoo database config."
printf "$COLUMN" "serve-vuepress-build" "" "Serve Vuepress build."
printf "$COLUMN" "set-addons-path" "" "Set Odoo addons path env variable."
printf "$COLUMN" "set-admin" "[db]" "Sets the password for the first user in database. Default is branch name."
printf "$COLUMN" "setup-mail" "[db]" "Setup mail config in Odoo db."
printf "$COLUMN" "setup-mail-sql" "[db]" "Setup mail config in Odoo db with SQL."
printf "$COLUMN" "show-env" "[env]" "Output content of the env file."
printf "$COLUMN" "show-revision" "[revision]" "Show references of Odoo revision."
printf "$COLUMN" "source" "" "Source the Python virtual env."
printf "$COLUMN" "start" "[name][db]" "Start container. Options: none, db, admin, odoo, native, mail."
printf "$COLUMN" "start-psql" "[db]" "Start PSQL shell in container container. Default is branch name."
printf "$COLUMN" "start-shell" "[db]" "Start Odoo shell from source folder. Default is branch name."
printf "$COLUMN" "stop" "[name]" "Stop containers."
printf "$COLUMN" "store-dotenv" "" "Store content of .env in pass entry."
printf "$COLUMN" "switch-git-submodule" "[branch]" "Switch branch for all submodules listed in the .gitmodules file."
printf "$COLUMN" "sync-git-submodule" "" "Switch, stash and pull all submodules."
printf "$COLUMN" "template-docker-compose" "" "Template the Docker compose file."
printf "$COLUMN" "template-odoo-rc" "" "Template the Odoo config file."
printf "$COLUMN" "template-repo" "[path]" "Update the repo folder from template."
printf "$COLUMN" "test-container" "[clean]" "Test Odoo image."
printf "$COLUMN" "test-module" "[db][name,path]" "Test target Odoo module."
printf "$COLUMN" "test-module-repo" "[db][path]" "Test target Odoo modules in repo folder."
printf "$COLUMN" "test-xmlrpc" "[env]" "Test json rpc connection."
printf "$COLUMN" "translate-module" "[db][path][lang]" "Generate translation for Odoo module."
printf "$COLUMN" "update-app-list" "[db]" "Update app list."
printf "$COLUMN" "update-docs" "" "Update project docs."
printf "$COLUMN" "update-module" "[db][name,path]" "Update target Odoo module."
printf "$COLUMN" "update-module-docs" "[path]" "Update Readme file of the module."
printf "$COLUMN" "update-repo-docs" "[path]" "Update Readme file of the repo."
printf "$COLUMN" "update-snippet" "[env][path]" "Update snippet definition."
printf "$COLUMN" "upgrade-module" "[path][version]" "Upgrade code of module from target Odoo version."
printf "$COLUMN" "upgrade-odoo" "[db][version][mode]" "Run the Odoo upgrade scripts. Default mode ist 'test'."
printf "$COLUMN" "upload-module" "[env][path]" "Zip and upload Odoo module."
printf "$COLUMN" "version" "" "Show version of required tools."
printf "$COLUMN" "visualize-dependencies" "[path]" "Generate visualizations of module dependencies."
printf "$COLUMN" "zip-module" "[path]" "Create zip file for module."
}
function help() {
echo
echo "$1 <command> [options]"
echo
echo "commands:"
echo
help-table
echo
}
# Static env vars
PASS_ENTRY=env/Odoo-Build
ODOO_RC="odoo.conf"
ODOO_BUILD_CONFIG_DIR="$HOME/.config/odoo-build"
# Dynamic env vars
GIT_BRANCH=$(git symbolic-ref --short -q HEAD)
ODOO_DATABASE=${ODOO_DATABASE:="$GIT_BRANCH"}
ODOO_REVISION=${ODOO_REVISION:="$GIT_BRANCH"}
ODOO_LANGUAGE=${ODOO_LANGUAGE:="de_CH"}
ODOO_PORT=${ODOO_PORT:="8069"}
POSTGRES_IMAGE=${POSTGRES_IMAGE:="postgres:14-alpine"}
POSTGRES_PORT=${POSTGRES_PORT:="5432"}
LOG_LEVEL=${LOG_LEVEL:="info"}
CONTAINER_REGISTRY=${CONTAINER_REGISTRY:="mintsystem/"}
CONTAINER_TAG=${CONTAINER_TAG:="odoo:${ODOO_REVISION}"}
CONTAINER_CONFIG="$HOME/.docker/$CONTAINER_REGISTRY"
BROWSER_OPEN=${BROWSER_OPEN:=true}
ODOO_REVISION_CONTAINER_PULL=${ODOO_REVISION_CONTAINER_PULL:=false}
CONTAINER_ENGINE=${CONTAINER_ENGINE:="docker"}
COMPOSE_COMMAND=${COMPOSE_COMMAND:="docker compose"}
LLM_MODEL=${LLM_MODEL:="deepseek-coder"}
# Conditional env vars
if [[ "$CONTAINER_ENGINE" == "podman" ]]; then
COMPOSE_COMMAND="podman-compose"
fi
if [ -n "$SERVER_WIDE_MODULES" ]; then
SERVER_WIDE_MODULES="base,web,$SERVER_WIDE_MODULES"
else
SERVER_WIDE_MODULES="base,web"
fi
if [[ "$(uname)" == "Darwin" ]]; then
OS_RELEASE="Darwin"
PYTHON_NOTIFY=""
OS_OPEN="open"
else
OS_RELEASE=$(awk -F= '/^NAME/{print $2}' /etc/os-release | tr -d '"')
PYTHON_NOTIFY="inotify"
OS_OPEN="xdg-open"
fi
# Help Commands
function info() {
set-addons-path
echo "OS Release: $OS_RELEASE"
echo "Git Branch: $GIT_BRANCH"
echo "Odoo Revision: $ODOO_REVISION"
echo "Odoo Port: $ODOO_PORT"
echo "Postgres Port: $POSTGRES_PORT"
echo "Odoo Language: $ODOO_LANGUAGE"
echo "Container Registry: $CONTAINER_REGISTRY"
echo "Container Config: $CONTAINER_CONFIG"
echo "Container Tag: $CONTAINER_TAG"
echo "Addons Path: $ADDONS_PATH"
}
function version() {
activate-venv
uv --version
wkhtmltopdf -V
if [ "$CONTAINER_ENGINE" == "docker" ]; then
docker -v
docker compose version
else
podman --version
podman-compose --version
fi
}
function generate-admin-passwd() {
activate-venv
if test -z "$1"; then echo "\$1 is empty."; exit; fi
ODOO_PASSWORD="$1"
bin/hash_password
}
# Environment Commands
function init-venv() {
if [ ! -d "venv$GIT_BRANCH" ]; then
echo "Init venv$GIT_BRANCH with $(uv --version)."
uv venv "venv$GIT_BRANCH"
fi
}
function activate-venv() {
echo "Source virtualenv venv$GIT_BRANCH."
source "venv$GIT_BRANCH/bin/activate"
echo "$(python --version) is active."
}
function load-env() {
ENV_FILE="$ODOO_BUILD_CONFIG_DIR/.env.$1"
echo "Load env file $ENV_FILE"
export $(cat "$ENV_FILE" | sed 's/#.*//g' | xargs)
}
function get-addons-path() {
set-addons-path
echo "$ADDONS_PATH"
}
function template-odoo-rc() {
echo "Template $ODOO_RC"
export SERVER_WIDE_MODULES
export MODULE_AUTO_INSTALL_DISABLED
if [ -n "$GIT_SSH_PRIVATE_KEY" ]; then
GIT_SSH_PRIVATE_KEY=$(echo -e "$GIT_SSH_PRIVATE_KEY" | base64 -w0)
fi
export GIT_SSH_PRIVATE_KEY
export GIT_SSH_PUBLIC_KEY
export MAIL_DEFAULT_FROM=${MAIL_DEFAULT_FROM:="notification"}
export MAIL_CATCHALL_ALIAS=${MAIL_CATCHALL_ALIAS:="catchall"}
envsubst < "odoo.conf.template" > "$ODOO_RC"
}
function set-addons-path() {
# Read addons path from git submodules
SUBMODULES_PATH="$(git config --file .gitmodules --get-regexp path | awk '{ print $2 }' |sort | tr '\n' ',' | sed 's/,*$//g')"
# Remove excluded addons
EXCLUDES="addons/theme_mint_system addons/company addons/web"
for EXCLUDE in $EXCLUDES; do
SUBMODULES_PATH=$(echo "$SUBMODULES_PATH" | sed "s|${EXCLUDE},||g")
done
# Check if addons dir exist
for ADDON in $SUBMODULES_PATH; do
if [ -d "$ADDON" ]; then
echo "Path does not exist: $ADDON"
exit 1
fi
done
# Convert to native paths
ADDONS_PATH="$(echo $SUBMODULES_PATH | sed 's|,odoo|,odoo/addons|g')"
# Append paths from config env var
if [ -n "$ODOO_ADDONS_PATH" ]; then
ADDONS_PATH="${ODOO_ADDONS_PATH},${ADDONS_PATH}"
fi
}
function init-config-dir() {
echo "Ensure $ODOO_BUILD_CONFIG_DIR exists"
mkdir -p "$ODOO_BUILD_CONFIG_DIR"
}
function create-odoo-env() {
if test -z "$1"; then echo "\$1 is empty."; exit; fi
init-config-dir
ENV_FILEPATH="$ODOO_BUILD_CONFIG_DIR/.env.$1"
if [ -f "$ENV_FILEPATH" ]; then
echo "Env file already exists: $ENV_FILEPATH"
exit 1
fi
echo "Init env file: $ENV_FILEPATH"
echo "ODOO_URL=$ODOO_URL" > "$ENV_FILEPATH"
echo "ODOO_DATABASE=$ODOO_DATABASE" >> "$ENV_FILEPATH"
echo "ODOO_USERNAME=$ODOO_USERNAME" >> "$ENV_FILEPATH"
echo "ODOO_PASSWORD=$ODOO_PASSWORD" >> "$ENV_FILEPATH"
echo "Edit with: task edit-env $1"
}
function create-nextcloud-env() {
if test -z "$1"; then echo "\$1 is empty."; exit; fi
init-config-dir
ENV_FILEPATH="$ODOO_BUILD_CONFIG_DIR/.env.$1"
if [ -f "$ENV_FILEPATH" ]; then
echo "Env file already exists: $ENV_FILEPATH"
exit 1
fi
echo "Init env file: $ENV_FILEPATH"
echo "NEXTCLOUD_URL=" > "$ENV_FILEPATH"
echo "NEXTCLOUD_USERNAME=" >> "$ENV_FILEPATH"
echo "NEXTCLOUD_PASSWORD=" >> "$ENV_FILEPATH"
echo "Edit with: task edit-env $1"
}
function list-env() {
ls -a1 "$ODOO_BUILD_CONFIG_DIR"
}
function show-env() {
if test -z "$1"; then echo "\$1 is empty."; exit; fi
ENV_FILEPATH="$ODOO_BUILD_CONFIG_DIR/.env.$1"
cat "$ENV_FILEPATH"
}
function edit-env() {
if test -z "$1"; then echo "\$1 is empty."; exit; fi
ENV_FILEPATH="$ODOO_BUILD_CONFIG_DIR/.env.$1"
"$EDITOR" "$ENV_FILEPATH"
}
function remove-env() {
if test -z "$1"; then echo "\$1 is empty."; exit; fi
ENV_FILEPATH="$ODOO_BUILD_CONFIG_DIR/.env.$1"
rm "$ENV_FILEPATH"
}
# Docs Commands
function generate-help-doc() {
help-table > task.md
}
function update-repo-docs() {
if test -z "$1"; then echo "\$1 is empty."; exit; fi
README_PATH="$1"
FILE_NAME=$(basename "$README_PATH")
if [[ "$FILE_NAME" != "README.md" ]]; then
README_PATH="$1/README.md"
FILE_NAME="README.md"
fi
REPO_PATH=$(dirname "$README_PATH")
MANIFEST_FILES="$REPO_PATH/*/__manifest__.py"
# Find marker in readme and clear content after
echo "Clear modules table for $README_PATH."
MARKER="## Available modules"
sed -i "/$MARKER/Q" "$README_PATH"
echo "$MARKER" >> "$README_PATH"
echo "" >> "$README_PATH"
echo "| Module | Summary |" >> "$README_PATH"
echo "| --- | --- |" >> "$README_PATH"
# Clear table after a marker
for MANIFEST_FILE in $MANIFEST_FILES; do
MODULE_DIR=$(dirname "$MANIFEST_FILE")
MODULE_NAME=$(basename "$MODULE_DIR")
echo "Add summary of $MODULE_NAME to readme file."
SUMMARY=$(grep 'summary' "$MANIFEST_FILE" -A 1 | tail -1)
echo "| [$MODULE_NAME]($MODULE_NAME) | $SUMMARY |" >> "$README_PATH"
done
}
function generate-snippets-doc() {
echo "Update snippets doc file."
echo "# Snippets" > snippets.md
echo "In Odoo everything is described as an XML document. \
Snippets are modifications (edits) for these XML documents. \
With a snippet you can e.g. hide a field on the contact form. \
A snippet name is unique and follows the \`\$COMPANY.\$MODULE.\$XML_ID.\$DESCRIPTION\` schema." >> snippets.md
PATH_URL="https://github.com/Mint-System/Odoo-Build/tree/16.0"
# Get all modules
MODULES=$(ls snippets/*.xml | xargs -n 1 basename | cut -d. -f1 | sort | uniq)
for MODULE in $MODULES; do
TITLE="${MODULE^}" # Uppercase first letter
TITLE=$(echo "$TITLE" | sed 's/_/ /g') # Replace underline with space
TITLE=$(echo "$TITLE" | sed -r 's/\<./\U&/g') # Uppercase first letter after space
# Create doc file for each module
DOCFILE="snippets/$MODULE.md"
echo -e "# $TITLE" > "$DOCFILE"
echo "## [$TITLE](snippets/$MODULE.md)" >> snippets.md
SIDEBAR_ENTRIES+="'/snippets/$MODULE.md',\n"
# Get all xml ids
XML_IDS=$(ls snippets/$MODULE.*.xml | xargs -n 1 basename | cut -d. -f2 | uniq)
for XML_ID in $XML_IDS; do
XML_ID_TITLE=$(echo "$XML_ID" | sed 's/_/ /g') # Replace underline with space
XML_ID_TITLE=$(echo "$XML_ID_TITLE" | sed -r 's/\<./\U&/g') # Uppercase first letter after space
echo "## $XML_ID_TITLE " >> "$DOCFILE"
# Process each file
FILES="snippets/$MODULE.$XML_ID.*.xml"
for FILE in $FILES; do
# Get snippet params
FILENAME=$(basename "$FILE")
EDIT=$(echo "$FILENAME" | cut -d. -f3)
EDIT_TITLE=$(echo "$EDIT" | sed 's/_/ /g') # Replace underline with space
EDIT_TITLE=$(echo "$EDIT_TITLE" | sed -r 's/\<./\U&/g') # Uppercase first letter after space
# Group by modules
echo "### $EDIT_TITLE " >> "$DOCFILE"
echo "ID: \`mint_system.$MODULE.$XML_ID.$EDIT\` " >> "$DOCFILE"
echo -e '```xml' >> "$DOCFILE"
cat "$FILE" >> "$DOCFILE"
echo -e '\n```' >> "$DOCFILE"
echo -e "Source: [$FILE]($PATH_URL/$FILE)\n" >> "$DOCFILE"
done
done
done
echo -e "export default [$SIDEBAR_ENTRIES]" > .vuepress/sidebar.js
}
function generate-revisions-doc() {
echo "Update revisions doc file."
rm -f "revisions.md"
echo -e "# Odoo Revisions \n\
A Odoo revision is a snapshot of git references of the Odoo source and modules at a specific date.\n\
For each major release there are multiple revisions.\n" > "revisions.md"
declare -A REVISIONS
PATH_URL="https://github.com/Mint-System/Odoo-Build/tree/16.0"
for FILE in bin/odoo_revision_*; do
if [[ -f "$FILE" ]]; then
REVISION=$(basename "$FILE" | sed 's/odoo_revision_//')
VERSION=$(echo "$REVISION" | cut -d'.' -f1-2)
if [[ -z "${REVISIONS[$VERSION]}" ]]; then
REVISIONS[$VERSION]="## $VERSION"
fi
REVISIONS[$VERSION]+=$'\n\n'
REVISIONS[$VERSION]+="#### $REVISION"
REVISIONS[$VERSION]+=$'\n\n```bash\n'
REVISIONS[$VERSION]+=$(cat "$FILE")
REVISIONS[$VERSION]+=$'\n```'
fi
done
for REVISION in $(echo "${!REVISIONS[@]}" | tr ' ' '\n' | sort -V); do
echo -e "${REVISIONS[$REVISION]}\n" >> "revisions.md"
done
}
function generate-module-overview() {
echo "Update module overview doc file."
activate-venv
./bin/generate_module_overview
}
function update-docs() {
generate-module-overview
generate-revisions-doc
generate-snippets-doc
generate-help-doc
}
function update-module-docs() {
if test -z "$1"; then echo "\$1 is empty."; exit; fi
MODULE_PATH="$1"
MANIFEST_PATH="$MODULE_PATH/__manifest__.py"
MODULE_TITLE=$(python3 -c "import ast; d=ast.literal_eval(open('$MANIFEST_PATH').read()); print(d.get('name', ''))")
MODULE_UNDERLINE=$(python3 -c "import ast; d=ast.literal_eval(open('$MANIFEST_PATH').read()); print('=' * len(d.get('name', '')))")
MODULE_SUMMARY=$(python3 -c "import ast; d=ast.literal_eval(open('$MANIFEST_PATH').read()); print(d.get('summary', '').replace('\n', ' ').strip())")
MODULE_WIKI_PATH=$(basename "$MODULE_PATH" | sed 's/_/-/g')
echo "Update $MODULE_PATH/README.rst"
export MODULE_TITLE MODULE_UNDERLINE MODULE_SUMMARY MODULE_WIKI_PATH
envsubst '$MODULE_TITLE $MODULE_UNDERLINE $MODULE_SUMMARY $MODULE_WIKI_PATH' < templates/README.rst > "$MODULE_PATH/README.rst"
echo "Copy app icon"
cp templates/module/static/description/icon.png "$MODULE_PATH/static/description/icon.png"
}
function template-repo(){
if test -z "$1"; then echo "\$1 is empty."; exit; fi
REPO_PATH="$1"
echo "Copy $GIT_BRANCH template files to $REPO_PATH"
cp "templates/task" "$REPO_PATH"
cp -r "templates/$GIT_BRANCH/." "$REPO_PATH"
rm "$REPO_PATH/.flake8"
rm "$REPO_PATH/.isort.cfg"
rm "$REPO_PATH/.pylintrc-mandatory"
update-repo-docs "$REPO_PATH"
}
# Module Commands
function get-modules() {
if test -z "$1"; then echo "\$1 is empty."; exit; fi
OPTION="$2"
if [ -z "$OPTION" ]; then
OPTION="dirname"
fi
if [[ "$OPTION" == "dirname" ]]; then
MODULES=$(echo "$1" | tr "," "\n" | xargs -I {} find {} -type f -name "__manifest__.py" | xargs grep -l "version.*${GIT_BRANCH}" | xargs -r dirname | sort -u | tr "\n" "," | sed 's/,$//')
fi
if [[ "$OPTION" == "basename" ]]; then
MODULES=$(echo "$1" | tr "," "\n" | xargs -I {} find {} -type f -name "__manifest__.py" | xargs grep -l "version.*${GIT_BRANCH}" | xargs -r dirname | xargs -r -I {} basename {} | sort -u | tr "\n" "," | sed 's/,$//')
fi
echo "$MODULES"
}
function get-module-version() {
if test -z "$1"
then
echo "\$1 is empty."
else
# Get version of module
VERSION=$(grep -m 1 \"version "$1/__manifest__.py" | sed "s;';\";g" | sed "s/,//g" | sed 's/#.*//g')
VERSION=$(echo "{ $VERSION }" | jq .version | sed 's/"//g' | sed 's/null//g')
# Set default version
[ -z "$VERSION" ] && VERSION=0.0
COUNT_DOTS=$(echo "$VERSION" | grep -o "\." | wc -l)
# Check if oca version or enterprise version
if [[ $COUNT_DOTS == 2 ]]; then
VERSION="$GIT_BRANCH.$VERSION"
fi
if [[ $COUNT_DOTS == 1 ]]; then
VERSION="$GIT_BRANCH.$VERSION"
fi
echo "$VERSION"
fi
}
function list-modules() {
if test -z "$1"; then echo "\$1 is empty."; exit; fi
echo $(get-modules "$1" basename | tr "," "\n")
}
# Container Commands
function template-docker-compose() {
echo "Template docker-compose.yml"
# Extract variables and export them
# grep -oP '\$\{([^}]+)\}' docker-compose.yml.template | sed 's/${\([^}]\+\)}/export \1/'
export CONTAINER_REGISTRY
export CONTAINER_TAG
export POSTGRES_PORT
export POSTGRES_PORT
export MAIL_DEFAULT_FROM
export MAIL_CATCHALL_DOMAIN
export MAIL_CATCHALL_ALIAS
export ODOO_MAIL_SMTP_HOST
export ODOO_MAIL_SMTP_PORT
export ODOO_MAIL_SMTP_ENCRYPTION
export ODOO_MAIL_SMTP_FROM_FILTER
export ODOO_MAIL_IMAP_HOST
export ODOO_MAIL_IMAP_PORT
export ODOO_MAIL_IMAP_SSL
export ODOO_MAIL_USERNAME
export ODOO_MAIL_PASSWORD
export GIT_SSH_PUBLIC_KEY
export GIT_SSH_PRIVATE_KEY
export GITHUB_USERNAME
export GITHUB_PERSONAL_ACCESS_TOKEN
export ADDONS_GIT_REPOS
export ODOO_ADDONS_PATH
export ODOO_DATABASE
export ODOO_INIT
export ODOO_INIT_LANG
export ODOO_INIT_ADDONS
export ENVIRONMENT
export PYTHON_INSTALL
export SERVER_WIDE_MODULES
export SESSION_DB_URI
export PROXY_MODE
export LOG_LEVEL
export LIST_DB
export ADMIN_PASSWD
export DBFILTER
export WORKERS
export LIMIT_REQUEST
export LIMIT_TIME_CPU
export LIMIT_TIME_REAL
export MODULE_AUTO_INSTALL_DISABLED
export CLICK_ODOO_UPDATE
export ODOO_PORT
export ODOO_PORT
export POSTGRES_IMAGE
export POSTGRES_PORT
export POSTGRES_PORT
export ODOO_DATABASE
envsubst < "docker-compose.yml.template" > "docker-compose.yml"
}
function ps() {
$CONTAINER_ENGINE ps
}
function build() {
MANIFEST_FILE="image/Dockerfile"
PLATFORM="linux/amd64" # linux/arm64
if [ -n "$1" ]; then
PLATFORM="$1"
fi
ODOO_DATE=""
if [[ "ODOO_REVISION" != "$GIT_BRANCH" ]]; then
ODOO_DATE=$(echo "$ODOO_REVISION" | cut -d'.' -f3-)
fi
echo "Remove container image with tag ${CONTAINER_REGISTRY}${CONTAINER_TAG}"
$CONTAINER_ENGINE image rm -f "${CONTAINER_REGISTRY}${CONTAINER_TAG}"
if [ "$CONTAINER_ENGINE" == "podman" ]; then
echo "Run Podman build ${CONTAINER_REGISTRY}${CONTAINER_TAG} for ${PLATFORM}"
SOURCE_DATE_EPOCH=$(git -C odoo log -1 --pretty=%ct) podman build --platform "$PLATFORM" . \
--file "$MANIFEST_FILE" \
--build-arg ODOO_VERSION="$GIT_BRANCH" \
--build-arg ODOO_DATE="$ODOO_DATE" \
--tag "${CONTAINER_REGISTRY}${CONTAINER_TAG}"
fi
if [ "$CONTAINER_ENGINE" == "docker" ]; then
echo "Run Docker build ${CONTAINER_REGISTRY}${CONTAINER_TAG} for ${PLATFORM}"
SOURCE_DATE_EPOCH=$(git -C odoo log -1 --pretty=%ct) docker buildx build --platform "$PLATFORM" . \
--file "$MANIFEST_FILE" \
--build-arg ODOO_VERSION="$GIT_BRANCH" \
--build-arg ODOO_DATE="$ODOO_DATE" \
--tag "${CONTAINER_REGISTRY}${CONTAINER_TAG}" \
--load
fi
}
function container-login() {
echo "Setup container hub login credentials for $CONTAINER_REGISTRY"
echo -n "Enter username: "
read CONTAINER_REGISTRY_USERNAME
echo -n "Enter password: "
read -s CONTAINER_REGISTRY_PASSWORD
if [ "$CONTAINER_ENGINE" == "podman" ]; then
podman login --username "$CONTAINER_REGISTRY_USERNAME" --password "$CONTAINER_REGISTRY_PASSWORD" docker.io
fi
if [ "$CONTAINER_ENGINE" == "docker" ]; then
docker --config "$CONTAINER_CONFIG" login --username "$CONTAINER_REGISTRY_USERNAME" --password "$CONTAINER_REGISTRY_PASSWORD"
fi
}
function publish() {
LATEST_TAG="odoo:$GIT_BRANCH"
echo "Tag container image ${CONTAINER_REGISTRY}${CONTAINER_TAG} with ${CONTAINER_REGISTRY}${LATEST_TAG}"
$CONTAINER_ENGINE tag "${CONTAINER_REGISTRY}${CONTAINER_TAG}" "${CONTAINER_REGISTRY}${LATEST_TAG}"
if [ "$CONTAINER_ENGINE" == "docker" ]; then
echo "Push container image to ${CONTAINER_REGISTRY}${CONTAINER_TAG}"
docker --config "$CONTAINER_CONFIG" push "${CONTAINER_REGISTRY}${CONTAINER_TAG}"
docker --config "$CONTAINER_CONFIG" push "${CONTAINER_REGISTRY}${LATEST_TAG}"
fi
if [ "$CONTAINER_ENGINE" == "podman" ]; then
echo "Push container image to ${CONTAINER_REGISTRY}${CONTAINER_TAG}"
podman push "${CONTAINER_REGISTRY}${CONTAINER_TAG}"
podman push "${CONTAINER_REGISTRY}${LATEST_TAG}"
fi
}
function upload-module() {
if test -z "$1"; then echo "\$1 is empty."; exit; fi
if test -z "$2"; then echo "\$2 is empty."; exit; fi
# Check if path is root folder
MODULES="$2"
if [ ! -f "$2/__manifest__.py" ]; then
echo "Identified as root folder"
MODULES="$MODULES/*"
fi
for MODULE in $MODULES; do
if [ -f "$MODULE/__manifest__.py" ]; then
# Create module zip
zip-module "$MODULE"
# Get path to zip file and upload url
FILE_PATH="tmp/$MODULE_NAME.zip"
load-env "$1"
NEXTCLOUD_UPLOAD_URL="$NEXTCLOUD_URL/remote.php/dav/files/$NEXTCLOUD_USERNAME/Odoo-Apps/"
# Upload zip file
curl -u "$NEXTCLOUD_USERNAME:$NEXTCLOUD_PASSWORD" -T "$FILE_PATH" "$NEXTCLOUD_UPLOAD_URL"
echo "File $FILE_PATH uploaded to $NEXTCLOUD_UPLOAD_URL."
UPLOADS+=" - name: $MODULE\n"
UPLOADS+=" version: $VERSION\n"
fi
done
echo "odoo_apps:"
echo -e "$UPLOADS"
}
function logs() {
$CONTAINER_ENGINE logs --follow odoo
}
# Script Commands
function install-odoo-scripts() {
curl -L https://raw.githubusercontent.com/mint-system/ansible-build/master/roles/odoo_scripts/files/install | bash
}
function upgrade-odoo() {
if test -z "$1"; then echo "\$1/database is empty."; exit; fi
if test -z "$2"; then echo "\$2/version is empty."; exit; fi
DATABASE="$1"
ODOO_TARGET_VERSION="$2"
MODE="test"
if [ -n "$3" ]; then
# Options: test, production
MODE="$3"
fi
NEW_DATABASE="${DATABASE}_${ODOO_TARGET_VERSION}"
echo "Execute Odoo upgrade script in $MODE mode for $DATABASE with version $ODOO_TARGET_VERSION."
echo "The database will be restored as $NEW_DATABASE."
export PGHOST=localhost
export PGUSER=odoo
export PGPASSWORD=odoo
python <(curl -s https://upgrade.odoo.com/upgrade) "$MODE" -d "$DATABASE" -t "$ODOO_TARGET_VERSION" -r "$NEW_DATABASE"
echo "Upgrade finished successfully."
}
# Install Commands
function install-native() {
init-venv
activate-venv
if [[ "$OS_RELEASE" =~ ^(Ubuntu|Debian|Pop!_OS)$ ]]; then
# Source: https://gist.github.com/faniska/37f896d5e9de5fee925925d7caf3cb9e
INSTALLED_VERSION=$(wkhtmltopdf --version 2>&1 | grep -Po '^wkhtmltopdf \K[\d.]+')
if [ "$INSTALLED_VERSION" != "0.12.4" ]; then
echo "Install wkhtmltopdf"
sudo apt remove wkhtmltopdf
wget https://github.com/wkhtmltopdf/wkhtmltopdf/releases/download/0.12.4/wkhtmltox-0.12.4_linux-generic-amd64.tar.xz
tar xvf wkhtmltox*.tar.xz
sudo mv wkhtmltox/bin/wkhtmlto* /usr/bin
rm -rf wkhtmltox wkhtmltox-0.12.4_linux-generic-amd64.tar.*
else
echo "wkhtmltopdf version is already 0.12.4"
fi
echo "Install python-ldap and psycopg2 build dependencies"
sudo apt-get install -y libsasl2-dev libldap2-dev libssl-dev libpq-dev python3-dev
echo "Install xmllint and gettext"
sudo apt install -y libxml2-utils gettext
elif [[ "$OS_RELEASE" =~ ^(Darwin)$ ]]; then
echo "Welcome daring Mac user. Let's try our best to get this working."
echo "Install wkhtmltopdf and some dev libraries"
echo "This will give a depreciation warning and you need to enter your sudo password."
brew install gettext wkhtmltopdf libsasl2 openldap openssl libxml2
echo "Install the binary version of psycopg2"
uv pip install psycopg2-binary --force
echo "Add LDFLAGS to .env file"
if ! grep -qxF 'LDFLAGS=-L/opt/homebrew/lib/' .env; then
echo '' >> .env
echo 'LDFLAGS=-L/opt/homebrew/lib/' >> .env
fi
else
echo "The operating system $OS_RELEASE is not supported."
exit 1
fi
echo "Install Odoo development tools"
uv pip install ${PYTHON_NOTIFY}
uv pip install -r requirements.txt
if [ -f "odoo/requirements.txt" ]; then
echo "Install Odoo dependencies"
uv pip install -r odoo/requirements.txt
echo "Configure Odoo as python package"
uv pip install pip
pip install -e odoo
fi
}
# Process Commands
function open-url-with-delay(){
if test -z "$1"; then echo "\$1 is empty."; exit; fi
if $BROWSER_OPEN; then
sleep 2
$OS_OPEN "$1"
fi
}
function start() {
activate-venv
set-addons-path
template-docker-compose
# Use default database if second param is not given
DATABASE="$2"
if [ -z "$2" ]; then
DATABASE="$ODOO_DATABASE"
fi
if [ -z "$1" ] ; then
echo "Start all container ${CONTAINER_REGISTRY}${CONTAINER_TAG}"
echo "Open http://localhost:8069 url in your browser."
$COMPOSE_COMMAND up -d
fi
if [[ "$1" =~ "db" ]]; then
$COMPOSE_COMMAND up -d db
fi
if [[ "$1" =~ "admin" ]]; then
echo "Open http://localhost:8000 url in your browser."
open-url-with-delay "http://localhost:8000" & $COMPOSE_COMMAND up -d admin
fi
if [[ "$1" =~ "odoo" ]]; then
echo "Start Odoo container ${CONTAINER_REGISTRY}${CONTAINER_TAG}"
echo "Open http://localhost:8069 url in your browser."
open-url-with-delay "http://localhost:8069" & $COMPOSE_COMMAND up -d odoo
fi
if [[ "$1" =~ "native" ]]; then
activate-venv
template-odoo-rc
PORT=8069
while [ $PORT -le 8079 ]; do
if ! lsof -i:$PORT >/dev/null 2>&1; then
break
fi
PORT=$((PORT + 1))
done
export ODOO_BASE_URL="http://localhost:8069"
echo "Open http://localhost:$PORT url in your browser."
open-url-with-delay "http://localhost:$PORT/web?debug=1&db=$DATABASE" &
odoo --database="$DATABASE" --config "$ODOO_RC" --xmlrpc-port="$PORT" --addons-path="$ADDONS_PATH" --dev=all --log-level="$LOG_LEVEL"
fi
if [[ "$1" =~ "queue" ]]; then
activate-venv
PORT=8069
echo "Open http://localhost:$PORT url in your browser."
open-url-with-delay "http://localhost:$PORT/web?debug=1&db=$DATABASE" &
odoo --database="$DATABASE" --config "$ODOO_RC" --xmlrpc-port="$PORT" --gevent-port=8072 --load=web,queue_job --workers=4 --addons-path="$ADDONS_PATH" --dev=all --log-level="$LOG_LEVEL" --log-handler=odoo.addons.queue_job:DEBUG
fi
if [[ "$1" =~ "mail" ]]; then
echo "Open http://localhost:8025 url in your browser."
open-url-with-delay "http://localhost:8025" & $COMPOSE_COMMAND up -d mail
fi
}
function run() {
if test -z "$1"; then echo "\$1 is empty."; exit; fi
if test -z "$2"; then echo "\$2 is empty."; exit; fi
activate-venv
template-docker-compose
echo "Run '$1' container with command '$2'."
$COMPOSE_COMMAND run --rm "$1" "$2"
}
function remove() {
activate-venv
template-docker-compose
if test -z "$1"; then
$COMPOSE_COMMAND down -v
fi
if [[ "$1" =~ "db" ]]; then
$COMPOSE_COMMAND rm -f -s -v db
fi
if [[ "$1" =~ "admin" ]]; then
$COMPOSE_COMMAND rm -f -s -v admin
fi
if [[ "$1" =~ "odoo" ]]; then
$COMPOSE_COMMAND rm -f -s -v odoo
fi
if [[ "$1" =~ "mail" ]]; then
$COMPOSE_COMMAND rm -f -s -v mail
fi
}
function restart() {
activate-venv
template-docker-compose
if test -z "$1"; then
$COMPOSE_COMMAND restart
fi
if [[ "db|mail|odoo" =~ $1 ]]; then
$COMPOSE_COMMAND restart "$1"
fi
}
function stop() {
activate-venv
template-docker-compose
if test -z "$1"; then
$COMPOSE_COMMAND stop
fi
$COMPOSE_COMMAND stop "$1"
}
function test-container() {
if [ "$1" = "clean" ]; then
echo "Cleanup test environment."
drop-db test
remove odoo