working

Signed-off-by: Alex Goodman <alex.goodman@anchore.com>

.binny.yaml

@@ -1,117 +0,0 @@
-tools:
-  # we want to use a pinned version of binny to manage the toolchain (so binny manages itself!)
-  - name: binny
-    version:
-      want: v0.6.3
-    method: github-release
-    with:
-      repo: anchore/binny
-
-  # used to produce SBOMs during release
-  - name: syft
-    version:
-      want: latest
-    method: github-release
-    with:
-      repo: anchore/syft
-
-  # used to sign mac binaries at release
-  - name: quill
-    version:
-      want: v0.4.1
-    method: github-release
-    with:
-      repo: anchore/quill
-
-  # used for linting
-  - name: golangci-lint
-    version:
-      want: v1.56.2
-    method: github-release
-    with:
-      repo: golangci/golangci-lint
-
-  # used for showing the changelog at release
-  - name: glow
-    version:
-      want: v1.5.1
-    method: github-release
-    with:
-      repo: charmbracelet/glow
-
-  # used for signing the checksums file at release
-  - name: cosign
-    version:
-      want: v2.2.3
-    method: github-release
-    with:
-      repo: sigstore/cosign
-
-  # used in integration tests to verify JSON schemas
-  - name: yajsv
-    version:
-      want: v1.4.1
-    method: github-release
-    with:
-      repo: neilpa/yajsv
-
-  # used to release all artifacts
-  - name: goreleaser
-    version:
-      want: v1.24.0
-    method: github-release
-    with:
-      repo: goreleaser/goreleaser
-
-  # used for organizing imports during static analysis
-  - name: gosimports
-    version:
-      want: v0.3.8
-    method: github-release
-    with:
-      repo: rinchsan/gosimports
-
-  # used at release to generate the changelog
-  - name: chronicle
-    version:
-      want: v0.8.0
-    method: github-release
-    with:
-      repo: anchore/chronicle
-
-  # used during static analysis for license compliance
-  - name: bouncer
-    version:
-      want: v0.4.0
-    method: github-release
-    with:
-      repo: wagoodman/go-bouncer
-
-  # used for showing benchmark testing
-  - name: benchstat
-    version:
-      want: latest
-      method: go-proxy
-      with:
-        module: golang.org/x/perf
-        allow-unresolved-version: true
-    method: go-install
-    with:
-      entrypoint: cmd/benchstat
-      module: golang.org/x/perf
-
-  # used for running all local and CI tasks
-  - name: task
-    version:
-      want: v3.35.1
-    method: github-release
-    with:
-      repo: go-task/task
-
-  # used for triggering a release
-  - name: gh
-    version:
-      want: v2.45.0
-    method: github-release
-    with:
-      repo: cli/cli

.bouncer.yaml

@@ -1,61 +1,9 @@
 permit:
   - BSD.*
-  - CC0.*
   - MIT.*
   - Apache.*
   - MPL.*
   - ISC
-  - WTFPL
-
 ignore-packages:
   # packageurl-go is released under the MIT license located in the root of the repo at /mit.LICENSE
-  - github.com/anchore/packageurl-go
-
-  # both of these dependencies are specified as Apache-2.0 in their respective GitHub READMEs
-  - github.com/alibabacloud-go/cr-20160607/client
-  - github.com/alibabacloud-go/tea-xml/service
-
-  # crypto/internal/boring is released under the openSSL license as a part of the Golang Standard Libary
-  - crypto/internal/boring
-
-  # from: https://github.com/spdx/tools-golang/blob/main/LICENSE.code
-  # The tools-golang source code is provided and may be used, at your option,
-  # under either:
-  # * Apache License, version 2.0 (Apache-2.0), OR
-  # * GNU General Public License, version 2.0 or later (GPL-2.0-or-later).
-  # (we choose Apache-2.0)
-  - github.com/spdx/tools-golang
-
-  # from: https://github.com/xi2/xz/blob/master/LICENSE
-  # All these files have been put into the public domain.
-  # You can do whatever you want with these files.
-  - github.com/xi2/xz
-
-  # from: https://gitlab.com/cznic/sqlite/-/blob/v1.15.4/LICENSE
-  # This is a BSD-3-Clause license
-  - modernc.org/libc
-  - modernc.org/libc/errno
-  - modernc.org/libc/fcntl
-  - modernc.org/libc/fts
-  - modernc.org/libc/grp
-  - modernc.org/libc/langinfo
-  - modernc.org/libc/limits
-  - modernc.org/libc/netdb
-  - modernc.org/libc/netinet/in
-  - modernc.org/libc/poll
-  - modernc.org/libc/pthread
-  - modernc.org/libc/pwd
-  - modernc.org/libc/signal
-  - modernc.org/libc/stdio
-  - modernc.org/libc/stdlib
-  - modernc.org/libc/sys/socket
-  - modernc.org/libc/sys/stat
-  - modernc.org/libc/sys/types
-  - modernc.org/libc/termios
-  - modernc.org/libc/time
-  - modernc.org/libc/unistd
-  - modernc.org/libc/utime
-  - modernc.org/libc/uuid/uuid
-  - modernc.org/libc/wctype
-  - modernc.org/mathutil
-  - modernc.org/memory
+  - github.com/package-url/packageurl-go

.chronicle.yaml

@@ -1,78 +0,0 @@
-enforce-v0: false
-title: ""
-
-github:
-  host: github.com
-  include-issue-pr-authors: true
-  include-issue-prs: true
-  include-issues-not-planned: false
-  include-prs: true
-  include-issues: true
-  include-unlabeled-issues: true
-  include-unlabeled-prs: true
-  issues-require-linked-prs: false
-  consider-pr-merge-commits: true
-
-  exclude-labels:
-    - duplicate
-    - question
-    - invalid
-    - wontfix
-    - wont-fix
-    - release-ignore
-    - changelog-ignore
-    - ignore
-
-  changes:
-
-    - name: security-fixes
-      title: Security Fixes
-      semver-field: patch
-      labels:
-        - security
-        - vulnerability
-
-    - name: added-feature
-      title: Added Features
-      semver-field: minor
-      labels:
-        - enhancement
-        - feature
-        - minor
-
-    - name: bug-fix
-      title: Bug Fixes
-      semver-field: patch
-      labels:
-        - bug
-        - fix
-        - bug-fix
-        - patch
-
-    - name: breaking-feature
-      title: Breaking Changes
-      semver-field: major
-      labels:
-        - breaking
-        - backwards-incompatible
-        - breaking-change
-        - breaking-feature
-        - major
-        - detected-breaking-change
-
-    - name: removed-feature
-      title: Removed Features
-      semver-field: major
-      labels:
-        - removed
-
-    - name: deprecated-feature
-      title: Deprecated Features
-      semver-field: minor
-      labels:
-        - deprecated
-
-    - name: unknown
-      title: Additional Changes
-      semver-field: ""
-      labels: []

.circleci/config.yml

@@ -0,0 +1,129 @@
+version: 2.1
+
+jobs:
+  run-static-analysis:
+    parameters:
+      version:
+        type: string
+    docker:
+      - image: circleci/golang:<< parameters.version >>
+        environment:
+          GO111MODULE: "on"
+          # work around for recent circle CI breaking change
+          # Error: "Error response from daemon: client version 1.39 is too new. Maximum supported API version is 1.38"
+          DOCKER_API_VERSION: "1.38"
+    # 2CPU / 4GB RAM
+    resource_class: medium
+    steps:
+      - checkout
+
+      - restore_cache:
+          keys:
+            - go-<< parameters.version >>-{{ checksum "go.sum" }}-{{ checksum "Makefile" }}
+
+      - run: make ci-bootstrap
+
+      - save_cache:
+          key: go-<< parameters.version >>-{{ checksum "go.sum" }}-{{ checksum "Makefile" }}
+          paths:
+            - "/go/pkg/mod"
+            - ".tmp"
+
+      - run:
+          name: run static analysis
+          command: make static-analysis
+
+  run-tests:
+    parameters:
+      version:
+        type: string
+    docker:
+      - image: circleci/golang:<< parameters.version >>
+        environment:
+          GO111MODULE: "on"
+          # work around for recent circle CI breaking change
+          # Error: "Error response from daemon: client version 1.39 is too new. Maximum supported API version is 1.38"
+          DOCKER_API_VERSION: "1.38"
+    # 2CPU / 4GB RAM
+    resource_class: medium
+    steps:
+      - checkout
+
+      - restore_cache:
+          keys:
+            - go-<< parameters.version >>-{{ checksum "go.sum" }}-{{ checksum "Makefile" }}
+
+      - run: make ci-bootstrap
+
+      - save_cache:
+          key: go-<< parameters.version >>-{{ checksum "go.sum" }}-{{ checksum "Makefile" }}
+          paths:
+            - "/go/pkg/mod"
+            - ".tmp"
+
+      - setup_remote_docker:
+          version: 18.06.0-ce
+
+      - run:
+          name: enable docker client
+          command: |
+            # all of this to enable "circleci local execute ..." cli commands for /var/run/docker.sock
+            mkdir -p ${HOME}/.local/bin
+            cat \<< EOF > ${HOME}/.local/bin/docker
+            #!/bin/bash
+            set -xue
+            sudo -E ${HOME}/.local/bin/docker.bin \$@
+            EOF
+            sudo mv /usr/bin/docker ${HOME}/.local/bin/docker.bin
+            chmod 755 ${HOME}/.local/bin/docker
+
+      - run:
+          name: build cache key for java test-fixture blobs
+          command: make java-packages-fingerprint
+
+      - restore_cache:
+          keys:
+            - syft-unit-test-java-cache-{{ checksum "syft/cataloger/java/test-fixtures/java-builds/packages.fingerprint" }}
+
+      - run:
+          name: run unit tests
+          command: make unit
+
+      - save_cache:
+          key: syft-unit-test-java-cache-{{ checksum "syft/cataloger/java/test-fixtures/java-builds/packages.fingerprint" }}
+          paths:
+            - "syft/cataloger/java/test-fixtures/java-builds/packages"
+
+      - run:
+          name: validate syft output against the CycloneDX schema
+          command: make validate-cyclonedx-schema
+
+      - run:
+          name: build hash key for integration test-fixtures blobs
+          command: make integration-fingerprint
+
+      - restore_cache:
+          keys:
+            - syft-integration-test-tar-cache-{{ checksum "test/integration/test-fixtures/tar-cache.fingerprint" }}
+      - run:
+          name: run integration tests
+          command: make integration
+
+      - save_cache:
+          key: syft-integration-test-tar-cache-{{ checksum "test/integration/test-fixtures/tar-cache.fingerprint" }}
+          paths:
+            - "test/integration/test-fixtures/tar-cache"
+
+workflows:
+  # Note: changing this workflow name requires making the same update in the .github/workflows/release.yaml pipeline
+  "Static Analysis + Unit + Integration":
+    jobs:
+      - run-static-analysis:
+          name: "Static Analysis"
+          version: "1.14"
+      - run-tests:
+          name: "Unit & Integration Tests (go-1.13)"
+          version: "1.13"
+      - run-tests:
+          name: "Unit & Integration Tests (go-latest)"
+          version: "latest"

.github/ISSUE_TEMPLATE/bug_report.md

@@ -11,10 +11,10 @@ assignees: ''
 
 **What you expected to happen**:
 
-**Steps to reproduce the issue**:
+**How to reproduce it (as minimally and precisely as possible)**:
 
 **Anything else we need to know?**:
 
 **Environment**:
-- Output of `syft version`:
+- syft version (use `syft version -v`):
 - OS (e.g: `cat /etc/os-release` or similar):

.github/ISSUE_TEMPLATE/config.yml

@@ -1,6 +1,11 @@
 contact_links:
 
-  - name: Join the Slack community 💬
-    # link to our community Slack registration page
-    url: https://anchore.com/slack
-    about: 'Come chat with us! Ask for help, join our software development efforts, or just give us feedback!'
+  - name: Help & Support Slack Channel ⛑️
+    # link to toolbox-help channel
+    url: https://anchorecommunity.slack.com/archives/C019BUXV7R6
+    about: Ask a questions and get answers
+
+  - name: Developer Slack Channel 💬
+    # link to toolbox-dev channel
+    url: https://anchorecommunity.slack.com/archives/C0190NF9TSM
+    about: Participate in design discussions and feature development

.github/actions/bootstrap/action.yaml

@@ -1,61 +0,0 @@
-name: "Bootstrap"
-
-description: "Bootstrap all tools and dependencies"
-inputs:
-  go-version:
-    description: "Go version to install"
-    required: true
-    default: "1.21.x"
-  go-dependencies:
-    description: "Download go dependencies"
-    required: true
-    default: "true"
-  cache-key-prefix:
-    description: "Prefix all cache keys with this value"
-    required: true
-    default: "1ac8281053"
-  compute-fingerprints:
-    description: "Compute test fixture fingerprints"
-    required: true
-    default: "true"
-  bootstrap-apt-packages:
-    description: "Space delimited list of tools to install via apt"
-    default: "libxml2-utils"
-
-
-runs:
-  using: "composite"
-  steps:
-    # note: go mod and build is automatically cached on default with v4+
-    - uses: actions/setup-go@93397bea11091df50f3d7e59dc26a7711a8bcfbe #v4.1.0
-      if: inputs.go-version != ''
-      with:
-        go-version: ${{ inputs.go-version }}
-
-    - name: Restore tool cache
-      id: tool-cache
-      uses: actions/cache@704facf57e6136b1bc63b828d79edcd491f0ee84 #v3.3.2
-      with:
-        path: ${{ github.workspace }}/.tool
-        key: ${{ inputs.cache-key-prefix }}-${{ runner.os }}-tool-${{ hashFiles('.binny.yaml') }}
-
-    - name: Install project tools
-      shell: bash
-      run: make tools
-
-    - name: Install go dependencies
-      if: inputs.go-dependencies == 'true'
-      shell: bash
-      run: make ci-bootstrap-go
-
-    - name: Install apt packages
-      if: inputs.bootstrap-apt-packages != ''
-      shell: bash
-      run: |
-        DEBIAN_FRONTEND=noninteractive sudo apt update && sudo -E apt install -y ${{ inputs.bootstrap-apt-packages }}
-
-    - name: Create all cache fingerprints
-      if: inputs.compute-fingerprints == 'true'
-      shell: bash
-      run: make fingerprints
-

.github/dependabot.yml

@@ -1,12 +0,0 @@
-version: 2
-updates:
-  - package-ecosystem: gomod
-    directory: "/"
-    schedule:
-      interval: "daily"
-    open-pull-requests-limit: 10
-  - package-ecosystem: "github-actions"
-    directory: "/"
-    schedule:
-      interval: "daily"
-    open-pull-requests-limit: 10

.github/scripts/check_binary_fixture_size.sh

@@ -1,36 +0,0 @@
-#!/bin/bash
-
-# current limit for fixture size
-size=1000
-
-if [ $# -eq 0 ]; then
-  echo "Usage: $0 <directory>"
-  exit 1
-fi
-
-directory="$1"
-
-# Remove trailing slash using parameter expansion
-directory="${directory%/}"
-
-if [ ! -d "$directory" ]; then
-  echo "Directory not found: $directory"
-  exit 1
-fi
-
-found_large_files=0
-while IFS= read -r -d '' file; do
-  if [ $(wc -c < "$file") -gt $size ]; then
-    echo "File $file is greater than ${size} bytes."
-    found_large_files=1
-  fi
-done < <(find "$directory" -type f -print0)
-
-if [ "$found_large_files" -eq 1 ]; then
-  echo "Script failed: Some files are greater than ${size} bytes."
-  exit 1
-else
-  echo "All files in $directory and its subdirectories are ${size} bytes or smaller. Check passed."
-  exit 0
-fi
-

.github/scripts/ci-check.sh

@@ -1,11 +0,0 @@
-#!/usr/bin/env bash
-
-red=$(tput setaf 1)
-bold=$(tput bold)
-normal=$(tput sgr0)
-
-# assert we are running in CI (or die!)
-if [[ -z "$CI" ]]; then
-    echo "${bold}${red}This step should ONLY be run in CI. Exiting...${normal}"
-    exit 1
-fi

.github/scripts/coverage.py

@@ -1,36 +0,0 @@
-#!/usr/bin/env python3
-import subprocess
-import sys
-import shlex
-
-
-class bcolors:
-    HEADER = '\033[95m'
-    OKBLUE = '\033[94m'
-    OKCYAN = '\033[96m'
-    OKGREEN = '\033[92m'
-    WARNING = '\033[93m'
-    FAIL = '\033[91m'
-    ENDC = '\033[0m'
-    BOLD = '\033[1m'
-    UNDERLINE = '\033[4m'
-
-
-if len(sys.argv) < 3:
-    print("Usage: coverage.py [threshold] [go-coverage-report]")
-    sys.exit(1)
-
-
-threshold = float(sys.argv[1])
-report = sys.argv[2]
-
-
-args = shlex.split(f"go tool cover -func {report}")
-p = subprocess.run(args, capture_output=True, text=True)
-
-percent_coverage = float(p.stdout.splitlines()[-1].split()[-1].replace("%", ""))
-print(f"{bcolors.BOLD}Coverage: {percent_coverage}%{bcolors.ENDC}")
-
-if percent_coverage < threshold:
-    print(f"{bcolors.BOLD}{bcolors.FAIL}Coverage below threshold of {threshold}%{bcolors.ENDC}")
-    sys.exit(1)

.github/scripts/go-mod-tidy-check.sh

@@ -1,30 +0,0 @@
-#!/usr/bin/env bash
-set -eu
-
-ORIGINAL_STATE_DIR=$(mktemp -d "TEMP-original-state-XXXXXXXXX")
-TIDY_STATE_DIR=$(mktemp -d "TEMP-tidy-state-XXXXXXXXX")
-
-trap "cp -p ${ORIGINAL_STATE_DIR}/* ./ && git update-index -q --refresh && rm -fR ${ORIGINAL_STATE_DIR} ${TIDY_STATE_DIR}" EXIT
-
-# capturing original state of files...
-cp go.mod go.sum "${ORIGINAL_STATE_DIR}"
-
-# capturing state of go.mod and go.sum after running go mod tidy...
-go mod tidy
-cp go.mod go.sum "${TIDY_STATE_DIR}"
-
-set +e
-
-# detect difference between the git HEAD state and the go mod tidy state
-DIFF_MOD=$(diff -u "${ORIGINAL_STATE_DIR}/go.mod" "${TIDY_STATE_DIR}/go.mod")
-DIFF_SUM=$(diff -u "${ORIGINAL_STATE_DIR}/go.sum" "${TIDY_STATE_DIR}/go.sum")
-
-if [[ -n "${DIFF_MOD}" || -n "${DIFF_SUM}" ]]; then
-    echo "go.mod diff:"
-    echo "${DIFF_MOD}"
-    echo "go.sum diff:"
-    echo "${DIFF_SUM}"
-    echo ""
-    printf "FAILED! go.mod and/or go.sum are NOT tidy; please run 'go mod tidy'.\n\n"
-    exit 1
-fi

.github/scripts/json-schema-drift-check.sh

@@ -1,17 +0,0 @@
-#!/usr/bin/env bash
-set -u
-
-if [ "$(git status --porcelain | wc -l)" -ne "0" ]; then
-  echo "  🔴 there are uncommitted changes, please commit them before running this check"
-  exit 1
-fi
-
-if ! make generate-json-schema; then
-  echo "Generating json schema failed"
-  exit 1
-fi
-
-if [ "$(git status --porcelain | wc -l)" -ne "0" ]; then
-  echo "  🔴 there are uncommitted changes, please commit them before running this check"
-  exit 1
-fi

.github/scripts/labeler.py

@@ -1,232 +0,0 @@
-from __future__ import annotations
-
-import sys
-import glob
-import subprocess
-import os
-import re
-
-DRY_RUN = False
-
-JSON_SCHEMA_LABEL = "json-schema"
-
-# note: we can't use "breaking-change" as the label since that might be applied manually by a user. This is a
-# distinct label that we can use to indicate that the label was applied (or removed) by automation.
-BREAKING_CHANGE_LABEL = "detected-breaking-change"
-
-
-def main(changed_files: str | None = None, merge_base_schema_files: str | None = None):
-    global DRY_RUN
-
-    pr_number = os.environ.get("GITHUB_PR_NUMBER")
-    comment_file_path = os.environ.get("CI_COMMENT_FILE")
-
-    if not comment_file_path:
-        print("CI_COMMENT_FILE not set")
-        sys.exit(1)
-
-    if not pr_number:
-        DRY_RUN = True
-
-    if changed_files:
-        DRY_RUN = True
-
-        # read lines from file... this is useful for local testing
-        with open(changed_files) as f:
-            pr_changed_files = f.read().splitlines()
-
-        with open(merge_base_schema_files) as f:
-            og_json_schema_files = sort_json_schema_files(f.read().splitlines())
-
-    else:
-        if not is_ci():
-            print("Not in CI")
-            sys.exit(1)
-
-        if not pr_number:
-            print("Not a PR")
-            sys.exit(1)
-
-        pr_changed_files = get_pr_changed_files(pr_number)
-        # since we are running this in the context of the pull_request_target, the checkout is the merge base..
-        # that is the main branch of the original repo, NOT the branch in the forked repo (or branch in the target 
-        # repo for non-forked PRs). This means we just need to list the current checkedout files to get a sense of
-        # the changes before a merge.
-        og_json_schema_files = list_json_schema_files()
-
-    pr_json_schema_files = filter_to_schema_files(pr_changed_files)
-
-    # print("schema files in pr:   ", summarize_schema_files(pr_json_schema_files))
-    # print("og schema files:      ", summarize_schema_files(og_json_schema_files))
-
-    if not og_json_schema_files:
-        print("No schema files found in merge base")
-        sys.exit(1)
-
-    # pr_json_schema_files = set of PR files are added, removed, and changed files
-    new_schema_files = set(pr_json_schema_files) - set(og_json_schema_files)
-    removed_or_modified_schema_files = set(pr_json_schema_files) - set(new_schema_files)
-
-    print("new schemas:                ", summarize_schema_files(new_schema_files))
-    print("removed or modified schemas:", summarize_schema_files(removed_or_modified_schema_files))
-
-    # if there is a new or modified schema, we should add the "json-schema" label to the PR...
-    if new_schema_files or removed_or_modified_schema_files:
-        print("\nAdding json-schema label...")
-        add_label(pr_number, JSON_SCHEMA_LABEL)
-
-    else:
-        remove_label(pr_number, JSON_SCHEMA_LABEL)
-
-    # new schema files should be scrutinized, comparing the latest and added versions to see if it's a breaking
-    # change (major version bump). Warn about it on the PR via adding a breaking-change label...
-    if is_breaking_change(new_schema_files, og_json_schema_files[-1]):
-        print("\nBreaking change detected...")
-        add_label(pr_number, BREAKING_CHANGE_LABEL)
-    else:
-        remove_label(pr_number, BREAKING_CHANGE_LABEL)
-
-    # modifying an existing schema could be a breaking change, we should warn about it on the PR via a comment...
-    # removing schema files should never be allowed, we should warn about it on the PR via a comment...
-    if removed_or_modified_schema_files:
-        print("\nRemoved or modified schema detected...")
-        schemas = sort_json_schema_files(list(removed_or_modified_schema_files))
-        schemas_str = "\n".join([f" - {schema}" for schema in schemas])
-        add_comment(comment_file_path, f"Detected modification or removal of existing json schemas:\n{schemas_str}", warning=True)
-
-
-def add_comment(comment_file_path: str, comment: str, warning: bool = False, important: bool = False):
-    if warning or important:
-        comment_lines = comment.splitlines()
-        comment = "\n".join([f"> {line}" for line in comment_lines])
-
-    if warning:
-        comment = f"> [!WARNING]\n{comment}"    
-    elif important:
-        comment = f"> [!IMPORTANT]\n{comment}"
-
-    # create any parent directories if they don't exist
-    os.makedirs(os.path.dirname(comment_file_path), exist_ok=True)
-
-    with open(comment_file_path, "w") as f:
-        f.write(comment)
-
-    print(f"Comment file contents: {comment_file_path}")
-    print(comment)
-
-
-def add_label(pr_number: str, label: str):
-    # run "gh pr edit --add-label <label>"
-    result = run(f"gh pr edit {pr_number} --add-label {label}", shell=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
-    if result.returncode != 0:
-        print(f"Unable to add  {label!r} label to PR with")
-        print(str(result.stderr))
-        sys.exit(1)
-
-
-def remove_label(pr_number: str, label: str):
-    # run "gh pr edit --remove-label <label>"
-    result = run(f"gh pr edit {pr_number} --remove-label {label}", shell=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
-    if result.returncode != 0:
-        print(f"Unable to label PR with {label!r}")
-        print(str(result.stderr))
-        sys.exit(1)
-
-
-def major_version(semver: str) -> int:
-    return int(semver.split(".")[0])
-
-
-def is_breaking_change(new_schema_files: set[str], latest_schema_file: str) -> bool:
-    latest_major_version = major_version(get_semver(latest_schema_file))
-    for file in new_schema_files:
-        change_major_version = major_version(get_semver(file))
-        if change_major_version > latest_major_version:
-            return True
-    return False
-
-
-def summarize_schema_files(files: list[str]) -> list[str]:
-    return [get_semver(file) for file in files]
-
-
-def is_ci() -> bool:
-    return "CI" in os.environ
-
-
-def get_pr_changed_files(pr_number: str) -> list[str]:
-    result = run(f"gh pr view {pr_number} --json files --jq '.files.[].path'", shell=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE, text=True)
-    if result.returncode != 0:
-        print("Unable to get list of changed files in PR")
-        print(str(result.stderr))
-        sys.exit(1)
-    
-    list_of_files = result.stdout.splitlines()
-    return list_of_files
-
-
-def filter_to_schema_files(list_of_files: list[str]) -> list[str]:
-    # get files matching "schema/json/schema-*.json"
-    files = []
-    for file in list_of_files:
-        if re.match(r"^schema/json/schema-\d+\.\d+\.\d+\.json$", file):
-            files.append(file)
-    return sort_json_schema_files(files)
-
-
-def list_json_schema_files() -> list[str]:
-    # list files in "schema/json" directory matching the pattern of "schema-*.json"
-    # special case: always ignore the "latest" schema file
-    return sort_json_schema_files([f for f in glob.glob("schema/json/schema-*.json") if "latest" not in f])
-
-
-def run(command: str,  **kwargs) -> subprocess.CompletedProcess:
-    if DRY_RUN:
-        print(f"[DRY RUN] {command}")
-        return subprocess.CompletedProcess(args=[command], returncode=0)
-    print(f"[RUN] {command}")
-    return subprocess.run(command, **kwargs)
-
-
-def get_semver(input_file: str) -> str:
-    return input_file.split("-")[1].split(".json")[0]
-
-
-def sort_json_schema_files(files: list[str]) -> list[str]:
-    # sort files by schema version, where the input looks like "schema/json/schema-1.12.1.json"
-    # we should sort by the semantic version embedded within the basename, not the string
-    # so that "schema/json/schema-1.2.1.json" comes before "schema/json/schema-1.12.1.json".
-    versions = [get_semver(file) for file in files if file]
-    
-    versions = sorted(versions, key=lambda s: [int(u) for u in s.split('.') if "." in s])
-
-    return [f"schema/json/schema-{version}.json" for version in versions]
-
-
-# allow for test files that have line-by-line list of files:
-
-# .binny.yaml
-# .github/actions/bootstrap/action.yaml
-# .github/scripts/goreleaser-install.sh
-# .github/workflows/release.yaml
-# .github/workflows/update-bootstrap-tools.yml
-# .github/workflows/update-cpe-dictionary-index.yml
-# .github/workflows/update-stereoscope-release.yml
-# .github/workflows/validations.yaml
-# .gitignore
-# .goreleaser.yaml
-# Makefile
-# Taskfile.yaml
-# schema/cyclonedx/Makefile
-
-if __name__ == "__main__":
-    # these are variables for a single file name that contains a list of files (line separated)
-    changed_files = None
-    merge_base_schema_files = None
-
-    if len(sys.argv) > 2:
-        changed_files = sys.argv[1]
-        merge_base_schema_files = sys.argv[2]
-
-    main(changed_files, merge_base_schema_files)
-

.github/scripts/labeler_test.py

@@ -1,70 +0,0 @@
-import unittest
-from unittest.mock import patch
-import subprocess
-
-import labeler
-
-class Labeler(unittest.TestCase):
-
-    def test_major_version(self):
-        self.assertEqual(labeler.major_version("1.2.3"), 1)
-        self.assertEqual(labeler.major_version("2.0.0"), 2)
-
-    def test_is_breaking_change(self):
-        new_schema_files = ["schema/json/schema-2.0.0.json"]
-        latest_schema_file = "schema/json/schema-1.2.0.json"
-        self.assertTrue(labeler.is_breaking_change(new_schema_files, latest_schema_file))
-
-        new_schema_files = ["schema/json/schema-1.3.0.json"]
-        latest_schema_file = "schema/json/schema-1.2.0.json"
-        self.assertFalse(labeler.is_breaking_change(new_schema_files, latest_schema_file))
-
-    def test_summarize_schema_files(self):
-        files = ["schema/json/schema-1.0.0.json", "schema/json/schema-2.0.0.json"]
-        expected = ["1.0.0", "2.0.0"]
-        self.assertEqual(labeler.summarize_schema_files(files), expected)
-
-    def test_is_ci(self):
-        # Mock os.environ to simulate CI environment
-        with patch.dict("os.environ", {"CI": "true"}):
-            self.assertTrue(labeler.is_ci())
-
-    def test_get_pr_changed_files(self):
-        expected_command = "gh pr view 123 --json files --jq '.files.[].path'"
-        expected_output = "file1.json\nfile2.json\n"
-
-        subprocess.CompletedProcess.returncode = 0
-        subprocess.CompletedProcess.stdout = expected_output
-        with patch("labeler.run", return_value=subprocess.CompletedProcess) as mock_run:
-            result = labeler.get_pr_changed_files("123")
-            mock_run.assert_called_with(expected_command, shell=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE, text=True)
-            self.assertEqual(result, ["file1.json", "file2.json"])
-
-    def test_filter_to_schema_files(self):
-        input_files = ["schema/json/schema-1.0.0.json", "not_schema.txt", "schema/json/schema-2.0.0.json"]
-        expected_files = ["schema/json/schema-1.0.0.json", "schema/json/schema-2.0.0.json"]
-        self.assertEqual(labeler.filter_to_schema_files(input_files), expected_files)
-
-        # we should be strict about what files are allowed to be processed
-        input_files = ["schema/json/schema-1.0.0extracontent.json", "schema/json/schema-1.0.0.md", "schema/json/schema-1.0.0.json.extracontent"]
-        expected_files = []
-        self.assertEqual(labeler.filter_to_schema_files(input_files), expected_files)
-
-    def test_get_semver(self):
-        input_file = "schema/json/schema-1.0.0.json"
-        expected_semver = "1.0.0"
-        self.assertEqual(labeler.get_semver(input_file), expected_semver)
-
-    def test_sort_json_schema_files(self):
-        files = ["schema/json/schema-1.12.1.json", "schema/json/schema-1.2.1.json"]
-        expected_sorted_files = ["schema/json/schema-1.2.1.json", "schema/json/schema-1.12.1.json"]
-        self.assertEqual(labeler.sort_json_schema_files(files), expected_sorted_files)
-
-        # ensure that "latest" doesn't cause a problem and is ultimately ignored
-        files = ["schema/json/schema-1.12.1.json", "schema/json/schema-_bogus.json"]
-        expected_sorted_files = ["schema/json/schema-_bogus.json", "schema/json/schema-1.12.1.json"]
-        self.assertEqual(labeler.sort_json_schema_files(files), expected_sorted_files)
-
-
-if __name__ == "__main__":
-    unittest.main()

.github/scripts/trigger-release.sh

@@ -1,50 +0,0 @@
-#!/usr/bin/env bash
-set -eu
-
-bold=$(tput bold)
-normal=$(tput sgr0)
-
-if ! [ -x "$(command -v gh)" ]; then
-    echo "The GitHub CLI could not be found. To continue follow the instructions at https://github.com/cli/cli#installation"
-    exit 1
-fi
-
-gh auth status
-
-# we need all of the git state to determine the next version. Since tagging is done by
-# the release pipeline it is possible to not have all of the tags from previous releases.
-git fetch --tags
-
-# populates the CHANGELOG.md and VERSION files
-echo "${bold}Generating changelog...${normal}"
-make changelog 2> /dev/null
-
-NEXT_VERSION=$(cat VERSION)
-
-if [[ "$NEXT_VERSION" == "" ||  "${NEXT_VERSION}" == "(Unreleased)" ]]; then
-    echo "Could not determine the next version to release. Exiting..."
-    exit 1
-fi
-
-while true; do
-    read -p "${bold}Do you want to trigger a release for version '${NEXT_VERSION}'?${normal} [y/n] " yn
-    case $yn in
-        [Yy]* ) echo; break;;
-        [Nn]* ) echo; echo "Cancelling release..."; exit;;
-        * ) echo "Please answer yes or no.";;
-    esac
-done
-
-echo "${bold}Kicking off release for ${NEXT_VERSION}${normal}..."
-echo
-gh workflow run release.yaml -f version=${NEXT_VERSION}
-
-echo
-echo "${bold}Waiting for release to start...${normal}"
-sleep 10
-
-set +e
-
-echo "${bold}Head to the release workflow to monitor the release:${normal} $(gh run list --workflow=release.yaml --limit=1 --json url --jq '.[].url')"
-id=$(gh run list --workflow=release.yaml --limit=1 --json databaseId --jq '.[].databaseId')
-gh run watch $id --exit-status || (echo ; echo "${bold}Logs of failed step:${normal}" && GH_PAGER="" gh run view $id --log-failed)

.github/scripts/update-version-file.sh

@@ -15,9 +15,14 @@ fi
 echo "creating and publishing version file"
 
 # create a version file for version-update checks
-VERSION_FILE="${DISTDIR}/VERSION"
-echo "${VERSION}" | tee "${VERSION_FILE}"
+echo "${VERSION}" | tee ${DISTDIR}/VERSION
 
 # upload the version file that supports the application version update check
-export AWS_DEFAULT_REGION=us-west-2
-aws s3 cp "${VERSION_FILE}" s3://toolbox-data.anchore.io/${BIN}/releases/latest/VERSION
+docker run --rm \
+    -i \
+    -e AWS_DEFAULT_REGION=us-west-2 \
+    -e AWS_ACCESS_KEY_ID=${AWS_ACCESS_KEY_ID} \
+    -e AWS_SECRET_ACCESS_KEY=${AWS_SECRET_ACCESS_KEY} \
+    -v $(pwd)/${DISTDIR}/:/distmount \
+    amazon/aws-cli \
+        s3 cp /distmount/VERSION s3://toolbox-data.anchore.io/${BIN}/releases/latest/VERSION

.github/scripts/verify-signature.sh

@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+set -ue
+
+DISTDIR=$1
+
+export FINGERPRINT=$(gpg --verify ${DISTDIR}/*checksums.txt.sig ${DISTDIR}/*checksums.txt 2>&1 | grep 'using RSA key' | awk '{ print $NF }')
+
+if [[ "${FINGERPRINT}" == "${SIGNING_FINGERPRINT}" ]]; then
+    echo 'verified signature'
+else
+    echo "signed with unknown fingerprint: ${FINGERPRINT}"
+    echo "           expected fingerprint: ${SIGNING_FINGERPRINT}"
+    exit 1
+fi

.github/workflows/acceptance-test.yaml

@@ -0,0 +1,123 @@
+name: 'Acceptance'
+on:
+  workflow_dispatch:
+  push:
+    # ... only act on pushes to main
+    branches:
+      - main
+    # ... do not act on release tags
+    tags-ignore:
+      - v*
+
+env:
+  GO_VERSION: "1.14.x"
+
+jobs:
+  Build-Snapshot-Artifacts:
+    runs-on: ubuntu-latest
+    steps:
+
+      - uses: actions/setup-go@v2
+        with:
+          go-version: ${{ env.GO_VERSION }}
+
+      - uses: actions/checkout@v2
+
+      - name: Restore bootstrap cache
+        id: cache
+        uses: actions/cache@v2
+        with:
+          path: |
+            ~/go/pkg/mod
+            ${{ github.workspace }}/.tmp
+          key: ${{ runner.os }}-go-${{ env.GO_VERSION }}-${{ hashFiles('**/go.sum') }}-${{ hashFiles('Makefile') }}
+          restore-keys: |
+            ${{ runner.os }}-go-${{ env.GO_VERSION }}-${{ hashFiles('**/go.sum') }}-
+            ${{ runner.os }}-go-${{ env.GO_VERSION }}-
+
+      - name: Bootstrap dependencies
+        if: steps.cache.outputs.cache-hit != 'true'
+        run: make ci-bootstrap
+
+      - name: Import GPG key
+        id: import_gpg
+        uses: crazy-max/ghaction-import-gpg@v2
+        env:
+          GPG_PRIVATE_KEY: ${{ secrets.SIGNING_GPG_PRIVATE_KEY }}
+          PASSPHRASE: ${{ secrets.SIGNING_GPG_PASSPHRASE }}
+
+      - name: GPG signing info
+        run: |
+          echo "fingerprint: ${{ steps.import_gpg.outputs.fingerprint }}"
+          echo "keyid:       ${{ steps.import_gpg.outputs.keyid }}"
+          echo "name:        ${{ steps.import_gpg.outputs.name }}"
+          echo "email:       ${{ steps.import_gpg.outputs.email }}"
+
+      - name: Build snapshot artifacts
+        run: make snapshot
+        env:
+          GPG_PRIVATE_KEY: ${{ secrets.SIGNING_GPG_PRIVATE_KEY }}
+          PASSPHRASE: ${{ secrets.SIGNING_GPG_PASSPHRASE }}
+
+      - uses: actions/upload-artifact@v2
+        with:
+          name: artifacts
+          path: snapshot/**/*
+
+  # Note: changing this job name requires making the same update in the .github/workflows/release.yaml pipeline
+  Acceptance-Linux:
+    needs: [ Build-Snapshot-Artifacts ]
+    runs-on: ubuntu-latest
+    steps:
+
+      - uses: actions/checkout@v2
+
+      - uses: actions/download-artifact@v2
+        with:
+          name: artifacts
+          path: snapshot
+
+      - name: Run Acceptance Tests (Linux)
+        run: make acceptance-linux
+
+  # Note: changing this job name requires making the same update in the .github/workflows/release.yaml pipeline
+  Acceptance-Mac:
+    needs: [ Build-Snapshot-Artifacts ]
+    runs-on: macos-latest
+    steps:
+
+      - uses: actions/checkout@v2
+
+      - uses: actions/download-artifact@v2
+        with:
+          name: artifacts
+          path: snapshot
+
+      - name: Run Acceptance Tests (Mac)
+        run: make acceptance-mac
+
+  # Note: changing this job name requires making the same update in the .github/workflows/release.yaml pipeline
+  Inline-Compare:
+    needs: [ Build-Snapshot-Artifacts ]
+    runs-on: ubuntu-latest
+    steps:
+
+      - uses: actions/checkout@v2
+
+      - name: Fingerprint inline-compare sources
+        run: make compare-fingerprint
+
+      - name: Restore inline reports cache
+        id: cache
+        uses: actions/cache@v2
+        with:
+          path: ${{ github.workspace }}/test/inline-compare/inline-reports
+          key: inline-reports-${{ hashFiles('**/inline-compare.fingerprint') }}
+
+      - uses: actions/download-artifact@v2
+        with:
+          name: artifacts
+          path: snapshot
+
+      - name: Compare Anchore inline-scan results against snapshot build output
+        run: make compare-snapshot

.github/workflows/benchmark-testing.yaml

@@ -1,62 +0,0 @@
-name: "Benchmark testing"
-
-on:
-  workflow_dispatch:
-  pull_request:
-
-permissions:
-  contents: read
-
-jobs:
-
-  Benchmark-Test:
-    name: "Benchmark tests"
-    runs-on: ubuntu-20.04
-    # note: we want benchmarks to run on pull_request events in order to publish results to a sticky comment, and
-    # we also want to run on push such that merges to main are recorded to the cache. For this reason we don't filter
-    # the job by event.
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@9bb56186c3b09b4f86b1c65136769dd318469633 # v4.1.2
-
-      - name: Bootstrap environment
-        uses: ./.github/actions/bootstrap
-
-      - name: Restore base benchmark result
-        uses: actions/cache@ab5e6d0c87105b4c9c2047343972218f562e4319 #v4.0.1
-        with:
-          path: test/results/benchmark-main.txt
-          # use base sha for PR or new commit hash for main push in benchmark result key
-          key: ${{ runner.os }}-bench-${{ (github.event.pull_request.base.sha != github.event.after) && github.event.pull_request.base.sha || github.event.after }}
-
-      - name: Run benchmark tests
-        id: benchmark
-        run: |
-          REF_NAME=${GITHUB_REF##*/} make benchmark
-          OUTPUT=$(make show-benchstat)
-          OUTPUT="${OUTPUT//'%'/'%25'}"   # URL encode all '%' characters
-          OUTPUT="${OUTPUT//$'\n'/'%0A'}" # URL encode all '\n' characters
-          OUTPUT="${OUTPUT//$'\r'/'%0D'}" # URL encode all '\r' characters
-          echo "result=$OUTPUT" >> $GITHUB_OUTPUT
-
-      - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1
-        with:
-          name: benchmark-test-results
-          path: test/results/**/*
-
-      - name: Update PR benchmark results comment
-        uses: marocchino/sticky-pull-request-comment@331f8f5b4215f0445d3c07b4967662a32a2d3e31 #v2.9.0
-        continue-on-error: true
-        with:
-          header: benchmark
-          message: |
-            ### Benchmark Test Results
-
-            <details>
-              <summary>Benchmark results from the latest changes vs base branch</summary>
-
-            ```
-            ${{ steps.benchmark.outputs.result }}
-            ```
-
-            </details>

.github/workflows/codeql-analysis.yml

@@ -1,73 +0,0 @@
-# For most projects, this workflow file will not need changing; you simply need
-# to commit it to your repository.
-#
-# You may wish to alter this file to override the set of languages analyzed,
-# or to provide custom queries or build logic.
-name: "CodeQL Security Scan"
-
-on:
-  push:
-    branches:
-      # only run when there are pushes to the main branch (not on PRs)
-      - main
-
-  schedule:
-    - cron: '0 0 * * 3'
-
-permissions:
-  contents: read
-
-jobs:
-  analyze:
-    name: Analyze
-    runs-on: ubuntu-22.04-4core-16gb
-
-    permissions:
-      security-events: write
-
-    strategy:
-      fail-fast: false
-      matrix:
-        # Override automatic language detection by changing the below list
-        # Supported options are ['csharp', 'cpp', 'go', 'java', 'javascript', 'python']
-        language: ['go', 'python']
-        # Learn more...
-        # https://docs.github.com/en/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#overriding-automatic-language-detection
-
-    steps:
-    - name: Checkout repository
-      uses: actions/checkout@9bb56186c3b09b4f86b1c65136769dd318469633 #v4.1.2
-
-    - name: Install Go
-      uses: actions/setup-go@0c52d547c9bc32b1aa3301fd7a9cb496313a4491 #v5.0.0
-      with:
-        go-version-file: go.mod
-
-    # Initializes the CodeQL tools for scanning.
-    - name: Initialize CodeQL
-      uses: github/codeql-action/init@8a470fddafa5cbb6266ee11b37ef4d8aae19c571 #v3.24.6
-      with:
-        languages: ${{ matrix.language }}
-        # If you wish to specify custom queries, you can do so here or in a config file.
-        # By default, queries listed here will override any specified in a config file. 
-        # Prefix the list here with "+" to use these queries and those in the config file.
-        # queries: ./path/to/local/query, your-org/your-repo/queries@main
-
-    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
-    # If this step fails, then you should remove it and run the build manually (see below)
-    - name: Autobuild
-      uses: github/codeql-action/autobuild@8a470fddafa5cbb6266ee11b37ef4d8aae19c571 #v3.24.6
-
-    # ℹ️ Command-line programs to run using the OS shell.
-    # 📚 https://git.io/JvXDl
-
-    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
-    #    and modify them (or add more) to build your code if your project
-    #    uses a compiled language
-
-    #- run: |
-    #   make bootstrap
-    #   make release
-
-    - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@8a470fddafa5cbb6266ee11b37ef4d8aae19c571 #v3.24.6

.github/workflows/dependabot-automation.yaml

@@ -1,10 +0,0 @@
-name: Dependabot Automation
-on:
-  pull_request:
-
-permissions:
-  pull-requests: write
-
-jobs:
-  run:
-    uses: anchore/workflows/.github/workflows/dependabot-automation.yaml@main

.github/workflows/detect-schema-changes.yaml

@@ -1,54 +0,0 @@
-name: "Detect schema changes"
-
-on:
-  # IMPORTANT! This workflow is triggered by the `pull_request_target` event
-  # which means that forked PRs will run with access secrets from the repo
-  # it's forked from (the "target" repo).
-  #
-  # For this reason we only NEVER checkout the code from the pull request
-  # (e.g. "ref: ${{ github.event.pull_request.head.sha }}") to prevent
-  # accidentally running potentially untrusted code.
-  #
-  # By default the checkout will be:
-  #   - GITHUB_SHA: Last commit on the PR base branch
-  #   - GITHUB_REF: PR base branch
-  #
-  # ...unlike a typical PR where:
-  #   - GITHUB_SHA: Last merge commit on the GITHUB_REF branch
-  #   - GITHUB_REF: PR merge branch refs/pull/:prNumber/merge
-  pull_request_target:
-
-env:
-  # note: this is used within hashFiles() so must be within the GITHUB_WORKSPACE path (or will silently fail)
-  CI_COMMENT_FILE: .tmp/labeler-comment.txt
-  # needs to be any string to uniquely identify the comment on a PR across multiple runs
-  COMMENT_HEADER: "label-commentary"
-
-jobs:
-  label:
-    name: "Label changes"
-    runs-on: ubuntu-22.04
-    steps:
-
-      - uses: actions/checkout@9bb56186c3b09b4f86b1c65136769dd318469633 #v4.1.2
-
-      - run: python .github/scripts/labeler.py
-        env:
-          # note: this token has write access to the repo
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          GITHUB_PR_NUMBER: ${{ github.event.number }}
-
-      - name: Delete existing comment
-        if: ${{ hashFiles( env.CI_COMMENT_FILE ) == '' }}
-        uses: marocchino/sticky-pull-request-comment@331f8f5b4215f0445d3c07b4967662a32a2d3e31 #v2.9.0
-        with:
-          header: ${{ env.COMMENT_HEADER }}
-          hide: true
-          hide_classify: "OUTDATED"
-
-      - name: Add comment
-        if: ${{ hashFiles( env.CI_COMMENT_FILE ) != '' }}
-        uses: marocchino/sticky-pull-request-comment@331f8f5b4215f0445d3c07b4967662a32a2d3e31 #v2.9.0
-        with:
-          header: ${{ env.COMMENT_HEADER }}
-          path: ${{ env.CI_COMMENT_FILE }}

.github/workflows/oss-project-board-add.yaml

@@ -1,18 +0,0 @@
-name: Add to OSS board
-
-permissions:
-  contents: read
-
-on:
-  issues:
-    types:
-      - opened
-      - reopened
-      - transferred
-      - labeled
-
-jobs:
-  run:
-    uses: "anchore/workflows/.github/workflows/oss-project-board-add.yaml@main"
-    secrets:
-      token: ${{ secrets.OSS_PROJECT_GH_TOKEN }}

.github/workflows/release-homebrew.yaml

@@ -1,48 +0,0 @@
-name: "Release Homebrew"
-
-on:
-  workflow_dispatch:
-  release:
-    types:
-      - released
-
-jobs:
-  homebrew:
-    runs-on: ubuntu-20.04
-    steps:
-
-      - uses: actions/checkout@9bb56186c3b09b4f86b1c65136769dd318469633 #v4.1.2
-        with:
-          # we need to be able to get the commit for a tag
-          fetch-depth: 0
-
-      - name: Get release info
-        id: release_info
-        run: |
-          echo -n "tag_name=$(gh release view --json tagName --jq '.tagName')" | tee -a $GITHUB_OUTPUT
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
-      - name: Get commit info
-        id: git_info
-        run: |
-          git checkout ${{ steps.release_info.outputs.tag_name }}
-          echo -n "commit=$(git rev-parse HEAD)" | tee -a $GITHUB_OUTPUT
-
-      - name: Update Homebrew formula
-        uses: dawidd6/action-homebrew-bump-formula@baf2b60c51fc1f8453c884b0c61052668a71bd1d # v3.11.0
-        with:
-          token: ${{ secrets.HOMEBREW_TOKEN }}
-          org: anchore
-          formula: syft
-          tag: ${{ steps.release_info.outputs.tag_name }}
-          revision: ${{ steps.git_info.outputs.commit }}
-
-      - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 #v3.16.2
-        if: ${{ failure() }}
-        with:
-          status: ${{ job.status }}
-          fields: repo,workflow,action,eventName
-          text: "Post-release homebrew publish workflow has failed: https://github.com/anchore/syft/actions/workflows/release-homebrew.yaml"
-        env:
-          SLACK_WEBHOOK_URL: ${{ secrets.SLACK_TOOLBOX_WEBHOOK_URL }}

.github/workflows/release.yaml

@@ -1,159 +1,129 @@
-name: "Release"
-
-permissions:
-  contents: read
-
+name: 'Release'
 on:
-  workflow_dispatch:
-    inputs:
-      version:
-        description: tag the latest commit on main with the given version (prefixed with v)
-        required: true
+  push:
+    # take no actions on push to any branch...
+    branches-ignore:
+      - '**'
+    # ... only act on release tags
+    tags:
+      - 'v*'
+
+env:
+  GO_VERSION: "1.14.x"
 
 jobs:
-  quality-gate:
-    environment: release
-    runs-on: ubuntu-20.04
+  wait-for-checks:
+    runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@9bb56186c3b09b4f86b1c65136769dd318469633 #v4.1.2
 
-      - name: Check if tag already exists
-        # note: this will fail if the tag already exists
+      - uses: actions/checkout@v2
+
+      # we don't want to release commits that have been pushed and tagged, but not necessarily merged onto main
+      - name: Ensure tagged commit is on main
         run: |
-          [[ "${{ github.event.inputs.version }}" == v* ]] || (echo "version '${{ github.event.inputs.version }}' does not have a 'v' prefix" && exit 1)
-          git tag ${{ github.event.inputs.version }}
+          echo "Tag: ${GITHUB_REF##*/}"
+          git fetch origin main
+          git merge-base --is-ancestor ${GITHUB_REF##*/} origin/main && echo "${GITHUB_REF##*/} is a commit on main!"
 
-      - name: Check static analysis results
-        uses: fountainhead/action-wait-for-check@297be350cf8393728ea4d4b39435c7d7ae167c93 # v1.1.0
-        id: static-analysis
+      - name: Check static anaylysis, unit, and integration test results
+        uses: fountainhead/action-wait-for-check@v1.0.0
+        id: sa-unit-int
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
-          # This check name is defined as the github action job name (in .github/workflows/testing.yaml)
-          checkName: "Static analysis"
-          ref: ${{ github.event.pull_request.head.sha || github.sha }}
-
-      - name: Check unit test results
-        uses: fountainhead/action-wait-for-check@297be350cf8393728ea4d4b39435c7d7ae167c93 # v1.1.0
-        id: unit
-        with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-          # This check name is defined as the github action job name (in .github/workflows/testing.yaml)
-          checkName: "Unit tests"
-          ref: ${{ github.event.pull_request.head.sha || github.sha }}
-
-      - name: Check integration test results
-        uses: fountainhead/action-wait-for-check@297be350cf8393728ea4d4b39435c7d7ae167c93 # v1.1.0
-        id: integration
-        with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-          # This check name is defined as the github action job name (in .github/workflows/testing.yaml)
-          checkName: "Integration tests"
+          # This check name is defined as the circle-ci workflow name (in .circleci/config.yaml)
+          checkName: "Static Analysis + Unit + Integration"
           ref: ${{ github.event.pull_request.head.sha || github.sha }}
 
       - name: Check acceptance test results (linux)
-        uses: fountainhead/action-wait-for-check@297be350cf8393728ea4d4b39435c7d7ae167c93 # v1.1.0
+        uses: fountainhead/action-wait-for-check@v1.0.0
         id: acceptance-linux
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
-          # This check name is defined as the github action job name (in .github/workflows/testing.yaml)
-          checkName: "Acceptance tests (Linux)"
+          # This check name is defined as the github action job name (in .github/workflows/acceptance-test.yaml)
+          checkName: "Acceptance-Linux"
           ref: ${{ github.event.pull_request.head.sha || github.sha }}
 
       - name: Check acceptance test results (mac)
-        uses: fountainhead/action-wait-for-check@297be350cf8393728ea4d4b39435c7d7ae167c93 # v1.1.0
+        uses: fountainhead/action-wait-for-check@v1.0.0
         id: acceptance-mac
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
-          # This check name is defined as the github action job name (in .github/workflows/testing.yaml)
-          checkName: "Acceptance tests (Mac)"
+          # This check name is defined as the github action job name (in .github/workflows/acceptance-test.yaml)
+          checkName: "Acceptance-Mac"
           ref: ${{ github.event.pull_request.head.sha || github.sha }}
 
-      - name: Check cli test results (linux)
-        uses: fountainhead/action-wait-for-check@297be350cf8393728ea4d4b39435c7d7ae167c93 # v1.1.0
-        id: cli-linux
+      - name: Check inline comparison test results
+        uses: fountainhead/action-wait-for-check@v1.0.0
+        id: inline-compare
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
-          # This check name is defined as the github action job name (in .github/workflows/testing.yaml)
-          checkName: "CLI tests (Linux)"
+          # This check name is defined as the github action job name (in .github/workflows/acceptance-test.yaml)
+          checkName: "Inline-Compare"
           ref: ${{ github.event.pull_request.head.sha || github.sha }}
 
       - name: Quality gate
-        if: steps.static-analysis.outputs.conclusion != 'success' || steps.unit.outputs.conclusion != 'success' || steps.integration.outputs.conclusion != 'success' || steps.cli-linux.outputs.conclusion != 'success' || steps.acceptance-linux.outputs.conclusion != 'success' || steps.acceptance-mac.outputs.conclusion != 'success'
+        if: steps.sa-unit-int.outputs.conclusion != 'success' || steps.inline-compare.outputs.conclusion != 'success' || steps.acceptance-linux.outputs.conclusion != 'success' || steps.acceptance-mac.outputs.conclusion != 'success'
         run: |
-          echo "Static Analysis Status: ${{ steps.static-analysis.conclusion }}"
-          echo "Unit Test Status: ${{ steps.unit.outputs.conclusion }}"
-          echo "Integration Test Status: ${{ steps.integration.outputs.conclusion }}"
+          echo "Static/Unit/Integration Status: ${{ steps.sa-unit-int.outputs.conclusion }}"
           echo "Acceptance Test (Linux) Status: ${{ steps.acceptance-linux.outputs.conclusion }}"
           echo "Acceptance Test (Mac) Status: ${{ steps.acceptance-mac.outputs.conclusion }}"
-          echo "CLI Test (Linux) Status: ${{ steps.cli-linux.outputs.conclusion }}"
+          echo "Inline Compare Status: ${{ steps.inline-compare.outputs.conclusion }}"
           false
 
   release:
-    needs: [quality-gate]
-    runs-on: ubuntu-20.04
-    permissions:
-      contents: write
-      packages: write
-      # required for goreleaser signs section with cosign
-      id-token: write
+    needs: [ wait-for-checks ]
+    runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@9bb56186c3b09b4f86b1c65136769dd318469633 #v4.1.2
+
+      - uses: actions/setup-go@v2
+        with:
+          go-version: ${{ env.GO_VERSION }}
+
+      - uses: actions/checkout@v2
         with:
           fetch-depth: 0
 
-      - name: Bootstrap environment
-        uses: ./.github/actions/bootstrap
-
-      - name: Login to Docker Hub
-        uses: docker/login-action@343f7c4344506bcbf9b4de18042ae17996df046d  #v3.0.0
+      - name: Restore bootstrap cache
+        id: cache
+        uses: actions/cache@v2
         with:
-          username: ${{ secrets.TOOLBOX_DOCKER_USER }}
-          password: ${{ secrets.TOOLBOX_DOCKER_PASS }}
+          path: |
+            ~/go/pkg/mod
+            ${{ github.workspace }}/.tmp
+          key: ${{ runner.os }}-go-${{ env.GO_VERSION }}-${{ hashFiles('**/go.sum') }}-${{ hashFiles('Makefile') }}
+          restore-keys: |
+            ${{ runner.os }}-go-${{ env.GO_VERSION }}-${{ hashFiles('**/go.sum') }}-
+            ${{ runner.os }}-go-${{ env.GO_VERSION }}-
 
-      - name: Login to GitHub Container Registry
-        uses: docker/login-action@343f7c4344506bcbf9b4de18042ae17996df046d  #v3.0.0
-        with:
-          registry: ghcr.io
-          username: ${{ github.actor }}
-          password: ${{ secrets.GITHUB_TOKEN }}
+      - name: Bootstrap dependencies
+        if: steps.cache.outputs.cache-hit != 'true'
+        run: make ci-bootstrap
 
-      - name: Tag release
-        run: |
-          git config --global user.name "anchoreci"
-          git config --global user.email "anchoreci@users.noreply.github.com"
-          git tag -a ${{ github.event.inputs.version }} -m "Release ${{ github.event.inputs.version }}"
-          git push origin --tags
+      - name: Import GPG key
+        id: import_gpg
+        uses: crazy-max/ghaction-import-gpg@v2
         env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GPG_PRIVATE_KEY: ${{ secrets.SIGNING_GPG_PRIVATE_KEY }}
+          PASSPHRASE: ${{ secrets.SIGNING_GPG_PASSPHRASE }}
+
+      - name: GPG signing info
+        run: |
+          echo "fingerprint: ${{ steps.import_gpg.outputs.fingerprint }}"
+          echo "keyid:       ${{ steps.import_gpg.outputs.keyid }}"
+          echo "name:        ${{ steps.import_gpg.outputs.name }}"
+          echo "email:       ${{ steps.import_gpg.outputs.email }}"
 
       - name: Build & publish release artifacts
-        run: make ci-release
+        run: make release
         env:
-          # for mac signing and notarization...
-          QUILL_SIGN_P12: ${{ secrets.ANCHORE_APPLE_DEVELOPER_ID_CERT_CHAIN }}
-          QUILL_SIGN_PASSWORD: ${{ secrets.ANCHORE_APPLE_DEVELOPER_ID_CERT_PASS }}
-          QUILL_NOTARY_ISSUER: ${{ secrets.APPLE_NOTARY_ISSUER }}
-          QUILL_NOTARY_KEY_ID: ${{ secrets.APPLE_NOTARY_KEY_ID }}
-          QUILL_NOTARY_KEY: ${{ secrets.APPLE_NOTARY_KEY }}
-          # for creating the release (requires write access to packages and content)
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          # for updating brew formula in anchore/homebrew-syft
-          GITHUB_BREW_TOKEN: ${{ secrets.ANCHORE_GIT_READ_TOKEN }}
-          # for updating the VERSION file in S3...
+          GITHUB_TOKEN: ${{ secrets.ANCHORE_GIT_READ_TOKEN }}
+          GPG_PRIVATE_KEY: ${{ secrets.SIGNING_GPG_PRIVATE_KEY }}
+          PASSPHRASE: ${{ secrets.SIGNING_GPG_PASSPHRASE }}
+          SIGNING_FINGERPRINT: ${{ steps.import_gpg.outputs.fingerprint }}
           AWS_ACCESS_KEY_ID: ${{ secrets.TOOLBOX_AWS_ACCESS_KEY_ID }}
           AWS_SECRET_ACCESS_KEY: ${{ secrets.TOOLBOX_AWS_SECRET_ACCESS_KEY }}
 
-      - uses: anchore/sbom-action@9fece9e20048ca9590af301449208b2b8861333b #v0.15.9
-        continue-on-error: true
+      - uses: actions/upload-artifact@v2
         with:
-          artifact-name: sbom.spdx.json
-
-      - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 #v3.16.2
-        continue-on-error: true
-        with:
-          status: ${{ job.status }}
-          fields: repo,workflow,action,eventName
-          text: "A new Syft release has been published: https://github.com/anchore/syft/releases/tag/${{ github.event.inputs.version }}"
-        env:
-          SLACK_WEBHOOK_URL: ${{ secrets.SLACK_TOOLBOX_WEBHOOK_URL }}
-        if: ${{ success() }}
+          name: artifacts
+          path: dist/**/*

.github/workflows/update-bootstrap-tools.yml

@@ -1,66 +0,0 @@
-name: PR for latest versions of tools
-on:
-  schedule:
-    - cron: "0 8 * * *" # 3 AM EST
-
-  workflow_dispatch:
-
-permissions:
-  contents: read
-
-jobs:
-  update-bootstrap-tools:
-    runs-on: ubuntu-latest
-    if: github.repository == 'anchore/syft' # only run for main repo
-    steps:
-      - uses: actions/checkout@9bb56186c3b09b4f86b1c65136769dd318469633 #v4.1.2
-
-      - name: Bootstrap environment
-        uses: ./.github/actions/bootstrap
-        with:
-          bootstrap-apt-packages: ""
-          compute-fingerprints: "false"
-          go-dependencies: false
-
-      - name: "Update tool versions"
-        id: latest-versions
-        run: |
-          make update-tools
-          make list-tools
-          
-          export NO_COLOR=1
-          delimiter="$(openssl rand -hex 8)"
-          
-          {
-            echo "status<<${delimiter}"
-            make list-tool-updates
-            echo "${delimiter}"
-          } >> $GITHUB_OUTPUT
-          
-          {
-            echo "### Tool version status"
-            echo "\`\`\`"
-            make list-tool-updates
-            echo "\`\`\`"
-          } >> $GITHUB_STEP_SUMMARY
-
-      - uses: tibdex/github-app-token@3beb63f4bd073e61482598c45c71c1019b59b73a #v2.1.0
-        id: generate-token
-        with:
-          app_id: ${{ secrets.TOKEN_APP_ID }}
-          private_key: ${{ secrets.TOKEN_APP_PRIVATE_KEY }}
-
-      - uses: peter-evans/create-pull-request@70a41aba780001da0a30141984ae2a0c95d8704e #v6.0.2
-        with:
-          signoff: true
-          delete-branch: true
-          branch: auto/latest-tools
-          labels: dependencies
-          commit-message: 'chore(deps): update tools to latest versions'
-          title: 'chore(deps): update tools to latest versions'
-          body: |
-            ```
-            ${{ steps.latest-versions.outputs.status }}
-            ```
-            This is an auto-generated pull request to update all of the tools to the latest versions.
-          token: ${{ steps.generate-token.outputs.token }}

.github/workflows/update-cpe-dictionary-index.yml

@@ -1,55 +0,0 @@
-name: PR to update CPE dictionary index
-on:
-  schedule:
-    - cron: "0 1 * * 1" # every monday at 1 AM
-
-  workflow_dispatch:
-
-permissions:
-  contents: read
-
-env:
-  SLACK_NOTIFICATIONS: true
-
-jobs:
-  upgrade-cpe-dictionary-index:
-    runs-on: ubuntu-latest
-    if: github.repository == 'anchore/syft' # only run for main repo
-    steps:
-      - uses: actions/checkout@9bb56186c3b09b4f86b1c65136769dd318469633 #v4.1.2
-
-      - name: Bootstrap environment
-        uses: ./.github/actions/bootstrap
-
-      - name: Bootstrap environment
-        uses: ./.github/actions/bootstrap
-
-      - run: |
-          make generate-cpe-dictionary-index
-
-      - uses: tibdex/github-app-token@3beb63f4bd073e61482598c45c71c1019b59b73a #v2.1.0
-        id: generate-token
-        with:
-          app_id: ${{ secrets.TOKEN_APP_ID }}
-          private_key: ${{ secrets.TOKEN_APP_PRIVATE_KEY }}
-
-      - uses: peter-evans/create-pull-request@70a41aba780001da0a30141984ae2a0c95d8704e #v6.0.2
-        with:
-          signoff: true
-          delete-branch: true
-          branch: auto/latest-cpe-dictionary-index
-          labels: dependencies
-          commit-message: "chore(deps): update CPE dictionary index"
-          title: "chore(deps): update CPE dictionary index"
-          body: |
-            Update CPE dictionary index based on the latest available CPE dictionary
-          token: ${{ steps.generate-token.outputs.token }}
-
-      - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 #v3.16.2
-        with:
-          status: ${{ job.status }}
-          fields: workflow,eventName,job
-          text: Syft CPE dictionary index update failed
-        env:
-          SLACK_WEBHOOK_URL: ${{ secrets.SLACK_TOOLBOX_WEBHOOK_URL }}
-        if: ${{ failure() && env.SLACK_NOTIFICATIONS == 'true' }}

.github/workflows/update-stereoscope-release.yml

@@ -1,57 +0,0 @@
-name: PR for latest Stereoscope release
-on:
-  schedule:
-    - cron: "0 8 * * *" # 3 AM EST
-
-  workflow_dispatch:
-
-env:
-  GO_VERSION: "1.21.x"
-  GO_STABLE_VERSION: true
-
-permissions:
-  contents: read
-
-jobs:
-  upgrade-stereoscope:
-    runs-on: ubuntu-latest
-    if: github.repository == 'anchore/syft' # only run for main repo
-    steps:
-      - uses: actions/checkout@9bb56186c3b09b4f86b1c65136769dd318469633 #v4.1.2
-
-      - uses: actions/setup-go@0c52d547c9bc32b1aa3301fd7a9cb496313a4491 #v5.0.0
-        with:
-          go-version: ${{ env.GO_VERSION }}
-          stable: ${{ env.GO_STABLE_VERSION }}
-
-      - name: Bootstrap environment
-        uses: ./.github/actions/bootstrap
-
-      - run: |
-          LATEST_VERSION=$(git ls-remote https://github.com/anchore/stereoscope main | head -n1 | awk '{print $1;}')
-
-          # update go.mod
-          go get github.com/anchore/stereoscope@$LATEST_VERSION
-          go mod tidy
-
-          # export the version for use with create-pull-request
-          echo "LATEST_VERSION=$LATEST_VERSION" >> $GITHUB_OUTPUT
-        id: latest-version
-
-      - uses: tibdex/github-app-token@3beb63f4bd073e61482598c45c71c1019b59b73a #v2.1.0
-        id: generate-token
-        with:
-          app_id: ${{ secrets.TOKEN_APP_ID }}
-          private_key: ${{ secrets.TOKEN_APP_PRIVATE_KEY }}
-
-      - uses: peter-evans/create-pull-request@70a41aba780001da0a30141984ae2a0c95d8704e #v6.0.2
-        with:
-          signoff: true
-          delete-branch: true
-          branch: auto/latest-stereoscope
-          labels: dependencies
-          commit-message: "chore(deps): update stereoscope to ${{ steps.latest-version.outputs.LATEST_VERSION }}"
-          title: "chore(deps): update stereoscope to ${{ steps.latest-version.outputs.LATEST_VERSION }}"
-          body: |
-            Update Stereoscope to ${{ steps.latest-version.outputs.LATEST_VERSION }}
-          token: ${{ steps.generate-token.outputs.token }}

.github/workflows/validations.yaml

@@ -1,262 +0,0 @@
-name: "Validations"
-
-on:
-  workflow_dispatch:
-  pull_request:
-  push:
-    branches:
-      - main
-
-permissions:
-    contents: read
-
-jobs:
-
-  Static-Analysis:
-    # Note: changing this job name requires making the same update in the .github/workflows/release.yaml pipeline
-    name: "Static analysis"
-    runs-on: ubuntu-20.04
-    steps:
-      - uses: actions/checkout@9bb56186c3b09b4f86b1c65136769dd318469633 #v4.1.2
-
-      - name: Bootstrap environment
-        uses: ./.github/actions/bootstrap
-
-      - name: Run static analysis
-        run: make static-analysis
-
-
-  Unit-Test:
-    # Note: changing this job name requires making the same update in the .github/workflows/release.yaml pipeline
-    name: "Unit tests"
-    runs-on: ubuntu-20.04
-    steps:
-      - uses: actions/checkout@9bb56186c3b09b4f86b1c65136769dd318469633 #v4.1.2
-
-      - name: Bootstrap environment
-        uses: ./.github/actions/bootstrap
-
-      - name: Restore file executable test-fixture cache
-        uses: actions/cache@ab5e6d0c87105b4c9c2047343972218f562e4319 #v4.0.1
-        with:
-          path: syft/file/cataloger/executable/test-fixtures/elf/bin
-          key: ${{ runner.os }}-unit-file-executable-elf-cache-${{ hashFiles( 'syft/file/cataloger/executable/test-fixtures/elf/cache.fingerprint' ) }}
-
-      - name: Restore file executable shared-info test-fixture cache
-        uses: actions/cache@ab5e6d0c87105b4c9c2047343972218f562e4319 #v4.0.1
-        with:
-          path: syft/file/cataloger/executable/test-fixtures/shared-info/bin
-          key: ${{ runner.os }}-unit-file-executable-shared-info-cache-${{ hashFiles( 'syft/file/cataloger/executable/test-fixtures/shared-info/cache.fingerprint' ) }}
-
-      - name: Restore Java test-fixture cache
-        uses: actions/cache@ab5e6d0c87105b4c9c2047343972218f562e4319 #v4.0.1
-        with:
-          path: syft/pkg/cataloger/java/test-fixtures/java-builds/packages
-          key: ${{ runner.os }}-unit-java-cache-${{ hashFiles( 'syft/pkg/cataloger/java/test-fixtures/java-builds/cache.fingerprint' ) }}
-
-      - name: Restore RPM test-fixture cache
-        uses: actions/cache@ab5e6d0c87105b4c9c2047343972218f562e4319 #v4.0.1
-        with:
-          path: syft/pkg/cataloger/redhat/test-fixtures/rpms
-          key: ${{ runner.os }}-unit-rpm-cache-${{ hashFiles( 'syft/pkg/cataloger/redhat/test-fixtures/rpms.fingerprint' ) }}
-
-      - name: Restore go binary test-fixture cache
-        uses: actions/cache@ab5e6d0c87105b4c9c2047343972218f562e4319 #v4.0.1
-        with:
-          path: syft/pkg/cataloger/golang/test-fixtures/archs/binaries
-          key: ${{ runner.os }}-unit-go-binaries-cache-${{ hashFiles( 'syft/pkg/cataloger/golang/test-fixtures/archs/binaries.fingerprint' ) }}
-
-      - name: Restore binary cataloger test-fixture cache
-        uses: actions/cache@ab5e6d0c87105b4c9c2047343972218f562e4319 #v4.0.1
-        with:
-          path: syft/pkg/cataloger/binary/test-fixtures/classifiers/bin
-          key: ${{ runner.os }}-unit-binary-cataloger-cache-${{ hashFiles( 'syft/pkg/cataloger/binary/test-fixtures/cache.fingerprint' ) }}
-
-      - name: Restore Kernel test-fixture cache
-        uses: actions/cache@ab5e6d0c87105b4c9c2047343972218f562e4319 #v4.0.1
-        with:
-          path: syft/pkg/cataloger/kernel/test-fixtures/cache
-          key: ${{ runner.os }}-unit-kernel-cache-${{ hashFiles( 'syft/pkg/cataloger/kernel/test-fixtures/cache.fingerprint' ) }}
-
-      - name: Run unit tests
-        run: make unit
-
-
-  Integration-Test:
-    # Note: changing this job name requires making the same update in the .github/workflows/release.yaml pipeline
-    name: "Integration tests"
-    runs-on: ubuntu-20.04
-    steps:
-      - uses: actions/checkout@9bb56186c3b09b4f86b1c65136769dd318469633 #v4.1.2
-
-      - name: Bootstrap environment
-        uses: ./.github/actions/bootstrap
-
-      - name: Validate syft output against the CycloneDX schema
-        run: make validate-cyclonedx-schema
-
-      - name: Restore integration test cache
-        uses: actions/cache@ab5e6d0c87105b4c9c2047343972218f562e4319 #v4.0.1
-        with:
-          path: ${{ github.workspace }}/cmd/syft/internal/test/integration/test-fixtures/cache
-          key: ${{ runner.os }}-integration-test-cache-${{ hashFiles('/cmd/syft/internal/test/integration/test-fixtures/cache.fingerprint') }}
-
-      - name: Run integration tests
-        run: make integration
-
-
-  Build-Snapshot-Artifacts:
-    name: "Build snapshot artifacts"
-    runs-on: ubuntu-20.04
-    steps:
-      - uses: actions/checkout@9bb56186c3b09b4f86b1c65136769dd318469633 #v4.1.2
-
-      - name: Bootstrap environment
-        uses: ./.github/actions/bootstrap
-        with:
-          bootstrap-apt-packages: ""
-
-      - name: Build snapshot artifacts
-        run: make snapshot
-
-      # why not use actions/upload-artifact? It is very slow (3 minutes to upload ~600MB of data, vs 10 seconds with this approach).
-      # see https://github.com/actions/upload-artifact/issues/199 for more info
-      - name: Upload snapshot artifacts
-        uses: actions/cache/save@ab5e6d0c87105b4c9c2047343972218f562e4319 #v4.0.1
-        with:
-          # we need to preserve the snapshot data itself as well as the task data that confirms if the
-          # snapshot build is stale or not. Otherwise the downstream jobs will attempt to rebuild the snapshot
-          # even though it already exists.
-          path: |
-            snapshot
-            .task
-          key: snapshot-build-${{ github.run_id }}
-
-
-  Acceptance-Linux:
-    # Note: changing this job name requires making the same update in the .github/workflows/release.yaml pipeline
-    name: "Acceptance tests (Linux)"
-    needs: [Build-Snapshot-Artifacts]
-    runs-on: ubuntu-20.04
-    steps:
-      - uses: actions/checkout@9bb56186c3b09b4f86b1c65136769dd318469633 #v4.1.2
-
-      - name: Bootstrap environment
-        uses: ./.github/actions/bootstrap
-
-      - name: Download snapshot build
-        id: snapshot-cache
-        uses: actions/cache/restore@ab5e6d0c87105b4c9c2047343972218f562e4319 #v4.0.1
-        with:
-          path: |
-            snapshot
-            .task
-          fail-on-cache-miss: true
-          key: snapshot-build-${{ github.run_id }}
-
-      # workaround for https://github.com/actions/cache/issues/1265
-      - name: (cache-miss) Snapshot build missing
-        if: steps.snapshot-cache.outputs.cache-hit != 'true'
-        run: echo "unable to download snapshots from previous job" && false
-
-      - name: Run comparison tests (Linux)
-        run: make compare-linux
-
-      - name: Restore install.sh test image cache
-        id: install-test-image-cache
-        uses: actions/cache@ab5e6d0c87105b4c9c2047343972218f562e4319 #v4.0.1
-        with:
-          path: ${{ github.workspace }}/test/install/cache
-          key: ${{ runner.os }}-install-test-image-cache-${{ hashFiles('test/install/cache.fingerprint') }}
-
-      - name: Load test image cache
-        if: steps.install-test-image-cache.outputs.cache-hit == 'true'
-        run: make install-test-cache-load
-
-      - name: Run install.sh tests (Linux)
-        run: make install-test
-
-      - name: (cache-miss) Create test image cache
-        if: steps.install-test-image-cache.outputs.cache-hit != 'true'
-        run: make install-test-cache-save
-
-
-  Acceptance-Mac:
-    # Note: changing this job name requires making the same update in the .github/workflows/release.yaml pipeline
-    name: "Acceptance tests (Mac)"
-    needs: [Build-Snapshot-Artifacts]
-    runs-on: macos-latest
-    steps:
-      - uses: actions/checkout@9bb56186c3b09b4f86b1c65136769dd318469633 #v4.1.2
-
-      - name: Bootstrap environment
-        uses: ./.github/actions/bootstrap
-        with:
-          bootstrap-apt-packages: ""
-          compute-fingerprints: "false"
-          go-dependencies: false
-          go-version: ""
-
-      - name: Download snapshot build
-        id: snapshot-cache
-        uses: actions/cache/restore@ab5e6d0c87105b4c9c2047343972218f562e4319 #v4.0.1
-        with:
-          path: |
-            snapshot
-            .task
-          fail-on-cache-miss: true
-          key: snapshot-build-${{ github.run_id }}
-
-      # workaround for https://github.com/actions/cache/issues/1265
-      - name: (cache-miss) Snapshot build missing
-        if: steps.snapshot-cache.outputs.cache-hit != 'true'
-        run: echo "unable to download snapshots from previous job" && false
-
-      - name: Restore docker image cache for compare testing
-        id: mac-compare-testing-cache
-        uses: actions/cache@ab5e6d0c87105b4c9c2047343972218f562e4319 #v4.0.1
-        with:
-          path: image.tar
-          key: ${{ runner.os }}-${{ hashFiles('test/compare/mac.sh') }}
-
-      - name: Run comparison tests (Mac)
-        run: make compare-mac
-
-      - name: Run install.sh tests (Mac)
-        run: make install-test-ci-mac
-
-
-  Cli-Linux:
-    # Note: changing this job name requires making the same update in the .github/workflows/release.yaml pipeline
-    name: "CLI tests (Linux)"
-    needs: [Build-Snapshot-Artifacts]
-    runs-on: ubuntu-20.04
-    steps:
-      - uses: actions/checkout@9bb56186c3b09b4f86b1c65136769dd318469633 #v4.1.2
-
-      - name: Bootstrap environment
-        uses: ./.github/actions/bootstrap
-
-      - name: Restore CLI test-fixture cache
-        uses: actions/cache@ab5e6d0c87105b4c9c2047343972218f562e4319 #v4.0.1
-        with:
-          path: ${{ github.workspace }}/test/cli/test-fixtures/cache
-          key: ${{ runner.os }}-cli-test-cache-${{ hashFiles('test/cli/test-fixtures/cache.fingerprint') }}
-
-      - name: Download snapshot build
-        id: snapshot-cache
-        uses: actions/cache/restore@ab5e6d0c87105b4c9c2047343972218f562e4319 #v4.0.1
-        with:
-          path: |
-            snapshot
-            .task
-          fail-on-cache-miss: true
-          key: snapshot-build-${{ github.run_id }}
-
-      # workaround for https://github.com/actions/cache/issues/1265
-      - name: (cache-miss) Snapshot build missing
-        if: steps.snapshot-cache.outputs.cache-hit != 'true'
-        run: echo "unable to download snapshots from previous job" && false
-
-      - name: Run CLI Tests (Linux)
-        run: make cli

.gitignore

@@ -1,40 +1,9 @@
-# local development tailoring
-go.work
-go.work.sum
-.tool-versions
-
-# app configuration
-/.syft.yaml
-
-# tool and bin directories
-.tmp/
-bin/
-/bin
-/.bin
-/build
+CHANGELOG.md
 /dist
 /snapshot
-/.tool
-/.task
-
-# changelog generation
-CHANGELOG.md
-VERSION
-
-# IDE configuration
-.vscode/
-.idea/
 .server/
-.history/
-
-# test related
+.vscode/
 *.fingerprint
-/test/results
-coverage.txt
-*.log
-
-# probable archives
-.images
 *.tar
 *.jar
 *.war
@@ -42,7 +11,11 @@ coverage.txt
 *.jpi
 *.hpi
 *.zip
-*.iml
+.idea/
+*.log
+.images
+.tmp/
+coverage.txt
 
 # Binaries for programs and plugins
 *.exe
@@ -56,17 +29,3 @@ coverage.txt
 
 # Output of the go coverage tool, specifically when used with LiteIDE
 *.out
-
-# macOS Finder metadata
-.DS_STORE
-
-*.profile
-
-# attestation
-cosign.key
-cosign.pub
-
-# Byte-compiled object files for python
-__pycache__/
-*.py[cod]
-*$py.class

.golangci.yaml

@@ -1,7 +1,5 @@
-issues:
-  max-same-issues: 25
-
-  # TODO: enable this when we have coverage on docstring comments
+# TODO: enable this when we have coverage on docstring comments
+#issues:
 #  # The list of ids of default excludes to include or disable.
 #  include:
 #    - EXC0002 # disable excluding of issues about comments from golint
@@ -12,10 +10,11 @@ linters:
   enable:
     - asciicheck
     - bodyclose
+    - deadcode
+    - depguard
     - dogsled
     - dupl
     - errcheck
-    - exportloopref
     - funlen
     - gocognit
     - goconst
@@ -23,6 +22,7 @@ linters:
     - gocyclo
     - gofmt
     - goimports
+    - golint
     - goprintffuncname
     - gosec
     - gosimple
@@ -30,53 +30,30 @@ linters:
     - ineffassign
     - misspell
     - nakedret
-    - revive
+    - nolintlint
+    - rowserrcheck
+    - scopelint
     - staticcheck
+    - structcheck
     - stylecheck
     - typecheck
     - unconvert
     - unparam
     - unused
+    - varcheck
     - whitespace
 
-linters-settings:
-  funlen:
-    # Checks the number of lines in a function.
-    # If lower than 0, disable the check.
-    # Default: 60
-    lines: 70
-    # Checks the number of statements in a function.
-    # If lower than 0, disable the check.
-    # Default: 40
-    statements: 50
-output:
-  uniq-by-line: false
-run:
-  timeout: 10m
-
 # do not enable...
-#    - deadcode          # The owner seems to have abandoned the linter. Replaced by "unused".
-#    - depguard          # We don't have a configuration for this yet
-#    - goprintffuncname  # does not catch all cases and there are exceptions
-#    - nakedret          # does not catch all cases and should not fail a build
 #    - gochecknoglobals
 #    - gochecknoinits    # this is too aggressive
-#    - rowserrcheck disabled per generics https://github.com/golangci/golangci-lint/issues/2649
 #    - godot
 #    - godox
 #    - goerr113
-#    - goimports   # we're using gosimports now instead to account for extra whitespaces (see https://github.com/golang/go/issues/20818)
-#    - golint      # deprecated
 #    - gomnd       # this is too aggressive
 #    - interfacer  # this is a good idea, but is no longer supported and is prone to false positives
 #    - lll         # without a way to specify per-line exception cases, this is not usable
 #    - maligned    # this is an excellent linter, but tricky to optimize and we are not sensitive to memory layout optimizations
 #    - nestif
-#    - nolintlint   # as of go1.19 this conflicts with the behavior of gofmt, which is a deal-breaker (lint-fix will still fail when running lint)
-#    - prealloc     # following this rule isn't consistently a good idea, as it sometimes forces unnecessary allocations that result in less idiomatic code
-#    - rowserrcheck # not in a repo with sql, so this is not useful
-#    - scopelint    # deprecated
-#    - structcheck  # The owner seems to have abandoned the linter. Replaced by "unused".
+#    - prealloc    # this unnecessarily requires preallocations for slices
 #    - testpackage
-#    - varcheck     # The owner seems to have abandoned the linter. Replaced by "unused".
-#    - wsl          # this doens't have an auto-fixer yet and is pretty noisy (https://github.com/bombsimon/wsl/issues/90)
+#    - wsl

.goreleaser.yaml

@@ -1,74 +1,36 @@
 release:
-  prerelease: auto
-  draft: false
+  # If set to auto, will mark the release as not ready for production in case there is an indicator for this in the
+  # tag e.g. v1.0.0-rc1 .If set to true, will mark the release as not ready for production.
+  prerelease: false
 
-env:
-  # required to support multi architecture docker builds
-  - DOCKER_CLI_EXPERIMENTAL=enabled
-  - CGO_ENABLED=0
+  # If set to true, will not auto-publish the release. This is done to allow us to review the changelog before publishing.
+  draft: true
+
+signs:
+  - artifacts: checksum
+    args: ["--output", "${signature}", "--detach-sign", "${artifact}"]
 
 builds:
-  - id: linux-build
-    dir: ./cmd/syft
-    binary: syft
+  - binary: syft
+    env:
+      - CGO_ENABLED=0
     goos:
+      # windows not supported yet (due to jotframe)
+      # - windows
       - linux
-    goarch:
-      - amd64
-      - arm64
-      - ppc64le
-      - s390x
-    # set the modified timestamp on the output binary to the git timestamp to ensure a reproducible build
-    mod_timestamp: &build-timestamp '{{ .CommitTimestamp }}'
-    ldflags: &build-ldflags |
-      -w
-      -s
-      -extldflags '-static'
-      -X main.version={{.Version}}
-      -X main.gitCommit={{.Commit}}
-      -X main.buildDate={{.Date}}
-      -X main.gitDescription={{.Summary}}
-
-  - id: darwin-build
-    dir: ./cmd/syft
-    binary: syft
-    goos:
       - darwin
     goarch:
       - amd64
-      - arm64
-    mod_timestamp: *build-timestamp
-    ldflags: *build-ldflags
-    hooks:
-      post:
-        - cmd: .tool/quill sign-and-notarize "{{ .Path }}" --dry-run={{ .IsSnapshot }} --ad-hoc={{ .IsSnapshot }} -vv
-          env:
-            - QUILL_LOG_FILE=/tmp/quill-{{ .Target }}.log
-
-  - id: windows-build
-    dir: ./cmd/syft
-    binary: syft
-    goos:
-      - windows
-    goarch:
-      - amd64
-    mod_timestamp: *build-timestamp
-    ldflags: *build-ldflags
-
-archives:
-  - id: linux-archives
-    builds:
-      - linux-build
-
-  # note: the signing process is depending on tar.gz archives. If this format changes then .github/scripts/apple-signing/*.sh will need to be adjusted
-  - id: darwin-archives
-    builds:
-      - darwin-build
-
-  - id: windows-archives
-    format: zip
-    builds:
-      - windows-build
+    # Set the modified timestamp on the output binary to the git timestamp (to ensure a reproducible build)
+    mod_timestamp: '{{ .CommitTimestamp }}'
+    ldflags: |
+      -w
+      -s
+      -extldflags '-static'
+      -X github.com/anchore/syft/internal/version.version={{.Version}}
+      -X github.com/anchore/syft/internal/version.gitCommit={{.Commit}}
+      -X github.com/anchore/syft/internal/version.buildDate={{.Date}}
+      -X github.com/anchore/syft/internal/version.gitTreeState={{.Env.BUILD_GIT_TREE_STATE}}
 
 nfpms:
   - license: "Apache 2.0"
@@ -83,192 +45,12 @@ brews:
   - tap:
       owner: anchore
       name: homebrew-syft
-      token: "{{.Env.GITHUB_BREW_TOKEN}}"
-    ids:
-      - darwin-archives
-      - linux-archives
     homepage: *website
     description: *description
-    license: "Apache License 2.0"
 
-dockers:
-  - image_templates:
-      - anchore/syft:debug
-      - anchore/syft:{{.Tag}}-debug
-      - ghcr.io/anchore/syft:debug
-      - ghcr.io/anchore/syft:{{.Tag}}-debug
-    goarch: amd64
-    dockerfile: Dockerfile.debug
-    use: buildx
-    build_flag_templates:
-      - "--platform=linux/amd64"
-      - "--build-arg=BUILD_DATE={{.Date}}"
-      - "--build-arg=BUILD_VERSION={{.Version}}"
-      - "--build-arg=VCS_REF={{.FullCommit}}"
-      - "--build-arg=VCS_URL={{.GitURL}}"
+archives:
+  - format: tar.gz
+    format_overrides:
+      - goos: windows
+        format: zip
 
-  - image_templates:
-      - anchore/syft:debug-arm64v8
-      - anchore/syft:{{.Tag}}-debug-arm64v8
-      - ghcr.io/anchore/syft:debug-arm64v8
-      - ghcr.io/anchore/syft:{{.Tag}}-debug-arm64v8
-    goarch: arm64
-    dockerfile: Dockerfile.debug
-    use: buildx
-    build_flag_templates:
-      - "--platform=linux/arm64/v8"
-      - "--build-arg=BUILD_DATE={{.Date}}"
-      - "--build-arg=BUILD_VERSION={{.Version}}"
-      - "--build-arg=VCS_REF={{.FullCommit}}"
-      - "--build-arg=VCS_URL={{.GitURL}}"
-
-  - image_templates:
-      - anchore/syft:debug-ppc64le
-      - anchore/syft:{{.Tag}}-debug-ppc64le
-      - ghcr.io/anchore/syft:debug-ppc64le
-      - ghcr.io/anchore/syft:{{.Tag}}-debug-ppc64le
-    goarch: ppc64le
-    dockerfile: Dockerfile.debug
-    use: buildx
-    build_flag_templates:
-      - "--platform=linux/ppc64le"
-      - "--build-arg=BUILD_DATE={{.Date}}"
-      - "--build-arg=BUILD_VERSION={{.Version}}"
-      - "--build-arg=VCS_REF={{.FullCommit}}"
-      - "--build-arg=VCS_URL={{.GitURL}}"
-
-  - image_templates:
-      - anchore/syft:debug-s390x
-      - anchore/syft:{{.Tag}}-debug-s390x
-      - ghcr.io/anchore/syft:debug-s390x
-      - ghcr.io/anchore/syft:{{.Tag}}-debug-s390x
-    goarch: s390x
-    dockerfile: Dockerfile.debug
-    use: buildx
-    build_flag_templates:
-      - "--platform=linux/s390x"
-      - "--build-arg=BUILD_DATE={{.Date}}"
-      - "--build-arg=BUILD_VERSION={{.Version}}"
-      - "--build-arg=VCS_REF={{.FullCommit}}"
-      - "--build-arg=VCS_URL={{.GitURL}}"
-
-  - image_templates:
-      - anchore/syft:latest
-      - anchore/syft:{{.Tag}}
-      - ghcr.io/anchore/syft:latest
-      - ghcr.io/anchore/syft:{{.Tag}}
-    goarch: amd64
-    dockerfile: Dockerfile
-    use: buildx
-    build_flag_templates:
-      - "--platform=linux/amd64"
-      - "--build-arg=BUILD_DATE={{.Date}}"
-      - "--build-arg=BUILD_VERSION={{.Version}}"
-      - "--build-arg=VCS_REF={{.FullCommit}}"
-      - "--build-arg=VCS_URL={{.GitURL}}"
-
-  - image_templates:
-      - anchore/syft:{{.Tag}}-arm64v8
-      - ghcr.io/anchore/syft:{{.Tag}}-arm64v8
-    goarch: arm64
-    dockerfile: Dockerfile
-    use: buildx
-    build_flag_templates:
-      - "--platform=linux/arm64/v8"
-      - "--build-arg=BUILD_DATE={{.Date}}"
-      - "--build-arg=BUILD_VERSION={{.Version}}"
-      - "--build-arg=VCS_REF={{.FullCommit}}"
-      - "--build-arg=VCS_URL={{.GitURL}}"
-
-  - image_templates:
-      - anchore/syft:{{.Tag}}-ppc64le
-      - ghcr.io/anchore/syft:{{.Tag}}-ppc64le
-    goarch: ppc64le
-    dockerfile: Dockerfile
-    use: buildx
-    build_flag_templates:
-      - "--platform=linux/ppc64le"
-      - "--build-arg=BUILD_DATE={{.Date}}"
-      - "--build-arg=BUILD_VERSION={{.Version}}"
-      - "--build-arg=VCS_REF={{.FullCommit}}"
-      - "--build-arg=VCS_URL={{.GitURL}}"
-
-  - image_templates:
-      - anchore/syft:{{.Tag}}-s390x
-      - ghcr.io/anchore/syft:{{.Tag}}-s390x
-    goarch: s390x
-    dockerfile: Dockerfile
-    use: buildx
-    build_flag_templates:
-      - "--platform=linux/s390x"
-      - "--build-arg=BUILD_DATE={{.Date}}"
-      - "--build-arg=BUILD_VERSION={{.Version}}"
-      - "--build-arg=VCS_REF={{.FullCommit}}"
-      - "--build-arg=VCS_URL={{.GitURL}}"
-
-docker_manifests:
-  - name_template: anchore/syft:latest
-    image_templates:
-      - anchore/syft:{{.Tag}}
-      - anchore/syft:{{.Tag}}-arm64v8
-      - anchore/syft:{{.Tag}}-ppc64le
-      - anchore/syft:{{.Tag}}-s390x
-
-  - name_template: anchore/syft:debug
-      - anchore/syft:{{.Tag}}-debug
-      - anchore/syft:{{.Tag}}-debug-arm64v8
-      - anchore/syft:{{.Tag}}-debug-ppc64le
-      - anchore/syft:{{.Tag}}-debug-s390x
-
-  - name_template: anchore/syft:{{.Tag}}
-    image_templates:
-      - anchore/syft:{{.Tag}}
-      - anchore/syft:{{.Tag}}-arm64v8
-      - anchore/syft:{{.Tag}}-ppc64le
-      - anchore/syft:{{.Tag}}-s390x
-
-  - name_template: ghcr.io/anchore/syft:latest
-    image_templates:
-      - ghcr.io/anchore/syft:{{.Tag}}
-      - ghcr.io/anchore/syft:{{.Tag}}-arm64v8
-      - ghcr.io/anchore/syft:{{.Tag}}-ppc64le
-      - ghcr.io/anchore/syft:{{.Tag}}-s390x
-
-  - name_template: ghcr.io/anchore/syft:debug
-    image_templates:
-      - ghcr.io/anchore/syft:{{.Tag}}-debug
-      - ghcr.io/anchore/syft:{{.Tag}}-debug-arm64v8
-      - ghcr.io/anchore/syft:{{.Tag}}-debug-ppc64le
-      - ghcr.io/anchore/syft:{{.Tag}}-debug-s390x
-
-  - name_template: ghcr.io/anchore/syft:{{.Tag}}
-    image_templates:
-      - ghcr.io/anchore/syft:{{.Tag}}
-      - ghcr.io/anchore/syft:{{.Tag}}-arm64v8
-      - ghcr.io/anchore/syft:{{.Tag}}-ppc64le
-      - ghcr.io/anchore/syft:{{.Tag}}-s390x
-
-sboms:
-  - artifacts: archive
-    # this is relative to the snapshot/dist directory, not the root of the repo
-    cmd: ../.tool/syft
-    documents:
-      - "{{ .Binary }}_{{ .Version }}_{{ .Os }}_{{ .Arch }}.sbom"
-    args:
-      - "scan"
-      - "$artifact"
-      - "--output"
-      - "json=$document"
-
-signs:
-  - cmd: .tool/cosign
-    signature: "${artifact}.sig"
-    certificate: "${artifact}.pem"
-    args:
-      - "sign-blob"
-      - "--oidc-issuer=https://token.actions.githubusercontent.com"
-      - "--output-certificate=${certificate}"
-      - "--output-signature=${signature}"
-      - "${artifact}"
-      - "--yes"
-    artifacts: checksum

CONTRIBUTING.md

@@ -1,63 +1,12 @@
-[#](#) Contributing to Syft
+# Contributing to `syft`
 
-If you are looking to contribute to this project and want to open a GitHub pull request ("PR"), there are a few guidelines of what we are looking for in patches. Make sure you go through this document and ensure that your code proposal is aligned.
+If you are looking to contribute to this project and want to open a Github pull request ("PR"), there are a few guidelines of what we are looking for in patches. Make sure you go through this document and ensure that your code proposal is aligned.
 
-## Setting up your environment
-
-Before you can contribute to Syft, you need to configure your development environment.
-
-### Debian setup
-
-You will need to install Go. The version on https://go.dev works best, using the system golang doesn't always work the way you might expect.
-
-Refer to the go.mod file in the root of this repo for the recommended version of Go to install.
-
-You will also need Docker. There's no reason the system packages shouldn't work, but we used the official Docker package. You can find instructions for installing Docker in Debian [here](https://docs.docker.com/engine/install/debian/).
-
-You also need to install some Debian packages
-
-```sh
-sudo apt-get install build-essential zip bc libxml2-utils git
-```
-
-## Configuring Git
-
-You will need to configure your git client with your name and email address. This is easily done from the command line.
-
-```text
-$ git config --global user.name "John Doe"
-$ git config --global user.email "john.doe@example.com"
-```
-
-This username and email address will matter later in this guide.
-
-## Fork the repo
-
-You should fork the Syft repo using the "Fork" button at the top right of the Syft GitHub [site](https://github.com/anchore/syft/). You will be doing your development in your fork, then submit a pull request to Syft. There are many resources how to use GitHub effectively, we will not cover those here.
-
-## Adding a feature or fix
-
-If you look at the Syft [Issue](https://github.com/anchore/syft/issues) there are plenty of bugs and feature requests. Maybe look at the [good first issue](https://github.com/anchore/syft/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) list if you're not sure where to start.
-
-## Commit guidelines
-
-In the Syft project we like commits and pull requests (PR) to be easy to understand and review. Open source thrives best when everything happening is over documented and small enough to be understood.
-
-### Granular commits
-
-Please try to make every commit as simple as possible, but no simpler. The idea is that each commit should be a logical unit of code. Try not to commit too many tiny changes, for example every line changed in a file as a separate commit. And also try not to make a commit enormous, for example committing all your work at the end of the day.
-
-Rather than try to follow a strict guide on what is or is not best, we try to be flexible and simple in this space. Do what makes the most sense for the changes you are trying to include.
-
-### Commit title and description
-
-Remember that the message you leave for a commit is for the reviewer in the present, and for someone (maybe you) changing something in the future. Please make sure the title and description used is easy to understand and explains what was done. Jokes and clever comments generally don't age well in commit messages. Just the facts please.
-
-## Sign off your work
+## Sign your work
 
 The `sign-off` is an added line at the end of the explanation for the commit, certifying that you wrote it or otherwise have the right to submit it as an open-source patch. By submitting a contribution, you agree to be bound by the terms of the DCO Version 1.1 and Apache License Version 2.0.
 
-Signing off a commit certifies the below Developer's Certificate of Origin (DCO):
+Signing a commit certifies the below Developer's Certificate of Origin (DCO):
 
 ```text
 Developer's Certificate of Origin 1.1
@@ -95,13 +44,20 @@ When committing your change, you can add the required line manually so that it l
 Signed-off-by: John Doe <john.doe@example.com>
 ```
 
-Creating a signed-off commit is then possible with `-s` or `--signoff`:
+Alternatively, configure your Git client with your name and email to use the `-s` flag when creating a commit:
+
+```text
+$ git config --global user.name "John Doe"
+$ git config --global user.email "john.doe@example.com"
+```
+
+Creating a signed commit is then possible with `-s`:
 
 ```text
 $ git commit -s -m "this is a commit message"
 ```
 
-To double-check that the commit was signed-off, look at the log output:
+To double check if the commit was signed, look at the log output:
 
 ```text
 $ git log -1
@@ -114,9 +70,22 @@ Date:   Mon Aug 1 11:27:13 2020 -0400
     Signed-off-by: John Doe <john.doe@example.com>
 ```
 
+
+[//]: # (TODO: Commit guidelines, granular commits)
+
+
+[//]: # (TODO: Commit guidelines, descriptive messages)
+
+
+[//]: # (TODO: Commit guidelines, commit title, extra body description)
+
+
+[//]: # (TODO: PR title and description)
+
+
 ## Test your changes
 
-This project has a `Makefile` which includes many helpers running both unit and integration tests. You can run `make help` to see all the options. Although PRs will have automatic checks for these, it is useful to run them locally, ensuring they pass before submitting changes. Ensure you've bootstrapped once before running tests:
+This project has a `Makefile` which includes many helpers running both unit and integration tests. Although PRs will have automatic checks for these, it is useful to run them locally, ensuring they pass before submitting changes. Ensure you've bootstrapped once before running tests:
 
 ```text
 $ make bootstrap
@@ -129,26 +98,6 @@ $ make unit
 $ make integration
 ```
 
-You can also run `make all` to run a more extensive test suite, but there is additional configuration that will be needed for those tests to run correctly. We will not cover the extra steps here.
-
-## Pull Request
-
-If you made it this far and all the tests are passing, it's time to submit a Pull Request (PR) for Syft. Submitting a PR is always a scary moment as what happens next can be an unknown. The Syft project strives to be easy to work with, we appreciate all contributions. Nobody is going to yell at you or try to make you feel bad. We love contributions and know how scary that first PR can be.
-
-### PR Title and Description
-
-Just like the commit title and description mentioned above, the PR title and description is very important for letting others know what's happening. Please include any details you think a reviewer will need to more properly review your PR.
-
-A PR that is very large or poorly described has a higher likelihood of being pushed to the end of the list. Reviewers like PRs they can understand and quickly review.
-
-### What to expect next
-
-Please be patient with the project. We try to review PRs in a timely manner, but this is highly dependent on all the other tasks we have going on. It's OK to ask for a status update every week or two, it's not OK to ask for a status update every day.
-
-It's very likely the reviewer will have questions and suggestions for changes to your PR. If your changes don't match the current style and flow of the other code, expect a request to change what you've done.
-
 ## Document your changes
 
-And lastly, when proposed changes are modifying user-facing functionality or output, it is expected the PR will include updates to the documentation as well. Syft is not a project that is heavy on documentation. This will mostly be updating the README and help for the tool.
-
-If nobody knows new features exist, they can't use them!
+When proposed changes are modifying user-facing functionality or output, it is expected the PR will include updates to the documentation as well.

CONTRIBUTORS.md

@@ -1,11 +0,0 @@
-# Syft Contributors
-
-The following Syft components were contributed by external authors/organizations.
-
-## GraalVM Native Image
-
-A cataloger contributed by Oracle Corporation that extracts packages given within GraalVM Native Image SBOMs.
-
-## Swift Package Manager
-
-A cataloger contributed by Axis Communications that catalogs packages resolved by Swift Package Manager.

DEVELOPING.md

@@ -1,382 +0,0 @@
-# Developing
-
-## Getting started
-
-In order to test and develop in this repo you will need the following dependencies installed:
-- Golang
-- docker
-- make
-- Python (>= 3.9)
-
-### Docker settings for getting started
-Make sure you've updated your docker settings so the default docker socket path is available.
-
-Go to:
-
-docker -> settings -> advanced
-
-Make sure:
-
-```
-Allow the default Docker socket to be used
-```
-
-is checked.
-
-Also double check that the docker context being used is the default context. If it is not, run:
-
-`docker context use default`
-
-After cloning the following step can help you get setup:
-1. run `make bootstrap` to download go mod dependencies, create the `/.tmp` dir, and download helper utilities.
-2. run `make` to view the selection of developer commands in the Makefile
-3. run `make build` to build the release snapshot binaries and packages
-4. for an even quicker start you can run `go run cmd/syft/main.go` to print the syft help.
-	- this command `go run cmd/syft/main.go alpine:latest` will compile and run syft against `alpine:latest`
-5. view the README or syft help output for more output options
-
-The main make tasks for common static analysis and testing are `lint`, `format`, `lint-fix`, `unit`, `integration`, and `cli`.
-
-See `make help` for all the current make tasks.
-
-### Internal Artifactory Settings
-
-**Not always applicable**
-
-Some companies have Artifactory setup internally as a solution for sourcing secure dependencies.
-If you're seeing an issue where the unit tests won't run because of the below error then this section might be relevant for your use case.
-
-```
-[ERROR] [ERROR] Some problems were encountered while processing the POMs
-```
-
-If you're dealing with an issue where the unit tests will not pull/build certain java fixtures check some of these settings:
-
-- a `settings.xml` file should be available to help you communicate with your internal artifactory deployment
-- this can be moved to `syft/pkg/cataloger/java/test-fixtures/java-builds/example-jenkins-plugin/` to help build the unit test-fixtures
-- you'll also want to modify the `build-example-jenkins-plugin.sh` to use `settings.xml`
-
-For more information on this setup and troubleshooting see [issue 1895](https://github.com/anchore/syft/issues/1895#issuecomment-1610085319)
-
-
-## Architecture
-
-At a high level, this is the package structure of syft:
-```
-./cmd/syft/
-│   ├── cli/
-│   │   ├── cli.go          // where all commands are wired up
-│   │   ├── commands/       // all command implementations
-│   │   ├── options/        // all command flags and configuration options
-│   │   └── ui/             // all handlers for events that are shown on the UI
-│   └── main.go             // entrypoint for the application
-└── syft/                   // the "core" syft library
-    ├── format/             // contains code to encode or decode to and from SBOM formats
-    ├── pkg/                // contains code to catalog packages from a source
-    ├── sbom/               // contains the definition of an SBOM
-    └── source/             // contains code to create a source object for some input type (e.g. container image, directory, etc)
-```
-
-Syft's core library is implemented in the `syft` package and subpackages, where the major packages are:
-
-- the `syft/source` package produces a `source.Source` object that can be used to catalog a directory, container, and other source types.
-- the `syft` package contains a single function that can take a `source.Source` object and catalog it, producing an `sbom.SBOM` object
-- the `syft/format` package contains the ability to encode and decode SBOMs to and from different SBOM formats (such as SPDX and CycloneDX)
-
-The `cmd` pacakge at the highest level execution flow wires up [`spf13/cobra`](https://github.com/spf13/cobra) commands for execution in the main application:
-```mermaid
-sequenceDiagram
-    participant main as cmd/syft/main
-    participant cli as cli.New()
-    participant root as root.Execute()
-    participant cmd as <command>.Execute()
-
-    main->>+cli: 
-
-    Note right of cli: wire ALL CLI commands
-    Note right of cli: add flags for ALL commands
-
-    cli-->>-main:  root command 
-
-    main->>+root: 
-    root->>+cmd: 
-    cmd-->>-root: (error)  
-
-    root-->>-main: (error) 
-
-    Note right of cmd: Execute SINGLE command from USER
-```
-
-The `packages` command uses the core library to generate an SBOM for the given user input:
-```mermaid
-sequenceDiagram
-    participant source as source.New(ubuntu:latest)
-    participant sbom as sbom.SBOM
-    participant catalog as syft.CatalogPackages(src)
-    participant encoder as syft.Encode(sbom, format)
-
-    Note right of source: use "ubuntu:latest" as SBOM input
-
-    source-->>+sbom: add source to SBOM struct
-    source-->>+catalog: pass src to generate catalog
-    catalog-->-sbom: add cataloging results onto SBOM
-    sbom-->>encoder: pass SBOM and format desiered to syft encoder
-    encoder-->>source: return bytes that are the SBOM of the original input 
-
-    Note right of catalog: cataloger configuration is done based on src
-```
-
-Additionally, here is a [gist of using syft as a library](https://gist.github.com/spiffcs/3027638b7ba904d07e482a712bc00d3d) to generate a SBOM for a docker image.
-
-
-### `pkg.Package` object
-
-The `pkg.Package` object is a core data structure that represents a software package. Fields like `name` and `version` probably don't need
-a detailed explanation, but some of the other fields are worth a quick overview:
-
-- `FoundBy`: the name of the cataloger that discovered this package (e.g. `python-pip-cataloger`).
-- `Locations`: these are the set of paths and layer ids that were parsed to discover this package (e.g. `python-pip-cataloger`).
-- `Language`: the language of the package (e.g. `python`).
-- `Type`: this is a high-level categorization of the ecosystem the package resides in. For instance, even if the package is a egg, wheel, or requirements.txt reference, it is still logically a "python" package. Not all package types align with a language (e.g. `rpm`) but it is common.
-- `Metadata`: specialized data for specific location(s) parsed. We should try and raise up as much raw information that seems useful. As a rule of thumb the object here should be as flat as possible and use the raw names and values from the underlying source material parsed.
-
-When `pkg.Package` is serialized an additional `MetadataType` is shown. This is a label that helps consumers understand the datashape of the `Metadata` field.
-
-By convention the `MetadataType` value should follow these rules of thumb:
-
-- Only use lowercase letters, numbers, and hyphens. Use hyphens to separate words.
-- **Try to anchor the name in the ecosystem, language, or packaging tooling it belongs to**. For a package manager for a language ecosystem the language, framework or runtime should be used as a prefix. For instance `pubspec-lock` is an OK name, but `dart-pubspec-lock` is better. For an OS package manager this is not necessary (e.g. `apk-db-entry` is a good name, but `alpine-apk-db-entry` is not since `alpine` and the `a` in `apk` is redundant).
-- **Be as specific as possible to what the data represents**. For instance `ruby-gem` is NOT a good `MetadataType` value, but `ruby-gemspec` is. Why? Ruby gem information can come from a gemspec file or a Gemfile.lock, which are very different. The latter name provides more context as to what to expect.
-- **Should describe WHAT the data is, NOT HOW it's used**. For instance `r-description-installed-file` is NOT a good `MetadataType` value since it's trying to convey that we use the DESCRIPTION file in the R ecosystem to detect installed packages. Instead simply describe what the DESCRIPTION file is itself without context of how it's used: `r-description`.
-- **Use the `lock` suffix** to distinct between manifest files that loosely describe package version requirements vs files that strongly specify one and only one version of a package ("lock" files). These should only be used with respect to package managers that have the guide and lock distinction, but would not be appropriate otherwise (e.g. `rpm` does not have a guide vs lock, so `lock` should NOT be used to describe a db entry).
-- **Use the `archive` suffix to indicate a package archive** (e.g. rpm file, apk file, etc) that describes the contents of the package. For example an RPM file that was cataloged would have a `rpm-archive` metadata type (not to be confused with an RPM DB record entry which would be `rpm-db-entry`).
-- **Use the `entry` suffix** to indicate information about a package that was found as a single entry within file that has multiple package entries. If the entry was found within a DB or a flat-file store for an OS package manager, you should use `db-entry`.
-- **Should NOT contain the phrase `package`**, though exceptions are allowed (say if the canonical name literally has the phrase package in it).
-- **Should NOT contain have a `file` suffix** unless the canonical name has the term "file", such as a `pipfile` or `gemfile`. An example of a bad name for this rule is`ruby-gemspec-file`; a better name would be `ruby-gemspec`.
-- **Should NOT contain the exact filename+extensions**. For instance `pipfile.lock` shouldn't really be in the name, instead try and describe what the file is: `python-pipfile-lock` (but shouldn't this be `python-pip-lock` you might ask? No, since the `pip` package manger is not related to the `pipfile` project).
-- **Should NOT contain the phrase `metadata`**, unless the canonical name has this term.
-- **Should represent a single use case**. For example, trying to describe Hackage metadata with a single `HackageMetadata` struct (and thus `MetadataType`) is not allowed since it represents 3 mutually exclusive use cases: representing a `stack.yaml`, `stack.lock`, or `cabal.project` file. Instead, each of these should have their own struct types and `MetadataType` values.
-
-There are other cases that are not covered by these rules... and that's ok! The goal is to provide a consistent naming scheme that is easy to understand and use when it's applicable. If the rules do not exactly apply in your situation then just use your best judgement (or amend these rules as needed whe new common cases come up).
-
-What if the underlying parsed data represents multiple files? There are two approaches to this:
-- use the primary file to represent all the data. For instance, though the `dpkg-cataloger` looks at multiple files to get all information about a package, it's the `status` file that gets represented.
-- nest each individual file's data under the `Metadata` field. For instance, the `java-archive-cataloger` may find information from on or all of the files: `pom.xml`, `pom.properties`, and `MANIFEST.MF`. However, the metadata is simply `java-metadata' with each possibility as a nested optional field.
-
-### Syft Catalogers
-
-Catalogers are the way in which syft is able to identify and construct packages given a set a targeted list of files.
-For example, a cataloger can ask syft for all `package-lock.json` files in order to parse and raise up javascript packages 
-(see [how file globs](https://github.com/anchore/syft/tree/v0.70.0/syft/pkg/cataloger/javascript/cataloger.go#L16-L21) and
-[file parser functions](https://github.com/anchore/syft/tree/v0.70.0/syft/pkg/cataloger/javascript/cataloger.go#L16-L21) are used 
-for a quick example).
-
-From a high level catalogers have the following properties:
-
-- _They are independent from one another_. The java cataloger has no idea of the processes, assumptions, or results of the python cataloger, for example.
-
-- _They do not know what source is being analyzed_. Are we analyzing a local directory? an image? if so, the squashed representation or all layers? The catalogers do not know the answers to these questions. Only that there is an interface to query for file paths and contents from an underlying "source" being scanned.
-
-- _Packages created by the cataloger should not be mutated after they are created_. There is one exception made for adding CPEs to a package after the cataloging phase, but that will most likely be moved back into the cataloger in the future.
-
-
-Cataloger names should be unique and named with the following rules of thumb in mind:
-
-- Must end with `-cataloger`
-- Use lowercase letters, numbers, and hyphens only
-- Use hyphens to separate words
-- Catalogers for language ecosystems should start with the language name (e.g. `python-` for a cataloger that raises up python packages)
-- Distinct between when the cataloger is searching for evidence of installed packages vs declared packages. For example, there are currently two different gemspec-based catalogers, the `ruby-gemspec-cataloger` and `ruby-installed-gemspec-cataloger`, where the latter requires that the gemspec is found within a `specifications` directory (which means it was installed, not just at the root of a source repo).
-
-#### Building a new Cataloger
-
-Catalogers must fulfill the [`pkg.Cataloger` interface](https://github.com/anchore/syft/tree/v0.70.0/syft/pkg/cataloger.go) in order to add packages to the SBOM.
-All catalogers should be added to:
-- the [global list of catalogers](https://github.com/anchore/syft/blob/9995950c70e849f9921919faffbfcf46401f71f3/syft/pkg/cataloger/cataloger.go#L92-L125)
-- at least one source-specific list, today the two lists are [directory catalogers and image catalogers](https://github.com/anchore/syft/blob/9995950c70e849f9921919faffbfcf46401f71f3/syft/pkg/cataloger/cataloger.go#L39-L89)
-
-For reference, catalogers are [invoked within syft](https://github.com/anchore/syft/tree/v0.70.0/syft/pkg/cataloger/catalog.go#L41-L100) one after the other, and can be invoked in parallel.
-
-`generic.NewCataloger` is an abstraction syft used to make writing common components easier (see the [apkdb cataloger](https://github.com/anchore/syft/tree/v0.70.0/syft/pkg/cataloger/apkdb/cataloger.go) for example usage). 
-It takes the following information as input:
-- A `catalogerName` to identify the cataloger uniquely among all other catalogers.
-- Pairs of file globs as well as parser functions to parse those files. These parser functions return a slice of [`pkg.Package`](https://github.com/anchore/syft/blob/9995950c70e849f9921919faffbfcf46401f71f3/syft/pkg/package.go#L19) as well as a slice of [`artifact.Relationship`](https://github.com/anchore/syft/blob/9995950c70e849f9921919faffbfcf46401f71f3/syft/artifact/relationship.go#L31) to describe how the returned packages are related. See this [the apkdb cataloger parser function](https://github.com/anchore/syft/tree/v0.70.0/syft/pkg/cataloger/apkdb/parse_apk_db.go#L22-L102) as an example.
-
-Identified packages share a common `pkg.Package` struct so be sure that when the new cataloger is constructing a new package it is using the [`Package` struct](https://github.com/anchore/syft/tree/v0.70.0/syft/pkg/package.go#L16-L31).
-If you want to return more information than what is available on the `pkg.Package` struct then you can do so in the `pkg.Package.Metadata` section of the struct, which is unique for each [`pkg.Type`](https://github.com/anchore/syft/blob/v0.70.0/syft/pkg/type.go).
-See [the `pkg` package](https://github.com/anchore/syft/tree/v0.70.0/syft/pkg) for examples of the different metadata types that are supported today. 
-These are plugged into the `MetadataType` and `Metadata` fields in the above struct. `MetadataType` informs which type is being used. `Metadata` is an interface converted to that type.
-
-Finally, here is an example of where the package construction is done within the apk cataloger:
-- [Calling the APK package constructor from the parser function](https://github.com/anchore/syft/blob/v0.70.0/syft/pkg/cataloger/apkdb/parse_apk_db.go#L106)
-- [The APK package constructor itself](https://github.com/anchore/syft/tree/v0.70.0/syft/pkg/cataloger/apkdb/package.go#L12-L27)
-
-Interested in building a new cataloger? Checkout the [list of issues with the `new-cataloger` label](https://github.com/anchore/syft/issues?q=is%3Aopen+is%3Aissue+label%3Anew-cataloger+no%3Aassignee)!
-If you have questions about implementing a cataloger feel free to file an issue or reach out to us [on slack](https://anchore.com/slack)!
-
-
-#### Searching for files
-
-All catalogers are provided an instance of the [`file.Resolver`](https://github.com/anchore/syft/blob/v0.70.0/syft/source/file_resolver.go#L8) to interface with the image and search for files. The implementations for these 
-abstractions leverage [`stereoscope`](https://github.com/anchore/stereoscope) in order to perform searching. Here is a 
-rough outline how that works:
-
-1. a stereoscope `file.Index` is searched based on the input given (a path, glob, or MIME type). The index is relatively fast to search, but requires results to be filtered down to the files that exist in the specific layer(s) of interest. This is done automatically by the `filetree.Searcher` abstraction. This abstraction will fallback to searching directly against the raw `filetree.FileTree` if the index does not contain the file(s) of interest. Note: the `filetree.Searcher` is used by the `file.Resolver` abstraction.
-2. Once the set of files are returned from the `filetree.Searcher` the results are filtered down further to return the most unique file results. For example, you may have requested for files by a glob that returns multiple results. These results are filtered down to deduplicate by real files, so if a result contains two references to the same file, say one accessed via symlink and one accessed via the real path, then the real path reference is returned and the symlink reference is filtered out. If both were accessed by symlink then the first (by lexical order) is returned. This is done automatically by the `file.Resolver` abstraction.
-3. By the time results reach the `pkg.Cataloger` you are guaranteed to have a set of unique files that exist in the layer(s) of interest (relative to what the resolver supports).
-
-## Testing
-
-### Levels of testing
-
-- `unit`: The default level of test which is distributed throughout the repo are unit tests. Any `_test.go` file that 
-  does not reside somewhere within the `/test` directory is a unit test. Other forms of testing should be organized in 
-  the `/test` directory. These tests should focus on correctness of functionality in depth. % test coverage metrics 
-  only considers unit tests and no other forms of testing.
-
-- `integration`: located within `cmd/syft/internal/test/integration`, these tests focus on the behavior surfaced by the common library 
-  entrypoints from the `syft` package and make light assertions about the results surfaced. Additionally, these tests
-  tend to make diversity assertions for enum-like objects, ensuring that as enum values are added to a definition
-  that integration tests will automatically fail if no test attempts to use that enum value. For more details see 
-  the "Data diversity and freshness assertions" section below.
-
-- `cli`: located with in `test/cli`, these are tests that test the correctness of application behavior from a 
-  snapshot build. This should be used in cases where a unit or integration test will not do or if you are looking
-  for in-depth testing of code in the `cmd/` package (such as testing the proper behavior of application configuration,
-  CLI switches, and glue code before syft library calls).
-
-- `acceptance`: located within `test/compare` and `test/install`, these are smoke-like tests that ensure that application  
-  packaging and installation works as expected. For example, during release we provide RPM packages as a download 
-  artifact. We also have an accompanying RPM acceptance test that installs the RPM from a snapshot build and ensures the 
-  output of a syft invocation matches canned expected output. New acceptance tests should be added for each release artifact
-  and architecture supported (when possible).
-
-### Data diversity and freshness assertions
-
-It is important that tests against the codebase are flexible enough to begin failing when they do not cover "enough"
-of the objects under test. "Cover" in this case does not mean that some percentage of the code has been executed 
-during testing, but instead that there is enough diversity of data input reflected in testing relative to the
-definitions available.
-
-For instance, consider an enum-like value like so:
-```go
-type Language string
-
-const (
-  Java            Language = "java"
-  JavaScript      Language = "javascript"
-  Python          Language = "python"
-  Ruby            Language = "ruby"
-  Go              Language = "go"
-)
-```
-
-Say we have a test that exercises all the languages defined today:
-
-```go
-func TestCatalogPackages(t *testing.T) {
-  testTable := []struct {
-    // ... the set of test cases that test all languages
-  }
-  for _, test := range cases {
-    t.Run(test.name, func (t *testing.T) {
-      // use inputFixturePath and assert that syft.CatalogPackages() returns the set of expected Package objects
-      // ...
-    })
-  }
-}
-```
-
-Where each test case has a `inputFixturePath` that would result with packages from each language. This test is
-brittle since it does not assert that all languages were exercised directly and future modifications (such as 
-adding a new language) won't be covered by any test cases.
-
-To address this the enum-like object should have a definition of all objects that can be used in testing:
-
-```go
-type Language string
-
-// const( Java Language = ..., ... )
-
-var AllLanguages = []Language{
-	Java,
-	JavaScript,
-	Python,
-	Ruby,
-	Go,
-	Rust,
-}
-```
-
-Allowing testing to automatically fail when adding a new language:
-
-```go
-func TestCatalogPackages(t *testing.T) {
-  testTable := []struct {
-  	// ... the set of test cases that (hopefully) covers all languages
-  }
-
-  // new stuff...
-  observedLanguages := strset.New()
-  
-  for _, test := range cases {
-    t.Run(test.name, func (t *testing.T) {
-      // use inputFixturePath and assert that syft.CatalogPackages() returns the set of expected Package objects
-    	// ...
-    	
-    	// new stuff...
-    	for _, actualPkg := range actual {
-        observedLanguages.Add(string(actualPkg.Language))
-    	}
-    	
-    })
-  }
-
-   // new stuff...
-  for _, expectedLanguage := range pkg.AllLanguages {
-    if 	!observedLanguages.Contains(expectedLanguage) {
-      t.Errorf("failed to test language=%q", expectedLanguage)	
-    }
-  }
-}
-```
-
-This is a better test since it will fail when someone adds a new language but fails to write a test case that should
-exercise that new language. This method is ideal for integration-level testing, where testing correctness in depth 
-is not needed (that is what unit tests are for) but instead testing in breadth to ensure that units are well integrated.
-
-A similar case can be made for data freshness; if the quality of the results will be diminished if the input data
-is not kept up to date then a test should be written (when possible) to assert any input data is not stale.
-
-An example of this is the static list of licenses that is stored in `internal/spdxlicense` for use by the SPDX 
-presenters. This list is updated and published periodically by an external group and syft can grab and update this
-list by running `go generate ./...` from the root of the repo.
-
-An integration test has been written to grabs the latest license list version externally and compares that version
-with the version generated in the codebase. If they differ, the test fails, indicating to someone that there is an
-action needed to update it.
-
-**_The key takeaway is to try and write tests that fail when data assumptions change and not just when code changes.**_
-
-### Snapshot tests
-
-The format objects make a lot of use of "snapshot" testing, where you save the expected output bytes from a call into the
-git repository and during testing make a comparison of the actual bytes from the subject under test with the golden
-copy saved in the repo. The "golden" files are stored in the `test-fixtures/snapshot` directory relative to the go 
-package under test and should always be updated by invoking `go test` on the specific test file with a specific CLI 
-update flag provided.
-
-Many of the `Format` tests make use of this approach, where the raw SBOM report is saved in the repo and the test 
-compares that SBOM with what is generated from the latest presenter code. For instance, at the time of this writing 
-the CycloneDX presenter snapshots can be updated by running:
-
-```bash
-go test ./internal/formats -update-cyclonedx
-```
-
-These flags are defined at the top of the test files that have tests that use the snapshot files.
-
-Snapshot testing is only as good as the manual verification of the golden snapshot file saved to the repo! Be careful 
-and diligent when updating these files.
-
-

Dockerfile

@@ -1,29 +0,0 @@
-FROM gcr.io/distroless/static-debian11:debug@sha256:a0a404776dec98be120089ae42bbdfbe48c177921d856937d124d48eb8c0b951 AS build
-
-FROM scratch
-# needed for version check HTTPS request
-COPY --from=build /etc/ssl/certs/ca-certificates.crt /etc/ssl/certs/ca-certificates.crt
-
-# create the /tmp dir, which is needed for image content cache
-WORKDIR /tmp
-
-COPY syft /
-
-ARG BUILD_DATE
-ARG BUILD_VERSION
-ARG VCS_REF
-ARG VCS_URL
-
-LABEL org.opencontainers.image.created=$BUILD_DATE
-LABEL org.opencontainers.image.title="syft"
-LABEL org.opencontainers.image.description="CLI tool and library for generating a Software Bill of Materials from container images and filesystems"
-LABEL org.opencontainers.image.source=$VCS_URL
-LABEL org.opencontainers.image.revision=$VCS_REF
-LABEL org.opencontainers.image.vendor="Anchore, Inc."
-LABEL org.opencontainers.image.version=$BUILD_VERSION
-LABEL org.opencontainers.image.licenses="Apache-2.0"
-LABEL io.artifacthub.package.readme-url="https://raw.githubusercontent.com/anchore/syft/main/README.md"
-LABEL io.artifacthub.package.logo-url="https://user-images.githubusercontent.com/5199289/136844524-1527b09f-c5cb-4aa9-be54-5aa92a6086c1.png"
-LABEL io.artifacthub.package.license="Apache-2.0"
-
-ENTRYPOINT ["/syft"]

Dockerfile.debug

@@ -1,25 +0,0 @@
-FROM gcr.io/distroless/static-debian11:debug@sha256:a0a404776dec98be120089ae42bbdfbe48c177921d856937d124d48eb8c0b951
-
-# create the /tmp dir, which is needed for image content cache
-WORKDIR /tmp
-
-COPY syft /
-
-ARG BUILD_DATE
-ARG BUILD_VERSION
-ARG VCS_REF
-ARG VCS_URL
-
-LABEL org.opencontainers.image.created=$BUILD_DATE
-LABEL org.opencontainers.image.title="syft"
-LABEL org.opencontainers.image.description="CLI tool and library for generating a Software Bill of Materials from container images and filesystems"
-LABEL org.opencontainers.image.source=$VCS_URL
-LABEL org.opencontainers.image.revision=$VCS_REF
-LABEL org.opencontainers.image.vendor="Anchore, Inc."
-LABEL org.opencontainers.image.version=$BUILD_VERSION
-LABEL org.opencontainers.image.licenses="Apache-2.0"
-LABEL io.artifacthub.package.readme-url="https://raw.githubusercontent.com/anchore/syft/main/README.md"
-LABEL io.artifacthub.package.logo-url="https://user-images.githubusercontent.com/5199289/136844524-1527b09f-c5cb-4aa9-be54-5aa92a6086c1.png"
-LABEL io.artifacthub.package.license="Apache-2.0"
-
-ENTRYPOINT ["/syft"]

Makefile

@@ -1,46 +1,279 @@
-OWNER = anchore
-PROJECT = syft
+BIN = syft
+TEMPDIR = ./.tmp
+RESULTSDIR = $(TEMPDIR)/results
+COVER_REPORT = $(RESULTSDIR)/cover.report
+COVER_TOTAL = $(RESULTSDIR)/cover.total
+LINTCMD = $(TEMPDIR)/golangci-lint run --tests=false --config .golangci.yaml
+ACC_TEST_IMAGE = centos:8.2.2004
+ACC_DIR = ./test/acceptance
+BOLD := $(shell tput -T linux bold)
+PURPLE := $(shell tput -T linux setaf 5)
+GREEN := $(shell tput -T linux setaf 2)
+CYAN := $(shell tput -T linux setaf 6)
+RED := $(shell tput -T linux setaf 1)
+RESET := $(shell tput -T linux sgr0)
+TITLE := $(BOLD)$(PURPLE)
+SUCCESS := $(BOLD)$(GREEN)
+# the quality gate lower threshold for unit test total % coverage (by function statements)
+COVERAGE_THRESHOLD := 72
 
-TOOL_DIR = .tool
-BINNY = $(TOOL_DIR)/binny
-TASK = $(TOOL_DIR)/task
+## Build variables
+DISTDIR=./dist
+SNAPSHOTDIR=./snapshot
+GITTREESTATE=$(if $(shell git status --porcelain),dirty,clean)
+SNAPSHOT_CMD=$(shell realpath $(shell pwd)/$(SNAPSHOTDIR)/syft_linux_amd64/syft)
 
-.DEFAULT_GOAL := make-default
+ifeq "$(strip $(VERSION))" ""
+ override VERSION = $(shell git describe --always --tags --dirty)
+endif
 
-## Bootstrapping targets #################################
+## Variable assertions
 
-# note: we need to assume that binny and task have not already been installed
-$(BINNY):
-	@mkdir -p $(TOOL_DIR)
-	@curl -sSfL https://raw.githubusercontent.com/$(OWNER)/binny/main/install.sh | sh -s -- -b $(TOOL_DIR)
+ifndef TEMPDIR
+	$(error TEMPDIR is not set)
+endif
 
-# note: we need to assume that binny and task have not already been installed
-.PHONY: task
-$(TASK) task: $(BINNY)
-	@$(BINNY) install task -q
+ifndef RESULTSDIR
+	$(error RESULTSDIR is not set)
+endif
 
-.PHONY: ci-bootstrap-go
-ci-bootstrap-go:
+ifndef ACC_DIR
+	$(error ACC_DIR is not set)
+endif
+
+ifndef DISTDIR
+	$(error DISTDIR is not set)
+endif
+
+ifndef SNAPSHOTDIR
+	$(error SNAPSHOTDIR is not set)
+endif
+
+define title
+    @printf '$(TITLE)$(1)$(RESET)\n'
+endef
+
+## Tasks
+
+.PHONY: all
+all: clean static-analysis test ## Run all linux-based checks (linting, license check, unit, integration, and linux acceptance tests)
+	@printf '$(SUCCESS)All checks pass!$(RESET)\n'
+
+.PHONY: test
+test: unit validate-cyclonedx-schema integration acceptance-linux ## Run all tests (currently unit, integration, and linux acceptance tests)
+
+.PHONY: help
+help:
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "$(BOLD)$(CYAN)%-25s$(RESET)%s\n", $$1, $$2}'
+
+.PHONY: ci-bootstrap
+ci-bootstrap: bootstrap
+	DEBIAN_FRONTEND=noninteractive sudo apt update && sudo -E apt install -y bc jq libxml2-utils
+
+.PHONY: bootstrap
+bootstrap: ## Download and install all go dependencies (+ prep tooling in the ./tmp dir)
+	$(call title,Bootstrapping dependencies)
+	@pwd
+	# prep temp dirs
+	mkdir -p $(TEMPDIR)
+	mkdir -p $(RESULTSDIR)
+	# install go dependencies
 	go mod download
+	# install utilities
+	[ -f "$(TEMPDIR)/golangci" ] || curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(TEMPDIR)/ v1.26.0
+	[ -f "$(TEMPDIR)/bouncer" ] || curl -sSfL https://raw.githubusercontent.com/wagoodman/go-bouncer/master/bouncer.sh | sh -s -- -b $(TEMPDIR)/ v0.2.0
+	[ -f "$(TEMPDIR)/goreleaser" ] || curl -sfL https://install.goreleaser.com/github.com/goreleaser/goreleaser.sh | sh -s -- -b $(TEMPDIR)/ v0.140.0
 
-# this is a bootstrapping catch-all, where if the target doesn't exist, we'll ensure the tools are installed and then try again
-%:
-	make $(TASK)
-	$(TASK) $@
+.PHONY: static-analysis
+static-analysis: lint check-licenses
 
-## Shim targets #################################
+.PHONY: lint
+lint: ## Run gofmt + golangci lint checks
+	$(call title,Running linters)
+	# ensure there are no go fmt differences
+	@printf "files with gofmt issues: [$(shell gofmt -l -s .)]\n"
+	@test -z "$(shell gofmt -l -s .)"
 
-.PHONY: make-default
-make-default: $(TASK)
-	@# run the default task in the taskfile
-	@$(TASK)
+	# run all golangci-lint rules
+	$(LINTCMD)
 
-# for those of us that can't seem to kick the habit of typing `make ...` lets wrap the superior `task` tool
-TASKS := $(shell bash -c "test -f $(TASK) && $(TASK) -l | grep '^\* ' | cut -d' ' -f2 | tr -d ':' | tr '\n' ' '" ) $(shell bash -c "test -f $(TASK) && $(TASK) -l | grep 'aliases:' | cut -d ':' -f 3 | tr '\n' ' ' | tr -d ','")
+	# go tooling does not play well with certain filename characters, ensure the common cases don't result in future "go get" failures
+	$(eval MALFORMED_FILENAMES := $(shell find . | grep -e ':'))
+	@bash -c "[[ '$(MALFORMED_FILENAMES)' == '' ]] || (printf '\nfound unsupported filename characters:\n$(MALFORMED_FILENAMES)\n\n' && false)"
 
-.PHONY: $(TASKS)
-$(TASKS): $(TASK)
-	@$(TASK) $@
+.PHONY: lint-fix
+lint-fix: ## Auto-format all source code + run golangci lint fixers
+	$(call title,Running lint fixers)
+	gofmt -w -s .
+	$(LINTCMD) --fix
 
-help: $(TASK)
-	@$(TASK) -l
+.PHONY: check-licenses
+check-licenses:
+	$(TEMPDIR)/bouncer check
+
+.PHONY: validate-cyclonedx-schema
+validate-cyclonedx-schema:
+	cd schema/cyclonedx && make
+
+.PHONY: unit
+unit: fixtures ## Run unit tests (with coverage)
+	$(call title,Running unit tests)
+	go test -coverprofile $(COVER_REPORT) ./...
+	@go tool cover -func $(COVER_REPORT) | grep total |  awk '{print substr($$3, 1, length($$3)-1)}' > $(COVER_TOTAL)
+	@echo "Coverage: $$(cat $(COVER_TOTAL))"
+	@if [ $$(echo "$$(cat $(COVER_TOTAL)) >= $(COVERAGE_THRESHOLD)" | bc -l) -ne 1 ]; then echo "$(RED)$(BOLD)Failed coverage quality gate (> $(COVERAGE_THRESHOLD)%)$(RESET)" && false; fi
+
+.PHONY: integration
+integration: ## Run integration tests
+	$(call title,Running integration tests)
+	go test -v -tags=integration ./test/integration
+
+# note: this is used by CI to determine if the integration test fixture cache (docker image tars) should be busted
+integration-fingerprint:
+	find test/integration/test-fixtures/image-* -type f -exec md5sum {} + | awk '{print $1}' | sort | md5sum | tee test/integration/test-fixtures/tar-cache.fingerprint
+
+.PHONY: java-packages-fingerprint
+java-packages-fingerprint:
+	@cd syft/cataloger/java/test-fixtures/java-builds && \
+	make packages.fingerprint
+
+.PHONY: fixtures
+fixtures:
+	$(call title,Generating test fixtures)
+	cd syft/cataloger/java/test-fixtures/java-builds && make
+
+.PHONY: generate-json-schema
+generate-json-schema: clean-json-schema-examples integration ## Generate a new json schema for the json presenter, derived from integration test cases
+	docker run \
+		-i \
+		--rm \
+		-v $(shell pwd)/schema/json:/work \
+		-w /work \
+		python:3.8 \
+			bash -x -c "\
+				pip install -r requirements.txt && \
+				python generate.py \
+			"
+
+.PHONY: clear-test-cache
+clear-test-cache: ## Delete all test cache (built docker image tars)
+	find . -type f -wholename "**/test-fixtures/tar-cache/*.tar" -delete
+
+.PHONY: check-pipeline
+check-pipeline: ## Run local CircleCI pipeline locally (sanity check)
+	$(call title,Check pipeline)
+	# note: this is meant for local development & testing of the pipeline, NOT to be run in CI
+	mkdir -p $(TEMPDIR)
+	circleci config process .circleci/config.yml > .tmp/circleci.yml
+	circleci local execute -c .tmp/circleci.yml --job "Static Analysis"
+	circleci local execute -c .tmp/circleci.yml --job "Unit & Integration Tests (go-latest)"
+	@printf '$(SUCCESS)Pipeline checks pass!$(RESET)\n'
+
+proto:
+	protoc -I syft/plugin/proto/ syft/plugin/proto/cataloger.proto --go_out=plugins=grpc:syft/plugin/proto/
+
+.PHONY: build
+build: $(SNAPSHOTDIR) ## Build release snapshot binaries and packages
+
+$(SNAPSHOTDIR): ## Build snapshot release binaries and packages
+	$(call title,Building snapshot artifacts)
+	# create a config with the dist dir overridden
+	echo "dist: $(SNAPSHOTDIR)" > $(TEMPDIR)/goreleaser.yaml
+	cat .goreleaser.yaml >> $(TEMPDIR)/goreleaser.yaml
+
+	# build release snapshots
+	BUILD_GIT_TREE_STATE=$(GITTREESTATE) \
+	$(TEMPDIR)/goreleaser release --skip-publish --rm-dist --snapshot --config $(TEMPDIR)/goreleaser.yaml
+
+.PHONY: acceptance-mac
+acceptance-mac: $(SNAPSHOTDIR) ## Run acceptance tests on build snapshot binaries and packages (Mac)
+	$(call title,Running acceptance test: Run on Mac)
+	$(ACC_DIR)/mac.sh \
+			$(SNAPSHOTDIR) \
+			$(ACC_DIR) \
+			$(ACC_TEST_IMAGE) \
+			$(RESULTSDIR)
+
+.PHONY: acceptance-linux
+acceptance-linux: acceptance-test-deb-package-install acceptance-test-rpm-package-install ## Run acceptance tests on build snapshot binaries and packages (Linux)
+
+# note: this is used by CI to determine if the inline-scan report cache should be busted for the inline-compare tests
+.PHONY: compare-fingerprint
+compare-fingerprint:
+	find test/inline-compare/* -type f -exec md5sum {} + | grep -v '\-reports' | grep -v 'fingerprint' | awk '{print $1}' | sort | md5sum | tee test/inline-compare/inline-compare.fingerprint
+
+.PHONY: compare-snapshot
+compare-snapshot: $(SNAPSHOTDIR) ## Compare the reports of a run of a snapshot build of syft against inline-scan
+	chmod 755 $(SNAPSHOT_CMD)
+	@cd test/inline-compare && SYFT_CMD=$(SNAPSHOT_CMD) make
+
+.PHONY: compare
+compare:  ## Compare the reports of a run of a main-branch build of syft against inline-scan
+	@cd test/inline-compare && make
+
+.PHONY: acceptance-test-deb-package-install
+acceptance-test-deb-package-install: $(SNAPSHOTDIR)
+	$(call title,Running acceptance test: DEB install)
+	$(ACC_DIR)/deb.sh \
+			$(SNAPSHOTDIR) \
+			$(ACC_DIR) \
+			$(ACC_TEST_IMAGE) \
+			$(RESULTSDIR)
+
+.PHONY: acceptance-test-rpm-package-install
+acceptance-test-rpm-package-install: $(SNAPSHOTDIR)
+	$(call title,Running acceptance test: RPM install)
+	$(ACC_DIR)/rpm.sh \
+			$(SNAPSHOTDIR) \
+			$(ACC_DIR) \
+			$(ACC_TEST_IMAGE) \
+			$(RESULTSDIR)
+
+.PHONY: changlog
+changelog:
+	mkdir -p $(DISTDIR)
+	@docker run -it --rm  \
+		-v "$(shell pwd)":/usr/local/src/your-app ferrarimarco/github-changelog-generator \
+		--user anchore \
+		--project $(BIN) \
+		-t ${GITHUB_TOKEN} \
+		--no-pr-wo-labels \
+		--no-issues-wo-labels \
+		--unreleased-only \
+		--future-release $(VERSION)
+
+.PHONY: release
+release: clean-dist changelog ## Build and publish final binaries and packages
+	$(call title,Publishing release artifacts)
+	# create a config with the dist dir overridden
+	echo "dist: $(DISTDIR)" > $(TEMPDIR)/goreleaser.yaml
+	cat .goreleaser.yaml >> $(TEMPDIR)/goreleaser.yaml
+
+	# release
+	BUILD_GIT_TREE_STATE=$(GITTREESTATE) \
+	$(TEMPDIR)/goreleaser \
+		--rm-dist \
+		--config $(TEMPDIR)/goreleaser.yaml \
+		--release-notes <(cat CHANGELOG.md)
+
+	# verify checksum signatures
+	.github/scripts/verify-signature.sh "$(DISTDIR)"
+
+	# upload the version file that supports the application version update check (excluding pre-releases)
+	.github/scripts/update-version-file.sh "$(DISTDIR)" "$(VERSION)"
+
+.PHONY: clean
+clean: clean-dist clean-snapshot clean-json-schema-examples ## Remove previous builds and result reports
+	rm -rf $(RESULTSDIR)/*
+
+.PHONY: clean-snapshot
+clean-snapshot:
+	rm -rf $(SNAPSHOTDIR) $(TEMPDIR)/goreleaser.yaml
+
+.PHONY: clean-dist
+clean-dist:
+	rm -rf $(DISTDIR) $(TEMPDIR)/goreleaser.yaml
+
+.PHONY: clean-json-schema-examples
+clean-json-schema-examples:
+	rm -f schema/json/examples/*

README.md

@@ -1,497 +1,72 @@
-<p align="center">
-    <img src="https://user-images.githubusercontent.com/5199289/136844524-1527b09f-c5cb-4aa9-be54-5aa92a6086c1.png" width="271" alt="Cute pink owl syft logo">
-</p>
+# syft
 
-[![Validations](https://github.com/anchore/syft/actions/workflows/validations.yaml/badge.svg)](https://github.com/anchore/syft/actions/workflows/validations.yaml)
+[![CircleCI](https://circleci.com/gh/anchore/syft.svg?style=svg)](https://circleci.com/gh/anchore/syft)
 [![Go Report Card](https://goreportcard.com/badge/github.com/anchore/syft)](https://goreportcard.com/report/github.com/anchore/syft)
 [![GitHub release](https://img.shields.io/github/release/anchore/syft.svg)](https://github.com/anchore/syft/releases/latest)
-[![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/anchore/syft.svg)](https://github.com/anchore/syft)
 [![License: Apache-2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/anchore/syft/blob/main/LICENSE)
-[![Slack Invite](https://img.shields.io/badge/Slack-Join-blue?logo=slack)](https://anchore.com/slack)
 
-A CLI tool and Go library for generating a Software Bill of Materials (SBOM) from container images and filesystems. Exceptional for vulnerability detection when used with a scanner like [Grype](https://github.com/anchore/grype).
-
-### Join our community meetings!
-
-- Calendar: https://calendar.google.com/calendar/u/0/r?cid=Y182OTM4dGt0MjRtajI0NnNzOThiaGtnM29qNEBncm91cC5jYWxlbmRhci5nb29nbGUuY29t
-- Agenda: https://docs.google.com/document/d/1ZtSAa6fj2a6KRWviTn3WoJm09edvrNUp4Iz_dOjjyY8/edit?usp=sharing (join [this group](https://groups.google.com/g/anchore-oss-community) for write access)
-- All are welcome!
-
-For commercial support options with Syft or Grype, please [contact Anchore](https://get.anchore.com/contact/)
+A CLI tool and go library for generating a Software Bill of Materials (SBOM) from container images and filesystems.
 
 ![syft-demo](https://user-images.githubusercontent.com/590471/90277200-2a253000-de33-11ea-893f-32c219eea11a.gif)
 
-## Features
-- Generates SBOMs for container images, filesystems, archives, and more to discover packages and libraries
-- Supports OCI, Docker and [Singularity](https://github.com/sylabs/singularity) image formats
-- Linux distribution identification
-- Works seamlessly with [Grype](https://github.com/anchore/grype) (a fast, modern vulnerability scanner)
-- Able to create signed SBOM attestations using the [in-toto specification](https://github.com/in-toto/attestation/blob/main/spec/README.md)
-- Convert between SBOM formats, such as CycloneDX, SPDX, and Syft's own format.
+**Features**
+- Catalog container images and filesystems to discover packages and libraries.
+- Supports packages and libraries from various ecosystems (APK, DEB, RPM, Ruby Bundles, Python Wheel/Egg/requirements.txt, JavaScript NPM/Yarn, Java JAR/EAR/WAR, Jenkins plugins JPI/HPI, Go modules)
+- Linux distribution identification (supports Alpine, BusyBox, CentOS/RedHat, Debian/Ubuntu flavored distributions)
 
-### Supported Ecosystems
-
-- Alpine (apk)
-- C (conan)
-- C++ (conan)
-- Dart (pubs)
-- Debian (dpkg)
-- Dotnet (deps.json)
-- Objective-C (cocoapods)
-- Elixir (mix)
-- Erlang (rebar3)
-- Go (go.mod, Go binaries)
-- Haskell (cabal, stack)
-- Java (jar, ear, war, par, sar, nar, native-image)
-- JavaScript (npm, yarn)
-- Jenkins Plugins (jpi, hpi)
-- Linux kernel archives (vmlinz)
-- Linux kernel modules (ko)
-- Nix (outputs in /nix/store)
-- PHP (composer)
-- Python (wheel, egg, poetry, requirements.txt)
-- Red Hat (rpm)
-- Ruby (gem)
-- Rust (cargo.lock)
-- Swift (cocoapods, swift-package-manager)
-- Wordpress plugins
-
-## Installation
-
-**Note**: Currently, Syft is built only for Linux, macOS and Windows.
-
-### Recommended
-```bash
-curl -sSfL https://raw.githubusercontent.com/anchore/syft/main/install.sh | sh -s -- -b /usr/local/bin
-```
-
-... or, you can specify a release version and destination directory for the installation:
-
-```
-curl -sSfL https://raw.githubusercontent.com/anchore/syft/main/install.sh | sh -s -- -b <DESTINATION_DIR> <RELEASE_VERSION>
-```
-
-### Chocolatey
-
-The chocolatey distribution of syft is community maintained and not distributed by the anchore team
-
-```powershell
-choco install syft -y
-```
-
-### Scoop
-
-```powershell
-scoop install syft
-```
-
-### Homebrew
-```bash
-brew install syft
-```
-
-### Nix
-
-**Note**: Nix packaging of Syft is [community maintained](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/admin/syft/default.nix). Syft is available in the [stable channel](https://nixos.wiki/wiki/Nix_channels#The_official_channels) since NixOS `22.05`.
-
-```bash
-nix-env -i syft
-```
-
-... or, just try it out in an ephemeral nix shell:
-
-```bash
-nix-shell -p syft
-```
+> :warning: **This is pre-release software** and it may not work as expected. If you encounter an issue, please [let us know using the issue tracker](https://github.com/anchore/syft/issues).
 
 ## Getting started
 
-### SBOM
-
-To generate an SBOM for a container image:
-
-```bash
+To generate an SBOM for an image:
+```
 syft <image>
 ```
 
-The above output includes only software that is visible in the container (i.e., the squashed representation of the image). To include software from all image layers in the SBOM, regardless of its presence in the final image, provide `--scope all-layers`:
+The above output includes only software that is visible in the container (i.e., the squashed representation of the image).
+To include software from all image layers in the SBOM, regardless of its presence in the final image, provide `--scope all-layers`:
 
-```bash
+```
 syft <image> --scope all-layers
 ```
 
-### Supported sources
-
-Syft can generate an SBOM from a variety of sources including images, files, directories, and archives. Syft will attempt to
-determine the type of source based on provided input, for example:
-
-```bash
-# catalog a container image archive (from the result of `docker image save ...`, `podman save ...`, or `skopeo copy` commands)
-syft path/to/image.tar
-
-# catalog a Singularity Image Format (SIF) container
-syft path/to/image.sif
+Syft can generate a SBOM from a variety of sources:
+```
+# catalog a docker image tar (from the result of "docker image save ... -o image.tar" command)
+syft docker-archive://path/to/image.tar
 
 # catalog a directory
-syft path/to/dir
+syft dir://path/to/dir
 ```
 
-To explicitly specify the source behavior, use the `--from` flag. Allowable options are:
-
+By default Syft shows a summary table, however, more detailed `text` and `json` formats are also available.
 ```
-docker             use images from the Docker daemon
-podman             use images from the Podman daemon
-containerd         use images from the Containerd daemon
-docker-archive     use a tarball from disk for archives created from "docker save"
-oci-archive        use a tarball from disk for OCI archives (from Skopeo or otherwise)
-oci-dir            read directly from a path on disk for OCI layout directories (from Skopeo or otherwise)
-singularity        read directly from a Singularity Image Format (SIF) container on disk
-dir                read directly from a path on disk (any directory)
-file               read directly from a path on disk (any single file)
-registry           pull image directly from a registry (no container runtime required)
-```
-If a source is not provided and Syft identifies the input as a potential image reference, Syft will attempt to resolve it using:
-the Docker, Podman, and Containerd daemons followed by direct registry access, in that order.
-
-This default behavior can be overridden with the `default-image-pull-source` configuration option (See [Configuration](#configuration) for more details).
-
-
-### File selection
-
-By default, Syft will catalog file details and digests for files that are owned by discovered packages. You can change this behavior by using the `SYFT_FILE_METADATA_SELECTION` environment variable or the `file.metadata.selection` configuration option. The options are:
-
-- `all`: capture all files from the search space
-- `owned-by-package`: capture only files owned by packages (default)
-- `none`: disable capturing any file information
-
-
-### Package cataloger selection
-
-#### Concepts
-
-> [!IMPORTANT]  
-> Syft uses a different set of catalogers by default when scanning files directly than it does when scanning images
-
-The catalogers for an image scan assumes that package installation steps have already been completed. For example, Syft will identify Python packages that have egg or wheel metadata files under a `site-packages` directory, since this is how the canonical tooling `pip` installs python packages.
-
-The catalogers for a directory scan will look for installed software as well as declared dependencies that are not necessarily installed. For example, dependencies listed in a Python `requirements.txt`.
-
-This default set of catalogers being dynamic is critical as this allows Syft to be used in a variety of contexts while still generating accurate SBOMs.
-Overriding the set of default catalogers is not recommended for most purposes, however, is possible if needed.
-
-Catalogers can be referenced in two different ways:
-- *by name*: the exact cataloger name (e.g. `java-pom-cataloger` or `java-archive-cataloger`)
-- *by tag*: a tag that is associated with a cataloger (e.g. `java`)
-
-Syft can take lists of references on the CLI or in the application configuration to define which catalogers to use.
-
-You can **set** the list of catalogers explicitly to use with the `--override-default-catalogers` CLI flag, accepting a comma-separated list of cataloger names or tags.
-
-You can also **add** to, **remove** from, or **sub-select** catalogers to use within the default set of catalogers by using the `--select-catalogers` CLI flag.
-  - To **sub-select** catalogers simply provide a tag (e.g. `--select-catalogers TAG`). Catalogers will always be selected from the default set of catalogers (e.g. `--select-catalogers java,go` will select all the `java` catalogers in the default set and all the `go` catalogers in the default set).
-  - To **add** a cataloger prefix the cataloger name with `+` (e.g. `--select-catalogers +NAME`). Added catalogers will _always be added_ regardless of removals, filtering, or other defaults.
-  - To **remove** a cataloger prefix the cataloger name or tag with `-` (e.g. `--select-catalogers -NAME_OR_TAG`). Catalogers are removed from the set of default catalogers after processing any sub-selections.
-
-These rules and the dynamic default cataloger sets approximates to the following logic:
-
-```
-image_catalogers = all_catalogers AND catalogers_tagged("image")
-
-directory_catalogers = all_catalogers AND catalogers_tagged("directory")
-
-default_catalogers = image_catalogers OR directory_catalogers
-
-sub_selected_catalogers = default_catalogers INTERSECT catalogers_tagged(TAG) [ UNION sub_selected_catalogers ... ]
-
-base_catalogers = default_catalogers OR sub_selected_catalogers
-
-final_set = (base_catalogers SUBTRACT removed_catalogers) UNION added_catalogers
+syft <image> -o json
+syft <image> -o text
 ```
 
+## Installation
 
-#### Examples
-
-Only scan for python related packages with catalogers appropriate for the source type (image or directory):
+**Recommended**
 ```bash
-syft <some container image> --select-catalogers "python"
-# results in the following catalogers being used:
-# - python-installed-package-cataloger
+# install the latest version to /usr/local/bin
+curl -sSfL https://raw.githubusercontent.com/anchore/syft/main/install.sh | sh -s -- -b /usr/local/bin
+
+# install a specific version into a specific dir
+curl -sSfL https://raw.githubusercontent.com/anchore/syft/main/install.sh | sh -s <RELEASE_VERSION> -b <SOME_BIN_PATH>
 ```
 
-Same command, but the set of catalogers changes based on what is being analyzed (in this case a directory):
+**macOS**
 ```bash
-syft <a directory> --select-catalogers "python"
-# results in the following catalogers being used:
-# - python-installed-package-cataloger
-# - python-package-cataloger
+brew tap anchore/syft
+brew install syft
 ```
 
-Use the default set of catalogers and add a cataloger to the set:
+You may experience a "macOS cannot verify app is free from malware" error upon running Syft because it is not yet signed and notarized. You can override this using `xattr`.
 ```bash
-syft ... --select-catalogers "+sbom-cataloger"
+xattr -rd com.apple.quarantine syft
 ```
 
-Use the default set of catalogers but remove any catalogers that deal with RPMs:
-```bash
-syft ... --select-catalogers "-rpm"
-```
-
-Only scan with catalogers that:
-- are tagged with "go"
-- always use the sbom-cataloger
-- are appropriate for the source type (image or directory)
-
-```bash
-syft <some container image> --select-catalogers "go,+sbom-cataloger"
-# results in the following catalogers being used:
-# - go-module-binary-cataloger
-# - sbom-cataloger
-```
-
-Scan with all catalogers that deal with binary analysis, regardless of the source type:
-```bash
-syft ... --override-default-catalogers "binary"
-# results in the following catalogers being used:
-# - binary-cataloger
-# - cargo-auditable-binary-cataloger
-# - dotnet-portable-executable-cataloger
-# - go-module-binary-cataloger
-```
-
-Only scan with the specific `go-module-binary-cataloger` and `go-module-file-cataloger` catalogers:
-```bash
-syft ... --override-default-catalogers "go-module-binary-cataloger,go-module-file-cataloger"
-```
-
-
-### Excluding file paths
-
-Syft can exclude files and paths from being scanned within a source by using glob expressions
-with one or more `--exclude` parameters:
-```
-syft <source> --exclude './out/**/*.json' --exclude /etc
-```
-**Note:** in the case of _image scanning_, since the entire filesystem is scanned it is
-possible to use absolute paths like `/etc` or `/usr/**/*.txt` whereas _directory scans_
-exclude files _relative to the specified directory_. For example: scanning `/usr/foo` with
-`--exclude ./package.json` would exclude `/usr/foo/package.json` and `--exclude '**/package.json'`
-would exclude all `package.json` files under `/usr/foo`. For _directory scans_,
-it is required to begin path expressions with `./`, `*/`, or `**/`, all of which
-will be resolved _relative to the specified scan directory_. Keep in mind, your shell
-may attempt to expand wildcards, so put those parameters in single quotes, like:
-`'**/*.json'`.
-
-### Output formats
-
-The output format for Syft is configurable as well using the
-`-o` (or `--output`) option:
-
-```
-syft <image> -o <format>
-```
-
-Where the `formats` available are:
-- `syft-json`: Use this to get as much information out of Syft as possible!
-- `syft-text`: A row-oriented, human-and-machine-friendly output.
-- `cyclonedx-xml`: A XML report conforming to the [CycloneDX 1.4 specification](https://cyclonedx.org/specification/overview/).
-- `cyclonedx-json`: A JSON report conforming to the [CycloneDX 1.4 specification](https://cyclonedx.org/specification/overview/).
-- `spdx-tag-value`: A tag-value formatted report conforming to the [SPDX 2.3 specification](https://spdx.github.io/spdx-spec/v2.3/).
-- `spdx-tag-value@2.2`: A tag-value formatted report conforming to the [SPDX 2.2 specification](https://spdx.github.io/spdx-spec/v2.2.2/).
-- `spdx-json`: A JSON report conforming to the [SPDX 2.3 JSON Schema](https://github.com/spdx/spdx-spec/blob/v2.3/schemas/spdx-schema.json).
-- `spdx-json@2.2`: A JSON report conforming to the [SPDX 2.2 JSON Schema](https://github.com/spdx/spdx-spec/blob/v2.2/schemas/spdx-schema.json).
-- `github-json`: A JSON report conforming to GitHub's dependency snapshot format.
-- `syft-table`: A columnar summary (default).
-- `template`: Lets the user specify the output format. See ["Using templates"](#using-templates) below.
-
-## Using templates
-
-Syft lets you define custom output formats, using [Go templates](https://pkg.go.dev/text/template) relative to the Syft JSON output. Here's how it works:
-
-- Define your format as a Go template, and save this template as a file.
-
-- Set the output format to "template" (`-o template`).
-
-- Specify the path to the template file (`-t ./path/to/custom.template`).
-
-- Syft's template processing uses the same data models as the `syft-json` output format — so if you're wondering what data is available as you author a template, you can use the output from `syft <image> -o syft-json` as a reference.
-
-**Example:** You could make Syft output data in CSV format by writing a Go template that renders CSV data and then running `syft <image> -o template -t ~/path/to/csv.tmpl`.
-
-Here's what the `csv.tmpl` file might look like:
-```gotemplate
-"Package","Version Installed", "Found by"
-{{- range .artifacts}}
-"{{.name}}","{{.version}}","{{.foundBy}}"
-{{- end}}
-```
-
-Which would produce output like:
-```text
-"Package","Version Installed","Found by"
-"alpine-baselayout","3.2.0-r20","apkdb-cataloger"
-"alpine-baselayout-data","3.2.0-r20","apkdb-cataloger"
-"alpine-keys","2.4-r1","apkdb-cataloger"
-...
-```
-
-Syft also includes a vast array of utility templating functions from [sprig](http://masterminds.github.io/sprig/) apart from the default Golang [text/template](https://pkg.go.dev/text/template#hdr-Functions) to allow users to customize the output format.
-
-Lastly, Syft has custom templating functions defined in `./syft/format/template/encoder.go` to help parse the passed-in JSON structs.
-
-> [!NOTE]
-> If you have templates being used before Syft v0.102.0 that are no longer working. This is because templating keys were relative to the internal go structs before this version whereas now the keys are relative to the Syft JSON output. To get the legacy behavior back you can set the `format.template.legacy` option to `true` in your configuration.
-
-## Multiple outputs
-
-Syft can also output _multiple_ files in differing formats by appending
-`=<file>` to the option, for example to output Syft JSON and SPDX JSON:
-
-```shell
-syft <image> -o syft-json=sbom.syft.json -o spdx-json=sbom.spdx.json
-```
-
-## Private Registry Authentication
-
-### Local Docker Credentials
-When a container runtime is not present, Syft can still utilize credentials configured in common credential sources (such as `~/.docker/config.json`). It will pull images from private registries using these credentials. The config file is where your credentials are stored when authenticating with private registries via some command like `docker login`. For more information see the `go-containerregistry` [documentation](https://github.com/google/go-containerregistry/tree/main/pkg/authn).
-
-An example `config.json` looks something like this:
-```json
-{
-	"auths": {
-		"registry.example.com": {
-			"username": "AzureDiamond",
-			"password": "hunter2"
-		}
-	}
-}
-```
-
-You can run the following command as an example. It details the mount/environment configuration a container needs to access a private registry:
-
-```
-docker run -v ./config.json:/config/config.json -e "DOCKER_CONFIG=/config" anchore/syft:latest  <private_image>
-```
-
-### Docker Credentials in Kubernetes
-
-Here's a simple workflow to mount this config file as a secret into a container on Kubernetes.
-
-1. Create a secret. The value of `config.json` is important. It refers to the specification detailed [here](https://github.com/google/go-containerregistry/tree/main/pkg/authn#the-config-file). Below this section is the `secret.yaml` file that the pod configuration will consume as a volume. The key `config.json` is important. It will end up being the name of the file when mounted into the pod.
-
-    ```yaml
-    # secret.yaml
-
-    apiVersion: v1
-    kind: Secret
-    metadata:
-      name: registry-config
-      namespace: syft
-    data:
-      config.json: <base64 encoded config.json>
-    ```
-
-   `kubectl apply -f secret.yaml`
-
-
-2. Create your pod running syft. The env `DOCKER_CONFIG` is important because it advertises where to look for the credential file. In the below example, setting `DOCKER_CONFIG=/config` informs syft that credentials can be found at `/config/config.json`. This is why we used `config.json` as the key for our secret. When mounted into containers the secrets' key is used as the filename. The `volumeMounts` section mounts our secret to `/config`. The `volumes` section names our volume and leverages the secret we created in step one.
-
-    ```yaml
-    # pod.yaml
-
-    apiVersion: v1
-    kind: Pod
-    metadata:
-      name: syft-k8s-usage
-    spec:
-      containers:
-        - image: anchore/syft:latest
-          name: syft-private-registry-demo
-          env:
-            - name: DOCKER_CONFIG
-              value: /config
-          volumeMounts:
-          - mountPath: /config
-            name: registry-config
-            readOnly: true
-          args:
-            - <private_image>
-      volumes:
-      - name: registry-config
-        secret:
-          secretName: registry-config
-    ```
-
-   `kubectl apply -f pod.yaml`
-
-
-3. The user can now run `kubectl logs syft-private-registry-demo`. The logs should show the Syft analysis for the `<private_image>` provided in the pod configuration.
-
-Using the above information, users should be able to configure private registry access without having to do so in the `grype` or `syft` configuration files.  They will also not be dependent on a Docker daemon, (or some other runtime software) for registry configuration and access.
-
-## Format conversion (experimental)
-
-The ability to convert existing SBOMs means you can create SBOMs in different formats quickly, without the need to regenerate the SBOM from scratch, which may take significantly more time.
-
-```
-syft convert <ORIGINAL-SBOM-FILE> -o <NEW-SBOM-FORMAT>[=<NEW-SBOM-FILE>]
-```
-
-This feature is experimental and data might be lost when converting formats. Packages are the main SBOM component easily transferable across formats, whereas files and relationships, as well as other information Syft doesn't support, are more likely to be lost.
-
-We support formats with wide community usage AND good encode/decode support by Syft. The supported formats are:
-- Syft JSON (```-o syft-json```)
-- SPDX 2.2 JSON (```-o spdx-json```)
-- SPDX 2.2 tag-value (```-o spdx-tag-value```)
-- CycloneDX 1.4 JSON (```-o cyclonedx-json```)
-- CycloneDX 1.4 XML (```-o cyclonedx-xml```)
-
-Conversion example:
-```sh
-syft alpine:latest -o syft-json=sbom.syft.json # generate a syft SBOM
-syft convert sbom.syft.json -o cyclonedx-json=sbom.cdx.json  # convert it to CycloneDX
-```
-
-## Attestation (experimental)
-### Keyless support
-Syft supports generating attestations using cosign's [keyless](https://github.com/sigstore/cosign/blob/main/KEYLESS.md) signatures.
-
-Note: users need to have >= v1.12.0 of cosign installed for this command to function
-
-To use this feature with a format like CycloneDX json simply run:
-```
-syft attest --output cyclonedx-json <IMAGE WITH OCI WRITE ACCESS>
-```
-This command will open a web browser and allow the user to authenticate their OIDC identity as the root of trust for the attestation (Github, Google, Microsoft).
-
-After authenticating, Syft will upload the attestation to the OCI registry specified by the image that the user has write access to.
-
-You will need to make sure your credentials are configured for the OCI registry you are uploading to so that the attestation can write successfully.
-
-Users can then verify the attestation(or any image with attestations) by running:
-```
-COSIGN_EXPERIMENTAL=1 cosign verify-attestation <IMAGE_WITH_ATTESTATIONS>
-```
-
-Users should see that the uploaded attestation claims are validated, the claims exist within the transparency log, and certificates on the attestations were verified against [fulcio](https://github.com/SigStore/fulcio).
-There will also be a printout of the certificates subject `<user identity>` and the certificate issuer URL: `<provider of user identity (Github, Google, Microsoft)>`:
-```
-Certificate subject:  test.email@testdomain.com
-Certificate issuer URL:  https://accounts.google.com
-```
-
-### Local private key support
-
-To generate an SBOM attestation for a container image using a local private key:
-```
-syft attest --output [FORMAT] --key [KEY] [SOURCE] [flags]
-```
-
-The above output is in the form of the [DSSE envelope](https://github.com/secure-systems-lab/dsse/blob/master/envelope.md#dsse-envelope).
-The payload is a base64 encoded `in-toto` statement with the generated SBOM as the predicate. For details on workflows using this command see [here](#adding-an-sbom-to-an-image-as-an-attestation-using-syft).
-
-
-
 ## Configuration
 
 Configuration search paths:
@@ -504,368 +79,31 @@ Configuration search paths:
 Configuration options (example values are the default):
 
 ```yaml
-# the output format(s) of the SBOM report (options: syft-table, syft-text, syft-json, spdx-json, ...)
-# to specify multiple output files in differing formats, use a list:
-# output:
-#   - "syft-json=<syft-json-output-file>"
-#   - "spdx-json=<spdx-json-output-file>"
-# SYFT_OUTPUT env var / -o, --output flags
-output: 
-  - "syft-table"
+# same as -o ; the output format of the SBOM report (options: table, text, json)
+output: "table"
 
-# suppress all output (except for the SBOM report)
-# SYFT_QUIET env var / -q flag
-quiet: false
-
-# enable/disable checking for application updates on startup
-# SYFT_CHECK_FOR_APP_UPDATE env var 
-check-for-app-update: true
-
-# maximum number of workers used to process the list of package catalogers in parallel
-parallelism: 1
-
-# a list of globs to exclude from scanning, for example:
-# exclude:
-#   - "/etc/**"
-#   - "./out/**/*.json"
-# SYFT_EXCLUDE env var / --exclude flag
-exclude: []
-
-# os and/or architecture to use when referencing container images (e.g. "windows/armv6" or "arm64")
-# SYFT_PLATFORM env var / --platform flag
-platform: ""
-
-# the search space to look for file and package data (options: all-layers, squashed)
-# SYFT_SCOPE env var
+# same as -s ; the search space to look for packages (options: all-layers, squashed)
 scope: "squashed"
 
-# set the list of package catalogers to use when generating the SBOM
-# default = empty (cataloger set determined automatically by the source type [image or file/directory])
-# Use `syft cataloger list` for a list of catalogers you can specify
-# DEPRECATED: please use default-catalogers and select-catalogers configuration options instead
-# SYFT_CATALOGERS env var / --catalogers flag
-catalogers:
-
-# set the base set of catalogers to use (defaults to 'image' or 'directory' depending on the scan source)
-# SYFT_DEFAULT_CATALOGERS env var / --override-default-catalogers flag
-default-catalogers: []
-
-# add, remove, and filter the catalogers to be used
-# SYFT_SELECT_CATALOGERS env var / --select-catalogers flag;
-select-catalogers: []
-
-# all format configuration
-format:
- 
-  # default value for all formats that support the "pretty" option (default is unset)
-  # SYFT_FORMAT_PRETTY env var
-  pretty: 
-
-  # all syft-json format options
-  json:
-
-    # include space indention and newlines (inherits default value from 'format.pretty' or 'false' if parent is unset)
-    # note: inherits default value from 'format.pretty' or 'false' if parent is unset
-    # SYFT_FORMAT_JSON_PRETTY env var
-    pretty: false
-    
-    # transform any syft-json output to conform to an approximation of the v11.0.1 schema. This includes:
-    # - using the package metadata type names from before v12 of the JSON schema (changed in https://github.com/anchore/syft/pull/1983)
-    #
-    # Note: this will still include package types and fields that were added at or after json schema v12. This means
-    # that output might not strictly be json schema v11 compliant, however, for consumers that require time to port
-    # over to the final syft 1.0 json output this option can be used to ease the transition.
-    #
-    # Note: long term support for this option is not guaranteed (it may change or break at any time).
-    # SYFT_FORMAT_JSON_LEGACY env var
-    legacy: false
-
-  # all template format options
-  template:
-    # path to the template file to use when rendering the output with the `template` output format. 
-    # Note that all template paths are based on the current syft-json schema.
-    # SYFT_FORMAT_TEMPLATE_PATH env var / -t flag 
-    path: ""
-    
-    # if true, uses the go structs for the syft-json format for templating. 
-    # if false, uses the syft-json output for templating (which follows the syft JSON schema exactly).
-    #
-    # Note: long term support for this option is not guaranteed (it may change or break at any time).
-    # SYFT_FORMAT_TEMPLATE_LEGACY env var
-    legacy: false
-
-  # all spdx-json format options
-  spdx-json:
-
-    # include space indention and newlines
-    # note: inherits default value from 'format.pretty' or 'false' if parent is unset
-    # SYFT_FORMAT_SPDX_JSON_PRETTY env var
-    pretty: false
-
-  # all cyclonedx-json format options
-  cyclonedx-json:
-
-     # include space indention and newlines
-     # note: inherits default value from 'format.pretty' or 'false' if parent is unset
-     # SYFT_FORMAT_CYCLONEDX_JSON_PRETTY env var
-     pretty: false
-
-  # all cyclonedx-xml format options
-  cyclonedx-xml:
-
-     # include space indention
-     # note: inherits default value from 'format.pretty' or 'false' if parent is unset
-     # SYFT_FORMAT_CYCLONEDX_XML_PRETTY env var
-     pretty: false
-
-
-file:
-
-   metadata: 
-      # select which files should be captured by the file-metadata cataloger and included in the SBOM. 
-      # Options include:
-      #  - "all": capture all files from the search space
-      #  - "owned-by-package": capture only files owned by packages
-      #  - "none", "": do not capture any files
-      # SYFT_FILE_METADATA_SELECTION env var
-      selection: "owned-by-package"
-
-      # the file digest algorithms to use when cataloging files (options: "md5", "sha1", "sha224", "sha256", "sha384", "sha512")
-      # SYFT_FILE_METADATA_DIGESTS env var
-      digests:
-      - "sha256"
-      - "sha1"
-
-   # capture the contents of select files in the SBOM
-   content:
-      # skip searching a file entirely if it is above the given size (default = 1MB; unit = bytes)
-      # SYFT_FILE_CONTENT_SKIP_FILES_ABOVE_SIZE env var
-      skip-files-above-size: 1048576
-   
-      # file globs for the cataloger to match on
-      # SYFT_FILE_CONTENT_GLOBS env var
-      globs: []
-
-
-# cataloging packages is exposed through the packages and power-user subcommands
-package:
-   
-  # search within archives that do contain a file index to search against (zip)
-  # note: for now this only applies to the java package cataloger
-  # SYFT_PACKAGE_SEARCH_INDEXED_ARCHIVES env var
-  search-indexed-archives: true
-
-  # search within archives that do not contain a file index to search against (tar, tar.gz, tar.bz2, etc)
-  # note: enabling this may result in a performance impact since all discovered compressed tars will be decompressed
-  # note: for now this only applies to the java package cataloger
-  # SYFT_PACKAGE_SEARCH_UNINDEXED_ARCHIVES env var
-  search-unindexed-archives: false
-
-  # allows users to exclude synthetic binary packages from the sbom
-  # these packages are removed if an overlap with a non-synthetic package is found
-  # SYFT_PACKAGE_EXCLUDE_BINARY_OVERLAP_BY_OWNERSHIP env var
-  exclude-binary-overlap-by-ownership: true
-
-
-golang:
-   # search for go package licences in the GOPATH of the system running Syft, note that this is outside the
-   # container filesystem and potentially outside the root of a local directory scan
-   # SYFT_GOLANG_SEARCH_LOCAL_MOD_CACHE_LICENSES env var
-   search-local-mod-cache-licenses: false
-   
-   # specify an explicit go mod cache directory, if unset this defaults to $GOPATH/pkg/mod or $HOME/go/pkg/mod
-   # SYFT_GOLANG_LOCAL_MOD_CACHE_DIR env var
-   local-mod-cache-dir: ""
-
-   # search for go package licences by retrieving the package from a network proxy
-   # SYFT_GOLANG_SEARCH_REMOTE_LICENSES env var
-   search-remote-licenses: false
-
-   # remote proxy to use when retrieving go packages from the network,
-   # if unset this defaults to $GOPROXY followed by https://proxy.golang.org
-   # SYFT_GOLANG_PROXY env var
-   proxy: ""
-
-   # specifies packages which should not be fetched by proxy
-   # if unset this defaults to $GONOPROXY
-   # SYFT_GOLANG_NOPROXY env var
-   no-proxy: ""
-  
-   # the go main module version discovered from binaries built with the go compiler will
-   # always show (devel) as the version. Use these options to control heuristics to guess
-   # a more accurate version from the binary.
-   main-module-version:
-      
-      # look for LD flags that appear to be setting a version (e.g. -X main.version=1.0.0)
-      # SYFT_GOLANG_MAIN_MODULE_VERSION_FROM_LD_FLAGS env var
-      from-ld-flags: true
-      
-      # use the build settings (e.g. vcs.version & vcs.time) to craft a v0 pseudo version 
-      # (e.g. v0.0.0-20220308212642-53e6d0aaf6fb) when a more accurate version cannot be found otherwise.
-      # SYFT_GOLANG_MAIN_MODULE_VERSION_FROM_BUILD_SETTINGS env var
-      from-build-settings: true
-      
-      # search for semver-like strings in the binary contents.
-      # SYFT_GOLANG_MAIN_MODULE_VERSION_FROM_CONTENTS env var
-      from-contents: true
-  
-java:
-   maven-url: "https://repo1.maven.org/maven2"
-   max-parent-recursive-depth: 5
-   # enables Syft to use the network to fill in more detailed information about artifacts
-   # currently this enables searching maven-url for license data
-   # when running across pom.xml files that could have more information, syft will
-   # explicitly search maven for license information by querying the online pom when this is true
-   # this option is helpful for when the parent pom has more data,
-   # that is not accessible from within the final built artifact
-   use-network: false
-
-linux-kernel:
-   # whether to catalog linux kernel modules found within lib/modules/** directories
-   # SYFT_LINUX_KERNEL_CATALOG_MODULES env var
-   catalog-modules: true
-
-python:
-   # when running across entries in requirements.txt that do not specify a specific version 
-   # (e.g. "sqlalchemy >= 1.0.0, <= 2.0.0, != 3.0.0, <= 3.0.0"), attempt to guess what the version could
-   # be based on the version requirements specified (e.g. "1.0.0"). When enabled the lowest expressible version 
-   # when given an arbitrary constraint will be used (even if that version may not be available/published).
-   guess-unpinned-requirements: false
-
-javascript:
-  search-remote-licenses: false
-  npm-base-url: "https://registry.npmjs.org"
-
-
-# configuration for the source that the SBOM is generated from (e.g. a file, directory, or container image)
-source:
-  # alias name for the source
-  # SYFT_SOURCE_NAME env var / --source-name flag
-  name: ""
-   
-  # alias version for the source
-  # SYFT_SOURCE_VERSION env var / --source-version flag
-  version: ""
-
-  # base directory for scanning, no links will be followed above this directory, and all paths will be 
-  # reported relative to this directory
-  # SYFT_SOURCE_BASE_PATH env var
-  base-path: ''
-
-   # options affecting the file source type
-  file:
-    # the file digest algorithms to use on the scanned file (options: "md5", "sha1", "sha224", "sha256", "sha384", "sha512")
-    digests: 
-     - "sha256"
-
-  image:
-     
-    # allows users to specify which image source should be used to generate the sbom
-    # valid values are: registry, docker, podman
-    # SYFT_SOURCE_IMAGE_DEFAULT_PULL_SOURCE env var
-    default-pull-source: ""
-
-
-# options when pulling directly from a registry via the "registry:" or "containerd:" scheme
-registry:
-  # skip TLS verification when communicating with the registry
-  # SYFT_REGISTRY_INSECURE_SKIP_TLS_VERIFY env var
-  insecure-skip-tls-verify: false
-
-  # use http instead of https when connecting to the registry
-  # SYFT_REGISTRY_INSECURE_USE_HTTP env var
-  insecure-use-http: false
-
-  # filepath to a CA certificate (or directory containing *.crt, *.cert, *.pem) used to generate the client certificate
-  # SYFT_REGISTRY_CA_CERT env var
-  ca-cert: ""
-
-  # credentials for specific registries
-  auth:
-      # the URL to the registry (e.g. "docker.io", "localhost:5000", etc.)
-      # SYFT_REGISTRY_AUTH_AUTHORITY env var
-    - authority: ""
-
-      # SYFT_REGISTRY_AUTH_USERNAME env var
-      username: ""
-
-      # SYFT_REGISTRY_AUTH_PASSWORD env var
-      password: ""
-
-      # note: token and username/password are mutually exclusive
-      # SYFT_REGISTRY_AUTH_TOKEN env var
-      token: ""
-
-      # filepath to the client certificate used for TLS authentication to the registry
-      # SYFT_REGISTRY_AUTH_TLS_CERT env var
-      tls-cert: ""
-
-      # filepath to the client key used for TLS authentication to the registry
-      # SYFT_REGISTRY_AUTH_TLS_KEY env var
-      tls-key: ""
-    
-    # - ... # note, more credentials can be provided via config file only (not env vars)
-
-# generate an attested SBOM
-attest:
-  # path to the private key file to use for attestation
-  # SYFT_ATTEST_KEY env var
-  key: "cosign.key"
-
-  # password to decrypt to given private key
-  # SYFT_ATTEST_PASSWORD env var, additionally responds to COSIGN_PASSWORD
-  password: ""
+# same as -q ; suppress all output (except for the SBOM report)
+quiet: false
 
 log:
   # use structured logging
-  # SYFT_LOG_STRUCTURED env var
   structured: false
 
   # the log level; note: detailed logging suppress the ETUI
-  # SYFT_LOG_LEVEL env var
   level: "error"
 
   # location to write the log file (default is not to have a log file)
-  # SYFT_LOG_FILE env var
   file: ""
+
+# enable/disable checking for application updates on startup
+check-for-app-update: true
 ```
 
-### Adding an SBOM to an image as an attestation using Syft
+## Future plans
 
-`syft attest --output [FORMAT] --key [KEY] [SOURCE] [flags]`
-
-SBOMs themselves can serve as input to different analysis tools. [Grype](https://github.com/anchore/grype), a vulnerability scanner CLI tool from Anchore, is one such tool. Publishers of container images can use attestations to enable their consumers to trust Syft-generated SBOM descriptions of those container images. To create and provide these attestations, image publishers can run `syft attest` in conjunction with the [cosign](https://github.com/sigstore/cosign) tool to attach SBOM attestations to their images.
-
-#### Example attestation
-Note for the following example replace `docker.io/image:latest` with an image you own. You should also have push access to
-its remote reference. Replace `$MY_PRIVATE_KEY` with a private key you own or have generated with cosign.
-
-```bash
-syft attest --key $MY_PRIVATE_KEY -o spdx-json docker.io/image:latest > image_latest_sbom_attestation.json
-cosign attach attestation --attestation image_latest_sbom_attestation.json docker.io/image:latest
-```
-
-Verify the new attestation exists on your image.
-
-```bash
-cosign verify-attestation --key $MY_PUBLIC_KEY --type spdxjson docker.io/image:latest | jq '.payload | @base64d | .payload | fromjson | .predicate'
-```
-
-You should see this output along with the attached SBOM:
-
-```
-Verification for docker.io/image:latest --
-The following checks were performed on each of these signatures:
-  - The cosign claims were validated
-  - The signatures were verified against the specified public key
-  - Any certificates were verified against the Fulcio roots.
-```
-
-Consumers of your image can now trust that the SBOM associated with your image is correct and from a trusted source.
-
-The SBOM can be piped to Grype:
-
-
-```bash
-cosign verify-attestation --key $MY_PUBLIC_KEY --type spdxjson docker.io/image:latest | jq '.payload | @base64d | .payload | fromjson | .predicate' | grype
-```
+The following areas of potential development are currently being investigated:
+- Add CycloneDX to list of output formats
+- Establish a stable interchange format w/Grype

RELEASE.md

@@ -1,49 +1,14 @@
-# Release
-
-## Creating a release
-
-This release process itself should be as automated as possible, and has only a few steps:
-
-1. **Trigger a new release with `make release`**. At this point you'll see a preview
-  changelog in the terminal. If you're happy with the changelog, press `y` to continue, otherwise
-  you can abort and adjust the labels on the PRs and issues to be included in the release and
-  re-run the release trigger command.
-
-1. A release admin must approve the release on the GitHub Actions release pipeline run page.
-   Once approved, the release pipeline will generate all assets and publish a GitHub Release.
-
-1. If there is a release Milestone, close it.
-
-Ideally releasing should be done often with small increments when possible. Unless a
-breaking change is blocking the release, or no fixes/features have been merged, a good
-target release cadence is between every 1 or 2 weeks.
-
-
-## Retracting a release
-
-If a release is found to be problematic, it can be retracted with the following steps:
-
-- Deleting the GitHub Release
-- Untag the docker images in the `ghcr.io` and `docker.io` registries
-- Revert the brew formula in [`anchore/homebrew-syft`](https://github.com/anchore/homebrew-syft) to point to the previous release
-- Add a new `retract` entry in the go.mod for the versioned release
-
-**Note**: do not delete release tags from the git repository since there may already be references to the release
-in the go proxy, which will cause confusion when trying to reuse the tag later (the H1 hash will not match and there
-will be a warning when users try to pull the new release).
-
-
-## Background
+# Release Process
 
 A good release process has the following qualities:
 
 1. There is a way to plan what should be in a release
 1. There is a way to see what is actually in a release
-1. Allow for different kinds of releases (major breaking vs backwards compatible enhancements vs patch updates)
+1. Allow for different kinds of releases (major breaking vs backwards compatible
+   enhancements vs patch updates)
 1. Specify a repeatable way to build and publish software artifacts
 
-
-### Planning a release
+## Planning a release
 
 To indicate a set of features to be released together add each issue to an in-repository
 Milestone named with major-minor version to be released (e.g. `v0.1`). It is OK for other
@@ -56,13 +21,15 @@ completed, would allow the release to be considered complete. A Milestone is onl
 
 Not all releases need to be planned. For instance, patch releases for fixes should be
 released when they are ready and when releasing would not interfere with another current
-release (where some partial or breaking features have already been merged).
+release (where some partial or breaking features have already been merged). Beta releases
+and release candidates should not be independently planned from the non-beta release. That
+is, the features for a `v0.1-beta.1` release should be planned under the `v0.1` Milestone,
+not under a separate `v0.1-beta.1` Milestone.
 
 Unless necessary, feature releases should be small and frequent, which may obviate the
 need for regular release planning under a Milestone.
 
-
-### What is in a release
+## What is in a release
 
 Milestones are specifically for planning a release, not necessarily tracking all changes
 that a release may bring (and more importantly, not all releases are necessarily planned
@@ -75,9 +42,9 @@ Changelog line. Furthermore, there should be a place to see all released version
 release date for each release, the semantic version of the release, and the set of changes
 for each release.
 
-**This project auto-generates the Changelog contents for each current release and posts the
-generated contents to the GitHub Release page**. Leveraging the GitHub Releases feature
-allows GitHub to manage the Changelog on each release outside of the git source tree while
+This project auto-generates the Changelog contents for each current release and posts the
+generated contents to the GitHub Release page. Leveraging the GitHub Releases feature
+allows GitHub to manage the Changelog on each release outside of the git repository while
 still being hosted with the released assets.
 
 The Changelog is generated from the metadata from in-repository issues and PRs, using
@@ -93,20 +60,40 @@ The above suggestions imply that we should:
 - The appropriate label is applied to PRs and/or issues to drive specific change type
   sections (deprecated, breaking, security, bug, etc)
 
-**With this approach as we cultivate good organization of PRs and issues we automatically
-get an equally good Changelog.**
+With this approach as we cultivate good organization of PRs and issues we automatically
+get an equally good Changelog.
 
-
-### Major, minor, and patch releases
+## Major, minor, and patch releases
 
 The latest version of the tool is the only supported version, which implies that multiple
 parallel release branches will not be a regular process (if ever). Multiple releases can
 be planned in parallel, however, only one can be actively developed at a time. That is, if
 PRs attached to a release Milestone have been merged into the main branch, that release is
-now the "next" release. **This implies that the source of truth for release lies with the
-git log and Changelog, not with the release Milestones** (which are purely for planning and
+now the "next" release. This implies that the source of truth for release lies with the
+git log and Changelog, not with the release Milestones (which are purely for planning and
 tracking).
 
 Semantic versioning should be used to indicate breaking changes, new features, and fixes.
 The exception to this is `< 1.0`, where the major version is not bumped for breaking changes,
 instead the minor version indicates both new features and breaking changes.
+
+## Cutting a release
+
+Ideally releasing should be done often with small increments when possible. Unless a
+breaking change is blocking the release, or no fixes/features have been merged, a good
+target release cadence is between every 2 or 4 weeks.
+
+This release process itself should be as automated as possible, and have only a few steps:
+
+1. Tag the main branch with a full semantic-version, prefixed with a `v`. If there is a
+   milestone with a partial version, the full version should be used for the git tag (e.g.
+   with a Milestone of `v0.1` the tag should be `v0.1.0`).
+
+1. Push the tag, the release pipeline will generate and publish all assets as well as a
+   draft GitHub Release.
+
+1. Promote the GitHub Release from draft to public. Note: since extra assets are made
+   available immediately from previous steps (i.e. the brew formula) the release should
+   only be in this state for a small amount of time (minutes).
+
+1. If there is a release Milestone, close it.

Taskfile.yaml

@@ -1,486 +0,0 @@
-
-version: "3"
-vars:
-  OWNER: anchore
-  PROJECT: syft
-
-  # static file dirs
-  TOOL_DIR: .tool
-  TMP_DIR: .tmp
-
-  # used for changelog generation
-  CHANGELOG: CHANGELOG.md
-  NEXT_VERSION: VERSION
-
-  # used for snapshot builds
-  OS:
-    sh: uname -s | tr '[:upper:]' '[:lower:]'
-  ARCH:
-    sh: |
-      [ "$(uname -m)" = "x86_64" ] && echo "amd64_v1" || echo $(uname -m)
-  PROJECT_ROOT:
-    sh: echo $PWD
-  # note: the snapshot dir must be a relative path starting with ./
-  SNAPSHOT_DIR: ./snapshot
-  SNAPSHOT_BIN: "{{ .PROJECT_ROOT }}/{{ .SNAPSHOT_DIR }}/{{ .OS }}-build_{{ .OS }}_{{ .ARCH }}/{{ .PROJECT }}"
-  SNAPSHOT_CMD: "{{ .TOOL_DIR }}/goreleaser release --config {{ .TMP_DIR }}/goreleaser.yaml --clean --snapshot --skip=publish --skip=sign"
-  BUILD_CMD:    "{{ .TOOL_DIR }}/goreleaser build   --config {{ .TMP_DIR }}/goreleaser.yaml --clean --snapshot --single-target"
-  RELEASE_CMD:  "{{ .TOOL_DIR }}/goreleaser release --clean --release-notes {{ .CHANGELOG }}"
-  VERSION:
-    sh: git describe --dirty --always --tags
-
-  # used for install and acceptance testing
-  COMPARE_DIR: ./test/compare
-  COMPARE_TEST_IMAGE: centos:8.2.2004
-
-tasks:
-
-  ## High-level tasks #################################
-
-  default:
-    desc: Run all validation tasks
-    aliases:
-      - pr-validations
-      - validations
-    cmds:
-      - task: static-analysis
-      - task: test
-      - task: install-test
-
-  static-analysis:
-    desc: Run all static analysis tasks
-    cmds:
-      - task: check-go-mod-tidy
-      - task: check-licenses
-      - task: lint
-      - task: check-json-schema-drift
-      - task: check-binary-fixture-size
-
-  test:
-    desc: Run all levels of test
-    cmds:
-      - task: unit
-      - task: integration
-      - task: validate-cyclonedx-schema
-      - task: benchmark
-      - task: test-utils
-      - task: cli
-
-  ## Bootstrap tasks #################################
-
-  binny:
-    internal: true
-    # desc: Get the binny tool
-    generates:
-      - "{{ .TOOL_DIR }}/binny"
-    status:
-      - "test -f {{ .TOOL_DIR }}/binny"
-    cmd: "curl -sSfL https://raw.githubusercontent.com/anchore/binny/main/install.sh | sh -s -- -b .tool"
-    silent: true
-
-  tools:
-    desc: Install all tools needed for CI and local development
-    deps: [binny]
-    aliases:
-      - bootstrap
-    generates:
-      - ".binny.yaml"
-      - "{{ .TOOL_DIR }}/*"
-    status:
-      - "{{ .TOOL_DIR }}/binny check -v"
-    cmd: "{{ .TOOL_DIR }}/binny install -v"
-    silent: true
-
-  update-tools:
-    desc: Update pinned versions of all tools to their latest available versions
-    deps: [binny]
-    generates:
-      - ".binny.yaml"
-      - "{{ .TOOL_DIR }}/*"
-    cmd: "{{ .TOOL_DIR }}/binny update -v"
-    silent: true
-
-  list-tools:
-    desc: List all tools needed for CI and local development
-    deps: [binny]
-    cmd: "{{ .TOOL_DIR }}/binny list"
-    silent: true
-
-  list-tool-updates:
-    desc: List all tools that are not up to date relative to the binny config
-    deps: [binny]
-    cmd: "{{ .TOOL_DIR }}/binny list --updates"
-    silent: true
-
-  tmpdir:
-    silent: true
-    generates:
-      - "{{ .TMP_DIR }}"
-    cmd: "mkdir -p {{ .TMP_DIR }}"
-
-  ## Static analysis tasks #################################
-
-  format:
-    desc: Auto-format all source code
-    deps: [tools]
-    cmds:
-      - gofmt -w -s .
-      - "{{ .TOOL_DIR }}/gosimports -local github.com/anchore -w ."
-      - go mod tidy
-
-  lint-fix:
-    desc: Auto-format all source code + run golangci lint fixers
-    deps: [tools]
-    cmds:
-      - task: format
-      - "{{ .TOOL_DIR }}/golangci-lint run --tests=false --fix"
-
-  lint:
-    desc: Run gofmt + golangci lint checks
-    vars:
-      BAD_FMT_FILES:
-        sh: gofmt -l -s .
-      BAD_FILE_NAMES:
-        sh: "find . | grep -e ':' || true"
-    deps: [tools]
-    cmds:
-      # ensure there are no go fmt differences
-      - cmd: 'test -z "{{ .BAD_FMT_FILES }}" || (echo "files with gofmt issues: [{{ .BAD_FMT_FILES }}]"; exit 1)'
-        silent: true
-      # ensure there are no files with ":" in it (a known back case in the go ecosystem)
-      - cmd: 'test -z "{{ .BAD_FILE_NAMES }}" || (echo "files with bad names: [{{ .BAD_FILE_NAMES }}]"; exit 1)'
-        silent: true
-      # run linting
-      - "{{ .TOOL_DIR }}/golangci-lint run --tests=false"
-
-
-  check-licenses:
-    # desc: Ensure transitive dependencies are compliant with the current license policy
-    deps: [tools]
-    cmd: "{{ .TOOL_DIR }}/bouncer check ./..."
-
-  check-go-mod-tidy:
-    # desc: Ensure go.mod and go.sum are up to date
-    cmds:
-      - cmd: .github/scripts/go-mod-tidy-check.sh && echo "go.mod and go.sum are tidy!"
-        silent: true
-
-  check-json-schema-drift:
-    desc: Ensure there is no drift between the JSON schema and the code
-    cmds:
-      - .github/scripts/json-schema-drift-check.sh
-
-  check-binary-fixture-size:
-    desc: Ensure that the binary test fixtures are not too large
-    cmds:
-      - .github/scripts/check_binary_fixture_size.sh syft/pkg/cataloger/binary/test-fixtures/classifiers/snippets
-
-
-  ## Testing tasks #################################
-
-  unit:
-    desc: Run unit tests
-    deps:
-      - tmpdir
-      - fixtures
-    vars:
-      TEST_PKGS:
-        sh: "go list ./... | grep -v {{ .OWNER }}/{{ .PROJECT }}/test | grep -v {{ .OWNER }}/{{ .PROJECT }}/cmd/syft/internal/test | tr '\n' ' '"
-
-      # unit test coverage threshold (in % coverage)
-      COVERAGE_THRESHOLD: 62
-    cmds:
-      - "go test -coverprofile {{ .TMP_DIR }}/unit-coverage-details.txt {{ .TEST_PKGS }}"
-      - cmd: ".github/scripts/coverage.py {{ .COVERAGE_THRESHOLD }} {{ .TMP_DIR }}/unit-coverage-details.txt"
-        silent: true
-
-  integration:
-    desc: Run integration tests
-    cmds:
-      - "go test -v ./cmd/syft/internal/test/integration"
-      # exercise most of the CLI with the data race detector
-      - "go run -race cmd/syft/main.go alpine:latest"
-
-  validate-cyclonedx-schema:
-    desc: Run integration tests
-    cmds:
-      - "cd schema/cyclonedx && make"
-
-  cli:
-    desc: Run CLI tests
-    # note: we don't want to regenerate the snapshot unless we have to. In CI it's probable
-    # that the cache being restored with the correct binary will be rebuilt since the timestamps
-    # and local checksums will not line up.
-    deps: [tools, snapshot]
-    sources:
-      - "{{ .SNAPSHOT_BIN }}"
-      - ./test/cli/**
-      - ./**/*.go
-    cmds:
-      - cmd: "echo 'testing binary: {{ .SNAPSHOT_BIN }}'"
-        silent: true
-
-      - cmd: "test -f {{ .SNAPSHOT_BIN }} || (find {{ .SNAPSHOT_DIR }} && echo '\nno snapshot found' && false)"
-        silent: true
-
-      - "go test -count=1 -timeout=15m -v ./test/cli"
-    env:
-      SYFT_BINARY_LOCATION: "{{ .SNAPSHOT_BIN }}"
-
-  test-utils:
-    desc: Run tests for pipeline utils
-    sources:
-      - .github/scripts/labeler*.py
-    cmds:
-      - cmd: python .github/scripts/labeler_test.py
-
-
-  ## Benchmark test targets #################################
-
-  benchmark:
-    deps: [tmpdir]
-    sources:
-      - ./**/*.go
-    generates:
-      - "{{ .TMP_DIR }}/benchmark-main.txt"
-    cmds:
-      - "go test -p 1 -run=^Benchmark -bench=. -count=7 -benchmem ./... | tee {{ .TMP_DIR }}/benchmark-{{ .VERSION }}.txt"
-      - |
-        bash -c "(test -s {{ .TMP_DIR }}/benchmark-main.txt && \
-        {{ .TOOL_DIR }}/benchstat {{ .TMP_DIR }}/benchmark-main.txt {{ .TMP_DIR }}/benchmark-{{ .VERSION }}.txt || \
-        {{ .TOOL_DIR }}/benchstat {{ .TMP_DIR }}/benchmark-{{ .VERSION }}.txt) \
-        | tee {{ .TMP_DIR }}/benchstat.txt"
-
-  show-benchstat:
-    deps: [benchmark, tmpdir]
-    sources:
-      - "{{ .TMP_DIR }}/benchstat.txt"
-    cmds:
-      - cmd: "cat {{ .TMP_DIR }}/benchstat.txt"
-        silent: true
-
-
-  ## Test-fixture-related targets #################################
-
-  fingerprints:
-    desc: Generate test fixture fingerprints
-    generates:
-      - cmd/syft/internal/test/integration/test-fixtures/cache.fingerprint
-      - syft/file/cataloger/executable/test-fixtures/elf/cache.fingerprint
-      - syft/file/cataloger/executable/test-fixtures/shared-info/cache.fingerprint
-      - syft/pkg/cataloger/binary/test-fixtures/cache.fingerprint
-      - syft/pkg/cataloger/java/test-fixtures/java-builds/cache.fingerprint
-      - syft/pkg/cataloger/golang/test-fixtures/archs/binaries.fingerprint
-      - syft/pkg/cataloger/redhat/test-fixtures/rpms.fingerprint
-      - syft/pkg/cataloger/kernel/test-fixtures/cache.fingerprint
-      - test/install/cache.fingerprint
-      - test/cli/test-fixtures/cache.fingerprint
-    cmds:
-      # for EXECUTABLE unit test fixtures
-      - "cd syft/file/cataloger/executable/test-fixtures/elf && make cache.fingerprint"
-      - "cd syft/file/cataloger/executable/test-fixtures/shared-info && make cache.fingerprint"
-      # for IMAGE integration test fixtures
-      - "cd cmd/syft/internal/test/integration/test-fixtures && make cache.fingerprint"
-      # for BINARY unit test fixtures
-      - "cd syft/pkg/cataloger/binary/test-fixtures && make cache.fingerprint"
-      # for JAVA BUILD unit test fixtures
-      - "cd syft/pkg/cataloger/java/test-fixtures/java-builds && make cache.fingerprint"
-      # for GO BINARY unit test fixtures
-      - "cd syft/pkg/cataloger/golang/test-fixtures/archs && make binaries.fingerprint"
-      # for RPM unit test fixtures
-      - "cd syft/pkg/cataloger/redhat/test-fixtures && make rpms.fingerprint"
-      # for Kernel unit test fixtures
-      - "cd syft/pkg/cataloger/kernel/test-fixtures && make cache.fingerprint"
-      # for INSTALL test fixtures
-      - "cd test/install && make cache.fingerprint"
-      # for CLI test fixtures
-      - "cd test/cli/test-fixtures && make cache.fingerprint"
-
-  fixtures:
-    desc: Generate test fixtures
-    cmds:
-      - "cd syft/file/cataloger/executable/test-fixtures/elf && make"
-      - "cd syft/file/cataloger/executable/test-fixtures/shared-info && make"
-      - "cd syft/pkg/cataloger/java/test-fixtures/java-builds && make"
-      - "cd syft/pkg/cataloger/redhat/test-fixtures && make"
-      - "cd syft/pkg/cataloger/binary/test-fixtures && make"
-
-  show-test-image-cache:
-    silent: true
-    cmds:
-      - "echo '\nDocker daemon cache:'"
-      - "docker images --format '{{`{{.ID}}`}} {{`{{.Repository}}`}}:{{`{{.Tag}}`}}' | grep stereoscope-fixture- | sort"
-      - "echo '\nTar cache:'"
-      - 'find . -type f -wholename "**/test-fixtures/snapshot/*" | sort'
-
-
-  ## install.sh testing targets #################################
-
-  install-test:
-    cmds:
-      - "cd test/install && make"
-
-  install-test-cache-save:
-    cmds:
-      - "cd test/install && make save"
-
-  install-test-cache-load:
-    cmds:
-      - "cd test/install && make load"
-
-  install-test-ci-mac:
-    cmds:
-      - "cd test/install && make ci-test-mac"
-
-  generate-compare-file:
-    cmd: "go run ./cmd/syft {{ .COMPARE_TEST_IMAGE }} -o json > {{ .COMPARE_DIR }}/test-fixtures/acceptance-{{ .COMPARE_TEST_IMAGE }}.json"
-
-  compare-mac:
-    deps: [tmpdir]
-    cmd: |
-      {{ .COMPARE_DIR }}/mac.sh \
-        {{ .SNAPSHOT_DIR }} \
-        {{ .COMPARE_DIR }} \
-        {{ .COMPARE_TEST_IMAGE }} \
-        {{ .TMP_DIR }}
-
-  compare-linux:
-    cmds:
-      - task: compare-test-deb-package-install
-      - task: compare-test-rpm-package-install
-
-  compare-test-deb-package-install:
-    deps: [tmpdir]
-    cmd: |
-      {{ .COMPARE_DIR }}/deb.sh \
-        {{ .SNAPSHOT_DIR }} \
-        {{ .COMPARE_DIR }} \
-        {{ .COMPARE_TEST_IMAGE }} \
-        {{ .TMP_DIR }}
-
-  compare-test-rpm-package-install:
-    deps: [tmpdir]
-    cmd: |
-      {{ .COMPARE_DIR }}/rpm.sh \
-        {{ .SNAPSHOT_DIR }} \
-        {{ .COMPARE_DIR }} \
-        {{ .COMPARE_TEST_IMAGE }} \
-        {{ .TMP_DIR }}
-
-
-  ## Code and data generation targets #################################
-
-  generate:
-    desc: Add data generation tasks
-    cmds:
-      - task: generate-json-schema
-      - task: generate-license-list
-      - task: generate-cpe-dictionary-index
-
-  generate-json-schema:
-    desc: Generate a new JSON schema
-    cmds:
-      - "cd syft/internal && go generate . && cd jsonschema && go run . && go fmt ../..."
-
-  generate-license-list:
-    desc: Generate an updated license processing code off of the latest available SPDX license list
-    cmds:
-      - "go generate ./internal/spdxlicense/..."
-      - "gofmt -s -w ./internal/spdxlicense"
-
-  generate-cpe-dictionary-index:
-    desc: Generate the CPE index based off of the latest available CPE dictionary
-    dir: "syft/pkg/cataloger/common/cpe/dictionary"
-    cmds:
-      - "go generate"
-
-
-  ## Build-related targets #################################
-
-  build:
-    desc: Build the project
-    deps: [tools, tmpdir]
-    generates:
-      - "{{ .PROJECT }}"
-    cmds:
-      - silent: true
-        cmd: |
-          echo "dist: {{ .SNAPSHOT_DIR }}" > {{ .TMP_DIR }}/goreleaser.yaml
-          cat .goreleaser.yaml >> {{ .TMP_DIR }}/goreleaser.yaml
-
-      - "{{ .BUILD_CMD }}"
-
-  snapshot:
-    desc: Create a snapshot release
-    aliases:
-      - build
-    deps: [tools, tmpdir]
-    sources:
-      - cmd/**/*.go
-      - syft/**/*.go
-      - internal/**/*.go
-    method: checksum
-    generates:
-      - "{{ .SNAPSHOT_BIN }}"
-    cmds:
-      - silent: true
-        cmd: |
-          echo "dist: {{ .SNAPSHOT_DIR }}" > {{ .TMP_DIR }}/goreleaser.yaml
-          cat .goreleaser.yaml >> {{ .TMP_DIR }}/goreleaser.yaml
-
-      - "{{ .SNAPSHOT_CMD }}"
-
-  changelog:
-    desc: Generate a changelog
-    deps: [tools]
-    generates:
-      - "{{ .CHANGELOG }}"
-      - "{{ .NEXT_VERSION }}"
-    cmds:
-      - "{{ .TOOL_DIR }}/chronicle -vv -n --version-file {{ .NEXT_VERSION }} > {{ .CHANGELOG }}"
-      - "{{ .TOOL_DIR }}/glow {{ .CHANGELOG }}"
-
-
-  ## Release targets #################################
-
-  release:
-    desc: Create a release
-    interactive: true
-    deps: [tools]
-    cmds:
-      - cmd: .github/scripts/trigger-release.sh
-        silent: true
-
-
-  ## CI-only targets #################################
-
-  ci-check:
-    # desc: "[CI only] Are you in CI?"
-    cmds:
-      - cmd: .github/scripts/ci-check.sh
-        silent: true
-
-  ci-release:
-    # desc: "[CI only] Create a release"
-    deps: [tools]
-    cmds:
-      - task: ci-check
-      - "{{ .TOOL_DIR }}/chronicle -vvv > CHANGELOG.md"
-      - cmd: "cat CHANGELOG.md"
-        silent: true
-      - "{{ .RELEASE_CMD }}"
-
-
-  ## Cleanup targets #################################
-
-  clean-snapshot:
-    desc: Remove any snapshot builds
-    cmds:
-      - "rm -rf {{ .SNAPSHOT_DIR }}"
-      - "rm -rf {{ .TMP_DIR }}/goreleaser.yaml"
-
-  clean-cache:
-    desc: Remove all docker cache and local image tar cache
-    cmds:
-      - 'find . -type f -wholename "**/test-fixtures/cache/stereoscope-fixture-*.tar" -delete'
-      - "docker images --format '{{`{{.ID}}`}} {{`{{.Repository}}`}}' | grep stereoscope-fixture- | awk '{print $$1}' | uniq | xargs -r docker rmi --force"

artifacthub-repo.yml

@@ -1,5 +0,0 @@
-# See documentation here: https://github.com/artifacthub/hub/blob/v1.6.0/docs/metadata/artifacthub-repo.yml
-repositoryID: eced152f-b15d-4879-8b3b-1175397192ba
-owners:
-  - name: wagoodman
-    email: wagoodman@gmail.com

cmd/cmd.go

@@ -0,0 +1,140 @@
+package cmd
+
+import (
+	"fmt"
+	"os"
+	"path"
+
+	"github.com/adrg/xdg"
+	"github.com/anchore/syft/internal"
+
+	"github.com/spf13/cobra"
+
+	"github.com/anchore/syft/syft/presenter"
+	"github.com/anchore/syft/syft/scope"
+
+	"github.com/anchore/stereoscope"
+	"github.com/anchore/syft/internal/config"
+	"github.com/anchore/syft/internal/format"
+	"github.com/anchore/syft/internal/log"
+	"github.com/anchore/syft/internal/logger"
+	"github.com/anchore/syft/syft"
+	"github.com/spf13/viper"
+	"github.com/wagoodman/go-partybus"
+	"gopkg.in/yaml.v2"
+)
+
+var appConfig *config.Application
+var eventBus *partybus.Bus
+var eventSubscription *partybus.Subscription
+var cliOpts = config.CliOnlyOptions{}
+
+func init() {
+	setGlobalCliOptions()
+
+	cobra.OnInitialize(
+		initAppConfig,
+		initLogging,
+		logAppConfig,
+		initEventBus,
+	)
+}
+
+func Execute() {
+	if err := rootCmd.Execute(); err != nil {
+		fmt.Fprintln(os.Stderr, err.Error())
+		os.Exit(1)
+	}
+}
+
+func setGlobalCliOptions() {
+	rootCmd.PersistentFlags().StringVarP(&cliOpts.ConfigPath, "config", "c", "", "application config file")
+
+	// scan options
+	flag := "scope"
+	rootCmd.Flags().StringP(
+		"scope", "s", scope.SquashedScope.String(),
+		fmt.Sprintf("selection of layers to catalog, options=%v", scope.Options))
+	if err := viper.BindPFlag(flag, rootCmd.Flags().Lookup(flag)); err != nil {
+		fmt.Printf("unable to bind flag '%s': %+v", flag, err)
+		os.Exit(1)
+	}
+
+	// output & formatting options
+	flag = "output"
+	rootCmd.Flags().StringP(
+		flag, "o", string(presenter.TablePresenter),
+		fmt.Sprintf("report output formatter, options=%v", presenter.Options),
+	)
+	if err := viper.BindPFlag(flag, rootCmd.Flags().Lookup(flag)); err != nil {
+		fmt.Printf("unable to bind flag '%s': %+v", flag, err)
+		os.Exit(1)
+	}
+
+	flag = "quiet"
+	rootCmd.Flags().BoolP(
+		flag, "q", false,
+		"suppress all logging output",
+	)
+	if err := viper.BindPFlag(flag, rootCmd.Flags().Lookup(flag)); err != nil {
+		fmt.Printf("unable to bind flag '%s': %+v", flag, err)
+		os.Exit(1)
+	}
+
+	rootCmd.Flags().CountVarP(&cliOpts.Verbosity, "verbose", "v", "increase verbosity (-v = info, -vv = debug)")
+
+	// plugins
+	defaultPluginDir := path.Join(xdg.CacheHome, internal.ApplicationName, "plugins")
+	flag = "plugins.dir"
+	rootCmd.Flags().String(
+		flag, defaultPluginDir,
+		"plugin storage directory",
+	)
+	if err := viper.BindPFlag(flag, rootCmd.Flags().Lookup(flag)); err != nil {
+		fmt.Printf("unable to bind flag '%s': %+v", flag, err)
+		os.Exit(1)
+	}
+}
+
+func initAppConfig() {
+	cfg, err := config.LoadConfigFromFile(viper.GetViper(), &cliOpts)
+	if err != nil {
+		fmt.Printf("failed to load application config: \n\t%+v\n", err)
+		os.Exit(1)
+	}
+	appConfig = cfg
+}
+
+func initLogging() {
+	cfg := logger.LogrusConfig{
+		EnableConsole: (appConfig.Log.FileLocation == "" || appConfig.CliOptions.Verbosity > 0) && !appConfig.Quiet,
+		EnableFile:    appConfig.Log.FileLocation != "",
+		Level:         appConfig.Log.LevelOpt,
+		Structured:    appConfig.Log.Structured,
+		FileLocation:  appConfig.Log.FileLocation,
+	}
+
+	logWrapper := logger.NewLogrusLogger(cfg)
+	syft.SetLogger(logWrapper)
+	stereoscope.SetLogger(&logger.LogrusNestedLogger{
+		Logger: logWrapper.Logger.WithField("from-lib", "stereoscope"),
+	})
+}
+
+func logAppConfig() {
+	appCfgStr, err := yaml.Marshal(&appConfig)
+
+	if err != nil {
+		log.Debugf("Could not display application config: %+v", err)
+	} else {
+		log.Debugf("Application config:\n%+v", format.Magenta.Format(string(appCfgStr)))
+	}
+}
+
+func initEventBus() {
+	eventBus = partybus.NewBus()
+	eventSubscription = eventBus.Subscribe()
+
+	stereoscope.SetBus(eventBus)
+	syft.SetBus(eventBus)
+}

cmd/root.go

@@ -0,0 +1,100 @@
+package cmd
+
+import (
+	"fmt"
+	"os"
+
+	"github.com/anchore/syft/internal"
+	"github.com/anchore/syft/internal/bus"
+	"github.com/anchore/syft/internal/log"
+	"github.com/anchore/syft/internal/ui"
+	"github.com/anchore/syft/internal/version"
+	"github.com/anchore/syft/syft"
+	"github.com/anchore/syft/syft/event"
+	"github.com/anchore/syft/syft/presenter"
+	"github.com/spf13/cobra"
+	"github.com/wagoodman/go-partybus"
+)
+
+var rootCmd = &cobra.Command{
+	Use:   fmt.Sprintf("%s [SOURCE]", internal.ApplicationName),
+	Short: "A tool for generating a Software Bill Of Materials (SBOM) from container images and filesystems",
+	Long: internal.Tprintf(`
+Supports the following image sources:
+    {{.appName}} yourrepo/yourimage:tag             defaults to using images from a docker daemon
+    {{.appName}} docker://yourrepo/yourimage:tag    explicitly use the docker daemon
+    {{.appName}} tar://path/to/yourimage.tar        use a tarball from disk
+    {{.appName}} dir://path/to/yourproject          read directly from a path in disk
+`, map[string]interface{}{
+		"appName": internal.ApplicationName,
+	}),
+	Args: cobra.MaximumNArgs(1),
+	Run: func(cmd *cobra.Command, args []string) {
+		if len(args) == 0 {
+			err := cmd.Help()
+			if err != nil {
+				log.Errorf(err.Error())
+				os.Exit(1)
+			}
+			os.Exit(1)
+		}
+		err := doRunCmd(cmd, args)
+		if err != nil {
+			log.Errorf(err.Error())
+			os.Exit(1)
+		}
+	},
+}
+
+func startWorker(userInput string) <-chan error {
+	errs := make(chan error)
+	go func() {
+		defer close(errs)
+
+		if appConfig.CheckForAppUpdate {
+			isAvailable, newVersion, err := version.IsUpdateAvailable()
+			if err != nil {
+				log.Errorf(err.Error())
+			}
+			if isAvailable {
+				log.Infof("new version of %s is available: %s", internal.ApplicationName, newVersion)
+
+				bus.Publish(partybus.Event{
+					Type:  event.AppUpdateAvailable,
+					Value: newVersion,
+				})
+			} else {
+				log.Debugf("no new %s update available", internal.ApplicationName)
+			}
+		}
+
+		config := syft.Config{
+			PluginDirectory: appConfig.Plugins.Directory,
+		}
+
+		client, err := syft.NewClient(config)
+		if err != nil {
+			errs <- fmt.Errorf("could not initialize syft: %+v", err)
+			return
+		}
+
+		catalog, scope, distro, err := client.Catalog(userInput, appConfig.ScopeOpt)
+		if err != nil {
+			errs <- fmt.Errorf("failed to catalog input: %+v", err)
+			return
+		}
+
+		bus.Publish(partybus.Event{
+			Type:  event.CatalogerFinished,
+			Value: presenter.GetPresenter(appConfig.PresenterOpt, *scope, catalog, distro),
+		})
+	}()
+	return errs
+}
+
+func doRunCmd(_ *cobra.Command, args []string) error {
+	userInput := args[0]
+	errs := startWorker(userInput)
+	ux := ui.Select(appConfig.CliOptions.Verbosity > 0, appConfig.Quiet)
+	return ux(errs, eventSubscription)
+}

cmd/syft/cli/cli.go

@@ -1,60 +0,0 @@
-package cli
-
-import (
-	"io"
-	"os"
-
-	cranecmd "github.com/google/go-containerregistry/cmd/crane/cmd"
-	"github.com/spf13/cobra"
-
-	"github.com/anchore/clio"
-	"github.com/anchore/syft/cmd/syft/internal"
-	"github.com/anchore/syft/cmd/syft/internal/commands"
-)
-
-// Application constructs the `syft packages` command and aliases the root command to `syft packages`.
-// It is also responsible for organizing flag usage and injecting the application config for each command.
-// It also constructs the syft attest command and the syft version command.
-// `RunE` is the earliest that the complete application configuration can be loaded.
-func Application(id clio.Identification) clio.Application {
-	app, _ := create(id, os.Stdout)
-	return app
-}
-
-// Command returns the root command for the syft CLI application. This is useful for embedding the entire syft CLI
-// into an existing application.
-func Command(id clio.Identification) *cobra.Command {
-	_, cmd := create(id, os.Stdout)
-	return cmd
-}
-
-func create(id clio.Identification, out io.Writer) (clio.Application, *cobra.Command) {
-	clioCfg := internal.AppClioSetupConfig(id, out)
-
-	app := clio.New(*clioCfg)
-
-	// since root is aliased as the packages cmd we need to construct this command first
-	// we also need the command to have information about the `root` options because of this alias
-	scanCmd := commands.Scan(app)
-
-	// root is currently an alias for the scan command
-	rootCmd := commands.Root(app, scanCmd)
-
-	// add sub-commands
-	rootCmd.AddCommand(
-		scanCmd,
-		commands.Packages(app, scanCmd), // this is currently an alias for the scan command
-		commands.Cataloger(app),
-		commands.Attest(app),
-		commands.Convert(app),
-		clio.VersionCommand(id),
-		cranecmd.NewCmdAuthLogin(id.Name), // syft login uses the same command as crane
-	)
-
-	// note: we would direct cobra to use our writer explicitly with rootCmd.SetOut(out) , however this causes
-	// deprecation warnings to be shown to stdout via the writer instead of stderr. This is unfortunate since this
-	// does not appear to be the correct behavior on cobra's part https://github.com/spf13/cobra/issues/1708 .
-	// In the future this functionality should be restored.
-
-	return app, rootCmd
-}

cmd/syft/cli/ui/__snapshots__/handle_attestation_test.snap

@@ -1,19 +0,0 @@
-
-[TestHandler_handleAttestationStarted/attesting_in_progress/task_line - 1]
- ⠋ Creating a thing                                                                running a thing
----
-
-[TestHandler_handleAttestationStarted/attesting_in_progress/log - 1]
-     ░░ contents
-     ░░ of
-     ░░ stuff!
-
----
-
-[TestHandler_handleAttestationStarted/attesting_complete/task_line - 1]
- ✔ Created a thing                                                                 running a thing
----
-
-[TestHandler_handleAttestationStarted/attesting_complete/log - 1]
-
----

cmd/syft/cli/ui/__snapshots__/handle_cataloger_task_test.snap

@@ -1,24 +0,0 @@
-
-[TestHandler_handleCatalogerTaskStarted/cataloging_task_in_progress - 1]
- ⠙ Cataloging contents             
- ⠙ some task title                 ━━━━━━━━━━━━━━━━━━━━  [some stage]  
----
-
-[TestHandler_handleCatalogerTaskStarted/cataloging_sub_task_in_progress - 1]
- ⠙ Cataloging contents             
-   └── ⠙ some task title                 ━━━━━━━━━━━━━━━━━━━━  [some stage]  
----
-
-[TestHandler_handleCatalogerTaskStarted/cataloging_sub_task_complete - 1]
- ⠙ Cataloging contents             
-   └── ✔ some task done                  [some stage]  
----
-
-[TestHandler_handleCatalogerTaskStarted/cataloging_sub_task_complete_--_hide_stage - 1]
- ⠙ Cataloging contents             
-   └── ✔ some task done                  
----
-
-[TestHandler_handleCatalogerTaskStarted/cataloging_sub_task_complete_with_removal - 1]
- ⠙ Cataloging contents             
----

cmd/syft/cli/ui/__snapshots__/handle_fetch_image_test.snap

@@ -1,8 +0,0 @@
-
-[TestHandler_handleFetchImage/fetch_image_in_progress - 1]
- ⠋ Loading image                   ━━━━━━━━━━━━━━━━━━━━  [current]                       the-image
----
-
-[TestHandler_handleFetchImage/fetch_image_complete - 1]
- ✔ Loaded image                                                                          the-image
----

cmd/syft/cli/ui/__snapshots__/handle_file_indexing_test.snap

@@ -1,8 +0,0 @@
-
-[TestHandler_handleFileIndexingStarted/cataloging_in_progress - 1]
- ⠋ Indexing file system            ━━━━━━━━━━━━━━━━━━━━  [current]                      /some/path
----
-
-[TestHandler_handleFileIndexingStarted/cataloging_complete - 1]
- ✔ Indexed file system                                                                  /some/path
----

cmd/syft/cli/ui/__snapshots__/handle_pull_docker_image_test.snap

@@ -1,12 +0,0 @@
-
-[Test_dockerPullStatusFormatter_Render/pulling - 1]
-3 Layers▕▅▃ ▏[12 B / 30 B]
----
-
-[Test_dockerPullStatusFormatter_Render/download_complete - 1]
-3 Layers▕█▃ ▏[30 B] Extracting...
----
-
-[Test_dockerPullStatusFormatter_Render/complete - 1]
-3 Layers▕███▏[30 B] Extracting...
----

cmd/syft/cli/ui/__snapshots__/handle_read_image_test.snap

@@ -1,8 +0,0 @@
-
-[TestHandler_handleReadImage/read_image_in_progress - 1]
- ⠋ Parsing image                   ━━━━━━━━━━━━━━━━━━━━                                         id
----
-
-[TestHandler_handleReadImage/read_image_complete - 1]
- ✔ Parsed image                                                                                 id
----

cmd/syft/cli/ui/handle_attestation.go

@@ -1,255 +0,0 @@
-package ui
-
-import (
-	"bufio"
-	"fmt"
-	"io"
-	"strings"
-	"sync"
-	"time"
-
-	tea "github.com/charmbracelet/bubbletea"
-	"github.com/charmbracelet/lipgloss"
-	"github.com/google/uuid"
-	"github.com/wagoodman/go-partybus"
-	"github.com/wagoodman/go-progress"
-	"github.com/zyedidia/generic/queue"
-
-	"github.com/anchore/bubbly/bubbles/taskprogress"
-	"github.com/anchore/syft/internal/log"
-	syftEventParsers "github.com/anchore/syft/syft/event/parsers"
-)
-
-var (
-	_ tea.Model = (*attestLogFrame)(nil)
-)
-
-type attestLogFrame struct {
-	reader     *backgroundLineReader
-	prog       progress.Progressable
-	lines      []string
-	completed  bool
-	failed     bool
-	windowSize tea.WindowSizeMsg
-
-	id       uint32
-	sequence int
-
-	updateDuration time.Duration
-	borderStype    lipgloss.Style
-}
-
-// attestLogFrameTickMsg indicates that the timer has ticked and we should render a frame.
-type attestLogFrameTickMsg struct {
-	Time     time.Time
-	Sequence int
-	ID       uint32
-}
-
-type backgroundLineReader struct {
-	limit int
-	lines *queue.Queue[string]
-	lock  *sync.RWMutex
-
-	// This is added specifically for tests to assert when the background reader is done.
-	// The main UI uses the global ui wait group from the handler to otherwise block
-	// Shared concerns among multiple model made it difficult to test using the global wait group
-	// so this is added to allow tests to assert when the background reader is done.
-	running *sync.WaitGroup
-}
-
-func (m *Handler) handleAttestationStarted(e partybus.Event) []tea.Model {
-	reader, prog, taskInfo, err := syftEventParsers.ParseAttestationStartedEvent(e)
-	if err != nil {
-		log.WithFields("error", err).Warn("unable to parse event")
-		return nil
-	}
-
-	stage := progress.Stage{}
-
-	tsk := m.newTaskProgress(
-		taskprogress.Title{
-			Default: taskInfo.Title.Default,
-			Running: taskInfo.Title.WhileRunning,
-			Success: taskInfo.Title.OnSuccess,
-		},
-		taskprogress.WithStagedProgressable(
-			struct {
-				progress.Progressable
-				progress.Stager
-			}{
-				Progressable: prog,
-				Stager:       &stage,
-			},
-		),
-	)
-
-	tsk.HideStageOnSuccess = false
-
-	if taskInfo.Context != "" {
-		tsk.Context = []string{taskInfo.Context}
-	}
-
-	borderStyle := tsk.HintStyle
-
-	return []tea.Model{
-		tsk,
-		newLogFrame(newBackgroundLineReader(m.Running, reader, &stage), prog, borderStyle),
-	}
-}
-
-func newLogFrame(reader *backgroundLineReader, prog progress.Progressable, borderStyle lipgloss.Style) attestLogFrame {
-	return attestLogFrame{
-		reader:         reader,
-		prog:           prog,
-		id:             uuid.Must(uuid.NewUUID()).ID(),
-		updateDuration: 250 * time.Millisecond,
-		borderStype:    borderStyle,
-	}
-}
-
-func newBackgroundLineReader(wg *sync.WaitGroup, reader io.Reader, stage *progress.Stage) *backgroundLineReader {
-	r := &backgroundLineReader{
-		limit:   7,
-		lock:    &sync.RWMutex{},
-		lines:   queue.New[string](),
-		running: &sync.WaitGroup{},
-	}
-
-	// tracks the background reader for the global handler wait group
-	wg.Add(1)
-
-	// tracks the background reader for the local wait group (used in tests to decouple from the global handler wait group)
-	r.running.Add(1)
-
-	go func() {
-		r.read(reader, stage)
-		wg.Done()
-		r.running.Done()
-	}()
-
-	return r
-}
-
-func (l *backgroundLineReader) read(reader io.Reader, stage *progress.Stage) {
-	s := bufio.NewScanner(reader)
-
-	for s.Scan() {
-		l.lock.Lock()
-
-		text := s.Text()
-		l.lines.Enqueue(text)
-
-		if strings.Contains(text, "tlog entry created with index") {
-			fields := strings.SplitN(text, ":", 2)
-			present := text
-			if len(fields) == 2 {
-				present = fmt.Sprintf("transparency log index: %s", fields[1])
-			}
-			stage.Current = present
-		} else if strings.Contains(text, "WARNING: skipping transparency log upload") {
-			stage.Current = "transparency log upload skipped"
-		}
-
-		// only show the last X lines of the shell output
-		for l.lines.Len() > l.limit {
-			l.lines.Dequeue()
-		}
-
-		l.lock.Unlock()
-	}
-}
-
-func (l backgroundLineReader) Lines() []string {
-	l.lock.RLock()
-	defer l.lock.RUnlock()
-
-	var lines []string
-
-	l.lines.Each(func(line string) {
-		lines = append(lines, line)
-	})
-
-	return lines
-}
-
-func (l attestLogFrame) Init() tea.Cmd {
-	// this is the periodic update of state information
-	return func() tea.Msg {
-		return attestLogFrameTickMsg{
-			// The time at which the tick occurred.
-			Time: time.Now(),
-
-			// The ID of the log frame that this message belongs to. This can be
-			// helpful when routing messages, however bear in mind that log frames
-			// will ignore messages that don't contain ID by default.
-			ID: l.id,
-
-			Sequence: l.sequence,
-		}
-	}
-}
-
-func (l attestLogFrame) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
-	switch msg := msg.(type) {
-	case tea.WindowSizeMsg:
-		l.windowSize = msg
-		return l, nil
-
-	case attestLogFrameTickMsg:
-		l.lines = l.reader.Lines()
-
-		l.completed = progress.IsCompleted(l.prog)
-		err := l.prog.Error()
-		l.failed = err != nil && !progress.IsErrCompleted(err)
-
-		tickCmd := l.handleTick(msg)
-
-		return l, tickCmd
-	}
-
-	return l, nil
-}
-
-func (l attestLogFrame) View() string {
-	if l.completed && !l.failed {
-		return ""
-	}
-
-	sb := strings.Builder{}
-
-	for _, line := range l.lines {
-		sb.WriteString(fmt.Sprintf("     %s %s\n", l.borderStype.Render("░░"), line))
-	}
-
-	return sb.String()
-}
-
-func (l attestLogFrame) queueNextTick() tea.Cmd {
-	return tea.Tick(l.updateDuration, func(t time.Time) tea.Msg {
-		return attestLogFrameTickMsg{
-			Time:     t,
-			ID:       l.id,
-			Sequence: l.sequence,
-		}
-	})
-}
-
-func (l *attestLogFrame) handleTick(msg attestLogFrameTickMsg) tea.Cmd {
-	// If an ID is set, and the ID doesn't belong to this log frame, reject the message.
-	if msg.ID > 0 && msg.ID != l.id {
-		return nil
-	}
-
-	// If a sequence is set, and it's not the one we expect, reject the message.
-	// This prevents the log frame from receiving too many messages and
-	// thus updating too frequently.
-	if msg.Sequence > 0 && msg.Sequence != l.sequence {
-		return nil
-	}
-
-	l.sequence++
-
-	// note: even if the log is completed we should still respond to stage changes and window size events
-	return l.queueNextTick()
-}

cmd/syft/cli/ui/handle_attestation_test.go

@@ -1,140 +0,0 @@
-package ui
-
-import (
-	"strings"
-	"testing"
-	"time"
-
-	tea "github.com/charmbracelet/bubbletea"
-	"github.com/gkampitakis/go-snaps/snaps"
-	"github.com/stretchr/testify/require"
-	"github.com/wagoodman/go-partybus"
-	"github.com/wagoodman/go-progress"
-
-	"github.com/anchore/bubbly/bubbles/taskprogress"
-	syftEvent "github.com/anchore/syft/syft/event"
-	"github.com/anchore/syft/syft/event/monitor"
-)
-
-func TestHandler_handleAttestationStarted(t *testing.T) {
-
-	tests := []struct {
-		name       string
-		eventFn    func(*testing.T) partybus.Event
-		iterations int
-	}{
-		{
-			name: "attesting in progress",
-			// note: this model depends on a background reader. Multiple iterations ensures that the
-			// reader has time to at least start and process the test fixture before the runModel
-			// test harness completes (which is a fake event loop anyway).
-			iterations: 1,
-			eventFn: func(t *testing.T) partybus.Event {
-				reader := strings.NewReader("contents\nof\nstuff!")
-
-				src := monitor.GenericTask{
-					Title: monitor.Title{
-						Default:      "Create a thing",
-						WhileRunning: "Creating a thing",
-						OnSuccess:    "Created a thing",
-					},
-					Context: "running a thing",
-				}
-
-				mon := progress.NewManual(-1)
-				mon.Set(50)
-
-				value := &monitor.ShellProgress{
-					Reader:       reader,
-					Progressable: mon,
-				}
-
-				return partybus.Event{
-					Type:   syftEvent.AttestationStarted,
-					Source: src,
-					Value:  value,
-				}
-			},
-		},
-		{
-			name: "attesting complete",
-			// note: this model depends on a background reader. Multiple iterations ensures that the
-			// reader has time to at least start and process the test fixture before the runModel
-			// test harness completes (which is a fake event loop anyway).
-			iterations: 1,
-			eventFn: func(t *testing.T) partybus.Event {
-				reader := strings.NewReader("contents\nof\nstuff!")
-
-				src := monitor.GenericTask{
-					Title: monitor.Title{
-						Default:      "Create a thing",
-						WhileRunning: "Creating a thing",
-						OnSuccess:    "Created a thing",
-					},
-					Context: "running a thing",
-				}
-
-				mon := progress.NewManual(-1)
-				mon.Set(50)
-				mon.SetCompleted()
-
-				value := &monitor.ShellProgress{
-					Reader:       reader,
-					Progressable: mon,
-				}
-
-				return partybus.Event{
-					Type:   syftEvent.AttestationStarted,
-					Source: src,
-					Value:  value,
-				}
-			},
-		},
-	}
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			event := tt.eventFn(t)
-			handler := New(DefaultHandlerConfig())
-			handler.WindowSize = tea.WindowSizeMsg{
-				Width:  100,
-				Height: 80,
-			}
-
-			models, _ := handler.Handle(event)
-			require.Len(t, models, 2)
-
-			t.Run("task line", func(t *testing.T) {
-				tsk, ok := models[0].(taskprogress.Model)
-				require.True(t, ok)
-
-				gotModel := runModel(t, tsk, tt.iterations, taskprogress.TickMsg{
-					Time:     time.Now(),
-					Sequence: tsk.Sequence(),
-					ID:       tsk.ID(),
-				})
-
-				got := gotModel.View()
-
-				t.Log(got)
-				snaps.MatchSnapshot(t, got)
-			})
-
-			t.Run("log", func(t *testing.T) {
-				log, ok := models[1].(attestLogFrame)
-				require.True(t, ok)
-
-				gotModel := runModel(t, log, tt.iterations, attestLogFrameTickMsg{
-					Time:     time.Now(),
-					Sequence: log.sequence,
-					ID:       log.id,
-				}, log.reader.running)
-
-				got := gotModel.View()
-
-				t.Log(got)
-				snaps.MatchSnapshot(t, got)
-			})
-
-		})
-	}
-}

cmd/syft/cli/ui/handle_cataloger_task.go

@@ -1,123 +0,0 @@
-package ui
-
-import (
-	tea "github.com/charmbracelet/bubbletea"
-	"github.com/charmbracelet/lipgloss"
-	"github.com/google/uuid"
-	"github.com/wagoodman/go-partybus"
-	"github.com/wagoodman/go-progress"
-
-	"github.com/anchore/bubbly/bubbles/taskprogress"
-	"github.com/anchore/bubbly/bubbles/tree"
-	"github.com/anchore/syft/internal/log"
-	"github.com/anchore/syft/syft/event/monitor"
-	syftEventParsers "github.com/anchore/syft/syft/event/parsers"
-)
-
-// we standardize how rows are instantiated to ensure consistency in the appearance across the UI
-type taskModelFactory func(title taskprogress.Title, opts ...taskprogress.Option) taskprogress.Model
-
-var _ tea.Model = (*catalogerTaskModel)(nil)
-
-type catalogerTaskModel struct {
-	model        tree.Model
-	modelFactory taskModelFactory
-}
-
-func newCatalogerTaskTreeModel(f taskModelFactory) *catalogerTaskModel {
-	t := tree.NewModel()
-	t.Padding = "   "
-	t.RootsWithoutPrefix = true
-	return &catalogerTaskModel{
-		modelFactory: f,
-		model:        t,
-	}
-}
-
-type newCatalogerTaskRowEvent struct {
-	info monitor.GenericTask
-	prog progress.StagedProgressable
-}
-
-func (cts catalogerTaskModel) Init() tea.Cmd {
-	return cts.model.Init()
-}
-
-func (cts catalogerTaskModel) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
-	event, ok := msg.(newCatalogerTaskRowEvent)
-	if !ok {
-		model, cmd := cts.model.Update(msg)
-		cts.model = model.(tree.Model)
-
-		return cts, cmd
-	}
-
-	info, prog := event.info, event.prog
-
-	tsk := cts.modelFactory(
-		taskprogress.Title{
-			Default: info.Title.Default,
-			Running: info.Title.WhileRunning,
-			Success: info.Title.OnSuccess,
-		},
-		taskprogress.WithStagedProgressable(prog),
-	)
-
-	if info.Context != "" {
-		tsk.Context = []string{info.Context}
-	}
-
-	tsk.HideOnSuccess = info.HideOnSuccess
-	tsk.HideStageOnSuccess = info.HideStageOnSuccess
-	tsk.HideProgressOnSuccess = true
-
-	if info.ParentID != "" {
-		tsk.TitleStyle = lipgloss.NewStyle()
-	}
-
-	if err := cts.model.Add(info.ParentID, info.ID, tsk); err != nil {
-		log.WithFields("error", err).Error("unable to add cataloger task to tree model")
-	}
-
-	return cts, tsk.Init()
-}
-
-func (cts catalogerTaskModel) View() string {
-	return cts.model.View()
-}
-
-func (m *Handler) handleCatalogerTaskStarted(e partybus.Event) ([]tea.Model, tea.Cmd) {
-	mon, info, err := syftEventParsers.ParseCatalogerTaskStarted(e)
-	if err != nil {
-		log.WithFields("error", err).Warn("unable to parse event")
-		return nil, nil
-	}
-
-	var models []tea.Model
-
-	// only create the new cataloger task tree once to manage all cataloger task events
-	m.onNewCatalogerTask.Do(func() {
-		models = append(models, newCatalogerTaskTreeModel(m.newTaskProgress))
-	})
-
-	// we need to update the cataloger task model with a new row. We should never update the model outside of the
-	// bubbletea update-render event loop. Instead, we return a command that will be executed by the bubbletea runtime,
-	// producing a message that is passed to the cataloger task model. This is the prescribed way to update models
-	// in bubbletea.
-
-	if info.ID == "" {
-		// ID is optional from the consumer perspective, but required internally
-		info.ID = uuid.Must(uuid.NewRandom()).String()
-	}
-
-	cmd := func() tea.Msg {
-		// this message will cause the cataloger task model to add a new row to the output based on the given task
-		// information and progress data.
-		return newCatalogerTaskRowEvent{
-			info: *info,
-			prog: mon,
-		}
-	}
-
-	return models, cmd
-}

cmd/syft/cli/ui/handle_cataloger_task_test.go

@@ -1,198 +0,0 @@
-package ui
-
-import (
-	"testing"
-
-	tea "github.com/charmbracelet/bubbletea"
-	"github.com/gkampitakis/go-snaps/snaps"
-	"github.com/stretchr/testify/require"
-	"github.com/wagoodman/go-partybus"
-	"github.com/wagoodman/go-progress"
-
-	syftEvent "github.com/anchore/syft/syft/event"
-	"github.com/anchore/syft/syft/event/monitor"
-)
-
-func TestHandler_handleCatalogerTaskStarted(t *testing.T) {
-	title := monitor.Title{
-		Default:   "some task title",
-		OnSuccess: "some task done",
-	}
-	tests := []struct {
-		name       string
-		eventFn    func(*testing.T) partybus.Event
-		iterations int
-	}{
-		{
-			name: "cataloging task in progress",
-			eventFn: func(t *testing.T) partybus.Event {
-				value := &monitor.CatalogerTaskProgress{
-					AtomicStage: progress.NewAtomicStage("some stage"),
-					Manual:      progress.NewManual(100),
-				}
-
-				value.Manual.Add(50)
-
-				return partybus.Event{
-					Type: syftEvent.CatalogerTaskStarted,
-					Source: monitor.GenericTask{
-						Title:              title,
-						HideOnSuccess:      false,
-						HideStageOnSuccess: false,
-						ID:                 "my-id",
-					},
-					Value: value,
-				}
-			},
-		},
-		{
-			name: "cataloging sub task in progress",
-			eventFn: func(t *testing.T) partybus.Event {
-				value := &monitor.CatalogerTaskProgress{
-					AtomicStage: progress.NewAtomicStage("some stage"),
-					Manual:      progress.NewManual(100),
-				}
-
-				value.Manual.Add(50)
-
-				return partybus.Event{
-					Type: syftEvent.CatalogerTaskStarted,
-					Source: monitor.GenericTask{
-						Title:              title,
-						HideOnSuccess:      false,
-						HideStageOnSuccess: false,
-						ID:                 "my-id",
-						ParentID:           "top-level-task",
-					},
-					Value: value,
-				}
-			},
-		},
-		{
-			name: "cataloging sub task complete",
-			eventFn: func(t *testing.T) partybus.Event {
-				value := &monitor.CatalogerTaskProgress{
-					AtomicStage: progress.NewAtomicStage("some stage"),
-					Manual:      progress.NewManual(100),
-				}
-
-				value.SetCompleted()
-
-				return partybus.Event{
-					Type: syftEvent.CatalogerTaskStarted,
-					Source: monitor.GenericTask{
-						Title:              title,
-						HideOnSuccess:      false,
-						HideStageOnSuccess: false,
-						ID:                 "my-id",
-						ParentID:           "top-level-task",
-					},
-					Value: value,
-				}
-			},
-		},
-		{
-			name: "cataloging sub task complete -- hide stage",
-			eventFn: func(t *testing.T) partybus.Event {
-				value := &monitor.CatalogerTaskProgress{
-					AtomicStage: progress.NewAtomicStage("some stage"),
-					Manual:      progress.NewManual(100),
-				}
-
-				value.SetCompleted()
-
-				return partybus.Event{
-					Type: syftEvent.CatalogerTaskStarted,
-					Source: monitor.GenericTask{
-						Title:              title,
-						HideOnSuccess:      false,
-						HideStageOnSuccess: true,
-						ID:                 "my-id",
-						ParentID:           "top-level-task",
-					},
-					Value: value,
-				}
-			},
-		},
-		{
-			name: "cataloging sub task complete with removal",
-			eventFn: func(t *testing.T) partybus.Event {
-				value := &monitor.CatalogerTaskProgress{
-					AtomicStage: progress.NewAtomicStage("some stage"),
-					Manual:      progress.NewManual(100),
-				}
-
-				value.SetCompleted()
-
-				return partybus.Event{
-					Type: syftEvent.CatalogerTaskStarted,
-					Source: monitor.GenericTask{
-						Title:              title,
-						HideOnSuccess:      true,
-						HideStageOnSuccess: false,
-						ID:                 "my-id",
-						ParentID:           "top-level-task",
-					},
-					Value: value,
-				}
-			},
-		},
-	}
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			// need to be able to get the initial newCatalogerTaskRowEvent + initialize the nested taskprogress model
-			if tt.iterations == 0 {
-				tt.iterations = 2
-			}
-
-			e := tt.eventFn(t)
-			handler := New(DefaultHandlerConfig())
-			handler.WindowSize = tea.WindowSizeMsg{
-				Width:  100,
-				Height: 80,
-			}
-
-			info := monitor.GenericTask{
-				Title: monitor.Title{
-					Default:      "Catalog contents",
-					WhileRunning: "Cataloging contents",
-					OnSuccess:    "Cataloged contents",
-				},
-				ID: "top-level-task",
-			}
-
-			// note: this line / event is not under test, only needed to show a sub status
-			kickoffEvent := &monitor.CatalogerTaskProgress{
-				AtomicStage: progress.NewAtomicStage(""),
-				Manual:      progress.NewManual(-1),
-			}
-
-			models, cmd := handler.Handle(
-				partybus.Event{
-					Type:   syftEvent.CatalogerTaskStarted,
-					Source: info,
-					Value:  progress.StagedProgressable(kickoffEvent),
-				},
-			)
-			require.Len(t, models, 1)
-			require.NotNil(t, cmd)
-			model := models[0]
-
-			tr, ok := model.(*catalogerTaskModel)
-			require.True(t, ok)
-
-			gotModel := runModel(t, tr, tt.iterations, cmd())
-
-			models, cmd = handler.Handle(e)
-			require.Len(t, models, 0)
-			require.NotNil(t, cmd)
-
-			gotModel = runModel(t, gotModel, tt.iterations, cmd())
-
-			got := gotModel.View()
-
-			t.Log(got)
-			snaps.MatchSnapshot(t, got)
-		})
-	}
-}

cmd/syft/cli/ui/handle_fetch_image.go

@@ -1,32 +0,0 @@
-package ui
-
-import (
-	tea "github.com/charmbracelet/bubbletea"
-	"github.com/wagoodman/go-partybus"
-
-	"github.com/anchore/bubbly/bubbles/taskprogress"
-	stereoEventParsers "github.com/anchore/stereoscope/pkg/event/parsers"
-	"github.com/anchore/syft/internal/log"
-)
-
-func (m *Handler) handleFetchImage(e partybus.Event) []tea.Model {
-	imgName, prog, err := stereoEventParsers.ParseFetchImage(e)
-	if err != nil {
-		log.WithFields("error", err).Warn("unable to parse event")
-		return nil
-	}
-
-	tsk := m.newTaskProgress(
-		taskprogress.Title{
-			Default: "Load image",
-			Running: "Loading image",
-			Success: "Loaded image",
-		},
-		taskprogress.WithStagedProgressable(prog),
-	)
-	if imgName != "" {
-		tsk.Context = []string{imgName}
-	}
-
-	return []tea.Model{tsk}
-}

cmd/syft/cli/ui/handle_fetch_image_test.go

@@ -1,102 +0,0 @@
-package ui
-
-import (
-	"testing"
-	"time"
-
-	tea "github.com/charmbracelet/bubbletea"
-	"github.com/gkampitakis/go-snaps/snaps"
-	"github.com/stretchr/testify/require"
-	"github.com/wagoodman/go-partybus"
-	"github.com/wagoodman/go-progress"
-
-	"github.com/anchore/bubbly/bubbles/taskprogress"
-	stereoscopeEvent "github.com/anchore/stereoscope/pkg/event"
-)
-
-func TestHandler_handleFetchImage(t *testing.T) {
-
-	tests := []struct {
-		name       string
-		eventFn    func(*testing.T) partybus.Event
-		iterations int
-	}{
-		{
-			name: "fetch image in progress",
-			eventFn: func(t *testing.T) partybus.Event {
-				prog := &progress.Manual{}
-				prog.SetTotal(100)
-				prog.Set(50)
-
-				mon := struct {
-					progress.Progressable
-					progress.Stager
-				}{
-					Progressable: prog,
-					Stager: &progress.Stage{
-						Current: "current",
-					},
-				}
-
-				return partybus.Event{
-					Type:   stereoscopeEvent.FetchImage,
-					Source: "the-image",
-					Value:  mon,
-				}
-			},
-		},
-		{
-			name: "fetch image complete",
-			eventFn: func(t *testing.T) partybus.Event {
-				prog := &progress.Manual{}
-				prog.SetTotal(100)
-				prog.Set(100)
-				prog.SetCompleted()
-
-				mon := struct {
-					progress.Progressable
-					progress.Stager
-				}{
-					Progressable: prog,
-					Stager: &progress.Stage{
-						Current: "current",
-					},
-				}
-
-				return partybus.Event{
-					Type:   stereoscopeEvent.FetchImage,
-					Source: "the-image",
-					Value:  mon,
-				}
-			},
-		},
-	}
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			event := tt.eventFn(t)
-			handler := New(DefaultHandlerConfig())
-			handler.WindowSize = tea.WindowSizeMsg{
-				Width:  100,
-				Height: 80,
-			}
-
-			models, _ := handler.Handle(event)
-			require.Len(t, models, 1)
-			model := models[0]
-
-			tsk, ok := model.(taskprogress.Model)
-			require.True(t, ok)
-
-			gotModel := runModel(t, tsk, tt.iterations, taskprogress.TickMsg{
-				Time:     time.Now(),
-				Sequence: tsk.Sequence(),
-				ID:       tsk.ID(),
-			})
-
-			got := gotModel.View()
-
-			t.Log(got)
-			snaps.MatchSnapshot(t, got)
-		})
-	}
-}

cmd/syft/cli/ui/handle_file_indexing.go

@@ -1,31 +0,0 @@
-package ui
-
-import (
-	tea "github.com/charmbracelet/bubbletea"
-	"github.com/wagoodman/go-partybus"
-
-	"github.com/anchore/bubbly/bubbles/taskprogress"
-	"github.com/anchore/syft/internal/log"
-	syftEventParsers "github.com/anchore/syft/syft/event/parsers"
-)
-
-func (m *Handler) handleFileIndexingStarted(e partybus.Event) []tea.Model {
-	path, prog, err := syftEventParsers.ParseFileIndexingStarted(e)
-	if err != nil {
-		log.WithFields("error", err).Warn("unable to parse event")
-		return nil
-	}
-
-	tsk := m.newTaskProgress(
-		taskprogress.Title{
-			Default: "Index files system",
-			Running: "Indexing file system",
-			Success: "Indexed file system",
-		},
-		taskprogress.WithStagedProgressable(prog),
-	)
-
-	tsk.Context = []string{path}
-
-	return []tea.Model{tsk}
-}

cmd/syft/cli/ui/handle_file_indexing_test.go

@@ -1,102 +0,0 @@
-package ui
-
-import (
-	"testing"
-	"time"
-
-	tea "github.com/charmbracelet/bubbletea"
-	"github.com/gkampitakis/go-snaps/snaps"
-	"github.com/stretchr/testify/require"
-	"github.com/wagoodman/go-partybus"
-	"github.com/wagoodman/go-progress"
-
-	"github.com/anchore/bubbly/bubbles/taskprogress"
-	syftEvent "github.com/anchore/syft/syft/event"
-)
-
-func TestHandler_handleFileIndexingStarted(t *testing.T) {
-
-	tests := []struct {
-		name       string
-		eventFn    func(*testing.T) partybus.Event
-		iterations int
-	}{
-		{
-			name: "cataloging in progress",
-			eventFn: func(t *testing.T) partybus.Event {
-				prog := &progress.Manual{}
-				prog.SetTotal(100)
-				prog.Set(50)
-
-				mon := struct {
-					progress.Progressable
-					progress.Stager
-				}{
-					Progressable: prog,
-					Stager: &progress.Stage{
-						Current: "current",
-					},
-				}
-
-				return partybus.Event{
-					Type:   syftEvent.FileIndexingStarted,
-					Source: "/some/path",
-					Value:  mon,
-				}
-			},
-		},
-		{
-			name: "cataloging complete",
-			eventFn: func(t *testing.T) partybus.Event {
-				prog := &progress.Manual{}
-				prog.SetTotal(100)
-				prog.Set(100)
-				prog.SetCompleted()
-
-				mon := struct {
-					progress.Progressable
-					progress.Stager
-				}{
-					Progressable: prog,
-					Stager: &progress.Stage{
-						Current: "current",
-					},
-				}
-
-				return partybus.Event{
-					Type:   syftEvent.FileIndexingStarted,
-					Source: "/some/path",
-					Value:  mon,
-				}
-			},
-		},
-	}
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			event := tt.eventFn(t)
-			handler := New(DefaultHandlerConfig())
-			handler.WindowSize = tea.WindowSizeMsg{
-				Width:  100,
-				Height: 80,
-			}
-
-			models, _ := handler.Handle(event)
-			require.Len(t, models, 1)
-			model := models[0]
-
-			tsk, ok := model.(taskprogress.Model)
-			require.True(t, ok)
-
-			gotModel := runModel(t, tsk, tt.iterations, taskprogress.TickMsg{
-				Time:     time.Now(),
-				Sequence: tsk.Sequence(),
-				ID:       tsk.ID(),
-			})
-
-			got := gotModel.View()
-
-			t.Log(got)
-			snaps.MatchSnapshot(t, got)
-		})
-	}
-}

cmd/syft/cli/ui/handle_pull_containerd_image.go

@@ -1,190 +0,0 @@
-package ui
-
-import (
-	"fmt"
-	"strings"
-
-	tea "github.com/charmbracelet/bubbletea"
-	"github.com/charmbracelet/lipgloss"
-	"github.com/dustin/go-humanize"
-	"github.com/wagoodman/go-partybus"
-	"github.com/wagoodman/go-progress"
-
-	"github.com/anchore/bubbly/bubbles/taskprogress"
-	stereoscopeParsers "github.com/anchore/stereoscope/pkg/event/parsers"
-	"github.com/anchore/stereoscope/pkg/image/containerd"
-	"github.com/anchore/syft/internal/log"
-)
-
-var _ interface {
-	progress.Stager
-	progress.Progressable
-} = (*containerdPullProgressAdapter)(nil)
-
-type containerdPullStatus interface {
-	Complete() bool
-	Layers() []containerd.LayerID
-	Current(containerd.LayerID) progress.Progressable
-}
-
-type containerdPullProgressAdapter struct {
-	status    containerdPullStatus
-	formatter containerdPullStatusFormatter
-}
-
-type containerdPullStatusFormatter struct {
-	auxInfoStyle       lipgloss.Style
-	pullCompletedStyle lipgloss.Style
-	pullDownloadStyle  lipgloss.Style
-	pullStageChars     []string
-	layerCaps          []string
-}
-
-func (m *Handler) handlePullContainerdImage(e partybus.Event) []tea.Model {
-	_, pullStatus, err := stereoscopeParsers.ParsePullContainerdImage(e)
-	if err != nil {
-		log.WithFields("error", err).Warn("unable to parse event")
-		return nil
-	}
-
-	if pullStatus == nil {
-		return nil
-	}
-
-	tsk := m.newTaskProgress(
-		taskprogress.Title{
-			Default: "Pull image",
-			Running: "Pulling image",
-			Success: "Pulled image",
-		},
-		taskprogress.WithStagedProgressable(
-			newContainerdPullProgressAdapter(pullStatus),
-		),
-	)
-
-	tsk.HintStyle = lipgloss.NewStyle()
-	tsk.HintEndCaps = nil
-
-	return []tea.Model{tsk}
-}
-
-func newContainerdPullProgressAdapter(status *containerd.PullStatus) *containerdPullProgressAdapter {
-	return &containerdPullProgressAdapter{
-		status:    status,
-		formatter: newContainerdPullStatusFormatter(),
-	}
-}
-
-func newContainerdPullStatusFormatter() containerdPullStatusFormatter {
-	return containerdPullStatusFormatter{
-		auxInfoStyle:       lipgloss.NewStyle().Foreground(lipgloss.Color("#777777")),
-		pullCompletedStyle: lipgloss.NewStyle().Foreground(lipgloss.Color("#fcba03")),
-		pullDownloadStyle:  lipgloss.NewStyle().Foreground(lipgloss.Color("#777777")),
-		pullStageChars:     strings.Split("▁▃▄▅▆▇█", ""),
-		layerCaps:          strings.Split("▕▏", ""),
-	}
-}
-
-func (d containerdPullProgressAdapter) Size() int64 {
-	return -1
-}
-
-func (d containerdPullProgressAdapter) Current() int64 {
-	return 1
-}
-
-func (d containerdPullProgressAdapter) Error() error {
-	if d.status.Complete() {
-		return progress.ErrCompleted
-	}
-	// TODO: return intermediate error indications
-	return nil
-}
-
-func (d containerdPullProgressAdapter) Stage() string {
-	return d.formatter.Render(d.status)
-}
-
-// Render crafts the given docker image pull status summarized into a single line.
-func (f containerdPullStatusFormatter) Render(pullStatus containerdPullStatus) string {
-	var size, current uint64
-
-	layers := pullStatus.Layers()
-	status := make(map[containerd.LayerID]progress.Progressable)
-	completed := make([]string, len(layers))
-
-	// fetch the current state
-	for idx, layer := range layers {
-		completed[idx] = " "
-		status[layer] = pullStatus.Current(layer)
-	}
-
-	numCompleted := 0
-	for idx, layer := range layers {
-		prog := status[layer]
-		curN := prog.Current()
-		curSize := prog.Size()
-
-		if progress.IsCompleted(prog) {
-			input := f.pullStageChars[len(f.pullStageChars)-1]
-			completed[idx] = f.formatPullPhase(prog.Error() != nil, input)
-		} else if curN != 0 {
-			var ratio float64
-			switch {
-			case curN == 0 || curSize < 0:
-				ratio = 0
-			case curN >= curSize:
-				ratio = 1
-			default:
-				ratio = float64(curN) / float64(curSize)
-			}
-
-			i := int(ratio * float64(len(f.pullStageChars)-1))
-			input := f.pullStageChars[i]
-			completed[idx] = f.formatPullPhase(status[layer].Error() != nil, input)
-		}
-
-		if progress.IsErrCompleted(status[layer].Error()) {
-			numCompleted++
-		}
-	}
-
-	for _, layer := range layers {
-		prog := status[layer]
-		size += uint64(prog.Size())
-		current += uint64(prog.Current())
-	}
-
-	var progStr, auxInfo string
-	if len(layers) > 0 {
-		render := strings.Join(completed, "")
-		prefix := f.pullCompletedStyle.Render(fmt.Sprintf("%d Layers", len(layers)))
-		auxInfo = f.auxInfoStyle.Render(fmt.Sprintf("[%s / %s]", humanize.Bytes(current), humanize.Bytes(size)))
-		if len(layers) == numCompleted {
-			auxInfo = f.auxInfoStyle.Render(fmt.Sprintf("[%s] Extracting...", humanize.Bytes(size)))
-		}
-
-		progStr = fmt.Sprintf("%s%s%s%s", prefix, f.layerCap(false), render, f.layerCap(true))
-	}
-
-	return progStr + auxInfo
-}
-
-// formatPullPhase returns a single character that represents the status of a layer pull.
-func (f containerdPullStatusFormatter) formatPullPhase(completed bool, inputStr string) string {
-	if completed {
-		return f.pullCompletedStyle.Render(f.pullStageChars[len(f.pullStageChars)-1])
-	}
-	return f.pullDownloadStyle.Render(inputStr)
-}
-
-func (f containerdPullStatusFormatter) layerCap(end bool) string {
-	l := len(f.layerCaps)
-	if l == 0 {
-		return ""
-	}
-	if end {
-		return f.layerCaps[l-1]
-	}
-	return f.layerCaps[0]
-}

cmd/syft/cli/ui/handle_pull_docker_image.go

@@ -1,201 +0,0 @@
-package ui
-
-import (
-	"fmt"
-	"strings"
-
-	tea "github.com/charmbracelet/bubbletea"
-	"github.com/charmbracelet/lipgloss"
-	"github.com/dustin/go-humanize"
-	"github.com/wagoodman/go-partybus"
-	"github.com/wagoodman/go-progress"
-
-	"github.com/anchore/bubbly/bubbles/taskprogress"
-	stereoscopeParsers "github.com/anchore/stereoscope/pkg/event/parsers"
-	"github.com/anchore/stereoscope/pkg/image/docker"
-	"github.com/anchore/syft/internal/log"
-)
-
-var _ interface {
-	progress.Stager
-	progress.Progressable
-} = (*dockerPullProgressAdapter)(nil)
-
-type dockerPullStatus interface {
-	Complete() bool
-	Layers() []docker.LayerID
-	Current(docker.LayerID) docker.LayerState
-}
-
-type dockerPullProgressAdapter struct {
-	status    dockerPullStatus
-	formatter dockerPullStatusFormatter
-}
-
-type dockerPullStatusFormatter struct {
-	auxInfoStyle             lipgloss.Style
-	dockerPullCompletedStyle lipgloss.Style
-	dockerPullDownloadStyle  lipgloss.Style
-	dockerPullExtractStyle   lipgloss.Style
-	dockerPullStageChars     []string
-	layerCaps                []string
-}
-
-func (m *Handler) handlePullDockerImage(e partybus.Event) []tea.Model {
-	_, pullStatus, err := stereoscopeParsers.ParsePullDockerImage(e)
-	if err != nil {
-		log.WithFields("error", err).Warn("unable to parse event")
-		return nil
-	}
-
-	tsk := m.newTaskProgress(
-		taskprogress.Title{
-			Default: "Pull image",
-			Running: "Pulling image",
-			Success: "Pulled image",
-		},
-		taskprogress.WithStagedProgressable(
-			newDockerPullProgressAdapter(pullStatus),
-		),
-	)
-
-	tsk.HintStyle = lipgloss.NewStyle()
-	tsk.HintEndCaps = nil
-
-	return []tea.Model{tsk}
-}
-
-func newDockerPullProgressAdapter(status dockerPullStatus) *dockerPullProgressAdapter {
-	return &dockerPullProgressAdapter{
-		status:    status,
-		formatter: newDockerPullStatusFormatter(),
-	}
-}
-
-func newDockerPullStatusFormatter() dockerPullStatusFormatter {
-	return dockerPullStatusFormatter{
-		auxInfoStyle:             lipgloss.NewStyle().Foreground(lipgloss.Color("#777777")),
-		dockerPullCompletedStyle: lipgloss.NewStyle().Foreground(lipgloss.Color("#fcba03")),
-		dockerPullDownloadStyle:  lipgloss.NewStyle().Foreground(lipgloss.Color("#777777")),
-		dockerPullExtractStyle:   lipgloss.NewStyle().Foreground(lipgloss.Color("#ffffff")),
-		dockerPullStageChars:     strings.Split("▁▃▄▅▆▇█", ""),
-		layerCaps:                strings.Split("▕▏", ""),
-	}
-}
-
-func (d dockerPullProgressAdapter) Size() int64 {
-	return -1
-}
-
-func (d dockerPullProgressAdapter) Current() int64 {
-	return 1
-}
-
-func (d dockerPullProgressAdapter) Error() error {
-	if d.status.Complete() {
-		return progress.ErrCompleted
-	}
-	// TODO: return intermediate error indications
-	return nil
-}
-
-func (d dockerPullProgressAdapter) Stage() string {
-	return d.formatter.Render(d.status)
-}
-
-// Render crafts the given docker image pull status summarized into a single line.
-func (f dockerPullStatusFormatter) Render(pullStatus dockerPullStatus) string {
-	var size, current uint64
-
-	layers := pullStatus.Layers()
-	status := make(map[docker.LayerID]docker.LayerState)
-	completed := make([]string, len(layers))
-
-	// fetch the current state
-	for idx, layer := range layers {
-		completed[idx] = " "
-		status[layer] = pullStatus.Current(layer)
-	}
-
-	numCompleted := 0
-	for idx, layer := range layers {
-		prog := status[layer].PhaseProgress
-		curN := prog.Current()
-		curSize := prog.Size()
-
-		if progress.IsCompleted(prog) {
-			input := f.dockerPullStageChars[len(f.dockerPullStageChars)-1]
-			completed[idx] = f.formatDockerPullPhase(status[layer].Phase, input)
-		} else if curN != 0 {
-			var ratio float64
-			switch {
-			case curN == 0 || curSize < 0:
-				ratio = 0
-			case curN >= curSize:
-				ratio = 1
-			default:
-				ratio = float64(curN) / float64(curSize)
-			}
-
-			i := int(ratio * float64(len(f.dockerPullStageChars)-1))
-			input := f.dockerPullStageChars[i]
-			completed[idx] = f.formatDockerPullPhase(status[layer].Phase, input)
-		}
-
-		if progress.IsErrCompleted(status[layer].DownloadProgress.Error()) {
-			numCompleted++
-		}
-	}
-
-	for _, layer := range layers {
-		prog := status[layer].DownloadProgress
-		size += uint64(prog.Size())
-		current += uint64(prog.Current())
-	}
-
-	var progStr, auxInfo string
-	if len(layers) > 0 {
-		render := strings.Join(completed, "")
-		prefix := f.dockerPullCompletedStyle.Render(fmt.Sprintf("%d Layers", len(layers)))
-		auxInfo = f.auxInfoStyle.Render(fmt.Sprintf("[%s / %s]", humanize.Bytes(current), humanize.Bytes(size)))
-		if len(layers) == numCompleted {
-			auxInfo = f.auxInfoStyle.Render(fmt.Sprintf("[%s] Extracting...", humanize.Bytes(size)))
-		}
-
-		progStr = fmt.Sprintf("%s%s%s%s", prefix, f.layerCap(false), render, f.layerCap(true))
-	}
-
-	return progStr + auxInfo
-}
-
-// formatDockerPullPhase returns a single character that represents the status of a layer pull.
-func (f dockerPullStatusFormatter) formatDockerPullPhase(phase docker.PullPhase, inputStr string) string {
-	switch phase {
-	case docker.WaitingPhase:
-		// ignore any progress related to waiting
-		return " "
-	case docker.PullingFsPhase, docker.DownloadingPhase:
-		return f.dockerPullDownloadStyle.Render(inputStr)
-	case docker.DownloadCompletePhase:
-		return f.dockerPullDownloadStyle.Render(f.dockerPullStageChars[len(f.dockerPullStageChars)-1])
-	case docker.ExtractingPhase:
-		return f.dockerPullExtractStyle.Render(inputStr)
-	case docker.VerifyingChecksumPhase, docker.PullCompletePhase:
-		return f.dockerPullCompletedStyle.Render(inputStr)
-	case docker.AlreadyExistsPhase:
-		return f.dockerPullCompletedStyle.Render(f.dockerPullStageChars[len(f.dockerPullStageChars)-1])
-	default:
-		return inputStr
-	}
-}
-
-func (f dockerPullStatusFormatter) layerCap(end bool) string {
-	l := len(f.layerCaps)
-	if l == 0 {
-		return ""
-	}
-	if end {
-		return f.layerCaps[l-1]
-	}
-	return f.layerCaps[0]
-}

cmd/syft/cli/ui/handle_pull_docker_image_test.go

@@ -1,163 +0,0 @@
-package ui
-
-import (
-	"testing"
-
-	"github.com/gkampitakis/go-snaps/snaps"
-	"github.com/wagoodman/go-progress"
-
-	"github.com/anchore/stereoscope/pkg/image/docker"
-)
-
-var _ dockerPullStatus = (*mockDockerPullStatus)(nil)
-
-type mockDockerPullStatus struct {
-	complete bool
-	layers   []docker.LayerID
-	current  map[docker.LayerID]docker.LayerState
-}
-
-func (m mockDockerPullStatus) Complete() bool {
-	return m.complete
-}
-
-func (m mockDockerPullStatus) Layers() []docker.LayerID {
-	return m.layers
-}
-
-func (m mockDockerPullStatus) Current(id docker.LayerID) docker.LayerState {
-	return m.current[id]
-}
-
-func Test_dockerPullStatusFormatter_Render(t *testing.T) {
-
-	tests := []struct {
-		name   string
-		status dockerPullStatus
-	}{
-		{
-			name: "pulling",
-			status: func() dockerPullStatus {
-				complete := progress.NewManual(10)
-				complete.Set(10)
-				complete.SetCompleted()
-
-				quarter := progress.NewManual(10)
-				quarter.Set(2)
-
-				half := progress.NewManual(10)
-				half.Set(6)
-
-				empty := progress.NewManual(10)
-
-				return mockDockerPullStatus{
-					complete: false,
-					layers: []docker.LayerID{
-						"sha256:1",
-						"sha256:2",
-						"sha256:3",
-					},
-					current: map[docker.LayerID]docker.LayerState{
-						"sha256:1": {
-							Phase:            docker.ExtractingPhase,
-							PhaseProgress:    half,
-							DownloadProgress: complete,
-						},
-						"sha256:2": {
-							Phase:            docker.DownloadingPhase,
-							PhaseProgress:    quarter,
-							DownloadProgress: quarter,
-						},
-						"sha256:3": {
-							Phase:            docker.WaitingPhase,
-							PhaseProgress:    empty,
-							DownloadProgress: empty,
-						},
-					},
-				}
-			}(),
-		},
-		{
-			name: "download complete",
-			status: func() dockerPullStatus {
-				complete := progress.NewManual(10)
-				complete.Set(10)
-				complete.SetCompleted()
-
-				quarter := progress.NewManual(10)
-				quarter.Set(2)
-
-				half := progress.NewManual(10)
-				half.Set(6)
-
-				empty := progress.NewManual(10)
-
-				return mockDockerPullStatus{
-					complete: false,
-					layers: []docker.LayerID{
-						"sha256:1",
-						"sha256:2",
-						"sha256:3",
-					},
-					current: map[docker.LayerID]docker.LayerState{
-						"sha256:1": {
-							Phase:            docker.ExtractingPhase,
-							PhaseProgress:    complete,
-							DownloadProgress: complete,
-						},
-						"sha256:2": {
-							Phase:            docker.ExtractingPhase,
-							PhaseProgress:    quarter,
-							DownloadProgress: complete,
-						},
-						"sha256:3": {
-							Phase:            docker.ExtractingPhase,
-							PhaseProgress:    empty,
-							DownloadProgress: complete,
-						},
-					},
-				}
-			}(),
-		},
-		{
-			name: "complete",
-			status: func() dockerPullStatus {
-				complete := progress.NewManual(10)
-				complete.Set(10)
-				complete.SetCompleted()
-
-				return mockDockerPullStatus{
-					complete: true,
-					layers: []docker.LayerID{
-						"sha256:1",
-						"sha256:2",
-						"sha256:3",
-					},
-					current: map[docker.LayerID]docker.LayerState{
-						"sha256:1": {
-							Phase:            docker.PullCompletePhase,
-							PhaseProgress:    complete,
-							DownloadProgress: complete,
-						},
-						"sha256:2": {
-							Phase:            docker.PullCompletePhase,
-							PhaseProgress:    complete,
-							DownloadProgress: complete,
-						},
-						"sha256:3": {
-							Phase:            docker.PullCompletePhase,
-							PhaseProgress:    complete,
-							DownloadProgress: complete,
-						},
-					},
-				}
-			}(),
-		},
-	}
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			f := newDockerPullStatusFormatter()
-			snaps.MatchSnapshot(t, f.Render(tt.status))
-		})
-	}
-}

cmd/syft/cli/ui/handle_read_image.go

@@ -1,33 +0,0 @@
-package ui
-
-import (
-	tea "github.com/charmbracelet/bubbletea"
-	"github.com/wagoodman/go-partybus"
-
-	"github.com/anchore/bubbly/bubbles/taskprogress"
-	stereoEventParsers "github.com/anchore/stereoscope/pkg/event/parsers"
-	"github.com/anchore/syft/internal/log"
-)
-
-func (m *Handler) handleReadImage(e partybus.Event) []tea.Model {
-	imgMetadata, prog, err := stereoEventParsers.ParseReadImage(e)
-	if err != nil {
-		log.WithFields("error", err).Warn("unable to parse event")
-		return nil
-	}
-
-	tsk := m.newTaskProgress(
-		taskprogress.Title{
-			Default: "Parse image",
-			Running: "Parsing image",
-			Success: "Parsed image",
-		},
-		taskprogress.WithProgress(prog),
-	)
-
-	if imgMetadata != nil {
-		tsk.Context = []string{imgMetadata.ID}
-	}
-
-	return []tea.Model{tsk}
-}

cmd/syft/cli/ui/handle_read_image_test.go

@@ -1,120 +0,0 @@
-package ui
-
-import (
-	"testing"
-	"time"
-
-	tea "github.com/charmbracelet/bubbletea"
-	"github.com/gkampitakis/go-snaps/snaps"
-	v1 "github.com/google/go-containerregistry/pkg/v1"
-	"github.com/stretchr/testify/require"
-	"github.com/wagoodman/go-partybus"
-	"github.com/wagoodman/go-progress"
-
-	"github.com/anchore/bubbly/bubbles/taskprogress"
-	stereoscopeEvent "github.com/anchore/stereoscope/pkg/event"
-	"github.com/anchore/stereoscope/pkg/image"
-)
-
-func TestHandler_handleReadImage(t *testing.T) {
-
-	tests := []struct {
-		name       string
-		eventFn    func(*testing.T) partybus.Event
-		iterations int
-	}{
-		{
-			name: "read image in progress",
-			eventFn: func(t *testing.T) partybus.Event {
-				prog := &progress.Manual{}
-				prog.SetTotal(100)
-				prog.Set(50)
-
-				src := image.Metadata{
-					ID:   "id",
-					Size: 42,
-					Config: v1.ConfigFile{
-						Architecture: "arch",
-						Author:       "auth",
-						Container:    "cont",
-						OS:           "os",
-						OSVersion:    "os-ver",
-						Variant:      "vari",
-					},
-					MediaType:      "media",
-					ManifestDigest: "digest",
-					Architecture:   "arch",
-					Variant:        "var",
-					OS:             "os",
-				}
-
-				return partybus.Event{
-					Type:   stereoscopeEvent.ReadImage,
-					Source: src,
-					Value:  prog,
-				}
-			},
-		},
-		{
-			name: "read image complete",
-			eventFn: func(t *testing.T) partybus.Event {
-				prog := &progress.Manual{}
-				prog.SetTotal(100)
-				prog.Set(100)
-				prog.SetCompleted()
-
-				src := image.Metadata{
-					ID:   "id",
-					Size: 42,
-					Config: v1.ConfigFile{
-						Architecture: "arch",
-						Author:       "auth",
-						Container:    "cont",
-						OS:           "os",
-						OSVersion:    "os-ver",
-						Variant:      "vari",
-					},
-					MediaType:      "media",
-					ManifestDigest: "digest",
-					Architecture:   "arch",
-					Variant:        "var",
-					OS:             "os",
-				}
-
-				return partybus.Event{
-					Type:   stereoscopeEvent.ReadImage,
-					Source: src,
-					Value:  prog,
-				}
-			},
-		},
-	}
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			event := tt.eventFn(t)
-			handler := New(DefaultHandlerConfig())
-			handler.WindowSize = tea.WindowSizeMsg{
-				Width:  100,
-				Height: 80,
-			}
-
-			models, _ := handler.Handle(event)
-			require.Len(t, models, 1)
-			model := models[0]
-
-			tsk, ok := model.(taskprogress.Model)
-			require.True(t, ok)
-
-			gotModel := runModel(t, tsk, tt.iterations, taskprogress.TickMsg{
-				Time:     time.Now(),
-				Sequence: tsk.Sequence(),
-				ID:       tsk.ID(),
-			})
-
-			got := gotModel.View()
-
-			t.Log(got)
-			snaps.MatchSnapshot(t, got)
-		})
-	}
-}

cmd/syft/cli/ui/handler.go

@@ -1,80 +0,0 @@
-package ui
-
-import (
-	"sync"
-
-	tea "github.com/charmbracelet/bubbletea"
-	"github.com/wagoodman/go-partybus"
-
-	"github.com/anchore/bubbly"
-	"github.com/anchore/bubbly/bubbles/taskprogress"
-	stereoscopeEvent "github.com/anchore/stereoscope/pkg/event"
-	syftEvent "github.com/anchore/syft/syft/event"
-)
-
-var _ interface {
-	bubbly.EventHandler
-	bubbly.MessageListener
-	bubbly.HandleWaiter
-} = (*Handler)(nil)
-
-type HandlerConfig struct {
-	TitleWidth        int
-	AdjustDefaultTask func(taskprogress.Model) taskprogress.Model
-}
-
-type Handler struct {
-	WindowSize tea.WindowSizeMsg
-	Running    *sync.WaitGroup
-	Config     HandlerConfig
-
-	bubbly.EventHandler
-
-	onNewCatalogerTask *sync.Once
-}
-
-func DefaultHandlerConfig() HandlerConfig {
-	return HandlerConfig{
-		TitleWidth: 30,
-	}
-}
-
-func New(cfg HandlerConfig) *Handler {
-	d := bubbly.NewEventDispatcher()
-
-	h := &Handler{
-		EventHandler:       d,
-		Running:            &sync.WaitGroup{},
-		Config:             cfg,
-		onNewCatalogerTask: &sync.Once{},
-	}
-
-	// register all supported event types with the respective handler functions
-	d.AddHandlers(map[partybus.EventType]bubbly.EventHandlerFn{
-		stereoscopeEvent.PullDockerImage:     simpleHandler(h.handlePullDockerImage),
-		stereoscopeEvent.PullContainerdImage: simpleHandler(h.handlePullContainerdImage),
-		stereoscopeEvent.ReadImage:           simpleHandler(h.handleReadImage),
-		stereoscopeEvent.FetchImage:          simpleHandler(h.handleFetchImage),
-		syftEvent.FileIndexingStarted:        simpleHandler(h.handleFileIndexingStarted),
-		syftEvent.AttestationStarted:         simpleHandler(h.handleAttestationStarted),
-		syftEvent.CatalogerTaskStarted:       h.handleCatalogerTaskStarted,
-	})
-
-	return h
-}
-
-func simpleHandler(fn func(partybus.Event) []tea.Model) bubbly.EventHandlerFn {
-	return func(e partybus.Event) ([]tea.Model, tea.Cmd) {
-		return fn(e), nil
-	}
-}
-
-func (m *Handler) OnMessage(msg tea.Msg) {
-	if msg, ok := msg.(tea.WindowSizeMsg); ok {
-		m.WindowSize = msg
-	}
-}
-
-func (m *Handler) Wait() {
-	m.Running.Wait()
-}

cmd/syft/cli/ui/new_task_progress.go

@@ -1,19 +0,0 @@
-package ui
-
-import "github.com/anchore/bubbly/bubbles/taskprogress"
-
-func (m Handler) newTaskProgress(title taskprogress.Title, opts ...taskprogress.Option) taskprogress.Model {
-	tsk := taskprogress.New(m.Running, opts...)
-
-	tsk.HideProgressOnSuccess = true
-	tsk.HideStageOnSuccess = true
-	tsk.WindowSize = m.WindowSize
-	tsk.TitleWidth = m.Config.TitleWidth
-	tsk.TitleOptions = title
-
-	if m.Config.AdjustDefaultTask != nil {
-		tsk = m.Config.AdjustDefaultTask(tsk)
-	}
-
-	return tsk
-}

cmd/syft/cli/ui/util_test.go

@@ -1,56 +0,0 @@
-package ui
-
-import (
-	"reflect"
-	"sync"
-	"testing"
-
-	tea "github.com/charmbracelet/bubbletea"
-)
-
-func runModel(t testing.TB, m tea.Model, iterations int, message tea.Msg, h ...*sync.WaitGroup) tea.Model {
-	t.Helper()
-	if iterations == 0 {
-		iterations = 1
-	}
-	m.Init()
-	var cmd tea.Cmd = func() tea.Msg {
-		return message
-	}
-
-	for _, each := range h {
-		if each != nil {
-			each.Wait()
-		}
-	}
-
-	for i := 0; cmd != nil && i < iterations; i++ {
-		msgs := flatten(cmd())
-		var nextCmds []tea.Cmd
-		var next tea.Cmd
-		for _, msg := range msgs {
-			t.Logf("Message: %+v %+v\n", reflect.TypeOf(msg), msg)
-			m, next = m.Update(msg)
-			nextCmds = append(nextCmds, next)
-		}
-		cmd = tea.Batch(nextCmds...)
-	}
-
-	return m
-}
-
-func flatten(ps ...tea.Msg) (msgs []tea.Msg) {
-	for _, p := range ps {
-		if bm, ok := p.(tea.BatchMsg); ok {
-			for _, m := range bm {
-				if m == nil {
-					continue
-				}
-				msgs = append(msgs, flatten(m())...)
-			}
-		} else {
-			msgs = []tea.Msg{p}
-		}
-	}
-	return msgs
-}

cmd/syft/internal/clio_setup_config.go

@@ -1,55 +0,0 @@
-package internal
-
-import (
-	"io"
-	"os"
-
-	"github.com/anchore/clio"
-	"github.com/anchore/stereoscope"
-	ui2 "github.com/anchore/syft/cmd/syft/cli/ui"
-	"github.com/anchore/syft/cmd/syft/internal/ui"
-	"github.com/anchore/syft/internal/bus"
-	"github.com/anchore/syft/internal/log"
-	"github.com/anchore/syft/internal/redact"
-)
-
-func AppClioSetupConfig(id clio.Identification, out io.Writer) *clio.SetupConfig {
-	clioCfg := clio.NewSetupConfig(id).
-		WithGlobalConfigFlag().   // add persistent -c <path> for reading an application config from
-		WithGlobalLoggingFlags(). // add persistent -v and -q flags tied to the logging config
-		WithConfigInRootHelp().   // --help on the root command renders the full application config in the help text
-		WithUIConstructor(
-			// select a UI based on the logging configuration and state of stdin (if stdin is a tty)
-			func(cfg clio.Config) ([]clio.UI, error) {
-				noUI := ui.None(out, cfg.Log.Quiet)
-				if !cfg.Log.AllowUI(os.Stdin) || cfg.Log.Quiet {
-					return []clio.UI{noUI}, nil
-				}
-
-				return []clio.UI{
-					ui.New(out, cfg.Log.Quiet,
-						ui2.New(ui2.DefaultHandlerConfig()),
-					),
-					noUI,
-				}, nil
-			},
-		).
-		WithInitializers(
-			func(state *clio.State) error {
-				// clio is setting up and providing the bus, redact store, and logger to the application. Once loaded,
-				// we can hoist them into the internal packages for global use.
-				stereoscope.SetBus(state.Bus)
-				bus.Set(state.Bus)
-
-				redact.Set(state.RedactStore)
-
-				log.Set(state.Logger)
-				stereoscope.SetLogger(state.Logger)
-				return nil
-			},
-		).
-		WithPostRuns(func(_ *clio.State, _ error) {
-			stereoscope.Cleanup()
-		})
-	return clioCfg
-}

cmd/syft/internal/commands/attest.go

@@ -1,283 +0,0 @@
-package commands
-
-import (
-	"context"
-	"fmt"
-	"io"
-	"os"
-	"os/exec"
-	"strings"
-
-	"github.com/spf13/cobra"
-	"github.com/wagoodman/go-partybus"
-	"github.com/wagoodman/go-progress"
-
-	"github.com/anchore/clio"
-	"github.com/anchore/stereoscope"
-	"github.com/anchore/syft/cmd/syft/internal/options"
-	"github.com/anchore/syft/cmd/syft/internal/ui"
-	"github.com/anchore/syft/internal"
-	"github.com/anchore/syft/internal/bus"
-	"github.com/anchore/syft/internal/log"
-	"github.com/anchore/syft/syft/event"
-	"github.com/anchore/syft/syft/event/monitor"
-	"github.com/anchore/syft/syft/format"
-	"github.com/anchore/syft/syft/format/cyclonedxjson"
-	"github.com/anchore/syft/syft/format/spdxjson"
-	"github.com/anchore/syft/syft/format/spdxtagvalue"
-	"github.com/anchore/syft/syft/format/syftjson"
-	"github.com/anchore/syft/syft/sbom"
-)
-
-const (
-	attestExample = `  {{.appName}} {{.command}} --output [FORMAT] alpine:latest            defaults to using images from a Docker daemon. If Docker is not present, the image is pulled directly from the registry
-`
-	attestSchemeHelp = "\n  " + schemeHelpHeader + "\n" + imageSchemeHelp
-	attestHelp       = attestExample + attestSchemeHelp
-	cosignBinName    = "cosign"
-)
-
-type attestOptions struct {
-	options.Config      `yaml:",inline" mapstructure:",squash"`
-	options.Output      `yaml:",inline" mapstructure:",squash"`
-	options.UpdateCheck `yaml:",inline" mapstructure:",squash"`
-	options.Catalog     `yaml:",inline" mapstructure:",squash"`
-	Attest              options.Attest `yaml:"attest" mapstructure:"attest"`
-}
-
-func Attest(app clio.Application) *cobra.Command {
-	id := app.ID()
-
-	opts := defaultAttestOptions()
-
-	// template format explicitly not allowed
-	opts.Format.Template.Enabled = false
-
-	return app.SetupCommand(&cobra.Command{
-		Use:   "attest --output [FORMAT] <IMAGE>",
-		Short: "Generate an SBOM as an attestation for the given [SOURCE] container image",
-		Long:  "Generate a packaged-based Software Bill Of Materials (SBOM) from a container image as the predicate of an in-toto attestation that will be uploaded to the image registry",
-		Example: internal.Tprintf(attestHelp, map[string]interface{}{
-			"appName": id.Name,
-			"command": "attest",
-		}),
-		Args:    validateScanArgs,
-		PreRunE: applicationUpdateCheck(id, &opts.UpdateCheck),
-		RunE: func(cmd *cobra.Command, args []string) error {
-			restoreStdout := ui.CaptureStdoutToTraceLog()
-			defer restoreStdout()
-
-			return runAttest(cmd.Context(), id, &opts, args[0])
-		},
-	}, &opts)
-}
-
-func defaultAttestOptions() attestOptions {
-	return attestOptions{
-		Output:      defaultAttestOutputOptions(),
-		UpdateCheck: options.DefaultUpdateCheck(),
-		Catalog:     options.DefaultCatalog(),
-	}
-}
-
-func defaultAttestOutputOptions() options.Output {
-	return options.Output{
-		AllowMultipleOutputs: false,
-		AllowToFile:          false,
-		AllowableOptions: []string{
-			string(syftjson.ID),
-			string(cyclonedxjson.ID),
-			string(spdxjson.ID),
-			string(spdxtagvalue.ID),
-		},
-		Outputs: []string{syftjson.ID.String()},
-		OutputFile: options.OutputFile{ // nolint:staticcheck
-			Enabled: false, // explicitly not allowed
-		},
-		Format: options.DefaultFormat(),
-	}
-}
-
-//nolint:funlen
-func runAttest(ctx context.Context, id clio.Identification, opts *attestOptions, userInput string) error {
-	// TODO: what other validation here besides binary name?
-	if !commandExists(cosignBinName) {
-		return fmt.Errorf("'syft attest' requires cosign to be installed, however it does not appear to be on PATH")
-	}
-
-	// this is the file that will contain the SBOM being attested
-	f, err := os.CreateTemp("", "syft-attest-")
-	if err != nil {
-		return fmt.Errorf("unable to create temp file: %w", err)
-	}
-	defer os.Remove(f.Name())
-
-	s, err := generateSBOMForAttestation(ctx, id, &opts.Catalog, userInput)
-	if err != nil {
-		return fmt.Errorf("unable to build SBOM: %w", err)
-	}
-
-	if err = writeSBOMToFormattedFile(s, f, opts); err != nil {
-		return fmt.Errorf("unable to write SBOM to file: %w", err)
-	}
-
-	if err = createAttestation(f.Name(), opts, userInput); err != nil {
-		return err
-	}
-
-	bus.Notify("Attestation has been created, please check your registry for the output or use the cosign command:")
-	bus.Notify(fmt.Sprintf("cosign download attestation %s", userInput))
-	return nil
-}
-
-func writeSBOMToFormattedFile(s *sbom.SBOM, sbomFile io.Writer, opts *attestOptions) error {
-	if sbomFile == nil {
-		return fmt.Errorf("no output file provided")
-	}
-
-	encs, err := opts.Format.Encoders()
-	if err != nil {
-		return fmt.Errorf("unable to create encoders: %w", err)
-	}
-
-	encoders := format.NewEncoderCollection(encs...)
-	encoder := encoders.GetByString(opts.Outputs[0])
-	if encoder == nil {
-		return fmt.Errorf("unable to find encoder for %q", opts.Outputs[0])
-	}
-
-	if err = encoder.Encode(sbomFile, *s); err != nil {
-		return fmt.Errorf("unable to encode SBOM: %w", err)
-	}
-
-	return nil
-}
-
-func createAttestation(sbomFilepath string, opts *attestOptions, userInput string) error {
-	execCmd, err := attestCommand(sbomFilepath, opts, userInput)
-	if err != nil {
-		return fmt.Errorf("unable to craft attest command: %w", err)
-	}
-
-	log.WithFields("cmd", strings.Join(execCmd.Args, " ")).Trace("creating attestation")
-
-	// bus adapter for ui to hook into stdout via an os pipe
-	r, w, err := os.Pipe()
-	if err != nil {
-		return fmt.Errorf("unable to create os pipe: %w", err)
-	}
-	defer w.Close()
-
-	mon := progress.NewManual(-1)
-
-	bus.Publish(
-		partybus.Event{
-			Type: event.AttestationStarted,
-			Source: monitor.GenericTask{
-				Title: monitor.Title{
-					Default:      "Create attestation",
-					WhileRunning: "Creating attestation",
-					OnSuccess:    "Created attestation",
-				},
-				Context: "cosign",
-			},
-			Value: &monitor.ShellProgress{
-				Reader:       r,
-				Progressable: mon,
-			},
-		},
-	)
-
-	execCmd.Stdout = w
-	execCmd.Stderr = w
-
-	// attest the SBOM
-	err = execCmd.Run()
-	if err != nil {
-		mon.SetError(err)
-		return fmt.Errorf("unable to attest SBOM: %w", err)
-	}
-
-	mon.SetCompleted()
-	return nil
-}
-
-func attestCommand(sbomFilepath string, opts *attestOptions, userInput string) (*exec.Cmd, error) {
-	outputNames := opts.OutputNameSet()
-	var outputName string
-	switch outputNames.Size() {
-	case 0:
-		return nil, fmt.Errorf("no output format specified")
-	case 1:
-		outputName = outputNames.List()[0]
-	default:
-		return nil, fmt.Errorf("multiple output formats specified: %s", strings.Join(outputNames.List(), ", "))
-	}
-
-	args := []string{"attest", userInput, "--predicate", sbomFilepath, "--type", predicateType(outputName), "-y"}
-	if opts.Attest.Key != "" {
-		args = append(args, "--key", opts.Attest.Key.String())
-	}
-
-	execCmd := exec.Command(cosignBinName, args...)
-	execCmd.Env = os.Environ()
-	if opts.Attest.Key != "" {
-		execCmd.Env = append(execCmd.Env, fmt.Sprintf("COSIGN_PASSWORD=%s", opts.Attest.Password))
-	} else {
-		// no key provided, use cosign's keyless mode
-		execCmd.Env = append(execCmd.Env, "COSIGN_EXPERIMENTAL=1")
-	}
-
-	return execCmd, nil
-}
-
-func predicateType(outputName string) string {
-	// select the Cosign predicate type based on defined output type
-	// As orientation, check: https://github.com/sigstore/cosign/blob/main/pkg/cosign/attestation/attestation.go
-	switch strings.ToLower(outputName) {
-	case "cyclonedx-json":
-		return "cyclonedx"
-	case "spdx-tag-value", "spdx-tv":
-		return "spdx"
-	case "spdx-json", "json":
-		return "spdxjson"
-	default:
-		return "custom"
-	}
-}
-
-func generateSBOMForAttestation(ctx context.Context, id clio.Identification, opts *options.Catalog, userInput string) (*sbom.SBOM, error) {
-	if len(opts.From) > 1 || (len(opts.From) == 1 && opts.From[0] != stereoscope.RegistryTag) {
-		return nil, fmt.Errorf("attest requires use of an OCI registry directly, one or more of the specified sources is unsupported: %v", opts.From)
-	}
-
-	src, err := getSource(ctx, opts, userInput, stereoscope.RegistryTag)
-
-	if err != nil {
-		return nil, err
-	}
-
-	defer func() {
-		if src != nil {
-			if err := src.Close(); err != nil {
-				log.Tracef("unable to close source: %+v", err)
-			}
-		}
-	}()
-
-	s, err := generateSBOM(ctx, id, src, opts)
-	if err != nil {
-		return nil, err
-	}
-
-	if s == nil {
-		return nil, fmt.Errorf("no SBOM produced for %q", userInput)
-	}
-
-	return s, nil
-}
-
-func commandExists(cmd string) bool {
-	_, err := exec.LookPath(cmd)
-	return err == nil
-}

cmd/syft/internal/commands/attest_test.go

@@ -1,331 +0,0 @@
-package commands
-
-import (
-	"bytes"
-	"context"
-	"fmt"
-	"io"
-	"os/exec"
-	"regexp"
-	"strings"
-	"testing"
-
-	"github.com/google/go-cmp/cmp"
-	"github.com/scylladb/go-set/strset"
-	"github.com/spf13/cobra"
-	"github.com/stretchr/testify/assert"
-	"github.com/stretchr/testify/require"
-
-	"github.com/anchore/clio"
-	"github.com/anchore/clio/cliotestutils"
-	"github.com/anchore/syft/cmd/syft/internal"
-	"github.com/anchore/syft/cmd/syft/internal/options"
-	"github.com/anchore/syft/syft/sbom"
-	"github.com/anchore/syft/syft/source"
-)
-
-func Test_writeSBOMToFormattedFile(t *testing.T) {
-	type args struct {
-		s    *sbom.SBOM
-		opts *attestOptions
-	}
-	tests := []struct {
-		name         string
-		args         args
-		wantSbomFile string
-		wantErr      bool
-	}{
-		{
-			name: "go case",
-			args: args{
-				opts: &attestOptions{
-					Output: func() options.Output {
-						def := defaultAttestOutputOptions()
-						def.Outputs = []string{"syft-json"}
-						return def
-					}(),
-				},
-				s: &sbom.SBOM{
-					Artifacts:     sbom.Artifacts{},
-					Relationships: nil,
-					Source: source.Description{
-						ID:      "source-id",
-						Name:    "source-name",
-						Version: "source-version",
-					},
-					Descriptor: sbom.Descriptor{
-						Name:    "syft-test",
-						Version: "non-version",
-					},
-				},
-			},
-			wantSbomFile: `{
- "artifacts": [],
- "artifactRelationships": [],
- "source": {
-  "id": "source-id",
-  "name": "source-name",
-  "version": "source-version",
-  "type": "",
-  "metadata": null
- },
- "distro": {},
- "descriptor": {
-  "name": "syft-test",
-  "version": "non-version"
- },
- "schema": {}
-}`,
-			wantErr: false,
-		},
-	}
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			sbomFile := &bytes.Buffer{}
-
-			err := writeSBOMToFormattedFile(tt.args.s, sbomFile, tt.args.opts)
-			if (err != nil) != tt.wantErr {
-				t.Errorf("writeSBOMToFormattedFile() error = %v, wantErr %v", err, tt.wantErr)
-				return
-			}
-
-			// redact the schema block
-			re := regexp.MustCompile(`(?s)"schema":\W*\{.*?},?`)
-			subject := re.ReplaceAllString(sbomFile.String(), `"schema":{}`)
-
-			assert.JSONEq(t, tt.wantSbomFile, subject)
-		})
-	}
-}
-
-func Test_attestCommand(t *testing.T) {
-	cmdPrefix := cosignBinName
-	lp, err := exec.LookPath(cosignBinName)
-	if err == nil {
-		cmdPrefix = lp
-	}
-
-	fullCmd := func(args string) string {
-		return fmt.Sprintf("%s %s", cmdPrefix, args)
-	}
-
-	type args struct {
-		sbomFilepath string
-		opts         attestOptions
-		userInput    string
-	}
-	tests := []struct {
-		name        string
-		args        args
-		wantCmd     string
-		wantEnvVars map[string]string
-		notEnvVars  []string
-		wantErr     require.ErrorAssertionFunc
-	}{
-		{
-			name: "with key and password",
-			args: args{
-				userInput:    "myimage",
-				sbomFilepath: "/tmp/sbom-filepath.json",
-				opts: func() attestOptions {
-					def := defaultAttestOptions()
-					def.Outputs = []string{"syft-json"}
-					def.Attest.Key = "key"
-					def.Attest.Password = "password"
-					return def
-				}(),
-			},
-			wantCmd: fullCmd("attest myimage --predicate /tmp/sbom-filepath.json --type custom -y --key key"),
-			wantEnvVars: map[string]string{
-				"COSIGN_PASSWORD": "password",
-			},
-			notEnvVars: []string{
-				"COSIGN_EXPERIMENTAL", // only for keyless
-			},
-		},
-		{
-			name: "keyless",
-			args: args{
-				userInput:    "myimage",
-				sbomFilepath: "/tmp/sbom-filepath.json",
-				opts: func() attestOptions {
-					def := defaultAttestOptions()
-					def.Outputs = []string{"syft-json"}
-					return def
-				}(),
-			},
-			wantCmd: fullCmd("attest myimage --predicate /tmp/sbom-filepath.json --type custom -y"),
-			wantEnvVars: map[string]string{
-				"COSIGN_EXPERIMENTAL": "1",
-			},
-			notEnvVars: []string{
-				"COSIGN_PASSWORD",
-			},
-		},
-	}
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			if tt.wantErr == nil {
-				tt.wantErr = require.NoError
-			}
-
-			got, err := attestCommand(tt.args.sbomFilepath, &tt.args.opts, tt.args.userInput)
-			tt.wantErr(t, err)
-			if err != nil {
-				return
-			}
-
-			require.NotNil(t, got)
-			assert.Equal(t, tt.wantCmd, got.String())
-
-			gotEnv := strset.New(got.Env...)
-
-			for k, v := range tt.wantEnvVars {
-				assert.True(t, gotEnv.Has(fmt.Sprintf("%s=%s", k, v)))
-			}
-
-			for _, k := range tt.notEnvVars {
-				for _, env := range got.Env {
-					fields := strings.Split(env, "=")
-					if fields[0] == k {
-						t.Errorf("attestCommand() unexpected environment variable %s", k)
-					}
-				}
-			}
-		})
-	}
-}
-
-func Test_predicateType(t *testing.T) {
-	tests := []struct {
-		name string
-		want string
-	}{
-		{
-			name: "cyclonedx-json",
-			want: "cyclonedx",
-		},
-		{
-			name: "spdx-tag-value",
-			want: "spdx",
-		},
-		{
-			name: "spdx-tv",
-			want: "spdx",
-		},
-		{
-			name: "spdx-json",
-			want: "spdxjson",
-		},
-		{
-			name: "json",
-			want: "spdxjson",
-		},
-		{
-			name: "syft-json",
-			want: "custom",
-		},
-	}
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			assert.Equalf(t, tt.want, predicateType(tt.name), "predicateType(%v)", tt.name)
-		})
-	}
-}
-
-func Test_buildSBOMForAttestation(t *testing.T) {
-	// note: this test is only meant to test that the filter function is wired
-	// and not the correctness of the function in depth
-	type args struct {
-		id        clio.Identification
-		opts      *options.Catalog
-		userInput string
-	}
-	tests := []struct {
-		name    string
-		args    args
-		want    *sbom.SBOM
-		wantErr require.ErrorAssertionFunc
-	}{
-		{
-			name: "do not allow directory scans",
-			args: args{
-				opts: func() *options.Catalog {
-					def := defaultAttestOptions()
-					return &def.Catalog
-				}(),
-				userInput: "dir:/tmp/something",
-			},
-			wantErr: require.Error,
-		},
-	}
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			if tt.wantErr == nil {
-				tt.wantErr = require.NoError
-			}
-			_, err := generateSBOMForAttestation(context.Background(), tt.args.id, tt.args.opts, tt.args.userInput)
-			tt.wantErr(t, err)
-			if err != nil {
-				return
-			}
-		})
-	}
-}
-
-func Test_attestCLIWiring(t *testing.T) {
-	id := clio.Identification{
-		Name:    "syft",
-		Version: "testing",
-	}
-	cfg := internal.AppClioSetupConfig(id, io.Discard)
-	tests := []struct {
-		name          string
-		assertionFunc func(*testing.T, *cobra.Command, []string, ...any)
-		wantOpts      attestOptions
-		args          []string
-		env           map[string]string
-	}{
-		{
-			name:          "key flag is accepted",
-			args:          []string{"some-image:some-tag", "--key", "some-cosign-key.key"},
-			assertionFunc: hasAttestOpts(options.Attest{Key: "some-cosign-key.key"}),
-		},
-		{
-			name: "key password is read from env",
-			args: []string{"some-image:some-tag", "--key", "cosign.key"},
-			env: map[string]string{
-				"SYFT_ATTEST_PASSWORD": "some-password",
-			},
-			assertionFunc: hasAttestOpts(options.Attest{
-				Key:      "cosign.key",
-				Password: "some-password",
-			}),
-		},
-	}
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			if tt.env != nil {
-				for k, v := range tt.env {
-					t.Setenv(k, v)
-				}
-			}
-			app := cliotestutils.NewApplication(t, cfg, tt.assertionFunc)
-			cmd := Attest(app)
-			cmd.SetArgs(tt.args)
-			err := cmd.Execute()
-			assert.NoError(t, err)
-		})
-	}
-}
-
-func hasAttestOpts(wantOpts options.Attest) cliotestutils.AssertionFunc {
-	return func(t *testing.T, _ *cobra.Command, _ []string, cfgs ...any) {
-		assert.Equal(t, len(cfgs), 1)
-		attestOpts, ok := cfgs[0].(*attestOptions)
-		require.True(t, ok)
-		if d := cmp.Diff(wantOpts, attestOpts.Attest); d != "" {
-			t.Errorf("mismatched attest options (-want +got):\n%s", d)
-		}
-	}
-}

cmd/syft/internal/commands/cataloger.go

@@ -1,20 +0,0 @@
-package commands
-
-import (
-	"github.com/spf13/cobra"
-
-	"github.com/anchore/clio"
-)
-
-func Cataloger(app clio.Application) *cobra.Command {
-	cmd := &cobra.Command{
-		Use:   "cataloger",
-		Short: "Show available catalogers and configuration",
-	}
-
-	cmd.AddCommand(
-		CatalogerList(app),
-	)
-
-	return cmd
-}

cmd/syft/internal/commands/cataloger_list.go

@@ -1,267 +0,0 @@
-package commands
-
-import (
-	"encoding/json"
-	"fmt"
-	"sort"
-	"strings"
-
-	"github.com/charmbracelet/lipgloss"
-	"github.com/jedib0t/go-pretty/v6/table"
-	"github.com/scylladb/go-set/strset"
-	"github.com/spf13/cobra"
-
-	"github.com/anchore/clio"
-	"github.com/anchore/syft/internal/bus"
-	"github.com/anchore/syft/internal/task"
-	"github.com/anchore/syft/syft/cataloging/pkgcataloging"
-)
-
-type catalogerListOptions struct {
-	Output            string   `yaml:"output" json:"output" mapstructure:"output"`
-	DefaultCatalogers []string `yaml:"default-catalogers" json:"default-catalogers" mapstructure:"default-catalogers"`
-	SelectCatalogers  []string `yaml:"select-catalogers" json:"select-catalogers" mapstructure:"select-catalogers"`
-	ShowHidden        bool     `yaml:"show-hidden" json:"show-hidden" mapstructure:"show-hidden"`
-}
-
-func (o *catalogerListOptions) AddFlags(flags clio.FlagSet) {
-	flags.StringVarP(&o.Output, "output", "o", "format to output the cataloger list (available: table, json)")
-
-	flags.StringArrayVarP(&o.DefaultCatalogers, "override-default-catalogers", "", "override the default catalogers with an expression")
-
-	flags.StringArrayVarP(&o.SelectCatalogers, "select-catalogers", "", "select catalogers with an expression")
-
-	flags.BoolVarP(&o.ShowHidden, "show-hidden", "s", "show catalogers that have been de-selected")
-}
-
-func defaultCatalogerListOptions() *catalogerListOptions {
-	return &catalogerListOptions{
-		DefaultCatalogers: []string{"all"},
-	}
-}
-
-func CatalogerList(app clio.Application) *cobra.Command {
-	opts := defaultCatalogerListOptions()
-
-	return app.SetupCommand(&cobra.Command{
-		Use:   "list [OPTIONS]",
-		Short: "List available catalogers",
-		RunE: func(_ *cobra.Command, _ []string) error {
-			return runCatalogerList(opts)
-		},
-	}, opts)
-}
-
-func runCatalogerList(opts *catalogerListOptions) error {
-	factories := task.DefaultPackageTaskFactories()
-	allTasks, err := factories.Tasks(task.DefaultCatalogingFactoryConfig())
-	if err != nil {
-		return fmt.Errorf("unable to create cataloger tasks: %w", err)
-	}
-
-	report, err := catalogerListReport(opts, allTasks)
-	if err != nil {
-		return fmt.Errorf("unable to generate cataloger list report: %w", err)
-	}
-
-	bus.Report(report)
-
-	return nil
-}
-
-func catalogerListReport(opts *catalogerListOptions, allTasks []task.Task) (string, error) {
-	selectedTasks, selectionEvidence, err := task.Select(allTasks,
-		pkgcataloging.NewSelectionRequest().
-			WithDefaults(opts.DefaultCatalogers...).
-			WithExpression(opts.SelectCatalogers...),
-	)
-	if err != nil {
-		return "", fmt.Errorf("unable to select catalogers: %w", err)
-	}
-	var report string
-
-	switch opts.Output {
-	case "json":
-		report, err = renderCatalogerListJSON(selectedTasks, selectionEvidence, opts.DefaultCatalogers, opts.SelectCatalogers)
-	case "table", "":
-		if opts.ShowHidden {
-			report = renderCatalogerListTable(allTasks, selectionEvidence, opts.DefaultCatalogers, opts.SelectCatalogers)
-		} else {
-			report = renderCatalogerListTable(selectedTasks, selectionEvidence, opts.DefaultCatalogers, opts.SelectCatalogers)
-		}
-	}
-
-	if err != nil {
-		return "", fmt.Errorf("unable to render cataloger list: %w", err)
-	}
-
-	return report, nil
-}
-
-func renderCatalogerListJSON(tasks []task.Task, selection task.Selection, defaultSelections, selections []string) (string, error) {
-	type node struct {
-		Name string   `json:"name"`
-		Tags []string `json:"tags"`
-	}
-
-	names, tagsByName := extractTaskInfo(tasks)
-
-	nodesByName := make(map[string]node)
-
-	for name := range tagsByName {
-		tagsSelected := selection.TokensByTask[name].SelectedOn.List()
-
-		if len(tagsSelected) == 1 && tagsSelected[0] == "all" {
-			tagsSelected = tagsByName[name]
-		}
-
-		sort.Strings(tagsSelected)
-
-		if tagsSelected == nil {
-			// ensure collections are not null
-			tagsSelected = []string{}
-		}
-
-		nodesByName[name] = node{
-			Name: name,
-			Tags: tagsSelected,
-		}
-	}
-
-	type document struct {
-		DefaultSelection []string `json:"default"`
-		Selection        []string `json:"selection"`
-		Catalogers       []node   `json:"catalogers"`
-	}
-
-	if selections == nil {
-		// ensure collections are not null
-		selections = []string{}
-	}
-
-	doc := document{
-		DefaultSelection: defaultSelections,
-		Selection:        selections,
-	}
-
-	for _, name := range names {
-		doc.Catalogers = append(doc.Catalogers, nodesByName[name])
-	}
-
-	by, err := json.Marshal(doc)
-
-	return string(by), err
-}
-
-func renderCatalogerListTable(tasks []task.Task, selection task.Selection, defaultSelections, selections []string) string {
-	t := table.NewWriter()
-	t.SetStyle(table.StyleLight)
-	t.AppendHeader(table.Row{"Cataloger", "Tags"})
-
-	names, tagsByName := extractTaskInfo(tasks)
-
-	rowsByName := make(map[string]table.Row)
-
-	for name, tags := range tagsByName {
-		rowsByName[name] = formatRow(name, tags, selection)
-	}
-
-	for _, name := range names {
-		t.AppendRow(rowsByName[name])
-	}
-
-	report := t.Render()
-
-	if len(selections) > 0 {
-		header := "Selected by expressions:\n"
-		for _, expr := range selections {
-			header += fmt.Sprintf("  - %q\n", expr)
-		}
-		report = header + report
-	}
-
-	if len(defaultSelections) > 0 {
-		header := "Default selections:\n"
-		for _, expr := range defaultSelections {
-			header += fmt.Sprintf("  - %q\n", expr)
-		}
-		report = header + report
-	}
-
-	return report
-}
-
-func formatRow(name string, tags []string, selection task.Selection) table.Row {
-	isIncluded := selection.Result.Has(name)
-	var selections *task.TokenSelection
-	if s, exists := selection.TokensByTask[name]; exists {
-		selections = &s
-	}
-
-	var formattedTags []string
-	for _, tag := range tags {
-		formattedTags = append(formattedTags, formatToken(tag, selections, isIncluded))
-	}
-
-	var tagStr string
-	if isIncluded {
-		tagStr = strings.Join(formattedTags, ", ")
-	} else {
-		tagStr = strings.Join(formattedTags, grey.Render(", "))
-	}
-
-	// TODO: selection should keep warnings (non-selections) in struct
-
-	return table.Row{
-		formatToken(name, selections, isIncluded),
-		tagStr,
-	}
-}
-
-var (
-	green = lipgloss.NewStyle().Foreground(lipgloss.Color("10")) // hi green
-	grey  = lipgloss.NewStyle().Foreground(lipgloss.Color("8"))  // dark grey
-	red   = lipgloss.NewStyle().Foreground(lipgloss.Color("9"))  // high red
-)
-
-func formatToken(token string, selection *task.TokenSelection, included bool) string {
-	if included && selection != nil {
-		// format all tokens in selection in green
-		if selection.SelectedOn.Has(token) {
-			return green.Render(token)
-		}
-
-		return token
-	}
-
-	// format all tokens in selection in red, all others in grey
-	if selection != nil && selection.DeselectedOn.Has(token) {
-		return red.Render(token)
-	}
-
-	return grey.Render(token)
-}
-
-func extractTaskInfo(tasks []task.Task) ([]string, map[string][]string) {
-	tagsByName := make(map[string][]string)
-	var names []string
-
-	for _, tsk := range tasks {
-		var tags []string
-		name := tsk.Name()
-
-		if s, ok := tsk.(task.Selector); ok {
-			set := strset.New(s.Selectors()...)
-			set.Remove(name)
-			tags = set.List()
-			sort.Strings(tags)
-		}
-
-		tagsByName[name] = tags
-		names = append(names, name)
-	}
-
-	sort.Strings(names)
-
-	return names, tagsByName
-}

cmd/syft/internal/commands/cataloger_list_test.go

@@ -1,201 +0,0 @@
-package commands
-
-import (
-	"context"
-	"strings"
-	"testing"
-
-	"github.com/scylladb/go-set/strset"
-	"github.com/stretchr/testify/assert"
-	"github.com/stretchr/testify/require"
-
-	"github.com/anchore/syft/internal/sbomsync"
-	"github.com/anchore/syft/internal/task"
-	"github.com/anchore/syft/syft/file"
-)
-
-var _ interface {
-	task.Task
-	task.Selector
-} = (*dummyTask)(nil)
-
-type dummyTask struct {
-	name      string
-	selectors []string
-}
-
-func (d dummyTask) HasAllSelectors(s ...string) bool {
-	return strset.New(d.selectors...).Has(s...)
-}
-
-func (d dummyTask) Selectors() []string {
-	return d.selectors
-}
-
-func (d dummyTask) Name() string {
-	return d.name
-}
-
-func (d dummyTask) Execute(_ context.Context, _ file.Resolver, _ sbomsync.Builder) error {
-	panic("implement me")
-}
-
-func testTasks() []task.Task {
-	return []task.Task{
-		dummyTask{
-			name:      "task1",
-			selectors: []string{"image", "a", "b", "1"},
-		},
-		dummyTask{
-			name:      "task2",
-			selectors: []string{"image", "b", "c", "2"},
-		},
-		dummyTask{
-			name:      "task3",
-			selectors: []string{"directory", "c", "d", "3"},
-		},
-		dummyTask{
-			name:      "task4",
-			selectors: []string{"directory", "d", "e", "4"},
-		},
-	}
-}
-
-func Test_catalogerListReport(t *testing.T) {
-	tests := []struct {
-		name    string
-		options *catalogerListOptions
-		want    string
-		wantErr require.ErrorAssertionFunc
-	}{
-		{
-			name: "no expressions, table",
-			options: func() *catalogerListOptions {
-				c := defaultCatalogerListOptions()
-				c.Output = "table"
-				return c
-			}(),
-			want: `
-Default selections:
-  - "all"
-┌───────────┬────────────────────┐
-│ CATALOGER │ TAGS               │
-├───────────┼────────────────────┤
-│ task1     │ 1, a, b, image     │
-│ task2     │ 2, b, c, image     │
-│ task3     │ 3, c, d, directory │
-│ task4     │ 4, d, directory, e │
-└───────────┴────────────────────┘
-`,
-		},
-		{
-			name: "no expressions, json",
-			options: func() *catalogerListOptions {
-				c := defaultCatalogerListOptions()
-				c.Output = "json"
-				return c
-			}(),
-			want: `
-{"default":["all"],"selection":[],"catalogers":[{"name":"task1","tags":["1","a","b","image"]},{"name":"task2","tags":["2","b","c","image"]},{"name":"task3","tags":["3","c","d","directory"]},{"name":"task4","tags":["4","d","directory","e"]}]}
-`,
-		},
-		{
-			name: "no expressions, default selection, table",
-			options: func() *catalogerListOptions {
-				c := defaultCatalogerListOptions()
-				c.Output = "table"
-				c.DefaultCatalogers = []string{
-					"image",
-				}
-				return c
-			}(),
-			want: `
-Default selections:
-  - "image"
-┌───────────┬────────────────┐
-│ CATALOGER │ TAGS           │
-├───────────┼────────────────┤
-│ task1     │ 1, a, b, image │
-│ task2     │ 2, b, c, image │
-└───────────┴────────────────┘
-`,
-		},
-		{
-			name: "no expressions, default selection, json",
-			options: func() *catalogerListOptions {
-				c := defaultCatalogerListOptions()
-				c.Output = "json"
-				c.DefaultCatalogers = []string{
-					"image",
-				}
-				return c
-			}(),
-			want: `
-{"default":["image"],"selection":[],"catalogers":[{"name":"task1","tags":["image"]},{"name":"task2","tags":["image"]}]}
-`,
-		},
-		{
-			name: "with expressions, default selection, table",
-			options: func() *catalogerListOptions {
-				c := defaultCatalogerListOptions()
-				c.Output = "table"
-				c.DefaultCatalogers = []string{
-					"image",
-				}
-				c.SelectCatalogers = []string{
-					"-directory",
-					"+task3",
-					"-c",
-					"b",
-				}
-				return c
-			}(),
-			want: `
-Default selections:
-  - "image"
-Selected by expressions:
-  - "-directory"
-  - "+task3"
-  - "-c"
-  - "b"
-┌───────────┬────────────────────┐
-│ CATALOGER │ TAGS               │
-├───────────┼────────────────────┤
-│ task1     │ 1, a, b, image     │
-│ task3     │ 3, c, d, directory │
-└───────────┴────────────────────┘
-`,
-		},
-		{
-			name: "with expressions, default selection, json",
-			options: func() *catalogerListOptions {
-				c := defaultCatalogerListOptions()
-				c.Output = "json"
-				c.DefaultCatalogers = []string{
-					"image",
-				}
-				c.SelectCatalogers = []string{
-					"-directory",
-					"+task3",
-					"-c",
-					"b",
-				}
-				return c
-			}(),
-			want: `
-{"default":["image"],"selection":["-directory","+task3","-c","b"],"catalogers":[{"name":"task1","tags":["b","image"]},{"name":"task3","tags":["task3"]}]}
-`,
-		},
-	}
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			if tt.wantErr == nil {
-				tt.wantErr = require.NoError
-			}
-
-			got, err := catalogerListReport(tt.options, testTasks())
-			tt.wantErr(t, err)
-			assert.Equal(t, strings.TrimSpace(tt.want), strings.TrimSpace(got))
-		})
-	}
-}

cmd/syft/internal/commands/commands_test.go

@@ -1,20 +0,0 @@
-package commands
-
-import (
-	"os"
-	"testing"
-
-	gologgerredact "github.com/anchore/go-logger/adapter/redact"
-	"github.com/anchore/syft/internal/redact"
-)
-
-func TestMain(m *testing.M) {
-	// Initialize global state needed to test clio/cobra commands directly
-	// Should be kept minimal.
-
-	// Initialize redact store once for all tests in the commands package
-	// Redact store must be wired up here because syft will panic unless
-	// a redact store is wired up exactly once
-	redact.Set(gologgerredact.NewStore())
-	os.Exit(m.Run())
-}

cmd/syft/internal/commands/convert.go

@@ -1,103 +0,0 @@
-package commands
-
-import (
-	"fmt"
-	"io"
-	"os"
-
-	"github.com/spf13/cobra"
-
-	"github.com/anchore/clio"
-	"github.com/anchore/syft/cmd/syft/internal/options"
-	"github.com/anchore/syft/cmd/syft/internal/ui"
-	"github.com/anchore/syft/internal"
-	"github.com/anchore/syft/internal/log"
-	"github.com/anchore/syft/syft/format"
-)
-
-const (
-	convertExample = `  {{.appName}} {{.command}} img.syft.json -o spdx-json                      convert a syft SBOM to spdx-json, output goes to stdout
-  {{.appName}} {{.command}} img.syft.json -o cyclonedx-json=img.cdx.json    convert a syft SBOM to CycloneDX, output is written to the file "img.cdx.json""
-  {{.appName}} {{.command}} - -o spdx-json                                  convert an SBOM from STDIN to spdx-json
-`
-)
-
-type ConvertOptions struct {
-	options.Config      `yaml:",inline" mapstructure:",squash"`
-	options.Output      `yaml:",inline" mapstructure:",squash"`
-	options.UpdateCheck `yaml:",inline" mapstructure:",squash"`
-}
-
-//nolint:dupl
-func Convert(app clio.Application) *cobra.Command {
-	id := app.ID()
-
-	opts := &ConvertOptions{
-		UpdateCheck: options.DefaultUpdateCheck(),
-		Output:      options.DefaultOutput(),
-	}
-
-	return app.SetupCommand(&cobra.Command{
-		Use:   "convert [SOURCE-SBOM] -o [FORMAT]",
-		Short: "Convert between SBOM formats",
-		Long:  "[Experimental] Convert SBOM files to, and from, SPDX, CycloneDX and Syft's format. For more info about data loss between formats see https://github.com/anchore/syft#format-conversion-experimental",
-		Example: internal.Tprintf(convertExample, map[string]interface{}{
-			"appName": id.Name,
-			"command": "convert",
-		}),
-		Args:    validateConvertArgs,
-		PreRunE: applicationUpdateCheck(id, &opts.UpdateCheck),
-		RunE: func(_ *cobra.Command, args []string) error {
-			restoreStdout := ui.CaptureStdoutToTraceLog()
-			defer restoreStdout()
-
-			return RunConvert(opts, args[0])
-		},
-	}, opts)
-}
-
-func validateConvertArgs(cmd *cobra.Command, args []string) error {
-	return validateArgs(cmd, args, "an SBOM argument is required")
-}
-
-func RunConvert(opts *ConvertOptions, userInput string) error {
-	log.Warn("convert is an experimental feature, run `syft convert -h` for help")
-
-	writer, err := opts.SBOMWriter()
-	if err != nil {
-		return err
-	}
-
-	var reader io.ReadSeekCloser
-
-	if userInput == "-" {
-		// though os.Stdin is an os.File, it does not support seeking
-		// you will get errors such as "seek /dev/stdin: illegal seek".
-		// We need to buffer what we read.
-		reader = internal.NewBufferedSeeker(os.Stdin)
-	} else {
-		f, err := os.Open(userInput)
-		if err != nil {
-			return fmt.Errorf("failed to open SBOM file: %w", err)
-		}
-		defer func() {
-			_ = f.Close()
-		}()
-		reader = f
-	}
-
-	s, _, _, err := format.Decode(reader)
-	if err != nil {
-		return fmt.Errorf("failed to decode SBOM: %w", err)
-	}
-
-	if s == nil {
-		return fmt.Errorf("no SBOM produced")
-	}
-
-	if err := writer.Write(*s); err != nil {
-		return fmt.Errorf("failed to write SBOM: %w", err)
-	}
-
-	return nil
-}

cmd/syft/internal/commands/packages.go

@@ -1,37 +0,0 @@
-package commands
-
-import (
-	"github.com/spf13/cobra"
-
-	"github.com/anchore/clio"
-	"github.com/anchore/syft/cmd/syft/internal/ui"
-	"github.com/anchore/syft/internal"
-)
-
-func Packages(app clio.Application, scanCmd *cobra.Command) *cobra.Command {
-	id := app.ID()
-
-	opts := defaultScanOptions()
-
-	cmd := app.SetupCommand(&cobra.Command{
-		Use:   "packages [SOURCE]",
-		Short: scanCmd.Short,
-		Long:  scanCmd.Long,
-		Args:  scanCmd.Args,
-		Example: internal.Tprintf(scanHelp, map[string]interface{}{
-			"appName": id.Name,
-			"command": "packages",
-		}),
-		PreRunE: applicationUpdateCheck(id, &opts.UpdateCheck),
-		RunE: func(cmd *cobra.Command, args []string) error {
-			restoreStdout := ui.CaptureStdoutToTraceLog()
-			defer restoreStdout()
-
-			return runScan(cmd.Context(), id, opts, args[0])
-		},
-	}, opts)
-
-	cmd.Deprecated = "use `syft scan` instead"
-
-	return cmd
-}

cmd/syft/internal/commands/packages_test.go

@@ -1,300 +0,0 @@
-package commands
-
-import (
-	"errors"
-	"fmt"
-	"testing"
-
-	"github.com/hashicorp/go-multierror"
-	"github.com/stretchr/testify/assert"
-
-	"github.com/anchore/syft/internal/task"
-)
-
-func Test_filterExpressionErrors_expressionErrorsHelp(t *testing.T) {
-	tests := []struct {
-		name        string
-		err         error
-		wantExpErrs []task.ErrInvalidExpression
-		wantErr     assert.ErrorAssertionFunc
-		wantHelp    string
-	}{
-		{
-			name:        "no errors",
-			err:         nil,
-			wantExpErrs: nil,
-			wantErr:     assert.NoError,
-			wantHelp:    "",
-		},
-		{
-			name: "single non-expression error is retained",
-			err:  errors.New("foo"),
-			wantErr: func(t assert.TestingT, err error, i ...interface{}) bool {
-				return assert.Equal(t, "foo", err.Error())
-			},
-			wantHelp: "",
-		},
-		{
-			name: "multiple non-expression sibling errors are retained",
-			err: func() error {
-				var err error
-				err = multierror.Append(err, errors.New("foo"))
-				err = multierror.Append(err, errors.New("bar"))
-				return err
-			}(),
-			wantErr: func(t assert.TestingT, err error, i ...interface{}) bool {
-				// note: this is the default formatting from the hashicorp multierror object
-				expected := `2 errors occurred:
-	* foo
-	* bar
-
-`
-				return assert.Equal(t, expected, err.Error())
-			},
-			wantHelp: "",
-		},
-		{
-			name: "has multiple expression errors (with sibling errors)",
-			err: func() error {
-				var err error
-				err = multierror.Append(err, errors.New("foo"))
-				err = multierror.Append(err, task.ErrInvalidExpression{Expression: "foo", Operation: task.AddOperation, Err: task.ErrTagsNotAllowed})
-				err = multierror.Append(err, errors.New("bar"))
-				err = multierror.Append(err, task.ErrInvalidExpression{Expression: "bar", Operation: task.SubSelectOperation, Err: task.ErrNamesNotAllowed})
-				err = multierror.Append(err, errors.New("last"))
-				return err
-			}(),
-			wantErr: func(t assert.TestingT, err error, i ...interface{}) bool {
-				expected := `5 errors occurred:
-	* foo
-	* invalid expression: "foo": tags are not allowed with this operation (must use exact names)
-	* bar
-	* invalid expression: "bar": names are not allowed with this operation (must use tags)
-	* last
-
-`
-				return assert.Equal(t, expected, err.Error())
-			},
-			wantExpErrs: []task.ErrInvalidExpression{
-				{Expression: "foo", Operation: task.AddOperation, Err: task.ErrTagsNotAllowed},
-				{Expression: "bar", Operation: task.SubSelectOperation, Err: task.ErrNamesNotAllowed},
-			},
-			wantHelp: `Suggestions:
-
- ❖ Given expression "--select-catalogers foo"
-   However, tags are not allowed with this operation (must use exact names).
-   Adding groups of catalogers may result in surprising behavior (create inaccurate SBOMs).
-   If you are certain this is what you want to do, use "--override-default-catalogers foo" instead.
-
- ❖ Given expression "--select-catalogers bar"
-   However, names are not allowed with this operation (must use tags).
-   It seems like you are intending to add a cataloger in addition to the default set.
-   ... Did you mean "--select-catalogers +bar" instead?
-`,
-		},
-		{
-			name: "has multiple expression errors (with error chains and sibling errors)",
-			err: func() error {
-				var err error
-				err = multierror.Append(err, fmt.Errorf("foo: %w", fmt.Errorf("bar: %w", errors.New("last"))))
-				err = multierror.Append(err, task.ErrInvalidExpression{Expression: "foo", Operation: task.AddOperation, Err: task.ErrTagsNotAllowed})
-				err = multierror.Append(err, task.ErrInvalidExpression{Expression: "bar", Operation: task.SubSelectOperation, Err: task.ErrNamesNotAllowed})
-				err = multierror.Append(err, errors.New("bottom"))
-
-				return fmt.Errorf("top: %w", fmt.Errorf("middle: %w", err))
-			}(),
-			wantErr: func(t assert.TestingT, err error, i ...interface{}) bool {
-				expected := `top: middle: 4 errors occurred:
-	* foo: bar: last
-	* invalid expression: "foo": tags are not allowed with this operation (must use exact names)
-	* invalid expression: "bar": names are not allowed with this operation (must use tags)
-	* bottom
-
-`
-				return assert.Equal(t, expected, err.Error())
-			},
-			wantExpErrs: []task.ErrInvalidExpression{
-				{Expression: "foo", Operation: task.AddOperation, Err: task.ErrTagsNotAllowed},
-				{Expression: "bar", Operation: task.SubSelectOperation, Err: task.ErrNamesNotAllowed},
-			},
-			wantHelp: `Suggestions:
-
- ❖ Given expression "--select-catalogers foo"
-   However, tags are not allowed with this operation (must use exact names).
-   Adding groups of catalogers may result in surprising behavior (create inaccurate SBOMs).
-   If you are certain this is what you want to do, use "--override-default-catalogers foo" instead.
-
- ❖ Given expression "--select-catalogers bar"
-   However, names are not allowed with this operation (must use tags).
-   It seems like you are intending to add a cataloger in addition to the default set.
-   ... Did you mean "--select-catalogers +bar" instead?
-`,
-		},
-		{
-			name: "has multiple expression errors (with error chains and sibling errors)",
-			err: func() error {
-				var err error
-				err = multierror.Append(err, fmt.Errorf("foo: %w", fmt.Errorf("bar: %w", errors.New("last"))))
-				err = multierror.Append(err, task.ErrInvalidExpression{Expression: "foo", Operation: task.AddOperation, Err: task.ErrTagsNotAllowed})
-				err = multierror.Append(err, task.ErrInvalidExpression{Expression: "bar", Operation: task.SubSelectOperation, Err: task.ErrNamesNotAllowed})
-				err = multierror.Append(err, errors.New("bottom"))
-
-				// note we wrap the top error in a chain
-				return fmt.Errorf("top: %w", fmt.Errorf("middle: %w", err))
-			}(),
-			wantErr: func(t assert.TestingT, err error, i ...interface{}) bool {
-				expected := `top: middle: 4 errors occurred:
-	* foo: bar: last
-	* invalid expression: "foo": tags are not allowed with this operation (must use exact names)
-	* invalid expression: "bar": names are not allowed with this operation (must use tags)
-	* bottom
-
-`
-				return assert.Equal(t, expected, err.Error())
-			},
-			wantExpErrs: []task.ErrInvalidExpression{
-				{Expression: "foo", Operation: task.AddOperation, Err: task.ErrTagsNotAllowed},
-				{Expression: "bar", Operation: task.SubSelectOperation, Err: task.ErrNamesNotAllowed},
-			},
-			wantHelp: `Suggestions:
-
- ❖ Given expression "--select-catalogers foo"
-   However, tags are not allowed with this operation (must use exact names).
-   Adding groups of catalogers may result in surprising behavior (create inaccurate SBOMs).
-   If you are certain this is what you want to do, use "--override-default-catalogers foo" instead.
-
- ❖ Given expression "--select-catalogers bar"
-   However, names are not allowed with this operation (must use tags).
-   It seems like you are intending to add a cataloger in addition to the default set.
-   ... Did you mean "--select-catalogers +bar" instead?
-`,
-		},
-		{
-			name: "preserve for any errors within ErrInvalidExpression types",
-			err: func() error {
-				var err error
-				err = multierror.Append(err, task.ErrInvalidExpression{Expression: "foo", Operation: task.AddOperation, Err: task.ErrTagsNotAllowed})
-				err = multierror.Append(err, task.ErrInvalidExpression{Expression: "bar", Operation: task.SubSelectOperation, Err: errors.New("explanation")}) // this is what makes this test different...
-
-				return err
-			}(),
-			wantErr: func(t assert.TestingT, err error, i ...interface{}) bool {
-				// note: the errors are removed and the help text shows the enriched error help
-				expected := `2 errors occurred:
-	* invalid expression: "foo": tags are not allowed with this operation (must use exact names)
-	* invalid expression: "bar": explanation
-
-`
-				return assert.Equal(t, expected, err.Error())
-			},
-			wantExpErrs: []task.ErrInvalidExpression{
-				{Expression: "foo", Operation: task.AddOperation, Err: task.ErrTagsNotAllowed},
-				{Expression: "bar", Operation: task.SubSelectOperation, Err: errors.New("explanation")},
-			},
-			wantHelp: `Suggestions:
-
- ❖ Given expression "--select-catalogers foo"
-   However, tags are not allowed with this operation (must use exact names).
-   Adding groups of catalogers may result in surprising behavior (create inaccurate SBOMs).
-   If you are certain this is what you want to do, use "--override-default-catalogers foo" instead.
-
-`,
-		},
-	}
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			gotExpErrs := filterExpressionErrors(tt.err)
-			tt.wantErr(t, tt.err) // ensure the error still remains
-			assert.Equal(t, tt.wantExpErrs, gotExpErrs)
-
-			gotHelp := expressionErrorsHelp(gotExpErrs)
-			assert.Equal(t, tt.wantHelp, gotHelp)
-		})
-	}
-}
-
-func Test_expressionSuggestions(t *testing.T) {
-	tests := []struct {
-		name   string
-		expErr task.ErrInvalidExpression
-		want   string
-	}{
-		{
-			name: "no embedded error",
-			expErr: task.ErrInvalidExpression{
-				Expression: "example",
-			},
-			want: ``,
-		},
-		{
-			name: "general error",
-			expErr: task.ErrInvalidExpression{
-				Err:        errors.New("general error message"),
-				Expression: "example",
-			},
-			want: ``,
-		},
-		{
-			name: "ErrUnknownNameOrTag with add operation",
-			expErr: task.ErrInvalidExpression{
-				Err:        task.ErrUnknownNameOrTag,
-				Operation:  task.AddOperation,
-				Expression: "+example",
-			},
-			want: ``,
-		},
-		{
-			name: "ErrUnknownNameOrTag with subselect operation",
-			expErr: task.ErrInvalidExpression{
-				Err:        task.ErrUnknownNameOrTag,
-				Operation:  task.SubSelectOperation,
-				Expression: "example",
-			},
-			want: ``,
-		},
-		{
-			name: "ErrNamesNotAllowed with subselect operator",
-			expErr: task.ErrInvalidExpression{
-				Err:        task.ErrNamesNotAllowed,
-				Operation:  task.SubSelectOperation,
-				Expression: "example",
-			},
-			want: ` ❖ Given expression "--select-catalogers example"
-   However, names are not allowed with this operation (must use tags).
-   It seems like you are intending to add a cataloger in addition to the default set.
-   ... Did you mean "--select-catalogers +example" instead?
-`,
-		},
-		{
-			name: "ErrTagsNotAllowed with add operation",
-			expErr: task.ErrInvalidExpression{
-				Err:        task.ErrTagsNotAllowed,
-				Operation:  task.AddOperation,
-				Expression: "+example",
-			},
-			want: ` ❖ Given expression "--select-catalogers +example"
-   However, tags are not allowed with this operation (must use exact names).
-   Adding groups of catalogers may result in surprising behavior (create inaccurate SBOMs).
-   If you are certain this is what you want to do, use "--override-default-catalogers example" instead.
-`,
-		},
-		{
-			name: "ErrAllNotAllowed with subselect operation",
-			expErr: task.ErrInvalidExpression{
-				Err:        task.ErrAllNotAllowed,
-				Operation:  task.SubSelectOperation,
-				Expression: "example",
-			},
-			want: ` ❖ Given expression "--select-catalogers example"
-   However, you cannot use the 'all' operand in this context.
-   It seems like you are intending to use all catalogers (which is not recommended).
-   ... Did you mean "--override-default-catalogers example" instead?
-`,
-		},
-	}
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			assert.Equal(t, tt.want, expressionSuggetions(tt.expErr))
-		})
-	}
-}

cmd/syft/internal/commands/root.go

@@ -1,31 +0,0 @@
-package commands
-
-import (
-	"fmt"
-
-	"github.com/spf13/cobra"
-
-	"github.com/anchore/clio"
-	"github.com/anchore/syft/cmd/syft/internal/ui"
-)
-
-func Root(app clio.Application, packagesCmd *cobra.Command) *cobra.Command {
-	id := app.ID()
-
-	opts := defaultScanOptions()
-
-	return app.SetupRootCommand(&cobra.Command{
-		Use:     fmt.Sprintf("%s [SOURCE]", app.ID().Name),
-		Short:   packagesCmd.Short,
-		Long:    packagesCmd.Long,
-		Args:    packagesCmd.Args,
-		Example: packagesCmd.Example,
-		PreRunE: applicationUpdateCheck(id, &opts.UpdateCheck),
-		RunE: func(cmd *cobra.Command, args []string) error {
-			restoreStdout := ui.CaptureStdoutToTraceLog()
-			defer restoreStdout()
-
-			return runScan(cmd.Context(), id, opts, args[0])
-		},
-	}, opts)
-}

cmd/syft/internal/commands/scan.go

@@ -1,454 +0,0 @@
-package commands
-
-import (
-	"context"
-	"errors"
-	"fmt"
-	"os"
-	"reflect"
-	"strings"
-
-	"github.com/hashicorp/go-multierror"
-	"github.com/spf13/cobra"
-	"gopkg.in/yaml.v3"
-
-	"github.com/anchore/clio"
-	"github.com/anchore/go-collections"
-	"github.com/anchore/stereoscope"
-	"github.com/anchore/stereoscope/pkg/image"
-	"github.com/anchore/syft/cmd/syft/internal/options"
-	"github.com/anchore/syft/cmd/syft/internal/ui"
-	"github.com/anchore/syft/internal"
-	"github.com/anchore/syft/internal/bus"
-	"github.com/anchore/syft/internal/file"
-	"github.com/anchore/syft/internal/log"
-	"github.com/anchore/syft/internal/task"
-	"github.com/anchore/syft/syft"
-	"github.com/anchore/syft/syft/sbom"
-	"github.com/anchore/syft/syft/source"
-	"github.com/anchore/syft/syft/source/sourceproviders"
-)
-
-const (
-	scanExample = `  {{.appName}} {{.command}} alpine:latest                                a summary of discovered packages
-  {{.appName}} {{.command}} alpine:latest -o json                        show all possible cataloging details
-  {{.appName}} {{.command}} alpine:latest -o cyclonedx                   show a CycloneDX formatted SBOM
-  {{.appName}} {{.command}} alpine:latest -o cyclonedx-json              show a CycloneDX JSON formatted SBOM
-  {{.appName}} {{.command}} alpine:latest -o spdx                        show a SPDX 2.3 Tag-Value formatted SBOM
-  {{.appName}} {{.command}} alpine:latest -o spdx@2.2                    show a SPDX 2.2 Tag-Value formatted SBOM
-  {{.appName}} {{.command}} alpine:latest -o spdx-json                   show a SPDX 2.3 JSON formatted SBOM
-  {{.appName}} {{.command}} alpine:latest -o spdx-json@2.2               show a SPDX 2.2 JSON formatted SBOM
-  {{.appName}} {{.command}} alpine:latest -vv                            show verbose debug information
-  {{.appName}} {{.command}} alpine:latest -o template -t my_format.tmpl  show a SBOM formatted according to given template file
-
-  Supports the following image sources:
-    {{.appName}} {{.command}} yourrepo/yourimage:tag     defaults to using images from a Docker daemon. If Docker is not present, the image is pulled directly from the registry.
-    {{.appName}} {{.command}} path/to/a/file/or/dir      a Docker tar, OCI tar, OCI directory, SIF container, or generic filesystem directory
-`
-
-	schemeHelpHeader = "You can also explicitly specify the scheme to use:"
-	imageSchemeHelp  = `    {{.appName}} {{.command}} docker:yourrepo/yourimage:tag            explicitly use the Docker daemon
-    {{.appName}} {{.command}} podman:yourrepo/yourimage:tag            explicitly use the Podman daemon
-    {{.appName}} {{.command}} registry:yourrepo/yourimage:tag          pull image directly from a registry (no container runtime required)
-    {{.appName}} {{.command}} docker-archive:path/to/yourimage.tar     use a tarball from disk for archives created from "docker save"
-    {{.appName}} {{.command}} oci-archive:path/to/yourimage.tar        use a tarball from disk for OCI archives (from Skopeo or otherwise)
-    {{.appName}} {{.command}} oci-dir:path/to/yourimage                read directly from a path on disk for OCI layout directories (from Skopeo or otherwise)
-    {{.appName}} {{.command}} singularity:path/to/yourimage.sif        read directly from a Singularity Image Format (SIF) container on disk
-`
-	nonImageSchemeHelp = `    {{.appName}} {{.command}} dir:path/to/yourproject                  read directly from a path on disk (any directory)
-    {{.appName}} {{.command}} file:path/to/yourproject/file            read directly from a path on disk (any single file)
-`
-	scanSchemeHelp = "\n  " + schemeHelpHeader + "\n" + imageSchemeHelp + nonImageSchemeHelp
-
-	scanHelp = scanExample + scanSchemeHelp
-)
-
-type scanOptions struct {
-	options.Config      `yaml:",inline" mapstructure:",squash"`
-	options.Output      `yaml:",inline" mapstructure:",squash"`
-	options.UpdateCheck `yaml:",inline" mapstructure:",squash"`
-	options.Catalog     `yaml:",inline" mapstructure:",squash"`
-}
-
-func defaultScanOptions() *scanOptions {
-	return &scanOptions{
-		Output:      options.DefaultOutput(),
-		UpdateCheck: options.DefaultUpdateCheck(),
-		Catalog:     options.DefaultCatalog(),
-	}
-}
-
-//nolint:dupl
-func Scan(app clio.Application) *cobra.Command {
-	id := app.ID()
-
-	opts := defaultScanOptions()
-
-	return app.SetupCommand(&cobra.Command{
-		Use:   "scan [SOURCE]",
-		Short: "Generate an SBOM",
-		Long:  "Generate a packaged-based Software Bill Of Materials (SBOM) from container images and filesystems",
-		Example: internal.Tprintf(scanHelp, map[string]interface{}{
-			"appName": id.Name,
-			"command": "scan",
-		}),
-		Args:    validateScanArgs,
-		PreRunE: applicationUpdateCheck(id, &opts.UpdateCheck),
-		RunE: func(cmd *cobra.Command, args []string) error {
-			restoreStdout := ui.CaptureStdoutToTraceLog()
-			defer restoreStdout()
-
-			return runScan(cmd.Context(), id, opts, args[0])
-		},
-	}, opts)
-}
-
-func (o *scanOptions) PostLoad() error {
-	return o.validateLegacyOptionsNotUsed()
-}
-
-func (o *scanOptions) validateLegacyOptionsNotUsed() error {
-	if o.Config.ConfigFile == "" {
-		return nil
-	}
-
-	// check for legacy config file shapes that are no longer valid
-	type legacyConfig struct {
-		BasePath                        *string `yaml:"base-path" json:"base-path" mapstructure:"base-path"`
-		DefaultImagePullSource          *string `yaml:"default-image-pull-source" json:"default-image-pull-source" mapstructure:"default-image-pull-source"`
-		ExcludeBinaryOverlapByOwnership *bool   `yaml:"exclude-binary-overlap-by-ownership" json:"exclude-binary-overlap-by-ownership" mapstructure:"exclude-binary-overlap-by-ownership"`
-		File                            any     `yaml:"file" json:"file" mapstructure:"file"`
-	}
-
-	by, err := os.ReadFile(o.Config.ConfigFile)
-	if err != nil {
-		return fmt.Errorf("unable to read config file during validations %q: %w", o.Config.ConfigFile, err)
-	}
-
-	var legacy legacyConfig
-	if err := yaml.Unmarshal(by, &legacy); err != nil {
-		return fmt.Errorf("unable to parse config file during validations %q: %w", o.Config.ConfigFile, err)
-	}
-
-	if legacy.DefaultImagePullSource != nil {
-		return fmt.Errorf("the config file option 'default-image-pull-source' has been removed, please use 'source.image.default-pull-source' instead")
-	}
-
-	if legacy.ExcludeBinaryOverlapByOwnership != nil {
-		return fmt.Errorf("the config file option 'exclude-binary-overlap-by-ownership' has been removed, please use 'package.exclude-binary-overlap-by-ownership' instead")
-	}
-
-	if legacy.BasePath != nil {
-		return fmt.Errorf("the config file option 'base-path' has been removed, please use 'source.base-path' instead")
-	}
-
-	if legacy.File != nil && reflect.TypeOf(legacy.File).Kind() == reflect.String {
-		return fmt.Errorf("the config file option 'file' has been removed, please use 'outputs' instead")
-	}
-
-	return nil
-}
-
-func validateScanArgs(cmd *cobra.Command, args []string) error {
-	return validateArgs(cmd, args, "an image/directory argument is required")
-}
-
-func validateArgs(cmd *cobra.Command, args []string, error string) error {
-	if len(args) == 0 {
-		// in the case that no arguments are given we want to show the help text and return with a non-0 return code.
-		if err := cmd.Help(); err != nil {
-			return fmt.Errorf("unable to display help: %w", err)
-		}
-		return fmt.Errorf(error)
-	}
-
-	return cobra.MaximumNArgs(1)(cmd, args)
-}
-
-func runScan(ctx context.Context, id clio.Identification, opts *scanOptions, userInput string) error {
-	writer, err := opts.SBOMWriter()
-	if err != nil {
-		return err
-	}
-
-	sources := opts.From
-	if len(sources) == 0 {
-		// extract a scheme if it matches any provider tag; this is a holdover for compatibility, using the --from flag is recommended
-		explicitSource, newUserInput := stereoscope.ExtractSchemeSource(userInput, allSourceProviderTags()...)
-		if explicitSource != "" {
-			sources = append(sources, explicitSource)
-			userInput = newUserInput
-		}
-	}
-
-	src, err := getSource(ctx, &opts.Catalog, userInput, sources...)
-
-	if err != nil {
-		return err
-	}
-
-	defer func() {
-		if src != nil {
-			if err := src.Close(); err != nil {
-				log.Tracef("unable to close source: %+v", err)
-			}
-		}
-	}()
-
-	s, err := generateSBOM(ctx, id, src, &opts.Catalog)
-	if err != nil {
-		return err
-	}
-
-	if s == nil {
-		return fmt.Errorf("no SBOM produced for %q", userInput)
-	}
-
-	if err := writer.Write(*s); err != nil {
-		return fmt.Errorf("failed to write SBOM: %w", err)
-	}
-
-	return nil
-}
-
-func getSource(ctx context.Context, opts *options.Catalog, userInput string, sources ...string) (source.Source, error) {
-	cfg := syft.DefaultGetSourceConfig().
-		WithRegistryOptions(opts.Registry.ToOptions()).
-		WithAlias(source.Alias{
-			Name:    opts.Source.Name,
-			Version: opts.Source.Version,
-		}).
-		WithExcludeConfig(source.ExcludeConfig{
-			Paths: opts.Exclusions,
-		}).
-		WithBasePath(opts.Source.BasePath).
-		WithSources(sources...).
-		WithDefaultImagePullSource(opts.Source.Image.DefaultPullSource)
-
-	var err error
-	var platform *image.Platform
-
-	if opts.Platform != "" {
-		platform, err = image.NewPlatform(opts.Platform)
-		if err != nil {
-			return nil, fmt.Errorf("invalid platform: %w", err)
-		}
-		cfg = cfg.WithPlatform(platform)
-	}
-
-	if opts.Source.File.Digests != nil {
-		hashers, err := file.Hashers(opts.Source.File.Digests...)
-		if err != nil {
-			return nil, fmt.Errorf("invalid hash algorithm: %w", err)
-		}
-		cfg = cfg.WithDigestAlgorithms(hashers...)
-	}
-
-	src, err := syft.GetSource(ctx, userInput, cfg)
-	if err != nil {
-		return nil, fmt.Errorf("could not determine source: %w", err)
-	}
-
-	if err != nil {
-		if userInput == "power-user" {
-			bus.Notify("Note: the 'power-user' command has been removed.")
-		}
-		return nil, fmt.Errorf("failed to construct source from user input %q: %w", userInput, err)
-	}
-
-	return src, nil
-}
-
-func generateSBOM(ctx context.Context, id clio.Identification, src source.Source, opts *options.Catalog) (*sbom.SBOM, error) {
-	s, err := syft.CreateSBOM(ctx, src, opts.ToSBOMConfig(id))
-	if err != nil {
-		expErrs := filterExpressionErrors(err)
-		notifyExpressionErrors(expErrs)
-		return nil, err
-	}
-	return s, nil
-}
-
-func filterExpressionErrors(err error) []task.ErrInvalidExpression {
-	if err == nil {
-		return nil
-	}
-
-	expErrs := processErrors(err)
-
-	return expErrs
-}
-
-// processErrors traverses error chains and multierror lists and returns all ErrInvalidExpression errors found
-func processErrors(err error) []task.ErrInvalidExpression {
-	var result []task.ErrInvalidExpression
-
-	var processError func(...error)
-	processError = func(errs ...error) {
-		for _, e := range errs {
-			// note: using errors.As will result in surprising behavior (since that will traverse the error chain,
-			// potentially skipping over nodes in a list of errors)
-			if cerr, ok := e.(task.ErrInvalidExpression); ok {
-				result = append(result, cerr)
-				continue
-			}
-			var multiErr *multierror.Error
-			if errors.As(e, &multiErr) {
-				processError(multiErr.Errors...)
-			}
-		}
-	}
-
-	processError(err)
-
-	return result
-}
-
-func notifyExpressionErrors(expErrs []task.ErrInvalidExpression) {
-	helpText := expressionErrorsHelp(expErrs)
-	if helpText == "" {
-		return
-	}
-
-	bus.Notify(helpText)
-}
-
-func expressionErrorsHelp(expErrs []task.ErrInvalidExpression) string {
-	// enrich all errors found with CLI hints
-	if len(expErrs) == 0 {
-		return ""
-	}
-
-	sb := strings.Builder{}
-
-	sb.WriteString("Suggestions:\n\n")
-
-	found := false
-	for i, expErr := range expErrs {
-		help := expressionSuggetions(expErr)
-		if help == "" {
-			continue
-		}
-		found = true
-		sb.WriteString(help)
-		if i != len(expErrs)-1 {
-			sb.WriteString("\n")
-		}
-	}
-
-	if !found {
-		return ""
-	}
-
-	return sb.String()
-}
-
-const expressionHelpTemplate = " ❖ Given expression %q\n%s%s"
-
-func expressionSuggetions(expErr task.ErrInvalidExpression) string {
-	if expErr.Err == nil {
-		return ""
-	}
-
-	hint := getHintPhrase(expErr)
-	if hint == "" {
-		return ""
-	}
-
-	return fmt.Sprintf(expressionHelpTemplate,
-		getExpression(expErr),
-		indentMsg(getExplanation(expErr)),
-		indentMsg(hint),
-	)
-}
-
-func indentMsg(msg string) string {
-	if msg == "" {
-		return ""
-	}
-
-	lines := strings.Split(msg, "\n")
-	for i, line := range lines {
-		lines[i] = "   " + line
-	}
-
-	return strings.Join(lines, "\n") + "\n"
-}
-
-func getExpression(expErr task.ErrInvalidExpression) string {
-	flag := "--select-catalogers"
-	if expErr.Operation == task.SetOperation {
-		flag = "--override-default-catalogers"
-	}
-	return fmt.Sprintf("%s %s", flag, expErr.Expression)
-}
-
-func getExplanation(expErr task.ErrInvalidExpression) string {
-	err := expErr.Err
-	if errors.Is(err, task.ErrUnknownNameOrTag) {
-		noun := ""
-		switch expErr.Operation {
-		case task.AddOperation:
-			noun = "name"
-		case task.SubSelectOperation:
-			noun = "tag"
-		default:
-			noun = "name or tag"
-		}
-
-		return fmt.Sprintf("However, %q is not a recognized cataloger %s.", trimOperation(expErr.Expression), noun)
-	}
-
-	if errors.Is(err, task.ErrNamesNotAllowed) {
-		if expErr.Operation == task.SubSelectOperation {
-			return "However, " + err.Error() + ".\nIt seems like you are intending to add a cataloger in addition to the default set." // nolint:goconst
-		}
-		return "However, " + err.Error() + "." // nolint:goconst
-	}
-
-	if errors.Is(err, task.ErrTagsNotAllowed) {
-		return "However, " + err.Error() + ".\nAdding groups of catalogers may result in surprising behavior (create inaccurate SBOMs)." // nolint:goconst
-	}
-
-	if errors.Is(err, task.ErrAllNotAllowed) {
-		return "However, you " + err.Error() + ".\nIt seems like you are intending to use all catalogers (which is not recommended)."
-	}
-
-	if err != nil {
-		return "However, this is not valid: " + err.Error()
-	}
-
-	return ""
-}
-
-func getHintPhrase(expErr task.ErrInvalidExpression) string {
-	if errors.Is(expErr.Err, task.ErrUnknownNameOrTag) {
-		return ""
-	}
-
-	switch expErr.Operation {
-	case task.AddOperation:
-		if errors.Is(expErr.Err, task.ErrTagsNotAllowed) {
-			return fmt.Sprintf("If you are certain this is what you want to do, use %q instead.", "--override-default-catalogers "+trimOperation(expErr.Expression))
-		}
-
-	case task.SubSelectOperation:
-		didYouMean := "... Did you mean %q instead?"
-		if errors.Is(expErr.Err, task.ErrNamesNotAllowed) {
-			return fmt.Sprintf(didYouMean, "--select-catalogers +"+expErr.Expression)
-		}
-
-		if errors.Is(expErr.Err, task.ErrAllNotAllowed) {
-			return fmt.Sprintf(didYouMean, "--override-default-catalogers "+expErr.Expression)
-		}
-	}
-	return ""
-}
-
-func trimOperation(x string) string {
-	return strings.TrimLeft(x, "+-")
-}
-
-func allSourceProviderTags() []string {
-	return collections.TaggedValueSet[source.Provider]{}.Join(sourceproviders.All("", nil)...).Tags()
-}

cmd/syft/internal/commands/scan_test.go

@@ -1,66 +0,0 @@
-package commands
-
-import (
-	"testing"
-
-	"github.com/stretchr/testify/assert"
-
-	"github.com/anchore/syft/cmd/syft/internal/options"
-)
-
-func Test_scanOptions_validateLegacyOptionsNotUsed(t *testing.T) {
-	tests := []struct {
-		name    string
-		cfg     string
-		wantErr assert.ErrorAssertionFunc
-	}{
-		{
-			name: "no config file",
-		},
-		{
-			name: "config file with no legacy options",
-			cfg:  "test-fixtures/scan-configs/no-legacy-options.yaml",
-		},
-		{
-			name:    "config file with default image pull source legacy option",
-			cfg:     "test-fixtures/scan-configs/with-default-pull-source.yaml",
-			wantErr: assertErrorContains("source.image.default-pull-source"),
-		},
-		{
-			name:    "config file with exclude-binary-overlap-by-ownership legacy option",
-			cfg:     "test-fixtures/scan-configs/with-exclude-binary-overlap-by-ownership.yaml",
-			wantErr: assertErrorContains("package.exclude-binary-overlap-by-ownership"),
-		},
-		{
-			name:    "config file with file string legacy option",
-			cfg:     "test-fixtures/scan-configs/with-file-string.yaml",
-			wantErr: assertErrorContains("outputs"),
-		},
-		{
-			name: "config file with file section",
-			cfg:  "test-fixtures/scan-configs/with-file-section.yaml",
-		},
-		{
-			name:    "config file with base-path legacy option",
-			cfg:     "test-fixtures/scan-configs/with-base-path.yaml",
-			wantErr: assertErrorContains("source.base-path"),
-		},
-	}
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			if tt.wantErr == nil {
-				tt.wantErr = assert.NoError
-			}
-			o := &scanOptions{
-				Config: options.Config{ConfigFile: tt.cfg},
-			}
-			tt.wantErr(t, o.validateLegacyOptionsNotUsed())
-		})
-	}
-}
-
-func assertErrorContains(contains string) assert.ErrorAssertionFunc {
-	return func(t assert.TestingT, err error, i ...interface{}) bool {
-		return assert.ErrorContains(t, err, contains, i...)
-	}
-}

cmd/syft/internal/commands/test-fixtures/scan-configs/no-legacy-options.yaml

@@ -1,2 +0,0 @@
-# simple, valid syft config with no legacy fields used
-parallelism: 5

cmd/syft/internal/commands/test-fixtures/scan-configs/with-base-path.yaml

@@ -1 +0,0 @@
-base-path: "something"

cmd/syft/internal/commands/test-fixtures/scan-configs/with-default-pull-source.yaml

@@ -1 +0,0 @@
-default-image-pull-source: "something"

cmd/syft/internal/commands/test-fixtures/scan-configs/with-exclude-binary-overlap-by-ownership.yaml

@@ -1 +0,0 @@
-exclude-binary-overlap-by-ownership: true

cmd/syft/internal/commands/test-fixtures/scan-configs/with-file-section.yaml

@@ -1,2 +0,0 @@
-file:
-  selection: all

cmd/syft/internal/commands/test-fixtures/scan-configs/with-file-string.yaml

@@ -1 +0,0 @@
-file: path

cmd/syft/internal/commands/update.go

@@ -1,121 +0,0 @@
-package commands
-
-import (
-	"fmt"
-	"io"
-	"net/http"
-	"strings"
-
-	"github.com/spf13/cobra"
-	"github.com/wagoodman/go-partybus"
-
-	"github.com/anchore/clio"
-	hashiVersion "github.com/anchore/go-version"
-	"github.com/anchore/syft/cmd/syft/internal"
-	"github.com/anchore/syft/cmd/syft/internal/options"
-	"github.com/anchore/syft/internal/bus"
-	"github.com/anchore/syft/internal/log"
-	"github.com/anchore/syft/syft/event"
-	"github.com/anchore/syft/syft/event/parsers"
-)
-
-var latestAppVersionURL = struct {
-	host string
-	path string
-}{
-	host: "https://toolbox-data.anchore.io",
-	path: "/syft/releases/latest/VERSION",
-}
-
-func applicationUpdateCheck(id clio.Identification, check *options.UpdateCheck) func(cmd *cobra.Command, args []string) error {
-	return func(_ *cobra.Command, _ []string) error {
-		if check.CheckForAppUpdate {
-			checkForApplicationUpdate(id)
-		}
-		return nil
-	}
-}
-
-func checkForApplicationUpdate(id clio.Identification) {
-	log.Debugf("checking if a new version of %s is available", id.Name)
-	isAvailable, newVersion, err := isUpdateAvailable(id)
-	if err != nil {
-		// this should never stop the application
-		log.Errorf(err.Error())
-	}
-	if isAvailable {
-		log.Infof("new version of %s is available: %s (current version is %s)", id.Name, newVersion, id.Version)
-
-		bus.Publish(partybus.Event{
-			Type: event.CLIAppUpdateAvailable,
-			Value: parsers.UpdateCheck{
-				New:     newVersion,
-				Current: id.Version,
-			},
-		})
-	} else {
-		log.Debugf("no new %s update available", id.Name)
-	}
-}
-
-// isUpdateAvailable indicates if there is a newer application version available, and if so, what the new version is.
-func isUpdateAvailable(id clio.Identification) (bool, string, error) {
-	if !isProductionBuild(id.Version) {
-		// don't allow for non-production builds to check for a version.
-		return false, "", nil
-	}
-
-	currentVersion, err := hashiVersion.NewVersion(id.Version)
-	if err != nil {
-		return false, "", fmt.Errorf("failed to parse current application version: %w", err)
-	}
-
-	latestVersion, err := fetchLatestApplicationVersion(id)
-	if err != nil {
-		return false, "", err
-	}
-
-	if latestVersion.GreaterThan(currentVersion) {
-		return true, latestVersion.String(), nil
-	}
-
-	return false, "", nil
-}
-
-func isProductionBuild(version string) bool {
-	if strings.Contains(version, "SNAPSHOT") || strings.Contains(version, internal.NotProvided) {
-		return false
-	}
-	return true
-}
-
-func fetchLatestApplicationVersion(id clio.Identification) (*hashiVersion.Version, error) {
-	req, err := http.NewRequest(http.MethodGet, latestAppVersionURL.host+latestAppVersionURL.path, nil)
-	if err != nil {
-		return nil, fmt.Errorf("failed to create request for latest version: %w", err)
-	}
-	req.Header.Add("User-Agent", fmt.Sprintf("%v %v", id.Name, id.Version))
-
-	client := http.Client{}
-	resp, err := client.Do(req)
-	if err != nil {
-		return nil, fmt.Errorf("failed to fetch latest version: %w", err)
-	}
-	defer func() { _ = resp.Body.Close() }()
-
-	if resp.StatusCode != http.StatusOK {
-		return nil, fmt.Errorf("HTTP %d on fetching latest version: %s", resp.StatusCode, resp.Status)
-	}
-
-	versionBytes, err := io.ReadAll(resp.Body)
-	if err != nil {
-		return nil, fmt.Errorf("failed to read latest version: %w", err)
-	}
-
-	versionStr := strings.TrimSuffix(string(versionBytes), "\n")
-	if len(versionStr) > 50 {
-		return nil, fmt.Errorf("version too long: %q", versionStr[:50])
-	}
-
-	return hashiVersion.NewVersion(versionStr)
-}

cmd/syft/internal/constants.go

@@ -1,5 +0,0 @@
-package internal
-
-const (
-	NotProvided = "[not provided]"
-)

cmd/syft/internal/options/attest.go

@@ -1,19 +0,0 @@
-package options
-
-import (
-	"github.com/anchore/clio"
-)
-
-var _ clio.FlagAdder = (*Attest)(nil)
-
-type Attest struct {
-	// IMPORTANT: do not show the attestation key/password in any YAML/JSON output (sensitive information)
-	Key      secret `yaml:"key" json:"key" mapstructure:"key"`
-	Password secret `yaml:"password" json:"password" mapstructure:"password"`
-}
-
-var _ clio.FlagAdder = (*Attest)(nil)
-
-func (o *Attest) AddFlags(flags clio.FlagSet) {
-	flags.StringVarP((*string)(&o.Key), "key", "k", "the key to use for the attestation")
-}

cmd/syft/internal/options/catalog.go

@@ -1,242 +0,0 @@
-package options
-
-import (
-	"fmt"
-	"sort"
-	"strings"
-
-	"github.com/iancoleman/strcase"
-
-	"github.com/anchore/clio"
-	"github.com/anchore/fangs"
-	intFile "github.com/anchore/syft/internal/file"
-	"github.com/anchore/syft/internal/log"
-	"github.com/anchore/syft/syft"
-	"github.com/anchore/syft/syft/cataloging"
-	"github.com/anchore/syft/syft/cataloging/filecataloging"
-	"github.com/anchore/syft/syft/cataloging/pkgcataloging"
-	"github.com/anchore/syft/syft/file/cataloger/executable"
-	"github.com/anchore/syft/syft/file/cataloger/filecontent"
-	"github.com/anchore/syft/syft/pkg/cataloger/binary"
-	"github.com/anchore/syft/syft/pkg/cataloger/golang"
-	"github.com/anchore/syft/syft/pkg/cataloger/java"
-	"github.com/anchore/syft/syft/pkg/cataloger/javascript"
-	"github.com/anchore/syft/syft/pkg/cataloger/kernel"
-	"github.com/anchore/syft/syft/pkg/cataloger/python"
-	"github.com/anchore/syft/syft/source"
-)
-
-type Catalog struct {
-	// high-level cataloger configuration
-	Catalogers        []string            `yaml:"-" json:"catalogers" mapstructure:"catalogers"` // deprecated and not shown in yaml output
-	DefaultCatalogers []string            `yaml:"default-catalogers" json:"default-catalogers" mapstructure:"default-catalogers"`
-	SelectCatalogers  []string            `yaml:"select-catalogers" json:"select-catalogers" mapstructure:"select-catalogers"`
-	Package           packageConfig       `yaml:"package" json:"package" mapstructure:"package"`
-	File              fileConfig          `yaml:"file" json:"file" mapstructure:"file"`
-	Scope             string              `yaml:"scope" json:"scope" mapstructure:"scope"`
-	Parallelism       int                 `yaml:"parallelism" json:"parallelism" mapstructure:"parallelism"` // the number of catalog workers to run in parallel
-	Relationships     relationshipsConfig `yaml:"relationships" json:"relationships" mapstructure:"relationships"`
-
-	// ecosystem-specific cataloger configuration
-	Golang      golangConfig      `yaml:"golang" json:"golang" mapstructure:"golang"`
-	Java        javaConfig        `yaml:"java" json:"java" mapstructure:"java"`
-	JavaScript  javaScriptConfig  `yaml:"javascript" json:"javascript" mapstructure:"javascript"`
-	LinuxKernel linuxKernelConfig `yaml:"linux-kernel" json:"linux-kernel" mapstructure:"linux-kernel"`
-	Python      pythonConfig      `yaml:"python" json:"python" mapstructure:"python"`
-
-	// configuration for the source (the subject being analyzed)
-	Registry   registryConfig `yaml:"registry" json:"registry" mapstructure:"registry"`
-	From       []string       `yaml:"from" json:"from" mapstructure:"from"`
-	Platform   string         `yaml:"platform" json:"platform" mapstructure:"platform"`
-	Source     sourceConfig   `yaml:"source" json:"source" mapstructure:"source"`
-	Exclusions []string       `yaml:"exclude" json:"exclude" mapstructure:"exclude"`
-}
-
-var _ interface {
-	clio.FlagAdder
-	clio.PostLoader
-	fangs.FieldDescriber
-} = (*Catalog)(nil)
-
-func DefaultCatalog() Catalog {
-	return Catalog{
-		Scope:         source.SquashedScope.String(),
-		Package:       defaultPackageConfig(),
-		LinuxKernel:   defaultLinuxKernelConfig(),
-		Golang:        defaultGolangConfig(),
-		File:          defaultFileConfig(),
-		Relationships: defaultRelationshipsConfig(),
-		Source:        defaultSourceConfig(),
-		Parallelism:   1,
-	}
-}
-
-func (cfg Catalog) ToSBOMConfig(id clio.Identification) *syft.CreateSBOMConfig {
-	return syft.DefaultCreateSBOMConfig().
-		WithTool(id.Name, id.Version).
-		WithParallelism(cfg.Parallelism).
-		WithRelationshipsConfig(cfg.ToRelationshipsConfig()).
-		WithSearchConfig(cfg.ToSearchConfig()).
-		WithPackagesConfig(cfg.ToPackagesConfig()).
-		WithFilesConfig(cfg.ToFilesConfig()).
-		WithCatalogerSelection(
-			pkgcataloging.NewSelectionRequest().
-				WithDefaults(cfg.DefaultCatalogers...).
-				WithExpression(cfg.SelectCatalogers...),
-		)
-}
-
-func (cfg Catalog) ToSearchConfig() cataloging.SearchConfig {
-	return cataloging.SearchConfig{
-		Scope: source.ParseScope(cfg.Scope),
-	}
-}
-
-func (cfg Catalog) ToRelationshipsConfig() cataloging.RelationshipsConfig {
-	return cataloging.RelationshipsConfig{
-		PackageFileOwnership:        cfg.Relationships.PackageFileOwnership,
-		PackageFileOwnershipOverlap: cfg.Relationships.PackageFileOwnershipOverlap,
-		// note: this option was surfaced in the syft application configuration before this relationships section was added
-		ExcludeBinaryPackagesWithFileOwnershipOverlap: cfg.Package.ExcludeBinaryOverlapByOwnership,
-	}
-}
-
-func (cfg Catalog) ToFilesConfig() filecataloging.Config {
-	hashers, err := intFile.Hashers(cfg.File.Metadata.Digests...)
-	if err != nil {
-		log.WithFields("error", err).Warn("unable to configure file hashers")
-	}
-
-	return filecataloging.Config{
-		Selection: cfg.File.Metadata.Selection,
-		Hashers:   hashers,
-		Content: filecontent.Config{
-			Globs:              cfg.File.Content.Globs,
-			SkipFilesAboveSize: cfg.File.Content.SkipFilesAboveSize,
-		},
-		Executable: executable.Config{
-			MIMETypes: executable.DefaultConfig().MIMETypes,
-			Globs:     cfg.File.Executable.Globs,
-		},
-	}
-}
-
-func (cfg Catalog) ToPackagesConfig() pkgcataloging.Config {
-	archiveSearch := cataloging.ArchiveSearchConfig{
-		IncludeIndexedArchives:   cfg.Package.SearchIndexedArchives,
-		IncludeUnindexedArchives: cfg.Package.SearchUnindexedArchives,
-	}
-	return pkgcataloging.Config{
-		Binary: binary.DefaultClassifierCatalogerConfig(),
-		Golang: golang.DefaultCatalogerConfig().
-			WithSearchLocalModCacheLicenses(cfg.Golang.SearchLocalModCacheLicenses).
-			WithLocalModCacheDir(cfg.Golang.LocalModCacheDir).
-			WithSearchRemoteLicenses(cfg.Golang.SearchRemoteLicenses).
-			WithProxy(cfg.Golang.Proxy).
-			WithNoProxy(cfg.Golang.NoProxy).
-			WithMainModuleVersion(
-				golang.DefaultMainModuleVersionConfig().
-					WithFromContents(cfg.Golang.MainModuleVersion.FromContents).
-					WithFromBuildSettings(cfg.Golang.MainModuleVersion.FromBuildSettings).
-					WithFromLDFlags(cfg.Golang.MainModuleVersion.FromLDFlags),
-			),
-		JavaScript: javascript.DefaultCatalogerConfig().
-			WithSearchRemoteLicenses(cfg.JavaScript.SearchRemoteLicenses).
-			WithNpmBaseURL(cfg.JavaScript.NpmBaseURL),
-		LinuxKernel: kernel.LinuxKernelCatalogerConfig{
-			CatalogModules: cfg.LinuxKernel.CatalogModules,
-		},
-		Python: python.CatalogerConfig{
-			GuessUnpinnedRequirements: cfg.Python.GuessUnpinnedRequirements,
-		},
-		JavaArchive: java.DefaultArchiveCatalogerConfig().
-			WithUseNetwork(cfg.Java.UseNetwork).
-			WithMavenBaseURL(cfg.Java.MavenURL).
-			WithArchiveTraversal(archiveSearch, cfg.Java.MaxParentRecursiveDepth),
-	}
-}
-
-func (cfg *Catalog) AddFlags(flags clio.FlagSet) {
-	var validScopeValues []string
-	for _, scope := range source.AllScopes {
-		validScopeValues = append(validScopeValues, strcase.ToDelimited(string(scope), '-'))
-	}
-	flags.StringVarP(&cfg.Scope, "scope", "s",
-		fmt.Sprintf("selection of layers to catalog, options=%v", validScopeValues))
-
-	flags.StringArrayVarP(&cfg.From, "from", "",
-		"specify the source behavior to use (e.g. docker, registry, oci-dir, ...)")
-
-	flags.StringVarP(&cfg.Platform, "platform", "",
-		"an optional platform specifier for container image sources (e.g. 'linux/arm64', 'linux/arm64/v8', 'arm64', 'linux')")
-
-	flags.StringArrayVarP(&cfg.Exclusions, "exclude", "",
-		"exclude paths from being scanned using a glob expression")
-
-	flags.StringArrayVarP(&cfg.Catalogers, "catalogers", "",
-		"enable one or more package catalogers")
-
-	if pfp, ok := flags.(fangs.PFlagSetProvider); ok {
-		if err := pfp.PFlagSet().MarkDeprecated("catalogers", "use: override-default-catalogers and select-catalogers"); err != nil {
-			panic(err)
-		}
-	} else {
-		panic("unable to mark flags as deprecated")
-	}
-
-	flags.StringArrayVarP(&cfg.DefaultCatalogers, "override-default-catalogers", "",
-		"set the base set of catalogers to use (defaults to 'image' or 'directory' depending on the scan source)")
-
-	flags.StringArrayVarP(&cfg.SelectCatalogers, "select-catalogers", "",
-		"add, remove, and filter the catalogers to be used")
-
-	flags.StringVarP(&cfg.Source.Name, "source-name", "",
-		"set the name of the target being analyzed")
-
-	flags.StringVarP(&cfg.Source.Version, "source-version", "",
-		"set the version of the target being analyzed")
-
-	flags.StringVarP(&cfg.Source.BasePath, "base-path", "",
-		"base directory for scanning, no links will be followed above this directory, and all paths will be reported relative to this directory")
-}
-
-func (cfg *Catalog) DescribeFields(descriptions fangs.FieldDescriptionSet) {
-	descriptions.Add(&cfg.Parallelism, "number of cataloger workers to run in parallel")
-}
-
-func (cfg *Catalog) PostLoad() error {
-	usingLegacyCatalogers := len(cfg.Catalogers) > 0
-	usingNewCatalogers := len(cfg.DefaultCatalogers) > 0 || len(cfg.SelectCatalogers) > 0
-
-	if usingLegacyCatalogers && usingNewCatalogers {
-		return fmt.Errorf("cannot use both 'catalogers' and 'select-catalogers'/'default-catalogers' flags")
-	}
-
-	flatten := func(l []string) []string {
-		var out []string
-		for _, v := range l {
-			for _, s := range strings.Split(v, ",") {
-				out = append(out, strings.TrimSpace(s))
-			}
-		}
-		sort.Strings(out)
-
-		return out
-	}
-
-	cfg.From = flatten(cfg.From)
-
-	cfg.Catalogers = flatten(cfg.Catalogers)
-	cfg.DefaultCatalogers = flatten(cfg.DefaultCatalogers)
-	cfg.SelectCatalogers = flatten(cfg.SelectCatalogers)
-
-	// for backwards compatibility
-	cfg.DefaultCatalogers = append(cfg.DefaultCatalogers, cfg.Catalogers...)
-
-	s := source.ParseScope(cfg.Scope)
-	if s == source.UnknownScope {
-		return fmt.Errorf("bad scope value %q", cfg.Scope)
-	}
-
-	return nil
-}

cmd/syft/internal/options/catalog_test.go

@@ -1,72 +0,0 @@
-package options
-
-import (
-	"fmt"
-	"testing"
-
-	"github.com/stretchr/testify/assert"
-)
-
-func TestCatalog_PostLoad(t *testing.T) {
-
-	tests := []struct {
-		name    string
-		options Catalog
-		assert  func(t *testing.T, options Catalog)
-		wantErr assert.ErrorAssertionFunc
-	}{
-		{
-			name: "mutually exclusive cataloger flags (cat / def-cat)",
-			options: Catalog{
-				Catalogers:        []string{"foo,bar", "42"},
-				DefaultCatalogers: []string{"some,thing"},
-				Scope:             "squashed",
-			},
-			wantErr: assert.Error,
-		},
-		{
-			name: "mutually exclusive cataloger flags (cat / sel-cat)",
-			options: Catalog{
-				Catalogers:       []string{"foo,bar", "42"},
-				SelectCatalogers: []string{"some,thing"},
-				Scope:            "squashed",
-			},
-			wantErr: assert.Error,
-		},
-		{
-			name: "allow old cataloger flags",
-			options: Catalog{
-				Catalogers: []string{"foo,bar"},
-				Scope:      "squashed",
-			},
-			assert: func(t *testing.T, options Catalog) {
-				assert.Equal(t, []string{"bar", "foo"}, options.DefaultCatalogers) // note: sorted order
-				assert.Equal(t, []string{"bar", "foo"}, options.Catalogers)        // note: sorted order
-			},
-		},
-		{
-			name: "allow new cataloger flags",
-			options: Catalog{
-				SelectCatalogers:  []string{"foo,bar", "42"},
-				DefaultCatalogers: []string{"some,thing"},
-				Scope:             "squashed",
-			},
-			assert: func(t *testing.T, options Catalog) {
-				assert.Equal(t, []string{"42", "bar", "foo"}, options.SelectCatalogers) // note: sorted order
-				assert.Equal(t, []string{"some", "thing"}, options.DefaultCatalogers)   // note: sorted order
-				assert.Empty(t, options.Catalogers)
-			},
-		},
-	}
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			if tt.wantErr == nil {
-				tt.wantErr = assert.NoError
-			}
-			tt.wantErr(t, tt.options.PostLoad(), fmt.Sprintf("PostLoad()"))
-			if tt.assert != nil {
-				tt.assert(t, tt.options)
-			}
-		})
-	}
-}

cmd/syft/internal/options/config.go

@@ -1,12 +0,0 @@
-package options
-
-import "github.com/anchore/fangs"
-
-// Config holds a reference to the specific config file that was used to load application configuration
-type Config struct {
-	ConfigFile string `yaml:"config" json:"config" mapstructure:"config"`
-}
-
-func (cfg *Config) DescribeFields(descriptions fangs.FieldDescriptionSet) {
-	descriptions.Add(&cfg.ConfigFile, "the configuration file that was used to load application configuration")
-}

cmd/syft/internal/options/file.go

@@ -1,58 +0,0 @@
-package options
-
-import (
-	"fmt"
-	"sort"
-
-	"github.com/scylladb/go-set/strset"
-
-	intFile "github.com/anchore/syft/internal/file"
-	"github.com/anchore/syft/syft/file"
-)
-
-type fileConfig struct {
-	Metadata   fileMetadata   `yaml:"metadata" json:"metadata" mapstructure:"metadata"`
-	Content    fileContent    `yaml:"content" json:"content" mapstructure:"content"`
-	Executable fileExecutable `yaml:"executable" json:"executable" mapstructure:"executable"`
-}
-
-type fileMetadata struct {
-	Selection file.Selection `yaml:"selection" json:"selection" mapstructure:"selection"`
-	Digests   []string       `yaml:"digests" json:"digests" mapstructure:"digests"`
-}
-
-type fileContent struct {
-	SkipFilesAboveSize int64    `yaml:"skip-files-above-size" json:"skip-files-above-size" mapstructure:"skip-files-above-size"`
-	Globs              []string `yaml:"globs" json:"globs" mapstructure:"globs"`
-}
-
-type fileExecutable struct {
-	Globs []string `yaml:"globs" json:"globs" mapstructure:"globs"`
-}
-
-func defaultFileConfig() fileConfig {
-	return fileConfig{
-		Metadata: fileMetadata{
-			Selection: file.FilesOwnedByPackageSelection,
-			Digests:   []string{"sha1", "sha256"},
-		},
-		Content: fileContent{
-			SkipFilesAboveSize: 250 * intFile.KB,
-		},
-		Executable: fileExecutable{
-			Globs: nil,
-		},
-	}
-}
-
-func (c *fileConfig) PostLoad() error {
-	digests := strset.New(c.Metadata.Digests...).List()
-	sort.Strings(digests)
-	c.Metadata.Digests = digests
-
-	switch c.Metadata.Selection {
-	case file.NoFilesSelection, file.FilesOwnedByPackageSelection, file.AllFilesSelection:
-		return nil
-	}
-	return fmt.Errorf("invalid file metadata selection: %q", c.Metadata.Selection)
-}

cmd/syft/internal/options/file_test.go

@@ -1,56 +0,0 @@
-package options
-
-import (
-	"testing"
-
-	"github.com/stretchr/testify/assert"
-
-	"github.com/anchore/syft/syft/file"
-)
-
-func Test_fileConfig_PostLoad(t *testing.T) {
-	tests := []struct {
-		name    string
-		cfg     fileConfig
-		assert  func(t *testing.T, cfg fileConfig)
-		wantErr assert.ErrorAssertionFunc
-	}{
-		{
-			name: "deduplicate digests",
-			cfg: fileConfig{
-				Metadata: fileMetadata{
-					Selection: file.NoFilesSelection,
-					Digests:   []string{"sha1", "sha1"},
-				},
-			},
-			assert: func(t *testing.T, cfg fileConfig) {
-				assert.Equal(t, []string{"sha1"}, cfg.Metadata.Digests)
-			},
-		},
-		{
-			name: "error on invalid selection",
-			cfg: fileConfig{
-				Metadata: fileMetadata{
-					Selection: file.Selection("invalid"),
-				},
-			},
-			wantErr: assert.Error,
-		},
-		{
-			name:    "error on empty selection",
-			cfg:     fileConfig{},
-			wantErr: assert.Error,
-		},
-	}
-	for _, tt := range tests {
-		t.Run(tt.name, func(t *testing.T) {
-			if tt.wantErr == nil {
-				tt.wantErr = assert.NoError
-			}
-			tt.wantErr(t, tt.cfg.PostLoad())
-			if tt.assert != nil {
-				tt.assert(t, tt.cfg)
-			}
-		})
-	}
-}

cmd/syft/internal/options/format.go

@@ -1,60 +0,0 @@
-package options
-
-import (
-	"github.com/anchore/clio"
-	"github.com/anchore/syft/syft/format"
-	"github.com/anchore/syft/syft/format/spdxtagvalue"
-	"github.com/anchore/syft/syft/sbom"
-)
-
-var _ clio.PostLoader = (*Format)(nil)
-
-// Format contains all user configuration for output formatting.
-type Format struct {
-	Pretty        *bool               `yaml:"pretty" json:"pretty" mapstructure:"pretty"`
-	Template      FormatTemplate      `yaml:"template" json:"template" mapstructure:"template"`
-	SyftJSON      FormatSyftJSON      `yaml:"json" json:"json" mapstructure:"json"`
-	SPDXJSON      FormatSPDXJSON      `yaml:"spdx-json" json:"spdx-json" mapstructure:"spdx-json"`
-	CyclonedxJSON FormatCyclonedxJSON `yaml:"cyclonedx-json" json:"cyclonedx-json" mapstructure:"cyclonedx-json"`
-	CyclonedxXML  FormatCyclonedxXML  `yaml:"cyclonedx-xml" json:"cyclonedx-xml" mapstructure:"cyclonedx-xml"`
-}
-
-func (o *Format) PostLoad() error {
-	o.SyftJSON.Pretty = multiLevelOption[bool](false, o.Pretty, o.SyftJSON.Pretty)
-	o.SPDXJSON.Pretty = multiLevelOption[bool](false, o.Pretty, o.SPDXJSON.Pretty)
-	o.CyclonedxJSON.Pretty = multiLevelOption[bool](false, o.Pretty, o.CyclonedxJSON.Pretty)
-	o.CyclonedxXML.Pretty = multiLevelOption[bool](false, o.Pretty, o.CyclonedxXML.Pretty)
-
-	return nil
-}
-
-func DefaultFormat() Format {
-	return Format{
-		Template:      DefaultFormatTemplate(),
-		SyftJSON:      DefaultFormatJSON(),
-		SPDXJSON:      DefaultFormatSPDXJSON(),
-		CyclonedxJSON: DefaultFormatCyclonedxJSON(),
-		CyclonedxXML:  DefaultFormatCyclonedxXML(),
-	}
-}
-
-func (o Format) Encoders() ([]sbom.FormatEncoder, error) {
-	return format.EncodersConfig{
-		Template:      o.Template.config(),
-		SyftJSON:      o.SyftJSON.config(),
-		SPDXJSON:      o.SPDXJSON.config(format.AllVersions),                   // we support multiple versions, not just a single version
-		SPDXTagValue:  spdxtagvalue.EncoderConfig{Version: format.AllVersions}, // we support multiple versions, not just a single version
-		CyclonedxJSON: o.CyclonedxJSON.config(format.AllVersions),              // we support multiple versions, not just a single version
-		CyclonedxXML:  o.CyclonedxXML.config(format.AllVersions),               // we support multiple versions, not just a single version
-	}.Encoders()
-}
-
-func multiLevelOption[T any](defaultValue T, option ...*T) *T {
-	result := defaultValue
-	for _, opt := range option {
-		if opt != nil {
-			result = *opt
-		}
-	}
-	return &result
-}

cmd/syft/internal/options/format_cyclonedx_json.go

@@ -1,24 +0,0 @@
-package options
-
-import (
-	"github.com/anchore/syft/syft/format/cyclonedxjson"
-)
-
-type FormatCyclonedxJSON struct {
-	Pretty *bool `yaml:"pretty" json:"pretty" mapstructure:"pretty"`
-}
-
-func DefaultFormatCyclonedxJSON() FormatCyclonedxJSON {
-	return FormatCyclonedxJSON{}
-}
-
-func (o FormatCyclonedxJSON) config(version string) cyclonedxjson.EncoderConfig {
-	var pretty bool
-	if o.Pretty != nil {
-		pretty = *o.Pretty
-	}
-	return cyclonedxjson.EncoderConfig{
-		Version: version,
-		Pretty:  pretty,
-	}
-}

cmd/syft/internal/options/format_cyclonedx_json_test.go

@@ -1,67 +0,0 @@
-package options
-
-import (
-	"reflect"
-	"testing"
-
-	"github.com/stretchr/testify/assert"
-)
-
-func TestFormatCyclonedxJSON_buildConfig(t *testing.T) {
-	// assert when building the config that we respond to all possible fields
-
-	ft := &FormatCyclonedxJSON{}
-	ft = setAllToNonZero(t, ft).(*FormatCyclonedxJSON)
-
-	subject := ft.config("Version")
-	assertExpectedValue(t, subject)
-}
-
-func setAllToNonZero(t testing.TB, structPtr any) any {
-	// set all fields on the struct to non-zero values
-	rt := reflect.TypeOf(structPtr)
-	if rt.Kind() != reflect.Ptr || rt.Elem().Kind() != reflect.Struct {
-		t.Fatal("expected a pointer to a struct")
-	}
-
-	rv := reflect.ValueOf(structPtr).Elem()
-	for i := 0; i < rt.Elem().NumField(); i++ {
-		val := getNonZeroExampleValue(t, rv.Field(i).Interface(), rt.Elem().Field(i).Name)
-		rv.Field(i).Set(reflect.ValueOf(val))
-	}
-	return structPtr
-}
-
-func getNonZeroExampleValue(t testing.TB, v any, name string) any {
-	switch v.(type) {
-	case bool:
-		return true
-	case *bool:
-		val := true
-		return &val
-	case string:
-		return name
-	}
-	t.Fatalf("unsupported type: %T", v)
-	return nil
-}
-
-func assertExpectedValue(t *testing.T, structTy any) {
-	rt := reflect.TypeOf(structTy)
-	rv := reflect.ValueOf(structTy)
-
-	for i := 0; i < rt.NumField(); i++ {
-		f := rt.Field(i)
-		fieldValue := rv.Field(i)
-
-		if fieldValue.Type().Kind() == reflect.String {
-			// use the field name as the expected value
-			assert.Equalf(t, f.Name, fieldValue.String(), "field %q value differs", f.Name)
-		} else {
-			// use the zero value for the type
-			if reflect.DeepEqual(fieldValue.Interface(), reflect.Zero(fieldValue.Type()).Interface()) {
-				t.Errorf("field '%s' is zero", f.Name)
-			}
-		}
-	}
-}

cmd/syft/internal/options/format_cyclonedx_xml.go

@@ -1,24 +0,0 @@
-package options
-
-import (
-	"github.com/anchore/syft/syft/format/cyclonedxxml"
-)
-
-type FormatCyclonedxXML struct {
-	Pretty *bool `yaml:"pretty" json:"pretty" mapstructure:"pretty"`
-}
-
-func DefaultFormatCyclonedxXML() FormatCyclonedxXML {
-	return FormatCyclonedxXML{}
-}
-
-func (o FormatCyclonedxXML) config(version string) cyclonedxxml.EncoderConfig {
-	var pretty bool
-	if o.Pretty != nil {
-		pretty = *o.Pretty
-	}
-	return cyclonedxxml.EncoderConfig{
-		Version: version,
-		Pretty:  pretty,
-	}
-}

cmd/syft/internal/options/format_cyclonedx_xml_test.go

@@ -1,15 +0,0 @@
-package options
-
-import (
-	"testing"
-)
-
-func TestFormatCyclonedxXML_buildConfig(t *testing.T) {
-	// assert when building the config that we respond to all possible fields
-
-	ft := FormatCyclonedxXML{}
-	ftp := setAllToNonZero(t, &ft).(*FormatCyclonedxXML)
-
-	subject := ftp.config("Version")
-	assertExpectedValue(t, subject)
-}