Elv2

1# shellcheck shell=bash
2# elv2.sh — the Elastic License v2 gate. Sourced (never executed) by
3# compose.sh, unit.sh, e2e.sh and live.sh before their first rover call that
4# needs the supergraph composition plugin (and before e2e.sh downloads or
5# live.sh runs the Apollo Router), and by toolchain.sh before it installs
6# the plugin or downloads the Router.
7#
8# rover's supergraph composition plugin, which `rover supergraph compose`
9# and `rover connector test` download and run, and the Apollo Router are
10# licensed under the Elastic License v2. Accepting it is the user's act: read the licence,
11# then set APOLLO_ELV2_LICENSE=accept in the environment. rover reads that
12# variable itself (it is the environment form of `--elv2-license accept`), so
13# these scripts never set it, never pass the flag, and never accept on the
14# user's behalf.
15#
16#   elv2_accepted        0 when APOLLO_ELV2_LICENSE is `accept`, 1 otherwise
17#   elv2_explain PREFIX [SUFFIX]  the instruction, on stderr, each line led
18#                        by PREFIX; SUFFIX ends the first line
19#   elv2_require LAYER   elv2_accepted, or elv2_explain and exit 3
20#
21# Exit 3 is `not_run`: `evidence` records the layer as `not_run`, its reason
22# the first line below, never `pass` and never `fail`. The tool is present,
23# so this is not the 127 `skipped`; what is missing is the user's own
24# acceptance, the way a missing credential leaves the live layer `not_run`.
25# Bash 3.2 compatible (macOS /bin/bash).
26
27ELV2_URL="https://www.elastic.co/licensing/elastic-license"
28
29elv2_accepted() {
30  [ "${APOLLO_ELV2_LICENSE:-}" = accept ]
31}
32
33elv2_explain() {
34  {
35    echo "$1: APOLLO_ELV2_LICENSE is not set to accept, and only you can accept the Elastic License v2${2:-}"
36    echo "$1:   rover's supergraph composition plugin, which \`rover supergraph compose\` downloads, and the Apollo Router, which e2e and live run, are licensed under the Elastic License v2: $ELV2_URL"
37    echo "$1:   read it, then set \`APOLLO_ELV2_LICENSE=accept\` (rover reads the variable itself); these scripts never set it on their own, and an agent sets it only after you say yes"
38    echo "$1:   until it is set, the compose, unit, e2e and live layers report not_run"
39  } >&2
40}
41
42elv2_require() {
43  elv2_accepted && return 0
44  elv2_explain "$1" " (not_run)"
45  exit 3
46}