sdb-debugger 0.2.1__tar.gz

sdb_debugger-0.2.1/.github/scripts/clear-dump.sh

@@ -0,0 +1,13 @@
+#!/bin/bash -eu
+
+DATA_DIR="tests/integration/data"
+
+echo "checking folder structure ..."
+if [ ! -d $DATA_DIR ]; then
+	exit 1
+fi
+
+echo "removing all crash/core dumps ..."
+rm -rf $DATA_DIR/dumps
+
+echo "Done"

sdb_debugger-0.2.1/.github/scripts/download-dumps-from-gdrive.sh

@@ -0,0 +1,10 @@
+#!/bin/bash -eux
+
+#
+# Download all the reference core dumps from the public gDrive folder
+# and place them in the root directory.
+#
+python3 -m pip install gdown
+gdown --folder 1fdPVuGXbxNKcMEVwhuda04hZTPCcYJms
+mv SDB-Public/* .
+rmdir SDB-Public

sdb_debugger-0.2.1/.github/scripts/extract-dump.sh

@@ -0,0 +1,73 @@
+#!/bin/bash -eu
+
+#
+# Assumptions for this to work:
+# [1] This script is executed from the root of the SDB repo
+# [2] The archive downloaded from gdrive has one of the following profiles:
+#     Profile A - It is lzma-compressed and has the following file structure:
+#           dump-data
+#           ├── dump.201912060006
+#           ├── mods
+#           │   ├── avl
+#           │   │   └── zavl.ko
+#           .....
+#           │   └── zfs
+#           │       └── zfs.ko
+#           └── vmlinux-5.0.0-36-generic
+#     Profile B - It is gzip-compressed and generated by the savedump utility.
+#
+# Note: Profile A is deprecated. It was format used for dump archives created
+#       manually.
+#
+
+DATA_DIR="tests/integration/data"
+
+if [ $# -eq 0 ]; then
+	echo "error: no crash dump archive argument supplied"
+	exit 1
+fi
+
+echo "checking folder structure ..."
+if [ ! -d $DATA_DIR ]; then
+	echo "error: please cd to the root of the git repo"
+	exit 1
+fi
+
+if [ ! -f "$1" ]; then
+	echo "error: $1: file not found"
+fi
+
+if [[ $1 == *.tar.lzma ]]; then
+	# Profile A
+	dump_name=${1%.tar.lzma}
+
+	echo "decompressing dump ..."
+	tar -x --lzma -f $1
+
+	echo "moving contents to tests/integration/data/dumps/${dump_name} ..."
+	mkdir -p $DATA_DIR/dumps/${dump_name}
+	mv dump-data/* $DATA_DIR/dumps/${dump_name}
+	[ $? -eq 0 ] || exit 1
+
+	rmdir dump-data
+	[ $? -eq 0 ] || exit 1
+elif [[ $1 == *.tar.gz ]]; then
+	# Profile B
+	dump_name=${1%.tar.gz}
+
+	echo "decompressing dump ..."
+	tar xzf $1
+
+	echo "moving contents to tests/integration/data/dumps/${dump_name} ..."
+	mkdir -p $DATA_DIR/dumps/${dump_name}
+	mv *${dump_name}/* $DATA_DIR/dumps/${dump_name}
+	[ $? -eq 0 ] || exit 1
+
+	rmdir *${dump_name}
+	[ $? -eq 0 ] || exit 1
+else
+	echo "unknown dump profile"
+	exit 1
+fi
+
+echo "Done"

sdb_debugger-0.2.1/.github/scripts/install-drgn.sh

@@ -0,0 +1,17 @@
+#!/bin/bash -eux
+
+#
+# These are build requirements of "drgn"; if we don't install these, the
+# build/install of "drgn" will fail below.
+#
+sudo apt update
+sudo apt install bison flex libelf-dev libdw-dev libomp5 libomp-dev
+
+# Install setuptools for Python 3.12+ compatibility
+python3 -m pip install --upgrade pip setuptools wheel
+
+git clone https://github.com/osandov/drgn.git
+
+cd drgn
+python3 -m pip install .
+cd -

sdb_debugger-0.2.1/.github/scripts/install-libkdumpfile.sh

@@ -0,0 +1,23 @@
+#!/bin/bash -eux
+
+#
+# These are build requirements of "libkdumpfile"; if we don't install these,
+# the build/install of "libkdumpfile" will fail below. We install python3-dev
+# which will work with whatever Python version is set up by actions/setup-python.
+#
+sudo apt update
+sudo apt install autoconf automake liblzo2-dev libsnappy-dev libtool pkg-config zlib1g-dev binutils-dev python3-dev
+
+git clone https://codeberg.org/ptesarik/libkdumpfile.git
+
+cd libkdumpfile
+autoreconf -fi
+./configure --with-python=$(which python3)
+make
+sudo make install
+cd -
+
+#
+# Debug statements
+#
+echo $(which python3)

sdb_debugger-0.2.1/.github/workflows/main.yml

@@ -0,0 +1,145 @@
+on:
+  push:
+    branches:
+      - '**'
+    tags-ignore:
+      - 'v*'  # Release workflow handles version tags
+  pull_request:
+  schedule:
+    - cron:  '0 0 * * *'
+
+jobs:
+  #
+  # Verify the build and installation of SDB.
+  #
+  install:
+    runs-on: ubuntu-24.04
+    strategy:
+      matrix:
+        python-version: ['3.10', '3.12']
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - run: python3 -m pip install --upgrade pip setuptools wheel
+      - run: python3 -m pip install .
+        #
+        # The statement below is used for debugging the Github job.
+        #
+      - run: python3 --version
+  #
+  # Verify "pylint" runs successfully.
+  #
+  # Note, we need to have "drgn" installed in order to run "pylint".
+  # Thus, prior to running "pylint" we have to clone, build, and install
+  # the "drgn" from source (there's no package currently available).
+  #
+  pylint:
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+      - run: ./.github/scripts/install-drgn.sh
+      - run: python3 -m pip install pylint pytest
+      - run: pylint -d duplicate-code -d invalid-name sdb
+      - run: pylint -d duplicate-code -d invalid-name tests
+  #
+  # Verify "pytest" runs successfully on unit tests.
+  #
+  # Note, we need to have "drgn" installed in order to run "pytest". Thus,
+  # prior to running "pytest" we have to clone, build, and install the
+  # "drgn" from source (there's no package currently available).
+  #
+  pytest-unit:
+    runs-on: ubuntu-24.04
+    strategy:
+      matrix:
+        python-version: ['3.10', '3.12']
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - run: python3 -m pip install pytest pytest-cov
+      - run: ./.github/scripts/install-drgn.sh
+      - run: pytest -v --cov sdb --cov-report xml tests/unit
+      - uses: codecov/codecov-action@v4
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+  #
+  # Verify "pytest" runs successfully on integration tests with crash dumps.
+  #
+  # Note, we need to have "drgn" and "libkdumpfile" installed to run pytest
+  # with crash dumps. We download both reference dumps for full integration testing.
+  #
+  pytest-integration:
+    runs-on: ubuntu-24.04
+    strategy:
+      matrix:
+        python-version: ['3.10', '3.12']
+    env:
+      AWS_DEFAULT_REGION: 'us-west-2'
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - run: python3 -m pip install pytest pytest-cov
+      - run: ./.github/scripts/install-libkdumpfile.sh
+      - run: ./.github/scripts/install-drgn.sh
+      - run: ./.github/scripts/download-dumps-from-gdrive.sh
+      - run: ./.github/scripts/extract-dump.sh dump.201912060006.tar.lzma
+      - run: ./.github/scripts/extract-dump.sh dump.202303131823.tar.gz
+      - run: pytest -v --cov sdb --cov-report xml tests/integration
+      - uses: codecov/codecov-action@v4
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+  #
+  # Verify "yapf" runs successfully.
+  #
+  yapf:
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+      - run: python3 -m pip install yapf
+      - run: yapf --diff --style google --recursive sdb
+      - run: yapf --diff --style google --recursive tests
+  #
+  # Verify "ruff" runs successfully.
+  #
+  ruff:
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+      - run: python3 -m pip install ruff
+      - run: ruff check sdb tests
+  #
+  # Verify "mypy" runs successfully.
+  #
+  # Note, we need to have "drgn" installed in order to run "mypy".
+  # Thus, prior to running "mypy" we have to clone, build, and install
+  # the "drgn" from source (there's no package currently available).
+  #
+  # Also note that we supply --ignore-missing-imports to the tests package
+  # because pytest doesn't provide stubs on typeshed.
+  #
+  mypy:
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+      - run: ./.github/scripts/install-drgn.sh
+      - run: python3 -m pip install mypy pytest
+      - run: python3 -m mypy --strict --show-error-codes -p sdb
+      - run: python3 -m mypy --strict --ignore-missing-imports --show-error-codes -p tests

sdb_debugger-0.2.1/.github/workflows/release.yml

@@ -0,0 +1,154 @@
+#
+# Release workflow - triggered on version tag push (e.g., v0.2.0)
+#
+# This workflow:
+# 1. Runs all CI checks (lint, type-check, tests)
+# 2. Builds the package (sdist + wheel)
+# 3. Publishes to PyPI using Trusted Publishing (OIDC)
+# 4. Creates a GitHub Release with auto-generated notes
+#
+name: Release
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+# Required for PyPI Trusted Publishing (OIDC)
+permissions:
+  contents: write  # For creating GitHub releases
+  id-token: write  # For PyPI OIDC authentication
+
+jobs:
+  #
+  # Run all CI checks before releasing
+  #
+  lint:
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+      - run: ./.github/scripts/install-drgn.sh
+      - run: python3 -m pip install pylint pytest ruff yapf
+      - run: pylint -d duplicate-code -d invalid-name sdb
+      - run: pylint -d duplicate-code -d invalid-name tests
+      - run: ruff check sdb tests
+      - run: yapf --diff --style google --recursive sdb
+      - run: yapf --diff --style google --recursive tests
+
+  type-check:
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+      - run: ./.github/scripts/install-drgn.sh
+      - run: python3 -m pip install mypy pytest
+      - run: python3 -m mypy --strict --show-error-codes -p sdb
+      - run: python3 -m mypy --strict --ignore-missing-imports --show-error-codes -p tests
+
+  test-unit:
+    runs-on: ubuntu-24.04
+    strategy:
+      matrix:
+        python-version: ['3.10', '3.12']
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - run: python3 -m pip install pytest pytest-cov
+      - run: ./.github/scripts/install-drgn.sh
+      - run: pytest -v --cov sdb --cov-report xml tests/unit
+
+  test-integration:
+    runs-on: ubuntu-24.04
+    strategy:
+      matrix:
+        python-version: ['3.10', '3.12']
+    env:
+      AWS_DEFAULT_REGION: 'us-west-2'
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - run: python3 -m pip install pytest pytest-cov
+      - run: ./.github/scripts/install-libkdumpfile.sh
+      - run: ./.github/scripts/install-drgn.sh
+      - run: ./.github/scripts/download-dumps-from-gdrive.sh
+      - run: ./.github/scripts/extract-dump.sh dump.201912060006.tar.lzma
+      - run: ./.github/scripts/extract-dump.sh dump.202303131823.tar.gz
+      - run: pytest -v --cov sdb --cov-report xml tests/integration
+
+  #
+  # Build the package
+  #
+  build:
+    needs: [lint, type-check, test-unit, test-integration]
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # Required for setuptools_scm to get version from tags
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+      - name: Install build dependencies
+        run: python3 -m pip install build
+      - name: Build package
+        run: python3 -m build
+      - name: Upload build artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  #
+  # Publish to PyPI using Trusted Publishing (OIDC)
+  #
+  publish-pypi:
+    needs: build
+    runs-on: ubuntu-24.04
+    environment:
+      name: pypi
+      url: https://pypi.org/project/sdb-debugger/
+    steps:
+      - name: Download build artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+  #
+  # Create GitHub Release with auto-generated notes
+  #
+  github-release:
+    needs: publish-pypi
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # Required for generating release notes
+      - name: Download build artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - name: Get version from tag
+        id: version
+        run: echo "VERSION=${GITHUB_REF#refs/tags/v}" >> $GITHUB_OUTPUT
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          name: SDB ${{ steps.version.outputs.VERSION }}
+          generate_release_notes: true
+          files: |
+            dist/*
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

sdb_debugger-0.2.1/.gitignore

@@ -0,0 +1,119 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+
+# crash-dump related files
+tests/integration/data/dump.*
+tests/integration/data/vmlinux-*
+tests/integration/data/mods/
+
+# vim
+*.swp
+
+# zipped folders - usually crash dumps
+*.lzma
+*.tar.gz
+
+# crash dump directory
+tests/integration/data/dumps/

sdb_debugger-0.2.1/CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+serapheimd@gmail.com.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.