You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

4560 lines
150 KiB

  1. #!/bin/bash
  2. ##
  3. ## TODO:
  4. ## - subordinate container should really be able to modify base image of their master
  5. ## - this could be done through docker-update
  6. ## - I'm not happy with the current build using 'build/' directory, this should be
  7. ## changed to:
  8. ## - always have a base image (specified in metadata), and always have hooks/install
  9. ## executed and merge in image (like docker-build-charm).
  10. ## - container base image is ALWAYS the image of the master container... this brings
  11. ## questions about a double way to express inheritage (through relations as it is
  12. ## implemented now, or through this base-image ?)
  13. ## - the name of the scripts for relation (aka relation_name-relation-joined) is bad as
  14. ## reading the name in a hooks/ dir, there are no way to know if we are the target or
  15. ## the base of the relation.
  16. ## - we could leverage a 'relations/' dir on the root of the charm, with both:
  17. ## 'relations/provide/relation_name' and 'relations/receive/relation_name'
  18. ## - a very bad point with the actual naming is that we can't have a providing AND
  19. ## receiving a relation with same name.
  20. ## - The cache system should keep md5 of docker-compose and other things between runs
  21. ## - The cache system should use underlying function that have only arguments inputs.
  22. ## This will allow to cache completely without issues function in time.
  23. ## - would probably need instrospection in charm custom action to know if these need
  24. ## init or relations to be set up.
  25. ## - Be clear about when the SERVICE name is used and the CHARM name is used.
  26. ## - in case of service contained in another container
  27. ## - in normal case
  28. ## - in docker-compose, can't use charm name: if we want 2 instances of the same charm
  29. ## we are stuck. What will be unique is the name of the service.
  30. ## - some relations are configured in compose.yml but should not trigger the loading
  31. ## of necessary component (for instance, apache --> log-rotate), if log-rotate is
  32. ## not there, this link should considered optional.
  33. ## - Could probably allow an unexistent charm to be populated with only "docker-image:"
  34. ## of the same name. Although this should trigger a visible warning.
  35. #:-
  36. [ -e /etc/shlib ] && . /etc/shlib || {
  37. echo "Unsatisfied dependency. Please install 'kal-shlib-core'."
  38. exit 1
  39. }
  40. #:-
  41. include common
  42. include pretty
  43. include parse
  44. include charm
  45. include array
  46. include cla
  47. include docker
  48. depends shyaml docker
  49. exname="compose"
  50. version=0.1
  51. usage="$exname [COMPOSE_OPTS] [ACTION [ACTION_OPTS]]"
  52. help="\
  53. $WHITE$exname$NORMAL jobs is to run various shell scripts to build
  54. a running orchestrated and configured docker containers. These shell
  55. scripts will have the opportunity to build a 'docker-compose.yml'.
  56. Once init script and relations scripts are executed, $WHITE$exname$NORMAL
  57. delegate the launching to ${WHITE}docker-compose${NORMAL} by providing it
  58. the final 'docker-compose.yml'.
  59. $WHITE$exname$NORMAL also leverage charms to offer some additional custom
  60. actions per charm, which are simply other scripts that can be
  61. run without launching ${WHITE}docker-compose${NORMAL}.
  62. In compose message, color coding is enforced as such:
  63. - ${DARKCYAN}action$NORMAL,
  64. - ${DARKBLUE}relation$NORMAL,
  65. - ${DARKPINK}charm${NORMAL},
  66. - ${DARKYELLOW}service${NORMAL},
  67. - ${WHITE}option-name${NORMAL}/${WHITE}command-name${NORMAL}/${WHITE}Section-Title${NORMAL}
  68. $WHITE$exname$NORMAL reads '/etc/compose.conf' for global variables, and
  69. '/etc/compose.local.conf' for local host adjustements.
  70. "
  71. ## XXXvlab: this doesn't seem to work when 'compose' is called in
  72. ## a hook of a charm.
  73. #[[ "${BASH_SOURCE[0]}" == "" ]] && SOURCED=true
  74. $(return >/dev/null 2>&1) && SOURCED=true
  75. errlvl() { return "${1:-1}"; }
  76. export -f errlvl
  77. if [ "$UID" == 0 ]; then
  78. CACHEDIR=${CACHEDIR:-/var/cache/compose}
  79. VARDIR=${VARDIR:-/var/lib/compose}
  80. else
  81. [ "$XDG_CONFIG_HOME" ] && CACHEDIR=${CACHEDIR:-$XDG_CONFIG_HOME/compose}
  82. [ "$XDG_DATA_HOME" ] && VARDIR=${VARDIR:-$XDG_DATA_HOME/compose}
  83. CACHEDIR=${CACHEDIR:-$HOME/.cache/compose}
  84. VARDIR=${VARDIR:-$HOME/.local/share/compose}
  85. fi
  86. export VARDIR CACHEDIR
  87. md5_compat() { md5sum | cut -c -32; }
  88. quick_cat_file() { quick_cat_stdin < "$1"; }
  89. quick_cat_stdin() { local IFS=''; while read -r line; do echo "$line"; done ; }
  90. export -f quick_cat_file quick_cat_stdin md5_compat
  91. clean_cache() {
  92. local i=0
  93. for f in $(ls -t "$CACHEDIR/"*.cache.* 2>/dev/null | tail -n +500); do
  94. ((i++))
  95. rm -f "$f"
  96. done
  97. if (( i > 0 )); then
  98. debug "${WHITE}Cleaned cache:${NORMAL} Removed $((i)) elements (current cache size is $(du -sh "$CACHEDIR" | cut -f 1))"
  99. fi
  100. }
  101. export DEFAULT_COMPOSE_FILE
  102. ##
  103. ## Merge YAML files
  104. ##
  105. export _merge_yaml_common_code="
  106. import sys
  107. import yaml
  108. try:
  109. from yaml import CSafeLoader as SafeLoader, CSafeDumper as SafeDumper
  110. except ImportError: ## pragma: no cover
  111. sys.stderr.write('YAML code in pure python\n')
  112. exit(1)
  113. from yaml import SafeLoader, SafeDumper
  114. class MySafeLoader(SafeLoader): pass
  115. class MySafeDumper(SafeDumper): pass
  116. try:
  117. # included in standard lib from Python 2.7
  118. from collections import OrderedDict
  119. except ImportError:
  120. # try importing the backported drop-in replacement
  121. # it's available on PyPI
  122. from ordereddict import OrderedDict
  123. ## Ensure that there are no collision with legacy OrderedDict
  124. ## that could be used for omap for instance.
  125. class MyOrderedDict(OrderedDict):
  126. pass
  127. MySafeDumper.add_representer(
  128. MyOrderedDict,
  129. lambda cls, data: cls.represent_dict(data.items()))
  130. def construct_omap(cls, node):
  131. cls.flatten_mapping(node)
  132. return MyOrderedDict(cls.construct_pairs(node))
  133. MySafeLoader.add_constructor(
  134. yaml.resolver.BaseResolver.DEFAULT_MAPPING_TAG,
  135. construct_omap)
  136. ##
  137. ## Support local and global objects
  138. ##
  139. class EncapsulatedNode(object): pass
  140. def mk_encapsulated_node(s, node):
  141. method = 'construct_%s' % (node.id, )
  142. data = getattr(s, method)(node)
  143. class _E(data.__class__, EncapsulatedNode):
  144. pass
  145. _E.__name__ = str(node.tag)
  146. _E._node = node
  147. return _E(data)
  148. def represent_encapsulated_node(s, o):
  149. value = s.represent_data(o.__class__.__bases__[0](o))
  150. value.tag = o.__class__.__name__
  151. return value
  152. MySafeDumper.add_multi_representer(EncapsulatedNode,
  153. represent_encapsulated_node)
  154. MySafeLoader.add_constructor(None, mk_encapsulated_node)
  155. def fc(filename):
  156. with open(filename) as f:
  157. return f.read()
  158. def merge(*args):
  159. # sys.stderr.write('%r\n' % (args, ))
  160. args = [arg for arg in args if arg is not None]
  161. if len(args) == 0:
  162. return None
  163. if len(args) == 1:
  164. return args[0]
  165. if all(isinstance(arg, (int, basestring, bool, float)) for arg in args):
  166. return args[-1]
  167. elif all(isinstance(arg, list) for arg in args):
  168. res = []
  169. for arg in args:
  170. for elt in arg:
  171. if elt in res:
  172. res.remove(elt)
  173. res.append(elt)
  174. return res
  175. elif all(isinstance(arg, dict) for arg in args):
  176. keys = set()
  177. for arg in args:
  178. keys |= set(arg.keys())
  179. dct = {}
  180. for key in keys:
  181. sub_args = []
  182. for arg in args:
  183. if key in arg:
  184. sub_args.append(arg)
  185. try:
  186. dct[key] = merge(*(a[key] for a in sub_args))
  187. except NotImplementedError as e:
  188. raise NotImplementedError(
  189. e.args[0],
  190. '%s.%s' % (key, e.args[1]) if e.args[1] else key,
  191. e.args[2])
  192. if dct[key] is None:
  193. del dct[key]
  194. return dct
  195. else:
  196. raise NotImplementedError(
  197. 'Unsupported types: %s'
  198. % (', '.join(list(set(arg.__class__.__name__ for arg in args)))), '', args)
  199. return None
  200. def merge_cli(*args):
  201. try:
  202. c = merge(*args)
  203. except NotImplementedError as e:
  204. sys.stderr.write('Merging Failed: %s.\n%s\n'
  205. ' Values are:\n %s\n'
  206. % (e.args[0],
  207. ' Conflicting key is %r.' % e.args[1] if e.args[1] else
  208. ' Conflict at base of structure.',
  209. '\\n '.join('v%d: %r' % (i, a)
  210. for i, a in enumerate(e.args[2]))))
  211. exit(1)
  212. if c is not None:
  213. print '%s' % yaml.dump(c, default_flow_style=False, Dumper=MySafeDumper)
  214. "
  215. merge_yaml() {
  216. if ! [ -r "$state_tmpdir/merge_yaml.py" ]; then
  217. cat <<EOF > "$state_tmpdir/merge_yaml.py"
  218. $_merge_yaml_common_code
  219. merge_cli(*(yaml.load(fc(f), Loader=MySafeLoader) for f in sys.argv[1:]))
  220. EOF
  221. fi
  222. python "$state_tmpdir/merge_yaml.py" "$@"
  223. }
  224. export -f merge_yaml
  225. merge_yaml_str() {
  226. local entries="$@"
  227. if ! [ -r "$state_tmpdir/merge_yaml_str.py" ]; then
  228. cat <<EOF > "$state_tmpdir/merge_yaml_str.py" || return 1
  229. $_merge_yaml_common_code
  230. merge_cli(*(yaml.load(f, Loader=MySafeLoader) for f in sys.argv[1:]))
  231. EOF
  232. fi
  233. if ! python "$state_tmpdir/merge_yaml_str.py" "$@"; then
  234. err "Failed to merge yaml strings:"
  235. local s
  236. for s in "$@"; do
  237. printf " - \n"
  238. printf "%s\n" "$s" | prefix " ${GRAY}|$NORMAL "
  239. done >&2
  240. return 1
  241. fi
  242. }
  243. export -f merge_yaml_str
  244. yaml_get_values() {
  245. local sep=${1:-$'\n'} value input type first elt
  246. input=$(cat -)
  247. if [ -z "$input" ] || [ "$input" == "None" ]; then
  248. return 0
  249. fi
  250. type=$(e "$input" | shyaml get-type)
  251. value=
  252. case "$type" in
  253. "sequence")
  254. first=1
  255. while read-0 elt; do
  256. elt="$(e "$elt" | yaml_get_interpret)" || return 1
  257. [ "$elt" ] || continue
  258. if [ "$first" ]; then
  259. first=
  260. else
  261. value+="$sep"
  262. fi
  263. first=
  264. value+="$elt"
  265. done < <(e "$input" | shyaml -y get-values-0)
  266. ;;
  267. "struct")
  268. while read-0 val; do
  269. value+=$'\n'"$(e "$val" | yaml_get_interpret)" || return 1
  270. done < <(e "$input" | shyaml -y values-0)
  271. ;;
  272. "NoneType")
  273. value=""
  274. ;;
  275. "str"|*)
  276. value+="$(e "$input" | yaml_get_interpret)"
  277. ;;
  278. esac
  279. e "$value"
  280. }
  281. export -f yaml_get_values
  282. yaml_key_val_str() {
  283. local entries="$@"
  284. if ! [ -r "$state_tmpdir/yaml_key_val_str.py" ]; then
  285. cat <<EOF > "$state_tmpdir/yaml_key_val_str.py"
  286. $_merge_yaml_common_code
  287. print '%s' % yaml.dump(
  288. {
  289. yaml.load(sys.argv[1], Loader=MySafeLoader):
  290. yaml.load(sys.argv[2], Loader=MySafeLoader)
  291. },
  292. default_flow_style=False,
  293. Dumper=MySafeDumper,
  294. )
  295. EOF
  296. fi
  297. python "$state_tmpdir/yaml_key_val_str.py" "$@"
  298. }
  299. export -f yaml_key_val_str
  300. ##
  301. ## Docker
  302. ##
  303. docker_has_image() {
  304. local image="$1"
  305. images=$(docker images -q "$image" 2>/dev/null) || {
  306. err "docker images call has failed unexpectedly."
  307. return 1
  308. }
  309. [ -n "$images" ]
  310. }
  311. export -f docker_has_image
  312. docker_image_id() {
  313. local image="$1"
  314. image_id=$(docker inspect "$image" --format='{{.Id}}') || return 1
  315. echo "$image_id" # | tee "$cache_file"
  316. }
  317. export -f docker_image_id
  318. cached_cmd_on_image() {
  319. local image="$1" cache_file
  320. image_id=$(docker_image_id "$image") || return 1
  321. cache_file="$CACHEDIR/$FUNCNAME.cache.$(echo "$*" | md5_compat)"
  322. if [ -e "$cache_file" ]; then
  323. # debug "$FUNCNAME: cache hit ($*)"
  324. quick_cat_stdin < "$cache_file"
  325. return 0
  326. fi
  327. shift
  328. out=$(docker run -i --rm --entrypoint /bin/sh "$image_id" -c "$*") || return 1
  329. echo "$out" | tee "$cache_file"
  330. }
  331. export -f cached_cmd_on_image
  332. cmd_on_base_image() {
  333. local service="$1" base_image
  334. shift
  335. base_image=$(service_base_docker_image "$service") || return 1
  336. docker run -i --rm --entrypoint /bin/bash "$base_image" -c "$*"
  337. }
  338. export -f cmd_on_base_image
  339. cached_cmd_on_base_image() {
  340. local service="$1" base_image cache_file="$state_tmpdir/$FUNCNAME.cache.$(printf "%s\0" "$@" | md5_compat)"
  341. shift
  342. if [ -e "$cache_file" ]; then
  343. # debug "$FUNCNAME: cache hit ($*)"
  344. quick_cat_stdin < "$cache_file"
  345. return 0
  346. fi
  347. base_image=$(service_base_docker_image "$service") || return 1
  348. if ! docker_has_image "$base_image"; then
  349. docker pull "$base_image" 1>&2
  350. fi
  351. result=$(cached_cmd_on_image "$base_image" "$@") || return 1
  352. echo "$result" | tee "$cache_file"
  353. }
  354. export -f cached_cmd_on_base_image
  355. docker_update() {
  356. ## YYY: warning, we a storing important information in cache, cache can
  357. ## be removed.
  358. ## We want here to cache the last script on given service whatever that script was
  359. local service="$1" script="$2" cache_file="$CACHEDIR/$FUNCNAME.cache.$1" \
  360. previous_base_image stored_image_id
  361. shift
  362. shift
  363. ## this will build it if necessary
  364. base_image=$(service_base_docker_image "$service") || return 1
  365. ## XXXvlab: there are probably ways to avoid rebuilding that each time
  366. image_id="$(docker_image_id "$base_image")" || return 1
  367. if [ -e "$cache_file" ]; then
  368. info "Cache file exists"
  369. read-0 previous_base_image stored_image_id < <(cat "$cache_file")
  370. info "previous: $previous_base_image"
  371. info "stored: $stored_image_id"
  372. else
  373. info "No cache file $cache_file"
  374. previous_base_image=""
  375. fi
  376. if [ "$previous_base_image" -a "$stored_image_id" == "$image_id" ]; then
  377. info "Resetting $base_image to $previous_base_image"
  378. docker tag "$previous_base_image" "$base_image" || return 1
  379. image_id="$(docker_image_id "$base_image")" || return 1
  380. else
  381. previous_base_image="$image_id"
  382. fi
  383. info "Updating base image: $base_image (hash: $image_id)"
  384. echo "$script" | dupd --debug -u "$base_image" -- "$@" || {
  385. err "Failed updating base image"
  386. return 1
  387. }
  388. new_image_id="$(docker_image_id "$base_image")"
  389. [ "$new_image_id" == "$previous_base_image" ] && {
  390. err "Image was not updated correctly (same id)."
  391. return 1
  392. }
  393. printf "%s\0" "$previous_base_image" "$new_image_id" > "$cache_file"
  394. info "Wrote cache file $cache_file"
  395. }
  396. export -f docker_update
  397. image_exposed_ports_0() {
  398. local image="$1"
  399. docker inspect --format='{{range $p, $conf := .Config.ExposedPorts}}{{$p}}{{"\x00"}}{{end}}' "$image"
  400. }
  401. export -f image_exposed_ports_0
  402. ## feature not yet included in docker: https://github.com/moby/moby/issues/16079
  403. docker_image_export_dir() {
  404. local image="$1" src="$2" dst="$3" container_id
  405. (
  406. container_id=$(docker create "$image") || exit 1
  407. trap_add EXIT,ERR "docker rm \"$container_id\" >/dev/null"
  408. docker cp "$container_id":"$src" "$dst"
  409. )
  410. }
  411. export -f docker_image_export_dir
  412. service_base_image_export_dir() {
  413. local service="$1" src="$2" dst="$3" base_image
  414. shift
  415. base_image=$(service_base_docker_image "$service") || return 1
  416. if ! docker_has_image "$base_image"; then
  417. docker pull "$base_image"
  418. fi
  419. docker_image_export_dir "$base_image" "$src" "$dst"
  420. }
  421. export -f service_base_image_export_dir
  422. service_base_image_id() {
  423. local service="$1" src="$2" dst="$3" base_image
  424. shift
  425. base_image=$(service_base_docker_image "$service") || return 1
  426. if ! docker_has_image "$base_image"; then
  427. docker pull "$base_image"
  428. fi
  429. docker inspect "$base_image" --format="{{ .Id }}"
  430. }
  431. export -f service_base_image_id
  432. ##
  433. ## Generic
  434. ##
  435. fn.exists() {
  436. declare -F "$1" >/dev/null
  437. }
  438. str_pattern_matches() {
  439. local str="$1"
  440. shift
  441. for pattern in "$@"; do
  442. eval "[[ \"$str\" == $pattern ]]" && return 0
  443. done
  444. return 1
  445. }
  446. str_matches() {
  447. local str="$1"
  448. shift
  449. for pattern in "$@"; do
  450. [[ "$str" == "$pattern" ]] && return 0
  451. done
  452. return 1
  453. }
  454. gen_password() {
  455. local l=( {a..z} {A..Z} {0..9} ) nl="${#l[@]}" size=${1:-16}
  456. while ((size--)); do
  457. echo -n "${l[$((RANDOM * nl / 32768))]}"
  458. done
  459. echo
  460. }
  461. export -f gen_password
  462. file_put() {
  463. local TARGET="$1"
  464. mkdir -p "$(dirname "$TARGET")" &&
  465. cat - > "$TARGET"
  466. }
  467. export -f file_put
  468. file_put_0() {
  469. local TARGET="$1"
  470. mkdir -p "$(dirname "$TARGET")" &&
  471. cat > "$TARGET"
  472. }
  473. export -f file_put_0
  474. fetch_file() {
  475. local src="$1"
  476. case "$src" in
  477. *"://"*)
  478. err "Unsupported target scheme."
  479. return 1
  480. ;;
  481. *)
  482. ## Try direct
  483. if ! [ -r "$src" ]; then
  484. err "File '$src' not found/readable."
  485. return 1
  486. fi
  487. cat "$src" || return 1
  488. ;;
  489. esac
  490. }
  491. export -f fetch_file
  492. ## receives stdin content to decompress on stdout
  493. ## stdout content should be tar format.
  494. uncompress_file() {
  495. local filename="$1"
  496. ## Warning, the content of the file is already as stdin, the filename
  497. ## is there to hint for correct decompression.
  498. case "$filename" in
  499. *".gz")
  500. gunzip
  501. ;;
  502. *".bz2")
  503. bunzip2
  504. ;;
  505. *)
  506. cat
  507. ;;
  508. esac
  509. }
  510. export -f uncompress_file
  511. get_file() {
  512. local src="$1"
  513. fetch_file "$src" | uncompress_file "$src"
  514. }
  515. export -f get_file
  516. ##
  517. ## Common database lib
  518. ##
  519. _clean_docker() {
  520. local _DB_NAME="$1" container_id="$2"
  521. (
  522. set +e
  523. debug "Removing container $_DB_NAME"
  524. docker stop "$container_id"
  525. docker rm "$_DB_NAME"
  526. docker network rm "${_DB_NAME}"
  527. rm -vf "$state_tmpdir/${_DB_NAME}.state"
  528. ) >&2
  529. }
  530. export -f _clean_docker
  531. get_service_base_image_dir_uid_gid() {
  532. local service="$1" dir="$2" uid_gid
  533. uid_gid=$(cached_cmd_on_base_image "$service" "stat -c '%u %g' '$dir'") || {
  534. debug "Failed to query '$dir' uid in ${DARKYELLOW}$service${NORMAL} base image."
  535. return 1
  536. }
  537. info "uid and gid from ${DARKYELLOW}$service${NORMAL}:$dir is '$uid_gid'"
  538. echo "$uid_gid"
  539. }
  540. export -f get_service_base_image_dir_uid_gid
  541. get_service_type() {
  542. local service="$1" cache_file="$state_tmpdir/$FUNCNAME.cache.$1"
  543. if [ -z "$service" ]; then
  544. print_syntax_error "$FUNCNAME: Please specify a service as first argument."
  545. return 1
  546. fi
  547. if [ -e "$cache_file" ]; then
  548. # debug "$FUNCNAME: cache hit ($*)"
  549. cat "$cache_file"
  550. return 0
  551. fi
  552. charm=$(get_service_charm "$service") || return 1
  553. metadata=$(charm.metadata "$charm") || return 1
  554. printf "%s" "$metadata" | shyaml get-value type service 2>/dev/null |
  555. tee "$cache_file"
  556. }
  557. are_files_locked_in_dir() {
  558. local dir="$1" device hdev ldev
  559. device=$(stat -c %d "$dir") || {
  560. err "Can't stat '$dir'."
  561. return 1
  562. }
  563. device=$(printf "%04x" $device)
  564. hdev=${device:0:2}
  565. ldev=${device:2:2}
  566. inodes=$(find "$dir" -printf ':%i:\n')
  567. found=
  568. while read -r inode; do
  569. debug "try inode:$inode"
  570. if [[ "$inodes" == *":$inode:"* ]]; then
  571. found=1
  572. break
  573. fi
  574. done < <(cat /proc/locks | grep " $hdev:$ldev:" | sed -r "s/^.*$hdev:$ldev:([0-9]+).*$/\1/g")
  575. [ "$found" ]
  576. }
  577. export -f are_files_locked_in_dir
  578. set_db_params() {
  579. local docker_ip="$1" docker_network="$2"
  580. if [ -z "$DB_PARAMS_LOADED" ]; then
  581. DB_PARAMS_LOADED=1
  582. _set_db_params "$docker_ip" "$docker_network"
  583. fi
  584. }
  585. export -f set_db_params
  586. export _PID="$$"
  587. ensure_db_docker_running () {
  588. local _STATE_FILE errlvl
  589. _DB_NAME="db_${DB_NAME}_${_PID}"
  590. _STATE_FILE="$state_tmpdir/${_DB_NAME}.state"
  591. if [ -e "$_STATE_FILE" ]; then
  592. IFS=: read DOCKER_NETWORK DOCKER_IP <<<"$(cat "$_STATE_FILE")"
  593. debug "Re-using previous docker/connection '$DOCKER_IP'."
  594. set_db_params "$DOCKER_IP" "$DOCKER_NETWORK"
  595. return 0
  596. fi
  597. if [ -e "$state_tmpdir/${_DB_NAME}.working" ]; then
  598. ## avoid recursive calls.
  599. if [ -z "$DOCKER_IP" ]; then
  600. err "Currently figuring up DOCKER_IP, please set it yourself before this call if needed."
  601. return 1
  602. else
  603. debug "ignoring recursive call of 'ensure_db_docker_running'."
  604. fi
  605. return 0
  606. fi
  607. touch "$state_tmpdir/${_DB_NAME}.working"
  608. docker rm "$_DB_NAME" 2>/dev/null || true
  609. host_db_working_dir="$HOST_DATASTORE/${SERVICE_NAME}$DB_DATADIR"
  610. if is_db_locked; then
  611. info "Some process is using '$host_db_working_dir'. Trying to find a docker that would do this..."
  612. found=
  613. for docker_id in $(docker ps -q); do
  614. has_volume_mounted=$(
  615. docker inspect \
  616. --format "{{range .Mounts}}{{if eq .Destination \"$DB_DATADIR\"}}{{.Source}}{{end}}{{end}}" \
  617. "$docker_id")
  618. if [ "$has_volume_mounted" == "$host_db_working_dir" ]; then
  619. found="$docker_id"
  620. break
  621. fi
  622. done
  623. if [ -z "$found" ]; then
  624. err "Please shutdown any other docker using this directory."
  625. return 1
  626. fi
  627. export container_id="$found"
  628. info "Found docker $docker_id is already running."
  629. else
  630. verb "Database is not locked."
  631. if ! docker_has_image "$DOCKER_BASE_IMAGE"; then
  632. docker pull "$DOCKER_BASE_IMAGE"
  633. fi
  634. _set_server_db_params || return 1
  635. debug docker network create "$_DB_NAME"
  636. if ! network_id=$(docker network create "$_DB_NAME"); then
  637. err "'docker network create $_DB_NAME' failed !"
  638. _clean_docker "$_DB_NAME" "$container_id"
  639. rm "$state_tmpdir/${_DB_NAME}.working"
  640. return 1
  641. fi
  642. debug docker run -d \
  643. --name "$_DB_NAME" \
  644. "${server_docker_opts[@]}" \
  645. --network "$_DB_NAME" \
  646. -v "$host_db_working_dir:$DB_DATADIR" \
  647. "$DOCKER_BASE_IMAGE"
  648. if ! container_id=$(
  649. docker run -d \
  650. --name "$_DB_NAME" \
  651. "${server_docker_opts[@]}" \
  652. --network "$_DB_NAME" \
  653. -v "$host_db_working_dir:$DB_DATADIR" \
  654. "$DOCKER_BASE_IMAGE"
  655. ); then
  656. err "'docker run' failed !"
  657. _clean_docker "$_DB_NAME" "$container_id"
  658. rm "$state_tmpdir/${_DB_NAME}.working"
  659. return 1
  660. fi
  661. trap_add EXIT,ERR "_clean_docker \"$_DB_NAME\" \"$container_id\""
  662. fi
  663. if docker_ip=$(wait_for_docker_ip "$container_id"); then
  664. IFS=: read DOCKER_NETWORK DOCKER_IP <<<"$docker_ip"
  665. echo "$docker_ip" > "$_STATE_FILE"
  666. debug "written '$_STATE_FILE'"
  667. rm "$state_tmpdir/${_DB_NAME}.working"
  668. set_db_params "$DOCKER_IP" "$DOCKER_NETWORK"
  669. return 0
  670. else
  671. errlvl="$?"
  672. err "Db not found (errlvl: $errlvl). Tail of docker logs follows:"
  673. docker logs --tail=5 "$container_id" 2>&1 | prefix " | " >&2
  674. rm "$state_tmpdir/${_DB_NAME}.working"
  675. return "$errlvl"
  676. fi
  677. }
  678. export -f ensure_db_docker_running
  679. ## Require to set $db_docker_opts if needed, and $DB_PASSFILE
  680. ##
  681. _dcmd() {
  682. local docker_opts command="$1"
  683. shift
  684. debug "Db> $command $@"
  685. if [ "$HOST_DB_PASSFILE" -a -f "$LOCAL_DB_PASSFILE" -a "$CLIENT_DB_PASSFILE" ]; then
  686. verb "Found and using '$HOST_DB_PASSFILE' as '$CLIENT_DB_PASSFILE'."
  687. docker_opts=("${db_docker_opts[@]}" "-v" "$HOST_DB_PASSFILE:$CLIENT_DB_PASSFILE")
  688. else
  689. docker_opts=("${db_docker_opts[@]}")
  690. fi
  691. ## XXXX was here: actualy, we need only connection between this version and the client version
  692. debug docker run -i --rm \
  693. "${docker_opts[@]}" \
  694. --entrypoint "$command" "$DOCKER_BASE_IMAGE" "${db_cmd_opts[@]}" "$@"
  695. docker run -i --rm \
  696. "${docker_opts[@]}" \
  697. --entrypoint "$command" "$DOCKER_BASE_IMAGE" "${db_cmd_opts[@]}" "$@"
  698. }
  699. export -f _dcmd
  700. ## Executes code through db
  701. dcmd() {
  702. local fun
  703. [ "$DB_NAME" ] || print_syntax_error "$FUNCNAME: You must provide \$DB_NAME."
  704. [ "$DB_DATADIR" ] || print_syntax_error "$FUNCNAME: You must provide \$DB_DATADIR."
  705. # [ "$DB_PASSFILE" ] || print_syntax_error "$FUNCNAME: You must provide \$DB_PASSFILE."
  706. [ "$_PID" ] || print_syntax_error "$FUNCNAME: You must provide \$_PID."
  707. for fun in is_db_locked _set_db_params ddb; do
  708. [ "$(type -t "$fun")" == "function" ] ||
  709. print_syntax_error "$FUNCNAME: You must provide function '$fun'."
  710. done
  711. ensure_db_docker_running </dev/null || return 1
  712. _dcmd "$@"
  713. }
  714. export -f dcmd
  715. get_docker_ips() {
  716. local name="$1" ip format network_id
  717. if ! docker inspect --format='{{ .NetworkSettings.Networks }}' "$name" >/dev/null 2>&1; then
  718. echo "default:$(docker inspect --format='{{ .NetworkSettings.IPAddress }}' "$name" 2>/dev/null)"
  719. else
  720. format='{{range $name, $conf := .NetworkSettings.Networks}}{{$name}}{{"\x00"}}{{$conf.IPAddress}}{{"\x00"}}{{end}}'
  721. while read-0 network_id ip; do
  722. printf "%s:%s\n" "$network_id" "$ip"
  723. done < <(docker inspect --format="$format" "$name")
  724. fi
  725. }
  726. export -f get_docker_ips
  727. get_docker_ip() {
  728. local name="$1"
  729. get_docker_ips "$name"
  730. }
  731. export -f get_docker_ip
  732. wait_docker_ip() {
  733. local name="$1" timeout="${2:-15}" timeout_count=0 docker_ip=
  734. start=$SECONDS
  735. while [ -z "$docker_ip" ]; do
  736. sleep 0.5
  737. docker_ip=$(get_docker_ip "$name") && break
  738. elapsed=$((SECONDS - start))
  739. if ((elapsed > timeout)); then
  740. err "${RED}timeout error${NORMAL}(${timeout}s):" \
  741. "Could not find '$name' docker container's IP."
  742. return 1
  743. fi
  744. [ "$elapsed" == "$old_elapsed" ] ||
  745. verb "Waiting for docker $name... ($elapsed/$timeout)"
  746. old_elapsed="$elapsed"
  747. done
  748. verb "Found docker $name network and IP: $docker_ip"
  749. echo "$docker_ip"
  750. }
  751. export -f wait_docker_ip
  752. wait_for_tcp_port() {
  753. local network=$1 host_port=$2 timeout=${3:-60}
  754. verb "Trying to connect to $host_port"
  755. bash_image=${DEFAULT_BASH_IMAGE:-docker.0k.io/bash}
  756. #echo docker run --rm -i --network "$network" "$bash_image" >&2
  757. docker run --rm -i --network "$network" "$bash_image" <<EOF
  758. start=\$SECONDS
  759. while true; do
  760. timeout 1 bash -c "</dev/tcp/${host_port/://}" >/dev/null 2>&1 && break
  761. sleep 0.2
  762. if [ "\$((SECONDS - start))" -gt "$timeout" ]; then
  763. exit 1
  764. fi
  765. done
  766. exit 0
  767. EOF
  768. if [ "$?" != 0 ]; then
  769. err "${RED}timeout error${NORMAL}(${timeout}s):"\
  770. "Could not connect to $host_port."
  771. return 1
  772. fi
  773. return 0
  774. }
  775. export -f wait_for_tcp_port
  776. ## Warning: requires a ``ddb`` matching current database to be checked
  777. wait_for_docker_ip() {
  778. local name=$1 DOCKER_IP= DOCKER_NETWORK= docker_ips= docker_ip= elapsed timeout=10
  779. docker_ip=$(wait_docker_ip "$name" 5) || return 1
  780. IFS=: read DOCKER_NETWORK DOCKER_IP <<<"$docker_ip"
  781. if ! str_is_ipv4 "$DOCKER_IP"; then
  782. err "internal 'wait_docker_ip' did not return a valid IP. Returned IP is '$DOCKER_IP'."
  783. return 1
  784. fi
  785. set_db_params "$DOCKER_IP" "$DOCKER_NETWORK"
  786. while read-0 port; do
  787. IFS="/" read port type <<<"$port"
  788. [ "$type" == "tcp" ] || continue
  789. wait_for_tcp_port "$DOCKER_NETWORK" "$DOCKER_IP:${port}" || return 17
  790. info "Host/Port $DOCKER_IP:${port} checked ${GREEN}open${NORMAL}."
  791. ## XXXvlab: what to do with more than one port ?
  792. break
  793. done < <(image_exposed_ports_0 "$container_id")
  794. ## Checking direct connection
  795. timeout=120
  796. start=$SECONDS
  797. while true; do
  798. if err=$(echo "$check_command" | ddb 2>&1 >/dev/null); then
  799. break
  800. fi
  801. if ! [[ "$err" == *"the database system is starting up" ]]; then
  802. err "${RED}db connection error${NORMAL}:" \
  803. "Could not connect to db on $DOCKER_IP container's IP."
  804. echo " Note: IP up, TCP ports is(are) open" >&2
  805. if [ "$err" ]; then
  806. echo " Error:" >&2
  807. printf "%s\n" "$err" | prefix " ${RED}!${NORMAL} " >&2
  808. fi
  809. return 18
  810. fi
  811. debug "Got 'database system is starting up' error."
  812. elapsed=$((SECONDS - start))
  813. if ((elapsed > timeout)); then
  814. err "${RED}db connection error${NORMAL}:"\
  815. "Could not connect to db on $DOCKER_IP" \
  816. "container's IP. (IP up, TCP ports is(are) open, sql answer after ${timeout}s)"
  817. return 1
  818. fi
  819. sleep 0.2
  820. done
  821. echo "${DOCKER_NETWORK}:${DOCKER_IP}"
  822. return 0
  823. }
  824. export -f wait_for_docker_ip
  825. docker_add_host_declaration() {
  826. local src_docker=$1 domain=$2 dst_docker=$3 dst_docker_ip= dst_docker_network
  827. dst_docker_ip=$(wait_docker_ip "$dst_docker") || exit 1
  828. IFS=: read dst_docker_ip dst_docker_network <<<"$dst_docker_ip"
  829. docker exec -i "$src_docker" bash <<EOF
  830. if cat /etc/hosts | grep -E "^[0-9]+\.[0-9]+\.[0-9]+\.[0-9]+\s+$domain\$" > /dev/null 2>&1; then
  831. sed -ri "s/^[0-9]+\.[0-9]+\.[0-9]+\.[0-9]+\s+$domain\$/$dst_docker_ip $domain/g" /etc/hosts
  832. else
  833. echo "$dst_docker_ip $domain" >> /etc/hosts
  834. fi
  835. EOF
  836. }
  837. export -f docker_add_host_declaration
  838. get_running_containers_for_service() {
  839. local service="$1"
  840. docker ps --filter label="compose.master-service=$service" --format="{{.ID}}"
  841. }
  842. export -f get_running_containers_for_service
  843. get_container_network_ips() {
  844. local container="$1"
  845. docker inspect "$container" \
  846. --format='{{range $key, $val :=.NetworkSettings.Networks}}{{$key}}{{"\x00"}}{{$val.IPAddress}}{{"\x00"}}{{end}}'
  847. }
  848. export -f get_container_network_ips
  849. get_container_network_ip() {
  850. local container="$1"
  851. while read-0 network ip; do
  852. printf "%s\0" "$network" "$ip"
  853. break
  854. done < <(get_container_network_ips "$container")
  855. }
  856. export -f get_container_network_ip
  857. ##
  858. ## Internal Process
  859. ##
  860. get_docker_compose_links() {
  861. local service="$1" cache_file="$state_tmpdir/$FUNCNAME.cache.$1" \
  862. deps master_service master_target_service _relation_name \
  863. target_service _relation_config tech_dep
  864. if [ -z "$service" ]; then
  865. print_syntax_error "$FUNCNAME: Please specify a service as first argument."
  866. return 1
  867. fi
  868. if [ -e "$cache_file" ]; then
  869. # debug "$FUNCNAME: cache hit ($*)"
  870. cat "$cache_file"
  871. return 0
  872. fi
  873. master_service=$(get_top_master_service_for_service "$service") || return 1
  874. deps=()
  875. while read-0 _relation_name target_service _relation_config tech_dep; do
  876. master_target_service="$(get_top_master_service_for_service "$target_service")" || return 1
  877. [ "$master_service" == "$master_target_service" ] && continue
  878. type="$(get_service_type "$target_service")" || return 1
  879. [ "$type" == "run-once" ] && continue
  880. if [ "$tech_dep" == "reversed" ]; then
  881. deps+=("$(echo -en "$master_target_service:\n links:\n - $master_service")")
  882. elif [ "$tech_dep" == "True" ]; then
  883. deps+=("$(echo -en "$master_service:\n links:\n - $master_target_service")")
  884. fi
  885. ## XXXvlab: an attempt to add depends_on, but this doesn't work well actually
  886. ## as there's a circular dependency issue. We don't really want the full feature
  887. ## of depends_on, but just to add it as targets when doing an 'up'
  888. # deps+=("$(echo -en "$master_service:\n depends_on:\n - $master_target_service")")
  889. done < <(get_service_relations "$service")
  890. merge_yaml_str "${deps[@]}" | tee "$cache_file" || return 1
  891. if [ "${PIPESTATUS[0]}" != 0 ]; then
  892. rm "$cache_file"
  893. err "Failed to merge YAML from all ${WHITE}links${NORMAL} dependencies."
  894. return 1
  895. fi
  896. }
  897. _get_docker_compose_opts() {
  898. local service="$1" cache_file="$state_tmpdir/$FUNCNAME.cache.$1" \
  899. compose_def master_service docker_compose_opts
  900. if [ -z "$service" ]; then
  901. print_syntax_error "$FUNCNAME: Please specify a service as first argument."
  902. return 1
  903. fi
  904. if [ -e "$cache_file" ]; then
  905. # debug "$FUNCNAME: cache hit ($*)"
  906. cat "$cache_file"
  907. return 0
  908. fi
  909. compose_def="$(get_compose_service_def "$service")" || return 1
  910. master_service="$(get_top_master_service_for_service "$service")"
  911. if docker_compose_opts=$(echo "$compose_def" | shyaml get-value -y "docker-compose" 2>/dev/null); then
  912. yaml_key_val_str "$master_service" "$docker_compose_opts"
  913. fi | tee "$cache_file"
  914. if [ "${PIPESTATUS[0]}" != 0 ]; then
  915. rm "$cache_file"
  916. return 1
  917. fi
  918. }
  919. ##
  920. ## By Reading the metadata.yml, we create a docker-compose.yml mixin.
  921. ## Some metadata.yml (of subordinates) will indeed modify other
  922. ## services than themselves.
  923. _get_docker_compose_service_mixin() {
  924. local service="$1" cache_file="$state_tmpdir/$FUNCNAME.cache.$1" \
  925. links_yaml base_mixin links_yaml docker_compose_options \
  926. charm charm_part
  927. if [ -z "$service" ]; then
  928. print_syntax_error "$FUNCNAME: Please specify a service as first argument."
  929. return 1
  930. fi
  931. if [ -e "$cache_file" ]; then
  932. # debug "$FUNCNAME: cache hit ($*)"
  933. cat "$cache_file"
  934. return 0
  935. fi
  936. master_service=$(get_top_master_service_for_service "$service") || {
  937. err "Failed to get top master service for service $DARKYELLOW$service$NORMAL"
  938. return 1
  939. }
  940. ## The compose part
  941. base_mixin="$master_service:
  942. labels:
  943. - compose.service=$service
  944. - compose.master-service=${master_service}
  945. - compose.project=$(get_default_project_name)"
  946. links_yaml=$(get_docker_compose_links "$service") || return 1
  947. docker_compose_options=$(_get_docker_compose_opts "$service") || return 1
  948. ## the charm part
  949. charm_part=$(get_docker_compose_mixin_from_metadata "$service") || return 1
  950. ## Merge results
  951. if [ "$charm_part" ]; then
  952. charm_yaml="$(yaml_key_val_str "$master_service" "$charm_part")" || return 1
  953. merge_yaml_str "$base_mixin" "$links_yaml" "$charm_yaml" "$docker_compose_options" || return 1
  954. else
  955. merge_yaml_str "$base_mixin" "$links_yaml" "$docker_compose_options" || return 1
  956. fi | tee "$cache_file"
  957. if [ "${PIPESTATUS[0]}" != 0 ]; then
  958. err "Failed to constitute the base YAML for service '${DARKYELLOW}$service${NORMAL}'"
  959. rm "$cache_file"
  960. return 1
  961. fi
  962. }
  963. export -f _get_docker_compose_service_mixin
  964. ##
  965. ## Get full `docker-compose.yml` format for all listed services (and
  966. ## their deps)
  967. ##
  968. ## @export
  969. ## @cache: !system !nofail +stdout
  970. get_docker_compose () {
  971. local cache_file="$state_tmpdir/$FUNCNAME.cache.$(echo "$*" | md5_compat)" \
  972. entries services service start docker_compose_services
  973. if [ -e "$cache_file" ]; then
  974. # debug "$FUNCNAME: cache hit ($*)"
  975. cat "$cache_file"
  976. return 0
  977. fi
  978. ##
  979. ## Adding sub services configurations
  980. ##
  981. declare -A entries
  982. start_compilation=$SECONDS
  983. debug "Compiling 'docker-compose.yml' base for ${DARKYELLOW}$*$NORMAL..."
  984. for target_service in "$@"; do
  985. start=$SECONDS
  986. services=($(get_ordered_service_dependencies "$target_service")) || {
  987. err "Failed to get dependencies for $DARKYELLOW$target_service$NORMAL"
  988. return 1
  989. }
  990. if [ "$DEBUG" ]; then
  991. debug " $DARKYELLOW$target_service$NORMAL deps:$DARKYELLOW" \
  992. "${services[@]::$((${#services[@]} - 1))}" \
  993. "$NORMAL$GRAY(in $((SECONDS - start))s)$NORMAL"
  994. fi
  995. for service in "${services[@]}"; do
  996. if [ "${entries[$service]}" ]; then
  997. ## Prevent double inclusion of same service if this
  998. ## service is deps of two or more of your
  999. ## requirements.
  1000. continue
  1001. fi
  1002. ## mark the service as "loaded" as well as it's containers
  1003. ## if this is a subordinate service
  1004. start_service=$SECONDS
  1005. entries[$service]=$(_get_docker_compose_service_mixin "$service") || {
  1006. err "Failed to get service mixin for $DARKYELLOW$service$NORMAL"
  1007. return 1
  1008. }
  1009. debug " Applied $DARKYELLOW$service$NORMAL charm metadata mixins $GRAY(in $((SECONDS - start_service))s)$NORMAL"
  1010. done
  1011. debug " ..finished all mixins for $DARKYELLOW$target_service$NORMAL $GRAY(in $((SECONDS - start))s)$NORMAL"
  1012. done
  1013. docker_compose_services=$(merge_yaml_str "${entries[@]}") || {
  1014. err "Failed to merge YAML services entries together."
  1015. return 1
  1016. }
  1017. base_v2="version: '2.0'"
  1018. merge_yaml_str "$(yaml_key_val_str "services" "$docker_compose_services")" \
  1019. "$base_v2" > "$cache_file" || return 1
  1020. export _current_docker_compose="$(cat "$cache_file")"
  1021. echo "$_current_docker_compose"
  1022. debug " ..compilation of base 'docker-compose.yml' done $GRAY(in $((SECONDS - start_compilation))s)$NORMAL" || true
  1023. # debug " ** ${WHITE}docker-compose.yml${NORMAL}:"
  1024. # debug "$_current_docker_compose"
  1025. }
  1026. export -f get_docker_compose
  1027. _get_compose_service_def_cached () {
  1028. local service="$1" docker_compose="$2" cache_file="$CACHEDIR/$FUNCNAME.cache.$(echo "$*" | md5_compat)"
  1029. if [ -e "$cache_file" ]; then
  1030. #debug "$FUNCNAME: STATIC cache hit"
  1031. cat "$cache_file" &&
  1032. touch "$cache_file" || return 1
  1033. return 0
  1034. fi
  1035. value=$(echo "$docker_compose" | shyaml get-value "${service//./\\.}" 2>/dev/null)
  1036. [ "$value" == None ] && value=""
  1037. if ! echo "$value" | shyaml get-value "charm" >/dev/null 2>&1; then
  1038. if charm.exists "$service"; then
  1039. value=$(merge_yaml <(echo "charm: $service") <(echo "$value")) || {
  1040. err "Can't merge YAML infered 'charm: $service' with base ${DARKYELLOW}$service${NORMAL} YAML definition."
  1041. return 1
  1042. }
  1043. else
  1044. err "No ${WHITE}charm${NORMAL} value for service $DARKYELLOW$service$NORMAL" \
  1045. "in compose, nor same name charm found."
  1046. return 1
  1047. fi
  1048. fi
  1049. echo "$value" | tee "$cache_file" || return 1
  1050. # if [ "${PIPESTATUS[0]}" != 0 ]; then
  1051. # rm "$cache_file"
  1052. # return 1
  1053. # fi
  1054. return 0
  1055. # if [ "${PIPESTATUS[0]}" != 0 -o \! -s "$cache_file" ]; then
  1056. # rm "$cache_file"
  1057. # err "PAS OK $service: $value"
  1058. # return 1
  1059. # fi
  1060. }
  1061. export -f _get_compose_service_def_cached
  1062. ## XXXvlab: a lot to be done to cache the results
  1063. get_compose_service_def () {
  1064. local service="$1" docker_compose cache_file="$state_tmpdir/$FUNCNAME.cache.$1" \
  1065. result
  1066. if [ -e "$cache_file" ]; then
  1067. #debug "$FUNCNAME: SESSION cache hit"
  1068. cat "$cache_file" || return 1
  1069. return 0
  1070. fi
  1071. [ -z "$service" ] && print_syntax_error "Missing service as first argument."
  1072. docker_compose=$(get_compose_yml_content) || return 1
  1073. result=$(_get_compose_service_def_cached "$service" "$docker_compose") || return 1
  1074. charm=$(echo "$result" | shyaml get-value charm 2>/dev/null) || return 1
  1075. metadata=$(charm.metadata "$charm") || return 1
  1076. if default_options=$(printf "%s" "$metadata" | shyaml -y -q get-value default-options); then
  1077. default_options=$(yaml_key_val_str "options" "$default_options") || return 1
  1078. result=$(merge_yaml_str "$default_options" "$result") || return 1
  1079. fi
  1080. echo "$result" | tee "$cache_file" || return 1
  1081. }
  1082. export -f get_compose_service_def
  1083. _get_service_charm_cached () {
  1084. local service="$1" service_def="$2" cache_file="$CACHEDIR/$FUNCNAME.cache.$(echo "$*" | md5_compat)"
  1085. if [ -e "$cache_file" ]; then
  1086. # debug "$FUNCNAME: cache hit $1"
  1087. cat "$cache_file" &&
  1088. touch "$cache_file" || return 1
  1089. return 0
  1090. fi
  1091. charm=$(echo "$service_def" | shyaml get-value charm 2>/dev/null)
  1092. if [ -z "$charm" ]; then
  1093. err "Missing ${WHITE}charm${NORMAL} value in service $DARKYELLOW$service$NORMAL definition."
  1094. return 1
  1095. fi
  1096. echo "$charm" | tee "$cache_file" || return 1
  1097. }
  1098. export -f _get_service_charm_cached
  1099. get_service_charm () {
  1100. local service="$1"
  1101. if [ -z "$service" ]; then
  1102. echo ${FUNCNAME[@]} >&2
  1103. print_syntax_error "$FUNCNAME: Please specify a service as first argument."
  1104. return 1
  1105. fi
  1106. service_def=$(get_compose_service_def "$service") || return 1
  1107. _get_service_charm_cached "$service" "$service_def"
  1108. }
  1109. export -f get_service_charm
  1110. ## built above the docker-compose abstraction, so it relies on the
  1111. ## full docker-compose.yml to be already built.
  1112. get_service_def () {
  1113. local service="$1" def
  1114. if [ -z "$_current_docker_compose" ]; then
  1115. print_syntax_error "$FUNCNAME is meant to be called after"\
  1116. "\$_current_docker_compose has been calculated."
  1117. fi
  1118. def=$(echo "$_current_docker_compose" | shyaml get-value "services.${service//./\\.}" 2>/dev/null)
  1119. if [ -z "$def" ]; then
  1120. err "No definition for service $DARKYELLOW$service$NORMAL in compiled 'docker-compose.yml'."
  1121. return 1
  1122. fi
  1123. echo "$def"
  1124. }
  1125. export -f get_service_def
  1126. ## Return the base docker image name of a service
  1127. service_base_docker_image() {
  1128. local service="$1" cache_file="$state_tmpdir/$FUNCNAME.cache.$1" \
  1129. master_service service_def service_image service_build service_dockerfile
  1130. if [ -e "$cache_file" ]; then
  1131. # debug "$FUNCNAME: cache hit ($*)"
  1132. cat "$cache_file"
  1133. return 0
  1134. fi
  1135. master_service="$(get_top_master_service_for_service "$service")" || {
  1136. err "Could not compute master service for service $DARKYELLOW$service$NORMAL."
  1137. return 1
  1138. }
  1139. service_def="$(get_service_def "$master_service")" || {
  1140. err "Could not get docker-compose service definition for $DARKYELLOW$master_service$NORMAL."
  1141. return 1
  1142. }
  1143. service_image=$(echo "$service_def" | shyaml get-value image 2>/dev/null)
  1144. if [ "$?" != 0 ]; then
  1145. ## According to https://stackoverflow.com/questions/32230577 , if there's a build,
  1146. ## then the builded image will get name ${project}_${service}
  1147. project=$(get_default_project_name) || return 1
  1148. image_name="${project}_${service}"
  1149. if ! docker_has_image "$image_name"; then
  1150. service_build=$(echo "$service_def" | shyaml get-value build 2>/dev/null)
  1151. if [ "$?" != 0 ]; then
  1152. err "Service $DARKYELLOW$service$NORMAL has no ${WHITE}image${NORMAL} nor ${WHITE}build${NORMAL} parameter."
  1153. echo "$service_def" >&2
  1154. return 1
  1155. fi
  1156. docker build "$service_build" -t "${project}_${service}" >&2 || {
  1157. err "Failed to build image for ${DARKYELLOW}$service${NORMAL}."
  1158. return 1
  1159. }
  1160. fi
  1161. printf "%s" "${project}_${service}"
  1162. else
  1163. printf "%s" "${service_image}"
  1164. fi | tee "$cache_file"
  1165. if [ "${PIPESTATUS[0]}" != 0 ]; then
  1166. rm "$cache_file"
  1167. return 1
  1168. fi
  1169. }
  1170. export -f service_base_docker_image
  1171. get_charm_relation_def () {
  1172. local charm="$1" relation_name="$2" cache_file="$state_tmpdir/$FUNCNAME.cache.$1.$2" \
  1173. relation_def metadata
  1174. if [ -e "$cache_file" ]; then
  1175. # debug "$FUNCNAME: cache hit ($*)"
  1176. cat "$cache_file"
  1177. return 0
  1178. fi
  1179. metadata="$(charm.metadata "$charm")" || return 1
  1180. relation_def="$(echo "$metadata" | shyaml get-value "provides.${relation_name}" 2>/dev/null)"
  1181. echo "$relation_def" | tee "$cache_file"
  1182. }
  1183. export -f get_charm_relation_def
  1184. get_charm_tech_dep_orientation_for_relation() {
  1185. local charm="$1" relation_name="$2" cache_file="$state_tmpdir/$FUNCNAME.cache.$1.$2" \
  1186. relation_def value
  1187. if [ -e "$cache_file" ]; then
  1188. # debug "$FUNCNAME: cache hit ($*)"
  1189. cat "$cache_file"
  1190. return 0
  1191. fi
  1192. relation_def=$(get_charm_relation_def "$charm" "$relation_name" 2>/dev/null)
  1193. value=$(echo "$relation_def" | shyaml get-value 'tech-dep' 2>/dev/null)
  1194. value=${value:-True}
  1195. printf "%s" "$value" | tee "$cache_file"
  1196. }
  1197. export -f get_charm_tech_dep_orientation_for_relation
  1198. get_service_relation_tech_dep() {
  1199. local service="$1" relation_name="$2" cache_file="$state_tmpdir/$FUNCNAME.cache.$1.$2" \
  1200. charm tech_dep
  1201. if [ -e "$cache_file" ]; then
  1202. # debug "$FUNCNAME: cache hit ($*)"
  1203. cat "$cache_file"
  1204. return 0
  1205. fi
  1206. charm=$(get_service_charm "$service") || return 1
  1207. tech_dep="$(get_charm_tech_dep_orientation_for_relation "$charm" "$relation_name")" || return 1
  1208. printf "%s" "$tech_dep" | tee "$cache_file"
  1209. }
  1210. export -f get_service_relation_tech_dep
  1211. ##
  1212. ## Use compose file to get deps, and relation definition in metadata.yml
  1213. ## for tech-dep attribute.
  1214. get_service_deps() {
  1215. local service="$1" cache_file="$state_tmpdir/$FUNCNAME.cache.$(H "$@" "$ALL_RELATIONS")"
  1216. if [ -e "$cache_file" ]; then
  1217. # debug "$FUNCNAME: cache hit ($*)"
  1218. cat "$cache_file"
  1219. return 0
  1220. fi
  1221. (
  1222. set -o pipefail
  1223. get_service_relations "$service" | \
  1224. while read-0 relation_name target_service _relation_config tech_dep; do
  1225. echo "$target_service"
  1226. done | tee "$cache_file"
  1227. ) || return 1
  1228. }
  1229. export -f get_service_deps
  1230. ## XXXvlab: cache was disabled because improper. Indeed, this needs to cache
  1231. ## 'depths' full state. Second, it should be
  1232. _rec_get_depth() {
  1233. local elt=$1 dep deps max
  1234. [ "${depths[$elt]}" ] && return 0
  1235. local cache_file="$state_tmpdir/$FUNCNAME.cache.$(H "$@" "$(declare -pA depths)" "$ALL_RELATIONS")"
  1236. if [ -e "$cache_file.depths" ]; then
  1237. #debug "$FUNCNAME: cache hit ($*) - $cache_file.depths"
  1238. while read-0 k v; do
  1239. depths["$k"]="$v"
  1240. done < "$cache_file.depths"
  1241. while read-0 k v; do
  1242. visited["$k"]="$v"
  1243. done < "$cache_file.visited"
  1244. return 0
  1245. fi
  1246. visited[$elt]=1
  1247. #debug "Setting visited[$elt]"
  1248. #debug "Asking for $DARKYELLOW$elt$NORMAL dependencies"
  1249. deps=$(get_service_deps "$elt") || {
  1250. debug "Failed get_service_deps $elt"
  1251. return 1
  1252. }
  1253. # debug "$elt deps are:" $deps
  1254. max=0
  1255. for dep in $deps; do
  1256. [ "${visited[$dep]}" ] && {
  1257. #debug "Already computing $dep"
  1258. continue
  1259. }
  1260. _rec_get_depth "$dep" || return 1
  1261. #debug "Requesting depth[$dep]"
  1262. if (( ${depths[$dep]} > max )); then
  1263. max="${depths[$dep]}"
  1264. fi
  1265. done
  1266. # debug "Setting depth[$elt] to $((max + 1))"
  1267. depths[$elt]=$((max + 1))
  1268. array_kv_to_stdin depths > "$cache_file.depths"
  1269. array_kv_to_stdin visited > "$cache_file.visited"
  1270. # debug "DEPTHS: $(declare -pA depths)"
  1271. # debug "$FUNCNAME: caching hit ($*) - $cache_file"
  1272. }
  1273. export -f _rec_get_depth
  1274. get_ordered_service_dependencies() {
  1275. local services=("$@") cache_file="$state_tmpdir/$FUNCNAME.cache.$(H "$@" "$ALL_RELATIONS")" \
  1276. i value key heads depths visited
  1277. if [ -e "$cache_file" ]; then
  1278. # debug "$FUNCNAME: cache hit ($*)"
  1279. cat "$cache_file"
  1280. return 0
  1281. fi
  1282. #debug "Figuring ordered deps of $DARKYELLOW${services[@]}$NORMAL"
  1283. if [ -z "${services[*]}" ]; then
  1284. return 0
  1285. # print_syntax_error "$FUNCNAME: no arguments"
  1286. # return 1
  1287. fi
  1288. declare -A depths
  1289. declare -A visited
  1290. heads=("${services[@]}")
  1291. while [ "${#heads[@]}" != 0 ]; do
  1292. array_pop heads head
  1293. _rec_get_depth "$head" || return 1
  1294. done
  1295. i=0
  1296. while [ "${#depths[@]}" != 0 ]; do
  1297. for key in "${!depths[@]}"; do
  1298. value="${depths[$key]}"
  1299. if [ "$value" == "$i" ]; then
  1300. echo "$key"
  1301. unset depths[$key]
  1302. fi
  1303. done
  1304. ((i++))
  1305. done | tee "$cache_file"
  1306. }
  1307. export -f get_ordered_service_dependencies
  1308. run_service_hook () {
  1309. local action="$1" service subservice subservices loaded
  1310. shift
  1311. declare -A loaded
  1312. for service in "$@"; do
  1313. subservices=$(get_ordered_service_dependencies "$service") || return 1
  1314. for subservice in $subservices; do
  1315. if [ "${loaded[$subservice]}" ]; then
  1316. ## Prevent double inclusion of same service if this
  1317. ## service is deps of two or more of your
  1318. ## requirements.
  1319. continue
  1320. fi
  1321. charm=$(get_service_charm "$subservice") || return 1
  1322. charm.has_hook "$charm" "$action" >/dev/null || continue
  1323. PROJECT_NAME=$(get_default_project_name) || return 1
  1324. MASTER_BASE_SERVICE_NAME=$(get_top_master_service_for_service "$subservice") || return 1
  1325. MASTER_BASE_CHARM_NAME=$(get_service_charm "$MASTER_BASE_SERVICE_NAME") || return 1
  1326. DOCKER_BASE_IMAGE=$(service_base_docker_image "$MASTER_BASE_SERVICE_NAME") || return 1
  1327. Wrap "${wrap_opts[@]}" -d "running $YELLOW$action$NORMAL hook of $DARKYELLOW$subservice$NORMAL in charm $DARKPINK$charm$NORMAL" <<EOF || return 1
  1328. export DOCKER_BASE_IMAGE="$DOCKER_BASE_IMAGE"
  1329. export SERVICE_NAME=$subservice
  1330. export IMAGE_NAME=$(echo "${PROJECT_NAME}" | tr -d "_-")_\${SERVICE_NAME}
  1331. export CONTAINER_NAME=\${IMAGE_NAME}_1
  1332. export CHARM_NAME="$charm"
  1333. export PROJECT_NAME="$PROJECT_NAME"
  1334. export SERVICE_DATASTORE="$DATASTORE/$subservice"
  1335. export SERVICE_CONFIGSTORE="$CONFIGSTORE/$subservice"
  1336. export MASTER_BASE_SERVICE_NAME="$MASTER_BASE_SERVICE_NAME"
  1337. export MASTER_BASE_CHARM_NAME="$MASTER_BASE_CHARM_NAME"
  1338. charm.run_hook "local" "$charm" "$action"
  1339. EOF
  1340. loaded[$subservice]=1
  1341. done
  1342. done
  1343. return 0
  1344. }
  1345. host_resource_get() {
  1346. local location="$1" cfg="$2"
  1347. type=$(echo "$cfg" | shyaml get-value type 2>/dev/null) || {
  1348. err "Missing ${WHITE}type$NORMAL option in ${WHITE}get$NORMAL config for location '$location'"
  1349. return 1
  1350. }
  1351. if fn.exists host_resource_get_$type; then
  1352. host_resource_get_$type "$location" "$cfg"
  1353. else
  1354. err "Source ${WHITE}source$NORMAL type '$type' unknown for" \
  1355. "${WHITE}host-resource$NORMAL '$location' defined in" \
  1356. "$DARKYELLOW$subservice$NORMAL config."
  1357. return 1
  1358. fi
  1359. }
  1360. export -f host_resource_get
  1361. host_resource_get_git() {
  1362. local location="$1" cfg="$2" branch parent url
  1363. branch=$(echo "$cfg" | shyaml get-value branch 2>/dev/null)
  1364. branch=${branch:-master}
  1365. url=$(echo "$cfg" | shyaml get-value url 2>/dev/null)
  1366. parent="$(dirname "$location")"
  1367. (
  1368. mkdir -p "$parent" && cd "$parent" &&
  1369. git clone -b "$branch" "$url" "$(basename "$location")"
  1370. ) || return 1
  1371. }
  1372. export -f host_resource_get_git
  1373. host_resource_get_git-sub() {
  1374. local location="$1" cfg="$2" branch parent url
  1375. branch=$(echo "$cfg" | shyaml get-value branch 2>/dev/null)
  1376. branch=${branch:-master}
  1377. url=$(echo "$cfg" | shyaml get-value url 2>/dev/null)
  1378. parent="$(dirname "$location")"
  1379. (
  1380. mkdir -p "$parent" && cd "$parent" &&
  1381. git sub clone -b "$branch" "$url" "$(basename "$location")"
  1382. ) || return 1
  1383. }
  1384. export -f host_resource_get_git-sub
  1385. setup_host_resource () {
  1386. local subservice="$1" service_def location get cfg
  1387. service_def=$(get_compose_service_def "$subservice") || return 1
  1388. while read-0 location cfg; do
  1389. ## XXXvlab: will it be a git resources always ?
  1390. if [ -d "$location" -a ! -d "$location/.git" ]; then
  1391. err "Hum, location '$location' does not seem to be a git directory."
  1392. return 1
  1393. fi
  1394. if [ -d "$location" ]; then
  1395. info "host resource '$location' already set up."
  1396. continue
  1397. fi
  1398. get=$(echo "$cfg" | shyaml get-value get 2>/dev/null)
  1399. if [ -z "$get" ]; then
  1400. err "No host directory '$location' found, and no ${WHITE}source$NORMAL" \
  1401. "specified for $DARKYELLOW$subservice$NORMAL."
  1402. return 1
  1403. fi
  1404. host_resource_get "$location" "$get" || return 1
  1405. done < <(echo "$service_def" | shyaml key-values-0 host-resources 2>/dev/null)
  1406. }
  1407. export -f setup_host_resource
  1408. setup_host_resources () {
  1409. local service subservices subservice loaded
  1410. declare -A loaded
  1411. for service in "$@"; do
  1412. subservices=$(get_ordered_service_dependencies "$service") || return 1
  1413. for subservice in $subservices; do
  1414. if [ "${loaded[$subservice]}" ]; then
  1415. ## Prevent double inclusion of same service if this
  1416. ## service is deps of two or more of your
  1417. ## requirements.
  1418. continue
  1419. fi
  1420. setup_host_resource "$subservice" || return 1
  1421. loaded[$subservice]=1
  1422. done
  1423. done
  1424. return 0
  1425. }
  1426. export -f setup_host_resources
  1427. ## Works on stdin
  1428. cfg-get-value () {
  1429. local key="$1" out
  1430. if [ -z "$key" ]; then
  1431. yaml_get_interpret || return 1
  1432. return 0
  1433. fi
  1434. if ! out=$(shyaml -y get-value "$key" 2>/dev/null); then
  1435. err "The key $WHITE$key$NORMAL was not found in relation's data."
  1436. return 1
  1437. fi
  1438. echo "$out" | yaml_get_interpret
  1439. }
  1440. export -f cfg-get-value
  1441. relation-get () {
  1442. cfg-get-value "$1" < "$RELATION_DATA_FILE"
  1443. }
  1444. export -f relation-get
  1445. expand_vars() {
  1446. local unlikely_prefix="UNLIKELY_PREFIX"
  1447. content=$(cat -)
  1448. ## find first identifier not in content
  1449. remaining_lines=$(echo "$content" | grep "^$unlikely_prefix")
  1450. while [ "$(echo "$remaining_lines" | grep "^$unlikely_prefix$")" ]; do
  1451. size_prefix="${#unlikely_prefix}"
  1452. first_matching=$(echo "$remaining_lines" |
  1453. grep -v "^$unlikely_prefix$" |
  1454. uniq -w "$((size_prefix + 1))" -c |
  1455. sort -rn |
  1456. head -n 1)
  1457. first_matching=${first_matching#"${x%%[![:space:]]*}"}
  1458. first_matching="${first_matching#* }"
  1459. next_char=${first_matching:$size_prefix:1}
  1460. if [ "$next_char" != "0" ]; then
  1461. unlikely_prefix+="0"
  1462. else
  1463. unlikely_prefix+="1"
  1464. fi
  1465. remaining_lines=$(echo "$remaining_lines" | grep "^$unlikely_prefix")
  1466. done
  1467. eval "cat <<$unlikely_prefix
  1468. $content
  1469. $unlikely_prefix"
  1470. }
  1471. export -f expand_vars
  1472. yaml_get_interpret() {
  1473. local content tag
  1474. content=$(cat -)
  1475. tag=$(echo "$content" | shyaml -y get-value) || return 1
  1476. tag="${tag%% *}"
  1477. content=$(echo "$content" | shyaml get-value) || return 1
  1478. if ! [ "${tag:0:1}" == "!" ]; then
  1479. echo "$content" || return 1
  1480. return 0
  1481. fi
  1482. case "$tag" in
  1483. "!bash-stdout")
  1484. echo "$content" | bash || {
  1485. err "shell code didn't end with errorlevel 0"
  1486. return 1
  1487. }
  1488. ;;
  1489. "!var-expand")
  1490. echo "$content" | expand_vars || {
  1491. err "shell expansion failed"
  1492. return 1
  1493. }
  1494. ;;
  1495. "!file-content")
  1496. source=$(echo "$content" | expand_vars) || {
  1497. err "shell expansion failed"
  1498. return 1
  1499. }
  1500. cat "$source" || return 1
  1501. ;;
  1502. *)
  1503. err "Invalid object tag ${WHITE}$tag${NORMAL}"
  1504. return 1
  1505. ;;
  1506. esac
  1507. }
  1508. export -f yaml_get_interpret
  1509. options-get () {
  1510. local key="$1" out
  1511. service_def=$(get_compose_service_def "$SERVICE_NAME") || return 1
  1512. if ! out=$(echo "$service_def" | shyaml -y get-value "options.$key" 2>/dev/null); then
  1513. err "The key $WHITE$key$NORMAL was not found in base service compose definition.."
  1514. return 1
  1515. fi
  1516. echo "$out" | yaml_get_interpret
  1517. }
  1518. export -f options-get
  1519. relation-base-compose-get () {
  1520. local key="$1" out
  1521. if ! out=$(echo "$RELATION_BASE_COMPOSE_DEF" | shyaml -y get-value "options.$key" 2>/dev/null); then
  1522. err "The key $WHITE$key$NORMAL was not found in base service compose definition.."
  1523. return 1
  1524. fi
  1525. echo "$out" | yaml_get_interpret
  1526. }
  1527. export -f relation-base-compose-get
  1528. relation-target-compose-get () {
  1529. local key="$1" out
  1530. if ! out=$(echo "$RELATION_TARGET_COMPOSE_DEF" | shyaml -y get-value "options.$key" 2>/dev/null); then
  1531. err "The key $WHITE$key$NORMAL was not found in base service compose definition.."
  1532. return 1
  1533. fi
  1534. echo "$out" | yaml_get_interpret
  1535. }
  1536. export -f relation-target-compose-get
  1537. relation-set () {
  1538. local key="$1" value="$2"
  1539. if [ -z "$RELATION_DATA_FILE" ]; then
  1540. err "$FUNCNAME: relation does not seems to be correctly setup."
  1541. return 1
  1542. fi
  1543. if ! [ -r "$RELATION_DATA_FILE" ]; then
  1544. err "$FUNCNAME: can't read relation's data." >&2
  1545. return 1
  1546. fi
  1547. _config_merge "$RELATION_DATA_FILE" <(yaml_key_val_str "$key" "$value")
  1548. }
  1549. export -f relation-set
  1550. _config_merge() {
  1551. local config_filename="$1" mixin="$2"
  1552. touch "$config_filename" &&
  1553. merge_yaml "$config_filename" "$mixin" > "$config_filename.tmp" || return 1
  1554. mv "$config_filename.tmp" "$config_filename"
  1555. }
  1556. export -f _config_merge
  1557. ## XXXvlab; this can be used only in relation, I'd like to use it in init.
  1558. config-add() {
  1559. local metadata="$1"
  1560. _config_merge "$RELATION_CONFIG" <(echo "$metadata")
  1561. }
  1562. export -f config-add
  1563. ## XXXvlab; this can be used only in relation, I'd like to use it in init.
  1564. init-config-add() {
  1565. local metadata="$1"
  1566. _config_merge "$state_tmpdir/to-merge-in-docker-compose.yml" \
  1567. <(yaml_key_val_str "services" "$metadata")
  1568. }
  1569. export -f init-config-add
  1570. docker_get_uid() {
  1571. local service="$1" user="$2" uid
  1572. uid=$(cached_cmd_on_base_image "$service" "id -u \"$user\"") || {
  1573. debug "Failed to query for '$user' uid in ${DARKYELLOW}$service${NORMAL} base image."
  1574. return 1
  1575. }
  1576. info "uid from ${DARKYELLOW}$service${NORMAL} for user '$user' is '$uid'"
  1577. echo "$uid"
  1578. }
  1579. export -f docker_get_uid
  1580. docker_get_uid_gid() {
  1581. local service="$1" user="$2" group="$3" uid
  1582. uid_gid=$(cached_cmd_on_base_image "$service" "id -u \"$user\"; id -g \"$group\"") || {
  1583. debug "Failed to query for '$user' uid in ${DARKYELLOW}$service${NORMAL} base image."
  1584. return 1
  1585. }
  1586. info "uid from ${DARKYELLOW}$service${NORMAL} for user '$user' is '$uid_gid'"
  1587. echo "$uid_gid"
  1588. }
  1589. export -f docker_get_uid_gid
  1590. logstdout() {
  1591. local name="$1"
  1592. sed -r 's%^%'"${name}"'> %g'
  1593. }
  1594. export -f logstdout
  1595. logstderr() {
  1596. local name="$1"
  1597. sed -r 's%^(.*)$%'"${RED}${name}>${NORMAL} \1"'%g'
  1598. }
  1599. export -f logstderr
  1600. _run_service_relation () {
  1601. local relation_name="$1" service="$2" target_service="$3" relation_config="$4" relation_dir services
  1602. local errlvl
  1603. charm=$(get_service_charm "$service") || return 1
  1604. target_charm=$(get_service_charm "$target_service") || return 1
  1605. base_script_name=$(charm.has_relation_hook "$charm" "$relation_name" relation-joined) || true
  1606. target_script_name=$(charm.has_relation_hook "$target_charm" "$relation_name" relation-joined) || true
  1607. [ "$base_script_name" -o "$target_script_name" ] || return 0
  1608. relation_dir=$(get_relation_data_dir "$service" "$target_service" "$relation_name") || return 1
  1609. RELATION_DATA_FILE=$(get_relation_data_file "$service" "$target_service" "$relation_name" "$relation_config") || return 1
  1610. export BASE_SERVICE_NAME=$service
  1611. export BASE_CHARM_NAME=$charm
  1612. export BASE_CHARM_PATH=$(charm.get_dir "$charm")
  1613. export TARGET_SERVICE_NAME=$target_service
  1614. export TARGET_CHARM_NAME=$target_charm
  1615. export TARGET_CHARM_PATH=$(charm.get_dir "$target_charm")
  1616. export RELATION_DATA_FILE
  1617. target_errlvl=0
  1618. if [ -z "$target_script_name" ]; then
  1619. verb "No relation script $DARKBLUE$relation_name$NORMAL in target $DARKPINK$target_charm$NORMAL."
  1620. else
  1621. verb "Running ${DARKBLUE}$relation_name${NORMAL} relation-joined script" \
  1622. "for target $DARKYELLOW$target_service$NORMAL (charm $DARKPINK$target_charm$NORMAL)"
  1623. RELATION_CONFIG="$relation_dir/config_provider"
  1624. DOCKER_BASE_IMAGE=$(service_base_docker_image "$target_service") || return 1
  1625. export DOCKER_BASE_IMAGE RELATION_CONFIG RELATION_DATA
  1626. {
  1627. (
  1628. SERVICE_NAME=$target_service
  1629. SERVICE_DATASTORE="$DATASTORE/$target_service"
  1630. SERVICE_CONFIGSTORE="$CONFIGSTORE/$target_service"
  1631. export SERVICE_NAME DOCKER_BASE_IMAGE SERVICE_DATASTORE SERVICE_CONFIGSTORE
  1632. charm.run_relation_hook local "$target_charm" "$relation_name" relation-joined
  1633. echo "$?" > "$relation_dir/target_errlvl"
  1634. ) | logstdout "$DARKYELLOW$target_service$NORMAL/$DARKBLUE$relation_name$NORMAL (joined) ${GREEN}@${NORMAL}"
  1635. } 3>&1 1>&2 2>&3 | logstderr "$DARKYELLOW$target_service$NORMAL/$DARKBLUE$relation_name$NORMAL (joined) ${RED}@${NORMAL}" 3>&1 1>&2 2>&3
  1636. target_errlvl="$(cat "$relation_dir/target_errlvl")" || {
  1637. err "Relation script '$script_name' in $DARKPINK$target_charm$NORMAL" \
  1638. "failed before outputing an errorlevel."
  1639. ((target_errlvl |= "1" ))
  1640. }
  1641. if [ -e "$RELATION_CONFIG" ]; then
  1642. debug "Merging some new config info in $DARKYELLOW$target_service$NORMAL"
  1643. _config_merge "$state_tmpdir/to-merge-in-docker-compose.yml" "$RELATION_CONFIG" &&
  1644. rm "$RELATION_CONFIG"
  1645. ((target_errlvl |= "$?"))
  1646. fi
  1647. fi
  1648. if [ "$target_errlvl" == 0 ]; then
  1649. errlvl=0
  1650. if [ "$base_script_name" ]; then
  1651. verb "Running ${DARKBLUE}$relation_name${NORMAL} relation-joined script" \
  1652. "for $DARKYELLOW$service$NORMAL (charm $DARKPINK$charm$NORMAL)"
  1653. RELATION_CONFIG="$relation_dir/config_providee"
  1654. RELATION_DATA="$(cat "$RELATION_DATA_FILE")"
  1655. DOCKER_BASE_IMAGE=$(service_base_docker_image "$service") || return 1
  1656. export DOCKER_BASE_IMAGE RELATION_CONFIG RELATION_DATA
  1657. {
  1658. (
  1659. SERVICE_NAME=$service
  1660. SERVICE_DATASTORE="$DATASTORE/$service"
  1661. SERVICE_CONFIGSTORE="$CONFIGSTORE/$service"
  1662. export SERVICE_NAME DOCKER_BASE_IMAGE SERVICE_DATASTORE SERVICE_CONFIGSTORE
  1663. charm.run_relation_hook local "$charm" "$relation_name" relation-joined
  1664. echo "$?" > "$relation_dir/errlvl"
  1665. ) | logstdout "$DARKYELLOW$service$NORMAL/$DARKBLUE$relation_name$NORMAL (joined) ${GREEN}@${NORMAL}"
  1666. } 3>&1 1>&2 2>&3 | logstderr "$DARKYELLOW$service$NORMAL/$DARKBLUE$relation_name$NORMAL (joined) ${RED}@$NORMAL" 3>&1 1>&2 2>&3
  1667. errlvl="$(cat "$relation_dir/errlvl")" || {
  1668. err "Relation script '$script_name' in $DARKPINK$charm$NORMAL" \
  1669. "failed before outputing an errorlevel."
  1670. ((errlvl |= "1" ))
  1671. }
  1672. if [ -e "$RELATION_CONFIG" ]; then
  1673. _config_merge "$state_tmpdir/to-merge-in-docker-compose.yml" "$RELATION_CONFIG" &&
  1674. rm "$RELATION_CONFIG"
  1675. ((errlvl |= "$?" ))
  1676. fi
  1677. if [ "$errlvl" != 0 ]; then
  1678. err "Relation $DARKBLUE$relation_name$NORMAL on $DARKYELLOW$service$NORMAL failed to run properly."
  1679. fi
  1680. else
  1681. verb "No relation script '$script_name' in charm $DARKPINK$charm$NORMAL. Ignoring."
  1682. fi
  1683. else
  1684. err "Relation $DARKBLUE$relation_name$NORMAL on $DARKYELLOW$target_service$NORMAL failed to run properly."
  1685. fi
  1686. if [ "$target_errlvl" == 0 -a "$errlvl" == 0 ]; then
  1687. debug "Relation $DARKBLUE$relation_name$NORMAL is established" \
  1688. "between $DARKYELLOW$service$NORMAL and $DARKYELLOW$target_service$NORMAL."
  1689. return 0
  1690. else
  1691. return 1
  1692. fi
  1693. }
  1694. export -f _run_service_relation
  1695. _get_compose_relations_cached () {
  1696. local compose_service_def="$1" cache_file="$CACHEDIR/$FUNCNAME.cache.$(echo "$*" | md5_compat)" \
  1697. relation_name relation_def target_service
  1698. if [ -e "$cache_file" ]; then
  1699. #debug "$FUNCNAME: STATIC cache hit $1"
  1700. cat "$cache_file" &&
  1701. touch "$cache_file" || return 1
  1702. return 0
  1703. fi
  1704. (
  1705. set -o pipefail
  1706. if [ "$compose_service_def" ]; then
  1707. while read-0 relation_name relation_def; do
  1708. ## XXXvlab: could we use braces here instead of parenthesis ?
  1709. (
  1710. case "$(echo "$relation_def" | shyaml get-type 2>/dev/null)" in
  1711. "str")
  1712. target_service="$(echo "$relation_def" | shyaml get-value 2>/dev/null)" || return 1
  1713. tech_dep="$(get_service_relation_tech_dep "$target_service" "$relation_name")" || return 1
  1714. printf "%s\0" "$relation_name" "$target_service" "" "$tech_dep"
  1715. ;;
  1716. "sequence")
  1717. while read-0 target_service; do
  1718. tech_dep="$(get_service_relation_tech_dep "$target_service" "$relation_name")" || return 1
  1719. printf "%s\0" "$relation_name" "$target_service" "" "$tech_dep"
  1720. done < <(echo "$relation_def" | shyaml get-values-0 2>/dev/null)
  1721. ;;
  1722. "struct")
  1723. while read-0 target_service relation_config; do
  1724. tech_dep="$(get_service_relation_tech_dep "$target_service" "$relation_name")" || return 1
  1725. printf "%s\0" "$relation_name" "$target_service" "$relation_config" "$tech_dep"
  1726. done < <(echo "$relation_def" | shyaml key-values-0 2>/dev/null)
  1727. ;;
  1728. esac
  1729. ) </dev/null >> "$cache_file" || return 1
  1730. done < <(echo "$compose_service_def" | shyaml key-values-0 relations 2>/dev/null)
  1731. fi
  1732. )
  1733. if [ "$?" != 0 ]; then
  1734. err "Error while looking for compose relations."
  1735. rm -f "$cache_file" ## no cache
  1736. return 1
  1737. fi
  1738. [ -e "$cache_file" ] && cat "$cache_file"
  1739. return 0
  1740. }
  1741. export -f _get_compose_relations_cached
  1742. get_compose_relations () {
  1743. local service="$1" cache_file="$state_tmpdir/$FUNCNAME.cache.$1" \
  1744. compose_def
  1745. if [ -e "$cache_file" ]; then
  1746. #debug "$FUNCNAME: SESSION cache hit $1"
  1747. cat "$cache_file"
  1748. return 0
  1749. fi
  1750. compose_def="$(get_compose_service_def "$service")" || return 1
  1751. _get_compose_relations_cached "$compose_def" > "$cache_file"
  1752. if [ "$?" != 0 ]; then
  1753. rm -f "$cache_file" ## no cache
  1754. return 1
  1755. fi
  1756. cat "$cache_file"
  1757. }
  1758. export -f get_compose_relations
  1759. get_service_relations () {
  1760. local service="$1" cache_file="$state_tmpdir/$FUNCNAME.cache.$(H "$@" "$ALL_RELATIONS")" \
  1761. s rn ts rc td
  1762. if [ -e "$cache_file" ]; then
  1763. #debug "$FUNCNAME: SESSION cache hit $1"
  1764. cat "$cache_file"
  1765. return 0
  1766. fi
  1767. if [ -z "$ALL_RELATIONS" ]; then
  1768. err "Can't access global \$ALL_RELATIONS"
  1769. return 1
  1770. fi
  1771. while read-0 s rn ts rc td; do
  1772. [[ "$s" == "$service" ]] || continue
  1773. printf "%s\0" "$rn" "$ts" "$rc" "$td"
  1774. done < <(cat "$ALL_RELATIONS") > "$cache_file"
  1775. if [ "$?" != 0 ]; then
  1776. rm -f "$cache_file" ## no cache
  1777. return 1
  1778. fi
  1779. cat "$cache_file"
  1780. }
  1781. export -f get_service_relations
  1782. get_service_relation() {
  1783. local service="$1" relation="$2" cache_file="$state_tmpdir/$FUNCNAME.cache.$1.$2" \
  1784. rn ts rc td
  1785. if [ -e "$cache_file" ]; then
  1786. #debug "$FUNCNAME: SESSION cache hit $1"
  1787. cat "$cache_file"
  1788. return 0
  1789. fi
  1790. while read-0 rn ts rc td; do
  1791. [ "$relation" == "$rn" ] && {
  1792. printf "%s\0" "$ts" "$rc" "$td"
  1793. break
  1794. }
  1795. done < <(get_service_relations "$service") > "$cache_file"
  1796. if [ "$?" != 0 ]; then
  1797. rm -f "$cache_file" ## no cache
  1798. return 1
  1799. fi
  1800. cat "$cache_file"
  1801. }
  1802. export -f get_service_relation
  1803. export TRAVERSE_SEPARATOR=:
  1804. ## Traverse on first service satisfying relation
  1805. service:traverse() {
  1806. local service_path="$1"
  1807. {
  1808. SEPARATOR=:
  1809. read -d "$TRAVERSE_SEPARATOR" service
  1810. while read -d "$TRAVERSE_SEPARATOR" relation; do
  1811. ## XXXvlab: Take only first service
  1812. if ! read-0 ts _ _ < <(get_service_relation "${service}" "${relation}"); then
  1813. err "Couldn't find relation ${DARKCYAN}${relation}${NORMAL}" \
  1814. "from ${DARKYELLOW}$service${NORMAL}."
  1815. return 1
  1816. fi
  1817. service="$ts"
  1818. done
  1819. echo "$service"
  1820. } < <(e "${service_path}${TRAVERSE_SEPARATOR}")
  1821. }
  1822. export -f service:traverse
  1823. service:relation-file() {
  1824. local service_path="$1" relation service relation_file
  1825. if ! [[ "$service_path" == *"$TRAVERSE_SEPARATOR"* ]]; then
  1826. err "Invalid argument '$service_path'." \
  1827. "Must provide a service path (no '${TRAVERSE_SEPARATOR}' found)."
  1828. return 1
  1829. fi
  1830. relation="${service_path##*${TRAVERSE_SEPARATOR}}"
  1831. service=$(service:traverse "${service_path%${TRAVERSE_SEPARATOR}*}") || return 1
  1832. if ! read-0 ts rc _ < <(get_service_relation "${service}" "${relation}"); then
  1833. err "Couldn't find relation ${DARKCYAN}${relation}${NORMAL}" \
  1834. "from ${DARKYELLOW}$service${NORMAL}."
  1835. return 1
  1836. fi
  1837. relation_dir=$(get_relation_data_dir "$service" "$ts" "$relation") || {
  1838. err "Failed to find relation file"
  1839. return 1
  1840. }
  1841. relation_file="$relation_dir/data"
  1842. if ! [ -e "$relation_file" ]; then
  1843. e "$rc" > "$relation_file"
  1844. chmod go-rwx "$relation_file" ## protecting this file
  1845. fi
  1846. echo "$relation_file"
  1847. }
  1848. export -f service:relation-file
  1849. service:relation-options() {
  1850. local service_path="$1" relation_file
  1851. relation_file=$(service:relation-file "$service_path") || {
  1852. err "Failed to find relation file"
  1853. return 1
  1854. }
  1855. cat "$relation_file"
  1856. }
  1857. export -f service:relation-options
  1858. relation:get() {
  1859. local service_path="$1" query="$2" relation_file
  1860. relation_file=$(service:relation-file "$service_path") || {
  1861. err "Failed to find relation file"
  1862. return 1
  1863. }
  1864. cfg-get-value "$query" < "$relation_file"
  1865. }
  1866. export -f relation:get
  1867. _get_charm_metadata_uses() {
  1868. local metadata="$1" cache_file="$CACHEDIR/$FUNCNAME.cache.$(printf "%s\0" "$@" | md5_compat)"
  1869. if [ -e "$cache_file" ]; then
  1870. #debug "$FUNCNAME: SESSION cache hit $1"
  1871. cat "$cache_file" || return 1
  1872. return 0
  1873. fi
  1874. printf "%s" "$metadata" | { shyaml key-values-0 uses 2>/dev/null || true; } | tee "$cache_file"
  1875. }
  1876. export -f _get_charm_metadata_uses
  1877. _get_service_metadata() {
  1878. local service="$1" cache_file="$state_tmpdir/$FUNCNAME.cache.$1" \
  1879. charm
  1880. if [ -e "$cache_file" ]; then
  1881. #debug "$FUNCNAME: SESSION cache hit $1"
  1882. cat "$cache_file"
  1883. return 0
  1884. fi
  1885. charm="$(get_service_charm "$service")" || return 1
  1886. charm.metadata "$charm" > "$cache_file"
  1887. if [ "$?" != 0 ]; then
  1888. rm -f "$cache_file" ## no cache
  1889. return 1
  1890. fi
  1891. cat "$cache_file"
  1892. }
  1893. export -f _get_service_metadata
  1894. _get_service_uses() {
  1895. local service="$1" cache_file="$state_tmpdir/$FUNCNAME.cache.$1" \
  1896. metadata
  1897. if [ -e "$cache_file" ]; then
  1898. #debug "$FUNCNAME: SESSION cache hit $1"
  1899. cat "$cache_file"
  1900. return 0
  1901. fi
  1902. metadata="$(_get_service_metadata "$service")" || return 1
  1903. _get_charm_metadata_uses "$metadata" > "$cache_file"
  1904. if [ "$?" != 0 ]; then
  1905. rm -f "$cache_file" ## no cache
  1906. return 1
  1907. fi
  1908. cat "$cache_file"
  1909. }
  1910. export -f _get_service_uses
  1911. _get_services_uses() {
  1912. local cache_file="$state_tmpdir/$FUNCNAME.cache.$(printf "%s\0" "$@" | md5_compat)" \
  1913. service rn rd
  1914. if [ -e "$cache_file" ]; then
  1915. #debug "$FUNCNAME: SESSION cache hit $1"
  1916. cat "$cache_file"
  1917. return 0
  1918. fi
  1919. for service in "$@"; do
  1920. _get_service_uses "$service" | while read-0 rn rd; do
  1921. printf "%s\0" "$service" "$rn" "$rd"
  1922. done
  1923. [ "${PIPESTATUS[0]}" == 0 ] || {
  1924. return 1
  1925. }
  1926. done > "${cache_file}.wip"
  1927. mv "${cache_file}"{.wip,} &&
  1928. cat "$cache_file" || return 1
  1929. }
  1930. export -f _get_services_uses
  1931. _get_provides_provides() {
  1932. local provides="$1" cache_file="$CACHEDIR/$FUNCNAME.cache.$(printf "%s\0" "$@" | md5_compat)" \
  1933. service rn rd
  1934. if [ -e "$cache_file" ]; then
  1935. # debug "$FUNCNAME: CACHEDIR cache hit $1"
  1936. cat "$cache_file"
  1937. return 0
  1938. fi
  1939. type=$(printf "%s" "$provides" | shyaml get-type)
  1940. case "$type" in
  1941. sequence)
  1942. while read-0 prov; do
  1943. printf "%s\0" "$prov" ""
  1944. done < <(echo "$provides" | shyaml get-values-0)
  1945. ;;
  1946. struct)
  1947. printf "%s" "$provides" | shyaml key-values-0
  1948. ;;
  1949. str)
  1950. printf "%s\0" "$(echo "$provides" | shyaml get-value)" ""
  1951. ;;
  1952. *)
  1953. err "Unexpected type '$type' for provider identifier in charm '$charm'."
  1954. return 1
  1955. esac | tee "$cache_file"
  1956. return "${PIPESTATUS[0]}"
  1957. }
  1958. _get_metadata_provides() {
  1959. local metadata="$1" cache_file="$CACHEDIR/$FUNCNAME.cache.$(printf "%s\0" "$@" | md5_compat)" \
  1960. service rn rd
  1961. if [ -e "$cache_file" ]; then
  1962. #debug "$FUNCNAME: CACHEDIR cache hit"
  1963. cat "$cache_file"
  1964. return 0
  1965. fi
  1966. provides=$(printf "%s" "$metadata" | shyaml get-value -y -q provides "")
  1967. [ "$provides" -a "$provides" != "''" ] || { touch "$cache_file"; return 0; }
  1968. _get_provides_provides "$provides" | tee "$cache_file"
  1969. return "${PIPESTATUS[0]}"
  1970. }
  1971. _get_services_provides() {
  1972. local cache_file="$state_tmpdir/$FUNCNAME.cache.$(printf "%s\0" "$@" | md5_compat)" \
  1973. service rn rd
  1974. if [ -e "$cache_file" ]; then
  1975. #debug "$FUNCNAME: SESSION cache hit $1"
  1976. cat "$cache_file"
  1977. return 0
  1978. fi
  1979. ## YYY: replace the inner loop by a cached function
  1980. for service in "$@"; do
  1981. metadata="$(_get_service_metadata "$service")" || return 1
  1982. while read-0 rn rd; do
  1983. printf "%s\0" "$service" "$rn" "$rd"
  1984. done < <(_get_metadata_provides "$metadata")
  1985. done > "$cache_file"
  1986. if [ "$?" != 0 ]; then
  1987. rm -f "$cache_file" ## no cache
  1988. return 1
  1989. fi
  1990. cat "$cache_file"
  1991. }
  1992. export -f _get_services_provides
  1993. _get_charm_provides() {
  1994. local cache_file="$CACHEDIR/$FUNCNAME.cache.$(charm.store_metadata_hash)" errlvl
  1995. if [ -e "$cache_file" ]; then
  1996. #debug "$FUNCNAME: SESSION cache hit"
  1997. cat "$cache_file"
  1998. return 0
  1999. fi
  2000. start="$SECONDS"
  2001. debug "Getting charm provider list..."
  2002. while read-0 charm _ realpath metadata; do
  2003. metadata="$(charm.metadata "$charm")" || continue
  2004. # echo "reading $charm" >&2
  2005. while read-0 rn rd; do
  2006. printf "%s\0" "$charm" "$rn" "$rd"
  2007. done < <(_get_metadata_provides "$metadata")
  2008. done < <(charm.ls) | tee "$cache_file"
  2009. errlvl="${PIPESTATUS[0]}"
  2010. debug " ..charm provider list done $GRAY(in $((SECONDS - start))s)$NORMAL"
  2011. return "$errlvl"
  2012. }
  2013. _get_charm_providing() {
  2014. local cache_file="$state_tmpdir/$FUNCNAME.cache.$(printf "%s\0" "$@" | md5_compat)" \
  2015. relation="$1"
  2016. if [ -e "$cache_file" ]; then
  2017. #debug "$FUNCNAME: SESSION cache hit $1"
  2018. cat "$cache_file"
  2019. return 0
  2020. fi
  2021. while read-0 charm relation_name relation_def; do
  2022. [ "$relation_name" == "$relation" ] || continue
  2023. printf "%s\0" "$charm" "$relation_def"
  2024. done < <(_get_charm_provides) > "$cache_file"
  2025. if [ "$?" != 0 ]; then
  2026. rm -f "$cache_file" ## no cache
  2027. return 1
  2028. fi
  2029. cat "$cache_file"
  2030. }
  2031. _get_services_providing() {
  2032. local cache_file="$state_tmpdir/$FUNCNAME.cache.$(printf "%s\0" "$@" | md5_compat)" \
  2033. relation="$1"
  2034. shift ## services is "$@"
  2035. if [ -e "$cache_file" ]; then
  2036. #debug "$FUNCNAME: SESSION cache hit $1"
  2037. cat "$cache_file"
  2038. return 0
  2039. fi
  2040. while read-0 service relation_name relation_def; do
  2041. [ "$relation_name" == "$relation" ] || continue
  2042. printf "%s\0" "$service" "$relation_def"
  2043. done < <(_get_services_provides "$@") > "$cache_file"
  2044. if [ "$?" != 0 ]; then
  2045. rm -f "$cache_file" ## no cache
  2046. return 1
  2047. fi
  2048. cat "$cache_file"
  2049. }
  2050. export -f _get_services_provides
  2051. _out_new_relation_from_defs() {
  2052. local service="$1" rn="$2" ts="$3" prov_def="$4" rel_def="$5" rc td rc_prov
  2053. rc_prov=$(printf "%s" "$prov_def" | shyaml -y get-value "default-options" 2>/dev/null)
  2054. ## YYYvlab: should be seen even in no debug mode no ?
  2055. rc=$(printf "%s" "$rel_def" | shyaml -y get-value "default-options" 2>/dev/null)
  2056. td=$(echo "$prov_def" | shyaml get-value 'tech-dep' 2>/dev/null)
  2057. td=${td:-True}
  2058. rc=$(merge_yaml_str "$rc_prov" "$rc") || return 1
  2059. after=$(_out_after_value_from_def "$service" "$rn" "$rel_def") || return 1
  2060. printf "%s\0" "$after" "$service" "$relation_name" "$ts" "$rc" "$td"
  2061. }
  2062. _out_after_value_from_def() {
  2063. local service="$1" relation_name="$2" relation_def="$3" after_t after
  2064. if after_t=$(echo "$relation_def" | shyaml get-type after 2>/dev/null); then
  2065. case "$after_t" in
  2066. sequence)
  2067. after="$(echo "$relation_def" | shyaml get-values after 2>/dev/null)" || return 1
  2068. after=",$service:${after//$'\n'/,$service:},"
  2069. ;;
  2070. struct)
  2071. err "Invalid type for ${WHITE}after${NORMAL}'s value in ${DARKBLUE}$relation_name${NORMAL}'s definition."
  2072. return 1
  2073. ;;
  2074. str)
  2075. after=",$service:$(echo "$relation_def" | shyaml get-value after "" 2>/dev/null)," || return 1
  2076. ;;
  2077. esac
  2078. else
  2079. after=""
  2080. fi
  2081. e "$after"
  2082. }
  2083. get_all_relations () {
  2084. local cache_file="$state_tmpdir/$FUNCNAME.cache.$(H "$@" "$(declare -p without_relations)")" \
  2085. services
  2086. if [ -e "${cache_file}" ]; then
  2087. #debug "$FUNCNAME: SESSION cache hit $1"
  2088. cat "${cache_file}"
  2089. return 0
  2090. fi
  2091. declare -A services
  2092. services_uses=()
  2093. ## XXXvlab: bwerk, leveraging cache to be able to get the errorlevel here.
  2094. _get_services_uses "$@" || return 1
  2095. array_read-0 services_uses < <(_get_services_uses "$@")
  2096. services_provides=()
  2097. ## XXXvlab: bwerk, leveraging cache to be able to get the errorlevel here.
  2098. _get_services_provides "$@" || return 1
  2099. array_read-0 services_provides < <(_get_services_provides "$@")
  2100. for service in "$@"; do
  2101. services[$service]=1
  2102. done
  2103. all_services=("$@")
  2104. while [ "${#all_services[@]}" != 0 ]; do
  2105. array_pop all_services service
  2106. while read-0 relation_name ts relation_config tech_dep; do
  2107. [ "${without_relations[$service:$relation_name]}" ] && {
  2108. debug "Ignoring compose $DARKYELLOW$service$NORMAL --$DARKBLUE$relation_name$NORMAL--> ${DARKYELLOW}$ts$NORMAL"
  2109. continue
  2110. }
  2111. ## First is priority, that can be adjusted in second step
  2112. printf "%s\0" "" "$service" "$relation_name" "$ts" "$relation_config" "$tech_dep"
  2113. ## adding target services ?
  2114. [ "${services[$ts]}" ] && continue
  2115. array_read-0 services_uses < <(_get_services_uses "$ts")
  2116. all_services+=("$ts")
  2117. services[$ts]=1
  2118. done < <(get_compose_relations "$service")
  2119. done > "${cache_file}.wip"
  2120. while true; do
  2121. changed=
  2122. new_services_uses=()
  2123. summon=()
  2124. required=()
  2125. recommended=()
  2126. optional=()
  2127. while [ "${#services_uses[@]}" != 0 ]; do
  2128. service="${services_uses[0]}"
  2129. relation_name="${services_uses[1]}"
  2130. relation_def="${services_uses[2]}"
  2131. services_uses=("${services_uses[@]:3}")
  2132. [ "${without_relations[$service:$relation_name]}" ] && {
  2133. debug "Skipping $DARKYELLOW$service$NORMAL --$DARKBLUE$relation_name$NORMAL--> $DARKYELLOW*$NORMAL"
  2134. continue
  2135. }
  2136. default_options=$(printf "%s" "$relation_def" | shyaml -y get-value "default-options" 2>/dev/null)
  2137. after=$(_out_after_value_from_def "$service" "$relation_name" "$relation_def") || return 1
  2138. ## is this "use" declaration satisfied ?
  2139. found=
  2140. while read-0 p s rn ts rc td; do
  2141. if [ -z "$found" -a "$service" == "$s" -a "$relation_name" == "$rn" ]; then
  2142. if [ "$default_options" ]; then
  2143. rc=$(merge_yaml_str "$default_options" "$rc") || return 1
  2144. fi
  2145. found="$ts"
  2146. p="$after"
  2147. fi
  2148. printf "%s\0" "$p" "$s" "$rn" "$ts" "$rc" "$td"
  2149. done < "${cache_file}.wip" > "${cache_file}.wip.new"
  2150. mv "${cache_file}.wip.new" "${cache_file}.wip"
  2151. if [ "$found" ]; then ## this "use" declaration was satisfied
  2152. debug "${DARKYELLOW}$service${NORMAL} use declaration for relation" \
  2153. "${DARKBLUE}$relation_name${NORMAL} is satisfied with ${DARKYELLOW}$found${NORMAL}"
  2154. continue
  2155. fi
  2156. auto=$(echo "$relation_def" | shyaml get-value auto pair 2>/dev/null)
  2157. case "$auto" in
  2158. "pair"|"summon")
  2159. service_list=()
  2160. array_read-0 service_list < <(array_keys_to_stdin services)
  2161. providers=()
  2162. providers_def=()
  2163. array_read-0 providers providers_def < <(_get_services_providing "$relation_name" "${service_list[@]}")
  2164. if [ "${#providers[@]}" == 1 ]; then
  2165. ts="${providers[0]}"
  2166. debug "Auto-pairs ${DARKYELLOW}$service${NORMAL}" \
  2167. "--${DARKBLUE}$relation_name${NORMAL}--> ${DARKYELLOW}$ts${NORMAL}"
  2168. _out_new_relation_from_defs "$service" "$relation_name" "$ts" \
  2169. "${providers_def[0]}" "$relation_def" \
  2170. >> "${cache_file}.wip"
  2171. ## Adding service
  2172. [ "${services[$ts]}" ] && continue
  2173. array_read-0 new_services_uses < <(_get_services_uses "$ts")
  2174. services[$ts]=1
  2175. changed=1
  2176. continue
  2177. elif [ "${#providers[@]}" -gt 1 ]; then
  2178. msg=""
  2179. warn "No auto-pairing ${DARKYELLOW}$service${NORMAL}" \
  2180. "--${DARKBLUE}$relation_name${NORMAL}--> ($DARKYELLOW""${providers[@]}""$NORMAL)"\
  2181. "(> 1 provider)."
  2182. continue
  2183. else
  2184. if [ "$auto" == "summon" ]; then
  2185. summon+=("$service" "$relation_name" "$relation_def")
  2186. fi
  2187. fi
  2188. ;;
  2189. ""|null|disable|disabled)
  2190. :
  2191. ;;
  2192. *)
  2193. err "Invalid ${WHITE}auto${NORMAL} value '$auto'."
  2194. return 1
  2195. ;;
  2196. esac
  2197. constraint=$(echo "$relation_def" | shyaml get-value constraint optional 2>/dev/null)
  2198. case "$constraint" in
  2199. "required")
  2200. required+=("$service" "$relation_name" "$relation_def")
  2201. ;;
  2202. "recommended")
  2203. recommended+=("$service" "$relation_name" "$relation_def")
  2204. ;;
  2205. "optional")
  2206. optional+=("$service" "$relation_name" "$relation_def")
  2207. ;;
  2208. *)
  2209. err "Invalid ${WHITE}constraint${NORMAL} value '$constraint'."
  2210. return 1
  2211. ;;
  2212. esac
  2213. new_services_uses+=("$service" "$relation_name" "$relation_def") ## re-queue it
  2214. done
  2215. services_uses=("${new_services_uses[@]}")
  2216. if [ "$changed" ]; then
  2217. continue
  2218. fi
  2219. ## situation is stable
  2220. if [ "${#summon[@]}" != 0 ]; then
  2221. while [ "${#summon[@]}" != 0 ]; do
  2222. service="${summon[0]}"
  2223. relation_name="${summon[1]}"
  2224. relation_def="${summon[2]}"
  2225. summon=("${summon[@]:3}")
  2226. providers=()
  2227. providers_def=()
  2228. array_read-0 providers providers_def < <(_get_charm_providing "$relation_name" "${service_list[@]}")
  2229. if [ "${#providers[@]}" == 0 ]; then
  2230. err "Summoning a ${DARKBLUE}$relation_name${NORMAL} provider failed: none were found in charm store."
  2231. return 1
  2232. fi
  2233. if [ "${#providers[@]}" -gt 1 ]; then
  2234. warn "Auto-summon ${DARKYELLOW}$service${NORMAL}" \
  2235. "--${DARKBLUE}$relation_name${NORMAL}--> ($DARKYELLOW""${providers[@]}""$NORMAL)"\
  2236. "(> 1 provider). Choosing first."
  2237. fi
  2238. ts="${providers[0]}"
  2239. ## YYYvlab: should be seen even in no debug mode no ?
  2240. debug "Auto-summon ${DARKYELLOW}$service${NORMAL}" \
  2241. "--${DARKBLUE}$relation_name${NORMAL}--> ${DARKYELLOW}$ts${NORMAL}"
  2242. _out_new_relation_from_defs "$service" "$relation_name" "$ts" \
  2243. "${providers_def[0]}" "$relation_def" \
  2244. >> "${cache_file}.wip"
  2245. ## Adding service
  2246. [ "${services[$ts]}" ] && continue
  2247. array_read-0 services_uses < <(_get_services_uses "$ts")
  2248. services[$ts]=1
  2249. changed=1
  2250. done
  2251. continue
  2252. fi
  2253. [ "$NO_CONSTRAINT_CHECK" ] && break
  2254. if [ "${#required[@]}" != 0 ]; then
  2255. echo "$(_display_solves required)" | sed -r "s/^/${RED}||${NORMAL} /g" >&2
  2256. err "Required relations not satisfied"
  2257. return 1
  2258. fi
  2259. if [ "${#recommended[@]}" != 0 ]; then
  2260. ## make recommendation
  2261. echo "$(_display_solves recommended)" | sed -r "s/^/${YELLOW}||${NORMAL} /g" >&2
  2262. fi
  2263. if [ "${#optional[@]}" != 0 ]; then
  2264. ## inform about options
  2265. echo "$(_display_solves optional)" | sed -r "s/^/${BLUE}||${NORMAL} /g" >&2
  2266. fi
  2267. # if [ "${#required[@]}" != 0 ]; then
  2268. # err "Required relations not satisfied"
  2269. # return 1
  2270. # fi
  2271. if [ "${#recommended[@]}" != 0 ]; then
  2272. warn "Recommended relations not satisfied"
  2273. fi
  2274. break
  2275. done
  2276. if [ "$?" != 0 ]; then
  2277. rm -f "${cache_file}"{,.wip,.wip.new} ## no cache
  2278. return 1
  2279. fi
  2280. ##
  2281. ## Sort relations thanks to uses =metadata.yml= relations.
  2282. ##
  2283. mv "${cache_file}.wip"{,.in} &&
  2284. rm -f "${cache_file}.wip.final" &&
  2285. touch "${cache_file}.wip.final" || {
  2286. err "Unexpected error when mangling cache files."
  2287. return 1
  2288. }
  2289. declare -A relation_done=()
  2290. while true; do
  2291. had_remaining_relation=
  2292. had_new_relation=
  2293. while read-0 p s rn ts rc td; do
  2294. if [ -z "$p" ] || [ "$p" == "," ]; then
  2295. relation_done["$s:$rn"]=1
  2296. # printf " .. %-30s %-30s %-30s\n" "--" "$s" "$rn" >&2
  2297. printf "%s\0" "$s" "$rn" "$ts" "$rc" "$td" >> "${cache_file}.wip.final"
  2298. had_new_relation=1
  2299. else
  2300. # printf " !! %-30s %-30s %-30s\n" "$p" "$s" "$rn" >&2
  2301. printf "%s\0" "$p" "$s" "$rn" "$ts" "$rc" "$td" >> "${cache_file}.wip.out"
  2302. had_remaining_relation=1
  2303. fi
  2304. done < "${cache_file}.wip.in"
  2305. [ -z "$had_remaining_relation" ] && break
  2306. mv "${cache_file}.wip."{out,in}
  2307. while read-0 p s rn ts rc td; do
  2308. for rel in "${!relation_done[@]}"; do
  2309. p="${p//,$rel,/,}"
  2310. done
  2311. # printf " CC %-30s %-30s %-30s\n" "$p" "$s" "$rn" >&2
  2312. if [ -z "$had_new_relation" ]; then
  2313. err "${DARKYELLOW}$s${NORMAL} --${DARKBLUE}$rn${NORMAL}--> ${DARKYELLOW}$ts${NORMAL} missing required ${WHITE}after${NORMAL} relations:"
  2314. for rel in ${p//,/ }; do
  2315. rel_s=${rel%%:*}
  2316. rel_r=${rel##*:}
  2317. echo " - ${DARKYELLOW}$rel_s${NORMAL} --${DARKBLUE}$rel_r${NORMAL}--> ${DARKGRAY}*${NORMAL}" >&2
  2318. done
  2319. else
  2320. printf "%s\0" "$p" "$s" "$rn" "$ts" "$rc" "$td" >> "${cache_file}.wip.out"
  2321. fi
  2322. done < "${cache_file}.wip.in"
  2323. if [ -z "$had_new_relation" ]; then
  2324. rm -f "${cache_file}"{,.wip{,new,in,out,final}} ## no cache
  2325. return 1
  2326. fi
  2327. mv "${cache_file}.wip."{out,in}
  2328. done
  2329. export ALL_RELATIONS="$cache_file"
  2330. mv "${cache_file}"{.wip.final,} || return 1
  2331. cat "$cache_file"
  2332. }
  2333. export -f get_all_relations
  2334. _display_solves() {
  2335. local array_name="$1" by_relation msg
  2336. ## inform about options
  2337. msg=""
  2338. declare -A by_relation
  2339. while read-0 service relation_name relation_def; do
  2340. solves=$(printf "%s" "$relation_def" | shyaml -y get-value solves 2>/dev/null);
  2341. auto=$(printf "%s" "$relation_def" | shyaml get-value auto 2>/dev/null);
  2342. if [ -z "$solves" ]; then
  2343. continue
  2344. fi
  2345. by_relation[$relation_name]+=$(printf "\n %s" "${DARKYELLOW}$service$NORMAL for:")
  2346. if [ "$auto" == "pair" ]; then
  2347. requirement="add provider in cluster to auto-pair"
  2348. else
  2349. requirement="add explicit relation"
  2350. fi
  2351. while read-0 name def; do
  2352. by_relation[$relation_name]+=$(printf "\n - ${DARKCYAN}%-15s${NORMAL} %s (%s)" "$name" "$def" "$requirement")
  2353. done < <(printf "%s" "$solves" | shyaml key-values-0)
  2354. done < <(array_values_to_stdin "$array_name")
  2355. while read-0 relation_name message; do
  2356. msg+="$(printf "\n${DARKBLUE}%s$NORMAL provider is $array_name by%s" \
  2357. "$relation_name" "$message" )"
  2358. done < <(array_kv_to_stdin by_relation)
  2359. if [ "$msg" ]; then
  2360. printf "%s\n" "${msg:1}"
  2361. fi
  2362. }
  2363. get_compose_relation_def() {
  2364. local service="$1" relation="$2" relation_name target_service relation_config tech_dep
  2365. while read-0 relation_name target_service relation_config tech_dep; do
  2366. [ "$relation_name" == "$relation" ] || continue
  2367. printf "%s\0%s\0%s\0" "$target_service" "$relation_config" "$tech_dep"
  2368. done < <(get_compose_relations "$service") || return 1
  2369. }
  2370. export -f get_compose_relation_def
  2371. run_service_relations () {
  2372. local service services loaded subservices subservice
  2373. PROJECT_NAME=$(get_default_project_name) || return 1
  2374. export PROJECT_NAME
  2375. declare -A loaded
  2376. subservices=$(get_ordered_service_dependencies "$@") || return 1
  2377. for service in $subservices; do
  2378. # debug "Upping dep's relations of ${DARKYELLOW}$service${NORMAL}:"
  2379. for subservice in $(get_service_deps "$service") "$service"; do
  2380. [ "${loaded[$subservice]}" ] && continue
  2381. export BASE_SERVICE_NAME=$service
  2382. MASTER_BASE_SERVICE_NAME=$(get_top_master_service_for_service "$subservice") || return 1
  2383. MASTER_BASE_CHARM_NAME=$(get_service_charm "$MASTER_BASE_SERVICE_NAME") || return 1
  2384. RELATION_BASE_COMPOSE_DEF=$(get_compose_service_def "$subservice") || return 1
  2385. export RELATION_BASE_COMPOSE_DEF MASTER_BASE_{CHARM,SERVICE}_NAME
  2386. # debug " Relations of ${DARKYELLOW}$subservice${NORMAL}:"
  2387. while read-0 relation_name target_service relation_config tech_dep; do
  2388. export relation_config
  2389. export TARGET_SERVICE_NAME=$target_service
  2390. MASTER_TARGET_SERVICE_NAME=$(get_top_master_service_for_service "$target_service") || return 1
  2391. MASTER_TARGET_CHARM_NAME=$(get_service_charm "$MASTER_TARGET_SERVICE_NAME") || return 1
  2392. RELATION_TARGET_COMPOSE_DEF=$(get_compose_service_def "$target_service") || return 1
  2393. export RELATION_TARGET_COMPOSE_DEF MASTER_TARGET_{CHARM,SERVICE}_NAME
  2394. Wrap "${wrap_opts[@]}" -d "Building $DARKYELLOW$subservice$NORMAL --$DARKBLUE$relation_name$NORMAL--> $DARKYELLOW$target_service$NORMAL" <<EOF || return 1
  2395. _run_service_relation "$relation_name" "$subservice" "$target_service" "\$relation_config"
  2396. EOF
  2397. done < <(get_service_relations "$subservice") || return 1
  2398. loaded[$subservice]=1
  2399. done
  2400. done
  2401. }
  2402. export -f run_service_relations
  2403. _run_service_action_direct() {
  2404. local service="$1" action="$2" charm _dummy project_name
  2405. shift; shift
  2406. read-0 charm action_script_path || true ## against 'set -e' that could be setup in parent scripts
  2407. if read-0 _dummy || [ "$_dummy" ]; then
  2408. print_syntax_error "$FUNCNAME: too many arguments in action descriptor"
  2409. return 1
  2410. fi
  2411. project_name=$(get_default_project_name) || return 1
  2412. export PROJECT_NAME="$project_name"
  2413. export state_tmpdir
  2414. (
  2415. set +e ## Prevents unwanted leaks from parent shell
  2416. export COMPOSE_CONFIG=$(get_compose_yml_content)
  2417. export METADATA_CONFIG=$(charm.metadata "$charm")
  2418. export SERVICE_NAME=$service
  2419. export ACTION_NAME=$action
  2420. export ACTION_SCRIPT_PATH="$action_script_path"
  2421. export CONTAINER_NAME=$(get_top_master_service_for_service "$service")
  2422. export DOCKER_BASE_IMAGE=$(service_base_docker_image "$CONTAINER_NAME")
  2423. export SERVICE_DATASTORE="$DATASTORE/$service"
  2424. export SERVICE_CONFIGSTORE="$CONFIGSTORE/$service"
  2425. exname="$exname $ACTION_NAME $SERVICE_NAME" \
  2426. stdbuf -oL -eL bash -c 'charm.run_direct_action "$@"' -- "$charm" "$action" "$@"
  2427. ) 0<&6 ## inject general stdin
  2428. }
  2429. export -f _run_service_action_direct
  2430. _run_service_action_relation() {
  2431. local service="$1" action="$2" charm target_charm relation_name relation_config _dummy
  2432. shift; shift
  2433. read-0 charm target_service target_charm relation_name relation_config action_script_path || true
  2434. if read-0 _dummy || [ "$_dummy" ]; then
  2435. print_syntax_error "$FUNCNAME: too many arguments in action descriptor"
  2436. return 1
  2437. fi
  2438. export action_errlvl_file="$state_tmpdir/action-$service-$charm-$action-errlvl"
  2439. export state_tmpdir
  2440. (
  2441. set +e ## Prevents unwanted leaks from parent shell
  2442. export METADATA_CONFIG=$(charm.metadata "$charm")
  2443. export SERVICE_NAME=$service
  2444. export RELATION_TARGET_SERVICE="$target_service"
  2445. export RELATION_TARGET_CHARM="$target_charm"
  2446. export RELATION_BASE_SERVICE="$service"
  2447. export RELATION_BASE_CHARM="$charm"
  2448. export ACTION_NAME=$action
  2449. export ACTION_SCRIPT_PATH="$action_script_path"
  2450. export CONTAINER_NAME=$(get_top_master_service_for_service "$service")
  2451. export DOCKER_BASE_IMAGE=$(service_base_docker_image "$CONTAINER_NAME")
  2452. export SERVICE_DATASTORE="$DATASTORE/$service"
  2453. export SERVICE_CONFIGSTORE="$CONFIGSTORE/$service"
  2454. exname="$exname $ACTION_NAME $SERVICE_NAME" \
  2455. stdbuf -oL -eL bash -c 'charm.run_relation_action "$@"' -- "$target_charm" "$relation_name" "$action" "$@"
  2456. ) 0<&6 ## inject general stdin
  2457. }
  2458. export -f _run_service_action_relation
  2459. get_relation_data_dir() {
  2460. local service="$1" target_service="$2" relation_name="$3" \
  2461. cache_file="$state_tmpdir/$FUNCNAME.cache.$(printf "%s\0" "$@" | md5_compat)"
  2462. if [ -e "$cache_file" ]; then
  2463. # debug "$FUNCNAME: cache hit ($*)"
  2464. cat "$cache_file"
  2465. return 0
  2466. fi
  2467. local project relation_dir
  2468. project=${PROJECT_NAME}
  2469. if [ -z "$project" ]; then
  2470. project=$(get_default_project_name) || return 1
  2471. fi
  2472. relation_dir="$VARDIR/relations/$project/${service}-${target_service}/$relation_name"
  2473. if ! [ -d "$relation_dir" ]; then
  2474. mkdir -p "$relation_dir" || return 1
  2475. chmod go-rwx "$relation_dir" || return 1 ## protecting this directory
  2476. fi
  2477. echo "$relation_dir" | tee "$cache_file"
  2478. }
  2479. export -f get_relation_data_dir
  2480. get_relation_data_file() {
  2481. local service="$1" target_service="$2" relation_name="$3" relation_config="$4"
  2482. relation_dir=$(get_relation_data_dir "$service" "$target_service" "$relation_name") || return 1
  2483. relation_data_file="$relation_dir/data"
  2484. new=
  2485. if [ -e "$relation_data_file" ]; then
  2486. ## Has reference changed ?
  2487. new_md5=$(e "$relation_config" | md5_compat)
  2488. if [ "$new_md5" != "$(cat "$relation_data_file.md5_ref" 2>/dev/null)" ]; then
  2489. new=true
  2490. fi
  2491. else
  2492. new=true
  2493. fi
  2494. if [ "$new" ]; then
  2495. e "$relation_config" > "$relation_data_file"
  2496. chmod go-rwx "$relation_data_file" ## protecting this file
  2497. e "$relation_config" | md5_compat > "$relation_data_file.md5_ref"
  2498. fi
  2499. echo "$relation_data_file"
  2500. }
  2501. export -f get_relation_data_file
  2502. has_service_action () {
  2503. local service="$1" action="$2" cache_file="$state_tmpdir/$FUNCNAME.cache.$1" \
  2504. charm target_charm relation_name target_service relation_config _tech_dep \
  2505. path
  2506. if [ -e "$cache_file" ]; then
  2507. # debug "$FUNCNAME: cache hit ($*)"
  2508. cat "$cache_file"
  2509. return 0
  2510. fi
  2511. charm=$(get_service_charm "$service") || return 1
  2512. ## Action directly provided ?
  2513. if path=$(charm.has_direct_action "$charm" "$action"); then
  2514. p0 "direct" "$charm" "$path" | tee "$cache_file"
  2515. return 0
  2516. fi
  2517. ## Action provided by relation ?
  2518. while read-0 relation_name target_service relation_config _tech_dep; do
  2519. target_charm=$(get_service_charm "$target_service") || return 1
  2520. if path=$(charm.has_relation_action "$target_charm" "$relation_name" "$action"); then
  2521. p0 "relation" "$charm" "$target_service" "$target_charm" "$relation_name" "$relation_config" "$path" | tee "$cache_file"
  2522. return 0
  2523. fi
  2524. done < <(get_service_relations "$service")
  2525. return 1
  2526. # master=$(get_top_master_service_for_service "$service")
  2527. # [ "$master" == "$charm" ] && return 1
  2528. # has_service_action "$master" "$action"
  2529. }
  2530. export -f has_service_action
  2531. run_service_action () {
  2532. local service="$1" action="$2" errlvl
  2533. shift ; shift
  2534. exec 6<&0 ## saving stdin
  2535. {
  2536. if ! read-0 action_type; then
  2537. info "Service $DARKYELLOW$service$NORMAL does not have any action $DARKCYAN$action$NORMAL defined."
  2538. info " Add an executable script to 'actions/$action' to implement action."
  2539. return 1
  2540. fi
  2541. "_run_service_action_${action_type}" "$service" "$action" "$@"
  2542. errlvl="$?"
  2543. } < <(has_service_action "$service" "$action")
  2544. exec 0<&6 6<&- ## restoring stdin
  2545. return "$errlvl"
  2546. }
  2547. export -f run_service_action
  2548. get_compose_relation_config() {
  2549. local service=$1 relation_config cache_file="$state_tmpdir/$FUNCNAME.cache.$1"
  2550. if [ -e "$cache_file" ]; then
  2551. # debug "$FUNCNAME: cache hit ($*)"
  2552. cat "$cache_file"
  2553. return 0
  2554. fi
  2555. compose_service_def=$(get_compose_service_def "$service") || return 1
  2556. echo "$compose_service_def" | shyaml get-value "relations" 2>/dev/null | tee "$cache_file"
  2557. }
  2558. export -f get_compose_relation_config
  2559. # ## Return key-values-0
  2560. # get_compose_relation_config_for_service() {
  2561. # local service=$1 relation_name=$2 relation_config
  2562. # compose_service_relations=$(get_compose_relation_config "$service") || return 1
  2563. # if ! relation_config=$(
  2564. # echo "$compose_service_relations" |
  2565. # shyaml get-value "${relation_name}" 2>/dev/null); then
  2566. # err "Couldn't find $DARKYELLOW${service}$NORMAL/${WHITE}${relation_name}$NORMAL" \
  2567. # "relation config in compose configuration."
  2568. # return 1
  2569. # fi
  2570. # if [ -z "$relation_config" ]; then
  2571. # err "Relation ${WHITE}mysql-database$NORMAL is empty in compose configuration."
  2572. # return 1
  2573. # fi
  2574. # if ! echo "$relation_config" | shyaml key-values-0 2>/dev/null; then
  2575. # err "No key/values in ${DARKBLUE}mysql-database$NORMAL of compose config."
  2576. # return 1
  2577. # fi
  2578. # }
  2579. # export -f get_compose_relation_config_for_service
  2580. _get_container_relation() {
  2581. local metadata=$1 found relation_name relation_def
  2582. found=
  2583. while read-0 relation_name relation_def; do
  2584. [ "$(echo "$relation_def" | shyaml get-value "scope" 2>/dev/null)" == "container" ] && {
  2585. found="$relation_name"
  2586. break
  2587. }
  2588. done < <(_get_charm_metadata_uses "$metadata")
  2589. if [ -z "$found" ]; then
  2590. err "Charm $DARKPINK$charm$NORMAL is a subordinate but does not have any required relation declaration with" \
  2591. "${WHITE}scope${NORMAL} set to 'container'."
  2592. return 1
  2593. fi
  2594. printf "%s" "$found"
  2595. }
  2596. _get_master_service_for_service_cached () {
  2597. local service="$1" charm="$2" metadata="$3" cache_file="$CACHEDIR/$FUNCNAME.cache.$(echo "$*" | md5_compat)" \
  2598. charm requires master_charm target_charm target_service service_def found
  2599. if [ -e "$cache_file" ]; then
  2600. # debug "$FUNCNAME: STATIC cache hit ($1)"
  2601. cat "$cache_file" &&
  2602. touch "$cache_file" || return 1
  2603. return 0
  2604. fi
  2605. if [ "$(echo "$metadata" | shyaml get-value "subordinate" 2>/dev/null)" != "True" ]; then
  2606. ## just return service name
  2607. echo "$service" | tee "$cache_file"
  2608. return 0
  2609. fi
  2610. ## Action provided by relation ?
  2611. container_relation=$(_get_container_relation "$metadata") || return 1
  2612. read-0 target_service _ _ < <(get_service_relation "$service" "$container_relation")
  2613. if [ -z "$target_service" ]; then
  2614. err "Couldn't find ${WHITE}relations.${container_relation}${NORMAL} in" \
  2615. "${DARKYELLOW}$service$NORMAL compose definition."
  2616. err ${FUNCNAME[@]}
  2617. return 1
  2618. fi
  2619. echo "$target_service" | tee "$cache_file"
  2620. }
  2621. export -f _get_master_service_for_service_cached
  2622. get_master_service_for_service() {
  2623. local service="$1" cache_file="$state_tmpdir/$FUNCNAME.cache.$1" \
  2624. charm metadata result
  2625. if [ -e "$cache_file" ]; then
  2626. # debug "$FUNCNAME: SESSION cache hit ($*)"
  2627. cat "$cache_file" || return 1
  2628. return 0
  2629. fi
  2630. charm=$(get_service_charm "$service") || return 1
  2631. metadata=$(charm.metadata "$charm" 2>/dev/null) || {
  2632. metadata=""
  2633. warn "No charm $DARKPINK$charm$NORMAL found."
  2634. }
  2635. result=$(_get_master_service_for_service_cached "$service" "$charm" "$metadata") || return 1
  2636. echo "$result" | tee "$cache_file" || return 1
  2637. }
  2638. export -f get_master_service_for_service
  2639. get_top_master_service_for_service() {
  2640. local service="$1" cache_file="$state_tmpdir/$FUNCNAME.cache.$1" \
  2641. current_service
  2642. if [ -e "$cache_file" ]; then
  2643. # debug "$FUNCNAME: cache hit ($*)"
  2644. cat "$cache_file"
  2645. return 0
  2646. fi
  2647. current_service="$service"
  2648. while true; do
  2649. master_service=$(get_master_service_for_service "$current_service") || return 1
  2650. [ "$master_service" == "$current_service" ] && break
  2651. current_service="$master_service"
  2652. done
  2653. echo "$current_service" | tee "$cache_file"
  2654. return 0
  2655. }
  2656. export -f get_top_master_service_for_service
  2657. ##
  2658. ## The result is a mixin that is not always a complete valid
  2659. ## docker-compose entry (thinking of subordinates). The result
  2660. ## will be merge with master charms.
  2661. _get_docker_compose_mixin_from_metadata_cached() {
  2662. local service="$1" charm="$2" metadata="$3" \
  2663. has_build_dir="$4" \
  2664. cache_file="$CACHEDIR/$FUNCNAME.cache.$(echo "$*" | md5_compat)" \
  2665. metadata_file metadata volumes docker_compose subordinate image mixin mixins
  2666. if [ -e "$cache_file" ]; then
  2667. #debug "$FUNCNAME: STATIC cache hit $1"
  2668. cat "$cache_file" &&
  2669. touch "$cache_file" || return 1
  2670. return 0
  2671. fi
  2672. mixins=("$(echo -en "labels:\n- compose.charm=$charm")")
  2673. if [ "$metadata" ]; then
  2674. ## resources to volumes
  2675. volumes=$(
  2676. for resource_type in data config; do
  2677. while read-0 resource; do
  2678. eval "echo \" - \$HOST_${resource_type^^}STORE/\$service\$resource:\$resource:rw\""
  2679. done < <(echo "$metadata" | shyaml get-values-0 "${resource_type}-resources" 2>/dev/null)
  2680. done
  2681. while read-0 resource; do
  2682. if [[ "$resource" == /*:/*:* ]]; then
  2683. echo " - $resource"
  2684. elif [[ "$resource" == /*:/* ]]; then
  2685. echo " - $resource:rw"
  2686. elif [[ "$resource" == /*:* ]]; then
  2687. echo " - ${resource%%:*}:$resource"
  2688. elif [[ "$resource" =~ ^/[^:]+$ ]]; then
  2689. echo " - $resource:$resource:rw"
  2690. else
  2691. die "Invalid host-resource specified in 'metadata.yml'."
  2692. fi
  2693. done < <(printf "%s" "$metadata" | shyaml get-values-0 "host-resources" 2>/dev/null)
  2694. while read-0 resource; do
  2695. dest="$(charm.get_dir "$charm")/resources$resource"
  2696. if ! [ -e "$dest" ]; then
  2697. die "charm-resource: '$resource' does not exist (file: '$dest')."
  2698. fi
  2699. echo " - $dest:$resource:ro"
  2700. done < <(echo "$metadata" | shyaml get-values-0 "charm-resources" 2>/dev/null)
  2701. ) || return 1
  2702. if [ "$volumes" ]; then
  2703. mixins+=("volumes:"$'\n'"$volumes")
  2704. fi
  2705. type="$(printf "%s" "$metadata" | shyaml get-value type 2>/dev/null)" || true
  2706. if [ "$type" != "run-once" ]; then
  2707. mixins+=("restart: unless-stopped")
  2708. fi
  2709. docker_compose=$(printf "%s" "$metadata" | shyaml get-value -y "docker-compose" 2>/dev/null) || true
  2710. if [ "$docker_compose" ]; then
  2711. mixins+=("$docker_compose")
  2712. fi
  2713. if [ "$(echo "$metadata" | shyaml get-value "subordinate" 2>/dev/null)" == "True" ]; then
  2714. subordinate=true
  2715. fi
  2716. fi
  2717. image=$(echo "$metadata" | shyaml get-value "docker-image" 2>/dev/null)
  2718. [ "$image" == "None" ] && image=""
  2719. if [ "$image" ]; then
  2720. if [ "$subordinate" ]; then
  2721. err "Subordinate charm can not have a ${WHITE}docker-image${NORMAL} value."
  2722. return 1
  2723. fi
  2724. mixins+=("image: $image")
  2725. elif [ "$has_build_dir" ]; then
  2726. if [ "$subordinate" ]; then
  2727. err "Subordinate charm can not have a 'build' sub directory."
  2728. return 1
  2729. fi
  2730. mixins+=("build: $(charm.get_dir "$charm")/build")
  2731. fi
  2732. mixin=$(merge_yaml_str "${mixins[@]}") || {
  2733. err "Failed to merge mixins from ${DARKPINK}${charm}${NORMAL} metadata."
  2734. return 1
  2735. }
  2736. echo "$mixin" | tee "$cache_file"
  2737. }
  2738. export -f _get_docker_compose_mixin_from_metadata_cached
  2739. get_docker_compose_mixin_from_metadata() {
  2740. local service="$1" cache_file="$state_tmpdir/$FUNCNAME.cache.$1"
  2741. if [ -e "$cache_file" ]; then
  2742. #debug "$FUNCNAME: SESSION cache hit ($*)"
  2743. cat "$cache_file"
  2744. return 0
  2745. fi
  2746. charm=$(get_service_charm "$service") || return 1
  2747. metadata="$(charm.metadata "$charm" 2>/dev/null)" || return 1
  2748. has_build_dir=
  2749. [ -d "$(charm.get_dir "$charm")/build" ] && has_build_dir=true
  2750. mixin=$(_get_docker_compose_mixin_from_metadata_cached "$service" "$charm" "$metadata" "$has_build_dir") || return 1
  2751. echo "$mixin" | tee "$cache_file"
  2752. }
  2753. export -f get_docker_compose_mixin_from_metadata
  2754. _save() {
  2755. local name="$1"
  2756. cat - | tee -a "$docker_compose_dir/.data/$name"
  2757. }
  2758. export -f _save
  2759. get_default_project_name() {
  2760. if [ -n "$DEFAULT_PROJECT_NAME" ]; then
  2761. echo "$DEFAULT_PROJECT_NAME"
  2762. return 0
  2763. fi
  2764. local normalized_path compose_yml_location name
  2765. compose_yml_location="$(get_compose_yml_location)" || return 1
  2766. if [ -n "$compose_yml_location" ]; then
  2767. if normalized_path=$(readlink -f "$compose_yml_location"); then
  2768. name="${normalized_path%/*}" ## dirname
  2769. name="${name##*/}" ## basename
  2770. name="${name%%-deploy}" ## remove any '-deploy'
  2771. name="${name,,}" ## lowercase
  2772. e "$name"
  2773. return 0
  2774. fi
  2775. fi
  2776. echo "orphan"
  2777. return 0
  2778. }
  2779. export -f get_default_project_name
  2780. get_running_compose_containers() {
  2781. ## XXXvlab: docker bug: there will be a final newline anyway
  2782. docker ps --filter label="compose.service" --format='{{.ID}}'
  2783. }
  2784. export -f get_running_compose_containers
  2785. get_healthy_container_ip_for_service () {
  2786. local service="$1" port="$2" timeout=${3:-60}
  2787. local containers container container_network container_ip
  2788. containers="$(get_running_containers_for_service "$service")"
  2789. if [ -z "$containers" ]; then
  2790. err "No containers running for service $DARKYELLOW$service$NORMAL."
  2791. return 1
  2792. fi
  2793. ## XXXvlab: taking first container is probably not a good idea
  2794. container="$(echo "$containers" | head -n 1)"
  2795. ## XXXvlab: taking first ip is probably not a good idea
  2796. read-0 container_network container_ip < <(get_container_network_ip "$container")
  2797. if [ -z "$container_ip" ]; then
  2798. err "Can't get container's IP. You should check health of" \
  2799. "${DARKYELLOW}$service${NORMAL}'s container."
  2800. return 1
  2801. fi
  2802. wait_for_tcp_port "$container_network" "$container_ip:$port" "$timeout" || {
  2803. err "TCP port of ${DARKYELLOW}$service${NORMAL}'s container doesn't seem open"
  2804. echo " Please check that container is healthy. Here are last logs:" >&2
  2805. docker logs "$container" --tail=10 | prefix " ${GRAY}|${NORMAL} " >&2
  2806. return 1
  2807. }
  2808. info "Host/Port ${container_ip}:${port} checked ${GREEN}open${NORMAL}."
  2809. echo "$container_network:$container_ip"
  2810. }
  2811. export -f get_healthy_container_ip_for_service
  2812. switch_to_relation_service() {
  2813. local relation="$1"
  2814. ## XXXvlab: can't get real config here
  2815. if ! read-0 ts _ _ < <(get_service_relation "$SERVICE_NAME" "$relation"); then
  2816. err "Couldn't find relation ${DARKCYAN}$relation${NORMAL}."
  2817. return 1
  2818. fi
  2819. export SERVICE_NAME="$ts"
  2820. export SERVICE_DATASTORE="$DATASTORE/$SERVICE_NAME"
  2821. DOCKER_BASE_IMAGE=$(service_base_docker_image "$SERVICE_NAME")
  2822. export DOCKER_BASE_IMAGE
  2823. target_charm=$(get_service_charm "$ts") || return 1
  2824. target_charm_path=$(charm.get_dir "$target_charm") || return 1
  2825. cd "$target_charm_path"
  2826. }
  2827. export -f switch_to_relation_service
  2828. get_volumes_for_container() {
  2829. local container="$1"
  2830. docker inspect \
  2831. --format '{{range $mount := .Mounts}}{{$mount.Source}}{{"\x00"}}{{$mount.Destination}}{{"\x00"}}{{end}}' \
  2832. "$container"
  2833. }
  2834. export -f get_volumes_for_container
  2835. is_volume_used() {
  2836. local volume="$1" container_id src dst
  2837. while read -r container_id; do
  2838. while read-0 src dst; do
  2839. [[ "$src/" == "$volume"/* ]] && return 0
  2840. done < <(get_volumes_for_container "$container_id")
  2841. done < <(get_running_compose_containers)
  2842. return 1
  2843. }
  2844. export -f is_volume_used
  2845. clean_unused_docker_compose() {
  2846. for f in /var/lib/compose/docker-compose/*; do
  2847. [ -e "$f" ] || continue
  2848. is_volume_used "$f" && continue
  2849. debug "Cleaning unused docker-compose ${f##*/}"
  2850. rm -rf "$f" || return 1
  2851. done
  2852. return 0
  2853. }
  2854. export -f clean_unused_docker_compose
  2855. stdin_get_hash() {
  2856. local sha
  2857. sha=$(sha256sum) || return 1
  2858. sha=${sha:0:64}
  2859. echo "$sha"
  2860. }
  2861. export -f stdin_get_hash
  2862. file_get_hash() {
  2863. stdin_get_hash < "$1" || return 1
  2864. }
  2865. export -f file_get_hash
  2866. docker_compose_store() {
  2867. local file="$1" sha
  2868. sha=$(file_get_hash "$file") || return 1
  2869. project=$(get_default_project_name) || return 1
  2870. dst="/var/lib/compose/docker-compose/$sha/$project"
  2871. mkdir -p "$dst" || return 1
  2872. cat <<EOF > "$dst/.env" || return 1
  2873. DOCKER_COMPOSE_PATH=$dst
  2874. COMPOSE_HTTP_TIMEOUT=7200
  2875. EOF
  2876. cp "$file" "$dst/docker-compose.yml" || return 1
  2877. mkdir -p "$dst/bin" || return 1
  2878. cat <<EOF > "$dst/bin/dc" || return 1
  2879. #!/bin/bash
  2880. $(declare -f read-0)
  2881. docker_run_opts=()
  2882. while read-0 opt; do
  2883. if [[ "\$opt" == "!env:"* ]]; then
  2884. opt="\${opt##!env:}"
  2885. var="\${opt%%=*}"
  2886. value="\${opt#*=}"
  2887. export "\$var"="\$value"
  2888. else
  2889. docker_run_opts+=("\$opt")
  2890. fi
  2891. done < <(cat "$COMPOSE_LAUNCHER_OPTS")
  2892. docker_run_opts+=(
  2893. "-w" "$dst"
  2894. "--entrypoint" "/usr/local/bin/docker-compose"
  2895. )
  2896. [ -t 1 ] && {
  2897. docker_run_opts+=("-ti")
  2898. }
  2899. exec docker run --rm "\${docker_run_opts[@]}" "\${COMPOSE_DOCKER_IMAGE:-docker.0k.io/compose}" "\$@"
  2900. EOF
  2901. chmod +x "$dst/bin/dc" || return 1
  2902. printf "%s" "$sha"
  2903. }
  2904. export -f docker_compose_store
  2905. launch_docker_compose() {
  2906. local charm docker_compose_tmpdir docker_compose_dir
  2907. docker_compose_tmpdir=$(mktemp -d -t tmp.XXXXXXXXXX)
  2908. #debug "Creating temporary docker-compose directory in '$docker_compose_tmpdir'."
  2909. trap_add EXIT "rm -rf \"$docker_compose_tmpdir\""
  2910. ## docker-compose will name network from the parent dir name
  2911. project=$(get_default_project_name)
  2912. mkdir -p "$docker_compose_tmpdir/$project"
  2913. docker_compose_dir="$docker_compose_tmpdir/$project"
  2914. get_docker_compose $SERVICE_PACK > "$docker_compose_dir/docker-compose.yml" || return 1
  2915. if [ -e "$state_tmpdir/to-merge-in-docker-compose.yml" ]; then
  2916. # debug "Merging some config data in docker-compose.yml:"
  2917. # debug "$(cat $state_tmpdir/to-merge-in-docker-compose.yml)"
  2918. _config_merge "$docker_compose_dir/docker-compose.yml" "$state_tmpdir/to-merge-in-docker-compose.yml" || return 1
  2919. fi
  2920. if [ -z "$(echo $(cat "$docker_compose_dir/docker-compose.yml"))" ]; then
  2921. die "Generated 'docker-compose.yml' is unexpectedly empty."
  2922. fi
  2923. ## XXXvlab: could be more specific and only link the needed charms
  2924. ## XXXvlab: why do we need these links ? If this is for the build command, then it is not useful anymore.
  2925. # for charm in $(shyaml keys services < "$docker_compose_dir/docker-compose.yml"); do
  2926. # if charm.exists "$charm"; then
  2927. # ln -sf "$(charm.get_dir "$charm")" "$docker_compose_dir/$charm" || exit 1
  2928. # fi
  2929. # done
  2930. mkdir "$docker_compose_dir/.data"
  2931. if [ -z "$COMPOSE_DISABLE_DOCKER_COMPOSE_STORE" ]; then
  2932. sha=$(docker_compose_store "$docker_compose_dir/docker-compose.yml") || return 1
  2933. fi
  2934. {
  2935. {
  2936. {
  2937. if [ -z "$COMPOSE_DISABLE_DOCKER_COMPOSE_STORE" ]; then
  2938. cd "/var/lib/compose/docker-compose/$sha/$project" || return 1
  2939. else
  2940. cd "$docker_compose_dir" || return 1
  2941. fi
  2942. if [ -f ".env" ]; then
  2943. debug "${WHITE}.env$NORMAL for $DARKYELLOW$SERVICE_PACK$NORMAL:"
  2944. debug "$(cat ".env" | prefix " $GRAY|$NORMAL ")"
  2945. fi
  2946. debug "${WHITE}docker-compose.yml$NORMAL for $DARKYELLOW$SERVICE_PACK$NORMAL:"
  2947. debug "$(cat "docker-compose.yml" | prefix " $GRAY|$NORMAL ")"
  2948. debug "${WHITE}Launching$NORMAL: docker-compose $@"
  2949. if [ "$DRY_COMPOSE_RUN" ]; then
  2950. echo docker-compose "$@"
  2951. else
  2952. docker-compose "$@"
  2953. fi
  2954. echo "$?" > "$docker_compose_dir/.data/errlvl"
  2955. } | _save stdout
  2956. } 3>&1 1>&2 2>&3 | _save stderr
  2957. } 3>&1 1>&2 2>&3
  2958. if tail -n 1 "$docker_compose_dir/.data/stderr" | grep -E "Service .+ failed to build: Error getting container [0-9a-f]+ from driver devicemapper: (open|Error mounting) /dev/mapper/docker-.*: no such file or directory$" >/dev/null 2>&1; then
  2959. err "Detected bug https://github.com/docker/docker/issues/4036 ... "
  2960. err "Please re-launch your command, or switch from 'devicemapper' driver to 'overlayfs' or 'aufs'."
  2961. fi
  2962. docker_compose_errlvl="$(cat "$docker_compose_dir/.data/errlvl" 2>/dev/null)"
  2963. if [ -z "$docker_compose_errlvl" ]; then
  2964. err "Something went wrong before you could gather docker-compose errorlevel."
  2965. return 1
  2966. fi
  2967. return "$docker_compose_errlvl"
  2968. }
  2969. export -f launch_docker_compose
  2970. get_compose_yml_location() {
  2971. if ! [ -z ${COMPOSE_YML_FILE+x} ]; then ## if set, even if empty
  2972. echo "$COMPOSE_YML_FILE"
  2973. return 0
  2974. fi
  2975. parent=$(while ! [ -f "./compose.yml" ]; do
  2976. [ "$PWD" == "/" ] && exit 0
  2977. cd ..
  2978. done; echo "$PWD"
  2979. )
  2980. if [ "$parent" ]; then
  2981. echo "$parent/compose.yml"
  2982. return 0
  2983. fi
  2984. ## XXXvlab: do we need this additional environment variable,
  2985. ## COMPOSE_YML_FILE is not sufficient ?
  2986. if [ "$DEFAULT_COMPOSE_FILE" ]; then
  2987. if ! [ -e "$DEFAULT_COMPOSE_FILE" ]; then
  2988. warn "No 'compose.yml' was found in current or parent dirs," \
  2989. "and \$DEFAULT_COMPOSE_FILE points to an unexistent file." \
  2990. "(${DEFAULT_COMPOSE_FILE})"
  2991. return 0
  2992. fi
  2993. echo "$DEFAULT_COMPOSE_FILE"
  2994. return 0
  2995. fi
  2996. warn "No 'compose.yml' was found in current or parent dirs, and no \$DEFAULT_COMPOSE_FILE was set."
  2997. return 0
  2998. }
  2999. export -f get_compose_yml_location
  3000. get_compose_yml_content() {
  3001. local cache_file="$state_tmpdir/$FUNCNAME.cache"
  3002. if [ -e "$cache_file" ]; then
  3003. cat "$cache_file" &&
  3004. touch "$cache_file" || return 1
  3005. return 0
  3006. fi
  3007. if [ -z "$COMPOSE_YML_FILE" ]; then
  3008. COMPOSE_YML_FILE=$(get_compose_yml_location) || return 1
  3009. fi
  3010. if [ -e "$COMPOSE_YML_FILE" ]; then
  3011. debug "Found $WHITE$exname$NORMAL YAML file in '$COMPOSE_YML_FILE'."
  3012. COMPOSE_YML_CONTENT=$(cat "$COMPOSE_YML_FILE") || {
  3013. err "Could not read '$COMPOSE_YML_FILE'."
  3014. return 1
  3015. }
  3016. else
  3017. debug "No compose file found. Using an empty one."
  3018. COMPOSE_YML_CONTENT=""
  3019. fi
  3020. COMPOSE_YML_CONTENT=$(merge_yaml_str "$COMPOSE_YML_CONTENT" "${compose_contents[@]}") || return 1
  3021. output=$(echo "$COMPOSE_YML_CONTENT"| shyaml get-value 2>&1)
  3022. if [ "$?" != 0 ]; then
  3023. outputed_something=
  3024. while IFS='' read -r line1 && IFS='' read -r line2; do
  3025. [ "$outputed_something" ] || err "Invalid YAML in '$COMPOSE_YML_FILE':"
  3026. outputed_something=true
  3027. echo "$line1 $GRAY($line2)$NORMAL"
  3028. done < <(echo "$output" | grep ^yaml.scanner -A 100 |
  3029. sed -r 's/^ in "<stdin>", //g' | sed -r 's/^yaml.scanner.[a-zA-Z]+: //g') |
  3030. prefix " $GRAY|$NORMAL "
  3031. [ "$outputed_something" ] || {
  3032. err "Unexpected error while running 'shyaml get-value' on '$COMPOSE_YML_FILE':"
  3033. echo "$output" | prefix " $GRAY|$NORMAL "
  3034. }
  3035. return 1
  3036. fi
  3037. echo "$COMPOSE_YML_CONTENT" | tee "$cache_file" || return 1
  3038. }
  3039. export -f get_compose_yml_content
  3040. get_default_target_services() {
  3041. local services=("$@")
  3042. if [ -z "${services[*]}" ]; then
  3043. if [ "$DEFAULT_SERVICES" ]; then
  3044. debug "No service provided, using $WHITE\$DEFAULT_SERVICES$NORMAL variable." \
  3045. "Target services: $DARKYELLOW$DEFAULT_SERVICES$NORMAL"
  3046. services="$DEFAULT_SERVICES"
  3047. else
  3048. err "No service provided."
  3049. return 1
  3050. fi
  3051. fi
  3052. echo "${services[*]}"
  3053. }
  3054. export -f get_default_target_services
  3055. get_master_services() {
  3056. local loaded master_service service
  3057. declare -A loaded
  3058. for service in "$@"; do
  3059. master_service=$(get_top_master_service_for_service "$service") || return 1
  3060. if [ "${loaded[$master_service]}" ]; then
  3061. continue
  3062. fi
  3063. echo "$master_service"
  3064. loaded["$master_service"]=1
  3065. done | nspc
  3066. return "${PIPESTATUS[0]}"
  3067. }
  3068. export -f get_master_services
  3069. get_current_docker_container_id() {
  3070. local line
  3071. line=$(cat "/proc/self/cpuset") || return 1
  3072. [[ "$line" == *docker* ]] || return 1
  3073. echo "${line##*/}"
  3074. }
  3075. export -f get_current_docker_container_id
  3076. ## if we are in a docker compose, we might want to know what is the
  3077. ## real host path of some local paths.
  3078. get_host_path() {
  3079. local path="$1"
  3080. path=$(realpath "$path") || return 1
  3081. container_id=$(get_current_docker_container_id) || {
  3082. print "%s" "$path"
  3083. return 0
  3084. }
  3085. biggest_dst=
  3086. current_src=
  3087. while read-0 src dst; do
  3088. [[ "$path" == "$dst"* ]] || continue
  3089. if [[ "${#biggest_dst}" < "${#dst}" ]]; then
  3090. biggest_dst="$dst"
  3091. current_src="$src"
  3092. fi
  3093. done < <(get_volumes_for_container "$container_id")
  3094. if [ "$current_src" ]; then
  3095. printf "%s" "$current_src"
  3096. else
  3097. return 1
  3098. fi
  3099. }
  3100. export -f get_host_path
  3101. _setup_state_dir() {
  3102. export state_tmpdir=$(mktemp -d -t tmp.XXXXXXXXXX)
  3103. #debug "Creating temporary state directory in '$state_tmpdir'."
  3104. # trap_add EXIT "debug \"Removing temporary state directory in $state_tmpdir.\";\
  3105. # rm -rf \"$state_tmpdir\""
  3106. trap_add EXIT "rm -rf \"$state_tmpdir\""
  3107. }
  3108. get_docker_compose_help_msg() {
  3109. local action="$1" cache_file="$CACHEDIR/$FUNCNAME.cache.$({ p0 "$1"; cat "$(which docker-compose)"; } | md5_compat)" \
  3110. docker_compose_help_msg
  3111. if [ -e "$cache_file" ]; then
  3112. cat "$cache_file" &&
  3113. touch "$cache_file" || return 1
  3114. return 0
  3115. fi
  3116. docker_compose_help_msg=$(docker-compose $action --help 2>/dev/null) || return 1
  3117. echo "$docker_compose_help_msg" |
  3118. tee "$cache_file" || return 1
  3119. }
  3120. get_docker_compose_usage() {
  3121. local action="$1" cache_file="$CACHEDIR/$FUNCNAME.cache.$({ p0 "$1"; cat "$(which docker-compose)"; } | md5_compat)" \
  3122. docker_compose_help_msg
  3123. if [ -e "$cache_file" ]; then
  3124. cat "$cache_file" &&
  3125. touch "$cache_file" || return 1
  3126. return 0
  3127. fi
  3128. docker_compose_help_msg=$(get_docker_compose_help_msg $action) || return 1
  3129. echo "$docker_compose_help_msg" |
  3130. grep -m 1 "^Usage:" -A 10000 |
  3131. egrep -m 1 "^\$" -B 10000 |
  3132. nspc |
  3133. sed -r 's/^Usage: //g' |
  3134. tee "$cache_file" || return 1
  3135. }
  3136. get_docker_compose_opts_help() {
  3137. local action="$1" cache_file="$CACHEDIR/$FUNCNAME.cache.$({ p0 "$1"; cat "$(which docker-compose)"; } | md5_compat)" \
  3138. docker_compose_help_msg
  3139. if [ -e "$cache_file" ]; then
  3140. cat "$cache_file" &&
  3141. touch "$cache_file" || return 1
  3142. return 0
  3143. fi
  3144. docker_compose_opts_help=$(get_docker_compose_help_msg $action) || return 1
  3145. echo "$docker_compose_opts_help" |
  3146. grep '^Options:' -A 20000 |
  3147. tail -n +2 |
  3148. { cat ; echo; } |
  3149. egrep -m 1 "^\S*\$" -B 10000 |
  3150. head -n -1 |
  3151. tee "$cache_file" || return 1
  3152. }
  3153. get_docker_compose_commands_help() {
  3154. local action="$1" cache_file="$CACHEDIR/$FUNCNAME.cache.$({ p0 "$1"; cat "$(which docker-compose)"; } | md5_compat)" \
  3155. docker_compose_help_msg
  3156. if [ -e "$cache_file" ]; then
  3157. cat "$cache_file" &&
  3158. touch "$cache_file" || return 1
  3159. return 0
  3160. fi
  3161. docker_compose_opts_help=$(get_docker_compose_help_msg $action) || return 1
  3162. echo "$docker_compose_opts_help" |
  3163. grep '^Commands:' -A 20000 |
  3164. tail -n +2 |
  3165. { cat ; echo; } |
  3166. egrep -m 1 "^\S*\$" -B 10000 |
  3167. head -n -1 |
  3168. tee "$cache_file" || return 1
  3169. }
  3170. get_docker_compose_opts_list() {
  3171. local action="$1" cache_file="$CACHEDIR/$FUNCNAME.cache.$({ p0 "$1"; cat "$(which docker-compose)"; } | md5_compat)" \
  3172. docker_compose_help_msg
  3173. if [ -e "$cache_file" ]; then
  3174. cat "$cache_file" &&
  3175. touch "$cache_file" || return 1
  3176. return 0
  3177. fi
  3178. docker_compose_opts_help=$(get_docker_compose_opts_help $action) || return 1
  3179. echo "$docker_compose_opts_help" |
  3180. egrep "^\s+-" |
  3181. sed -r 's/\s+((((-[a-zA-Z]|--[a-zA-Z0-9-]+)( [A-Z=]+|=[^ ]+)?)(, )?)+)\s+.*$/\1/g' |
  3182. tee "$cache_file" || return 1
  3183. }
  3184. options_parser() {
  3185. sed -r 's/^(\s+(((-[a-zA-Z]|--[a-zA-Z0-9-]+)([ =]([a-zA-Z_=\"\[]|\])+)?(, | )?)+)\s+)[^ ].*$/\x0\2\x0\0/g'
  3186. printf "\0"
  3187. }
  3188. remove_options_in_option_help_msg() {
  3189. {
  3190. read-0 null
  3191. if [ "$null" ]; then
  3192. err "options parsing error, should start with an option line."
  3193. return 1
  3194. fi
  3195. while read-0 opt full_txt;do
  3196. multi_opts="$(printf "%s " $opt | multi_opts_filter)"
  3197. single_opts="$(printf "%s " $opt | single_opts_filter)"
  3198. for to_remove in "$@"; do
  3199. str_matches "$to_remove" $multi_opts $single_opts && {
  3200. continue 2
  3201. }
  3202. done
  3203. echo -n "$full_txt"
  3204. done
  3205. } < <(options_parser)
  3206. }
  3207. _MULTIOPTION_REGEX='^((-[a-zA-Z]|--[a-zA-Z0-9-]+)(, )?)+'
  3208. _MULTIOPTION_REGEX_LINE_FILTER=$_MULTIOPTION_REGEX'(\s|=)'
  3209. multi_opts_filter() {
  3210. egrep "$_MULTIOPTION_REGEX_LINE_FILTER" |
  3211. sed -r "s/^($_MULTIOPTION_REGEX)(\s|=).*$/\1/g" |
  3212. tr ',' "\n" | nspc
  3213. }
  3214. single_opts_filter() {
  3215. egrep -v "$_MULTIOPTION_REGEX_LINE_FILTER" |
  3216. tr ',' "\n" | nspc
  3217. }
  3218. get_docker_compose_multi_opts_list() {
  3219. local action="$1" opts_list
  3220. opts_list=$(get_docker_compose_opts_list "$action") || return 1
  3221. echo "$opts_list" | multi_opts_filter
  3222. }
  3223. get_docker_compose_single_opts_list() {
  3224. local action="$1" opts_list
  3225. opts_list=$(get_docker_compose_opts_list "$action") || return 1
  3226. echo "$opts_list" | single_opts_filter
  3227. }
  3228. display_commands_help() {
  3229. local charm_actions
  3230. echo
  3231. echo "${WHITE}Commands${NORMAL} (thanks to docker-compose):"
  3232. get_docker_compose_commands_help | sed -r "s/ ([a-z]+)(\s+)/ ${DARKCYAN}\1${NORMAL}\2/g"
  3233. charm_actions_help=$(get_docker_charm_action_help) || return 1
  3234. if [ "$charm_actions_help" ]; then
  3235. echo
  3236. echo "${WHITE}Charm actions${NORMAL}:"
  3237. printf "%s\n" "$charm_actions_help" | \
  3238. sed -r "s/^ ([a-z0-9-]+)(\s+)([a-z0-9-]+)(\s+)/ ${DARKCYAN}\1${NORMAL}\2${DARKYELLOW}\3${NORMAL}\4/g"
  3239. fi
  3240. }
  3241. get_docker_charm_action_help() {
  3242. local services service charm relation_name target_service relation_config \
  3243. target_charm
  3244. services=($(get_compose_yml_content | shyaml keys 2>/dev/null))
  3245. NO_CONSTRAINT_CHECK=1 get_all_relations "${services[@]}" >/dev/null || return 1
  3246. for service in "${services[@]}"; do
  3247. out=$(
  3248. charm=$(get_service_charm "$service") || return 1
  3249. for action in $(charm.ls_direct_actions "$charm"); do
  3250. printf " %-28s %s\n" "$action $service" "Direct action from ${DARKPINK}$charm${NORMAL}"
  3251. done
  3252. while read-0 relation_name target_service _relation_config _tech_dep; do
  3253. target_charm=$(get_service_charm "$target_service") || return 1
  3254. for action in $(charm.ls_relation_actions "$target_charm" "$relation_name"); do
  3255. printf " %-28s %s\n" "$action $service" "Indirect action from ${DARKPINK}$target_charm${NORMAL}"
  3256. done
  3257. done < <(get_service_relations "$service")
  3258. )
  3259. if [ "$out" ]; then
  3260. echo " for ${DARKYELLOW}$service${NORMAL}:"
  3261. printf "%s\n" "$out"
  3262. fi
  3263. done
  3264. }
  3265. display_help() {
  3266. print_help
  3267. echo "${WHITE}Usage${NORMAL}:"
  3268. echo " $usage"
  3269. echo "${WHITE}Options${NORMAL}:"
  3270. echo " -h, --help Print this message and quit"
  3271. echo " (ignoring any other options)"
  3272. echo " -V, --version Print current version and quit"
  3273. echo " (ignoring any other options)"
  3274. echo " --dirs Display data dirs and quit"
  3275. echo " (ignoring any other options)"
  3276. echo " --get-project-name Display project name and quit"
  3277. echo " (ignoring any other options)"
  3278. echo " -v, --verbose Be more verbose"
  3279. echo " -q, --quiet Be quiet"
  3280. echo " -d, --debug Print full debugging information (sets also verbose)"
  3281. echo " --dry-compose-run If docker-compose will be run, only print out what"
  3282. echo " command line will be used."
  3283. echo " --no-relations Do not run any relation script"
  3284. echo " --no-hooks Do not run any hook script"
  3285. echo " --no-init Do not run any init script"
  3286. echo " --no-post-deploy Do not run any post-deploy script"
  3287. echo " --no-pre-deploy Do not run any pre-deploy script"
  3288. echo " --without-relation RELATION "
  3289. echo " Do not run given relation"
  3290. echo " -R, --rebuild-relations-to-service SERVICE"
  3291. echo " Will rebuild all relations to given service"
  3292. echo " --add-compose-content, -Y YAML"
  3293. echo " Will merge some direct YAML with the current compose"
  3294. echo " -c, --color Force color mode (default is to detect if in tty mode)"
  3295. get_docker_compose_opts_help | remove_options_in_option_help_msg --version --help --verbose |
  3296. filter_docker_compose_help_message
  3297. display_commands_help
  3298. }
  3299. _graph_service() {
  3300. local service="$1" base="$1"
  3301. charm=$(get_service_charm "$service") || return 1
  3302. metadata=$(charm.metadata "$charm") || return 1
  3303. subordinate=$(echo "$metadata" | shyaml get-value "subordinate" 2>/dev/null)
  3304. if [ "$subordinate" == "True" ]; then
  3305. requires="$(echo "$metadata" | shyaml get-value "requires" 2>/dev/null)"
  3306. master_charm=
  3307. while read-0 relation_name relation; do
  3308. [ "$(echo "$relation" | shyaml get-value "scope" 2>/dev/null)" == "container" ] || continue
  3309. interface="$(echo "$relation" | shyaml get-value "interface" 2>/dev/null)"
  3310. if [ -z "$interface" ]; then
  3311. err "No ${WHITE}$interface${NORMAL} set for relation $relation_name."
  3312. return 1
  3313. fi
  3314. ## Action provided by relation ?
  3315. target_service=
  3316. while read-0 relation_name candidate_target_service _relation_config _tech_dep; do
  3317. [ "$interface" == "$relation_name" ] && {
  3318. target_service="$candidate_target_service"
  3319. break
  3320. }
  3321. done < <(get_service_relations "$service")
  3322. if [ -z "$target_service" ]; then
  3323. err "Couldn't find ${WHITE}relations.$interface${NORMAL} in" \
  3324. "${DARKYELLOW}$service$NORMAL compose definition."
  3325. return 1
  3326. fi
  3327. master_service="$target_service"
  3328. master_charm=$(get_service_charm "$target_service") || return 1
  3329. break
  3330. done < <(echo "$requires" | shyaml key-values-0 2>/dev/null)
  3331. fi
  3332. _graph_node_service "$service" "$base" "$charm"
  3333. _graph_edge_service "$service" "$subordinate" "$master_service"
  3334. }
  3335. _graph_node_service() {
  3336. local service="$1" base="$2" charm="$3"
  3337. cat <<EOF
  3338. "$(_graph_node_service_label ${service})" [
  3339. style = "filled, $([ "$subordinate" == "True" ] && echo "dashed" || echo "bold")"
  3340. penwidth = $([ "$subordinate" == "True" ] && echo "3" || echo "5")
  3341. color = $([ "$base" ] && echo "blue" || echo "black")
  3342. fillcolor = "white"
  3343. fontname = "Courier New"
  3344. shape = "Mrecord"
  3345. label =<$(_graph_node_service_content "$service")>
  3346. ];
  3347. EOF
  3348. }
  3349. _graph_edge_service() {
  3350. local service="$1" subordinate="$2" master_service="$3"
  3351. while read-0 relation_name target_service relation_config tech_dep; do
  3352. cat <<EOF
  3353. "$(_graph_node_service_label ${service})" -> "$(_graph_node_service_label ${target_service})" [
  3354. penwidth = $([ "$master_service" == "$target_service" ] && echo 3 || echo 2)
  3355. fontsize = 16
  3356. fontcolor = "black"
  3357. style = $([ "$master_service" == "$target_service" ] && echo dashed || echo "\"\"")
  3358. weight = $([ "$master_service" == "$target_service" ] && echo 2.0 || echo 1.0)
  3359. dir = $([ "$master_service" == "$target_service" ] && echo none || echo both)
  3360. arrowtail = odot
  3361. # arrowhead = dotlicurve
  3362. taillabel = "$relation_name" ];
  3363. EOF
  3364. done < <(get_service_relations "$service") || return 1
  3365. }
  3366. _graph_node_service_label() {
  3367. local service="$1"
  3368. echo "service_$service"
  3369. }
  3370. _graph_node_service_content() {
  3371. local service="$1"
  3372. charm=$(get_service_charm "$service") || return 1
  3373. cat <<EOF
  3374. <table border="0" cellborder="0" cellpadding="3" bgcolor="white">
  3375. <tr>
  3376. <td bgcolor="black" align="center" colspan="2">
  3377. <font color="white">$service</font>
  3378. </td>
  3379. </tr>
  3380. $(if [ "$charm" != "$service" ]; then
  3381. cat <<EOF2
  3382. <tr>
  3383. <td align="left" port="r0">charm: $charm</td>
  3384. </tr>
  3385. EOF2
  3386. fi)
  3387. </table>
  3388. EOF
  3389. }
  3390. cla_contains () {
  3391. local e
  3392. for e in "${@:2}"; do [[ "$e" == "$1" ]] && return 0; done
  3393. return 1
  3394. }
  3395. filter_docker_compose_help_message() {
  3396. cat - |
  3397. sed -r "s/docker-compose run/${DARKWHITE}compose${NORMAL} ${DARKCYAN}$action${NORMAL}/g;
  3398. s/docker-compose.yml/compose.yml/g;
  3399. s/SERVICES?/${DARKYELLOW}\0${NORMAL}/g;
  3400. s/^(\s+)\\$/\1${WHITE}\$${NORMAL}/g;
  3401. s/^(\s+)run/\1${DARKCYAN}$action${NORMAL}/g;
  3402. s/docker-compose/${DARKWHITE}compose${NORMAL}/g"
  3403. }
  3404. graph() {
  3405. local services=("$@")
  3406. declare -A entries
  3407. cat <<EOF
  3408. digraph g {
  3409. graph [
  3410. fontsize=30
  3411. labelloc="t"
  3412. label=""
  3413. splines=true
  3414. overlap=false
  3415. #rankdir = "LR"
  3416. ];
  3417. ratio = auto;
  3418. EOF
  3419. for target_service in "$@"; do
  3420. services=$(get_ordered_service_dependencies "$target_service") || return 1
  3421. for service in $services; do
  3422. [ "${entries[$service]}" ] && continue || entries[$service]=1
  3423. if cla_contains "$service" "${services[@]}"; then
  3424. base=true
  3425. else
  3426. base=
  3427. fi
  3428. _graph_service "$service" "$base"
  3429. done
  3430. done
  3431. echo "}"
  3432. }
  3433. cached_wget() {
  3434. local cache_file="$CACHEDIR/$FUNCNAME.cache.$(p0 "$@" | md5_compat)" \
  3435. url="$1"
  3436. if [ -e "$cache_file" ]; then
  3437. cat "$cache_file"
  3438. touch "$cache_file"
  3439. return 0
  3440. fi
  3441. wget -O- "${url}" |
  3442. tee "$cache_file"
  3443. if [ "${PIPESTATUS[0]}" != 0 ]; then
  3444. rm "$cache_file"
  3445. die "Unable to fetch '$url'."
  3446. return 1
  3447. fi
  3448. }
  3449. export -f cached_wget
  3450. [ "$SOURCED" ] && return 0
  3451. trap_add "EXIT" clean_cache
  3452. if [ -z "$DISABLE_SYSTEM_CONFIG_FILE" ]; then
  3453. if [ -r /etc/default/charm ]; then
  3454. . /etc/default/charm
  3455. fi
  3456. if [ -r "/etc/default/$exname" ]; then
  3457. . "/etc/default/$exname"
  3458. fi
  3459. ## XXXvlab: should provide YML config opportunities in possible parent dirs ?
  3460. ## userdir ? and global /etc/compose.yml ?
  3461. for cfgfile in /etc/compose.conf /etc/compose.local.conf \
  3462. /etc/default/compose /etc/compose/local.conf; do
  3463. [ -e "$cfgfile" ] || continue
  3464. . "$cfgfile" || die "Loading config file '$cfgfile' failed."
  3465. done
  3466. fi
  3467. _setup_state_dir
  3468. mkdir -p "$CACHEDIR" || exit 1
  3469. log () { cat; }
  3470. export -f log
  3471. ##
  3472. ## Argument parsing
  3473. ##
  3474. wrap_opts=()
  3475. services=()
  3476. remainder_args=()
  3477. compose_opts=()
  3478. compose_contents=()
  3479. action_opts=()
  3480. services_args=()
  3481. pos_arg_ct=0
  3482. no_hooks=
  3483. no_init=
  3484. action=
  3485. stage="main" ## switches from 'main', to 'action', 'remainder'
  3486. is_docker_compose_action=
  3487. rebuild_relations_to_service=()
  3488. color=
  3489. declare -A without_relations
  3490. DC_MATCH_MULTI=$(get_docker_compose_multi_opts_list) &&
  3491. DC_MATCH_SINGLE=$(get_docker_compose_single_opts_list) || exit 1
  3492. while read-0 arg; do
  3493. case "$stage" in
  3494. "main")
  3495. case "$arg" in
  3496. --help|-h)
  3497. no_init=true ; no_hooks=true ; no_relations=true
  3498. display_help
  3499. exit 0
  3500. ;;
  3501. --verbose|-v)
  3502. export VERBOSE=true
  3503. compose_opts+=("--verbose")
  3504. ;;
  3505. --quiet|-q)
  3506. export QUIET=true
  3507. export wrap_opts+=("-q")
  3508. log () { cat >&2; }
  3509. export -f log
  3510. ;;
  3511. --version|-V)
  3512. print_version
  3513. docker-compose --version
  3514. docker --version
  3515. exit 0
  3516. ;;
  3517. -f|--file)
  3518. read-0 value
  3519. [ -e "$value" ] || die "File $value doesn't exists"
  3520. export COMPOSE_YML_FILE="$value"
  3521. shift
  3522. ;;
  3523. -p|--project-name)
  3524. read-0 value
  3525. export DEFAULT_PROJECT_NAME="$value"
  3526. compose_opts+=("--project-name $value")
  3527. shift
  3528. ;;
  3529. --color|-c)
  3530. if [ "$color" == "0" ]; then
  3531. err "Conflicting option --color with previous --no-ansi."
  3532. exit 1
  3533. fi
  3534. color=1
  3535. ansi_color yes
  3536. ;;
  3537. --no-ansi)
  3538. if [ "$color" == "1" ]; then
  3539. err "Conflicting option --no-ansi with previous --color."
  3540. exit 1
  3541. fi
  3542. color=0
  3543. ansi_color no
  3544. compose_opts+=("--no-ansi")
  3545. ;;
  3546. --no-relations)
  3547. export no_relations=true
  3548. ;;
  3549. --without-relation)
  3550. read-0 value
  3551. without_relations["$value"]=1
  3552. shift
  3553. ;;
  3554. --no-hooks)
  3555. export no_hooks=true
  3556. ;;
  3557. --no-init)
  3558. export no_init=true
  3559. ;;
  3560. --no-post-deploy)
  3561. export no_post_deploy=true
  3562. ;;
  3563. --no-pre-deploy)
  3564. export no_pre_deploy=true
  3565. ;;
  3566. --rebuild-relations-to-service|-R)
  3567. read-0 value
  3568. rebuild_relations_to_service+=("$value")
  3569. shift
  3570. ;;
  3571. --debug|-d)
  3572. export DEBUG=true
  3573. export VERBOSE=true
  3574. #compose_opts+=("--verbose" "--log-level" "DEBUG")
  3575. ;;
  3576. --add-compose-content|-Y)
  3577. read-0 value
  3578. compose_contents+=("$value")
  3579. shift
  3580. ;;
  3581. --dirs)
  3582. echo "CACHEDIR: $CACHEDIR"
  3583. echo "VARDIR: $VARDIR"
  3584. exit 0
  3585. ;;
  3586. --get-project-name)
  3587. project=$(get_default_project_name) || exit 1
  3588. echo "$project"
  3589. exit 0
  3590. ;;
  3591. --dry-compose-run)
  3592. export DRY_COMPOSE_RUN=true
  3593. ;;
  3594. --*|-*)
  3595. if str_pattern_matches "$arg" $DC_MATCH_MULTI; then
  3596. read-0 value
  3597. compose_opts+=("$arg" "$value")
  3598. shift;
  3599. elif str_pattern_matches "$arg" $DC_MATCH_SINGLE; then
  3600. compose_opts+=("$arg")
  3601. else
  3602. err "Unknown option '$arg'. Please check help:"
  3603. display_help >&2
  3604. exit 1
  3605. fi
  3606. ;;
  3607. *)
  3608. action="$arg"
  3609. stage="action"
  3610. if DC_USAGE=$(get_docker_compose_usage "$action"); then
  3611. is_docker_compose_action=true
  3612. DC_MATCH_MULTI=$(get_docker_compose_multi_opts_list "$action") &&
  3613. DC_MATCH_SINGLE="$(get_docker_compose_single_opts_list "$action")"
  3614. if [ "$DC_MATCH_MULTI" ]; then
  3615. DC_MATCH_SINGLE="$DC_MATCH_SINGLE $(echo "$DC_MATCH_MULTI" | sed -r 's/( |$)/=\* /g')"
  3616. fi
  3617. pos_args=($(echo "$DC_USAGE" | sed -r 's/\[-[^]]+\] ?//g;s/\[options\] ?//g'))
  3618. pos_args=("${pos_args[@]:1}")
  3619. # echo "USAGE: $DC_USAGE"
  3620. # echo "pos_args: ${pos_args[@]}"
  3621. # echo "MULTI: $DC_MATCH_MULTI"
  3622. # echo "SINGLE: $DC_MATCH_SINGLE"
  3623. # exit 1
  3624. else
  3625. stage="remainder"
  3626. fi
  3627. ;;
  3628. esac
  3629. ;;
  3630. "action") ## Only for docker-compose actions
  3631. case "$arg" in
  3632. --help|-h)
  3633. no_init=true ; no_hooks=true ; no_relations=true
  3634. action_opts+=("$arg")
  3635. ;;
  3636. --*|-*)
  3637. if [ "$is_docker_compose_action" ]; then
  3638. if str_pattern_matches "$arg" $DC_MATCH_MULTI; then
  3639. read-0 value
  3640. action_opts+=("$arg" "$value")
  3641. shift
  3642. elif str_pattern_matches "$arg" $DC_MATCH_SINGLE; then
  3643. action_opts+=("$arg")
  3644. else
  3645. err "Unknown option '$arg'. Please check '${DARKCYAN}$action${NORMAL}' help:"
  3646. docker-compose "$action" --help |
  3647. filter_docker_compose_help_message >&2
  3648. exit 1
  3649. fi
  3650. fi
  3651. ;;
  3652. *)
  3653. # echo "LOOP $1 : pos_arg: $pos_arg_ct // ${pos_args[$pos_arg_ct]}"
  3654. if [[ "${pos_args[$pos_arg_ct]}" == "[SERVICE...]" ]]; then
  3655. services_args+=("$arg")
  3656. elif [[ "${pos_args[$pos_arg_ct]}" == "SERVICE" ]]; then
  3657. services_args=("$arg") || exit 1
  3658. stage="remainder"
  3659. else
  3660. action_posargs+=("$arg")
  3661. ((pos_arg_ct++))
  3662. fi
  3663. ;;
  3664. esac
  3665. ;;
  3666. "remainder")
  3667. remainder_args+=("$arg")
  3668. while read-0 arg; do
  3669. remainder_args+=("$arg")
  3670. done
  3671. break 3
  3672. ;;
  3673. esac
  3674. shift
  3675. done < <(cla.normalize "$@")
  3676. export compose_contents
  3677. [ "${services_args[*]}" ] && debug " ${DARKWHITE}Services:$NORMAL ${DARKYELLOW}${services_args[*]}$NORMAL"
  3678. [ "${compose_opts[*]}" ] && debug " ${DARKWHITE}Main docker-compose opts:$NORMAL ${compose_opts[*]}"
  3679. [ "${action_posargs[*]}" ] && debug " ${DARKWHITE}Main docker-compose pos args:$NORMAL ${action_posargs[*]}"
  3680. [ "${action_opts[*]}" ] && debug " ${DARKWHITE}Action $DARKCYAN$action$NORMAL with opts:$NORMAL ${action_opts[*]}"
  3681. [ "${remainder_args[*]}" ] && debug " ${DARKWHITE}Remainder args:$NORMAL ${remainder_args[*]}"
  3682. aexport remainder_args
  3683. ##
  3684. ## Actual code
  3685. ##
  3686. COMPOSE_YML_FILE=$(get_compose_yml_location) || exit 1
  3687. COMPOSE_YML_CONTENT=$(get_compose_yml_content) || exit 1
  3688. export COMPOSE_YML_FILE COMPOSE_YML_CONTENT
  3689. charm.sanity_checks || die "Sanity checks about charm-store failed. Please correct."
  3690. ##
  3691. ## Get services in command line.
  3692. ##
  3693. if [ -z "$is_docker_compose_action" -a "$action" ]; then
  3694. action_service=${remainder_args[0]}
  3695. if [ -z "$action_service" ]; then
  3696. err "No such command or action: ${DARKCYAN}$action${NORMAL}"
  3697. display_commands_help
  3698. exit 1
  3699. fi
  3700. ## Required by has_service_action
  3701. array_read-0 services_args < <(printf "%s" "$COMPOSE_YML_CONTENT" | shyaml keys-0 2>/dev/null)
  3702. NO_CONSTRAINT_CHECK=1 get_all_relations "${services_args[@]}" >/dev/null || exit 1
  3703. remainder_args=("${remainder_args[@]:1}")
  3704. if has_service_action "$action_service" "$action" >/dev/null; then
  3705. is_service_action=true
  3706. {
  3707. read-0 action_type
  3708. case "$action_type" in
  3709. "relation")
  3710. read-0 _ target_service _target_charm relation_name _ action_script_path
  3711. debug "Found action $DARKYELLOW${action_service}$NORMAL/$DARKBLUE$relation_name$NORMAL/$DARKCYAN$action$NORMAL (in $DARKYELLOW$target_service$NORMAL)"
  3712. ;;
  3713. "direct")
  3714. read-0 _ action_script_path
  3715. debug "Found action $DARKYELLOW${action_service}$NORMAL.$DARKCYAN$action$NORMAL"
  3716. ;;
  3717. esac
  3718. } < <(has_service_action "$action_service" "$action")
  3719. services_args=("$action_service")
  3720. get_all_relations "${services_args[@]}" >/dev/null || {
  3721. echo " Hint: if this is unexpected, you can try to delete caches, and re-run the command." >&2
  3722. exit 1
  3723. }
  3724. ## Divert logging to stdout to stderr
  3725. log () { cat >&2; }
  3726. export -f log
  3727. else
  3728. die "Unknown action '${DARKCYAN}$action$NORMAL': It doesn't match any docker-compose commands nor inner charm actions."
  3729. fi
  3730. else
  3731. case "$action" in
  3732. ps|up)
  3733. if [ "${#services_args[@]}" == 0 ]; then
  3734. array_read-0 services_args < <(printf "%s" "$COMPOSE_YML_CONTENT" | shyaml keys-0 2>/dev/null)
  3735. fi
  3736. ;;
  3737. config)
  3738. services_args=("${action_posargs[@]}")
  3739. ;;
  3740. esac
  3741. fi
  3742. NO_CONSTRAINT_CHECK=True
  3743. case "$action" in
  3744. up)
  3745. NO_CONSTRAINT_CHECK=
  3746. ;;
  3747. esac
  3748. get_all_relations "${services_args[@]}" >/dev/null || exit 1
  3749. if [ "$is_docker_compose_action" -a "${#services_args[@]}" -gt 0 ]; then
  3750. services=($(get_master_services "${services_args[@]}")) || exit 1
  3751. if [ "$action" == "up" ]; then
  3752. declare -A seen
  3753. for service in $(get_ordered_service_dependencies "${services_args[@]}"); do
  3754. mservice=$(get_master_service_for_service "$service") || exit 1
  3755. [ "${seen[$mservice]}" ] && continue
  3756. type="$(get_service_type "$mservice")" || exit 1
  3757. ## remove run-once
  3758. [ "$type" == "run-once" ] && continue
  3759. seen[$mservice]=1
  3760. action_posargs+=("$mservice")
  3761. done
  3762. else
  3763. action_posargs+=("${services[@]}")
  3764. fi
  3765. ## Get rid of subordinates
  3766. action_posargs=($(get_master_services "${action_posargs[@]}")) || exit 1
  3767. fi
  3768. get_docker_compose "${services_args[@]}" >/dev/null || { ## precalculate variable \$_current_docker_compose
  3769. err "Fails to compile base 'docker-compose.yml'"
  3770. exit 1
  3771. }
  3772. ##
  3773. ## Pre-action
  3774. ##
  3775. full_init=
  3776. case "$action" in
  3777. up|run)
  3778. full_init=true
  3779. post_hook=true
  3780. ;;
  3781. ""|down|restart|logs|config|ps)
  3782. full_init=
  3783. ;;
  3784. *)
  3785. if [ "$is_service_action" ]; then
  3786. full_init=true
  3787. keywords=($(egrep "^#*\s*compose:" "$action_script_path" | cut -f 2- -d:))
  3788. for keyword in "${keywords[@]}"; do
  3789. case "$keyword" in
  3790. no-hooks)
  3791. full_init=
  3792. ;;
  3793. hooks)
  3794. full_init=true
  3795. ;;
  3796. esac
  3797. done
  3798. fi
  3799. ;;
  3800. esac
  3801. if [ -n "$full_init" ]; then
  3802. ## init in order
  3803. if [[ -z "$no_init" && -z "$no_hooks" ]]; then
  3804. Section setup host resources
  3805. setup_host_resources "${services_args[@]}" || exit 1
  3806. Section initialisation
  3807. run_service_hook init "${services_args[@]}" || exit 1
  3808. fi
  3809. ## Get relations
  3810. if [[ -z "$no_relations" && -z "$no_hooks" ]]; then
  3811. if [ "${#rebuild_relations_to_service[@]}" != 0 ]; then
  3812. rebuild_relations_to_service=$(get_master_services "${rebuild_relations_to_service[@]}") || return 1
  3813. rebuild_relations_to_service=($rebuild_relations_to_service)
  3814. project=$(get_default_project_name) || return 1
  3815. for service in "${rebuild_relations_to_service[@]}"; do
  3816. for dir in "$VARDIR/relations/$project/"*"-${service}/"*; do
  3817. [ -d "$dir" ] && {
  3818. debug rm -rf "$dir"
  3819. rm -rf "$dir"
  3820. }
  3821. done
  3822. done
  3823. fi
  3824. run_service_relations "${services_args[@]}" || exit 1
  3825. fi
  3826. if [[ -z "$no_pre_deploy" && -z "$no_hooks" ]]; then
  3827. run_service_hook pre_deploy "${services_args[@]}" || exit 1
  3828. fi
  3829. fi | log
  3830. if [ "${PIPESTATUS[0]}" != 0 ]; then
  3831. exit 1
  3832. fi
  3833. if [ "$action" == "run" -a "${#services_args}" != 0 ]; then
  3834. charm=$(get_service_charm "${services_args[0]}") || exit 1
  3835. metadata=$(charm.metadata "$charm") || exit 1
  3836. SERVICE_TYPE="$(printf "%s" "$metadata" | shyaml get-value type 2>/dev/null)" || true
  3837. if [ "$SERVICE_TYPE" == "run-once" ]; then
  3838. run_service_hook dc-pre-run "${services_args[@]}" || exit 1
  3839. fi
  3840. fi
  3841. export SERVICE_PACK="${services_args[*]}"
  3842. ##
  3843. ## Docker-compose
  3844. ##
  3845. errlvl="0"
  3846. case "$action" in
  3847. up|start|stop|build|run)
  3848. ## force daemon mode for up
  3849. if [[ "$action" == "up" ]]; then
  3850. if ! array_member action_opts -d; then
  3851. action_opts+=("-d")
  3852. fi
  3853. if ! array_member action_opts --remove-orphans; then
  3854. action_opts+=("--remove-orphans")
  3855. fi
  3856. fi
  3857. launch_docker_compose "${compose_opts[@]}" "$action" "${action_opts[@]}" "${action_posargs[@]}" "${remainder_args[@]}"
  3858. ;;
  3859. logs)
  3860. if ! array_member action_opts --tail; then ## force daemon mode for up
  3861. action_opts+=("--tail" "10")
  3862. fi
  3863. launch_docker_compose "${compose_opts[@]}" "$action" "${action_opts[@]}" "${action_posargs[@]}" "${remainder_args[@]}"
  3864. ;;
  3865. "")
  3866. launch_docker_compose "${compose_opts[@]}"
  3867. ;;
  3868. graph)
  3869. graph $SERVICE_PACK
  3870. ;;
  3871. config)
  3872. ## removing the services
  3873. services=($(get_master_services "${action_posargs[@]}")) || exit 1
  3874. ## forcing docker-compose config to output the config file to stdout and not stderr
  3875. out=$(launch_docker_compose "${compose_opts[@]}" "$action" "${action_opts[@]}" "${remainder_args[@]}" 2>&1) || {
  3876. echo "$out"
  3877. exit 1
  3878. }
  3879. echo "$out"
  3880. warn "Runtime configuration modification (from relations) are not included here."
  3881. ;;
  3882. down)
  3883. if ! array_member action_opts --remove-orphans; then ## force daemon mode for up
  3884. debug "Adding a default argument of '--remove-orphans'"
  3885. action_opts+=("--remove-orphans")
  3886. fi
  3887. launch_docker_compose "${compose_opts[@]}" "$action" "${action_opts[@]}" "${remainder_args[@]}"
  3888. ;;
  3889. *)
  3890. if [ "$is_service_action" ]; then
  3891. run_service_action "$action_service" "$action" "${remainder_args[@]}"
  3892. errlvl="$?"
  3893. errlvl "$errlvl"
  3894. else
  3895. launch_docker_compose "${compose_opts[@]}" "$action" "${action_opts[@]}" "${action_posargs[@]}" "${remainder_args[@]}"
  3896. fi
  3897. ;;
  3898. esac || exit 1
  3899. if [ "$post_hook" -a "${#services_args[@]}" != 0 -a -z "$no_hooks" -a -z "$no_post_deploy" ]; then
  3900. run_service_hook post_deploy "${services_args[@]}" || exit 1
  3901. fi
  3902. if [ "$action" == "run" -a "${#services_args}" != 0 ]; then
  3903. if [ "$SERVICE_TYPE" == "run-once" ]; then
  3904. run_service_hook dc-post-run "${services_args[@]}" || exit 1
  3905. fi
  3906. fi
  3907. clean_unused_docker_compose || exit 1
  3908. exit "$errlvl"