Refactor taskfiles and add build, install, and example tasks for all targets and build types.

Author: davidlion

taskfile.yaml

@@ -7,19 +7,17 @@ includes:
   build: "./taskfiles/build.yaml"
   deps: "./taskfiles/deps.yaml"
   lint: "./taskfiles/lint.yaml"
-  utils: "tools/yscope-dev-utils/exports/taskfiles/utils/utils.yaml"
+  test: "./taskfiles/test.yaml"
+  utils: "./tools/yscope-dev-utils/exports/taskfiles/utils/utils.yaml"
 
 vars:
   G_BUILD_DIR: "{{.ROOT_DIR}}/build"
   G_CPP_SRC_DIR: "{{.ROOT_DIR}}/src"
-  G_DEPS_DIR: "{{.G_BUILD_DIR}}/deps"
 
-  # These should be kept in-sync with its usage in CMakeLists.txt
-  G_DEPS_CMAKE_SETTINGS_DIR: "{{.G_DEPS_DIR}}/cmake-settings"
-  G_DEPS_CMAKE_SETTINGS_FILE: "{{.G_DEPS_CMAKE_SETTINGS_DIR}}/settings.cmake"
-
-  G_TEST_BIN_DIR: "{{.G_BUILD_DIR}}/testbin"
-  G_TEST_TARGET_SUFFIXES:
+  G_VALID_BUILD_TYPES:
+    - "debug"
+    - "release"
+  G_VALID_TARGETS:
     - "all"
     - "containers"
     - "error_handling"
@@ -38,12 +36,44 @@ tasks:
     cmds:
       - "mkdir -p '{{.G_BUILD_DIR}}'"
 
-  test-*:
-    desc: "Runs unit tests for the specified test target."
-    vars:
-      TEST_TARGET: >-
-        {{printf "unit-test-%s" (index .MATCH 0)}}
-    deps:
-      - "build:{{.TEST_TARGET}}"
+  validate-args:
+    internal: true
+    requires:
+      vars: ["BUILD_TYPE", "TARGET"]
     cmds:
-      - "{{.G_TEST_BIN_DIR}}/{{.TEST_TARGET}}"
+      - task: "validate-build-type"
+        vars:
+          BUILD_TYPE: "{{.BUILD_TYPE}}"
+      - task: "validate-target"
+        vars:
+          TARGET: "{{.TARGET}}"
+
+  validate-build-type:
+    internal: true
+    requires:
+      vars: ["BUILD_TYPE"]
+    preconditions:
+      - sh: >-
+          {{has .BUILD_TYPE .G_VALID_BUILD_TYPES}}
+        msg: |-
+          {{- if not (has .BUILD_TYPE .G_VALID_BUILD_TYPES)}}
+            {{.BUILD_TYPE}} is not a valid build type. List of valid build types:
+            {{- range .G_VALID_BUILD_TYPES}}
+              {{.}}
+            {{- end}}
+          {{- end}}
+
+  validate-target:
+    internal: true
+    requires:
+      vars: ["TARGET"]
+    preconditions:
+      - sh: >-
+          {{has .TARGET .G_VALID_TARGETS}}
+        msg: |-
+          {{- if not (has .TARGET .G_VALID_TARGETS)}}
+            {{.TARGET}} is not a valid build target. List of valid build targets:
+            {{- range .G_VALID_TARGETS}}
+              {{.}}
+            {{- end}}
+          {{- end}}

taskfiles/build.yaml

@@ -1,65 +1,139 @@
 version: "3"
 
+includes:
+  deps:
+    internal: true
+    taskfile: "deps.yaml"
+  utils:
+    internal: true
+    taskfile: "../tools/yscope-dev-utils/exports/taskfiles/utils/utils.yaml"
+
 vars:
-  G_CMAKE_CACHE: "{{.G_BUILD_DIR}}/CMakeCache.txt"
-  G_COMPILE_COMMANDS_DB: "{{.G_BUILD_DIR}}/compile_commands.json"
+  G_EXAMPLES_BUILD_DIR: "{{.G_BUILD_DIR}}/examples"
+  G_YSTDLIB_BUILD_DIR: "{{.G_BUILD_DIR}}/ystdlib"
 
 tasks:
-  all:
-    desc: "Builds all of ystdlib."
+  build-*-*:
+    desc: "build-<target>-<build type>: Builds the specified build target with build type."
+    vars:
+      BUILD_TYPE: "{{index .MATCH 1}}"
+      TARGET: "{{index .MATCH 0}}"
     deps:
-      - "init"
+      - task: ":validate-args"
+        vars:
+          BUILD_TYPE: "{{.BUILD_TYPE}}"
+          TARGET: "{{.TEST_TARGET}}"
     cmds:
-      - task: ":utils:cmake:build"
+      - task: "build"
         vars:
-          BUILD_DIR: "{{.G_BUILD_DIR}}"
+          BUILD_TYPE: "{{.BUILD_TYPE}}"
+          TARGET: "{{.TARGET}}"
 
-  target-*:
-    desc: "Builds a CMake target."
+  clean-*:
+    desc: "clean-<build type>: Clean the build type."
     vars:
-      TARGET: "{{index .MATCH 0}}"
+      BUILD_TYPE: "{{index .MATCH 0}}"
     deps:
-      - "init"
+      - task: ":validate-build-type"
+        vars:
+          BUILD_TYPE: "{{.BUILD_TYPE}}"
     cmds:
-      - task: ":utils:cmake:build"
+      - task: "utils:cmake:clean"
         vars:
-          BUILD_DIR: "{{.G_BUILD_DIR}}"
-          TARGETS:
-            - "{{.TARGET}}"
+          BUILD_DIR: "{{.G_YSTDLIB_DIR}}/{{.BUILD_TYPE}}"
 
-  unit-test-*:
-    desc: "Builds the specified unit test target."
+  examples-*:
+    desc: "examples-<build type>: Builds the examples with build type."
     vars:
-      TARGET_SUFFIX: >-
-        {{index .MATCH 0}}
-      TARGET_NAME: >-
-        {{printf "unit-test-%s" .TARGET_SUFFIX}}
-    preconditions:
-      - sh: >-
-          {{has .TARGET_SUFFIX .G_TEST_TARGET_SUFFIXES}}
-        msg: |-
-          {{.TARGET_NAME}} is not a valid unit test target!
-          List of unit test targets:
-          {{- range .G_TEST_TARGET_SUFFIXES }}
-            unit-test-{{.}}
-          {{- end}}
+      BUILD_TYPE: "{{index .MATCH 0}}"
+    deps:
+      - task: ":validate-build-type"
+        vars:
+          BUILD_TYPE: "{{.BUILD_TYPE}}"
     cmds:
-      - task: "target-{{.TARGET_NAME}}"
+      - task: "examples"
+        vars:
+          BUILD_TYPE: "{{.BUILD_TYPE}}"
 
-  clean:
-    desc: "Removes all built artifacts."
+  install-*-*:
+    desc: >-
+      install-<target>-<build type> INSTALL_PREFIX="<prefix path>": Install the specified build
+      target with build type to the prefix path."
+    vars:
+      BUILD_TYPE: "{{index .MATCH 1}}"
+      TARGET: "{{index .MATCH 0}}"
+    requires:
+      vars: ["INSTALL_PREFIX"]
     deps:
-      - task: ":utils:cmake:clean"
+      - task: ":validate-args"
+        vars:
+          BUILD_TYPE: "{{.BUILD_TYPE}}"
+          TARGET: "{{.TEST_TARGET}}"
+    cmds:
+      - task: "install"
         vars:
-          BUILD_DIR: "{{.G_BUILD_DIR}}"
+          BUILD_TYPE: "{{.BUILD_TYPE}}"
+          INSTALL_PREFIX: "{{.INSTALL_PREFIX}}"
+          TARGET: "{{.TARGET}}"
 
-  init:
+  build:
     internal: true
+    requires:
+      vars: ["BUILD_TYPE", "TARGET"]
     deps:
-      - ":deps:install-all"
-    run: "once"
+      - "deps:all"
     cmds:
-      - task: ":utils:cmake:generate"
+      - task: "utils:cmake:generate"
         vars:
-          BUILD_DIR: "{{.G_BUILD_DIR}}"
+          BUILD_DIR: "{{.G_YSTDLIB_BUILD_DIR}}/{{.BUILD_TYPE}}"
+          EXTRA_ARGS:
+            - "-DCMAKE_BUILD_TYPE={{.BUILD_TYPE}}"
           SOURCE_DIR: "{{.ROOT_DIR}}"
+      - task: "utils:cmake:build"
+        vars:
+          BUILD_DIR: "{{.G_YSTDLIB_BUILD_DIR}}/{{.BUILD_TYPE}}"
+          TARGETS:
+            - "{{.TARGET}}"
+
+  examples:
+    internal: true
+    requires:
+      vars: ["BUILD_TYPE"]
+    vars:
+      INSTALL_PREFIX: "{{.G_EXAMPLES_BUILD_DIR}}/deps/ystdlib/{{.BUILD_TYPE}}"
+    deps:
+      - task: "build"
+        vars:
+          BUILD_TYPE: "{{.BUILD_TYPE}}"
+          TARGET: "{{.TARGET}}"
+    cmds:
+      - task: "install"
+        vars:
+          BUILD_TYPE: "{{.BUILD_TYPE}}"
+          INSTALL_PREFIX: "{{.INSTALL_PREFIX}}"
+          TARGET: "{{.TARGET}}"
+      - task: "utils:cmake:generate"
+        vars:
+          BUILD_DIR: "{{.G_EXAMPLES_BUILD_DIR}}/{{.BUILD_TYPE}}"
+          EXTRA_ARGS:
+            - "-DCMAKE_BUILD_TYPE={{.BUILD_TYPE}}"
+            - "-Dystdlib_ROOT={{.INSTALL_PREFIX}}"
+          SOURCE_DIR: "{{.ROOT_DIR}}/examples"
+      - task: "utils:cmake:build"
+        vars:
+          BUILD_DIR: "{{.G_EXAMPLES_BUILD_DIR}}/{{.BUILD_TYPE}}"
+
+  install:
+    internal: true
+    requires:
+      vars: ["BUILD_TYPE", "INSTALL_PREFIX", "TARGET"]
+    deps:
+      - task: "build"
+        vars:
+          BUILD_TYPE: "{{.BUILD_TYPE}}"
+          TARGET: "{{.TARGET}}"
+    cmds:
+      - task: "utils:cmake:install"
+        vars:
+          BUILD_DIR: "{{.G_YSTDLIB_BUILD_DIR}}/{{.BUILD_TYPE}}"
+          INSTALL_PREFIX: "{{.INSTALL_PREFIX}}"

taskfiles/deps.yaml

@@ -1,49 +1,56 @@
 version: "3"
 
+includes:
+  utils:
+    internal: true
+    taskfile: "../tools/yscope-dev-utils/exports/taskfiles/utils/utils.yaml"
+
 vars:
   G_CATCH2_LIB_NAME: "Catch2"
-  G_CATCH2_WORK_DIR: "{{.G_DEPS_DIR}}/{{.G_CATCH2_LIB_NAME}}"
+  G_DEPS_DIR: "{{.G_BUILD_DIR}}/deps"
+
+  # This path must be kept in-sync with its usage in CMakeLists.txt and examples/CMakeLists.txt.
+  G_DEPS_CMAKE_SETTINGS_DIR: "{{.G_DEPS_DIR}}/cmake-settings"
 
 tasks:
-  install-all:
+  all:
     desc: "Install all dependencies required by ystdlib."
     run: "once"
     cmds:
-      - "rm -rf '{{.G_DEPS_CMAKE_SETTINGS_DIR}}'"
-      - "mkdir -p '{{.G_DEPS_CMAKE_SETTINGS_DIR}}'"
-      - task: ":utils:cmake:install-deps-and-generate-settings"
+      - task: "utils:cmake:install-deps-and-generate-settings"
         vars:
           CMAKE_SETTINGS_DIR: "{{.G_DEPS_CMAKE_SETTINGS_DIR}}"
-          CMAKE_SETTINGS_FILE: "{{.G_DEPS_CMAKE_SETTINGS_FILE}}"
-          DEP_TASK: "deps:install-all-parallel"
+          DEP_TASK: "all-parallel"
 
-  install-all-parallel:
+  all-parallel:
     internal: true
+    run: "once"
     deps:
-      - "install-boost"
-      - "install-Catch2"
+      - "boost"
+      - "Catch2"
 
-  install-Catch2:
+  Catch2:
     internal: true
     run: "once"
     cmds:
-      - task: ":utils:cmake:install-remote-tar"
+      - task: "utils:cmake:install-remote-tar"
         vars:
           CMAKE_PACKAGE_NAME: "{{.G_CATCH2_LIB_NAME}}"
           CMAKE_SETTINGS_DIR: "{{.G_DEPS_CMAKE_SETTINGS_DIR}}"
           TAR_SHA256: "1ab2de20460d4641553addfdfe6acd4109d871d5531f8f519a52ea4926303087"
           TAR_URL: "https://github.com/catchorg/Catch2/archive/refs/tags/v3.8.0.tar.gz"
-          WORK_DIR: "{{.G_CATCH2_WORK_DIR}}"
+          WORK_DIR: "{{.G_DEPS_DIR}}"
 
-  install-boost:
+  boost:
     internal: true
     run: "once"
     cmds:
+      # NOTE: boost:download-and-install only works when included from the top level taskfile
       - task: ":utils:boost:download-and-install"
         vars:
           CMAKE_SETTINGS_DIR: "{{.G_DEPS_CMAKE_SETTINGS_DIR}}"
           FILE_SHA256: "d6c69e4459eb5d6ec208250291221e7ff4a2affde9af6e49c9303b89c687461f"
           URL: "https://github.com/boostorg/boost/releases/download/boost-1.87.0\
             /boost-1.87.0-b2-nodocs.tar.gz"
           TARGETS: ["headers"]
-          WORK_DIR: "{{.G_DEPS_DIR}}/boost"
+          WORK_DIR: "{{.G_DEPS_DIR}}"

taskfiles/lint-cpp.yaml

@@ -1,6 +1,7 @@
 version: "3"
 
 vars:
+  G_COMPILE_COMMANDS_DB: "{{.G_BUILD_DIR}}/compile_commands.json"
   G_LINT_CLANG_TIDY_DIR: "{{.G_BUILD_DIR}}/lint-clang-tidy"
 
 tasks:

taskfiles/test.yaml

@@ -0,0 +1,26 @@
+version: "3"
+
+includes:
+  build:
+    internal: true
+    taskfile: "build.yaml"
+
+tasks:
+  test-*-*:
+    desc: >-
+      test-<target>-<build type>: Runs unit tests for the specified test target and build type.
+    vars:
+      BUILD_TYPE: "{{index .MATCH 1}}"
+      TARGET: "{{index .MATCH 0}}"
+      TEST_TARGET: "unit-test-{{.TARGET}}"
+    deps:
+      - task: ":validate-args"
+        vars:
+          BUILD_TYPE: "{{.BUILD_TYPE}}"
+          TARGET: "{{.TARGET}}"
+    cmds:
+      - task: "build:build"
+        vars:
+          BUILD_TYPE: "{{.BUILD_TYPE}}"
+          TARGET: "{{.TEST_TARGET}}"
+      - "{{.G_BUILD_DIR}}/testbin/{{.TEST_TARGET}}"