amd-node-scraper 0.0.1__tar.gz

amd_node_scraper-0.0.1/.github/CODEOWNERS

@@ -0,0 +1 @@
+* @landrews-amd @alexandraBara @jaspals3123

amd_node_scraper-0.0.1/.github/workflows/code_quality_checks.yml

@@ -0,0 +1,26 @@
+# workflow to validate code formatting using pre-commit hooks
+name: Code Quality Check
+
+permissions:
+  contents: read
+
+on:
+  - pull_request
+  - workflow_dispatch
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    container: python:3.9
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: setup environment and run pre-commit hooks
+        shell: bash
+        run: |
+          source ./dev-setup.sh
+          pre-commit run --all-files --show-diff-on-failure --color=always
+      - name: Print message on failure
+        if: failure()
+        run: |
+          echo "### :x: Pre-commit hooks failed. Please check logs for changes needed" >> $GITHUB_STEP_SUMMARY

amd_node_scraper-0.0.1/.github/workflows/functional-test.yml

@@ -0,0 +1,30 @@
+name: Python Functional Tests
+
+on:
+  workflow_dispatch:
+  pull_request:
+  push:
+    branches: [ "main" ]
+
+permissions:
+  contents: read
+
+jobs:
+  run_tests:
+    runs-on: ubuntu-latest
+    container: python:3.9
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Install xmllint
+      run: |
+        apt-get update
+        apt-get install -y libxml2-utils bc
+
+    - name: Install package and run functional tests
+      id: run_functional_tests
+      shell: bash
+      run: |
+        source ./dev-setup.sh
+        pytest test/functional -s --disable-warnings -v

amd_node_scraper-0.0.1/.github/workflows/release-trusted-publisher.yml

@@ -0,0 +1,122 @@
+name: Release (Trusted Publisher)
+
+permissions:
+  contents: write  # Required for creating releases and pushing tags
+  id-token: write  # Required for PyPI Trusted Publishing
+
+on:
+  workflow_dispatch:
+    inputs:
+      release_type:
+        description: 'Release type (major, minor, patch)'
+        required: true
+        type: choice
+        options:
+          - patch
+          - minor
+          - major
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0  # Fetch all history and tags
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Fetch all tags
+        run: |
+          git fetch --tags --force
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.9'
+
+      - name: Configure Git
+        run: |
+          git config --global user.name "github-actions[bot]"
+          git config --global user.email "github-actions[bot]@users.noreply.github.com"
+
+      - name: Calculate next version
+        id: next_version
+        shell: bash
+        run: |
+          # Get the latest tag, default to v0.0.0 if no tags exist
+          LATEST_TAG=$(git describe --tags --abbrev=0 2>/dev/null || echo "v0.0.0")
+          echo "Latest tag: $LATEST_TAG"
+
+          # Remove 'v' prefix and split into components
+          VERSION=${LATEST_TAG#v}
+          IFS='.' read -r -a VERSION_PARTS <<< "$VERSION"
+          MAJOR="${VERSION_PARTS[0]:-0}"
+          MINOR="${VERSION_PARTS[1]:-0}"
+          PATCH="${VERSION_PARTS[2]:-0}"
+
+          echo "Current version: $MAJOR.$MINOR.$PATCH"
+
+          # Increment based on release type
+          case "${{ github.event.inputs.release_type }}" in
+            major)
+              MAJOR=$((MAJOR + 1))
+              MINOR=0
+              PATCH=0
+              ;;
+            minor)
+              MINOR=$((MINOR + 1))
+              PATCH=0
+              ;;
+            patch)
+              PATCH=$((PATCH + 1))
+              ;;
+          esac
+
+          NEW_VERSION="v${MAJOR}.${MINOR}.${PATCH}"
+          echo "New version: $NEW_VERSION"
+          echo "version=$NEW_VERSION" >> $GITHUB_OUTPUT
+
+      - name: Create and push tag
+        run: |
+          git tag ${{ steps.next_version.outputs.version }}
+          git push origin ${{ steps.next_version.outputs.version }}
+
+      - name: Install build dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install build
+
+      - name: Build package
+        run: |
+          python -m build
+
+      - name: Upload to PyPI using Trusted Publisher
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist/
+
+      - name: Create GitHub Release
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          gh release create ${{ steps.next_version.outputs.version }} \
+            --title "${{ steps.next_version.outputs.version }}" \
+            --generate-notes \
+            dist/*
+
+      - name: Print summary
+        if: success()
+        run: |
+          echo "### :rocket: Release ${{ steps.next_version.outputs.version }} completed successfully!" >> $GITHUB_STEP_SUMMARY
+          echo "" >> $GITHUB_STEP_SUMMARY
+          echo "- **Release Type:** ${{ github.event.inputs.release_type }}" >> $GITHUB_STEP_SUMMARY
+          echo "- **New Version:** ${{ steps.next_version.outputs.version }}" >> $GITHUB_STEP_SUMMARY
+          echo "- **PyPI Package:** Published via Trusted Publisher" >> $GITHUB_STEP_SUMMARY
+          echo "- **GitHub Release:** Created with auto-generated notes" >> $GITHUB_STEP_SUMMARY
+
+      - name: Print failure message
+        if: failure()
+        run: |
+          echo "### :x: Release failed. Please check the logs above." >> $GITHUB_STEP_SUMMARY

amd_node_scraper-0.0.1/.github/workflows/unit-test.yml

@@ -0,0 +1,41 @@
+name: Python Unit Tests
+
+on:
+  workflow_dispatch:
+  pull_request:
+  push:
+    branches: [ "main" ]
+
+permissions:
+  contents: read
+
+jobs:
+  run_tests:
+    runs-on: ubuntu-latest
+    container: python:3.9
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Install xmllint
+      run: |
+        apt-get update
+        apt-get install -y libxml2-utils bc
+
+    - name: Install package and run unit tests with coverage
+      id: extract_coverage
+      shell: bash
+      run: |
+        source ./dev-setup.sh
+        pytest test/unit -s --cov=nodescraper --cov-report=xml --cov-report=term --cov-fail-under=70 --maxfail=1 --disable-warnings -v
+
+    - name: Print coverage
+      run: |
+        total_coverage=$(xmllint --xpath "string(//coverage/@line-rate)" coverage.xml)
+        total_coverage_percentage=$(echo "$total_coverage * 100" | bc)
+        echo "Total Coverage: $total_coverage_percentage%"
+        echo "coverage_percentage=$total_coverage_percentage" >> $GITHUB_ENV
+
+    - name: Display total coverage in Summary
+      run: |
+        echo "Total Coverage: ${{ env.coverage_percentage }}" >> $GITHUB_STEP_SUMMARY

amd_node_scraper-0.0.1/.github/workflows/update-plugin-docs.yml

@@ -0,0 +1,69 @@
+# Workflow to run plugin documentation generation then create a PR with the updated changes
+
+name: Plugin Documentation Generator
+
+permissions:
+  contents: write
+  pull-requests: write
+
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: '0 0 * * *'
+
+jobs:
+  generate_docs:
+    runs-on: ubuntu-latest
+    # To disable this workflow, set DISABLE_AUTO_DOCS to 'true' in repository variables
+    if: vars.DISABLE_AUTO_DOCS != 'true'
+    env:
+      HOME: /tmp/github-actions-home
+
+    steps:
+    - name: Setup HOME directory
+      run: |
+        mkdir -p /tmp/github-actions-home
+        export HOME=/tmp/github-actions-home
+
+    - name: Checkout repository
+      uses: actions/checkout@v4
+      with:
+        token: ${{ secrets.GITHUB_TOKEN }}
+
+    - name: Install dependencies
+      run: ./dev-setup.sh
+
+    - name: Run plugin documentation generator
+      run: |
+        source venv/bin/activate
+        python docs/generate_plugin_doc_bundle.py \
+          --package nodescraper.plugins.inband \
+          --output docs/PLUGIN_DOC.md
+
+    - name: Clean pre-commit cache
+      run: |
+        rm -rf /tmp/github-actions-home/.cache/pre-commit
+        source venv/bin/activate
+        pre-commit clean || true
+
+    - name: Format documentation with pre-commit
+      run: |
+        source venv/bin/activate
+        pre-commit install-hooks || true
+        pre-commit run --files docs/PLUGIN_DOC.md || true
+
+    - name: Create Pull Request
+      uses: peter-evans/create-pull-request@v6
+      with:
+        token: ${{ secrets.GITHUB_TOKEN }}
+        commit-message: "docs: Update plugin documentation [automated]"
+        committer: "github-actions[bot] <github-actions[bot]@users.noreply.github.com>"
+        author: "github-actions[bot] <github-actions[bot]@users.noreply.github.com>"
+        branch: automated-plugin-docs-update
+        delete-branch: true
+        title: "docs: Update plugin documentation [automated]"
+        body: |
+          Automated plugin documentation update generated by workflow.
+
+          This PR was automatically created by the Plugin Documentation Generator workflow.
+        labels: documentation,automated

amd_node_scraper-0.0.1/.gitignore

@@ -0,0 +1,133 @@
+# Virtual environment
+venv/
+
+# 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/
+pip-wheel-metadata/
+share/python-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/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# 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/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+scraper_logs*/*

amd_node_scraper-0.0.1/.mypy.ini

@@ -0,0 +1,122 @@
+[mypy]
+# Global mypy configuration
+
+[mypy-nodescraper.base.regexanalyzer]
+ignore_errors = True
+
+[mypy-nodescraper.cli.cli]
+ignore_errors = True
+
+[mypy-nodescraper.cli.dynamicparserbuilder]
+ignore_errors = True
+
+[mypy-nodescraper.cli.helper]
+ignore_errors = True
+
+[mypy-nodescraper.cli.inputargtypes]
+ignore_errors = True
+
+[mypy-nodescraper.configbuilder]
+ignore_errors = True
+
+[mypy-nodescraper.configregistry]
+ignore_errors = True
+
+[mypy-nodescraper.enums.eventpriority]
+ignore_errors = True
+
+[mypy-nodescraper.enums.systeminteraction]
+ignore_errors = True
+
+[mypy-nodescraper.interfaces.connectionmanager]
+ignore_errors = True
+
+[mypy-nodescraper.interfaces.datacollectortask]
+ignore_errors = True
+
+[mypy-nodescraper.interfaces.dataplugin]
+ignore_errors = True
+
+[mypy-nodescraper.interfaces.task]
+ignore_errors = True
+
+[mypy-nodescraper.models.analyzerargs]
+ignore_errors = True
+
+[mypy-nodescraper.models.datamodel]
+ignore_errors = True
+
+[mypy-nodescraper.pluginexecutor]
+ignore_errors = True
+
+[mypy-nodescraper.plugins.inband.bios.analyzer_args]
+ignore_errors = True
+
+[mypy-nodescraper.plugins.inband.cmdline.cmdline_analyzer]
+ignore_errors = True
+
+[mypy-nodescraper.plugins.inband.dimm.dimm_collector]
+ignore_errors = True
+
+[mypy-nodescraper.plugins.inband.dkms.analyzer_args]
+ignore_errors = True
+
+[mypy-nodescraper.plugins.inband.dmesg.dmesg_analyzer]
+ignore_errors = True
+
+[mypy-nodescraper.plugins.inband.dmesg.dmesgdata]
+ignore_errors = True
+
+[mypy-nodescraper.plugins.inband.memory.memory_collector]
+ignore_errors = True
+
+[mypy-nodescraper.plugins.inband.os.os_collector]
+ignore_errors = True
+
+[mypy-nodescraper.plugins.inband.package.analyzer_args]
+ignore_errors = True
+
+[mypy-nodescraper.plugins.inband.process.analyzer_args]
+ignore_errors = True
+
+[mypy-nodescraper.plugins.inband.process.process_collector]
+ignore_errors = True
+
+[mypy-nodescraper.plugins.inband.rocm.rocm_plugin]
+ignore_errors = True
+
+[mypy-nodescraper.taskresulthooks.filesystemloghook]
+ignore_errors = True
+
+[mypy-nodescraper.typeutils]
+ignore_errors = True
+
+[mypy-nodescraper.utils]
+ignore_errors = True
+
+[mypy-test.unit.conftest]
+ignore_errors = True
+
+[mypy-test.unit.framework.common.shared_utils]
+ignore_errors = True
+
+[mypy-test.unit.framework.test_cli_helper]
+ignore_errors = True
+
+[mypy-test.unit.framework.test_dataplugin]
+ignore_errors = True
+
+[mypy-test.unit.framework.test_plugin_executor]
+ignore_errors = True
+
+[mypy-nodescraper.models.collectorargs]
+ignore_errors = True
+
+[mypy-nodescraper.plugins.inband.kernel_module.*]
+ignore_errors = True
+
+[mypy-nodescraper.plugins.inband.nvme.nvme_collector]
+ignore_errors = True
+
+[mypy-test.unit.framework.test_cli]
+ignore_errors = True

amd_node_scraper-0.0.1/.pre-commit-config.yaml

@@ -0,0 +1,23 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.11.6
+    hooks:
+      - id: ruff
+        args:
+          - --fix
+  - repo: https://github.com/psf/black
+    rev: 25.1.0
+    hooks:
+      - id: black
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.15.0
+    hooks:
+      - id: mypy
+        args: [--install-types, --non-interactive, --explicit-package-bases, --allow-redefinition]
+        language: system

amd_node_scraper-0.0.1/CONTRIBUTING.md

@@ -0,0 +1,92 @@
+# Contribute to Node Scraper
+
+AMD values and encourages contributions to our code and documentation. If you want to contribute
+to our repository, first review the following guidance.
+
+## Development workflow
+
+Node Scraper uses GitHub to host code, collaborate, and manage version control. We use pull requests (PRs)
+for all changes within our repository. We use
+[GitHub issues](https://github.com/amd/node-scraper/issues) to track known issues, such as
+bugs.
+
+### Issue tracking
+
+Before filing a new issue, search the
+[existing issues](https://github.com/amd/node-scraper/issues) to make sure your issue isn't
+already listed.
+
+General issue guidelines:
+
+* Use your best judgement for issue creation. If your issue is already listed, upvote the issue and
+  comment or post to provide additional details, such as how you reproduced this issue.
+* If you're not sure if your issue is the same, err on the side of caution and file your issue.
+  You can add a comment to include the issue number (and link) for the similar issue. If we evaluate
+  your issue as being the same as the existing issue, we'll close the duplicate.
+* If your issue doesn't exist, use the issue template to file a new issue.
+  * When filing an issue, be sure to provide as much information as possible, including script output so
+    we can collect information about your configuration. This helps reduce the time required to
+    reproduce your issue.
+  * Check your issue regularly, as we may require additional information to successfully reproduce the
+    issue.
+
+### Pull requests
+
+When you create a pull request, you should target the default branch.  Our repository uses the
+**development** branch as the default integration branch.
+
+When creating a PR, use the following process.
+
+* Identify the issue you want to fix
+* Target the default branch (usually the **development** branch) for integration
+* Ensure your code builds successfully
+* Do not break existing test cases
+* New functionality is only merged with new unit tests
+* Tests must have good code coverage
+* Submit your PR and work with the reviewer or maintainer to get your PR approved
+* Once approved, the PR is brought onto internal CI systems and may be merged into the component
+  during our release cycle, as coordinated by the maintainer
+* We'll inform you once your change is committed
+
+> [!IMPORTANT]
+> By creating a PR, you agree to allow your contribution to be licensed under the
+> terms of the LICENSE.txt file.
+
+### Pre-commit hooks
+
+This repository uses [pre-commit](https://pre-commit.com/) to automatically format code. When you commit changes to plugin files, the hooks will:
+
+1. Run code formatters (ruff, black)
+2. Run type checking (mypy)
+
+#### Setup
+
+Install pre-commit hooks after cloning the repository:
+
+```bash
+# Activate your virtual environment
+source venv/bin/activate
+
+# Install pre-commit hooks
+pre-commit install
+```
+
+#### Usage
+
+The hooks run automatically when you commit.
+
+```bash
+# First commit attempt - hooks run and may modify files
+git commit -m "Add new plugin feature"
+
+# If hooks modified files, stage them and commit again
+git add .
+git commit -m "Add new plugin feature"
+```
+
+You can also run hooks manually:
+
+```bash
+# Run all hooks on all files
+pre-commit run --all-files
+```