Taskfile.dist.yaml

version: '3'

env:
  #ENV: dev
  #ENV: testing
  #ENV: staging
  ENV: production

dotenv: ['.env', '{{ .taskEnv }}']

vars:
  project: Hello World
  homepage: https://example.com
  forums: https://example.com/forums
  chat: https://chat.example.com
  ircserver: irc.libera.chat
  ircroom: help
  homepage: https://example.com
  author: Acme Inc.
  version: 0.0.1
  build:
    sh: "[ -d .git ] && git rev-parse --short HEAD || echo dev"
  date:
    sh: date -Ins
  license: MIT
  user:
    sh: id -u -n
  hostname:
    sh: hostname
  taskEnv: .task.env

tasks:

  default:
    cmds:
      - task: hello

  hello:
    desc: "Display project welcome message"
    summary: |
      Display project information and welcome message

      This is space for a longer description.
    cmds:
      - cmd: echo " Hello {{ .fullname }}!"
        silent: true
      - cmd: echo -e "\nRun 'just help' to get started."
        silent: true
      - cmd: just help
        silent: true

  help:
    desc: "Display help"
    cmds:
      - cmd: task --help
        silent: true

  build:
    desc: Build
    deps: ['build:templates']
    env:
      RUSTFLAGS: "--cfg tokio_unstable"
    cmds:
      - cargo auditable build --release
      - defer: { task: cleanup }

  build:templates:
    desc: "Compile templates"
    sources:
      - '**/*.j2'
    cmds:
      - for: sources
        cmd: minijinja-cli --strict --format toml --output $(basename {{ .ITEM }} .j2) {{ .ITEM }} variables.toml

  test:
    desc: Run tests
    deps: ['test:code', 'test:scripts', 'test:apis']

  test:code:
    desc: Test code
    cmds:
      - task: test:code:rust

  test:code:rust:
    desc: "Test Rust code"
    sources:
      - '**/*.rs'
    cmds:
      - cargo nextest run --workspace --all-features --all-targets --verbose --no-tests=warn

  test:scripts:
    desc: Test using scripts
    cmds:
      - task: run:venom

  test:apis:
    desc: Test APIs
    cmds:
      - task: run:hurl

  run:venom:
    desc: Run venom scripted tests
    sources:
      - '**/*.venom.yaml'
    run: always
    cmds:
      - for: sources
        cmd: task run:venom:test -- {{ .ITEM }}

  run:venom:test:
    desc: Run a venom test
    cmds:
      - if [ ! -f build/tests/venom/variables.yaml ]; then echo '---' > build/tests/venom/variables.yaml ; fi
      - venom run --output-dir build/tests/venom/results --html-report --var-from-file build/tests/venom/variables.yaml {{ .CLI_ARGS }}
      - mv build/tests/venom/results/test_results.html build/tests/venom/results/index.html
      - cat build/tests/venom/results/test_results_venom.json | jq
      - echo www --port 4001 build/tests/venom/results

  run:hurl:
    desc: Run hurl API tests
    sources:
      - '**/*.hurl.yaml'
    run: always
    cmds:
      - for: sources
        cmd: task run:hurl:test -- {{ .ITEM }}

  run:hurl:test:
    desc: Run a hurl test
    cmds:
      - hurl --test --parallel --glob {{ .CLI_ARGS }} --report-html build/tests/hurl --report-json build/tests/hurl
      - cat build/tests/hurl/report.json | jq
      - echo www --port 4002 build/tests/hurl

  clean:
    desc: "Clean up"
    deps: ["run:cargo-clean", "run:mise-clean"]

  run:cargo-clean:
    desc: "Run cargo clean"
    cmds:
      - cargo clean

  run:mise-clean:
    desc: "Run mise clean"
    status:
      - test ! -f .mise.toml
    cmds:
      - mise prune
      - mise cache clear

  lint:
    desc: Lint code
    deps: ['run:lychee', 'run:cargo-outdated', 'run:todos']

  run:lychee:
    desc: Run lychee link checker
    sources:
      - '**/*.md'
    cmds:
      - for: sources
        cmd: if ! test "$PWD" != "${PWD%node_modules*}" ; echo lychee {{ .ITEM }} ; fi

  run:cargo-outdated:
    desc: Run cargo outdated
    sources:
      - '**/Cargo.toml'
    cmds:
      - for: sources
        cmd: cd $(dirname {{ .ITEM }}) ; cargo outdated

  run:todos:
    desc: Run todo checker
    cmds:
      - todo-tree

  format:
    desc: Format code
    deps: ['run:treefmt']

  run:treefmt:
    desc: Run treefmt
    cmds:
      - treefmt
    # for v2: treefmt --on-unmatched=info

  docs:
    desc: Build documentation pages
    deps: ['run:rustdoc', 'run:doctave', 'run:mdbook', 'run:zola']

  run:rustdoc:
    desc: "Build rustdoc technical notes"
    generates:
      - "./docs/technical/rustdoc"
    preconditions:
      - test -f Cargo.toml
    vars:
      PKG_NAME:
        sh: cargo get package.name
      build_dir: ../../../build/output/docs/technical/rustdoc
    cmds:
      - echo Building rustdoc...
      - cargo doc
      - mkdir -p {{.build_dir}} ; mv target/doc/{{.PKG_NAME}}/* {{.build_dir}}/ ; rmdir target/doc/{{.PKG_NAME}} ; mv target/doc/* {{.build_dir}}/
      - "echo Start server: www --root {{.build_dir}} --port 4000"

  run:mdbook:
    desc: Build mdbook technical notes
    generates:
      - './docs/technical/mdbook'
    cmds:
      - echo Building mdbook...
      - if [ ! -d mdbook ]; then mkdir -p docs/technical ; cd docs/technical ; mdbook init mdbook --title "Technical Documentation" --ignore git; fi
      - cd docs/technical/mdbook ; mkdir -p ../../../build/docs/technical/mdbook ; mdbook build --dest-dir ../../../build/docs/technical/mdbook
      - 'echo Start server: mdbook serve --dest-dir ../../../build/docs/technical/mdbook --port 4001'

  run:doctave:
    desc: Build doctave user guides notes
    generates:
      - "./docs/user-guides/doctave"
    vars:
      build_dir: ../../../build/output/docs/user-guides/doctave
    cmds:
      - echo Building doctave...
      - |
        cat > doctave.yaml <<EOL
        name: {{.project}}
        version: {{.version}}
        build_dir: {{.build_dir}}
        EOL
      - cd docs/user-guides/doctave ; doctave build --release
      - 'echo Start server: doctave serve --port 4002'

  #run:docusourus:
    #desc: Build docusourus user guides
    #vars:
    #GIT_OWNER:
        #sh: git remote get-url origin | grep owner
    #GIT_PROJECT:
        #sh: git remote get-url origin | grep owner
    #generates:
      #- './docs/user-guides/docusourus'
    #cmds:
      #- echo Building docusourus...
      #- if [ ! -d docusourus ]; then npx --yes create-docusaurus@latest --typescript --git-strategy shallow --package-manager yarn docusourus classic ; fi
      #- cd docusourus
      #- 'sd --fixed-strings "facebook/docusourus" "{{.GIT_OWNER}}/{{.GIT_PROJECT}}" docusaurus.config.ts'
      #- 'sd "organizationName: .facebook." "{{.GIT_OWNER}}" docusaurus.config.ts'
      #- yarn build
      #- 'echo Start server: www --port 4003 build'

  run:zola:
    desc: Build zola blog and release notes
    generates:
      - './docs/blog/zola'
    cmds:
      - echo Building zola...
      - if [ ! -d zola ]; then mkdir -p docs/blog ; cd docs/blog ; zola init zola ; fi
      - cd docs/blog/zola ; mkdir -p ../../../build/docs/blog/zola ; zola build --force --base-url https://localhost:4004 --output-dir ../../../build/docs/blog/zola
      - 'echo Start server: www --port 4004 ../../../build/docs/blog/zola'

  audit:
    desc: Perform a security audit
    deps: ['audit:secrets', 'audit:vulnerabilities', 'audit:code-quality', 'audit:code-coverage', 'audit:licenses', 'audit:project-health']

  audit:secrets:
    desc: Scan for secrets
    cmds:
      - task: run:trufflehog

  run:trufflehog:
    desc: Run trufflehog
    summary: |
      Scan for:

      - 700 credential detectors that support active verification against their respective APIs.
      - GitHub, GitLab, Docker, filesystems, S3, GCS, Circle CI and Travis CI.
      - Instantly verify private keys against millions of GitHub users and billions of TLS certificates
      - Scan binaries and documents

    cmds:
      - trufflehog git file://. --since-commit HEAD --only-verified --no-update --fail

  audit:vulnerabilities:
    desc: Scan for vulnerabilities
    cmds:
      - task: run:trivy

  run:trivy:
    desc: Run trivy
    summary: |
      Scan for:

      OS packages and software dependencies in use (SBOM)
      Known vulnerabilities (CVEs)
      IaC issues and misconfigurations
      Sensitive information and secrets
      Software licenses
    cmds:
      - trivy --config trivy.yaml fs .

  audit:code-quality:
    desc: Look for code smells
    cmds:
      - task: run:sonarcube

  run:sonarcube:
    desc: Run sonarcube
    cmds:
      - echo sonarcube run

  audit:code-coverage:
    desc: Calculate code coverage
    cmds:
      - task: run:llvm-cov

  run:llvm-cov:
    desc: Run LLVM cov
    env:
      LLVM_COV: /usr/local/bin/llvm-cov19
      LLVM_PROFDATA: /usr/local/bin/llvm-profdata19
    cmds:
      - cargo llvm-cov nextest
      - cargo llvm-cov --manifest-path backpack/cli/Cargo.toml --fail-under-lines 90 --fail-under-functions 90
      - cargo llvm-cov --manifest-path backpack/lib/Cargo.toml --fail-under-lines 90 --fail-under-functions 90

  audit:licenses:
    desc: Look for incompatible licenses
    cmds:
      - task: run:feluda
      - task: run:cargo-deny
      - task: run:cargo-license

  audit:project-health:
    desc: Overall health of this project
    cmds:
      - 'echo Missing docs :: website'
      - 'echo Missing docs :: comments'
      - 'echo Missing code :: tests'
      - 'echo Missing code :: test coverage'
      - 'echo Missing benchmarks :: tests'
      - 'echo Missing benchmarks :: reports'
      - 'echo Missing git :: license'
      - 'echo Missing git :: readme'
      - 'echo Missing security :: sbom'
      - 'echo Missing security :: checksums'
      - 'echo Missing security :: signatures :: minisign'
      - 'echo Missing security :: signatures :: cosign'
      - 'echo Missing security :: rust :: cargo-audible'

  run:feluda:
    desc: Run feluda
    cmds:
      - feluda

  run:cargo-deny:
    desc: Run cargo deny
    cmds:
      - cargo deny check licenses bans

  run:cargo-license:
    desc: Run cargo license
    cmds:
      - cargo license --authors --do-not-bundle