deps-tasks.yml

version: "3"
vars:
  # Utility script path
  G_DEP_DOWNLOAD_SCRIPT: "{{.ROOT_DIR}}/tools/scripts/deps-download/download-dep.py"

  # Target checksum files
  G_DEPS_CORE_CHECKSUM_FILE: "{{.G_BUILD_DIR}}/deps#core.md5"
  G_DEPS_LOG_VIEWER_CHECKSUM_FILE: "{{.G_BUILD_DIR}}/deps#log-viewer.md5"

  # Submodule checksum files
  G_ABSEIL_CPP_CHECKSUM_FILE: "{{.G_BUILD_DIR}}/deps#abseil-cpp.md5"
  G_ANTLR4_CHECKSUM_FILE: "{{.G_BUILD_DIR}}/deps#antlr4.md5"
  G_CATCH2_CHECKSUM_FILE: "{{.G_BUILD_DIR}}/deps#Catch2.md5"
  G_DATE_CHECKSUM_FILE: "{{.G_BUILD_DIR}}/deps#date.md5"
  G_JSON_CHECKSUM_FILE: "{{.G_BUILD_DIR}}/deps#json.md5"
  G_LOG_SURGEON_CHECKSUM_FILE: "{{.G_BUILD_DIR}}/deps#log-surgeon.md5"
  G_OUTCOME_CHECKSUM_FILE: "{{.G_BUILD_DIR}}/deps#outcome.md5"
  G_SIMDJSON_CHECKSUM_FILE: "{{.G_BUILD_DIR}}/deps#simdjson.md5"
  G_SQLITE3_CHECKSUM_FILE: "{{.G_BUILD_DIR}}/deps#sqlite3.md5"
  G_UTFCPP_CHECKSUM_FILE: "{{.G_BUILD_DIR}}/deps#utfcpp.md5"
  G_YAML_CPP_CHECKSUM_FILE: "{{.G_BUILD_DIR}}/deps#yaml-cpp.md5"
  G_YSCOPE_LOG_VIEWER_CHECKSUM_FILE: "{{.G_BUILD_DIR}}/deps#yscope-log-viewer.md5"

tasks:
  default:
    cmds:
      - task: "core"
      - task: "log-viewer"

  core:
    vars:
    sources:
      - "{{.G_ABSEIL_CPP_CHECKSUM_FILE}}"
      - "{{.G_ANTLR4_CHECKSUM_FILE}}"
      - "{{.G_CATCH2_CHECKSUM_FILE}}"
      - "{{.G_DATE_CHECKSUM_FILE}}"
      - "{{.G_JSON_CHECKSUM_FILE}}"
      - "{{.G_LOG_SURGEON_CHECKSUM_FILE}}"
      - "{{.G_OUTCOME_CHECKSUM_FILE}}"
      - "{{.G_SIMDJSON_CHECKSUM_FILE}}"
      - "{{.G_SQLITE3_CHECKSUM_FILE}}"
      - "{{.G_UTFCPP_CHECKSUM_FILE}}"
      - "{{.G_YAML_CPP_CHECKSUM_FILE}}"
    generates: ["{{.G_DEPS_CORE_CHECKSUM_FILE}}"]
    deps: ["all-internal-deps"]
    cmds:
      - >-
        cat
        "{{.G_ABSEIL_CPP_CHECKSUM_FILE}}"
        "{{.G_ANTLR4_CHECKSUM_FILE}}"
        "{{.G_CATCH2_CHECKSUM_FILE}}"
        "{{.G_DATE_CHECKSUM_FILE}}"
        "{{.G_JSON_CHECKSUM_FILE}}"
        "{{.G_LOG_SURGEON_CHECKSUM_FILE}}"
        "{{.G_OUTCOME_CHECKSUM_FILE}}"
        "{{.G_SIMDJSON_CHECKSUM_FILE}}"
        "{{.G_SQLITE3_CHECKSUM_FILE}}"
        "{{.G_UTFCPP_CHECKSUM_FILE}}"
        "{{.G_YAML_CPP_CHECKSUM_FILE}}"
        >> "{{.G_DEPS_CORE_CHECKSUM_FILE}}"

  log-viewer:
    sources:
      - "{{.G_YSCOPE_LOG_VIEWER_CHECKSUM_FILE}}"
    generates: ["{{.G_DEPS_LOG_VIEWER_CHECKSUM_FILE}}"]
    deps: ["all-internal-deps"]
    cmds:
      - >-
        cat
        "{{.G_YSCOPE_LOG_VIEWER_CHECKSUM_FILE}}"
        >> "{{.G_DEPS_LOG_VIEWER_CHECKSUM_FILE}}"

  # NOTE: `git submodule update` doesn't support parallel invocations, so we can't use it to
  # download submodules in parallel. This means:
  # 1. the submodule tasks cannot be specified as a list of `deps`, because `task` always runs
  #   `deps` tasks in parallel.
  # 2. we need to force higher level tasks, like `core` and `log-viewer`, to run their submodule
  #    download tasks serially.
  #
  # As a solution, the `all-internal-deps` task below:
  # 1. uses `cmds` to sequentially download `ALL` submodules required by the clp-package.
  # 2. uses `run: once`, so it executes once even if multiple higher level targets depend on it.
  #
  # All higher level tasks must depend on this task instead of depending on the individual
  # submodule tasks in this file.
  all-internal-deps:
    internal: true
    run: "once"
    cmds:
      - task: "abseil-cpp"
      - task: "antlr4"
      - task: "Catch2"
      - task: "date"
      - task: "json"
      - task: "log-surgeon"
      - task: "outcome"
      - task: "simdjson"
      - task: "sqlite3"
      - task: "utfcpp"
      - task: "yaml-cpp"
      - task: "yscope-log-viewer"

  abseil-cpp:
    internal: true
    vars:
      CHECKSUM_FILE: "{{.G_ABSEIL_CPP_CHECKSUM_FILE}}"
      DEST: "{{.G_CORE_COMPONENT_SUBMODULES_DIR}}/abseil-cpp"
    sources:
      - "{{.G_DEP_DOWNLOAD_SCRIPT}}"
      - "{{.G_UTILS_TASKFILE}}"
      - "{{.ROOT_DIR}}/Taskfile.yml"
      - "{{.TASKFILE}}"
    generates: ["{{.CHECKSUM_FILE}}"]
    deps:
      - ":init"
      - task: ":utils:validate-checksum"
        vars:
          CHECKSUM_FILE: "{{.CHECKSUM_FILE}}"
          INCLUDE_PATTERNS: ["{{.DEST}}"]
    cmds:
      - task: "download-dependency"
        vars:
          DEST: "{{.DEST}}"
          FLAGS: "--extract"
          SRC_NAME: "abseil-cpp-20230802.1"
          SRC_URL: "https://github.com/abseil/abseil-cpp/archive/refs/tags/20230802.1.zip"
      # This command must be last
      - task: ":utils:compute-checksum"
        vars:
          CHECKSUM_FILE: "{{.CHECKSUM_FILE}}"
          INCLUDE_PATTERNS: ["{{.DEST}}"]

  antlr4:
    internal: true
    vars:
      CHECKSUM_FILE: "{{.G_ANTLR4_CHECKSUM_FILE}}"
      DEST_DIR: "{{.G_CORE_COMPONENT_DIR}}/third-party/antlr"
      DEST: "{{.DEST_DIR}}/antlr-4.13.1-complete.jar"
    sources:
      - "{{.G_DEP_DOWNLOAD_SCRIPT}}"
      - "{{.G_UTILS_TASKFILE}}"
      - "{{.ROOT_DIR}}/Taskfile.yml"
      - "{{.TASKFILE}}"
    generates: ["{{.CHECKSUM_FILE}}"]
    deps:
      - ":init"
      - task: ":utils:validate-checksum"
        vars:
          CHECKSUM_FILE: "{{.CHECKSUM_FILE}}"
          INCLUDE_PATTERNS: ["{{.DEST_DIR}}"]
    cmds:
      - task: "download-dependency"
        vars:
          DEST: "{{.DEST}}"
          FLAGS: "--no-submodule"
          SRC_NAME: "antlr-4.13.1-complete.jar"
          SRC_URL: "https://www.antlr.org/download/antlr-4.13.1-complete.jar"
      # This command must be last
      - task: ":utils:compute-checksum"
        vars:
          CHECKSUM_FILE: "{{.CHECKSUM_FILE}}"
          INCLUDE_PATTERNS: ["{{.DEST_DIR}}"]

  Catch2:
    internal: true
    vars:
      CHECKSUM_FILE: "{{.G_CATCH2_CHECKSUM_FILE}}"
      DEST: "{{.G_CORE_COMPONENT_SUBMODULES_DIR}}/Catch2"
    sources:
      - "{{.G_DEP_DOWNLOAD_SCRIPT}}"
      - "{{.G_UTILS_TASKFILE}}"
      - "{{.ROOT_DIR}}/Taskfile.yml"
      - "{{.TASKFILE}}"
    generates: ["{{.CHECKSUM_FILE}}"]
    deps:
      - ":init"
      - task: ":utils:validate-checksum"
        vars:
          CHECKSUM_FILE: "{{.CHECKSUM_FILE}}"
          INCLUDE_PATTERNS: ["{{.DEST}}"]
    cmds:
      - task: "download-dependency"
        vars:
          DEST: "{{.DEST}}"
          FLAGS: "--extract"
          SRC_NAME: "Catch2-2.13.7"
          SRC_URL: "https://github.com/catchorg/Catch2/archive/refs/tags/v2.13.7.zip"
      # This command must be last
      - task: ":utils:compute-checksum"
        vars:
          CHECKSUM_FILE: "{{.CHECKSUM_FILE}}"
          INCLUDE_PATTERNS: ["{{.DEST}}"]

  date:
    internal: true
    vars:
      CHECKSUM_FILE: "{{.G_DATE_CHECKSUM_FILE}}"
      DEST: "{{.G_CORE_COMPONENT_SUBMODULES_DIR}}/date"
    sources:
      - "{{.G_DEP_DOWNLOAD_SCRIPT}}"
      - "{{.G_UTILS_TASKFILE}}"
      - "{{.ROOT_DIR}}/Taskfile.yml"
      - "{{.TASKFILE}}"
    generates: ["{{.CHECKSUM_FILE}}"]
    deps:
      - ":init"
      - task: ":utils:validate-checksum"
        vars:
          CHECKSUM_FILE: "{{.CHECKSUM_FILE}}"
          INCLUDE_PATTERNS: ["{{.DEST}}"]
    cmds:
      - task: "download-dependency"
        vars:
          DEST: "{{.DEST}}"
          FLAGS: "--extract"
          SRC_NAME: "date-3.0.1"
          SRC_URL: "https://github.com/HowardHinnant/date/archive/refs/tags/v3.0.1.zip"
      # This command must be last
      - task: ":utils:compute-checksum"
        vars:
          CHECKSUM_FILE: "{{.CHECKSUM_FILE}}"
          INCLUDE_PATTERNS: ["{{.DEST}}"]

  json:
    internal: true
    vars:
      CHECKSUM_FILE: "{{.G_JSON_CHECKSUM_FILE}}"
      DEST: "{{.G_CORE_COMPONENT_SUBMODULES_DIR}}/json"
    sources:
      - "{{.G_DEP_DOWNLOAD_SCRIPT}}"
      - "{{.G_UTILS_TASKFILE}}"
      - "{{.ROOT_DIR}}/Taskfile.yml"
      - "{{.TASKFILE}}"
    generates: ["{{.CHECKSUM_FILE}}"]
    deps:
      - ":init"
      - task: ":utils:validate-checksum"
        vars:
          CHECKSUM_FILE: "{{.CHECKSUM_FILE}}"
          INCLUDE_PATTERNS: ["{{.DEST}}"]
    cmds:
      - task: "download-dependency"
        vars:
          DEST: "{{.DEST}}"
          FLAGS: "--extract"
          SRC_NAME: "json-3.11.3"
          SRC_URL: "https://github.com/nlohmann/json/archive/refs/tags/v3.11.3.zip"
      # This command must be last
      - task: ":utils:compute-checksum"
        vars:
          CHECKSUM_FILE: "{{.CHECKSUM_FILE}}"
          INCLUDE_PATTERNS: ["{{.DEST}}"]

  log-surgeon:
    internal: true
    vars:
      CHECKSUM_FILE: "{{.G_LOG_SURGEON_CHECKSUM_FILE}}"
      DEST: "{{.G_CORE_COMPONENT_SUBMODULES_DIR}}/log-surgeon"
    sources:
      - "{{.G_DEP_DOWNLOAD_SCRIPT}}"
      - "{{.G_UTILS_TASKFILE}}"
      - "{{.ROOT_DIR}}/Taskfile.yml"
      - "{{.TASKFILE}}"
    generates: ["{{.CHECKSUM_FILE}}"]
    deps:
      - ":init"
      - task: ":utils:validate-checksum"
        vars:
          CHECKSUM_FILE: "{{.CHECKSUM_FILE}}"
          INCLUDE_PATTERNS: ["{{.DEST}}"]
    cmds:
      - task: "download-dependency"
        vars:
          DEST: "{{.DEST}}"
          FLAGS: "--extract"
          SRC_NAME: "log-surgeon-895f46489b1911ab3b3aac3202afd56c96e8cd98"
          SRC_URL: "https://github.com/y-scope/log-surgeon/archive/895f464.zip"
      # This command must be last
      - task: ":utils:compute-checksum"
        vars:
          CHECKSUM_FILE: "{{.CHECKSUM_FILE}}"
          INCLUDE_PATTERNS: ["{{.DEST}}"]

  outcome:
    internal: true
    vars:
      CHECKSUM_FILE: "{{.G_OUTCOME_CHECKSUM_FILE}}"
      DEST: "{{.G_CORE_COMPONENT_SUBMODULES_DIR}}/outcome"
    sources:
      - "{{.G_DEP_DOWNLOAD_SCRIPT}}"
      - "{{.G_UTILS_TASKFILE}}"
      - "{{.ROOT_DIR}}/Taskfile.yml"
      - "{{.TASKFILE}}"
    generates: ["{{.CHECKSUM_FILE}}"]
    deps:
      - ":init"
      - task: ":utils:validate-checksum"
        vars:
          CHECKSUM_FILE: "{{.CHECKSUM_FILE}}"
          INCLUDE_PATTERNS: ["{{.DEST}}"]
    cmds:
      - task: "download-dependency"
        vars:
          DEST: "{{.DEST}}"
          FLAGS: "--extract"
          SRC_NAME: "outcome-2.2.9"
          SRC_URL: "https://github.com/ned14/outcome/archive/refs/tags/v2.2.9.zip"
      # This command must be last
      - task: ":utils:compute-checksum"
        vars:
          CHECKSUM_FILE: "{{.CHECKSUM_FILE}}"
          INCLUDE_PATTERNS: ["{{.DEST}}"]

  simdjson:
    internal: true
    vars:
      CHECKSUM_FILE: "{{.G_SIMDJSON_CHECKSUM_FILE}}"
      DEST: "{{.G_CORE_COMPONENT_SUBMODULES_DIR}}/simdjson"
    sources:
      - "{{.G_DEP_DOWNLOAD_SCRIPT}}"
      - "{{.G_UTILS_TASKFILE}}"
      - "{{.ROOT_DIR}}/Taskfile.yml"
      - "{{.TASKFILE}}"
    generates: ["{{.CHECKSUM_FILE}}"]
    deps:
      - ":init"
      - task: ":utils:validate-checksum"
        vars:
          CHECKSUM_FILE: "{{.CHECKSUM_FILE}}"
          INCLUDE_PATTERNS: ["{{.DEST}}"]
    cmds:
      - task: "download-dependency"
        vars:
          DEST: "{{.DEST}}"
          FLAGS: "--extract"
          SRC_NAME: "simdjson-3.6.3"
          SRC_URL: "https://github.com/simdjson/simdjson/archive/refs/tags/v3.6.3.zip"
      # This command must be last
      - task: ":utils:compute-checksum"
        vars:
          CHECKSUM_FILE: "{{.CHECKSUM_FILE}}"
          INCLUDE_PATTERNS: ["{{.DEST}}"]

  # We don't use a git submodule for sqlite3 since that would require building the sqlite
  # amalgamation
  sqlite3:
    internal: true
    vars:
      CHECKSUM_FILE: "{{.G_SQLITE3_CHECKSUM_FILE}}"
      DEST: "{{.G_CORE_COMPONENT_SUBMODULES_DIR}}/sqlite3"
    sources:
      - "{{.G_DEP_DOWNLOAD_SCRIPT}}"
      - "{{.G_UTILS_TASKFILE}}"
      - "{{.ROOT_DIR}}/Taskfile.yml"
      - "{{.TASKFILE}}"
    generates: ["{{.CHECKSUM_FILE}}"]
    deps:
      - ":init"
      - task: ":utils:validate-checksum"
        vars:
          CHECKSUM_FILE: "{{.CHECKSUM_FILE}}"
          INCLUDE_PATTERNS: ["{{.DEST}}"]
    cmds:
      - task: "download-dependency"
        vars:
          DEST: "{{.DEST}}"
          FLAGS: "--extract --no-submodule"
          SRC_NAME: "sqlite-amalgamation-3360000"
          SRC_URL: "https://www.sqlite.org/2021/sqlite-amalgamation-3360000.zip"
      # This command must be last
      - task: ":utils:compute-checksum"
        vars:
          CHECKSUM_FILE: "{{.CHECKSUM_FILE}}"
          INCLUDE_PATTERNS: ["{{.DEST}}"]

  utfcpp:
    internal: true
    vars:
      CHECKSUM_FILE: "{{.G_UTFCPP_CHECKSUM_FILE}}"
      DEST: "{{.G_CORE_COMPONENT_SUBMODULES_DIR}}/utfcpp"
    sources:
      - "{{.G_DEP_DOWNLOAD_SCRIPT}}"
      - "{{.G_UTILS_TASKFILE}}"
      - "{{.ROOT_DIR}}/Taskfile.yml"
      - "{{.TASKFILE}}"
    generates: ["{{.CHECKSUM_FILE}}"]
    deps:
      - ":init"
      - task: ":utils:validate-checksum"
        vars:
          CHECKSUM_FILE: "{{.CHECKSUM_FILE}}"
          INCLUDE_PATTERNS: ["{{.DEST}}"]
    cmds:
      - task: "download-dependency"
        vars:
          DEST: "{{.DEST}}"
          FLAGS: "--extract"
          SRC_NAME: "utfcpp-4.0.6"
          SRC_URL: "https://github.com/nemtrif/utfcpp/archive/refs/tags/v4.0.6.zip"
      # This command must be last
      - task: ":utils:compute-checksum"
        vars:
          CHECKSUM_FILE: "{{.CHECKSUM_FILE}}"
          INCLUDE_PATTERNS: ["{{.DEST}}"]

  yaml-cpp:
    internal: true
    vars:
      CHECKSUM_FILE: "{{.G_YAML_CPP_CHECKSUM_FILE}}"
      DEST: "{{.G_CORE_COMPONENT_SUBMODULES_DIR}}/yaml-cpp"
    sources:
      - "{{.G_DEP_DOWNLOAD_SCRIPT}}"
      - "{{.G_UTILS_TASKFILE}}"
      - "{{.ROOT_DIR}}/Taskfile.yml"
      - "{{.TASKFILE}}"
    generates: ["{{.CHECKSUM_FILE}}"]
    deps:
      - ":init"
      - task: ":utils:validate-checksum"
        vars:
          CHECKSUM_FILE: "{{.CHECKSUM_FILE}}"
          INCLUDE_PATTERNS: ["{{.DEST}}"]
    cmds:
      - task: "download-dependency"
        vars:
          DEST: "{{.DEST}}"
          FLAGS: "--extract"
          SRC_NAME: "yaml-cpp-yaml-cpp-0.7.0"
          SRC_URL: "https://github.com/jbeder/yaml-cpp/archive/refs/tags/yaml-cpp-0.7.0.zip"
      # This command must be last
      - task: ":utils:compute-checksum"
        vars:
          CHECKSUM_FILE: "{{.CHECKSUM_FILE}}"
          INCLUDE_PATTERNS: ["{{.DEST}}"]

  yscope-log-viewer:
    internal: true
    vars:
      CHECKSUM_FILE: "{{.G_YSCOPE_LOG_VIEWER_CHECKSUM_FILE}}"
      DEST: "{{.G_LOG_VIEWER_WEBUI_SRC_DIR}}/yscope-log-viewer"
    sources:
      - "{{.G_DEP_DOWNLOAD_SCRIPT}}"
      - "{{.G_UTILS_TASKFILE}}"
      - "{{.ROOT_DIR}}/Taskfile.yml"
      - "{{.TASKFILE}}"
    generates: ["{{.CHECKSUM_FILE}}"]
    deps:
      - ":init"
      - task: ":utils:validate-checksum"
        vars:
          CHECKSUM_FILE: "{{.CHECKSUM_FILE}}"
          INCLUDE_PATTERNS: ["{{.DEST}}"]
    cmds:
      - task: "download-dependency"
        vars:
          DEST: "{{.DEST}}"
          FLAGS: "--extract"
          SRC_NAME: "yscope-log-viewer-969ff35b2387bcdc3580b441907e3656640ce16d"
          SRC_URL: "https://github.com/y-scope/yscope-log-viewer/archive/969ff35.zip"
      # This command must be last
      - task: ":utils:compute-checksum"
        vars:
          CHECKSUM_FILE: "{{.CHECKSUM_FILE}}"
          INCLUDE_PATTERNS: ["{{.DEST}}"]

  download-dependency:
    internal: true
    label: "{{.TASK}}-{{.SRC_NAME}}"
    requires:
      vars: ["DEST", "FLAGS", "SRC_NAME", "SRC_URL"]
    deps:
      - ":init"
    cmds:
      - >-
        python3 "{{.G_DEP_DOWNLOAD_SCRIPT}}"
        "{{.SRC_URL}}"
        {{.SRC_NAME}}
        "{{.DEST}}"
        {{.FLAGS}}